google-cloud-dialogflow-cx-v3 1.1.1 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +2 -1
  4. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +13 -13
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/paths.rb +19 -0
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +13 -13
  7. data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +1 -1
  8. data/lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb +1 -1
  9. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +3 -3
  10. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +3 -3
  11. data/lib/google/cloud/dialogflow/cx/v3/data_store_connection_pb.rb +1 -1
  12. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +3 -5
  13. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +3 -5
  14. data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +1 -1
  15. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +12 -13
  16. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +12 -13
  17. data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +1 -1
  18. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +15 -17
  19. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +15 -17
  20. data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +1 -1
  21. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +9 -13
  22. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +9 -13
  23. data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +1 -1
  24. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +15 -15
  25. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +15 -15
  26. data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +1 -1
  27. data/lib/google/cloud/dialogflow/cx/v3/gcs_pb.rb +1 -1
  28. data/lib/google/cloud/dialogflow/cx/v3/generative_settings_pb.rb +1 -1
  29. data/lib/google/cloud/dialogflow/cx/v3/generator_pb.rb +2 -1
  30. data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +6 -6
  31. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +6 -6
  32. data/lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb +1 -1
  33. data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +1 -1
  34. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +10 -11
  35. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +10 -11
  36. data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +1 -1
  37. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +8 -8
  38. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +8 -8
  39. data/lib/google/cloud/dialogflow/cx/v3/safety_settings_pb.rb +1 -1
  40. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +6 -6
  41. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +6 -6
  42. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +25 -23
  43. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +25 -23
  44. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +5 -1
  45. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +12 -9
  46. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +12 -9
  47. data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +1 -1
  48. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +25 -25
  49. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +25 -25
  50. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +1 -1
  51. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +14 -15
  52. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +14 -15
  53. data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +1 -1
  54. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  55. data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +1 -1
  56. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +13 -14
  57. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +13 -14
  58. data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +1 -1
  59. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +6 -6
  60. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +6 -6
  61. data/proto_docs/google/api/client.rb +20 -0
  62. data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb +1 -1
  63. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +44 -20
  64. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +6 -0
  65. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +5 -5
  66. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +11 -13
  67. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +16 -17
  68. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +26 -28
  69. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +15 -19
  70. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +28 -27
  71. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +2 -2
  72. data/proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb +2 -2
  73. data/proto_docs/google/cloud/dialogflow/cx/v3/generator.rb +41 -8
  74. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +19 -19
  75. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +33 -33
  76. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +2 -1
  77. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +14 -14
  78. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +107 -22
  79. data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +30 -28
  80. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +41 -43
  81. data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +16 -18
  82. data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +19 -19
  83. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +24 -25
  84. metadata +3 -3
@@ -35,8 +35,8 @@ module Google
35
35
  # method.
36
36
  # {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#create_intent Intents.CreateIntent}
37
37
  # populates the name automatically.
38
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
39
- # ID>/intents/<Intent ID>`.
38
+ # Format:
39
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
40
40
  # @!attribute [rw] display_name
41
41
  # @return [::String]
42
42
  # Required. The human-readable name of the intent, unique within the agent.
@@ -145,11 +145,12 @@ module Google
145
145
  # @!attribute [rw] entity_type
146
146
  # @return [::String]
147
147
  # Required. The entity type of the parameter.
148
- # Format: `projects/-/locations/-/agents/-/entityTypes/<System Entity Type
149
- # ID>` for system entity types (for example,
148
+ # Format:
149
+ # `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
150
+ # system entity types (for example,
150
151
  # `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
151
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
152
- # ID>/entityTypes/<Entity Type ID>` for developer entity types.
152
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
153
+ # for developer entity types.
153
154
  # @!attribute [rw] is_list
154
155
  # @return [::Boolean]
155
156
  # Indicates whether the parameter represents a list of values.
@@ -181,7 +182,7 @@ module Google
181
182
  # @!attribute [rw] parent
182
183
  # @return [::String]
183
184
  # Required. The agent to list all intents for.
184
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
185
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
185
186
  # @!attribute [rw] language_code
186
187
  # @return [::String]
187
188
  # The language to list intents for. The following fields are language
@@ -229,8 +230,8 @@ module Google
229
230
  # @!attribute [rw] name
