google-cloud-dialogflow-v2 0.20.0 → 0.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/dialogflow/v2/agent_services_pb.rb +12 -8
- data/lib/google/cloud/dialogflow/v2/agents/client.rb +16 -12
- data/lib/google/cloud/dialogflow/v2/agents.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +7 -0
- data/lib/google/cloud/dialogflow/v2/answer_record_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/answer_records.rb +3 -2
- data/lib/google/cloud/dialogflow/v2/contexts.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/conversation_dataset_services_pb.rb +10 -5
- data/lib/google/cloud/dialogflow/v2/conversation_datasets/client.rb +12 -7
- data/lib/google/cloud/dialogflow/v2/conversation_datasets.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/conversation_model_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/conversation_model_services_pb.rb +10 -5
- data/lib/google/cloud/dialogflow/v2/conversation_models/client.rb +10 -5
- data/lib/google/cloud/dialogflow/v2/conversation_models.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +18 -0
- data/lib/google/cloud/dialogflow/v2/conversation_profile_services_pb.rb +14 -7
- data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +14 -7
- data/lib/google/cloud/dialogflow/v2/conversation_profiles.rb +3 -2
- data/lib/google/cloud/dialogflow/v2/conversation_services_pb.rb +14 -6
- data/lib/google/cloud/dialogflow/v2/conversations/client.rb +119 -8
- data/lib/google/cloud/dialogflow/v2/conversations/paths.rb +45 -0
- data/lib/google/cloud/dialogflow/v2/conversations.rb +3 -2
- data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +16 -8
- data/lib/google/cloud/dialogflow/v2/documents/client.rb +20 -12
- data/lib/google/cloud/dialogflow/v2/documents.rb +3 -2
- data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/entity_types.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/environments/client.rb +4 -4
- data/lib/google/cloud/dialogflow/v2/environments.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/fulfillments.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/intent_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/intents/client.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/intents.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/knowledge_base_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/knowledge_bases.rb +3 -2
- data/lib/google/cloud/dialogflow/v2/participants/client.rb +3 -2
- data/lib/google/cloud/dialogflow/v2/participants.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +2 -1
- data/lib/google/cloud/dialogflow/v2/session_entity_types.rb +3 -2
- data/lib/google/cloud/dialogflow/v2/sessions/client.rb +8 -6
- data/lib/google/cloud/dialogflow/v2/sessions.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/versions/client.rb +2 -2
- data/lib/google/cloud/dialogflow/v2/versions.rb +1 -1
- data/lib/google/cloud/dialogflow/v2.rb +2 -2
- data/proto_docs/google/cloud/dialogflow/v2/agent.rb +26 -15
- data/proto_docs/google/cloud/dialogflow/v2/answer_record.rb +34 -9
- data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +28 -18
- data/proto_docs/google/cloud/dialogflow/v2/context.rb +14 -7
- data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +99 -14
- data/proto_docs/google/cloud/dialogflow/v2/conversation_dataset.rb +15 -10
- data/proto_docs/google/cloud/dialogflow/v2/conversation_model.rb +41 -14
- data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +28 -15
- data/proto_docs/google/cloud/dialogflow/v2/document.rb +26 -15
- data/proto_docs/google/cloud/dialogflow/v2/entity_type.rb +30 -15
- data/proto_docs/google/cloud/dialogflow/v2/environment.rb +37 -29
- data/proto_docs/google/cloud/dialogflow/v2/fulfillment.rb +12 -7
- data/proto_docs/google/cloud/dialogflow/v2/intent.rb +33 -17
- data/proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb +12 -6
- data/proto_docs/google/cloud/dialogflow/v2/participant.rb +105 -59
- data/proto_docs/google/cloud/dialogflow/v2/session.rb +60 -45
- data/proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb +15 -8
- data/proto_docs/google/cloud/dialogflow/v2/version.rb +20 -14
- data/proto_docs/google/cloud/dialogflow/v2/webhook.rb +20 -13
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +5 -5
@@ -29,8 +29,8 @@ module Google
|
|
29
29
|
# ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
|
30
30
|
# @!attribute [rw] role
|
31
31
|
# @return [::Google::Cloud::Dialogflow::V2::Participant::Role]
|
32
|
-
# Immutable. The role this participant plays in the conversation. This field
|
33
|
-
# during participant creation and is then immutable.
|
32
|
+
# Immutable. The role this participant plays in the conversation. This field
|
33
|
+
# must be set during participant creation and is then immutable.
|
34
34
|
# @!attribute [rw] sip_recording_media_label
|
35
35
|
# @return [::String]
|
36
36
|
# Optional. Label applied to streams representing this participant in SIPREC
|
@@ -38,22 +38,27 @@ module Google
|
|
38
38
|
# media stream to this participant. This field can be updated.
|
39
39
|
# @!attribute [rw] obfuscated_external_user_id
|
40
40
|
# @return [::String]
|
41
|
-
# Optional. Obfuscated user id that should be associated with the created
|
41
|
+
# Optional. Obfuscated user id that should be associated with the created
|
42
|
+
# participant.
|
42
43
|
#
|
43
44
|
# You can specify a user id as follows:
|
44
45
|
#
|
45
46
|
# 1. If you set this field in
|
46
|
-
# {::Google::Cloud::Dialogflow::V2::CreateParticipantRequest#participant CreateParticipantRequest}
|
47
|
+
# {::Google::Cloud::Dialogflow::V2::CreateParticipantRequest#participant CreateParticipantRequest}
|
48
|
+
# or
|
47
49
|
# {::Google::Cloud::Dialogflow::V2::UpdateParticipantRequest#participant UpdateParticipantRequest},
|
48
50
|
# Dialogflow adds the obfuscated user id with the participant.
|
49
51
|
#
|
50
52
|
# 2. If you set this field in
|
51
|
-
# [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
|
53
|
+
# [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
|
54
|
+
# or
|
52
55
|
# [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
|
53
|
-
# Dialogflow will update
|
56
|
+
# Dialogflow will update
|
57
|
+
# {::Google::Cloud::Dialogflow::V2::Participant#obfuscated_external_user_id Participant.obfuscated_external_user_id}.
|
54
58
|
#
|
55
59
|
# Dialogflow returns an error if you try to add a user id for a
|
56
|
-
# non-{::Google::Cloud::Dialogflow::V2::Participant::Role::END_USER END_USER}
|
60
|
+
# non-{::Google::Cloud::Dialogflow::V2::Participant::Role::END_USER END_USER}
|
61
|
+
# participant.
|
57
62
|
#
|
58
63
|
# Dialogflow uses this user id for billing and measurement purposes. For
|
59
64
|
# example, Dialogflow determines whether a user in one conversation returned
|
@@ -68,9 +73,10 @@ module Google
|
|
68
73
|
# * The length of the user id must be <= 256 characters.
|
69
74
|
# @!attribute [rw] documents_metadata_filters
|
70
75
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
71
|
-
# Optional. Key-value filters on the metadata of documents returned by
|
72
|
-
# suggestion. If specified, article suggestion only returns suggested
|
73
|
-
# documents that match all filters in their
|
76
|
+
# Optional. Key-value filters on the metadata of documents returned by
|
77
|
+
# article suggestion. If specified, article suggestion only returns suggested
|
78
|
+
# documents that match all filters in their
|
79
|
+
# {::Google::Cloud::Dialogflow::V2::Document#metadata Document.metadata}. Multiple
|
74
80
|
# values for a metadata key should be concatenated by comma. For example,
|
75
81
|
# filters to match all documents that have 'US' or 'CA' in their market
|
76
82
|
# metadata values and 'agent' in their user metadata values will be
|
@@ -151,7 +157,8 @@ module Google
|
|
151
157
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
152
158
|
end
|
153
159
|
|
154
|
-
# The request message for
|
160
|
+
# The request message for
|
161
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#create_participant Participants.CreateParticipant}.
|
155
162
|
# @!attribute [rw] parent
|
156
163
|
# @return [::String]
|
157
164
|
# Required. Resource identifier of the conversation adding the participant.
|
@@ -165,7 +172,8 @@ module Google
|
|
165
172
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
166
173
|
end
|
167
174
|
|
168
|
-
# The request message for
|
175
|
+
# The request message for
|
176
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#get_participant Participants.GetParticipant}.
|
169
177
|
# @!attribute [rw] name
|
170
178
|
# @return [::String]
|
171
179
|
# Required. The name of the participant. Format:
|
@@ -176,7 +184,8 @@ module Google
|
|
176
184
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
177
185
|
end
|
178
186
|
|
179
|
-
# The request message for
|
187
|
+
# The request message for
|
188
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#list_participants Participants.ListParticipants}.
|
180
189
|
# @!attribute [rw] parent
|
181
190
|
# @return [::String]
|
182
191
|
# Required. The conversation to list all participants from.
|
@@ -194,7 +203,8 @@ module Google
|
|
194
203
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
204
|
end
|
196
205
|
|
197
|
-
# The response message for
|
206
|
+
# The response message for
|
207
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#list_participants Participants.ListParticipants}.
|
198
208
|
# @!attribute [rw] participants
|
199
209
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::Participant>]
|
200
210
|
# The list of participants. There is a maximum number of items
|
@@ -208,7 +218,8 @@ module Google
|
|
208
218
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
209
219
|
end
|
210
220
|
|
211
|
-
# The request message for
|
221
|
+
# The request message for
|
222
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#update_participant Participants.UpdateParticipant}.
|
212
223
|
# @!attribute [rw] participant
|
213
224
|
# @return [::Google::Cloud::Dialogflow::V2::Participant]
|
214
225
|
# Required. The participant to update.
|
@@ -220,7 +231,8 @@ module Google
|
|
220
231
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
221
232
|
end
|
222
233
|
|
223
|
-
# The request message for
|
234
|
+
# The request message for
|
235
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}.
|
224
236
|
# @!attribute [rw] participant
|
225
237
|
# @return [::String]
|
226
238
|
# Required. The name of the participant this text comes from.
|
@@ -272,7 +284,8 @@ module Google
|
|
272
284
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
273
285
|
end
|
274
286
|
|
275
|
-
# The response message for
|
287
|
+
# The response message for
|
288
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}.
|
276
289
|
# @!attribute [rw] reply_text
|
277
290
|
# @return [::String]
|
278
291
|
# The output text content.
|
@@ -296,14 +309,17 @@ module Google
|
|
296
309
|
# Only set if a Dialogflow automated agent has responded.
|
297
310
|
# Note that: [AutomatedAgentReply.detect_intent_response.output_audio][]
|
298
311
|
# and [AutomatedAgentReply.detect_intent_response.output_audio_config][]
|
299
|
-
# are always empty, use
|
312
|
+
# are always empty, use
|
313
|
+
# {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#reply_audio reply_audio}
|
314
|
+
# instead.
|
300
315
|
# @!attribute [rw] message
|
301
316
|
# @return [::Google::Cloud::Dialogflow::V2::Message]
|
302
317
|
# Message analyzed by CCAI.
|
303
318
|
# @!attribute [rw] human_agent_suggestion_results
|
304
319
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
|
305
320
|
# The suggestions for most recent human agent. The order is the same as
|
306
|
-
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
321
|
+
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
322
|
+
# of
|
307
323
|
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig#human_agent_suggestion_config HumanAgentAssistantConfig.human_agent_suggestion_config}.
|
308
324
|
#
|
309
325
|
# Note that any failure of Agent Assist features will not lead to the overall
|
@@ -313,7 +329,8 @@ module Google
|
|
313
329
|
# @!attribute [rw] end_user_suggestion_results
|
314
330
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
|
315
331
|
# The suggestions for end user. The order is the same as
|
316
|
-
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
332
|
+
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
333
|
+
# of
|
317
334
|
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig#end_user_suggestion_config HumanAgentAssistantConfig.end_user_suggestion_config}.
|
318
335
|
#
|
319
336
|
# Same as human_agent_suggestion_results, any failure of Agent Assist
|
@@ -329,33 +346,41 @@ module Google
|
|
329
346
|
end
|
330
347
|
|
331
348
|
# The top-level message sent by the client to the
|
332
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}
|
349
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}
|
350
|
+
# method.
|
333
351
|
#
|
334
352
|
# Multiple request messages should be sent in order:
|
335
353
|
#
|
336
354
|
# 1. The first message must contain
|
337
355
|
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#participant participant},
|
338
|
-
# [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config]
|
339
|
-
#
|
340
|
-
#
|
356
|
+
# [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config]
|
357
|
+
# and optionally
|
358
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#query_params query_params}.
|
359
|
+
# If you want to receive an audio response, it should also contain
|
341
360
|
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#reply_audio_config reply_audio_config}.
|
342
361
|
# The message must not contain
|
343
362
|
# [input][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input].
|
344
363
|
#
|
345
|
-
# 2. If
|
346
|
-
#
|
364
|
+
# 2. If
|
365
|
+
# [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in
|
366
|
+
# the first message
|
367
|
+
# was set to
|
368
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#audio_config audio_config},
|
347
369
|
# all subsequent messages must contain
|
348
|
-
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#input_audio input_audio}
|
349
|
-
# with Speech recognition.
|
350
|
-
# However, note that:
|
370
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#input_audio input_audio}
|
371
|
+
# to continue with Speech recognition. However, note that:
|
351
372
|
#
|
352
373
|
# * Dialogflow will bill you for the audio so far.
|
353
374
|
# * Dialogflow discards all Speech recognition results in favor of the
|
354
375
|
# text input.
|
355
376
|
#
|
356
|
-
# 3. If
|
357
|
-
#
|
358
|
-
#
|
377
|
+
# 3. If
|
378
|
+
# [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config]
|
379
|
+
# in the first message was set
|
380
|
+
# to
|
381
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#text_config StreamingAnalyzeContentRequest.text_config},
|
382
|
+
# then the second message must contain only
|
383
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest#input_text input_text}.
|
359
384
|
# Moreover, you must not send more than two messages.
|
360
385
|
#
|
361
386
|
# After you sent all input, you must half-close or abort the request stream.
|
@@ -466,19 +491,23 @@ module Google
|
|
466
491
|
# Only set if a Dialogflow automated agent has responded.
|
467
492
|
# Note that: [AutomatedAgentReply.detect_intent_response.output_audio][]
|
468
493
|
# and [AutomatedAgentReply.detect_intent_response.output_audio_config][]
|
469
|
-
# are always empty, use
|
494
|
+
# are always empty, use
|
495
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#reply_audio reply_audio}
|
496
|
+
# instead.
|
470
497
|
# @!attribute [rw] message
|
471
498
|
# @return [::Google::Cloud::Dialogflow::V2::Message]
|
472
499
|
# Message analyzed by CCAI.
|
473
500
|
# @!attribute [rw] human_agent_suggestion_results
|
474
501
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
|
475
502
|
# The suggestions for most recent human agent. The order is the same as
|
476
|
-
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
503
|
+
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
504
|
+
# of
|
477
505
|
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig#human_agent_suggestion_config HumanAgentAssistantConfig.human_agent_suggestion_config}.
|
478
506
|
# @!attribute [rw] end_user_suggestion_results
|
479
507
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
|
480
508
|
# The suggestions for end user. The order is the same as
|
481
|
-
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
509
|
+
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
510
|
+
# of
|
482
511
|
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig#end_user_suggestion_config HumanAgentAssistantConfig.end_user_suggestion_config}.
|
483
512
|
# @!attribute [rw] dtmf_parameters
|
484
513
|
# @return [::Google::Cloud::Dialogflow::V2::DtmfParameters]
|
@@ -488,7 +517,8 @@ module Google
|
|
488
517
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
489
518
|
end
|
490
519
|
|
491
|
-
# The request message for
|
520
|
+
# The request message for
|
521
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_articles Participants.SuggestArticles}.
|
492
522
|
# @!attribute [rw] parent
|
493
523
|
# @return [::String]
|
494
524
|
# Required. The name of the participant to fetch suggestion for.
|
@@ -504,8 +534,9 @@ module Google
|
|
504
534
|
# @!attribute [rw] context_size
|
505
535
|
# @return [::Integer]
|
506
536
|
# Optional. Max number of messages prior to and including
|
507
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message}
|
508
|
-
# when compiling the suggestion. By default 20 and at
|
537
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message}
|
538
|
+
# to use as context when compiling the suggestion. By default 20 and at
|
539
|
+
# most 50.
|
509
540
|
# @!attribute [rw] assist_query_params
|
510
541
|
# @return [::Google::Cloud::Dialogflow::V2::AssistQueryParameters]
|
511
542
|
# Parameters for a human assist query.
|
@@ -514,7 +545,8 @@ module Google
|
|
514
545
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
515
546
|
end
|
516
547
|
|
517
|
-
# The response message for
|
548
|
+
# The response message for
|
549
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_articles Participants.SuggestArticles}.
|
518
550
|
# @!attribute [rw] article_answers
|
519
551
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::ArticleAnswer>]
|
520
552
|
# Articles ordered by score in descending order.
|
@@ -528,16 +560,18 @@ module Google
|
|
528
560
|
# @!attribute [rw] context_size
|
529
561
|
# @return [::Integer]
|
530
562
|
# Number of messages prior to and including
|
531
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse#latest_message latest_message}
|
532
|
-
# suggestion. It may be smaller than the
|
533
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#context_size SuggestArticlesRequest.context_size}
|
534
|
-
# aren't that many messages in the
|
563
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse#latest_message latest_message}
|
564
|
+
# to compile the suggestion. It may be smaller than the
|
565
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#context_size SuggestArticlesRequest.context_size}
|
566
|
+
# field in the request if there aren't that many messages in the
|
567
|
+
# conversation.
|
535
568
|
class SuggestArticlesResponse
|
536
569
|
include ::Google::Protobuf::MessageExts
|
537
570
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
538
571
|
end
|
539
572
|
|
540
|
-
# The request message for
|
573
|
+
# The request message for
|
574
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_faq_answers Participants.SuggestFaqAnswers}.
|
541
575
|
# @!attribute [rw] parent
|
542
576
|
# @return [::String]
|
543
577
|
# Required. The name of the participant to fetch suggestion for.
|
@@ -563,7 +597,8 @@ module Google
|
|
563
597
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
564
598
|
end
|
565
599
|
|
566
|
-
# The request message for
|
600
|
+
# The request message for
|
601
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_faq_answers Participants.SuggestFaqAnswers}.
|
567
602
|
# @!attribute [rw] faq_answers
|
568
603
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::FaqAnswer>]
|
569
604
|
# Answers extracted from FAQ documents.
|
@@ -577,16 +612,18 @@ module Google
|
|
577
612
|
# @!attribute [rw] context_size
|
578
613
|
# @return [::Integer]
|
579
614
|
# Number of messages prior to and including
|
580
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse#latest_message latest_message}
|
581
|
-
# suggestion. It may be smaller than the
|
582
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersRequest#context_size SuggestFaqAnswersRequest.context_size}
|
583
|
-
# aren't that many messages in the
|
615
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse#latest_message latest_message}
|
616
|
+
# to compile the suggestion. It may be smaller than the
|
617
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersRequest#context_size SuggestFaqAnswersRequest.context_size}
|
618
|
+
# field in the request if there aren't that many messages in the
|
619
|
+
# conversation.
|
584
620
|
class SuggestFaqAnswersResponse
|
585
621
|
include ::Google::Protobuf::MessageExts
|
586
622
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
587
623
|
end
|
588
624
|
|
589
|
-
# The request message for
|
625
|
+
# The request message for
|
626
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_smart_replies Participants.SuggestSmartReplies}.
|
590
627
|
# @!attribute [rw] parent
|
591
628
|
# @return [::String]
|
592
629
|
# Required. The name of the participant to fetch suggestion for.
|
@@ -614,7 +651,8 @@ module Google
|
|
614
651
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
615
652
|
end
|
616
653
|
|
617
|
-
# The response message for
|
654
|
+
# The response message for
|
655
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_smart_replies Participants.SuggestSmartReplies}.
|
618
656
|
# @!attribute [r] smart_reply_answers
|
619
657
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SmartReplyAnswer>]
|
620
658
|
# Output only. Multiple reply options provided by smart reply service. The
|
@@ -630,10 +668,11 @@ module Google
|
|
630
668
|
# @!attribute [rw] context_size
|
631
669
|
# @return [::Integer]
|
632
670
|
# Number of messages prior to and including
|
633
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse#latest_message latest_message}
|
634
|
-
# suggestion. It may be smaller than the
|
635
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesRequest#context_size SuggestSmartRepliesRequest.context_size}
|
636
|
-
# aren't that many messages in the
|
671
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse#latest_message latest_message}
|
672
|
+
# to compile the suggestion. It may be smaller than the
|
673
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesRequest#context_size SuggestSmartRepliesRequest.context_size}
|
674
|
+
# field in the request if there aren't that many messages in the
|
675
|
+
# conversation.
|
637
676
|
class SuggestSmartRepliesResponse
|
638
677
|
include ::Google::Protobuf::MessageExts
|
639
678
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -655,7 +694,9 @@ module Google
|
|
655
694
|
# Represents a response from an automated agent.
|
656
695
|
# @!attribute [rw] detect_intent_response
|
657
696
|
# @return [::Google::Cloud::Dialogflow::V2::DetectIntentResponse]
|
658
|
-
# Response of the Dialogflow
|
697
|
+
# Response of the Dialogflow
|
698
|
+
# {::Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent Sessions.DetectIntent}
|
699
|
+
# call.
|
659
700
|
# @!attribute [rw] automated_agent_reply_type
|
660
701
|
# @return [::Google::Cloud::Dialogflow::V2::AutomatedAgentReply::AutomatedAgentReplyType]
|
661
702
|
# AutomatedAgentReply type.
|
@@ -789,8 +830,12 @@ module Google
|
|
789
830
|
end
|
790
831
|
|
791
832
|
# One response of different type of suggestion response which is used in
|
792
|
-
# the response of
|
793
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
|
833
|
+
# the response of
|
834
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
|
835
|
+
# and
|
836
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent},
|
837
|
+
# as well as
|
838
|
+
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantEvent HumanAgentAssistantEvent}.
|
794
839
|
# @!attribute [rw] error
|
795
840
|
# @return [::Google::Rpc::Status]
|
796
841
|
# Error status if the request failed.
|
@@ -867,7 +912,8 @@ module Google
|
|
867
912
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
868
913
|
# Key-value filters on the metadata of documents returned by article
|
869
914
|
# suggestion. If specified, article suggestion only returns suggested
|
870
|
-
# documents that match all filters in their
|
915
|
+
# documents that match all filters in their
|
916
|
+
# {::Google::Cloud::Dialogflow::V2::Document#metadata Document.metadata}. Multiple
|
871
917
|
# values for a metadata key should be concatenated by comma. For example,
|
872
918
|
# filters to match all documents that have 'US' or 'CA' in their market
|
873
919
|
# metadata values and 'agent' in their user metadata values will be
|
@@ -61,12 +61,14 @@ module Google
|
|
61
61
|
# configured, no output audio is generated.
|
62
62
|
# @!attribute [rw] output_audio_config_mask
|
63
63
|
# @return [::Google::Protobuf::FieldMask]
|
64
|
-
# Mask for
|
65
|
-
#
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
64
|
+
# Mask for
|
65
|
+
# {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config}
|
66
|
+
# indicating which settings in this request-level config should override
|
67
|
+
# speech synthesizer settings defined at agent-level.
|
68
|
+
#
|
69
|
+
# If unspecified or empty,
|
70
|
+
# {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config}
|
71
|
+
# replaces the agent-level config in its entirety.
|
70
72
|
# @!attribute [rw] input_audio
|
71
73
|
# @return [::String]
|
72
74
|
# The natural language speech audio to be processed. This field
|
@@ -309,25 +311,29 @@ module Google
|
|
309
311
|
end
|
310
312
|
|
311
313
|
# The top-level message sent by the client to the
|
312
|
-
# {::Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent Sessions.StreamingDetectIntent}
|
314
|
+
# {::Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent Sessions.StreamingDetectIntent}
|
315
|
+
# method.
|
313
316
|
#
|
314
317
|
# Multiple request messages should be sent in order:
|
315
318
|
#
|
316
319
|
# 1. The first message must contain
|
317
320
|
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#session session},
|
318
|
-
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_input query_input}
|
319
|
-
#
|
320
|
-
#
|
321
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_input query_input}
|
322
|
+
# plus optionally
|
323
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_params query_params}.
|
324
|
+
# If the client wants to receive an audio response, it should also contain
|
321
325
|
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#output_audio_config output_audio_config}.
|
322
326
|
# The message must not contain
|
323
327
|
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#input_audio input_audio}.
|
324
|
-
# 2. If
|
325
|
-
#
|
326
|
-
#
|
327
|
-
# {::Google::Cloud::Dialogflow::V2::
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
328
|
+
# 2. If
|
329
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_input query_input}
|
330
|
+
# was set to
|
331
|
+
# {::Google::Cloud::Dialogflow::V2::InputAudioConfig query_input.audio_config},
|
332
|
+
# all subsequent messages must contain
|
333
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#input_audio input_audio}
|
334
|
+
# to continue with Speech recognition. If you decide to rather detect an
|
335
|
+
# intent from text input after you already started Speech recognition,
|
336
|
+
# please send a message with
|
331
337
|
# {::Google::Cloud::Dialogflow::V2::QueryInput#text query_input.text}.
|
332
338
|
#
|
333
339
|
# However, note that:
|
@@ -372,14 +378,15 @@ module Google
|
|
372
378
|
# 3. an event that specifies which intent to trigger.
|
373
379
|
# @!attribute [rw] single_utterance
|
374
380
|
# @return [::Boolean]
|
375
|
-
# Please use
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
# This setting is ignored when `query_input` is a piece
|
381
|
+
# Please use
|
382
|
+
# {::Google::Cloud::Dialogflow::V2::InputAudioConfig#single_utterance InputAudioConfig.single_utterance}
|
383
|
+
# instead. If `false` (default), recognition does not cease until the client
|
384
|
+
# closes the stream. If `true`, the recognizer will detect a single spoken
|
385
|
+
# utterance in input audio. Recognition ceases when it detects the audio's
|
386
|
+
# voice has stopped or paused. In this case, once a detected intent is
|
387
|
+
# received, the client should close the stream and start a new request with a
|
388
|
+
# new stream as needed. This setting is ignored when `query_input` is a piece
|
389
|
+
# of text or an event.
|
383
390
|
# @!attribute [rw] output_audio_config
|
384
391
|
# @return [::Google::Cloud::Dialogflow::V2::OutputAudioConfig]
|
385
392
|
# Instructs the speech synthesizer how to generate the output
|
@@ -387,12 +394,14 @@ module Google
|
|
387
394
|
# configured, no output audio is generated.
|
388
395
|
# @!attribute [rw] output_audio_config_mask
|
389
396
|
# @return [::Google::Protobuf::FieldMask]
|
390
|
-
# Mask for
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
397
|
+
# Mask for
|
398
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#output_audio_config output_audio_config}
|
399
|
+
# indicating which settings in this request-level config should override
|
400
|
+
# speech synthesizer settings defined at agent-level.
|
401
|
+
#
|
402
|
+
# If unspecified or empty,
|
403
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#output_audio_config output_audio_config}
|
404
|
+
# replaces the agent-level config in its entirety.
|
396
405
|
# @!attribute [rw] input_audio
|
397
406
|
# @return [::String]
|
398
407
|
# The input audio content to be recognized. Must be sent if
|
@@ -411,8 +420,9 @@ module Google
|
|
411
420
|
# 1. If the `StreamingDetectIntentRequest.input_audio` field was
|
412
421
|
# set, the `recognition_result` field is populated for one
|
413
422
|
# or more messages.
|
414
|
-
# See the
|
415
|
-
#
|
423
|
+
# See the
|
424
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult StreamingRecognitionResult}
|
425
|
+
# message for details about the result message sequence.
|
416
426
|
#
|
417
427
|
# 2. The next message contains `response_id`, `query_result`
|
418
428
|
# and optionally `webhook_status` if a WebHook was called.
|
@@ -511,7 +521,8 @@ module Google
|
|
511
521
|
# @!attribute [rw] speech_word_info
|
512
522
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SpeechWordInfo>]
|
513
523
|
# Word-specific information for the words recognized by Speech in
|
514
|
-
# {::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult#transcript transcript}.
|
524
|
+
# {::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult#transcript transcript}.
|
525
|
+
# Populated if and only if `message_type` = `TRANSCRIPT` and
|
515
526
|
# [InputAudioConfig.enable_word_info] is set.
|
516
527
|
# @!attribute [rw] speech_end_offset
|
517
528
|
# @return [::Google::Protobuf::Duration]
|
@@ -534,11 +545,12 @@ module Google
|
|
534
545
|
|
535
546
|
# Event indicates that the server has detected the end of the user's speech
|
536
547
|
# utterance and expects no additional inputs.
|
537
|
-
# Therefore, the server will not process additional audio (although it may
|
538
|
-
#
|
539
|
-
# connection, and wait for any
|
540
|
-
#
|
541
|
-
# set to `true`, and is not
|
548
|
+
# Therefore, the server will not process additional audio (although it may
|
549
|
+
# subsequently return additional results). The client should stop sending
|
550
|
+
# additional audio data, half-close the gRPC connection, and wait for any
|
551
|
+
# additional results until the server closes the gRPC connection. This
|
552
|
+
# message is only sent if `single_utterance` was set to `true`, and is not
|
553
|
+
# used otherwise.
|
542
554
|
END_OF_SINGLE_UTTERANCE = 2
|
543
555
|
end
|
544
556
|
end
|
@@ -596,8 +608,8 @@ module Google
|
|
596
608
|
# the same session do not necessarily need to specify the same language.
|
597
609
|
#
|
598
610
|
# This field is ignored when used in the context of a
|
599
|
-
# {::Google::Cloud::Dialogflow::V2::WebhookResponse#followup_event_input WebhookResponse.followup_event_input}
|
600
|
-
# because the language was already defined in the originating detect
|
611
|
+
# {::Google::Cloud::Dialogflow::V2::WebhookResponse#followup_event_input WebhookResponse.followup_event_input}
|
612
|
+
# field, because the language was already defined in the originating detect
|
601
613
|
# intent request.
|
602
614
|
class EventInput
|
603
615
|
include ::Google::Protobuf::MessageExts
|
@@ -619,11 +631,14 @@ module Google
|
|
619
631
|
# and identifies the prevailing subjective opinion, especially to determine a
|
620
632
|
# user's attitude as positive, negative, or neutral.
|
621
633
|
# For [Participants.DetectIntent][], it needs to be configured in
|
622
|
-
# {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#query_params DetectIntentRequest.query_params}.
|
623
|
-
# [Participants.StreamingDetectIntent][], it needs to be configured in
|
634
|
+
# {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#query_params DetectIntentRequest.query_params}.
|
635
|
+
# For [Participants.StreamingDetectIntent][], it needs to be configured in
|
624
636
|
# {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_params StreamingDetectIntentRequest.query_params}.
|
625
|
-
# And for
|
626
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#
|
637
|
+
# And for
|
638
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
|
639
|
+
# and
|
640
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent},
|
641
|
+
# it needs to be configured in
|
627
642
|
# {::Google::Cloud::Dialogflow::V2::ConversationProfile#human_agent_assistant_config ConversationProfile.human_agent_assistant_config}
|
628
643
|
# @!attribute [rw] query_text_sentiment
|
629
644
|
# @return [::Google::Cloud::Dialogflow::V2::Sentiment]
|
@@ -69,13 +69,15 @@ module Google
|
|
69
69
|
# `GetSessionEntityType`, `CreateSessionEntityType` and
|
70
70
|
# `UpdateSessionEntityType` only return the additional entities added in
|
71
71
|
# this session entity type. If you want to get the supplemented list,
|
72
|
-
# please call
|
73
|
-
#
|
72
|
+
# please call
|
73
|
+
# {::Google::Cloud::Dialogflow::V2::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType}
|
74
|
+
# on the custom entity type and merge.
|
74
75
|
ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
|
75
76
|
end
|
76
77
|
end
|
77
78
|
|
78
|
-
# The request message for
|
79
|
+
# The request message for
|
80
|
+
# {::Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
|
79
81
|
# @!attribute [rw] parent
|
80
82
|
# @return [::String]
|
81
83
|
# Required. The session to list all session entity types from.
|
@@ -96,7 +98,8 @@ module Google
|
|
96
98
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
97
99
|
end
|
98
100
|
|
99
|
-
# The response message for
|
101
|
+
# The response message for
|
102
|
+
# {::Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
|
100
103
|
# @!attribute [rw] session_entity_types
|
101
104
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>]
|
102
105
|
# The list of session entity types. There will be a maximum number of items
|
@@ -110,7 +113,8 @@ module Google
|
|
110
113
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
111
114
|
end
|
112
115
|
|
113
|
-
# The request message for
|
116
|
+
# The request message for
|
117
|
+
# {::Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client#get_session_entity_type SessionEntityTypes.GetSessionEntityType}.
|
114
118
|
# @!attribute [rw] name
|
115
119
|
# @return [::String]
|
116
120
|
# Required. The name of the session entity type. Format:
|
@@ -125,7 +129,8 @@ module Google
|
|
125
129
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
126
130
|
end
|
127
131
|
|
128
|
-
# The request message for
|
132
|
+
# The request message for
|
133
|
+
# {::Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client#create_session_entity_type SessionEntityTypes.CreateSessionEntityType}.
|
129
134
|
# @!attribute [rw] parent
|
130
135
|
# @return [::String]
|
131
136
|
# Required. The session to create a session entity type for.
|
@@ -142,7 +147,8 @@ module Google
|
|
142
147
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
143
148
|
end
|
144
149
|
|
145
|
-
# The request message for
|
150
|
+
# The request message for
|
151
|
+
# {::Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client#update_session_entity_type SessionEntityTypes.UpdateSessionEntityType}.
|
146
152
|
# @!attribute [rw] session_entity_type
|
147
153
|
# @return [::Google::Cloud::Dialogflow::V2::SessionEntityType]
|
148
154
|
# Required. The session entity type to update.
|
@@ -154,7 +160,8 @@ module Google
|
|
154
160
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
161
|
end
|
156
162
|
|
157
|
-
# The request message for
|
163
|
+
# The request message for
|
164
|
+
# {::Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client#delete_session_entity_type SessionEntityTypes.DeleteSessionEntityType}.
|
158
165
|
# @!attribute [rw] name
|
159
166
|
# @return [::String]
|
160
167
|
# Required. The name of the entity type to delete. Format:
|