google-cloud-dialogflow-cx-v3 0.10.2 → 0.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +2 -1
  4. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +8 -6
  5. data/lib/google/cloud/dialogflow/cx/v3/agents.rb +1 -1
  6. data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +1 -1
  7. data/lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb +4 -2
  8. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +11 -7
  9. data/lib/google/cloud/dialogflow/cx/v3/deployments.rb +1 -1
  10. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +5 -3
  11. data/lib/google/cloud/dialogflow/cx/v3/entity_types.rb +1 -1
  12. data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +26 -13
  13. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +40 -23
  14. data/lib/google/cloud/dialogflow/cx/v3/environments.rb +3 -2
  15. data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +15 -9
  16. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +28 -18
  17. data/lib/google/cloud/dialogflow/cx/v3/experiments.rb +1 -1
  18. data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +4 -2
  19. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +8 -6
  20. data/lib/google/cloud/dialogflow/cx/v3/flows.rb +1 -1
  21. data/lib/google/cloud/dialogflow/cx/v3/intents.rb +1 -1
  22. data/lib/google/cloud/dialogflow/cx/v3/pages.rb +1 -1
  23. data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +1 -0
  24. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +14 -9
  25. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb +1 -1
  26. data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +7 -4
  27. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +2 -1
  28. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +2 -1
  29. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types.rb +3 -2
  30. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +1 -0
  31. data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +10 -5
  32. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +10 -5
  33. data/lib/google/cloud/dialogflow/cx/v3/sessions.rb +4 -3
  34. data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +16 -8
  35. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +27 -18
  36. data/lib/google/cloud/dialogflow/cx/v3/test_cases.rb +1 -1
  37. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +11 -5
  38. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +21 -11
  39. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups.rb +3 -2
  40. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  41. data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +6 -3
  42. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +22 -18
  43. data/lib/google/cloud/dialogflow/cx/v3/versions.rb +1 -1
  44. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +4 -3
  45. data/lib/google/cloud/dialogflow/cx/v3/webhooks.rb +1 -1
  46. data/lib/google/cloud/dialogflow/cx/v3.rb +2 -2
  47. data/proto_docs/google/api/client.rb +318 -0
  48. data/proto_docs/google/api/launch_stage.rb +71 -0
  49. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +55 -31
  50. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +16 -12
  51. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +6 -3
  52. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +13 -8
  53. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +24 -12
  54. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +65 -41
  55. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +31 -19
  56. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +38 -22
  57. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +10 -5
  58. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +27 -15
  59. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +62 -37
  60. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +32 -21
  61. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +35 -25
  62. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +109 -68
  63. data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +22 -15
  64. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +82 -55
  65. data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +32 -20
  66. data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +36 -26
  67. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +106 -66
  68. data/proto_docs/google/rpc/status.rb +4 -2
  69. metadata +7 -5
data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb CHANGED
@@ -37,16 +37,16 @@ module Google
37
37
  # ID>/environments/<Environment ID>`.
38
38
  # @!attribute [rw] display_name
39
39
  # @return [::String]
40
- # Required. The human-readable name of the environment (unique in an agent). Limit of
41
- # 64 characters.
40
+ # Required. The human-readable name of the environment (unique in an agent).
41
+ # Limit of 64 characters.
42
42
  # @!attribute [rw] description
43
43
  # @return [::String]
44
44
  # The human-readable description of the environment. The maximum length is
45
45
  # 500 characters. If exceeded, the request is rejected.
46
46
  # @!attribute [rw] version_configs
47
47
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Environment::VersionConfig>]
48
- # Required. A list of configurations for flow versions. You should include version
49
- # configs for all flows that are reachable from [`Start
48
+ # Required. A list of configurations for flow versions. You should include
49
+ # version configs for all flows that are reachable from [`Start
50
50
  # Flow`][Agent.start_flow] in the agent. Otherwise, an error will be
51
51
  # returned.
52
52
  # @!attribute [r] update_time