230
231
  # @return [::String]
231
232
  # Required. The name of the intent.
232
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
233
- # ID>/intents/<Intent ID>`.
233
+ # Format:
234
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
234
235
  # @!attribute [rw] language_code
235
236
  # @return [::String]
236
237
  # The language to retrieve the intent for. The following fields are language
@@ -253,7 +254,7 @@ module Google
253
254
  # @!attribute [rw] parent
254
255
  # @return [::String]
255
256
  # Required. The agent to create an intent for.
256
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
257
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
257
258
  # @!attribute [rw] intent
258
259
  # @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
259
260
  # Required. The intent to create.
@@ -303,8 +304,8 @@ module Google
303
304
  # @!attribute [rw] name
304
305
  # @return [::String]
305
306
  # Required. The name of the intent to delete.
306
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
307
- # ID>/intents/<Intent ID>`.
307
+ # Format:
308
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
308
309
  class DeleteIntentRequest
309
310
  include ::Google::Protobuf::MessageExts
310
311
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -315,7 +316,7 @@ module Google
315
316
  # @!attribute [rw] parent
316
317
  # @return [::String]
317
318
  # Required. The agent to import the intents into.
318
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
319
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
319
320
  # @!attribute [rw] intents_uri
320
321
  # @return [::String]
321
322
  # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
@@ -375,8 +376,8 @@ module Google
375
376
  # @!attribute [rw] intents
376
377
  # @return [::Array<::String>]
377
378
  # The unique identifier of the imported intents.
378
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
379
- # ID>/intents/<Intent ID>`.
379
+ # Format:
380
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
380
381
  # @!attribute [rw] conflicting_resources
381
382
  # @return [::Google::Cloud::Dialogflow::CX::V3::ImportIntentsResponse::ConflictingResources]
382
383
  # Info which resources have conflicts when
@@ -414,13 +415,12 @@ module Google
414
415
  # @!attribute [rw] parent
415
416
  # @return [::String]
416
417
  # Required. The name of the parent agent to export intents.
417
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
418
- # ID>`.
418
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
419
419
  # @!attribute [rw] intents
420
420
  # @return [::Array<::String>]
421
421
  # Required. The name of the intents to export.
422
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
423
- # ID>/intents/<Intent ID>`.
422
+ # Format:
423
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
424
424
  # @!attribute [rw] intents_uri
425
425
  # @return [::String]
426
426
  # Optional. The [Google Cloud
@@ -45,8 +45,8 @@ module Google
45
45
  # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#update_page Pages.UpdatePage} method.
46
46
  # {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#create_page Pages.CreatePage}
47
47
  # populates the name automatically.
48
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
49
- # ID>/flows/<Flow ID>/pages/<Page ID>`.
48
+ # Format:
49
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
50
50
  # @!attribute [rw] display_name
51
51
  # @return [::String]
52
52
  # Required. The human-readable name of the page, unique within the flow.
@@ -76,11 +76,10 @@ module Google
76
76
  # * If multiple transition route groups within a page contain the same
77
77
  # intent, then the first group in the ordered list takes precedence.
78
78
  #
79
- # Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
80
- # ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
81
- # or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
82
- # ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
83
- # groups.
79
+ # Format:`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
80
+ # or
81
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
82
+ # for agent-level groups.
84
83
  # @!attribute [rw] transition_routes
85
84
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRoute>]
86
85
  # A list of transitions for the transition rules of this page.
@@ -147,11 +146,12 @@ module Google
147
146
  # @!attribute [rw] entity_type
148
147
  # @return [::String]
149
148
  # Required. The entity type of the parameter.
150
- # Format: `projects/-/locations/-/agents/-/entityTypes/<System Entity Type
151
- # ID>` for system entity types (for example,
149
+ # Format:
150
+ # `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
151
+ # system entity types (for example,
152
152
  # `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
153
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
154
- # ID>/entityTypes/<Entity Type ID>` for developer entity types.
153
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
154
+ # for developer entity types.
155
155
  # @!attribute [rw] is_list
156
156
  # @return [::Boolean]
157
157
  # Indicates whether the parameter represents a list of values.
@@ -255,13 +255,13 @@ module Google
255
255
  # @!attribute [rw] target_page
256
256
  # @return [::String]
257
257
  # The target page to transition to.
