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.
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 -28
  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/intent.rb CHANGED
@@ -30,7 +30,10 @@ module Google
30
30
  # @!attribute [rw] name
31
31
  # @return [::String]
32
32
  # The unique identifier of the intent.
33
- # Required for the {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#update_intent Intents.UpdateIntent} method. {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#create_intent Intents.CreateIntent}
33
+ # Required for the
34
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#update_intent Intents.UpdateIntent}
35
+ # method.
36
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#create_intent Intents.CreateIntent}
34
37
  # populates the name automatically.
35
38
  # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
36
39
  # ID>/intents/<Intent ID>`.
@@ -100,7 +103,9 @@ module Google
100
103
  # training phrase is well formatted when the parts are concatenated.
101
104
  #
102
105
  # If the training phrase does not need to be annotated with parameters,
103
- # you just need a single part with only the {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text Part.text} field set.
106
+ # you just need a single part with only the
107
+ # {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text Part.text}
108
+ # field set.
104
109
  #
105
110
  # If you want to annotate the training phrase, you must create multiple
106
111
  # parts, where the fields of each part are populated in one of two ways:
@@ -121,9 +126,9 @@ module Google
121
126
  # Required. The text for this part.
122
127
  # @!attribute [rw] parameter_id
123
128
  # @return [::String]
124
- # The {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} used to annotate this part of the
125
- # training phrase. This field is required for annotated parts of the
126
- # training phrase.
129
+ # The {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} used to
130
+ # annotate this part of the training phrase. This field is required for
131
+ # annotated parts of the training phrase.
127
132
  class Part
128
133
  include ::Google::Protobuf::MessageExts
129
134
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -134,8 +139,9 @@ module Google
134
139
  # @!attribute [rw] id
135
140
  # @return [::String]
136
141
  # Required. The unique identifier of the parameter. This field
137
- # is used by {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase training phrases} to annotate their
138
- # {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
142
+ # is used by [training
143
+ # phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
144
+ # their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
139
145
  # @!attribute [rw] entity_type
140
146
  # @return [::String]
141
147
  # Required. The entity type of the parameter.
@@ -153,8 +159,8 @@ module Google
153
159
  # redaction is enabled, the parameter content will be replaced by parameter
154
160
  # name during logging.
155
161
  # Note: the parameter content is subject to redaction if either parameter
156
- # level redaction or {::Google::Cloud::Dialogflow::CX::V3::EntityType#redact entity type level redaction} is
157
- # enabled.
162
+ # level redaction or [entity type level
163
+ # redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
158
164
  class Parameter
159
165
  include ::Google::Protobuf::MessageExts
160
166
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -170,7 +176,8 @@ module Google
170
176
  end
171
177
  end
172
178
 
173
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#list_intents Intents.ListIntents}.
179
+ # The request message for
180
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#list_intents Intents.ListIntents}.
174
181
  # @!attribute [rw] parent
175
182
  # @return [::String]
176
183
  # Required. The agent to list all intents for.
@@ -202,7 +209,8 @@ module Google
202
209
  extend ::Google::Protobuf::MessageExts::ClassMethods
203
210
  end
204
211
 
205
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#list_intents Intents.ListIntents}.
212
+ # The response message for
213
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#list_intents Intents.ListIntents}.
206
214
  # @!attribute [rw] intents
207
215
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Intent>]
208
216
  # The list of intents. There will be a maximum number of items returned based
@@ -216,7 +224,8 @@ module Google
216
224
  extend ::Google::Protobuf::MessageExts::ClassMethods
217
225
  end
218
226
 
219
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#get_intent Intents.GetIntent}.
227
+ # The request message for
228
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#get_intent Intents.GetIntent}.
220
229
  # @!attribute [rw] name
221
230
  # @return [::String]
222
231
  # Required. The name of the intent.
@@ -239,7 +248,8 @@ module Google
239
248
  extend ::Google::Protobuf::MessageExts::ClassMethods
240
249
  end
241
250
 
242
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#create_intent Intents.CreateIntent}.
251
+ # The request message for
252
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#create_intent Intents.CreateIntent}.
243
253
  # @!attribute [rw] parent