@@ -65,8 +65,8 @@ module Google
65
65
  # Configuration for the version.
66
66
  # @!attribute [rw] version
67
67
  # @return [::String]
68
- # Required. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
69
- # ID>/flows/<Flow ID>/versions/<Version ID>.
68
+ # Required. Format: projects/<Project ID>/locations/<Location
69
+ # ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
70
70
  class VersionConfig
71
71
  include ::Google::Protobuf::MessageExts
72
72
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -80,12 +80,14 @@ module Google
80
80
  # <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`
81
81
  # @!attribute [rw] enable_continuous_run
82
82
  # @return [::Boolean]
83
- # Whether to run test cases in {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases} periodically.
84
- # Default false. If set to true, run once a day.
83
+ # Whether to run test cases in
84
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
85
+ # periodically. Default false. If set to true, run once a day.
85
86
  # @!attribute [rw] enable_predeployment_run
86
87
  # @return [::Boolean]
87
- # Whether to run test cases in {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases} before
88
- # deploying a flow version to the environment. Default false.
88
+ # Whether to run test cases in
89
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
90
+ # before deploying a flow version to the environment. Default false.
89
91
  class TestCasesConfig
90
92
  include ::Google::Protobuf::MessageExts
91
93
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -96,7 +98,8 @@ module Google
96
98
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
97
99
  # The list of webhooks to override for the agent environment. The webhook
98
100
  # must exist in the agent. You can override fields in
99
- # {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`} and
101
+ # {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`}
102
+ # and
100
103
  # {::Google::Cloud::Dialogflow::CX::V3::Webhook#service_directory `service_directory`}.
101
104
  class WebhookConfig
102
105
  include ::Google::Protobuf::MessageExts
@@ -104,11 +107,13 @@ module Google
104
107
  end
105
108
  end
106
109
 
107
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_environments Environments.ListEnvironments}.
110
+ # The request message for
111
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_environments Environments.ListEnvironments}.
108
112
  # @!attribute [rw] parent
109
113
  # @return [::String]
110
- # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to list all environments for.
111
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
114
+ # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to list all
115
+ # environments for. Format: `projects/<Project ID>/locations/<Location
116
+ # ID>/agents/<Agent ID>`.
112
117
  # @!attribute [rw] page_size
113
118
  # @return [::Integer]
114
119
  # The maximum number of items to return in a single page. By default 20 and
@@ -121,7 +126,8 @@ module Google
121
126
  extend ::Google::Protobuf::MessageExts::ClassMethods
122
127
  end
123
128
 
124
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_environments Environments.ListEnvironments}.
129
+ # The response message for
130
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_environments Environments.ListEnvironments}.
125
131
  # @!attribute [rw] environments
126
132
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Environment>]
127
133
  # The list of environments. There will be a maximum number of items
@@ -137,22 +143,26 @@ module Google
137
143
  extend ::Google::Protobuf::MessageExts::ClassMethods
138
144
  end
139
145
 
140
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#get_environment Environments.GetEnvironment}.
146
+ # The request message for
147
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#get_environment Environments.GetEnvironment}.
141
148
  # @!attribute [rw] name
142
149
  # @return [::String]
143
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
144
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
150
+ # Required. The name of the
151
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. Format:
152
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
145
153
  # ID>/environments/<Environment ID>`.
146
154
  class GetEnvironmentRequest
147
155
  include ::Google::Protobuf::MessageExts
148
156
  extend ::Google::Protobuf::MessageExts::ClassMethods
149
157
  end
150
158
 
151
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#create_environment Environments.CreateEnvironment}.
159
+ # The request message for
160
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#create_environment Environments.CreateEnvironment}.
152
161
  # @!attribute [rw] parent
153
162
  # @return [::String]
154
- # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for.
155
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
163
+ # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an
164
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for. Format:
165
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
156
166
  # @!attribute [rw] environment