258
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
259
- # ID>/flows/<Flow ID>/pages/<Page ID>`.
258
+ # Format:
259
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
260
260
  # @!attribute [rw] target_flow
261
261
  # @return [::String]
262
262
  # The target flow to transition to.
263
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
264
- # ID>/flows/<Flow ID>`.
263
+ # Format:
264
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
265
265
  class EventHandler
266
266
  include ::Google::Protobuf::MessageExts
267
267
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -293,8 +293,8 @@ module Google
293
293
  # @!attribute [rw] intent
294
294
  # @return [::String]
295
295
  # The unique identifier of an {::Google::Cloud::Dialogflow::CX::V3::Intent Intent}.
296
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
297
- # ID>/intents/<Intent ID>`.
296
+ # Format:
297
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
298
298
  # Indicates that the transition can only happen when the given intent is
299
299
  # matched.
300
300
  # At least one of `intent` or `condition` must be specified. When both
@@ -319,13 +319,13 @@ module Google
319
319
  # @!attribute [rw] target_page
320
320
  # @return [::String]
321
321
  # The target page to transition to.
322
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
323
- # ID>/flows/<Flow ID>/pages/<Page ID>`.
322
+ # Format:
323
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
324
324
  # @!attribute [rw] target_flow
325
325
  # @return [::String]
326
326
  # The target flow to transition to.
327
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
328
- # ID>/flows/<Flow ID>`.
327
+ # Format:
328
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
329
329
  class TransitionRoute
330
330
  include ::Google::Protobuf::MessageExts
331
331
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -336,8 +336,8 @@ module Google
336
336
  # @!attribute [rw] parent
337
337
  # @return [::String]
338
338
  # Required. The flow to list all pages for.
339
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
340
- # ID>/flows/<Flow ID>`.
339
+ # Format:
340
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
341
341
  # @!attribute [rw] language_code
342
342
  # @return [::String]
343
343
  # The language to list pages for. The following fields are language
@@ -393,8 +393,8 @@ module Google
393
393
  # @!attribute [rw] name
394
394
  # @return [::String]
395
395
  # Required. The name of the page.
396
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
397
- # ID>/flows/<Flow ID>/pages/<Page ID>`.
396
+ # Format:
397
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
398
398
  # @!attribute [rw] language_code
399
399
  # @return [::String]
400
400
  # The language to retrieve the page for. The following fields are language
@@ -428,8 +428,8 @@ module Google
428
428
  # @!attribute [rw] parent
429
429
  # @return [::String]
430
430
  # Required. The flow to create a page for.
431
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
432
- # ID>/flows/<Flow ID>`.
431
+ # Format:
432
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
433
433
  # @!attribute [rw] page
434
434
  # @return [::Google::Cloud::Dialogflow::CX::V3::Page]
435
435
  # Required. The page to create.
@@ -501,8 +501,8 @@ module Google
501
501
  # @!attribute [rw] name
502
502
  # @return [::String]
503
503
  # Required. The name of the page to delete.
504
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
505
- # ID>/Flows/<flow ID>/pages/<Page ID>`.
504
+ # Format:
505
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/Flows/<flowID>/pages/<PageID>`.
506
506
  # @!attribute [rw] force
507
507
  # @return [::Boolean]
508
508
  # This field has no effect for pages with no incoming transitions.
@@ -538,13 +538,13 @@ module Google
538
538
  # @!attribute [rw] target_page
539
539
  # @return [::String]
540
540
  # The target page to transition to.
541
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
542
- # ID>/flows/<Flow ID>/pages/<Page ID>`.
541
+ # Format:
542
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
543
543
  # @!attribute [rw] target_flow
544
544
  # @return [::String]
545
545
  # The target flow to transition to.
546
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
547
- # ID>/flows/<Flow ID>`.
546
+ # Format:
547
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
548
548
  # @!attribute [rw] data_store_connections
549
549
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>]
550
550
  # Optional. List of related data store connections.
@@ -101,7 +101,8 @@ module Google
101
101
  # The text response message.
102
102
  # @!attribute [rw] text
103
103
  # @return [::Array<::String>]
104
- # Required. A collection of text responses.
104
+ # Required. A collection of text response variants. If multiple variants
105
+ # are defined, only one text response variant is returned at runtime.
105
106
  # @!attribute [r] allow_playback_interruption