244
254
  # @return [::String]
245
255
  # Required. The agent to create an intent for.
@@ -263,7 +273,8 @@ module Google
263
273
  extend ::Google::Protobuf::MessageExts::ClassMethods
264
274
  end
265
275
 
266
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#update_intent Intents.UpdateIntent}.
276
+ # The request message for
277
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#update_intent Intents.UpdateIntent}.
267
278
  # @!attribute [rw] intent
268
279
  # @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
269
280
  # Required. The intent to update.
@@ -287,7 +298,8 @@ module Google
287
298
  extend ::Google::Protobuf::MessageExts::ClassMethods
288
299
  end
289
300
 
290
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#delete_intent Intents.DeleteIntent}.
301
+ # The request message for
302
+ # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#delete_intent Intents.DeleteIntent}.
291
303
  # @!attribute [rw] name
292
304
  # @return [::String]
293
305
  # Required. The name of the intent to delete.
data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb CHANGED
@@ -41,7 +41,9 @@ module Google
41
41
  # @!attribute [rw] name
42
42
  # @return [::String]
43
43
  # The unique identifier of the page.
44
- # Required for the {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#update_page Pages.UpdatePage} method. {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#create_page Pages.CreatePage}
44
+ # Required for the
45
+ # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#update_page Pages.UpdatePage} method.
46
+ # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#create_page Pages.CreatePage}
45
47
  # populates the name automatically.
46
48
  # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
47
49
  # ID>/flows/<Flow ID>/pages/<Page ID>`.
@@ -57,8 +59,10 @@ module Google
57
59
  # relevant to the page.
58
60
  # @!attribute [rw] transition_route_groups
59
61
  # @return [::Array<::String>]
60
- # Ordered list of {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup `TransitionRouteGroups`} associated
61
- # with the page. Transition route groups must be unique within a page.
62
+ # Ordered list of
63
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup `TransitionRouteGroups`}
64
+ # associated with the page. Transition route groups must be unique within a
65
+ # page.
62
66
  #
63
67
  # * If multiple transition routes within a page scope refer to the same
64
68
  # intent, then the precedence order is: page's transition route -> page's
@@ -80,16 +84,19 @@ module Google
80
84
  #
81
85
  # * TransitionRoutes defined in the page with intent specified.
82
86
  # * TransitionRoutes defined in the
83
- # {::Google::Cloud::Dialogflow::CX::V3::Page#transition_route_groups transition route groups} with intent
84
- # specified.
87
+ # [transition route
88
+ # groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups]
89
+ # with intent specified.
85
90
  # * TransitionRoutes defined in flow with intent specified.
86
91
  # * TransitionRoutes defined in the
87
- # {::Google::Cloud::Dialogflow::CX::V3::Flow#transition_route_groups transition route groups} with intent
88
- # specified.
92
+ # [transition route
93
+ # groups][google.cloud.dialogflow.cx.v3.Flow.transition_route_groups]
94
+ # with intent specified.
89
95
  # * TransitionRoutes defined in the page with only condition specified.
90
96
  # * TransitionRoutes defined in the
91
- # {::Google::Cloud::Dialogflow::CX::V3::Page#transition_route_groups transition route groups} with only
92
- # condition specified.
97
+ # [transition route
98
+ # groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups]
99
+ # with only condition specified.
93
100
  # @!attribute [rw] event_handlers
94
101
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>]
95
102
  # Handlers associated with the page to handle events such as webhook errors,
@@ -102,8 +109,9 @@ module Google
102
109
  # A form is a data model that groups related parameters that can be collected
103
110
  # from the user. The process in which the agent prompts the user and collects
104
111
  # parameter values from the user is called form filling. A form can be added to
105
- # a {::Google::Cloud::Dialogflow::CX::V3::Page page}. When form filling is done, the filled parameters will be
106
- # written to the {::Google::Cloud::Dialogflow::CX::V3::SessionInfo#parameters session}.
112
+ # a {::Google::Cloud::Dialogflow::CX::V3::Page page}. When form filling is done, the
113
+ # filled parameters will be written to the
114
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionInfo#parameters session}.
107
115
  # @!attribute [rw] parameters