157
167
  # @return [::Google::Cloud::Dialogflow::CX::V3::Environment]
158
168
  # Required. The environment to create.
@@ -161,7 +171,8 @@ module Google
161
171
  extend ::Google::Protobuf::MessageExts::ClassMethods
162
172
  end
163
173
 
164
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#update_environment Environments.UpdateEnvironment}.
174
+ # The request message for
175
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#update_environment Environments.UpdateEnvironment}.
165
176
  # @!attribute [rw] environment
166
177
  # @return [::Google::Cloud::Dialogflow::CX::V3::Environment]
167
178
  # Required. The environment to update.
@@ -173,18 +184,21 @@ module Google
173
184
  extend ::Google::Protobuf::MessageExts::ClassMethods
174
185
  end
175
186
 
176
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#delete_environment Environments.DeleteEnvironment}.
187
+ # The request message for
188
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#delete_environment Environments.DeleteEnvironment}.
177
189
  # @!attribute [rw] name
178
190
  # @return [::String]
179
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete.
180
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
191
+ # Required. The name of the
192
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete. Format:
193
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
181
194
  # ID>/environments/<Environment ID>`.
182
195
  class DeleteEnvironmentRequest
183
196
  include ::Google::Protobuf::MessageExts
184
197
  extend ::Google::Protobuf::MessageExts::ClassMethods
185
198
  end
186
199
 
187
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#lookup_environment_history Environments.LookupEnvironmentHistory}.
200
+ # The request message for
201
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#lookup_environment_history Environments.LookupEnvironmentHistory}.
188
202
  # @!attribute [rw] name
189
203
  # @return [::String]
190
204
  # Required. Resource name of the environment to look up the history for.
@@ -202,11 +216,13 @@ module Google
202
216
  extend ::Google::Protobuf::MessageExts::ClassMethods
203
217
  end
204
218
 
205
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#lookup_environment_history Environments.LookupEnvironmentHistory}.
219
+ # The response message for
220
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#lookup_environment_history Environments.LookupEnvironmentHistory}.
206
221
  # @!attribute [rw] environments
207
222
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Environment>]
208
223
  # Represents a list of snapshots for an environment. Time of the snapshots is
209
- # stored in {::Google::Cloud::Dialogflow::CX::V3::Environment#update_time `update_time`}.
224
+ # stored in
225
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment#update_time `update_time`}.
210
226
  # @!attribute [rw] next_page_token
211
227
  # @return [::String]
212
228
  # Token to retrieve the next page of results, or empty if there are no more
@@ -250,17 +266,19 @@ module Google
250
266
  end
251
267
  end
252
268
 
253
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest}.
269
+ # The request message for
270
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest}.
254
271
  # @!attribute [rw] environment
255
272
  # @return [::String]
256
- # Required. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
257
- # ID>/environments/<Environment ID>`.
273
+ # Required. Format: `projects/<Project ID>/locations/<Location
274
+ # ID>/agents/<Agent ID>/environments/<Environment ID>`.
258
275
  class RunContinuousTestRequest
259
276
  include ::Google::Protobuf::MessageExts
260
277
  extend ::Google::Protobuf::MessageExts::ClassMethods
261
278
  end
262
279
 
263
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest}.
280
+ # The response message for
281
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest}.
264
282
  # @!attribute [rw] continuous_test_result
265
283
  # @return [::Google::Cloud::Dialogflow::CX::V3::ContinuousTestResult]
266
284
  # The result for a continuous test run.
@@ -269,8 +287,9 @@ module Google
269
287
  extend ::Google::Protobuf::MessageExts::ClassMethods
270
288
  end
271
289
 
272
- # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest} long running
273
- # operation.
290
+ # Metadata returned for the
291
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest}
292
+ # long running operation.
274
293
  # @!attribute [rw] errors
275
294
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestError>]
276
295
  # The test errors.
@@ -279,7 +298,8 @@ module Google
279
298
  extend ::Google::Protobuf::MessageExts::ClassMethods