106
107
  # @return [::Boolean]
107
108
  # Output only. Whether the playback of this message can be interrupted by
@@ -27,8 +27,8 @@ module Google
27
27
  # @!attribute [rw] name
28
28
  # @return [::String]
29
29
  # Required. Resource name of the settings.
30
- # Format: `projects/<Project ID>/locations/<Location
31
- # ID>/securitySettings/<security settings ID>`.
30
+ # Format:
31
+ # `projects/<ProjectID>/locations/<LocationID>/securitySettings/<securitysettingsID>`.
32
32
  class GetSecuritySettingsRequest
33
33
  include ::Google::Protobuf::MessageExts
34
34
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -53,7 +53,7 @@ module Google
53
53
  # @!attribute [rw] parent
54
54
  # @return [::String]
55
55
  # Required. The location to list all security settings for.
56
- # Format: `projects/<Project ID>/locations/<Location ID>`.
56
+ # Format: `projects/<ProjectID>/locations/<LocationID>`.
57
57
  # @!attribute [rw] page_size
58
58
  # @return [::Integer]
59
59
  # The maximum number of items to return in a single page. By default 20 and
@@ -84,7 +84,7 @@ module Google
84
84
  # @return [::String]
85
85
  # Required. The location to create an
86
86
  # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} for.
87
- # Format: `projects/<Project ID>/locations/<Location ID>`.
87
+ # Format: `projects/<ProjectID>/locations/<LocationID>`.
88
88
  # @!attribute [rw] security_settings
89
89
  # @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings]
90
90
  # Required. The security settings to create.
@@ -98,8 +98,8 @@ module Google
98
98
  # @return [::String]
99
99
  # Required. The name of the
100
100
  # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} to
101
- # delete. Format: `projects/<Project ID>/locations/<Location
102
- # ID>/securitySettings/<Security Settings ID>`.
101
+ # delete. Format:
102
+ # `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
103
103
  class DeleteSecuritySettingsRequest
104
104
  include ::Google::Protobuf::MessageExts
105
105
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -115,8 +115,8 @@ module Google
115
115
  # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#update_security_settings SecuritySettingsService.UpdateSecuritySettings}
116
116
  # method.
117
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>`.
118
+ # populates the name automatically. Format:
119
+ # `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
120
120
  # @!attribute [rw] display_name
121
121
  # @return [::String]
122
122
  # Required. The human-readable name of the security settings, unique within
@@ -142,9 +142,9 @@ module Google
142
142
  # If empty, we use the default DLP inspect config.
143
143
  #
144
144
  # The template name will have one of the following formats:
145
- # `projects/<Project ID>/locations/<Location ID>/inspectTemplates/<Template
146
- # ID>` OR `organizations/<Organization ID>/locations/<Location
147
- # ID>/inspectTemplates/<Template ID>`
145
+ # `projects/<ProjectID>/locations/<LocationID>/inspectTemplates/<TemplateID>`
146
+ # OR
147
+ # `organizations/<OrganizationID>/locations/<LocationID>/inspectTemplates/<TemplateID>`
148
148
  #
149
149
  # Note: `inspect_template` must be located in the same region as the
150
150
  # `SecuritySettings`.
@@ -161,9 +161,9 @@ module Google
161
161
  # If empty, Dialogflow replaces sensitive info with `[redacted]` text.
162
162
  #
163
163
  # The template name will have one of the following formats:
164
- # `projects/<Project ID>/locations/<Location
165
- # ID>/deidentifyTemplates/<Template ID>` OR `organizations/<Organization
166
- # ID>/locations/<Location ID>/deidentifyTemplates/<Template ID>`
164
+ # `projects/<ProjectID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`
165
+ # OR
166
+ # `organizations/<OrganizationID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`
167
167
  #
168
168
  # Note: `deidentify_template` must be located in the same region as the
169
169
  # `SecuritySettings`.
@@ -91,9 +91,10 @@ module Google
91
91
  # @!attribute [rw] session
92
92
  # @return [::String]
93
93
  # Required. The name of the session this query is sent to.
94
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
95
- # ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
96
- # ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
94
+ # Format:
95
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<Session
96
+ # ID>` or
97
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
97
98
  # If `Environment ID` is not specified, we assume default 'draft'