108
116
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Form::Parameter>]
109
117
  # Parameters to collect from the user.
@@ -145,8 +153,8 @@ module Google
145
153
  # redaction is enabled, the parameter content will be replaced by parameter
146
154
  # name during logging.
147
155
  # Note: the parameter content is subject to redaction if either parameter
148
- # level redaction or {::Google::Cloud::Dialogflow::CX::V3::EntityType#redact entity type level redaction} is
149
- # enabled.
156
+ # level redaction or [entity type level
157
+ # redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
150
158
  class Parameter
151
159
  include ::Google::Protobuf::MessageExts
152
160
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -197,17 +205,22 @@ module Google
197
205
  end
198
206
  end
199
207
 
200
- # An event handler specifies an {::Google::Cloud::Dialogflow::CX::V3::EventHandler#event event} that can be handled
208
+ # An event handler specifies an
209
+ # {::Google::Cloud::Dialogflow::CX::V3::EventHandler#event event} that can be handled
201
210
  # during a session. When the specified event happens, the following actions are
202
211
  # taken in order:
203
212
  #
204
213
  # * If there is a
205
- # {::Google::Cloud::Dialogflow::CX::V3::EventHandler#trigger_fulfillment `trigger_fulfillment`} associated with
206
- # the event, it will be called.
207
- # * If there is a {::Google::Cloud::Dialogflow::CX::V3::EventHandler#target_page `target_page`} associated
208
- # with the event, the session will transition into the specified page.
209
- # * If there is a {::Google::Cloud::Dialogflow::CX::V3::EventHandler#target_flow `target_flow`} associated
210
- # with the event, the session will transition into the specified flow.
214
+ # {::Google::Cloud::Dialogflow::CX::V3::EventHandler#trigger_fulfillment `trigger_fulfillment`}
215
+ # associated with the event, it will be called.
216
+ # * If there is a
217
+ # {::Google::Cloud::Dialogflow::CX::V3::EventHandler#target_page `target_page`}
218
+ # associated with the event, the session will transition into the specified
219
+ # page.
220
+ # * If there is a
221
+ # {::Google::Cloud::Dialogflow::CX::V3::EventHandler#target_flow `target_flow`}
222
+ # associated with the event, the session will transition into the specified
223
+ # flow.
211
224
  # @!attribute [r] name
212
225
  # @return [::String]
213
226
  # Output only. The unique identifier of this event handler.
@@ -235,17 +248,22 @@ module Google
235
248
  extend ::Google::Protobuf::MessageExts::ClassMethods
236
249
  end
237
250
 
238
- # A transition route specifies a {::Google::Cloud::Dialogflow::CX::V3::Intent intent} that can be matched and/or a
239
- # data condition that can be evaluated during a session. When a specified
240
- # transition is matched, the following actions are taken in order:
251
+ # A transition route specifies a {::Google::Cloud::Dialogflow::CX::V3::Intent intent}
252
+ # that can be matched and/or a data condition that can be evaluated during a
253
+ # session. When a specified transition is matched, the following actions are
254
+ # taken in order:
241
255
  #
242
256
  # * If there is a
243
- # {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#trigger_fulfillment `trigger_fulfillment`} associated with
244
- # the transition, it will be called.
245
- # * If there is a {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#target_page `target_page`} associated
246
- # with the transition, the session will transition into the specified page.
247
- # * If there is a {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#target_flow `target_flow`} associated
248
- # with the transition, the session will transition into the specified flow.
257
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#trigger_fulfillment `trigger_fulfillment`}
258
+ # associated with the transition, it will be called.
259
+ # * If there is a
260
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#target_page `target_page`}
261
+ # associated with the transition, the session will transition into the
262
+ # specified page.
263
+ # * If there is a
264
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#target_flow `target_flow`}
265
+ # associated with the transition, the session will transition into the
266
+ # specified flow.
249
267
  # @!attribute [r] name
250
268
  # @return [::String]
