google-cloud-dialogflow-cx-v3 0.10.1 → 0.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +8 -6
- data/lib/google/cloud/dialogflow/cx/v3/agents.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb +4 -2
- data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +11 -7
- data/lib/google/cloud/dialogflow/cx/v3/deployments.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +5 -3
- data/lib/google/cloud/dialogflow/cx/v3/entity_types.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +26 -13
- data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +40 -23
- data/lib/google/cloud/dialogflow/cx/v3/environments.rb +3 -2
- data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +15 -9
- data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +28 -18
- data/lib/google/cloud/dialogflow/cx/v3/experiments.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +4 -2
- data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +8 -6
- data/lib/google/cloud/dialogflow/cx/v3/flows.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/intents.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/pages.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +14 -9
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +7 -4
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types.rb +3 -2
- data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +10 -5
- data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +10 -5
- data/lib/google/cloud/dialogflow/cx/v3/sessions.rb +4 -3
- data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +16 -8
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +27 -18
- data/lib/google/cloud/dialogflow/cx/v3/test_cases.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +11 -5
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +21 -11
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups.rb +3 -2
- data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +6 -3
- data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +22 -18
- data/lib/google/cloud/dialogflow/cx/v3/versions.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +4 -3
- data/lib/google/cloud/dialogflow/cx/v3/webhooks.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3.rb +2 -2
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +55 -31
- data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +16 -12
- data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +6 -3
- data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +13 -8
- data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +24 -12
- data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +65 -41
- data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +31 -19
- data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +38 -22
- data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +10 -5
- data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +27 -15
- data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +62 -37
- data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +32 -21
- data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +35 -28
- data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +109 -68
- data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +22 -15
- data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +82 -55
- data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +32 -20
- data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +36 -26
- data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +106 -66
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +7 -5
@@ -36,13 +36,20 @@ module Google
|
|
36
36
|
# in your app, product, or service to determine user intent and respond to the
|
37
37
|
# user in a natural way.
|
38
38
|
#
|
39
|
-
# After you create an agent, you can add
|
40
|
-
# {::Google::Cloud::Dialogflow::CX::V3::
|
41
|
-
#
|
39
|
+
# After you create an agent, you can add
|
40
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Intent Intents}, [Entity
|
41
|
+
# Types][google.cloud.dialogflow.cx.v3.EntityType],
|
42
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Flow Flows},
|
43
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Fulfillment Fulfillments},
|
44
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Webhook Webhooks}, and so on to manage the
|
45
|
+
# conversation flows..
|
42
46
|
# @!attribute [rw] name
|
43
47
|
# @return [::String]
|
44
48
|
# The unique identifier of the agent.
|
45
|
-
# Required for the
|
49
|
+
# Required for the
|
50
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#update_agent Agents.UpdateAgent}
|
51
|
+
# method.
|
52
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#create_agent Agents.CreateAgent}
|
46
53
|
# populates the name automatically.
|
47
54
|
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
|
48
55
|
# @!attribute [rw] display_name
|
@@ -54,7 +61,9 @@ module Google
|
|
54
61
|
# See [Language
|
55
62
|
# Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
56
63
|
# for a list of the currently supported language codes.
|
57
|
-
# This field cannot be set by the
|
64
|
+
# This field cannot be set by the
|
65
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#update_agent Agents.UpdateAgent}
|
66
|
+
# method.
|
58
67
|
# @!attribute [rw] supported_language_codes
|
59
68
|
# @return [::Array<::String>]
|
60
69
|
# The list of all languages supported by the agent (except for the
|
@@ -79,20 +88,21 @@ module Google
|
|
79
88
|
# Speech recognition related settings.
|
80
89
|
# @!attribute [rw] start_flow
|
81
90
|
# @return [::String]
|
82
|
-
# Immutable. Name of the start flow in this agent. A start flow will be
|
83
|
-
# created when the agent is created, and can only be deleted by
|
84
|
-
# agent.
|
85
|
-
#
|
86
|
-
# ID>/flows/<Flow ID>`.
|
91
|
+
# Immutable. Name of the start flow in this agent. A start flow will be
|
92
|
+
# automatically created when the agent is created, and can only be deleted by
|
93
|
+
# deleting the agent. Format: `projects/<Project ID>/locations/<Location
|
94
|
+
# ID>/agents/<Agent ID>/flows/<Flow ID>`.
|
87
95
|
# @!attribute [rw] security_settings
|
88
96
|
# @return [::String]
|
89
|
-
# Name of the
|
90
|
-
#
|
97
|
+
# Name of the
|
98
|
+
# {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings}
|
99
|
+
# reference for the agent. Format: `projects/<Project ID>/locations/<Location
|
91
100
|
# ID>/securitySettings/<Security Settings ID>`.
|
92
101
|
# @!attribute [rw] enable_stackdriver_logging
|
93
102
|
# @return [::Boolean]
|
94
103
|
# Indicates if stackdriver logging is enabled for the agent.
|
95
|
-
# Please use
|
104
|
+
# Please use
|
105
|
+
# {::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings::LoggingSettings agent.advanced_settings}
|
96
106
|
# instead.
|
97
107
|
# @!attribute [rw] enable_spell_correction
|
98
108
|
# @return [::Boolean]
|
@@ -111,7 +121,8 @@ module Google
|
|
111
121
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
112
122
|
end
|
113
123
|
|
114
|
-
# The request message for
|
124
|
+
# The request message for
|
125
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#list_agents Agents.ListAgents}.
|
115
126
|
# @!attribute [rw] parent
|
116
127
|
# @return [::String]
|
117
128
|
# Required. The location to list all agents for.
|
@@ -128,7 +139,8 @@ module Google
|
|
128
139
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
129
140
|
end
|
130
141
|
|
131
|
-
# The response message for
|
142
|
+
# The response message for
|
143
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#list_agents Agents.ListAgents}.
|
132
144
|
# @!attribute [rw] agents
|
133
145
|
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Agent>]
|
134
146
|
# The list of agents. There will be a maximum number of items returned based
|
@@ -142,7 +154,8 @@ module Google
|
|
142
154
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
143
155
|
end
|
144
156
|
|
145
|
-
# The request message for
|
157
|
+
# The request message for
|
158
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#get_agent Agents.GetAgent}.
|
146
159
|
# @!attribute [rw] name
|
147
160
|
# @return [::String]
|
148
161
|
# Required. The name of the agent.
|
@@ -152,7 +165,8 @@ module Google
|
|
152
165
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
153
166
|
end
|
154
167
|
|
155
|
-
# The request message for
|
168
|
+
# The request message for
|
169
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#create_agent Agents.CreateAgent}.
|
156
170
|
# @!attribute [rw] parent
|
157
171
|
# @return [::String]
|
158
172
|
# Required. The location to create a agent for.
|
@@ -165,7 +179,8 @@ module Google
|
|
165
179
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
166
180
|
end
|
167
181
|
|
168
|
-
# The request message for
|
182
|
+
# The request message for
|
183
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#update_agent Agents.UpdateAgent}.
|
169
184
|
# @!attribute [rw] agent
|
170
185
|
# @return [::Google::Cloud::Dialogflow::CX::V3::Agent]
|
171
186
|
# Required. The agent to update.
|
@@ -178,7 +193,8 @@ module Google
|
|
178
193
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
179
194
|
end
|
180
195
|
|
181
|
-
# The request message for
|
196
|
+
# The request message for
|
197
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#delete_agent Agents.DeleteAgent}.
|
182
198
|
# @!attribute [rw] name
|
183
199
|
# @return [::String]
|
184
200
|
# Required. The name of the agent to delete.
|
@@ -188,17 +204,18 @@ module Google
|
|
188
204
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
189
205
|
end
|
190
206
|
|
191
|
-
# The request message for
|
207
|
+
# The request message for
|
208
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#export_agent Agents.ExportAgent}.
|
192
209
|
# @!attribute [rw] name
|
193
210
|
# @return [::String]
|
194
211
|
# Required. The name of the agent to export.
|
195
212
|
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
|
196
213
|
# @!attribute [rw] agent_uri
|
197
214
|
# @return [::String]
|
198
|
-
# Optional. The [Google Cloud
|
199
|
-
#
|
200
|
-
# `gs://<bucket-name>/<object-name>`.
|
201
|
-
#
|
215
|
+
# Optional. The [Google Cloud
|
216
|
+
# Storage](https://cloud.google.com/storage/docs/) URI to export the agent
|
217
|
+
# to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If
|
218
|
+
# left unspecified, the serialized agent is returned inline.
|
202
219
|
#
|
203
220
|
# Dialogflow performs a write operation for the Cloud Storage object
|
204
221
|
# on the caller's behalf, so your request authentication must
|
@@ -207,7 +224,8 @@ module Google
|
|
207
224
|
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
|
208
225
|
# @!attribute [rw] data_format
|
209
226
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest::DataFormat]
|
210
|
-
# Optional. The data format of the exported agent. If not specified, `BLOB`
|
227
|
+
# Optional. The data format of the exported agent. If not specified, `BLOB`
|
228
|
+
# is assumed.
|
211
229
|
# @!attribute [rw] environment
|
212
230
|
# @return [::String]
|
213
231
|
# Optional. Environment name. If not set, draft environment is assumed.
|
@@ -227,11 +245,13 @@ module Google
|
|
227
245
|
end
|
228
246
|
end
|
229
247
|
|
230
|
-
# The response message for
|
248
|
+
# The response message for
|
249
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#export_agent Agents.ExportAgent}.
|
231
250
|
# @!attribute [rw] agent_uri
|
232
251
|
# @return [::String]
|
233
252
|
# The URI to a file containing the exported agent. This field is populated
|
234
|
-
# only if `agent_uri` is specified in
|
253
|
+
# only if `agent_uri` is specified in
|
254
|
+
# {::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest ExportAgentRequest}.
|
235
255
|
# @!attribute [rw] agent_content
|
236
256
|
# @return [::String]
|
237
257
|
# Uncompressed raw byte content for agent.
|
@@ -240,7 +260,8 @@ module Google
|
|
240
260
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
241
261
|
end
|
242
262
|
|
243
|
-
# The request message for
|
263
|
+
# The request message for
|
264
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#restore_agent Agents.RestoreAgent}.
|
244
265
|
# @!attribute [rw] name
|
245
266
|
# @return [::String]
|
246
267
|
# Required. The name of the agent to restore into.
|
@@ -282,7 +303,8 @@ module Google
|
|
282
303
|
end
|
283
304
|
end
|
284
305
|
|
285
|
-
# The request message for
|
306
|
+
# The request message for
|
307
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#validate_agent Agents.ValidateAgent}.
|
286
308
|
# @!attribute [rw] name
|
287
309
|
# @return [::String]
|
288
310
|
# Required. The agent to validate.
|
@@ -295,7 +317,8 @@ module Google
|
|
295
317
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
296
318
|
end
|
297
319
|
|
298
|
-
# The request message for
|
320
|
+
# The request message for
|
321
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#get_agent_validation_result Agents.GetAgentValidationResult}.
|
299
322
|
# @!attribute [rw] name
|
300
323
|
# @return [::String]
|
301
324
|
# Required. The agent name.
|
@@ -309,7 +332,8 @@ module Google
|
|
309
332
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
310
333
|
end
|
311
334
|
|
312
|
-
# The response message for
|
335
|
+
# The response message for
|
336
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#get_agent_validation_result Agents.GetAgentValidationResult}.
|
313
337
|
# @!attribute [rw] name
|
314
338
|
# @return [::String]
|
315
339
|
# The unique identifier of the agent validation result.
|
@@ -63,10 +63,12 @@ module Google
|
|
63
63
|
# more details.
|
64
64
|
# @!attribute [rw] enable_word_info
|
65
65
|
# @return [::Boolean]
|
66
|
-
# Optional. If `true`, Dialogflow returns
|
67
|
-
# {::Google::Cloud::Dialogflow::CX::V3::
|
68
|
-
#
|
69
|
-
#
|
66
|
+
# Optional. If `true`, Dialogflow returns
|
67
|
+
# {::Google::Cloud::Dialogflow::CX::V3::SpeechWordInfo SpeechWordInfo} in
|
68
|
+
# {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult StreamingRecognitionResult}
|
69
|
+
# with information about the recognized speech words, e.g. start and end time
|
70
|
+
# offsets. If false or unspecified, Speech doesn't return any word-level
|
71
|
+
# information.
|
70
72
|
# @!attribute [rw] phrase_hints
|
71
73
|
# @return [::Array<::String>]
|
72
74
|
# Optional. A list of strings containing words and phrases that the speech
|
@@ -90,7 +92,8 @@ module Google
|
|
90
92
|
# for more details.
|
91
93
|
# @!attribute [rw] model_variant
|
92
94
|
# @return [::Google::Cloud::Dialogflow::CX::V3::SpeechModelVariant]
|
93
|
-
# Optional. Which variant of the
|
95
|
+
# Optional. Which variant of the [Speech
|
96
|
+
# model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
|
94
97
|
# @!attribute [rw] single_utterance
|
95
98
|
# @return [::Boolean]
|
96
99
|
# Optional. If `false` (default), recognition does not cease until the
|
@@ -119,10 +122,10 @@ module Google
|
|
119
122
|
# @return [::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender]
|
120
123
|
# Optional. The preferred gender of the voice. If not set, the service will
|
121
124
|
# choose a voice based on the other parameters such as language_code and
|
122
|
-
# {::Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams#name name}. Note that
|
123
|
-
#
|
124
|
-
#
|
125
|
-
# request.
|
125
|
+
# {::Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams#name name}. Note that
|
126
|
+
# this is only a preference, not requirement. If a voice of the appropriate
|
127
|
+
# gender is not available, the synthesizer substitutes a voice with a
|
128
|
+
# different gender rather than failing the request.
|
126
129
|
class VoiceSelectionParams
|
127
130
|
include ::Google::Protobuf::MessageExts
|
128
131
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -231,7 +234,8 @@ module Google
|
|
231
234
|
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7
|
232
235
|
end
|
233
236
|
|
234
|
-
# Variant of the specified
|
237
|
+
# Variant of the specified [Speech
|
238
|
+
# model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
|
235
239
|
#
|
236
240
|
# See the [Cloud Speech
|
237
241
|
# documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)
|
@@ -260,8 +264,8 @@ module Google
|
|
260
264
|
# Use an enhanced model variant:
|
261
265
|
#
|
262
266
|
# * If an enhanced variant does not exist for the given
|
263
|
-
# {::Google::Cloud::Dialogflow::CX::V3::InputAudioConfig#model model} and request
|
264
|
-
# back to the standard variant.
|
267
|
+
# {::Google::Cloud::Dialogflow::CX::V3::InputAudioConfig#model model} and request
|
268
|
+
# language, Dialogflow falls back to the standard variant.
|
265
269
|
#
|
266
270
|
# The [Cloud Speech
|
267
271
|
# documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)
|
@@ -22,7 +22,8 @@ module Google
|
|
22
22
|
module Dialogflow
|
23
23
|
module CX
|
24
24
|
module V3
|
25
|
-
# The request message for
|
25
|
+
# The request message for
|
26
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Changelogs::Client#list_changelogs Changelogs.ListChangelogs}.
|
26
27
|
# @!attribute [rw] parent
|
27
28
|
# @return [::String]
|
28
29
|
# Required. The agent containing the changelogs.
|
@@ -61,7 +62,8 @@ module Google
|
|
61
62
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
62
63
|
end
|
63
64
|
|
64
|
-
# The response message for
|
65
|
+
# The response message for
|
66
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Changelogs::Client#list_changelogs Changelogs.ListChangelogs}.
|
65
67
|
# @!attribute [rw] changelogs
|
66
68
|
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Changelog>]
|
67
69
|
# The list of changelogs. There will be a maximum number of items returned
|
@@ -76,7 +78,8 @@ module Google
|
|
76
78
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
77
79
|
end
|
78
80
|
|
79
|
-
# The request message for
|
81
|
+
# The request message for
|
82
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Changelogs::Client#get_changelog Changelogs.GetChangelog}.
|
80
83
|
# @!attribute [rw] name
|
81
84
|
# @return [::String]
|
82
85
|
# Required. The name of the changelog to get.
|
@@ -84,12 +84,14 @@ module Google
|
|
84
84
|
end
|
85
85
|
end
|
86
86
|
|
87
|
-
# The request message for
|
87
|
+
# The request message for
|
88
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Deployments::Client#list_deployments Deployments.ListDeployments}.
|
88
89
|
# @!attribute [rw] parent
|
89
90
|
# @return [::String]
|
90
|
-
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
|
91
|
-
# Format: `projects/<Project
|
92
|
-
# ID>/environments/<Environment
|
91
|
+
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
|
92
|
+
# list all environments for. Format: `projects/<Project
|
93
|
+
# ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment
|
94
|
+
# ID>`.
|
93
95
|
# @!attribute [rw] page_size
|
94
96
|
# @return [::Integer]
|
95
97
|
# The maximum number of items to return in a single page. By default 20 and
|
@@ -102,7 +104,8 @@ module Google
|
|
102
104
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
103
105
|
end
|
104
106
|
|
105
|
-
# The response message for
|
107
|
+
# The response message for
|
108
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Deployments::Client#list_deployments Deployments.ListDeployments}.
|
106
109
|
# @!attribute [rw] deployments
|
107
110
|
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Deployment>]
|
108
111
|
# The list of deployments. There will be a maximum number of items
|
@@ -118,11 +121,13 @@ module Google
|
|
118
121
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
119
122
|
end
|
120
123
|
|
121
|
-
# The request message for
|
124
|
+
# The request message for
|
125
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Deployments::Client#get_deployment Deployments.GetDeployment}.
|
122
126
|
# @!attribute [rw] name
|
123
127
|
# @return [::String]
|
124
|
-
# Required. The name of the
|
125
|
-
# Format:
|
128
|
+
# Required. The name of the
|
129
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}. Format:
|
130
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
126
131
|
# ID>/environments/<Environment ID>/deployments/<Deployment ID>`.
|
127
132
|
class GetDeploymentRequest
|
128
133
|
include ::Google::Protobuf::MessageExts
|
@@ -45,19 +45,23 @@ module Google
|
|
45
45
|
#
|
46
46
|
# * **User** - entities that are built for an individual user such as
|
47
47
|
# favorites, preferences, playlists, and so on. A user entity is
|
48
|
-
# represented by the
|
48
|
+
# represented by the
|
49
|
+
# {::Google::Cloud::Dialogflow::CX::V3::SessionEntityType SessionEntityType}
|
50
|
+
# type.
|
49
51
|
#
|
50
52
|
# For more information about entity types, see the [Dialogflow
|
51
53
|
# documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
|
52
54
|
# @!attribute [rw] name
|
53
55
|
# @return [::String]
|
54
56
|
# The unique identifier of the entity type.
|
55
|
-
# Required for
|
57
|
+
# Required for
|
58
|
+
# {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#update_entity_type EntityTypes.UpdateEntityType}.
|
56
59
|
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
57
60
|
# ID>/entityTypes/<Entity Type ID>`.
|
58
61
|
# @!attribute [rw] display_name
|
59
62
|
# @return [::String]
|
60
|
-
# Required. The human-readable name of the entity type, unique within the
|
63
|
+
# Required. The human-readable name of the entity type, unique within the
|
64
|
+
# agent.
|
61
65
|
# @!attribute [rw] kind
|
62
66
|
# @return [::Google::Cloud::Dialogflow::CX::V3::EntityType::Kind]
|
63
67
|
# Required. Indicates the kind of entity type.
|
@@ -156,7 +160,8 @@ module Google
|
|
156
160
|
end
|
157
161
|
end
|
158
162
|
|
159
|
-
# The request message for
|
163
|
+
# The request message for
|
164
|
+
# {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#list_entity_types EntityTypes.ListEntityTypes}.
|
160
165
|
# @!attribute [rw] parent
|
161
166
|
# @return [::String]
|
162
167
|
# Required. The agent to list all entity types for.
|
@@ -187,7 +192,8 @@ module Google
|
|
187
192
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
188
193
|
end
|
189
194
|
|
190
|
-
# The response message for
|
195
|
+
# The response message for
|
196
|
+
# {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#list_entity_types EntityTypes.ListEntityTypes}.
|
191
197
|
# @!attribute [rw] entity_types
|
192
198
|
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType>]
|
193
199
|
# The list of entity types. There will be a maximum number of items returned
|
@@ -201,7 +207,8 @@ module Google
|
|
201
207
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
202
208
|
end
|
203
209
|
|
204
|
-
# The request message for
|
210
|
+
# The request message for
|
211
|
+
# {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType}.
|
205
212
|
# @!attribute [rw] name
|
206
213
|
# @return [::String]
|
207
214
|
# Required. The name of the entity type.
|
@@ -226,7 +233,8 @@ module Google
|
|
226
233
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
234
|
end
|
228
235
|
|
229
|
-
# The request message for
|
236
|
+
# The request message for
|
237
|
+
# {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#create_entity_type EntityTypes.CreateEntityType}.
|
230
238
|
# @!attribute [rw] parent
|
231
239
|
# @return [::String]
|
232
240
|
# Required. The agent to create a entity type for.
|
@@ -252,7 +260,8 @@ module Google
|
|
252
260
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
253
261
|
end
|
254
262
|
|
255
|
-
# The request message for
|
263
|
+
# The request message for
|
264
|
+
# {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#update_entity_type EntityTypes.UpdateEntityType}.
|
256
265
|
# @!attribute [rw] entity_type
|
257
266
|
# @return [::Google::Cloud::Dialogflow::CX::V3::EntityType]
|
258
267
|
# Required. The entity type to update.
|
@@ -277,7 +286,8 @@ module Google
|
|
277
286
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
278
287
|
end
|
279
288
|
|
280
|
-
# The request message for
|
289
|
+
# The request message for
|
290
|
+
# {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#delete_entity_type EntityTypes.DeleteEntityType}.
|
281
291
|
# @!attribute [rw] name
|
282
292
|
# @return [::String]
|
283
293
|
# Required. The name of the entity type to delete.
|
@@ -292,9 +302,11 @@ module Google
|
|
292
302
|
# indicating the referencing resources.
|
293
303
|
# * If `force` is set to true, Dialogflow will remove the entity type, as
|
294
304
|
# well as any references to the entity type (i.e. Page
|
295
|
-
# {::Google::Cloud::Dialogflow::CX::V3::Form::Parameter parameter} of the entity
|
296
|
-
#
|
297
|
-
#
|
305
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Form::Parameter parameter} of the entity
|
306
|
+
# type will be changed to
|
307
|
+
# '@sys.any' and intent
|
308
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} of the
|
309
|
+
# entity type will be removed).
|
298
310
|
class DeleteEntityTypeRequest
|
299
311
|
include ::Google::Protobuf::MessageExts
|
300
312
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|