98
99
  # environment.
99
100
  # It's up to the API caller to choose an appropriate `Session ID`. It can be
@@ -207,9 +208,10 @@ module Google
207
208
  # @!attribute [rw] session
208
209
  # @return [::String]
209
210
  # The name of the session this query is sent to.
210
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
211
- # ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
212
- # ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
211
+ # Format:
212
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
213
+ # or
214
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
213
215
  # If `Environment ID` is not specified, we assume default 'draft'
214
216
  # environment.
215
217
  # It's up to the API caller to choose an appropriate `Session ID`. It can be
@@ -522,8 +524,8 @@ module Google
522
524
  # @return [::String]
523
525
  # The unique identifier of the {::Google::Cloud::Dialogflow::CX::V3::Page page} to
524
526
  # override the [current page][QueryResult.current_page] in the session.
525
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
526
- # ID>/flows/<Flow ID>/pages/<Page ID>`.
527
+ # Format:
528
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
527
529
  #
528
530
  # If `current_page` is specified, the previous state of the session will be
529
531
  # ignored by Dialogflow, including the [previous
@@ -553,8 +555,8 @@ module Google
553
555
  # @!attribute [rw] flow_versions
554
556
  # @return [::Array<::String>]
555
557
  # A list of flow versions to override for the request.
556
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
557
- # ID>/flows/<Flow ID>/versions/<Version ID>`.
558
+ # Format:
559
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
558
560
  #
559
561
  # If version 1 of flow X is included in this list, the traffic of
560
562
  # flow X will go through version 1 regardless of the version configuration in
@@ -679,9 +681,93 @@ module Google
679
681
  #
680
682
  # Setting to 0.0 means no boost applied. The boosting condition is
681
683
  # ignored.
684
+ # @!attribute [rw] boost_control_spec
685
+ # @return [::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec]
686
+ # Optional. Complex specification for custom ranking based on customer
687
+ # defined attribute value.
682
688
  class ConditionBoostSpec
683
689
  include ::Google::Protobuf::MessageExts
684
690
  extend ::Google::Protobuf::MessageExts::ClassMethods
691
+
692
+ # Specification for custom ranking based on customer specified attribute
693
+ # value. It provides more controls for customized ranking than the simple
694
+ # (condition, boost) combination above.
695
+ # @!attribute [rw] field_name
696
+ # @return [::String]
697
+ # Optional. The name of the field whose value will be used to determine
698
+ # the boost amount.
699
+ # @!attribute [rw] attribute_type
700
+ # @return [::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
701
+ # Optional. The attribute type to be used to determine the boost amount.
702
+ # The attribute value can be derived from the field value of the
703
+ # specified field_name. In the case of numerical it is straightforward
704
+ # i.e. attribute_value = numerical_field_value. In the case of freshness
705
+ # however, attribute_value = (time.now() - datetime_field_value).
706
+ # @!attribute [rw] interpolation_type
707
+ # @return [::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
708
+ # Optional. The interpolation type to be applied to connect the control
709
+ # points listed below.
710
+ # @!attribute [rw] control_points
711
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
712
+ # Optional. The control points used to define the curve. The monotonic
713
+ # function (defined through the interpolation_type above) passes through
714
+ # the control points listed here.
715
+ class BoostControlSpec
716
+ include ::Google::Protobuf::MessageExts
717
+ extend ::Google::Protobuf::MessageExts::ClassMethods
718
+
719
+ # The control points used to define the curve. The curve defined
720
+ # through these control points can only be monotonically increasing
721
+ # or decreasing(constant values are acceptable).
722
+ # @!attribute [rw] attribute_value
723
+ # @return [::String]
724
+ # Optional. Can be one of:
725
+ # 1. The numerical field value.
726
+ # 2. The duration spec for freshness:
727
+ # The value must be formatted as an XSD `dayTimeDuration` value (a
728
+ # restricted subset of an ISO 8601 duration value). The pattern for
729
+ # this is: `[nD][T[nH][nM][nS]]`.
730
+ # @!attribute [rw] boost_amount
731
+ # @return [::Float]
732
+ # Optional. The value between -1 to 1 by which to boost the score if
733
+ # the attribute_value evaluates to the value specified above.
734
+ class ControlPoint
735
+ include ::Google::Protobuf::MessageExts
736
+ extend ::Google::Protobuf::MessageExts::ClassMethods
737
+ end
738
+
739
+ # The attribute(or function) for which the custom ranking is to be
740
+ # applied.
741
+ module AttributeType
742
+ # Unspecified AttributeType.
743
+ ATTRIBUTE_TYPE_UNSPECIFIED = 0
744
+
745
+ # The value of the numerical field will be used to dynamically update
746
+ # the boost amount. In this case, the attribute_value (the x value)
747
+ # of the control point will be the actual value of the numerical
748
+ # field for which the boost_amount is specified.
749
+ NUMERICAL = 1
750
+
751
+ # For the freshness use case the attribute value will be the duration
752
+ # between the current time and the date in the datetime field
753
+ # specified. The value must be formatted as an XSD `dayTimeDuration`
754
+ # value (a restricted subset of an ISO 8601 duration value). The
755
+ # pattern for this is: `[nD][T[nH][nM][nS]]`.
756
+ # E.g. `5D`, `3DT12H30M`, `T24H`.
757
+ FRESHNESS = 2
758
+ end
759
+
760
+ # The interpolation type to be applied. Default will be linear
761
+ # (Piecewise Linear).
762
+ module InterpolationType
763
+ # Interpolation type is unspecified. In this case, it defaults to
764
+ # Linear.
765
+ INTERPOLATION_TYPE_UNSPECIFIED = 0
766
+
767
+ # Piecewise linear interpolation will be applied.
768
+ LINEAR = 1
769
+ end
770
+ end
685
771
  end