251
269
  # Output only. The unique identifier of this transition route.
@@ -261,8 +279,9 @@ module Google
261
279
  # when both are fulfilled.
262
280
  # @!attribute [rw] condition
263
281
  # @return [::String]
264
- # The condition to evaluate against {::Google::Cloud::Dialogflow::CX::V3::Form#parameters form parameters} or
265
- # {::Google::Cloud::Dialogflow::CX::V3::SessionInfo#parameters session parameters}.
282
+ # The condition to evaluate against [form
283
+ # parameters][google.cloud.dialogflow.cx.v3.Form.parameters] or [session
284
+ # parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
266
285
  #
267
286
  # See the [conditions
268
287
  # reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
@@ -289,7 +308,8 @@ module Google
289
308
  extend ::Google::Protobuf::MessageExts::ClassMethods
290
309
  end
291
310
 
292
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#list_pages Pages.ListPages}.
311
+ # The request message for
312
+ # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#list_pages Pages.ListPages}.
293
313
  # @!attribute [rw] parent
294
314
  # @return [::String]
295
315
  # Required. The flow to list all pages for.
@@ -330,7 +350,8 @@ module Google
330
350
  extend ::Google::Protobuf::MessageExts::ClassMethods
331
351
  end
332
352
 
333
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#list_pages Pages.ListPages}.
353
+ # The response message for
354
+ # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#list_pages Pages.ListPages}.
334
355
  # @!attribute [rw] pages
335
356
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Page>]
336
357
  # The list of pages. There will be a maximum number of items returned based
@@ -344,7 +365,8 @@ module Google
344
365
  extend ::Google::Protobuf::MessageExts::ClassMethods
345
366
  end
346
367
 
347
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#get_page Pages.GetPage}.
368
+ # The request message for
369
+ # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#get_page Pages.GetPage}.
348
370
  # @!attribute [rw] name
349
371
  # @return [::String]
350
372
  # Required. The name of the page.
@@ -378,7 +400,8 @@ module Google
378
400
  extend ::Google::Protobuf::MessageExts::ClassMethods
379
401
  end
380
402
 
381
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#create_page Pages.CreatePage}.
403
+ # The request message for
404
+ # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#create_page Pages.CreatePage}.
382
405
  # @!attribute [rw] parent
383
406
  # @return [::String]
384
407
  # Required. The flow to create a page for.
@@ -414,7 +437,8 @@ module Google
414
437
  extend ::Google::Protobuf::MessageExts::ClassMethods
415
438
  end
416
439
 
417
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#update_page Pages.UpdatePage}.
440
+ # The request message for
441
+ # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#update_page Pages.UpdatePage}.
418
442
  # @!attribute [rw] page
419
443
  # @return [::Google::Cloud::Dialogflow::CX::V3::Page]
420
444
  # Required. The page to update.
@@ -449,7 +473,8 @@ module Google
449
473
  extend ::Google::Protobuf::MessageExts::ClassMethods
450
474
  end
451
475
 
452
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#delete_page Pages.DeletePage}.
476
+ # The request message for
477
+ # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#delete_page Pages.DeletePage}.
453
478
  # @!attribute [rw] name
454
479
  # @return [::String]
455
480
  # Required. The name of the page to delete.
data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb CHANGED
@@ -57,22 +57,23 @@ module Google
57
57
  # Hands off conversation to a human agent.
58
58
  # @!attribute [r] end_interaction
59
59
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::EndInteraction]
60
- # Output only. A signal that indicates the interaction with the Dialogflow agent has
61
- # ended.
62
- # This message is generated by Dialogflow only when the conversation
63
- # reaches `END_SESSION` page. It is not supposed to be defined by the user.
60
+ # Output only. A signal that indicates the interaction with the Dialogflow
61
+ # agent has ended. This message is generated by Dialogflow only when the
62
+ # conversation reaches `END_SESSION` page. It is not supposed to be defined
63
+ # by the user.
64
64
  #
65
65
  # It's guaranteed that there is at most one such message in each response.
66
66
  # @!attribute [rw] play_audio
67
67
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio]
68
68
  # Signal that the client should play an audio clip hosted at a
