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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +30 -20
  3. data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +1 -1
  4. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +2 -1
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +44 -25
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +12 -15
  7. data/lib/google/cloud/dialogflow/cx/v3/agents/paths.rb +19 -0
  8. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +44 -25
  9. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +43 -38
  10. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/service_stub.rb +102 -68
  11. data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +1 -1
  12. data/lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb +1 -1
  13. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +32 -6
  14. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +32 -6
  15. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/service_stub.rb +30 -14
  16. data/lib/google/cloud/dialogflow/cx/v3/data_store_connection_pb.rb +1 -1
  17. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +32 -8
  18. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +32 -8
  19. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/service_stub.rb +30 -14
  20. data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +1 -1
  21. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +43 -21
  22. data/lib/google/cloud/dialogflow/cx/v3/entity_types/operations.rb +12 -15
  23. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +43 -21
  24. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/operations.rb +43 -38
  25. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/service_stub.rb +70 -44
  26. data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +1 -1
  27. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +50 -27
  28. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +12 -15
  29. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +50 -27
  30. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +43 -38
  31. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/service_stub.rb +86 -56
  32. data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +1 -1
  33. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +38 -21
  34. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +38 -21
  35. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/service_stub.rb +70 -44
  36. data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +1 -1
  37. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +47 -26
  38. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +12 -15
  39. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +47 -26
  40. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +43 -38
  41. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/service_stub.rb +94 -62
  42. data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +1 -1
  43. data/lib/google/cloud/dialogflow/cx/v3/gcs_pb.rb +1 -1
  44. data/lib/google/cloud/dialogflow/cx/v3/generative_settings_pb.rb +1 -1
  45. data/lib/google/cloud/dialogflow/cx/v3/generator_pb.rb +2 -1
  46. data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +35 -12
  47. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +35 -12
  48. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/service_stub.rb +54 -32
  49. data/lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb +1 -1
  50. data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +1 -1
  51. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +41 -19
  52. data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +12 -15
  53. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +41 -19
  54. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +43 -38
  55. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/service_stub.rb +70 -44
  56. data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +1 -1
  57. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +37 -14
  58. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +37 -14
  59. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/service_stub.rb +54 -32
  60. data/lib/google/cloud/dialogflow/cx/v3/safety_settings_pb.rb +1 -1
  61. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +35 -12
  62. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +35 -12
  63. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/service_stub.rb +54 -32
  64. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +54 -29
  65. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +54 -29
  66. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/service_stub.rb +54 -32
  67. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +5 -1
  68. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +40 -16
  69. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +40 -14
  70. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb +47 -26
  71. data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +1 -1
  72. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +59 -38
  73. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +12 -15
  74. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +59 -38
  75. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +43 -38
  76. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/service_stub.rb +110 -74
  77. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +1 -1
  78. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +43 -21
  79. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +43 -21
  80. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/service_stub.rb +54 -32
  81. data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +1 -1
  82. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  83. data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +1 -1
  84. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +44 -22
  85. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +12 -15
  86. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +44 -22
  87. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +43 -38
  88. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/service_stub.rb +70 -44
  89. data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +1 -1
  90. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +35 -12
  91. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +35 -12
  92. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/service_stub.rb +54 -32
  93. data/proto_docs/google/api/client.rb +39 -0
  94. data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb +1 -1
  95. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +44 -20
  96. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +6 -0
  97. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +5 -5
  98. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +11 -13
  99. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +16 -17
  100. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +26 -28
  101. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +15 -19
  102. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +28 -27
  103. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +2 -2
  104. data/proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb +2 -2
  105. data/proto_docs/google/cloud/dialogflow/cx/v3/generator.rb +41 -8
  106. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +19 -19
  107. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +33 -33
  108. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +2 -1
  109. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +14 -14
  110. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +107 -22
  111. data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +30 -28
  112. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +41 -43
  113. data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +16 -18
  114. data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +19 -19
  115. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +24 -25
  116. data/proto_docs/google/longrunning/operations.rb +19 -14
  117. metadata +5 -5
@@ -33,7 +33,8 @@ module Google
33
33
  # classification threshold. If the returned score value is less than the
34
34
  # threshold value, then a no-match event will be triggered. The score values
35
35
  # range from 0.0 (completely uncertain) to 1.0 (completely certain). If set
36
- # to 0.0, the default of 0.3 is used.
36
+ # to 0.0, the default of 0.3 is used. You can set a separate classification
37
+ # threshold for the flow in each language enabled for the agent.
37
38
  # @!attribute [rw] model_training_mode
38
39
  # @return [::Google::Cloud::Dialogflow::CX::V3::NluSettings::ModelTrainingMode]
39
40
  # Indicates NLU model training mode.
@@ -85,8 +86,8 @@ module Google
85
86
  # @!attribute [rw] name
86
87
  # @return [::String]
87
88
  # The unique identifier of the flow.