686
772
  end
687
773
 
@@ -765,8 +851,7 @@ module Google
765
851
  # @return [::String]
766
852
  # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
767
853
  # input, this field will contain a copy of the intent identifier. Format:
768
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
769
- # ID>/intents/<Intent ID>`.
854
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
770
855
  # @!attribute [rw] transcript
771
856
  # @return [::String]
772
857
  # If [natural language speech
@@ -904,8 +989,8 @@ module Google
904
989
  # @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals]
905
990
  # Optional. Data store connection feature output signals.
906
991
  # Filled only when data stores are involved in serving the query and
907
- # DetectIntentRequest.populate data_store_connection_quality_signals is set
908
- # to true in the request.
992
+ # DetectIntentRequest.populate_data_store_connection_signals is set to true
993
+ # in the request.
909
994
  class QueryResult
910
995
  include ::Google::Protobuf::MessageExts
911
996
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -925,8 +1010,8 @@ module Google
925
1010
  # @!attribute [rw] intent
926
1011
  # @return [::String]
927
1012
  # Required. The unique identifier of the intent.
928
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
929
- # ID>/intents/<Intent ID>`.
1013
+ # Format:
1014
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
930
1015
  class IntentInput
931
1016
  include ::Google::Protobuf::MessageExts
932
1017
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1058,9 +1143,10 @@ module Google
1058
1143
  # @!attribute [rw] session
1059
1144
  # @return [::String]
1060
1145
  # Required. The name of the session this query is sent to.
1061
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
1062
- # ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
1063
- # ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
1146
+ # Format:
1147
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
1148
+ # or
1149
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
1064
1150
  # If `Environment ID` is not specified, we assume default 'draft'
1065
1151
  # environment.
1066
1152
  # It's up to the API caller to choose an appropriate `Session ID`. It can be
@@ -1092,8 +1178,7 @@ module Google
1092
1178
  # @return [::String]
1093
1179
  # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
1094
1180
  # input, this field will contain a copy of the intent identifier. Format:
1095
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
1096
- # ID>/intents/<Intent ID>`.
1181
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
1097
1182
  # @!attribute [rw] transcript
1098
1183
  # @return [::String]
1099
1184
  # If [natural language speech
@@ -1168,7 +1253,7 @@ module Google
1168
1253
  # @!attribute [rw] score
1169
1254
  # @return [::Float]
1170
1255
  # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
1171
- # sentiment).
1256
+ # sentiment).
1172
1257
  # @!attribute [rw] magnitude
1173
1258
  # @return [::Float]
1174
1259
  # A non-negative number in the [0, +inf) range, which represents the absolute