69
69
  # client-specific URI. Dialogflow uses this to construct
70
- # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#mixed_audio mixed_audio}. However, Dialogflow itself
71
- # does not try to read or process the URI in any way.
70
+ # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#mixed_audio mixed_audio}.
71
+ # However, Dialogflow itself does not try to read or process the URI in any
72
+ # way.
72
73
  # @!attribute [r] mixed_audio
73
74
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::MixedAudio]
74
- # Output only. An audio response message composed of both the synthesized Dialogflow
75
- # agent responses and responses defined via
75
+ # Output only. An audio response message composed of both the synthesized
76
+ # Dialogflow agent responses and responses defined via
76
77
  # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#play_audio play_audio}.
77
78
  # This message is generated by Dialogflow only and not supposed to be
78
79
  # defined by the user.
@@ -80,6 +81,12 @@ module Google
80
81
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall]
81
82
  # A signal that the client should transfer the phone call connected to
82
83
  # this agent to a third-party endpoint.
84
+ # @!attribute [rw] channel
85
+ # @return [::String]
86
+ # The channel which the response is associated with. Clients can specify the
87
+ # channel via
88
+ # {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#channel QueryParameters.channel},
89
+ # and only associated channel response will be returned.
83
90
  class ResponseMessage
84
91
  include ::Google::Protobuf::MessageExts
85
92
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -90,8 +97,8 @@ module Google
90
97
  # Required. A collection of text responses.
91
98
  # @!attribute [r] allow_playback_interruption
92
99
  # @return [::Boolean]
93
- # Output only. Whether the playback of this message can be interrupted by the end
94
- # user's speech and the client can then starts the next Dialogflow
100
+ # Output only. Whether the playback of this message can be interrupted by
101
+ # the end user's speech and the client can then starts the next Dialogflow
95
102
  # request.
96
103
  class Text
97
104
  include ::Google::Protobuf::MessageExts
@@ -105,7 +112,9 @@ module Google
105
112
  # is up to you and your handoff procedures.
106
113
  #
107
114
  # You may set this, for example:
108
- # * In the {::Google::Cloud::Dialogflow::CX::V3::Page#entry_fulfillment entry_fulfillment} of a {::Google::Cloud::Dialogflow::CX::V3::Page Page} if
115
+ # * In the
116
+ # {::Google::Cloud::Dialogflow::CX::V3::Page#entry_fulfillment entry_fulfillment}
117
+ # of a {::Google::Cloud::Dialogflow::CX::V3::Page Page} if
109
118
  # entering the page indicates something went extremely wrong in the
110
119
  # conversation.
111
120
  # * In a webhook response when you determine that the customer issue can only
@@ -129,7 +138,9 @@ module Google
129
138
  # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess ConversationSuccess}.
130
139
  #
131
140
  # You may set this, for example:
132
- # * In the {::Google::Cloud::Dialogflow::CX::V3::Page#entry_fulfillment entry_fulfillment} of a {::Google::Cloud::Dialogflow::CX::V3::Page Page} if
141
+ # * In the
142
+ # {::Google::Cloud::Dialogflow::CX::V3::Page#entry_fulfillment entry_fulfillment}
143
+ # of a {::Google::Cloud::Dialogflow::CX::V3::Page Page} if
133
144
  # entering the page indicates that the conversation succeeded.
134
145
  # * In a webhook response when you determine that you handled the customer
135
146
  # issue.
@@ -152,8 +163,8 @@ module Google
152
163
  # [SSML](/speech/text-to-speech/docs/ssml).
153
164
  # @!attribute [r] allow_playback_interruption
154
165
  # @return [::Boolean]
155
- # Output only. Whether the playback of this message can be interrupted by the end
156
- # user's speech and the client can then starts the next Dialogflow
166
+ # Output only. Whether the playback of this message can be interrupted by
167
+ # the end user's speech and the client can then starts the next Dialogflow
157
168
  # request.
158
169
  class OutputAudioText
159
170
  include ::Google::Protobuf::MessageExts
