google-cloud-dialogflow-cx-v3 1.2.0 → 1.4.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 +31 -21
- data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +44 -12
- data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +19 -15
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +44 -12
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +50 -38
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/service_stub.rb +102 -68
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +36 -3
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +36 -3
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/service_stub.rb +30 -14
- data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +36 -3
- data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +36 -3
- data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/service_stub.rb +30 -14
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +46 -8
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/operations.rb +19 -15
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +46 -8
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/operations.rb +50 -38
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +42 -10
- data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +19 -15
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +42 -10
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +50 -38
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/service_stub.rb +86 -56
- data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +36 -8
- data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +36 -8
- data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +43 -11
- data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +19 -15
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +43 -11
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +50 -38
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/service_stub.rb +94 -62
- data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/generators/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +46 -8
- data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +19 -15
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +46 -8
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +50 -38
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/pages/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +36 -6
- 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 +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +35 -7
- data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +35 -5
- data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb +47 -26
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +45 -13
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +19 -15
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +45 -13
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +50 -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_groups/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +38 -8
- data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +19 -15
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +38 -8
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +50 -38
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +36 -6
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/service_stub.rb +54 -32
- data/proto_docs/google/api/client.rb +19 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +12 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +12 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +4 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +8 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +4 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +12 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +12 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +28 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +4 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +32 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +22 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +18 -0
- data/proto_docs/google/longrunning/operations.rb +23 -14
- data/proto_docs/google/protobuf/struct.rb +12 -0
- metadata +6 -9
@@ -31,7 +31,8 @@ module Google
|
|
31
31
|
# including transcoding, making the REST call, and deserialing the response.
|
32
32
|
#
|
33
33
|
class ServiceStub
|
34
|
-
|
34
|
+
# @private
|
35
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
|
35
36
|
# These require statements are intentionally placed here to initialize
|
36
37
|
# the REST modules only when it's required.
|
37
38
|
require "gapic/rest"
|
@@ -41,7 +42,9 @@ module Google
|
|
41
42
|
universe_domain: universe_domain,
|
42
43
|
credentials: credentials,
|
43
44
|
numeric_enums: true,
|
44
|
-
|
45
|
+
service_name: self.class,
|
46
|
+
raise_faraday_errors: false,
|
47
|
+
logger: logger
|
45
48
|
end
|
46
49
|
|
47
50
|
##
|
@@ -62,6 +65,15 @@ module Google
|
|
62
65
|
@client_stub.endpoint
|
63
66
|
end
|
64
67
|
|
68
|
+
##
|
69
|
+
# The logger used for request/response debug logging.
|
70
|
+
#
|
71
|
+
# @return [Logger]
|
72
|
+
#
|
73
|
+
def logger stub: false
|
74
|
+
stub ? @client_stub.stub_logger : @client_stub.logger
|
75
|
+
end
|
76
|
+
|
65
77
|
##
|
66
78
|
# Baseline implementation for the list_webhooks REST call
|
67
79
|
#
|
@@ -88,16 +100,18 @@ module Google
|
|
88
100
|
|
89
101
|
response = @client_stub.make_http_request(
|
90
102
|
verb,
|
91
|
-
uri:
|
92
|
-
body:
|
93
|
-
params:
|
103
|
+
uri: uri,
|
104
|
+
body: body || "",
|
105
|
+
params: query_string_params,
|
106
|
+
method_name: "list_webhooks",
|
94
107
|
options: options
|
95
108
|
)
|
96
109
|
operation = ::Gapic::Rest::TransportOperation.new response
|
97
110
|
result = ::Google::Cloud::Dialogflow::CX::V3::ListWebhooksResponse.decode_json response.body, ignore_unknown_fields: true
|
98
|
-
|
99
|
-
|
100
|
-
|
111
|
+
catch :response do
|
112
|
+
yield result, operation if block_given?
|
113
|
+
result
|
114
|
+
end
|
101
115
|
end
|
102
116
|
|
103
117
|
##
|
@@ -126,16 +140,18 @@ module Google
|
|
126
140
|
|
127
141
|
response = @client_stub.make_http_request(
|
128
142
|
verb,
|
129
|
-
uri:
|
130
|
-
body:
|
131
|
-
params:
|
143
|
+
uri: uri,
|
144
|
+
body: body || "",
|
145
|
+
params: query_string_params,
|
146
|
+
method_name: "get_webhook",
|
132
147
|
options: options
|
133
148
|
)
|
134
149
|
operation = ::Gapic::Rest::TransportOperation.new response
|
135
150
|
result = ::Google::Cloud::Dialogflow::CX::V3::Webhook.decode_json response.body, ignore_unknown_fields: true
|
136
|
-
|
137
|
-
|
138
|
-
|
151
|
+
catch :response do
|
152
|
+
yield result, operation if block_given?
|
153
|
+
result
|
154
|
+
end
|
139
155
|
end
|
140
156
|
|
141
157
|
##
|
@@ -164,16 +180,18 @@ module Google
|
|
164
180
|
|
165
181
|
response = @client_stub.make_http_request(
|
166
182
|
verb,
|
167
|
-
uri:
|
168
|
-
body:
|
169
|
-
params:
|
183
|
+
uri: uri,
|
184
|
+
body: body || "",
|
185
|
+
params: query_string_params,
|
186
|
+
method_name: "create_webhook",
|
170
187
|
options: options
|
171
188
|
)
|
172
189
|
operation = ::Gapic::Rest::TransportOperation.new response
|
173
190
|
result = ::Google::Cloud::Dialogflow::CX::V3::Webhook.decode_json response.body, ignore_unknown_fields: true
|
174
|
-
|
175
|
-
|
176
|
-
|
191
|
+
catch :response do
|
192
|
+
yield result, operation if block_given?
|
193
|
+
result
|
194
|
+
end
|
177
195
|
end
|
178
196
|
|
179
197
|
##
|
@@ -202,16 +220,18 @@ module Google
|
|
202
220
|
|
203
221
|
response = @client_stub.make_http_request(
|
204
222
|
verb,
|
205
|
-
uri:
|
206
|
-
body:
|
207
|
-
params:
|
223
|
+
uri: uri,
|
224
|
+
body: body || "",
|
225
|
+
params: query_string_params,
|
226
|
+
method_name: "update_webhook",
|
208
227
|
options: options
|
209
228
|
)
|
210
229
|
operation = ::Gapic::Rest::TransportOperation.new response
|
211
230
|
result = ::Google::Cloud::Dialogflow::CX::V3::Webhook.decode_json response.body, ignore_unknown_fields: true
|
212
|
-
|
213
|
-
|
214
|
-
|
231
|
+
catch :response do
|
232
|
+
yield result, operation if block_given?
|
233
|
+
result
|
234
|
+
end
|
215
235
|
end
|
216
236
|
|
217
237
|
##
|
@@ -240,16 +260,18 @@ module Google
|
|
240
260
|
|
241
261
|
response = @client_stub.make_http_request(
|
242
262
|
verb,
|
243
|
-
uri:
|
244
|
-
body:
|
245
|
-
params:
|
263
|
+
uri: uri,
|
264
|
+
body: body || "",
|
265
|
+
params: query_string_params,
|
266
|
+
method_name: "delete_webhook",
|
246
267
|
options: options
|
247
268
|
)
|
248
269
|
operation = ::Gapic::Rest::TransportOperation.new response
|
249
270
|
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
|
250
|
-
|
251
|
-
|
252
|
-
|
271
|
+
catch :response do
|
272
|
+
yield result, operation if block_given?
|
273
|
+
result
|
274
|
+
end
|
253
275
|
end
|
254
276
|
|
255
277
|
##
|
@@ -306,9 +306,28 @@ module Google
|
|
306
306
|
# @!attribute [rw] common
|
307
307
|
# @return [::Google::Api::CommonLanguageSettings]
|
308
308
|
# Some settings.
|
309
|
+
# @!attribute [rw] renamed_services
|
310
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
311
|
+
# Map of service names to renamed services. Keys are the package relative
|
312
|
+
# service names and values are the name to be used for the service client
|
313
|
+
# and call options.
|
314
|
+
#
|
315
|
+
# publishing:
|
316
|
+
# go_settings:
|
317
|
+
# renamed_services:
|
318
|
+
# Publisher: TopicAdmin
|
309
319
|
class GoSettings
|
310
320
|
include ::Google::Protobuf::MessageExts
|
311
321
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
322
|
+
|
323
|
+
# @!attribute [rw] key
|
324
|
+
# @return [::String]
|
325
|
+
# @!attribute [rw] value
|
326
|
+
# @return [::String]
|
327
|
+
class RenamedServicesEntry
|
328
|
+
include ::Google::Protobuf::MessageExts
|
329
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
330
|
+
end
|
312
331
|
end
|
313
332
|
|
314
333
|
# Describes the generator configuration for a method.
|
@@ -389,16 +389,22 @@ module Google
|
|
389
389
|
# The URI to a file containing the exported agent. This field is populated
|
390
390
|
# if `agent_uri` is specified in
|
391
391
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest ExportAgentRequest}.
|
392
|
+
#
|
393
|
+
# Note: The following fields are mutually exclusive: `agent_uri`, `agent_content`, `commit_sha`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
392
394
|
# @!attribute [rw] agent_content
|
393
395
|
# @return [::String]
|
394
396
|
# Uncompressed raw byte content for agent. This field is populated
|
395
397
|
# if none of `agent_uri` and `git_destination` are specified in
|
396
398
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest ExportAgentRequest}.
|
399
|
+
#
|
400
|
+
# Note: The following fields are mutually exclusive: `agent_content`, `agent_uri`, `commit_sha`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
397
401
|
# @!attribute [rw] commit_sha
|
398
402
|
# @return [::String]
|
399
403
|
# Commit SHA of the git push. This field is populated if
|
400
404
|
# `git_destination` is specified in
|
401
405
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest ExportAgentRequest}.
|
406
|
+
#
|
407
|
+
# Note: The following fields are mutually exclusive: `commit_sha`, `agent_uri`, `agent_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
402
408
|
class ExportAgentResponse
|
403
409
|
include ::Google::Protobuf::MessageExts
|
404
410
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -421,12 +427,18 @@ module Google
|
|
421
427
|
# have read permissions for the object. For more information, see
|
422
428
|
# [Dialogflow access
|
423
429
|
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
|
430
|
+
#
|
431
|
+
# Note: The following fields are mutually exclusive: `agent_uri`, `agent_content`, `git_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
424
432
|
# @!attribute [rw] agent_content
|
425
433
|
# @return [::String]
|
426
434
|
# Uncompressed raw byte content for agent.
|
435
|
+
#
|
436
|
+
# Note: The following fields are mutually exclusive: `agent_content`, `agent_uri`, `git_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
427
437
|
# @!attribute [rw] git_source
|
428
438
|
# @return [::Google::Cloud::Dialogflow::CX::V3::RestoreAgentRequest::GitSource]
|
429
439
|
# Setting for restoring from a git branch
|
440
|
+
#
|
441
|
+
# Note: The following fields are mutually exclusive: `git_source`, `agent_uri`, `agent_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
430
442
|
# @!attribute [rw] restore_option
|
431
443
|
# @return [::Google::Cloud::Dialogflow::CX::V3::RestoreAgentRequest::RestoreOption]
|
432
444
|
# Agent restore mode. If not specified, `KEEP` is assumed.
|
@@ -183,9 +183,13 @@ module Google
|
|
183
183
|
# have write permissions for the object. For more information, see
|
184
184
|
# [Dialogflow access
|
185
185
|
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
|
186
|
+
#
|
187
|
+
# Note: The following fields are mutually exclusive: `entity_types_uri`, `entity_types_content_inline`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
186
188
|
# @!attribute [rw] entity_types_content_inline
|
187
189
|
# @return [::Boolean]
|
188
190
|
# Optional. The option to return the serialized entity types inline.
|
191
|
+
#
|
192
|
+
# Note: The following fields are mutually exclusive: `entity_types_content_inline`, `entity_types_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
189
193
|
# @!attribute [rw] data_format
|
190
194
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ExportEntityTypesRequest::DataFormat]
|
191
195
|
# Optional. The data format of the exported entity types. If not specified,
|
@@ -228,11 +232,15 @@ module Google
|
|
228
232
|
# The URI to a file containing the exported entity types. This field is
|
229
233
|
# populated only if `entity_types_uri` is specified in
|
230
234
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportEntityTypesRequest ExportEntityTypesRequest}.
|
235
|
+
#
|
236
|
+
# Note: The following fields are mutually exclusive: `entity_types_uri`, `entity_types_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
231
237
|
# @!attribute [rw] entity_types_content
|
232
238
|
# @return [::Google::Cloud::Dialogflow::CX::V3::InlineDestination]
|
233
239
|
# Uncompressed byte content for entity types. This field is populated only
|
234
240
|
# if `entity_types_content_inline` is set to true in
|
235
241
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportEntityTypesRequest ExportEntityTypesRequest}.
|
242
|
+
#
|
243
|
+
# Note: The following fields are mutually exclusive: `entity_types_content`, `entity_types_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
236
244
|
class ExportEntityTypesResponse
|
237
245
|
include ::Google::Protobuf::MessageExts
|
238
246
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -263,9 +271,13 @@ module Google
|
|
263
271
|
# have read permissions for the object. For more information, see
|
264
272
|
# [Dialogflow access
|
265
273
|
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
|
274
|
+
#
|
275
|
+
# Note: The following fields are mutually exclusive: `entity_types_uri`, `entity_types_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
266
276
|
# @!attribute [rw] entity_types_content
|
267
277
|
# @return [::Google::Cloud::Dialogflow::CX::V3::InlineSource]
|
268
278
|
# Uncompressed byte content of entity types.
|
279
|
+
#
|
280
|
+
# Note: The following fields are mutually exclusive: `entity_types_content`, `entity_types_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
269
281
|
# @!attribute [rw] merge_option
|
270
282
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ImportEntityTypesRequest::MergeOption]
|
271
283
|
# Required. Merge option for importing entity types.
|
@@ -146,9 +146,13 @@ module Google
|
|
146
146
|
# @!attribute [rw] ratio
|
147
147
|
# @return [::Float]
|
148
148
|
# Ratio value of a metric.
|
149
|
+
#
|
150
|
+
# Note: The following fields are mutually exclusive: `ratio`, `count`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
149
151
|
# @!attribute [rw] count
|
150
152
|
# @return [::Float]
|
151
153
|
# Count value of a metric.
|
154
|
+
#
|
155
|
+
# Note: The following fields are mutually exclusive: `count`, `ratio`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
152
156
|
# @!attribute [rw] confidence_interval
|
153
157
|
# @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
|
154
158
|
# The probability that the treatment is better than all other treatments
|
@@ -418,9 +418,13 @@ module Google
|
|
418
418
|
# have read permissions for the object. For more information, see
|
419
419
|
# [Dialogflow access
|
420
420
|
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
|
421
|
+
#
|
422
|
+
# Note: The following fields are mutually exclusive: `flow_uri`, `flow_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
421
423
|
# @!attribute [rw] flow_content
|
422
424
|
# @return [::String]
|
423
425
|
# Uncompressed raw byte content for flow.
|
426
|
+
#
|
427
|
+
# Note: The following fields are mutually exclusive: `flow_content`, `flow_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
424
428
|
# @!attribute [rw] import_option
|
425
429
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ImportFlowRequest::ImportOption]
|
426
430
|
# Flow import mode. If not specified, `KEEP` is assumed.
|
@@ -508,9 +512,13 @@ module Google
|
|
508
512
|
# The URI to a file containing the exported flow. This field is populated
|
509
513
|
# only if `flow_uri` is specified in
|
510
514
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest ExportFlowRequest}.
|
515
|
+
#
|
516
|
+
# Note: The following fields are mutually exclusive: `flow_uri`, `flow_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
511
517
|
# @!attribute [rw] flow_content
|
512
518
|
# @return [::String]
|
513
519
|
# Uncompressed raw byte content for flow.
|
520
|
+
#
|
521
|
+
# Note: The following fields are mutually exclusive: `flow_content`, `flow_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
514
522
|
class ExportFlowResponse
|
515
523
|
include ::Google::Protobuf::MessageExts
|
516
524
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -129,9 +129,13 @@ module Google
|
|
129
129
|
# @!attribute [rw] message
|
130
130
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage]
|
131
131
|
# Returned message.
|
132
|
+
#
|
133
|
+
# Note: The following fields are mutually exclusive: `message`, `additional_cases`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
132
134
|
# @!attribute [rw] additional_cases
|
133
135
|
# @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment::ConditionalCases]
|
134
136
|
# Additional cases to be evaluated.
|
137
|
+
#
|
138
|
+
# Note: The following fields are mutually exclusive: `additional_cases`, `message`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
135
139
|
class CaseContent
|
136
140
|
include ::Google::Protobuf::MessageExts
|
137
141
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -328,9 +328,13 @@ module Google
|
|
328
328
|
# have read permissions for the object. For more information, see
|
329
329
|
# [Dialogflow access
|
330
330
|
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
|
331
|
+
#
|
332
|
+
# Note: The following fields are mutually exclusive: `intents_uri`, `intents_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
331
333
|
# @!attribute [rw] intents_content
|
332
334
|
# @return [::Google::Cloud::Dialogflow::CX::V3::InlineSource]
|
333
335
|
# Uncompressed byte content of intents.
|
336
|
+
#
|
337
|
+
# Note: The following fields are mutually exclusive: `intents_content`, `intents_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
334
338
|
# @!attribute [rw] merge_option
|
335
339
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ImportIntentsRequest::MergeOption]
|
336
340
|
# Merge option for importing intents. If not specified, `REJECT` is assumed.
|
@@ -433,9 +437,13 @@ module Google
|
|
433
437
|
# have write permissions for the object. For more information, see
|
434
438
|
# [Dialogflow access
|
435
439
|
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
|
440
|
+
#
|
441
|
+
# Note: The following fields are mutually exclusive: `intents_uri`, `intents_content_inline`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
436
442
|
# @!attribute [rw] intents_content_inline
|
437
443
|
# @return [::Boolean]
|
438
444
|
# Optional. The option to return the serialized intents inline.
|
445
|
+
#
|
446
|
+
# Note: The following fields are mutually exclusive: `intents_content_inline`, `intents_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
439
447
|
# @!attribute [rw] data_format
|
440
448
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest::DataFormat]
|
441
449
|
# Optional. The data format of the exported intents. If not specified, `BLOB`
|
@@ -467,11 +475,15 @@ module Google
|
|
467
475
|
# The URI to a file containing the exported intents. This field is
|
468
476
|
# populated only if `intents_uri` is specified in
|
469
477
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest ExportIntentsRequest}.
|
478
|
+
#
|
479
|
+
# Note: The following fields are mutually exclusive: `intents_uri`, `intents_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
470
480
|
# @!attribute [rw] intents_content
|
471
481
|
# @return [::Google::Cloud::Dialogflow::CX::V3::InlineDestination]
|
472
482
|
# Uncompressed byte content for intents. This field is populated only if
|
473
483
|
# `intents_content_inline` is set to true in
|
474
484
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest ExportIntentsRequest}.
|
485
|
+
#
|
486
|
+
# Note: The following fields are mutually exclusive: `intents_content`, `intents_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
475
487
|
class ExportIntentsResponse
|
476
488
|
include ::Google::Protobuf::MessageExts
|
477
489
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -257,11 +257,15 @@ module Google
|
|
257
257
|
# The target page to transition to.
|
258
258
|
# Format:
|
259
259
|
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
|
260
|
+
#
|
261
|
+
# Note: The following fields are mutually exclusive: `target_page`, `target_flow`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
260
262
|
# @!attribute [rw] target_flow
|
261
263
|
# @return [::String]
|
262
264
|
# The target flow to transition to.
|
263
265
|
# Format:
|
264
266
|
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
|
267
|
+
#
|
268
|
+
# Note: The following fields are mutually exclusive: `target_flow`, `target_page`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
265
269
|
class EventHandler
|
266
270
|
include ::Google::Protobuf::MessageExts
|
267
271
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -321,11 +325,15 @@ module Google
|
|
321
325
|
# The target page to transition to.
|
322
326
|
# Format:
|
323
327
|
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
|
328
|
+
#
|
329
|
+
# Note: The following fields are mutually exclusive: `target_page`, `target_flow`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
324
330
|
# @!attribute [rw] target_flow
|
325
331
|
# @return [::String]
|
326
332
|
# The target flow to transition to.
|
327
333
|
# Format:
|
328
334
|
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
|
335
|
+
#
|
336
|
+
# Note: The following fields are mutually exclusive: `target_flow`, `target_page`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
329
337
|
class TransitionRoute
|
330
338
|
include ::Google::Protobuf::MessageExts
|
331
339
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -540,11 +548,15 @@ module Google
|
|
540
548
|
# The target page to transition to.
|
541
549
|
# Format:
|
542
550
|
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
|
551
|
+
#
|
552
|
+
# Note: The following fields are mutually exclusive: `target_page`, `target_flow`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
543
553
|
# @!attribute [rw] target_flow
|
544
554
|
# @return [::String]
|
545
555
|
# The target flow to transition to.
|
546
556
|
# Format:
|
547
557
|
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
|
558
|
+
#
|
559
|
+
# Note: The following fields are mutually exclusive: `target_flow`, `target_page`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
548
560
|
# @!attribute [rw] data_store_connections
|
549
561
|
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>]
|
550
562
|
# Optional. List of related data store connections.
|
@@ -42,19 +42,29 @@ module Google
|
|
42
42
|
# @!attribute [rw] text
|
43
43
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text]
|
44
44
|
# Returns a text response.
|
45
|
+
#
|
46
|
+
# Note: The following fields are mutually exclusive: `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
45
47
|
# @!attribute [rw] payload
|
46
48
|
# @return [::Google::Protobuf::Struct]
|
47
49
|
# Returns a response containing a custom, platform-specific payload.
|
50
|
+
#
|
51
|
+
# Note: The following fields are mutually exclusive: `payload`, `text`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
48
52
|
# @!attribute [rw] conversation_success
|
49
53
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess]
|
50
54
|
# Indicates that the conversation succeeded.
|
55
|
+
#
|
56
|
+
# Note: The following fields are mutually exclusive: `conversation_success`, `text`, `payload`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
51
57
|
# @!attribute [rw] output_audio_text
|
52
58
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText]
|
53
59
|
# A text or ssml response that is preferentially used for TTS output audio
|
54
60
|
# synthesis, as described in the comment on the ResponseMessage message.
|
61
|
+
#
|
62
|
+
# Note: The following fields are mutually exclusive: `output_audio_text`, `text`, `payload`, `conversation_success`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
55
63
|
# @!attribute [rw] live_agent_handoff
|
56
64
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff]
|
57
65
|
# Hands off conversation to a human agent.
|
66
|
+
#
|
67
|
+
# Note: The following fields are mutually exclusive: `live_agent_handoff`, `text`, `payload`, `conversation_success`, `output_audio_text`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
58
68
|
# @!attribute [r] end_interaction
|
59
69
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::EndInteraction]
|
60
70
|
# Output only. A signal that indicates the interaction with the Dialogflow
|
@@ -63,6 +73,8 @@ module Google
|
|
63
73
|
# by the user.
|
64
74
|
#
|
65
75
|
# It's guaranteed that there is at most one such message in each response.
|
76
|
+
#
|
77
|
+
# Note: The following fields are mutually exclusive: `end_interaction`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
66
78
|
# @!attribute [rw] play_audio
|
67
79
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio]
|
68
80
|
# Signal that the client should play an audio clip hosted at a
|
@@ -70,6 +82,8 @@ module Google
|
|
70
82
|
# {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#mixed_audio mixed_audio}.
|
71
83
|
# However, Dialogflow itself does not try to read or process the URI in any
|
72
84
|
# way.
|
85
|
+
#
|
86
|
+
# Note: The following fields are mutually exclusive: `play_audio`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
73
87
|
# @!attribute [r] mixed_audio
|
74
88
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::MixedAudio]
|
75
89
|
# Output only. An audio response message composed of both the synthesized
|
@@ -77,14 +91,20 @@ module Google
|
|
77
91
|
# {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#play_audio play_audio}.
|
78
92
|
# This message is generated by Dialogflow only and not supposed to be
|
79
93
|
# defined by the user.
|
94
|
+
#
|
95
|
+
# Note: The following fields are mutually exclusive: `mixed_audio`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
80
96
|
# @!attribute [rw] telephony_transfer_call
|
81
97
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall]
|
82
98
|
# A signal that the client should transfer the phone call connected to
|
83
99
|
# this agent to a third-party endpoint.
|
100
|
+
#
|
101
|
+
# Note: The following fields are mutually exclusive: `telephony_transfer_call`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
84
102
|
# @!attribute [rw] knowledge_info_card
|
85
103
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::KnowledgeInfoCard]
|
86
104
|
# Represents info card for knowledge answers, to be better rendered in
|
87
105
|
# Dialogflow Messenger.
|
106
|
+
#
|
107
|
+
# Note: The following fields are mutually exclusive: `knowledge_info_card`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
88
108
|
# @!attribute [rw] response_type
|
89
109
|
# @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType]
|
90
110
|
# Response type.
|
@@ -165,10 +185,14 @@ module Google
|
|
165
185
|
# @!attribute [rw] text
|
166
186
|
# @return [::String]
|
167
187
|
# The raw text to be synthesized.
|
188
|
+
#
|
189
|
+
# Note: The following fields are mutually exclusive: `text`, `ssml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
168
190
|
# @!attribute [rw] ssml
|
169
191
|
# @return [::String]
|
170
192
|
# The SSML text to be synthesized. For more information, see
|
171
193
|
# [SSML](/speech/text-to-speech/docs/ssml).
|
194
|
+
#
|
195
|
+
# Note: The following fields are mutually exclusive: `ssml`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
172
196
|
# @!attribute [r] allow_playback_interruption
|
173
197
|
# @return [::Boolean]
|
174
198
|
# Output only. Whether the playback of this message can be interrupted by
|
@@ -221,10 +245,14 @@ module Google
|
|
221
245
|
# @return [::String]
|
222
246
|
# Raw audio synthesized from the Dialogflow agent's response using
|
223
247
|
# the output config specified in the request.
|
248
|
+
#
|
249
|
+
# Note: The following fields are mutually exclusive: `audio`, `uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
224
250
|
# @!attribute [rw] uri
|
225
251
|
# @return [::String]
|
226
252
|
# Client-specific URI that points to an audio clip accessible to the
|
227
253
|
# client. Dialogflow does not impose any validation on it.
|
254
|
+
#
|
255
|
+
# Note: The following fields are mutually exclusive: `uri`, `audio`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
228
256
|
# @!attribute [r] allow_playback_interruption
|
229
257
|
# @return [::Boolean]
|
230
258
|
# Output only. Whether the playback of this segment can be interrupted by
|
@@ -177,10 +177,14 @@ module Google
|
|
177
177
|
# When data retention configuration is changed, it only applies to the data
|
178
178
|
# created after the change; the TTL of existing data created before the
|
179
179
|
# change stays intact.
|
180
|
+
#
|
181
|
+
# Note: The following fields are mutually exclusive: `retention_window_days`, `retention_strategy`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
180
182
|
# @!attribute [rw] retention_strategy
|
181
183
|
# @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy]
|
182
184
|
# Specifies the retention behavior defined by
|
183
185
|
# {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy SecuritySettings.RetentionStrategy}.
|
186
|
+
#
|
187
|
+
# Note: The following fields are mutually exclusive: `retention_strategy`, `retention_window_days`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
184
188
|
# @!attribute [rw] purge_data_types
|
185
189
|
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>]
|
186
190
|
# List of types of data to remove when retention settings triggers purge.
|