280
299
  end
281
300
 
282
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_continuous_test_results Environments.ListContinuousTestResults}.
301
+ # The request message for
302
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_continuous_test_results Environments.ListContinuousTestResults}.
283
303
  # @!attribute [rw] parent
284
304
  # @return [::String]
285
305
  # Required. The environment to list results for.
@@ -310,7 +330,8 @@ module Google
310
330
  extend ::Google::Protobuf::MessageExts::ClassMethods
311
331
  end
312
332
 
313
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow}.
333
+ # The request message for
334
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow}.
314
335
  # @!attribute [rw] environment
315
336
  # @return [::String]
316
337
  # Required. The environment to deploy the flow to.
@@ -326,22 +347,25 @@ module Google
326
347
  extend ::Google::Protobuf::MessageExts::ClassMethods
327
348
  end
328
349
 
329
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow}.
350
+ # The response message for
351
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow}.
330
352
  # @!attribute [rw] environment
331
353
  # @return [::Google::Cloud::Dialogflow::CX::V3::Environment]
332
354
  # The updated environment where the flow is deployed.
333
355
  # @!attribute [rw] deployment
334
356
  # @return [::String]
335
- # The name of the flow version {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}.
336
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
357
+ # The name of the flow version
358
+ # {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}. Format:
359
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
337
360
  # environments/<Environment ID>/deployments/<Deployment ID>`.
338
361
  class DeployFlowResponse
339
362
  include ::Google::Protobuf::MessageExts
340
363
  extend ::Google::Protobuf::MessageExts::ClassMethods
341
364
  end
342
365
 
343
- # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow} long running
344
- # operation.
366
+ # Metadata returned for the
367
+ # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow}
368
+ # long running operation.
345
369
  # @!attribute [rw] test_errors
346
370
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestError>]
347
371
  # Errors of running deployment tests.
data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb CHANGED
@@ -30,8 +30,8 @@ module Google
30
30
  # ID>/environments/<Environment ID>/experiments/<Experiment ID>..
31
31
  # @!attribute [rw] display_name
32
32
  # @return [::String]
33
- # Required. The human-readable name of the experiment (unique in an environment). Limit
34
- # of 64 characters.
33
+ # Required. The human-readable name of the experiment (unique in an
34
+ # environment). Limit of 64 characters.
35
35
  # @!attribute [rw] description
36
36
  # @return [::String]
37
37
  # The human-readable description of the experiment.
@@ -328,12 +328,14 @@ module Google
328
328
  extend ::Google::Protobuf::MessageExts::ClassMethods
329
329
  end
330
330
 
331
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#list_experiments Experiments.ListExperiments}.
331
+ # The request message for
332
+ # {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#list_experiments Experiments.ListExperiments}.
332
333
  # @!attribute [rw] parent
333
334
  # @return [::String]
334
- # Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to list all environments for.
335
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
336
- # ID>/environments/<Environment ID>`.
335
+ # Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
336
+ # list all environments for. Format: `projects/<Project
337
+ # ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment
338
+ # ID>`.
337
339
  # @!attribute [rw] page_size
338
340
  # @return [::Integer]
339
341
  # The maximum number of items to return in a single page. By default 20 and
@@ -346,7 +348,8 @@ module Google
346
348
  extend ::Google::Protobuf::MessageExts::ClassMethods
347
349
  end
348
350
 
349
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#list_experiments Experiments.ListExperiments}.
351
+ # The response message for
352
+ # {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#list_experiments Experiments.ListExperiments}.
350
353
  # @!attribute [rw] experiments
351
354
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment>]
352
355
  # The list of experiments. There will be a maximum number of items
@@ -362,22 +365,26 @@ module Google
362
365
  extend ::Google::Protobuf::MessageExts::ClassMethods
363
366
  end
364
367
 
365
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#get_experiment Experiments.GetExperiment}.
368
+ # The request message for
369
+ # {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#get_experiment Experiments.GetExperiment}.
366
370
  # @!attribute [rw] name
