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
data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb CHANGED
@@ -56,8 +56,8 @@ module Google
56
56
  # The unique identifier of the entity type.
57
57
  # Required for
58
58
  # {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#update_entity_type EntityTypes.UpdateEntityType}.
59
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
60
- # ID>/entityTypes/<Entity Type ID>`.
59
+ # Format:
60
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
61
61
  # @!attribute [rw] display_name
62
62
  # @return [::String]
63
63
  # Required. The human-readable name of the entity type, unique within the
@@ -165,13 +165,12 @@ module Google
165
165
  # @!attribute [rw] parent
166
166
  # @return [::String]
167
167
  # Required. The name of the parent agent to export entity types.
168
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
169
- # ID>`.
168
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
170
169
  # @!attribute [rw] entity_types
171
170
  # @return [::Array<::String>]
172
171
  # Required. The name of the entity types to export.
173
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
174
- # ID>/entityTypes/<EntityType ID>`.
172
+ # Format:
173
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
175
174
  # @!attribute [rw] entity_types_uri
176
175
  # @return [::String]
177
176
  # Optional. The [Google Cloud
@@ -252,7 +251,7 @@ module Google
252
251
  # @!attribute [rw] parent
253
252
  # @return [::String]
254
253
  # Required. The agent to import the entity types into.
255
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
254
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
256
255
  # @!attribute [rw] entity_types_uri
257
256
  # @return [::String]
258
257
  # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
@@ -273,8 +272,8 @@ module Google
273
272
  # @!attribute [rw] target_entity_type
274
273
  # @return [::String]
275
274
  # Optional. The target entity type to import into.
276
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
277
- # ID>/entity_types/<EntityType ID>`.
275
+ # Format:
276
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entity_types/<EntityTypeID>`.
278
277
  # If set, there should be only one entity type included in
279
278
  # [entity_types][google.cloud.dialogflow.cx.v3.ImportEntityTypesRequest.entity_types],
280
279
  # of which the type should match the type of the target entity type. All
@@ -316,8 +315,8 @@ module Google
316
315
  # @!attribute [rw] entity_types
317
316
  # @return [::Array<::String>]
318
317
  # The unique identifier of the imported entity types.
319
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
320
- # ID>/entity_types/<EntityType ID>`.
318
+ # Format:
319
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entity_types/<EntityTypeID>`.
321
320
  # @!attribute [rw] conflicting_resources
322
321
  # @return [::Google::Cloud::Dialogflow::CX::V3::ImportEntityTypesResponse::ConflictingResources]
323
322
  # Info which resources have conflicts when
@@ -355,7 +354,7 @@ module Google
355
354
  # @!attribute [rw] parent
356
355
  # @return [::String]
357
356
  # Required. The agent to list all entity types for.
358
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
357
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
359
358
  # @!attribute [rw] language_code
360
359
  # @return [::String]
361
360
  # The language to list entity types for. The following fields are language
@@ -402,8 +401,8 @@ module Google
402
401
  # @!attribute [rw] name
403
402
  # @return [::String]
404
403
  # Required. The name of the entity type.
405
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
406
- # ID>/entityTypes/<Entity Type ID>`.
404
+ # Format:
405
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
407
406
  # @!attribute [rw] language_code
408
407
  # @return [::String]
409
408
  # The language to retrieve the entity type for. The following fields are
@@ -428,7 +427,7 @@ module Google
428
427
  # @!attribute [rw] parent
429
428
  # @return [::String]
430
429
  # Required. The agent to create a entity type for.
431
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
430
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
432
431
  # @!attribute [rw] entity_type
433
432
  # @return [::Google::Cloud::Dialogflow::CX::V3::EntityType]
434
433
  # Required. The entity type to create.
@@ -481,8 +480,8 @@ module Google
481
480
  # @!attribute [rw] name
482
481
  # @return [::String]
483
482
  # Required. The name of the entity type to delete.
484
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
485
- # ID>/entityTypes/<Entity Type ID>`.
483
+ # Format:
484
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
486
485
  # @!attribute [rw] force
487
486
  # @return [::Boolean]
488
487
  # This field has no effect for entity type not being used.
data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb CHANGED
@@ -33,8 +33,8 @@ module Google
33
33
  # @!attribute [rw] name
34
34
  # @return [::String]
35
35
  # The name of the environment.
36
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
37
- # ID>/environments/<Environment ID>`.
36
+ # Format:
37
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
38
38
  # @!attribute [rw] display_name
39
39
  # @return [::String]
40
40
  # Required. The human-readable name of the environment (unique in an agent).
