google-cloud-dialogflow-v2 1.12.1 → 1.13.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/lib/google/cloud/dialogflow/v2/agent_coaching_instruction_pb.rb +47 -0
- data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +3 -1
- data/lib/google/cloud/dialogflow/v2/answer_records/paths.rb +19 -0
- data/lib/google/cloud/dialogflow/v2/audio_config_pb.rb +3 -1
- data/lib/google/cloud/dialogflow/v2/conversation_event_pb.rb +3 -1
- data/lib/google/cloud/dialogflow/v2/conversation_model_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +3 -1
- data/lib/google/cloud/dialogflow/v2/conversations/client.rb +10 -1
- data/lib/google/cloud/dialogflow/v2/conversations/paths.rb +19 -0
- data/lib/google/cloud/dialogflow/v2/conversations/rest/client.rb +10 -1
- data/lib/google/cloud/dialogflow/v2/document_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/generator_evaluation_pb.rb +82 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluation_services_pb.rb +51 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations/client.rb +815 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations/operations.rb +841 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations/paths.rb +92 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest/client.rb +752 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest/operations.rb +945 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest/service_stub.rb +326 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest.rb +54 -0
- data/lib/google/cloud/dialogflow/v2/generator_evaluations.rb +56 -0
- data/lib/google/cloud/dialogflow/v2/generator_pb.rb +18 -1
- data/lib/google/cloud/dialogflow/v2/generators/paths.rb +19 -0
- data/lib/google/cloud/dialogflow/v2/operations_pb.rb +45 -0
- data/lib/google/cloud/dialogflow/v2/participant_pb.rb +3 -1
- data/lib/google/cloud/dialogflow/v2/rest.rb +3 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunk_pb.rb +62 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunk_services_pb.rb +53 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunks/client.rb +885 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunks/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunks/paths.rb +69 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunks/rest/client.rb +815 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunks/rest/service_stub.rb +388 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunks/rest.rb +53 -0
- data/lib/google/cloud/dialogflow/v2/sip_trunks.rb +55 -0
- data/lib/google/cloud/dialogflow/v2/tool_call_pb.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/tool_pb.rb +80 -0
- data/lib/google/cloud/dialogflow/v2/tool_services_pb.rb +55 -0
- data/lib/google/cloud/dialogflow/v2/tools/client.rb +897 -0
- data/lib/google/cloud/dialogflow/v2/tools/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/tools/paths.rb +109 -0
- data/lib/google/cloud/dialogflow/v2/tools/rest/client.rb +827 -0
- data/lib/google/cloud/dialogflow/v2/tools/rest/service_stub.rb +388 -0
- data/lib/google/cloud/dialogflow/v2/tools/rest.rb +55 -0
- data/lib/google/cloud/dialogflow/v2/tools.rb +57 -0
- data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/webhook_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/v2.rb +3 -0
- data/proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb +109 -0
- data/proto_docs/google/cloud/dialogflow/v2/answer_record.rb +8 -3
- data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +40 -0
- data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +19 -2
- data/proto_docs/google/cloud/dialogflow/v2/conversation_event.rb +2 -0
- data/proto_docs/google/cloud/dialogflow/v2/conversation_model.rb +12 -0
- data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +38 -6
- data/proto_docs/google/cloud/dialogflow/v2/document.rb +3 -0
- data/proto_docs/google/cloud/dialogflow/v2/generator.rb +220 -4
- data/proto_docs/google/cloud/dialogflow/v2/generator_evaluation.rb +539 -0
- data/proto_docs/google/cloud/dialogflow/v2/operations.rb +39 -0
- data/proto_docs/google/cloud/dialogflow/v2/participant.rb +70 -7
- data/proto_docs/google/cloud/dialogflow/v2/sip_trunk.rb +211 -0
- data/proto_docs/google/cloud/dialogflow/v2/tool.rb +552 -0
- data/proto_docs/google/cloud/dialogflow/v2/tool_call.rb +115 -0
- metadata +39 -1
|
@@ -334,17 +334,22 @@ module Google
|
|
|
334
334
|
# @return [::Google::Cloud::Dialogflow::V2::ArticleAnswer]
|
|
335
335
|
# Output only. The article suggestion answer.
|
|
336
336
|
#
|
|
337
|
-
# Note: The following fields are mutually exclusive: `article_suggestion_answer`, `faq_answer`, `dialogflow_assist_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
337
|
+
# Note: The following fields are mutually exclusive: `article_suggestion_answer`, `faq_answer`, `dialogflow_assist_answer`, `generator_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
338
338
|
# @!attribute [r] faq_answer
|
|
339
339
|
# @return [::Google::Cloud::Dialogflow::V2::FaqAnswer]
|
|
340
340
|
# Output only. The FAQ answer.
|
|
341
341
|
#
|
|
342
|
-
# Note: The following fields are mutually exclusive: `faq_answer`, `article_suggestion_answer`, `dialogflow_assist_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
342
|
+
# Note: The following fields are mutually exclusive: `faq_answer`, `article_suggestion_answer`, `dialogflow_assist_answer`, `generator_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
343
343
|
# @!attribute [r] dialogflow_assist_answer
|
|
344
344
|
# @return [::Google::Cloud::Dialogflow::V2::DialogflowAssistAnswer]
|
|
345
345
|
# Output only. Dialogflow assist answer.
|
|
346
346
|
#
|
|
347
|
-
# Note: The following fields are mutually exclusive: `dialogflow_assist_answer`, `article_suggestion_answer`, `faq_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
347
|
+
# Note: The following fields are mutually exclusive: `dialogflow_assist_answer`, `article_suggestion_answer`, `faq_answer`, `generator_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
348
|
+
# @!attribute [r] generator_suggestion
|
|
349
|
+
# @return [::Google::Cloud::Dialogflow::V2::GeneratorSuggestion]
|
|
350
|
+
# Output only. The generator suggestion.
|
|
351
|
+
#
|
|
352
|
+
# Note: The following fields are mutually exclusive: `generator_suggestion`, `article_suggestion_answer`, `faq_answer`, `dialogflow_assist_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
348
353
|
class AgentAssistantRecord
|
|
349
354
|
include ::Google::Protobuf::MessageExts
|
|
350
355
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -99,6 +99,8 @@ module Google
|
|
|
99
99
|
# Support](https://cloud.google.com/dialogflow/docs/reference/language)
|
|
100
100
|
# for a list of the currently supported language codes. Note that queries in
|
|
101
101
|
# the same session do not necessarily need to specify the same language.
|
|
102
|
+
# If not set, the language is inferred from the
|
|
103
|
+
# {::Google::Cloud::Dialogflow::V2::ConversationProfile#stt_config ConversationProfile.stt_config}.
|
|
102
104
|
# @!attribute [rw] enable_word_info
|
|
103
105
|
# @return [::Boolean]
|
|
104
106
|
# If `true`, Dialogflow returns
|
|
@@ -222,11 +224,46 @@ module Google
|
|
|
222
224
|
# @!attribute [rw] voice
|
|
223
225
|
# @return [::Google::Cloud::Dialogflow::V2::VoiceSelectionParams]
|
|
224
226
|
# Optional. The desired voice of the synthesized audio.
|
|
227
|
+
# @!attribute [rw] pronunciations
|
|
228
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::CustomPronunciationParams>]
|
|
229
|
+
# Optional. The custom pronunciations for the synthesized audio.
|
|
225
230
|
class SynthesizeSpeechConfig
|
|
226
231
|
include ::Google::Protobuf::MessageExts
|
|
227
232
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
228
233
|
end
|
|
229
234
|
|
|
235
|
+
# Pronunciation customization for a phrase.
|
|
236
|
+
# @!attribute [rw] phrase
|
|
237
|
+
# @return [::String]
|
|
238
|
+
# The phrase to which the customization is applied.
|
|
239
|
+
# The phrase can be multiple words, such as proper nouns, but shouldn't span
|
|
240
|
+
# the length of the sentence.
|
|
241
|
+
# @!attribute [rw] phonetic_encoding
|
|
242
|
+
# @return [::Google::Cloud::Dialogflow::V2::CustomPronunciationParams::PhoneticEncoding]
|
|
243
|
+
# The phonetic encoding of the phrase.
|
|
244
|
+
# @!attribute [rw] pronunciation
|
|
245
|
+
# @return [::String]
|
|
246
|
+
# The pronunciation of the phrase. This must be in the phonetic encoding
|
|
247
|
+
# specified above.
|
|
248
|
+
class CustomPronunciationParams
|
|
249
|
+
include ::Google::Protobuf::MessageExts
|
|
250
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
251
|
+
|
|
252
|
+
# The phonetic encoding of the phrase.
|
|
253
|
+
module PhoneticEncoding
|
|
254
|
+
# Not specified.
|
|
255
|
+
PHONETIC_ENCODING_UNSPECIFIED = 0
|
|
256
|
+
|
|
257
|
+
# IPA, such as apple -> ˈæpəl.
|
|
258
|
+
# https://en.wikipedia.org/wiki/International_Phonetic_Alphabet
|
|
259
|
+
PHONETIC_ENCODING_IPA = 1
|
|
260
|
+
|
|
261
|
+
# X-SAMPA, such as apple -> "{p@l".
|
|
262
|
+
# https://en.wikipedia.org/wiki/X-SAMPA
|
|
263
|
+
PHONETIC_ENCODING_X_SAMPA = 2
|
|
264
|
+
end
|
|
265
|
+
end
|
|
266
|
+
|
|
230
267
|
# Instructs the speech synthesizer on how to generate the output audio content.
|
|
231
268
|
# If this audio config is supplied in a request, it overrides all existing
|
|
232
269
|
# text-to-speech settings applied to the agent.
|
|
@@ -315,6 +352,9 @@ module Google
|
|
|
315
352
|
# Support](https://cloud.google.com/dialogflow/docs/reference/language)
|
|
316
353
|
# for a list of the currently supported language codes. Note that queries in
|
|
317
354
|
# the same session do not necessarily need to specify the same language.
|
|
355
|
+
# If not specified, the default language configured at
|
|
356
|
+
# {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile} is
|
|
357
|
+
# used.
|
|
318
358
|
# @!attribute [rw] enable_word_info
|
|
319
359
|
# @return [::Boolean]
|
|
320
360
|
# If `true`, Dialogflow returns
|
|
@@ -84,8 +84,9 @@ module Google
|
|
|
84
84
|
# Output only. The number dialed to connect this call in E.164 format.
|
|
85
85
|
# @!attribute [rw] sdp
|
|
86
86
|
# @return [::String]
|
|
87
|
-
# Optional. SDP of the call. It's initially the SDP answer to the
|
|
88
|
-
# but maybe later updated for the purpose of making the link active,
|
|
87
|
+
# Optional. SDP of the call. It's initially the SDP answer to the incoming
|
|
88
|
+
# call, but maybe later updated for the purpose of making the link active,
|
|
89
|
+
# etc.
|
|
89
90
|
# @!attribute [r] sip_headers
|
|
90
91
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
|
|
91
92
|
# Output only. The SIP headers from the initial SIP INVITE.
|
|
@@ -150,6 +151,12 @@ module Google
|
|
|
150
151
|
# @return [::Google::Protobuf::Timestamp]
|
|
151
152
|
# Output only. The time when this information was incorporated into the
|
|
152
153
|
# relevant context reference.
|
|
154
|
+
# @!attribute [rw] answer_record
|
|
155
|
+
# @return [::String]
|
|
156
|
+
# If the context content was generated from a tool call, specify the
|
|
157
|
+
# answer record associated with the tool call.
|
|
158
|
+
# Format: `projects/<Project ID>/locations/<Location
|
|
159
|
+
# ID>/answerRecords/<Answer Record ID>`.
|
|
153
160
|
class ContextContent
|
|
154
161
|
include ::Google::Protobuf::MessageExts
|
|
155
162
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -625,6 +632,16 @@ module Google
|
|
|
625
632
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::TriggerEvent>]
|
|
626
633
|
# Optional. A list of trigger events. Generator will be triggered only if
|
|
627
634
|
# it's trigger event is included here.
|
|
635
|
+
# @!attribute [rw] security_settings
|
|
636
|
+
# @return [::String]
|
|
637
|
+
# Optional. Name of the CX SecuritySettings which is used to redact generated
|
|
638
|
+
# response. If this field is empty, try to fetch v2 security_settings, which
|
|
639
|
+
# is a project level setting. If this field is empty and no v2
|
|
640
|
+
# security_settings set up in this project, no redaction will be done.
|
|
641
|
+
#
|
|
642
|
+
# Format:
|
|
643
|
+
# `projects/<Project ID>/locations/<Location ID>/securitySettings/<Security
|
|
644
|
+
# Settings ID>`.
|
|
628
645
|
class GenerateStatelessSuggestionRequest
|
|
629
646
|
include ::Google::Protobuf::MessageExts
|
|
630
647
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -60,6 +60,8 @@ module Google
|
|
|
60
60
|
|
|
61
61
|
# An existing conversation has closed. This is fired when a telephone call
|
|
62
62
|
# is terminated, or a conversation is closed via the API.
|
|
63
|
+
# The event is fired for every CompleteConversation call, even if the
|
|
64
|
+
# conversation is already closed.
|
|
63
65
|
CONVERSATION_FINISHED = 2
|
|
64
66
|
|
|
65
67
|
# An existing conversation has received notification from Dialogflow that
|
|
@@ -435,6 +435,9 @@ module Google
|
|
|
435
435
|
# @return [::Google::Protobuf::Timestamp]
|
|
436
436
|
# Timestamp when the request to create conversation model is submitted. The
|
|
437
437
|
# time is measured on server side.
|
|
438
|
+
# @!attribute [rw] done_time
|
|
439
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
440
|
+
# The time when the operation finished.
|
|
438
441
|
class CreateConversationModelOperationMetadata
|
|
439
442
|
include ::Google::Protobuf::MessageExts
|
|
440
443
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -477,6 +480,9 @@ module Google
|
|
|
477
480
|
# @return [::Google::Protobuf::Timestamp]
|
|
478
481
|
# Timestamp when request to deploy conversation model was submitted. The time
|
|
479
482
|
# is measured on server side.
|
|
483
|
+
# @!attribute [rw] done_time
|
|
484
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
485
|
+
# The time when the operation finished.
|
|
480
486
|
class DeployConversationModelOperationMetadata
|
|
481
487
|
include ::Google::Protobuf::MessageExts
|
|
482
488
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -493,6 +499,9 @@ module Google
|
|
|
493
499
|
# @return [::Google::Protobuf::Timestamp]
|
|
494
500
|
# Timestamp when the request to undeploy conversation model was submitted.
|
|
495
501
|
# The time is measured on server side.
|
|
502
|
+
# @!attribute [rw] done_time
|
|
503
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
504
|
+
# The time when the operation finished.
|
|
496
505
|
class UndeployConversationModelOperationMetadata
|
|
497
506
|
include ::Google::Protobuf::MessageExts
|
|
498
507
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -509,6 +518,9 @@ module Google
|
|
|
509
518
|
# @return [::Google::Protobuf::Timestamp]
|
|
510
519
|
# Timestamp when delete conversation model request was created. The time is
|
|
511
520
|
# measured on server side.
|
|
521
|
+
# @!attribute [rw] done_time
|
|
522
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
523
|
+
# The time when the operation finished.
|
|
512
524
|
class DeleteConversationModelOperationMetadata
|
|
513
525
|
include ::Google::Protobuf::MessageExts
|
|
514
526
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -281,6 +281,20 @@ module Google
|
|
|
281
281
|
# @return [::Boolean]
|
|
282
282
|
# Optional. Enable query suggestion only.
|
|
283
283
|
# Supported features: KNOWLEDGE_ASSIST
|
|
284
|
+
# @!attribute [rw] enable_response_debug_info
|
|
285
|
+
# @return [::Boolean]
|
|
286
|
+
# Optional. Enable returning detailed reasons for suggestion results.
|
|
287
|
+
#
|
|
288
|
+
# For example, with this field disabled, Knowledge Search feature returns
|
|
289
|
+
# NotFound error when no answer is found for the input query. Enabling this
|
|
290
|
+
# field will change the behavior to return an OK response with
|
|
291
|
+
# detailed information indicating the lack of results.
|
|
292
|
+
#
|
|
293
|
+
# Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST
|
|
294
|
+
# @!attribute [rw] rai_settings
|
|
295
|
+
# @return [::Google::Cloud::Dialogflow::V2::RaiSettings]
|
|
296
|
+
# Optional. Settings for Responsible AI checks.
|
|
297
|
+
# Supported features: KNOWLEDGE_ASSIST
|
|
284
298
|
# @!attribute [rw] suggestion_trigger_settings
|
|
285
299
|
# @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionTriggerSettings]
|
|
286
300
|
# Settings of suggestion trigger.
|
|
@@ -330,6 +344,23 @@ module Google
|
|
|
330
344
|
# enable_event_based_suggestion must be set to true to receive the
|
|
331
345
|
# responses from high latency features in Pub/Sub. High latency feature(s):
|
|
332
346
|
# KNOWLEDGE_ASSIST
|
|
347
|
+
# @!attribute [rw] skip_empty_event_based_suggestion
|
|
348
|
+
# @return [::Boolean]
|
|
349
|
+
# Optional. Enable skipping event based suggestion if the suggestion is
|
|
350
|
+
# empty.
|
|
351
|
+
#
|
|
352
|
+
# For example, with this field disabled, Knowledge Assist feature sends
|
|
353
|
+
# a Pub/Sub message when there are no suggestions. Enabling this field
|
|
354
|
+
# will change the behavior to skip the Pub/Sub message in this situation.
|
|
355
|
+
# @!attribute [rw] use_unredacted_conversation_data
|
|
356
|
+
# @return [::Boolean]
|
|
357
|
+
# Optional. If true,
|
|
358
|
+
# use unredacted transcript data (Supported features: AI_COACH) and
|
|
359
|
+
# use unredacted ingested context (Supported features: All Agent Assist
|
|
360
|
+
# features)
|
|
361
|
+
# @!attribute [rw] enable_async_tool_call
|
|
362
|
+
# @return [::Boolean]
|
|
363
|
+
# Optional. If true, enable asynchronous execution of tools.
|
|
333
364
|
class SuggestionConfig
|
|
334
365
|
include ::Google::Protobuf::MessageExts
|
|
335
366
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -524,7 +555,7 @@ module Google
|
|
|
524
555
|
# Custom conversation models used in agent assist feature.
|
|
525
556
|
#
|
|
526
557
|
# Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY,
|
|
527
|
-
# CONVERSATION_SUMMARIZATION
|
|
558
|
+
# CONVERSATION_SUMMARIZATION
|
|
528
559
|
# @!attribute [rw] model
|
|
529
560
|
# @return [::String]
|
|
530
561
|
# Conversation model resource name. Format: `projects/<Project
|
|
@@ -534,11 +565,12 @@ module Google
|
|
|
534
565
|
# Version of current baseline model. It will be ignored if
|
|
535
566
|
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig#model model}
|
|
536
567
|
# is set. Valid versions are:
|
|
537
|
-
#
|
|
538
|
-
#
|
|
539
|
-
#
|
|
540
|
-
#
|
|
541
|
-
#
|
|
568
|
+
#
|
|
569
|
+
# - Article Suggestion baseline model:
|
|
570
|
+
# - 0.9
|
|
571
|
+
# - 1.0 (default)
|
|
572
|
+
# - Summarization baseline model:
|
|
573
|
+
# - 1.0
|
|
542
574
|
class ConversationModelConfig
|
|
543
575
|
include ::Google::Protobuf::MessageExts
|
|
544
576
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -414,6 +414,9 @@ module Google
|
|
|
414
414
|
# @!attribute [rw] export_operation_metadata
|
|
415
415
|
# @return [::Google::Cloud::Dialogflow::V2::ExportOperationMetadata]
|
|
416
416
|
# Metadata for the Export Data Operation such as the destination of export.
|
|
417
|
+
# @!attribute [rw] done_time
|
|
418
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
419
|
+
# The time when the operation finished.
|
|
417
420
|
class KnowledgeOperationMetadata
|
|
418
421
|
include ::Google::Protobuf::MessageExts
|
|
419
422
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -228,6 +228,26 @@ module Google
|
|
|
228
228
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
229
229
|
end
|
|
230
230
|
|
|
231
|
+
# Agent Coaching context that customer can configure.
|
|
232
|
+
# @!attribute [rw] overarching_guidance
|
|
233
|
+
# @return [::String]
|
|
234
|
+
# Optional. The overarching guidance for the agent coaching. This should be
|
|
235
|
+
# set only for v1.5 and later versions.
|
|
236
|
+
# @!attribute [rw] instructions
|
|
237
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction>]
|
|
238
|
+
# Optional. Customized instructions for agent coaching.
|
|
239
|
+
# @!attribute [rw] version
|
|
240
|
+
# @return [::String]
|
|
241
|
+
# Optional. Version of the feature. If not set, default to latest version.
|
|
242
|
+
# Current candidates are ["1.2"].
|
|
243
|
+
# @!attribute [rw] output_language_code
|
|
244
|
+
# @return [::String]
|
|
245
|
+
# Optional. Output language code.
|
|
246
|
+
class AgentCoachingContext
|
|
247
|
+
include ::Google::Protobuf::MessageExts
|
|
248
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
249
|
+
end
|
|
250
|
+
|
|
231
251
|
# Represents the section of summarization.
|
|
232
252
|
# @!attribute [rw] key
|
|
233
253
|
# @return [::String]
|
|
@@ -332,12 +352,17 @@ module Google
|
|
|
332
352
|
# @return [::Google::Cloud::Dialogflow::V2::FreeFormContext]
|
|
333
353
|
# Input of free from generator to LLM.
|
|
334
354
|
#
|
|
335
|
-
# Note: The following fields are mutually exclusive: `free_form_context`, `summarization_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
355
|
+
# Note: The following fields are mutually exclusive: `free_form_context`, `agent_coaching_context`, `summarization_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
356
|
+
# @!attribute [rw] agent_coaching_context
|
|
357
|
+
# @return [::Google::Cloud::Dialogflow::V2::AgentCoachingContext]
|
|
358
|
+
# Input of prebuilt Agent Coaching feature.
|
|
359
|
+
#
|
|
360
|
+
# Note: The following fields are mutually exclusive: `agent_coaching_context`, `free_form_context`, `summarization_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
336
361
|
# @!attribute [rw] summarization_context
|
|
337
362
|
# @return [::Google::Cloud::Dialogflow::V2::SummarizationContext]
|
|
338
363
|
# Input of prebuilt Summarization feature.
|
|
339
364
|
#
|
|
340
|
-
# Note: The following fields are mutually exclusive: `summarization_context`, `free_form_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
365
|
+
# Note: The following fields are mutually exclusive: `summarization_context`, `free_form_context`, `agent_coaching_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
341
366
|
# @!attribute [rw] inference_parameter
|
|
342
367
|
# @return [::Google::Cloud::Dialogflow::V2::InferenceParameter]
|
|
343
368
|
# Optional. Inference parameters for this generator.
|
|
@@ -358,6 +383,14 @@ module Google
|
|
|
358
383
|
# @!attribute [r] update_time
|
|
359
384
|
# @return [::Google::Protobuf::Timestamp]
|
|
360
385
|
# Output only. Update time of this generator.
|
|
386
|
+
# @!attribute [rw] tools
|
|
387
|
+
# @return [::Array<::String>]
|
|
388
|
+
# Optional. Resource names of the tools that the generator can choose from.
|
|
389
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/tools/<tool ID>`.
|
|
390
|
+
# @!attribute [rw] suggestion_deduping_config
|
|
391
|
+
# @return [::Google::Cloud::Dialogflow::V2::SuggestionDedupingConfig]
|
|
392
|
+
# Optional. Configuration for suggestion deduping. This is only applicable to
|
|
393
|
+
# AI Coach feature.
|
|
361
394
|
class Generator
|
|
362
395
|
include ::Google::Protobuf::MessageExts
|
|
363
396
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -393,20 +426,203 @@ module Google
|
|
|
393
426
|
end
|
|
394
427
|
end
|
|
395
428
|
|
|
429
|
+
# Suggestion for coaching agents.
|
|
430
|
+
# @!attribute [rw] applicable_instructions
|
|
431
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction>]
|
|
432
|
+
# Optional. Instructions applicable based on the current context.
|
|
433
|
+
# @!attribute [rw] agent_action_suggestions
|
|
434
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion::AgentActionSuggestion>]
|
|
435
|
+
# Optional. Suggested actions for the agent to take.
|
|
436
|
+
# @!attribute [rw] sample_responses
|
|
437
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion::SampleResponse>]
|
|
438
|
+
# Optional. Sample response for the Agent.
|
|
439
|
+
class AgentCoachingSuggestion
|
|
440
|
+
include ::Google::Protobuf::MessageExts
|
|
441
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
442
|
+
|
|
443
|
+
# Sources for the suggestion.
|
|
444
|
+
# @!attribute [r] instruction_indexes
|
|
445
|
+
# @return [::Array<::Integer>]
|
|
446
|
+
# Output only. Source instruction indexes for the suggestion. This is the
|
|
447
|
+
# index of the applicable_instructions field.
|
|
448
|
+
class Sources
|
|
449
|
+
include ::Google::Protobuf::MessageExts
|
|
450
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
451
|
+
end
|
|
452
|
+
|
|
453
|
+
# Duplication check for the suggestion.
|
|
454
|
+
# @!attribute [r] duplicate_suggestions
|
|
455
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion::DuplicateCheckResult::DuplicateSuggestion>]
|
|
456
|
+
# Output only. The duplicate suggestions.
|
|
457
|
+
class DuplicateCheckResult
|
|
458
|
+
include ::Google::Protobuf::MessageExts
|
|
459
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
460
|
+
|
|
461
|
+
# The duplicate suggestion details.
|
|
462
|
+
# Keeping answer_record and sources together as they are identifiers for
|
|
463
|
+
# duplicate suggestions.
|
|
464
|
+
# @!attribute [r] answer_record
|
|
465
|
+
# @return [::String]
|
|
466
|
+
# Output only. The answer record id of the past duplicate suggestion.
|
|
467
|
+
# @!attribute [r] sources
|
|
468
|
+
# @return [::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion::Sources]
|
|
469
|
+
# Output only. Sources for the suggestion.
|
|
470
|
+
# @!attribute [r] suggestion_index
|
|
471
|
+
# @return [::Integer]
|
|
472
|
+
# Output only. The index of the duplicate suggestion in the past
|
|
473
|
+
# suggestion list.
|
|
474
|
+
# @!attribute [r] similarity_score
|
|
475
|
+
# @return [::Float]
|
|
476
|
+
# Output only. The similarity score of between the past and current
|
|
477
|
+
# suggestion.
|
|
478
|
+
class DuplicateSuggestion
|
|
479
|
+
include ::Google::Protobuf::MessageExts
|
|
480
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
481
|
+
end
|
|
482
|
+
end
|
|
483
|
+
|
|
484
|
+
# Actions suggested for the agent. This is based on applicable instructions.
|
|
485
|
+
# @!attribute [rw] agent_action
|
|
486
|
+
# @return [::String]
|
|
487
|
+
# Optional. The suggested action for the agent.
|
|
488
|
+
# @!attribute [r] sources
|
|
489
|
+
# @return [::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion::Sources]
|
|
490
|
+
# Output only. Sources for the agent action suggestion.
|
|
491
|
+
# @!attribute [r] duplicate_check_result
|
|
492
|
+
# @return [::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion::DuplicateCheckResult]
|
|
493
|
+
# Output only. Duplicate check result for the agent action suggestion.
|
|
494
|
+
class AgentActionSuggestion
|
|
495
|
+
include ::Google::Protobuf::MessageExts
|
|
496
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
497
|
+
end
|
|
498
|
+
|
|
499
|
+
# Sample response that the agent can use. This could be based on applicable
|
|
500
|
+
# instructions and ingested data from other systems.
|
|
501
|
+
# @!attribute [rw] response_text
|
|
502
|
+
# @return [::String]
|
|
503
|
+
# Optional. Sample response for Agent in text.
|
|
504
|
+
# @!attribute [r] sources
|
|
505
|
+
# @return [::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion::Sources]
|
|
506
|
+
# Output only. Sources for the Sample Response.
|
|
507
|
+
# @!attribute [r] duplicate_check_result
|
|
508
|
+
# @return [::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion::DuplicateCheckResult]
|
|
509
|
+
# Output only. Duplicate check result for the sample response.
|
|
510
|
+
class SampleResponse
|
|
511
|
+
include ::Google::Protobuf::MessageExts
|
|
512
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
513
|
+
end
|
|
514
|
+
end
|
|
515
|
+
|
|
396
516
|
# Suggestion generated using a Generator.
|
|
397
517
|
# @!attribute [rw] free_form_suggestion
|
|
398
518
|
# @return [::Google::Cloud::Dialogflow::V2::FreeFormSuggestion]
|
|
399
519
|
# Optional. Free form suggestion.
|
|
400
520
|
#
|
|
401
|
-
# Note: The following fields are mutually exclusive: `free_form_suggestion`, `summary_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
521
|
+
# Note: The following fields are mutually exclusive: `free_form_suggestion`, `summary_suggestion`, `agent_coaching_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
402
522
|
# @!attribute [rw] summary_suggestion
|
|
403
523
|
# @return [::Google::Cloud::Dialogflow::V2::SummarySuggestion]
|
|
404
524
|
# Optional. Suggested summary.
|
|
405
525
|
#
|
|
406
|
-
# Note: The following fields are mutually exclusive: `summary_suggestion`, `free_form_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
526
|
+
# Note: The following fields are mutually exclusive: `summary_suggestion`, `free_form_suggestion`, `agent_coaching_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
527
|
+
# @!attribute [rw] agent_coaching_suggestion
|
|
528
|
+
# @return [::Google::Cloud::Dialogflow::V2::AgentCoachingSuggestion]
|
|
529
|
+
# Optional. Suggestion to coach the agent.
|
|
530
|
+
#
|
|
531
|
+
# Note: The following fields are mutually exclusive: `agent_coaching_suggestion`, `free_form_suggestion`, `summary_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
532
|
+
# @!attribute [rw] tool_call_info
|
|
533
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::GeneratorSuggestion::ToolCallInfo>]
|
|
534
|
+
# Optional. List of request and response for tool calls executed.
|
|
407
535
|
class GeneratorSuggestion
|
|
408
536
|
include ::Google::Protobuf::MessageExts
|
|
409
537
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
538
|
+
|
|
539
|
+
# Request and response for a tool call.
|
|
540
|
+
# @!attribute [rw] tool_call
|
|
541
|
+
# @return [::Google::Cloud::Dialogflow::V2::ToolCall]
|
|
542
|
+
# Required. Request for a tool call.
|
|
543
|
+
# @!attribute [rw] tool_call_result
|
|
544
|
+
# @return [::Google::Cloud::Dialogflow::V2::ToolCallResult]
|
|
545
|
+
# Required. Response for a tool call.
|
|
546
|
+
class ToolCallInfo
|
|
547
|
+
include ::Google::Protobuf::MessageExts
|
|
548
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
549
|
+
end
|
|
550
|
+
end
|
|
551
|
+
|
|
552
|
+
# Config for suggestion deduping.
|
|
553
|
+
# NEXT_ID: 3
|
|
554
|
+
# @!attribute [rw] enable_deduping
|
|
555
|
+
# @return [::Boolean]
|
|
556
|
+
# Optional. Whether to enable suggestion deduping.
|
|
557
|
+
# @!attribute [rw] similarity_threshold
|
|
558
|
+
# @return [::Float]
|
|
559
|
+
# Optional. The threshold for similarity between two suggestions.
|
|
560
|
+
# Acceptable value is [0.0, 1.0], default to 0.8
|
|
561
|
+
class SuggestionDedupingConfig
|
|
562
|
+
include ::Google::Protobuf::MessageExts
|
|
563
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
564
|
+
end
|
|
565
|
+
|
|
566
|
+
# Settings for Responsible AI checks.
|
|
567
|
+
# @!attribute [rw] rai_category_configs
|
|
568
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::RaiSettings::RaiCategoryConfig>]
|
|
569
|
+
# Configuration for a set of RAI categories.
|
|
570
|
+
class RaiSettings
|
|
571
|
+
include ::Google::Protobuf::MessageExts
|
|
572
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
573
|
+
|
|
574
|
+
# Configuration for a specific RAI category.
|
|
575
|
+
# @!attribute [rw] category
|
|
576
|
+
# @return [::Google::Cloud::Dialogflow::V2::RaiSettings::RaiCategoryConfig::RaiCategory]
|
|
577
|
+
# Optional. The RAI category.
|
|
578
|
+
# @!attribute [rw] sensitivity_level
|
|
579
|
+
# @return [::Google::Cloud::Dialogflow::V2::RaiSettings::RaiCategoryConfig::SensitivityLevel]
|
|
580
|
+
# Optional. The sensitivity level for this category.
|
|
581
|
+
class RaiCategoryConfig
|
|
582
|
+
include ::Google::Protobuf::MessageExts
|
|
583
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
584
|
+
|
|
585
|
+
# Enum for RAI category.
|
|
586
|
+
module RaiCategory
|
|
587
|
+
# Default value.
|
|
588
|
+
RAI_CATEGORY_UNSPECIFIED = 0
|
|
589
|
+
|
|
590
|
+
# Dangerous content.
|
|
591
|
+
DANGEROUS_CONTENT = 1
|
|
592
|
+
|
|
593
|
+
# Sexually explicit content.
|
|
594
|
+
SEXUALLY_EXPLICIT = 2
|
|
595
|
+
|
|
596
|
+
# Harassment content.
|
|
597
|
+
HARASSMENT = 3
|
|
598
|
+
|
|
599
|
+
# Hate speech content.
|
|
600
|
+
HATE_SPEECH = 4
|
|
601
|
+
end
|
|
602
|
+
|
|
603
|
+
# Enum for user-configurable sensitivity levels.
|
|
604
|
+
module SensitivityLevel
|
|
605
|
+
# Default value.
|
|
606
|
+
# If unspecified, the default behavior is:
|
|
607
|
+
# - DANGEROUS_CONTENT: BLOCK_FEW
|
|
608
|
+
# - SEXUALLY_EXPLICIT: BLOCK_SOME
|
|
609
|
+
# - HARASSMENT: BLOCK_SOME
|
|
610
|
+
# - HATE_SPEECH: BLOCK_SOME
|
|
611
|
+
SENSITIVITY_LEVEL_UNSPECIFIED = 0
|
|
612
|
+
|
|
613
|
+
# Block most potentially sensitive responses.
|
|
614
|
+
BLOCK_MOST = 1
|
|
615
|
+
|
|
616
|
+
# Block some potentially sensitive responses.
|
|
617
|
+
BLOCK_SOME = 2
|
|
618
|
+
|
|
619
|
+
# Block a few potentially sensitive responses.
|
|
620
|
+
BLOCK_FEW = 3
|
|
621
|
+
|
|
622
|
+
# No filtering for this category.
|
|
623
|
+
BLOCK_NONE = 4
|
|
624
|
+
end
|
|
625
|
+
end
|
|
410
626
|
end
|
|
411
627
|
|
|
412
628
|
# The event that triggers the generator and LLM execution.
|