367
371
  # @return [::String]
368
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
369
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
372
+ # Required. The name of the
373
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. Format:
374
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
370
375
  # ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
371
376
  class GetExperimentRequest
372
377
  include ::Google::Protobuf::MessageExts
373
378
  extend ::Google::Protobuf::MessageExts::ClassMethods
374
379
  end
375
380
 
376
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#create_experiment Experiments.CreateExperiment}.
381
+ # The request message for
382
+ # {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#create_experiment Experiments.CreateExperiment}.
377
383
  # @!attribute [rw] parent
378
384
  # @return [::String]
379
- # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for.
380
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
385
+ # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an
386
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for. Format:
387
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
381
388
  # ID>/environments/<Environment ID>`.
382
389
  # @!attribute [rw] experiment
383
390
  # @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
@@ -387,7 +394,8 @@ module Google
387
394
  extend ::Google::Protobuf::MessageExts::ClassMethods
388
395
  end
389
396
 
390
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#update_experiment Experiments.UpdateExperiment}.
397
+ # The request message for
398
+ # {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#update_experiment Experiments.UpdateExperiment}.
391
399
  # @!attribute [rw] experiment
392
400
  # @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
393
401
  # Required. The experiment to update.
@@ -399,18 +407,21 @@ module Google
399
407
  extend ::Google::Protobuf::MessageExts::ClassMethods
400
408
  end
401
409
 
402
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#delete_experiment Experiments.DeleteExperiment}.
410
+ # The request message for
411
+ # {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#delete_experiment Experiments.DeleteExperiment}.
403
412
  # @!attribute [rw] name
404
413
  # @return [::String]
405
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete.
406
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
414
+ # Required. The name of the
415
+ # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete. Format:
416
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
407
417
  # ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
408
418
  class DeleteExperimentRequest
409
419
  include ::Google::Protobuf::MessageExts
410
420
  extend ::Google::Protobuf::MessageExts::ClassMethods
411
421
  end
412
422
 
413
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#start_experiment Experiments.StartExperiment}.
423
+ # The request message for
424
+ # {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#start_experiment Experiments.StartExperiment}.
414
425
  # @!attribute [rw] name
415
426
  # @return [::String]
416
427
  # Required. Resource name of the experiment to start.
@@ -421,7 +432,8 @@ module Google
421
432
  extend ::Google::Protobuf::MessageExts::ClassMethods
422
433
  end
423
434
 
424
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#stop_experiment Experiments.StopExperiment}.
435
+ # The request message for
436
+ # {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#stop_experiment Experiments.StopExperiment}.
425
437
  # @!attribute [rw] name
426
438
  # @return [::String]
427
439
  # Required. Resource name of the experiment to stop.
data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb CHANGED
@@ -123,9 +123,10 @@ module Google
123
123
  # regardless of the current page. Event handlers defined in the page
124
124
  # have higher priority than those defined in the flow.
125
125
  #
126
- # Unlike {::Google::Cloud::Dialogflow::CX::V3::Flow#transition_routes transition_routes}, these handlers are
127
- # evaluated on a first-match basis. The first one that matches the event
128
- # get executed, with the rest being ignored.
126
+ # Unlike
127
+ # {::Google::Cloud::Dialogflow::CX::V3::Flow#transition_routes transition_routes},
128
+ # these handlers are evaluated on a first-match basis. The first one that
129
+ # matches the event get executed, with the rest being ignored.
129
130
  # @!attribute [rw] transition_route_groups
130
131
  # @return [::Array<::String>]
131
132
  # A flow's transition route group serve two purposes:
@@ -146,7 +147,8 @@ module Google
146
147
  extend ::Google::Protobuf::MessageExts::ClassMethods
147
148
  end
148
149
 
149
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#create_flow Flows.CreateFlow}.
150
+ # The request message for
151
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#create_flow Flows.CreateFlow}.
150
152
  # @!attribute [rw] parent