@@ -65,8 +65,11 @@ module Google
65
65
  # Configuration for the version.
66
66
  # @!attribute [rw] version
67
67
  # @return [::String]
68
- # Required. Format: projects/<Project ID>/locations/<Location
69
- # ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
68
+ # Required. Both flow and playbook versions are supported.
69
+ # Format for flow version:
70
+ # projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
71
+ # Format for playbook version:
72
+ # projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.
70
73
  class VersionConfig
71
74
  include ::Google::Protobuf::MessageExts
72
75
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -76,8 +79,8 @@ module Google
76
79
  # @!attribute [rw] test_cases
77
80
  # @return [::Array<::String>]
78
81
  # A list of test case names to run. They should be under the same agent.
79
- # Format of each test case name: `projects/<Project ID>/locations/
80
- # <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`
82
+ # Format of each test case name:
83
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`
81
84
  # @!attribute [rw] enable_continuous_run
82
85
  # @return [::Boolean]
83
86
  # Whether to run test cases in
@@ -112,8 +115,8 @@ module Google
112
115
  # @!attribute [rw] parent
113
116
  # @return [::String]
114
117
  # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to list all
115
- # environments for. Format: `projects/<Project ID>/locations/<Location
116
- # ID>/agents/<Agent ID>`.
118
+ # environments for. Format:
119
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
117
120
  # @!attribute [rw] page_size
118
121
  # @return [::Integer]
119
122
  # The maximum number of items to return in a single page. By default 20 and
@@ -149,8 +152,7 @@ module Google
149
152
  # @return [::String]
150
153
  # Required. The name of the
151
154
  # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. Format:
152
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
153
- # ID>/environments/<Environment ID>`.
155
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
154
156
  class GetEnvironmentRequest
155
157
  include ::Google::Protobuf::MessageExts
156
158
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -162,7 +164,7 @@ module Google
162
164
  # @return [::String]
163
165
  # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an
164
166
  # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for. Format:
165
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
167
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
166
168
  # @!attribute [rw] environment
167
169
  # @return [::Google::Cloud::Dialogflow::CX::V3::Environment]
168
170
  # Required. The environment to create.
@@ -190,8 +192,7 @@ module Google
190
192
  # @return [::String]
191
193
  # Required. The name of the
192
194
  # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete. Format:
193
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
194
- # ID>/environments/<Environment ID>`.
195
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
195
196
  class DeleteEnvironmentRequest
196
197
  include ::Google::Protobuf::MessageExts
197
198
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -202,8 +203,8 @@ module Google
202
203
  # @!attribute [rw] name
203
204
  # @return [::String]
204
205
  # Required. Resource name of the environment to look up the history for.
205
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
206
- # ID>/environments/<Environment ID>`.
206
+ # Format:
207
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
207
208
  # @!attribute [rw] page_size
208
209
  # @return [::Integer]
209
210
  # The maximum number of items to return in a single page. By default 100 and
@@ -236,9 +237,7 @@ module Google
236
237
  # @!attribute [rw] name
237
238
  # @return [::String]
238
239
  # The resource name for the continuous test result. Format:
239
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
240
- # ID>/environments/<Environment
241
- # ID>/continuousTestResults/<ContinuousTestResult ID>`.
240
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/continuousTestResults/<ContinuousTestResultID>`.
242
241
  # @!attribute [rw] result
243
242
  # @return [::Google::Cloud::Dialogflow::CX::V3::ContinuousTestResult::AggregatedTestResult]
244
243
  # The result of this continuous test run, i.e. whether all the tests in this
@@ -270,8 +269,8 @@ module Google
270
269
  # {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest}.
271
270
  # @!attribute [rw] environment
272
271
  # @return [::String]
273
- # Required. Format: `projects/<Project ID>/locations/<Location
274
- # ID>/agents/<Agent ID>/environments/<Environment ID>`.
272
+ # Required. Format:
273
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
275
274
  class RunContinuousTestRequest
276
275
  include ::Google::Protobuf::MessageExts
277
276
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -303,8 +302,8 @@ module Google
303
302
  # @!attribute [rw] parent
304
303
  # @return [::String]
305
304
  # Required. The environment to list results for.
306
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
307
- # environments/<Environment ID>`.
305
+ # Format:
306
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
308
307
  # @!attribute [rw] page_size
309
308
  # @return [::Integer]
310
309
  # The maximum number of items to return in a single page. By default 100 and
@@ -335,13 +334,13 @@ module Google
335
334
  # @!attribute [rw] environment
