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.
- checksums.yaml +4 -4
- data/README.md +30 -20
- data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +44 -25
- data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/agents/paths.rb +19 -0
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +44 -25
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/service_stub.rb +102 -68
- data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +32 -6
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +32 -6
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/service_stub.rb +30 -14
- data/lib/google/cloud/dialogflow/cx/v3/data_store_connection_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +32 -8
- data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +32 -8
- data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/service_stub.rb +30 -14
- data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +43 -21
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +43 -21
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +50 -27
- data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +50 -27
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/service_stub.rb +86 -56
- data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +38 -21
- data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +38 -21
- data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +47 -26
- data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +47 -26
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/service_stub.rb +94 -62
- data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/gcs_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/generative_settings_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/generator_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/generators/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +41 -19
- data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +41 -19
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +37 -14
- data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +37 -14
- data/lib/google/cloud/dialogflow/cx/v3/pages/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/safety_settings_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +54 -29
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +54 -29
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +5 -1
- data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +40 -16
- data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +40 -14
- data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb +47 -26
- data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +59 -38
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +59 -38
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/service_stub.rb +110 -74
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +43 -21
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +43 -21
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +44 -22
- data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +44 -22
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/service_stub.rb +54 -32
- data/proto_docs/google/api/client.rb +39 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb +1 -1
- data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +44 -20
- data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +6 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +5 -5
- data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +11 -13
- data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +16 -17
- data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +26 -28
- data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +15 -19
- data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +28 -27
- data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +2 -2
- data/proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb +2 -2
- data/proto_docs/google/cloud/dialogflow/cx/v3/generator.rb +41 -8
- data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +19 -19
- data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +33 -33
- data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +2 -1
- data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +14 -14
- data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +107 -22
- data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +30 -28
- data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +41 -43
- data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +16 -18
- data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +19 -19
- data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +24 -25
- data/proto_docs/google/longrunning/operations.rb +19 -14
- metadata +5 -5
@@ -52,7 +52,7 @@ module Google
|
|
52
52
|
# method.
|
53
53
|
# {::Google::Cloud::Dialogflow::CX::V3::Agents::Client#create_agent Agents.CreateAgent}
|
54
54
|
# populates the name automatically.
|
55
|
-
# Format: `projects/<
|
55
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
56
56
|
# @!attribute [rw] display_name
|
57
57
|
# @return [::String]
|
58
58
|
# Required. The human-readable name of the agent, unique within the location.
|
@@ -91,14 +91,14 @@ module Google
|
|
91
91
|
# @return [::String]
|
92
92
|
# Immutable. Name of the start flow in this agent. A start flow will be
|
93
93
|
# automatically created when the agent is created, and can only be deleted by
|
94
|
-
# deleting the agent. Format:
|
95
|
-
#
|
94
|
+
# deleting the agent. Format:
|
95
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
|
96
96
|
# @!attribute [rw] security_settings
|
97
97
|
# @return [::String]
|
98
98
|
# Name of the
|
99
99
|
# {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings}
|
100
|
-
# reference for the agent. Format:
|
101
|
-
#
|
100
|
+
# reference for the agent. Format:
|
101
|
+
# `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
|
102
102
|
# @!attribute [rw] enable_stackdriver_logging
|
103
103
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
104
104
|
# @return [::Boolean]
|
@@ -138,6 +138,9 @@ module Google
|
|
138
138
|
# @!attribute [rw] personalization_settings
|
139
139
|
# @return [::Google::Cloud::Dialogflow::CX::V3::Agent::PersonalizationSettings]
|
140
140
|
# Optional. Settings for end user personalization.
|
141
|
+
# @!attribute [rw] client_certificate_settings
|
142
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::Agent::ClientCertificateSettings]
|
143
|
+
# Optional. Settings for custom client certificates.
|
141
144
|
class Agent
|
142
145
|
include ::Google::Protobuf::MessageExts
|
143
146
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -211,6 +214,27 @@ module Google
|
|
211
214
|
include ::Google::Protobuf::MessageExts
|
212
215
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
213
216
|
end
|
217
|
+
|
218
|
+
# Settings for custom client certificates.
|
219
|
+
# @!attribute [rw] ssl_certificate
|
220
|
+
# @return [::String]
|
221
|
+
# Required. The ssl certificate encoded in PEM format. This string must
|
222
|
+
# include the begin header and end footer lines.
|
223
|
+
# @!attribute [rw] private_key
|
224
|
+
# @return [::String]
|
225
|
+
# Required. The name of the SecretManager secret version resource storing
|
226
|
+
# the private key encoded in PEM format. Format:
|
227
|
+
# `projects/{project}/secrets/{secret}/versions/{version}`
|
228
|
+
# @!attribute [rw] passphrase
|
229
|
+
# @return [::String]
|
230
|
+
# Optional. The name of the SecretManager secret version resource storing
|
231
|
+
# the passphrase. 'passphrase' should be left unset if the private key is
|
232
|
+
# not encrypted.
|
233
|
+
# Format: `projects/{project}/secrets/{secret}/versions/{version}`
|
234
|
+
class ClientCertificateSettings
|
235
|
+
include ::Google::Protobuf::MessageExts
|
236
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
237
|
+
end
|
214
238
|
end
|
215
239
|
|
216
240
|
# The request message for
|
@@ -218,7 +242,7 @@ module Google
|
|
218
242
|
# @!attribute [rw] parent
|
219
243
|
# @return [::String]
|
220
244
|
# Required. The location to list all agents for.
|
221
|
-
# Format: `projects/<
|
245
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>`.
|
222
246
|
# @!attribute [rw] page_size
|
223
247
|
# @return [::Integer]
|
224
248
|
# The maximum number of items to return in a single page. By default 100 and
|
@@ -251,7 +275,7 @@ module Google
|
|
251
275
|
# @!attribute [rw] name
|
252
276
|
# @return [::String]
|
253
277
|
# Required. The name of the agent.
|
254
|
-
# Format: `projects/<
|
278
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
255
279
|
class GetAgentRequest
|
256
280
|
include ::Google::Protobuf::MessageExts
|
257
281
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -262,7 +286,7 @@ module Google
|
|
262
286
|
# @!attribute [rw] parent
|
263
287
|
# @return [::String]
|
264
288
|
# Required. The location to create a agent for.
|
265
|
-
# Format: `projects/<
|
289
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>`.
|
266
290
|
# @!attribute [rw] agent
|
267
291
|
# @return [::Google::Cloud::Dialogflow::CX::V3::Agent]
|
268
292
|
# Required. The agent to create.
|
@@ -290,7 +314,7 @@ module Google
|
|
290
314
|
# @!attribute [rw] name
|
291
315
|
# @return [::String]
|
292
316
|
# Required. The name of the agent to delete.
|
293
|
-
# Format: `projects/<
|
317
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
294
318
|
class DeleteAgentRequest
|
295
319
|
include ::Google::Protobuf::MessageExts
|
296
320
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -301,7 +325,7 @@ module Google
|
|
301
325
|
# @!attribute [rw] name
|
302
326
|
# @return [::String]
|
303
327
|
# Required. The name of the agent to export.
|
304
|
-
# Format: `projects/<
|
328
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
305
329
|
# @!attribute [rw] agent_uri
|
306
330
|
# @return [::String]
|
307
331
|
# Optional. The [Google Cloud
|
@@ -321,8 +345,8 @@ module Google
|
|
321
345
|
# @!attribute [rw] environment
|
322
346
|
# @return [::String]
|
323
347
|
# Optional. Environment name. If not set, draft environment is assumed.
|
324
|
-
# Format:
|
325
|
-
#
|
348
|
+
# Format:
|
349
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
|
326
350
|
# @!attribute [rw] git_destination
|
327
351
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest::GitDestination]
|
328
352
|
# Optional. The Git branch to export the agent to.
|
@@ -385,7 +409,7 @@ module Google
|
|
385
409
|
# @!attribute [rw] name
|
386
410
|
# @return [::String]
|
387
411
|
# Required. The name of the agent to restore into.
|
388
|
-
# Format: `projects/<
|
412
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
389
413
|
# @!attribute [rw] agent_uri
|
390
414
|
# @return [::String]
|
391
415
|
# The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
|
@@ -440,7 +464,7 @@ module Google
|
|
440
464
|
# @!attribute [rw] name
|
441
465
|
# @return [::String]
|
442
466
|
# Required. The agent to validate.
|
443
|
-
# Format: `projects/<
|
467
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
444
468
|
# @!attribute [rw] language_code
|
445
469
|
# @return [::String]
|
446
470
|
# If not specified, the agent's default language is used.
|
@@ -454,8 +478,8 @@ module Google
|
|
454
478
|
# @!attribute [rw] name
|
455
479
|
# @return [::String]
|
456
480
|
# Required. The agent name.
|
457
|
-
# Format:
|
458
|
-
#
|
481
|
+
# Format:
|
482
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/validationResult`.
|
459
483
|
# @!attribute [rw] language_code
|
460
484
|
# @return [::String]
|
461
485
|
# If not specified, the agent's default language is used.
|
@@ -469,8 +493,8 @@ module Google
|
|
469
493
|
# @!attribute [rw] name
|
470
494
|
# @return [::String]
|
471
495
|
# The unique identifier of the agent validation result.
|
472
|
-
# Format:
|
473
|
-
#
|
496
|
+
# Format:
|
497
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/validationResult`.
|
474
498
|
# @!attribute [rw] flow_validation_results
|
475
499
|
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult>]
|
476
500
|
# Contains all flow validation results.
|
@@ -484,8 +508,8 @@ module Google
|
|
484
508
|
# RPC.
|
485
509
|
# @!attribute [rw] name
|
486
510
|
# @return [::String]
|
487
|
-
# Required. Format:
|
488
|
-
#
|
511
|
+
# Required. Format:
|
512
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generativeSettings`.
|
489
513
|
# @!attribute [rw] language_code
|
490
514
|
# @return [::String]
|
491
515
|
# Required. Language code of the generative settings.
|
@@ -307,6 +307,9 @@ module Google
|
|
307
307
|
# is replaced with a single byte containing the block length. Only Speex
|
308
308
|
# wideband is supported. `sample_rate_hertz` must be 16000.
|
309
309
|
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7
|
310
|
+
|
311
|
+
# 8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law.
|
312
|
+
AUDIO_ENCODING_ALAW = 8
|
310
313
|
end
|
311
314
|
|
312
315
|
# Variant of the specified [Speech
|
@@ -384,6 +387,9 @@ module Google
|
|
384
387
|
|
385
388
|
# 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
|
386
389
|
OUTPUT_AUDIO_ENCODING_MULAW = 5
|
390
|
+
|
391
|
+
# 8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law.
|
392
|
+
OUTPUT_AUDIO_ENCODING_ALAW = 6
|
387
393
|
end
|
388
394
|
end
|
389
395
|
end
|
@@ -27,7 +27,7 @@ module Google
|
|
27
27
|
# @!attribute [rw] parent
|
28
28
|
# @return [::String]
|
29
29
|
# Required. The agent containing the changelogs.
|
30
|
-
# Format: `projects/<
|
30
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
31
31
|
# @!attribute [rw] filter
|
32
32
|
# @return [::String]
|
33
33
|
# The filter string. Supports filter by user_email, resource, type and
|
@@ -83,8 +83,8 @@ module Google
|
|
83
83
|
# @!attribute [rw] name
|
84
84
|
# @return [::String]
|
85
85
|
# Required. The name of the changelog to get.
|
86
|
-
# Format:
|
87
|
-
#
|
86
|
+
# Format:
|
87
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/changelogs/<ChangelogID>`.
|
88
88
|
class GetChangelogRequest
|
89
89
|
include ::Google::Protobuf::MessageExts
|
90
90
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -94,8 +94,8 @@ module Google
|
|
94
94
|
# @!attribute [rw] name
|
95
95
|
# @return [::String]
|
96
96
|
# The unique identifier of the changelog.
|
97
|
-
# Format:
|
98
|
-
#
|
97
|
+
# Format:
|
98
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/changelogs/<ChangelogID>`.
|
99
99
|
# @!attribute [rw] user_email
|
100
100
|
# @return [::String]
|
101
101
|
# Email address of the authenticated user.
|
@@ -29,13 +29,13 @@ module Google
|
|
29
29
|
# @!attribute [rw] name
|
30
30
|
# @return [::String]
|
31
31
|
# The name of the deployment.
|
32
|
-
# Format:
|
33
|
-
#
|
32
|
+
# Format:
|
33
|
+
# projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/deployments/<DeploymentID>.
|
34
34
|
# @!attribute [rw] flow_version
|
35
35
|
# @return [::String]
|
36
36
|
# The name of the flow version for this deployment.
|
37
|
-
# Format:
|
38
|
-
#
|
37
|
+
# Format:
|
38
|
+
# projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VerionID>.
|
39
39
|
# @!attribute [rw] state
|
40
40
|
# @return [::Google::Cloud::Dialogflow::CX::V3::Deployment::State]
|
41
41
|
# The current state of the deployment.
|
@@ -56,13 +56,13 @@ module Google
|
|
56
56
|
# @!attribute [rw] deployment_test_results
|
57
57
|
# @return [::Array<::String>]
|
58
58
|
# Results of test cases running before the deployment.
|
59
|
-
# Format:
|
60
|
-
#
|
59
|
+
# Format:
|
60
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
|
61
61
|
# @!attribute [rw] experiment
|
62
62
|
# @return [::String]
|
63
63
|
# The name of the experiment triggered by this deployment.
|
64
|
-
# Format:
|
65
|
-
#
|
64
|
+
# Format:
|
65
|
+
# projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
|
66
66
|
class Result
|
67
67
|
include ::Google::Protobuf::MessageExts
|
68
68
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -89,9 +89,8 @@ module Google
|
|
89
89
|
# @!attribute [rw] parent
|
90
90
|
# @return [::String]
|
91
91
|
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
|
92
|
-
# list all environments for. Format:
|
93
|
-
#
|
94
|
-
# ID>`.
|
92
|
+
# list all environments for. Format:
|
93
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
|
95
94
|
# @!attribute [rw] page_size
|
96
95
|
# @return [::Integer]
|
97
96
|
# The maximum number of items to return in a single page. By default 20 and
|
@@ -127,8 +126,7 @@ module Google
|
|
127
126
|
# @return [::String]
|
128
127
|
# Required. The name of the
|
129
128
|
# {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}. Format:
|
130
|
-
# `projects/<
|
131
|
-
# ID>/environments/<Environment ID>/deployments/<Deployment ID>`.
|
129
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/deployments/<DeploymentID>`.
|
132
130
|
class GetDeploymentRequest
|
133
131
|
include ::Google::Protobuf::MessageExts
|
134
132
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -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:
|
60
|
-
#
|
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/<
|
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:
|
174
|
-
#
|
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/<
|
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:
|
277
|
-
#
|
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:
|
320
|
-
#
|
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/<
|
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:
|
406
|
-
#
|
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/<
|
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:
|
485
|
-
#
|
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.
|
@@ -33,8 +33,8 @@ module Google
|
|
33
33
|
# @!attribute [rw] name
|
34
34
|
# @return [::String]
|
35
35
|
# The name of the environment.
|
36
|
-
# Format:
|
37
|
-
#
|
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.
|
69
|
-
#
|
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:
|
80
|
-
#
|
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:
|
116
|
-
#
|
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/<
|
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/<
|
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/<
|
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:
|
206
|
-
#
|
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/<
|
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:
|
274
|
-
#
|
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:
|
307
|
-
# environments/<
|
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:
|
339
|
-
# environments/<
|
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:
|
344
|
-
# flows/<
|
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/<
|
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
|
@@ -26,8 +26,8 @@ module Google
|
|
26
26
|
# @!attribute [rw] name
|
27
27
|
# @return [::String]
|
28
28
|
# The name of the experiment.
|
29
|
-
# Format:
|
30
|
-
#
|
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:
|
166
|
-
#
|
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:
|
249
|
-
#
|
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:
|
337
|
-
#
|
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/<
|
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/<
|
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/<
|
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:
|
429
|
-
#
|
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:
|
441
|
-
#
|
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
|