@@ -171,12 +182,12 @@ module Google
171
182
  # Specifies an audio clip to be played by the client as part of the response.
172
183
  # @!attribute [rw] audio_uri
173
184
  # @return [::String]
174
- # Required. URI of the audio clip. Dialogflow does not impose any validation on this
175
- # value. It is specific to the client that reads it.
185
+ # Required. URI of the audio clip. Dialogflow does not impose any
186
+ # validation on this value. It is specific to the client that reads it.
176
187
  # @!attribute [r] allow_playback_interruption
177
188
  # @return [::Boolean]
178
- # Output only. Whether the playback of this message can be interrupted by the end
179
- # user's speech and the client can then starts the next Dialogflow
189
+ # Output only. Whether the playback of this message can be interrupted by
190
+ # the end user's speech and the client can then starts the next Dialogflow
180
191
  # request.
181
192
  class PlayAudio
182
193
  include ::Google::Protobuf::MessageExts
@@ -208,9 +219,9 @@ module Google
208
219
  # client. Dialogflow does not impose any validation on it.
209
220
  # @!attribute [r] allow_playback_interruption
210
221
  # @return [::Boolean]
211
- # Output only. Whether the playback of this segment can be interrupted by the end
212
- # user's speech and the client should then start the next Dialogflow
213
- # request.
222
+ # Output only. Whether the playback of this segment can be interrupted by
223
+ # the end user's speech and the client should then start the next
224
+ # Dialogflow request.
214
225
  class Segment
215
226
  include ::Google::Protobuf::MessageExts
216
227
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb CHANGED
@@ -22,7 +22,8 @@ module Google
22
22
  module Dialogflow
23
23
  module CX
24
24
  module V3
25
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#get_security_settings SecuritySettingsService.GetSecuritySettings}.
25
+ # The request message for
26
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#get_security_settings SecuritySettingsService.GetSecuritySettings}.
26
27
  # @!attribute [rw] name
27
28
  # @return [::String]
28
29
  # Required. Resource name of the settings.
@@ -33,15 +34,16 @@ module Google
33
34
  extend ::Google::Protobuf::MessageExts::ClassMethods
34
35
  end
35
36
 
36
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#update_security_settings SecuritySettingsService.UpdateSecuritySettings}.
37
+ # The request message for
38
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#update_security_settings SecuritySettingsService.UpdateSecuritySettings}.
37
39
  # @!attribute [rw] security_settings
38
40
  # @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings]
39
41
  # Required. [SecuritySettings] object that contains values for each of the
40
42
  # fields to update.
41
43
  # @!attribute [rw] update_mask
42
44
  # @return [::Google::Protobuf::FieldMask]
43
- # Required. The mask to control which fields get updated. If the mask is not present,
44
- # all fields will be updated.
45
+ # Required. The mask to control which fields get updated. If the mask is not
46
+ # present, all fields will be updated.
45
47
  class UpdateSecuritySettingsRequest
46
48
  include ::Google::Protobuf::MessageExts
47
49
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -80,7 +82,8 @@ module Google
80
82
  # The request message for [SecuritySettings.CreateSecuritySettings][].
81
83
  # @!attribute [rw] parent
82
84
  # @return [::String]
83
- # Required. The location to create an {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} for.
85
+ # Required. The location to create an
86
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} for.
84
87
  # Format: `projects/<Project ID>/locations/<Location ID>`.
85
88
  # @!attribute [rw] security_settings
86
89
  # @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings]
@@ -93,8 +96,9 @@ module Google
93
96
  # The request message for [SecuritySettings.DeleteSecuritySettings][].
94
97
  # @!attribute [rw] name
95
98
  # @return [::String]
96
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} to delete.
97
- # Format: `projects/<Project ID>/locations/<Location
99
+ # Required. The name of the
100
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} to
101
+ # delete. Format: `projects/<Project ID>/locations/<Location
98
102
  # ID>/securitySettings/<Security Settings ID>`.
99
103
  class DeleteSecuritySettingsRequest
100
104
  include ::Google::Protobuf::MessageExts
@@ -107,15 +111,16 @@ module Google
107
111
  # @!attribute [rw] name