336
335
  # @return [::String]
337
336
  # Required. The environment to deploy the flow to.
338
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
339
- # environments/<Environment ID>`.
337
+ # Format:
338
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
340
339
  # @!attribute [rw] flow_version
341
340
  # @return [::String]
342
341
  # Required. The flow version to deploy.
343
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
344
- # flows/<Flow ID>/versions/<Version ID>`.
342
+ # Format:
343
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
345
344
  class DeployFlowRequest
346
345
  include ::Google::Protobuf::MessageExts
347
346
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -356,8 +355,7 @@ module Google
356
355
  # @return [::String]
357
356
  # The name of the flow version
358
357
  # {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}. Format:
359
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
360
- # environments/<Environment ID>/deployments/<Deployment ID>`.
358
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/deployments/<DeploymentID>`.
361
359
  class DeployFlowResponse
362
360
  include ::Google::Protobuf::MessageExts
363
361
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb CHANGED
@@ -26,8 +26,8 @@ module Google
26
26
  # @!attribute [rw] name
27
27
  # @return [::String]
28
28
  # The name of the experiment.
29
- # Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
30
- # ID>/environments/<Environment ID>/experiments/<Experiment ID>..
29
+ # Format:
30
+ # projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
31
31
  # @!attribute [rw] display_name
32
32
  # @return [::String]
33
33
  # Required. The human-readable name of the experiment (unique in an
@@ -162,8 +162,8 @@ module Google
162
162
  # @!attribute [rw] version
163
163
  # @return [::String]
164
164
  # The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
165
- # Format: `projects/<Project ID>/locations/<Location
166
- # ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
165
+ # Format:
166
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
167
167
  # @!attribute [rw] metrics
168
168
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
169
169
  # The metrics and corresponding confidence intervals in the inference
@@ -245,8 +245,8 @@ module Google
245
245
  # @!attribute [rw] version
246
246
  # @return [::String]
247
247
  # The name of the flow version.
248
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
249
- # ID>/flows/<Flow ID>/versions/<Version ID>`.
248
+ # Format:
249
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
250
250
  # @!attribute [rw] traffic_allocation
251
251
  # @return [::Float]
252
252
  # Percentage of the traffic which should be routed to this
@@ -333,9 +333,8 @@ module Google
333
333
  # @!attribute [rw] parent
334
334
  # @return [::String]
335
335
  # Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
336
- # list all environments for. Format: `projects/<Project
337
- # ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment
338
- # ID>`.
336
+ # list all environments for. Format:
337
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
339
338
  # @!attribute [rw] page_size
340
339
  # @return [::Integer]
341
340
  # The maximum number of items to return in a single page. By default 20 and
@@ -371,8 +370,7 @@ module Google
371
370
  # @return [::String]
372
371
  # Required. The name of the
373
372
  # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. Format:
374
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
375
- # ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
373
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`.
376
374
  class GetExperimentRequest
377
375
  include ::Google::Protobuf::MessageExts
378
376
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -384,8 +382,7 @@ module Google
384
382
  # @return [::String]
385
383
  # Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an
386
384
  # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for. Format:
387
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
388
- # ID>/environments/<Environment ID>`.
385
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
389
386
  # @!attribute [rw] experiment
390
387
  # @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
391
388
  # Required. The experiment to create.
@@ -413,8 +410,7 @@ module Google
413
410
  # @return [::String]
414
411
  # Required. The name of the
415
412
  # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete. Format:
416
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
417
- # ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
413
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`.
418
414
  class DeleteExperimentRequest
419
415
  include ::Google::Protobuf::MessageExts
420
416
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -425,8 +421,8 @@ module Google
425
421
  # @!attribute [rw] name
426
422
  # @return [::String]
427
423
  # Required. Resource name of the experiment to start.
428
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
429
- # ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
424
+ # Format:
425
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`.
430
426
  class StartExperimentRequest
431
427
  include ::Google::Protobuf::MessageExts
432
428
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -437,8 +433,8 @@ module Google
437
433
  # @!attribute [rw] name
438
434
  # @return [::String]
439
435
  # Required. Resource name of the experiment to stop.
440
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
441
- # ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
436
+ # Format:
437
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`.
442
438
  class StopExperimentRequest
443
439
  include ::Google::Protobuf::MessageExts
444
440
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb CHANGED
@@ -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
data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb CHANGED
@@ -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
data/proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb CHANGED
@@ -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.
data/proto_docs/google/cloud/dialogflow/cx/v3/generator.rb CHANGED
@@ -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.