151
153
  # @return [::String]
152
154
  # Required. The agent to create a flow for.
@@ -173,7 +175,8 @@ module Google
173
175
  extend ::Google::Protobuf::MessageExts::ClassMethods
174
176
  end
175
177
 
176
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#delete_flow Flows.DeleteFlow}.
178
+ # The request message for
179
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#delete_flow Flows.DeleteFlow}.
177
180
  # @!attribute [rw] name
178
181
  # @return [::String]
179
182
  # Required. The name of the flow to delete.
@@ -196,7 +199,8 @@ module Google
196
199
  extend ::Google::Protobuf::MessageExts::ClassMethods
197
200
  end
198
201
 
199
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}.
202
+ # The request message for
203
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}.
200
204
  # @!attribute [rw] parent
201
205
  # @return [::String]
202
206
  # Required. The agent containing the flows.
@@ -228,7 +232,8 @@ module Google
228
232
  extend ::Google::Protobuf::MessageExts::ClassMethods
229
233
  end
230
234
 
231
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}.
235
+ # The response message for
236
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}.
232
237
  # @!attribute [rw] flows
233
238
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Flow>]
234
239
  # The list of flows. There will be a maximum number of items returned based
@@ -242,7 +247,8 @@ module Google
242
247
  extend ::Google::Protobuf::MessageExts::ClassMethods
243
248
  end
244
249
 
245
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow Flows.GetFlow}.
250
+ # The response message for
251
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow Flows.GetFlow}.
246
252
  # @!attribute [rw] name
247
253
  # @return [::String]
248
254
  # Required. The name of the flow to get.
@@ -268,7 +274,8 @@ module Google
268
274
  extend ::Google::Protobuf::MessageExts::ClassMethods
269
275
  end
270
276
 
271
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#update_flow Flows.UpdateFlow}.
277
+ # The request message for
278
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#update_flow Flows.UpdateFlow}.
272
279
  # @!attribute [rw] flow
273
280
  # @return [::Google::Cloud::Dialogflow::CX::V3::Flow]
274
281
  # Required. The flow to update.
@@ -295,7 +302,8 @@ module Google
295
302
  extend ::Google::Protobuf::MessageExts::ClassMethods
296
303
  end
297
304
 
298
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#train_flow Flows.TrainFlow}.
305
+ # The request message for
306
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#train_flow Flows.TrainFlow}.
299
307
  # @!attribute [rw] name
300
308
  # @return [::String]
301
309
  # Required. The flow to train.
@@ -306,7 +314,8 @@ module Google
306
314
  extend ::Google::Protobuf::MessageExts::ClassMethods
307
315
  end
308
316
 
309
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#validate_flow Flows.ValidateFlow}.
317
+ # The request message for
318
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#validate_flow Flows.ValidateFlow}.
310
319
  # @!attribute [rw] name
311
320
  # @return [::String]
312
321
  # Required. The flow to validate.
@@ -320,7 +329,8 @@ module Google
320
329
  extend ::Google::Protobuf::MessageExts::ClassMethods
321
330
  end
322
331
 
323
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}.
332
+ # The request message for
333
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}.
324
334
  # @!attribute [rw] name
325
335
  # @return [::String]
326
336
  # Required. The flow name.
@@ -334,7 +344,8 @@ module Google
334
344
  extend ::Google::Protobuf::MessageExts::ClassMethods
335
345
  end
336
346
 
337
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}.
347
+ # The response message for
348
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}.
338
349
  # @!attribute [rw] name
339
350
  # @return [::String]
340
351
  # The unique identifier of the flow validation result.
@@ -351,7 +362,8 @@ module Google
351
362
  extend ::Google::Protobuf::MessageExts::ClassMethods
352
363
  end
353
364
 
354
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}.
365
+ # The request message for
366
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}.
355
367
  # @!attribute [rw] parent
356
368
  # @return [::String]