88
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
89
- # ID>/flows/<Flow ID>`.
89
+ # Format:
90
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
90
91
  # @!attribute [rw] display_name
91
92
  # @return [::String]
92
93
  # Required. The human-readable name of the flow.
@@ -137,11 +138,11 @@ module Google
137
138
  # route groups][Page.transition_route_groups]. Transition route groups
138
139
  # defined in the page have higher priority than those defined in the flow.
139
140
  #
140
- # Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
141
- # ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
142
- # or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
143
- # ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
144
- # groups.
141
+ # Format:
142
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
143
+ # or
144
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
145
+ # for agent-level groups.
145
146
  # @!attribute [rw] nlu_settings
146
147
  # @return [::Google::Cloud::Dialogflow::CX::V3::NluSettings]
147
148
  # NLU related settings of the flow.
@@ -190,7 +191,7 @@ module Google
190
191
  # @!attribute [rw] parent
191
192
  # @return [::String]
192
193
  # Required. The agent to create a flow for.
193
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
194
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
194
195
  # @!attribute [rw] flow
195
196
  # @return [::Google::Cloud::Dialogflow::CX::V3::Flow]
196
197
  # Required. The flow to create.
@@ -218,8 +219,8 @@ module Google
218
219
  # @!attribute [rw] name
219
220
  # @return [::String]
220
221
  # Required. The name of the flow to delete.
221
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
222
- # ID>/flows/<Flow ID>`.
222
+ # Format:
223
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
223
224
  # @!attribute [rw] force
224
225
  # @return [::Boolean]
225
226
  # This field has no effect for flows with no incoming transitions.
@@ -242,7 +243,7 @@ module Google
242
243
  # @!attribute [rw] parent
243
244
  # @return [::String]
244
245
  # Required. The agent containing the flows.
245
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
246
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
246
247
  # @!attribute [rw] page_size
247
248
  # @return [::Integer]
248
249
  # The maximum number of items to return in a single page. By default 100 and
@@ -290,8 +291,8 @@ module Google
290
291
  # @!attribute [rw] name
291
292
  # @return [::String]
292
293
  # Required. The name of the flow to get.
293
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
294
- # ID>/flows/<Flow ID>`.
294
+ # Format:
295
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
295
296
  # @!attribute [rw] language_code
296
297
  # @return [::String]
297
298
  # The language to retrieve the flow for. The following fields are language
@@ -345,8 +346,8 @@ module Google
345
346
  # @!attribute [rw] name
346
347
  # @return [::String]
347
348
  # Required. The flow to train.
348
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
349
- # ID>/flows/<Flow ID>`.
349
+ # Format:
350
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
350
351
  class TrainFlowRequest
351
352
  include ::Google::Protobuf::MessageExts
352
353
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -357,8 +358,8 @@ module Google
357
358
  # @!attribute [rw] name
358
359
  # @return [::String]
359
360
  # Required. The flow to validate.
360
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
361
- # ID>/flows/<Flow ID>`.
361
+ # Format:
362
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
362
363
  # @!attribute [rw] language_code
363
364
  # @return [::String]
364
365
  # If not specified, the agent's default language is used.
@@ -372,8 +373,8 @@ module Google
372
373
  # @!attribute [rw] name
373
374
  # @return [::String]
374
375
  # Required. The flow name.
375
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
376
- # ID>/flows/<Flow ID>/validationResult`.
376
+ # Format:
377
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/validationResult`.
377
378
  # @!attribute [rw] language_code
378
379
  # @return [::String]
379
380
  # If not specified, the agent's default language is used.
@@ -387,8 +388,8 @@ module Google
387
388
  # @!attribute [rw] name
388
389
  # @return [::String]
389
390
  # The unique identifier of the flow validation result.
390
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
391
- # ID>/flows/<Flow ID>/validationResult`.
391
+ # Format:
392
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/validationResult`.
392
393
  # @!attribute [rw] validation_messages
393
394
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ValidationMessage>]
394
395
  # Contains all validation messages.
@@ -405,7 +406,7 @@ module Google
405
406
  # @!attribute [rw] parent
406
407
  # @return [::String]
407
408
  # Required. The agent to import the flow into.
408
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
409
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
409
410
  # @!attribute [rw] flow_uri
410
411
  # @return [::String]
411
412
  # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
@@ -466,8 +467,8 @@ module Google
466
467
  # @!attribute [rw] flow
467
468
  # @return [::String]
468
469
  # The unique identifier of the new flow.
469
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
470
- # ID>/flows/<Flow ID>`.
470
+ # Format:
471
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
471
472
  class ImportFlowResponse
472
473
  include ::Google::Protobuf::MessageExts
473
474
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -478,8 +479,8 @@ module Google
478
479
  # @!attribute [rw] name
479
480
  # @return [::String]
480
481
  # Required. The name of the flow to export.
481
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
482
- # ID>/flows/<Flow ID>`.
482
+ # Format:
483
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
483
484
  # @!attribute [rw] flow_uri