108
112
  # @return [::String]
109
113
  # Resource name of the settings.
110
- # Required for the {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#update_security_settings SecuritySettingsService.UpdateSecuritySettings} method.
111
- # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#create_security_settings SecuritySettingsService.CreateSecuritySettings} populates the name
112
- # automatically.
113
- # Format: `projects/<Project ID>/locations/<Location
114
- # ID>/securitySettings/<Security Settings ID>`.
114
+ # Required for the
115
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#update_security_settings SecuritySettingsService.UpdateSecuritySettings}
116
+ # method.
117
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#create_security_settings SecuritySettingsService.CreateSecuritySettings}
118
+ # populates the name automatically. Format: `projects/<Project
119
+ # ID>/locations/<Location ID>/securitySettings/<Security Settings ID>`.
115
120
  # @!attribute [rw] display_name
116
121
  # @return [::String]
117
- # Required. The human-readable name of the security settings, unique within the
118
- # location.
122
+ # Required. The human-readable name of the security settings, unique within
123
+ # the location.
119
124
  # @!attribute [rw] redaction_strategy
120
125
  # @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy]
121
126
  # Strategy that defines how we do redaction.
@@ -164,15 +169,11 @@ module Google
164
169
  # `SecuritySettings`.
165
170
  # @!attribute [rw] retention_window_days
166
171
  # @return [::Integer]
167
- # Retains data in interaction logging for the specified number of days.
168
- # This does not apply to Cloud logging, which is owned by the user - not
169
- # Dialogflow.
170
- # User must set a value lower than Dialogflow's default 365d TTL. Setting a
171
- # value higher than that has no effect.
172
- # A missing value or setting to 0 also means we use Dialogflow's default
173
- # TTL.
174
- # Note: Interaction logging is a limited access feature. Talk to your
175
- # Google representative to check availability for you.
172
+ # Retains the data for the specified number of days.
173
+ # User must set a value lower than Dialogflow's default 365d TTL (30 days
174
+ # for Agent Assist traffic), higher value will be ignored and use default.
175
+ # Setting a value higher than that has no effect. A missing value or
176
+ # setting to 0 also means we use default TTL.
176
177
  # @!attribute [rw] purge_data_types
177
178
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>]
178
179
  # List of types of data to remove when retention settings triggers purge.
@@ -182,22 +183,28 @@ module Google
182
183
  # ingesting audio to conversations via [Participants.AnalyzeContent][] or
183
184
  # [Participants.StreamingAnalyzeContent][].
184
185
  #
185
- # If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy] is set to REMOVE_AFTER_CONVERSATION or
186
- # [audio_export_settings.gcs_bucket][] is empty, audio export is disabled.
186
+ # If
187
+ # [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy]
188
+ # is set to REMOVE_AFTER_CONVERSATION or [audio_export_settings.gcs_bucket][]
189
+ # is empty, audio export is disabled.
187
190
  #
188
191
  # If audio export is enabled, audio is recorded and saved to
189
192
  # [audio_export_settings.gcs_bucket][], subject to retention policy of
190
193
  # [audio_export_settings.gcs_bucket][].
191
194
  #
192
195
  # This setting won't effect audio input for implicit sessions via
193
- # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#detect_intent Sessions.DetectIntent} or {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent Sessions.StreamingDetectIntent}.
196
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#detect_intent Sessions.DetectIntent}
197
+ # or
198
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent Sessions.StreamingDetectIntent}.
194
199
  # @!attribute [rw] insights_export_settings
195
200
  # @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::InsightsExportSettings]
196
201
  # Controls conversation exporting settings to Insights after conversation is
197
202
  # completed.
198
203
  #
199
- # If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy] is set to REMOVE_AFTER_CONVERSATION,
200
- # Insights export is disabled no matter what you configure here.
204
+ # If
205
+ # [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy]
206
+ # is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter
207
+ # what you configure here.
201
208
  class SecuritySettings
202
209
  include ::Google::Protobuf::MessageExts
203
210
  extend ::Google::Protobuf::MessageExts::ClassMethods