357
369
  # Required. The agent to import the flow into.
@@ -394,7 +406,8 @@ module Google
394
406
  end
395
407
  end
396
408
 
397
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}.
409
+ # The response message for
410
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}.
398
411
  # @!attribute [rw] flow
399
412
  # @return [::String]
400
413
  # The unique identifier of the new flow.
@@ -405,7 +418,8 @@ module Google
405
418
  extend ::Google::Protobuf::MessageExts::ClassMethods
406
419
  end
407
420
 
408
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}.
421
+ # The request message for
422
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}.
409
423
  # @!attribute [rw] name
410
424
  # @return [::String]
411
425
  # Required. The name of the flow to export.
@@ -413,10 +427,10 @@ module Google
413
427
  # ID>/flows/<Flow ID>`.
414
428
  # @!attribute [rw] flow_uri
415
429
  # @return [::String]
416
- # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to
417
- # export the flow to. The format of this URI must be
418
- # `gs://<bucket-name>/<object-name>`.
419
- # If left unspecified, the serialized flow is returned inline.
430
+ # Optional. The [Google Cloud
431
+ # Storage](https://cloud.google.com/storage/docs/) URI to export the flow to.
432
+ # The format of this URI must be `gs://<bucket-name>/<object-name>`. If left
433
+ # unspecified, the serialized flow is returned inline.
420
434
  #
421
435
  # Dialogflow performs a write operation for the Cloud Storage object
422
436
  # on the caller's behalf, so your request authentication must
@@ -431,11 +445,13 @@ module Google
431
445
  extend ::Google::Protobuf::MessageExts::ClassMethods
432
446
  end
433
447
 
434
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}.
448
+ # The response message for
449
+ # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}.
435
450
  # @!attribute [rw] flow_uri
436
451
  # @return [::String]
437
452
  # The URI to a file containing the exported flow. This field is populated
438
- # only if `flow_uri` is specified in {::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest ExportFlowRequest}.
453
+ # only if `flow_uri` is specified in
454
+ # {::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest ExportFlowRequest}.
439
455
  # @!attribute [rw] flow_content
440
456
  # @return [::String]
441
457
  # Uncompressed raw byte content for flow.
data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb CHANGED
@@ -28,10 +28,14 @@ module Google
28
28
  # * Set parameter values.
29
29
  # * Call the webhook.
30
30
  #
31
- # Fulfillments can be called at various stages in the {::Google::Cloud::Dialogflow::CX::V3::Page Page} or
32
- # {::Google::Cloud::Dialogflow::CX::V3::Form Form} lifecycle. For example, when a {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest DetectIntentRequest} drives a
33
- # session to enter a new page, the page's entry fulfillment can add a static
34
- # response to the {::Google::Cloud::Dialogflow::CX::V3::QueryResult QueryResult} in the returning {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse DetectIntentResponse},
31
+ # Fulfillments can be called at various stages in the
32
+ # {::Google::Cloud::Dialogflow::CX::V3::Page Page} or
33
+ # {::Google::Cloud::Dialogflow::CX::V3::Form Form} lifecycle. For example, when a
34
+ # {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest DetectIntentRequest}
35
+ # drives a session to enter a new page, the page's entry fulfillment can add a
36
+ # static response to the
37
+ # {::Google::Cloud::Dialogflow::CX::V3::QueryResult QueryResult} in the returning
38
+ # {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse DetectIntentResponse},
35
39
  # call the webhook (for example, to load user data from a database), or both.
36
40
  # @!attribute [rw] messages
37
41
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
@@ -54,7 +58,8 @@ module Google
54
58
  # that have slow webhooks.
55
59
  # @!attribute [rw] tag
56
60
  # @return [::String]
57
- # The value of this field will be populated in the {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}
61
+ # The value of this field will be populated in the
62
+ # {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}
58
63
  # `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
59
64
  # called.
60
65
  # The tag is typically used by the webhook service to identify which