484
485
  # @return [::String]
485
486
  # Optional. The [Google Cloud
@@ -43,8 +43,8 @@ module Google
43
43
  # @!attribute [rw] webhook
44
44
  # @return [::String]
45
45
  # The webhook to call.
46
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
47
- # ID>/webhooks/<Webhook ID>`.
46
+ # Format:
47
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
48
48
  # @!attribute [rw] return_partial_responses
49
49
  # @return [::Boolean]
50
50
  # Whether Dialogflow should return currently queued fulfillment response
@@ -25,8 +25,8 @@ module Google
25
25
  # Settings for Generative AI.
26
26
  # @!attribute [rw] name
27
27
  # @return [::String]
28
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
29
- # ID>/generativeSettings`.
28
+ # Format:
29
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generativeSettings`.
30
30
  # @!attribute [rw] fallback_settings
31
31
  # @return [::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings]
32
32
  # Settings for Generative Fallback.
@@ -32,8 +32,8 @@ module Google
32
32
  # Must be set for the
33
33
  # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#update_generator Generators.UpdateGenerator}
34
34
  # method. [Generators.CreateGenerate][] populates the name automatically.
35
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
36
- # ID>/generators/<Generator ID>`.
35
+ # Format:
36
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
37
37
  # @!attribute [rw] display_name
38
38
  # @return [::String]
39
39
  # Required. The human-readable name of the generator, unique within the
@@ -46,6 +46,9 @@ module Google
46
46
  # @!attribute [rw] placeholders
47
47
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>]
48
48
  # Optional. List of custom placeholders in the prompt text.
49
+ # @!attribute [rw] model_parameter
50
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter]
51
+ # Parameters passed to the LLM to configure its behavior.
49
52
  class Generator
50
53
  include ::Google::Protobuf::MessageExts
51
54
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -61,6 +64,36 @@ module Google
61
64
  include ::Google::Protobuf::MessageExts
62
65
  extend ::Google::Protobuf::MessageExts::ClassMethods
63
66
  end
67
+
68
+ # Parameters to be passed to the LLM. If not set, default values will be
69
+ # used.
70
+ # @!attribute [rw] temperature
71
+ # @return [::Float]
72
+ # The temperature used for sampling. Temperature sampling occurs after both
73
+ # topP and topK have been applied.
74
+ # Valid range: [0.0, 1.0]
75
+ # Low temperature = less random. High temperature = more random.
76
+ # @!attribute [rw] max_decode_steps
77
+ # @return [::Integer]
78
+ # The maximum number of tokens to generate.
79
+ # @!attribute [rw] top_p
80
+ # @return [::Float]
81
+ # If set, only the tokens comprising the top top_p probability mass are
82
+ # considered. If both top_p and top_k are
83
+ # set, top_p will be used for further refining candidates selected with
84
+ # top_k.
85
+ # Valid range: (0.0, 1.0].
86
+ # Small topP = less random. Large topP = more random.
87
+ # @!attribute [rw] top_k
88
+ # @return [::Integer]
89
+ # If set, the sampling process in each step is limited to the top_k tokens
90
+ # with highest probabilities.
91
+ # Valid range: [1, 40] or 1000+.
92
+ # Small topK = less random. Large topK = more random.
93
+ class ModelParameter
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
64
97
  end
65
98
 
66
99
  # Text input which can be used for prompt or banned phrases.
@@ -77,7 +110,7 @@ module Google
77
110
  # @!attribute [rw] parent
78
111
  # @return [::String]
79
112
  # Required. The agent to list all generators for.
80
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
113
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
81
114
  # @!attribute [rw] language_code
82
115
  # @return [::String]
83
116
  # The language to list generators for.
@@ -113,8 +146,8 @@ module Google
113
146
  # @!attribute [rw] name
114
147
  # @return [::String]
115
148
  # Required. The name of the generator.
116
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
117
- # ID>/generators/<Generator ID>`.
149
+ # Format:
150
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
118
151
  # @!attribute [rw] language_code
119
152
  # @return [::String]
120
153
  # The language to list generators for.
@@ -128,7 +161,7 @@ module Google
128
161
  # @!attribute [rw] parent
129
162
  # @return [::String]
130
163
  # Required. The agent to create a generator for.
131
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
164
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
132
165
  # @!attribute [rw] generator
133
166
  # @return [::Google::Cloud::Dialogflow::CX::V3::Generator]
134
167
  # Required. The generator to create.
@@ -164,8 +197,8 @@ module Google
164
197
  # @!attribute [rw] name
165
198
  # @return [::String]
166
199
  # Required. The name of the generator to delete.
167
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
168
- # ID>/generators/<Generator ID>`.
200
+ # Format:
201
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
169
202
  # @!attribute [rw] force
170
203
  # @return [::Boolean]
171
204
  # This field has no effect for generators not being used.
@@ -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`.