google-cloud-dialogflow-v2 1.14.0 → 1.16.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.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/v2/agents/client.rb +2 -0
  4. data/lib/google/cloud/dialogflow/v2/agents/operations.rb +2 -0
  5. data/lib/google/cloud/dialogflow/v2/agents/rest/client.rb +2 -0
  6. data/lib/google/cloud/dialogflow/v2/agents/rest/operations.rb +2 -0
  7. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +2 -0
  8. data/lib/google/cloud/dialogflow/v2/answer_records/paths.rb +70 -4
  9. data/lib/google/cloud/dialogflow/v2/answer_records/rest/client.rb +2 -0
  10. data/lib/google/cloud/dialogflow/v2/ces_app_pb.rb +25 -0
  11. data/lib/google/cloud/dialogflow/v2/ces_tool_pb.rb +25 -0
  12. data/lib/google/cloud/dialogflow/v2/contexts/client.rb +2 -0
  13. data/lib/google/cloud/dialogflow/v2/contexts/rest/client.rb +2 -0
  14. data/lib/google/cloud/dialogflow/v2/conversation_datasets/client.rb +2 -0
  15. data/lib/google/cloud/dialogflow/v2/conversation_datasets/operations.rb +2 -0
  16. data/lib/google/cloud/dialogflow/v2/conversation_datasets/rest/client.rb +2 -0
  17. data/lib/google/cloud/dialogflow/v2/conversation_datasets/rest/operations.rb +2 -0
  18. data/lib/google/cloud/dialogflow/v2/conversation_models/client.rb +2 -0
  19. data/lib/google/cloud/dialogflow/v2/conversation_models/operations.rb +2 -0
  20. data/lib/google/cloud/dialogflow/v2/conversation_models/rest/client.rb +2 -0
  21. data/lib/google/cloud/dialogflow/v2/conversation_models/rest/operations.rb +2 -0
  22. data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +6 -1
  23. data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +1 -1
  24. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +2 -0
  25. data/lib/google/cloud/dialogflow/v2/conversation_profiles/operations.rb +2 -0
  26. data/lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb +2 -0
  27. data/lib/google/cloud/dialogflow/v2/conversation_profiles/rest/operations.rb +2 -0
  28. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +2 -0
  29. data/lib/google/cloud/dialogflow/v2/conversations/paths.rb +70 -4
  30. data/lib/google/cloud/dialogflow/v2/conversations/rest/client.rb +2 -0
  31. data/lib/google/cloud/dialogflow/v2/documents/client.rb +2 -0
  32. data/lib/google/cloud/dialogflow/v2/documents/operations.rb +2 -0
  33. data/lib/google/cloud/dialogflow/v2/documents/rest/client.rb +2 -0
  34. data/lib/google/cloud/dialogflow/v2/documents/rest/operations.rb +2 -0
  35. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/client.rb +2 -0
  36. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/operations.rb +2 -0
  37. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/rest/client.rb +2 -0
  38. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/rest/operations.rb +2 -0
  39. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +2 -0
  40. data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +2 -0
  41. data/lib/google/cloud/dialogflow/v2/entity_types/rest/client.rb +2 -0
  42. data/lib/google/cloud/dialogflow/v2/entity_types/rest/operations.rb +2 -0
  43. data/lib/google/cloud/dialogflow/v2/environments/client.rb +2 -0
  44. data/lib/google/cloud/dialogflow/v2/environments/rest/client.rb +2 -0
  45. data/lib/google/cloud/dialogflow/v2/fulfillments/client.rb +2 -0
  46. data/lib/google/cloud/dialogflow/v2/fulfillments/rest/client.rb +2 -0
  47. data/lib/google/cloud/dialogflow/v2/generator_evaluations/client.rb +2 -0
  48. data/lib/google/cloud/dialogflow/v2/generator_evaluations/operations.rb +2 -0
  49. data/lib/google/cloud/dialogflow/v2/generator_evaluations/paths.rb +70 -4
  50. data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest/client.rb +2 -0
  51. data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest/operations.rb +2 -0
  52. data/lib/google/cloud/dialogflow/v2/generator_pb.rb +4 -1
  53. data/lib/google/cloud/dialogflow/v2/generators/client.rb +2 -0
  54. data/lib/google/cloud/dialogflow/v2/generators/paths.rb +70 -4
  55. data/lib/google/cloud/dialogflow/v2/generators/rest/client.rb +2 -0
  56. data/lib/google/cloud/dialogflow/v2/intents/client.rb +2 -0
  57. data/lib/google/cloud/dialogflow/v2/intents/operations.rb +2 -0
  58. data/lib/google/cloud/dialogflow/v2/intents/rest/client.rb +2 -0
  59. data/lib/google/cloud/dialogflow/v2/intents/rest/operations.rb +2 -0
  60. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +2 -0
  61. data/lib/google/cloud/dialogflow/v2/knowledge_bases/rest/client.rb +2 -0
  62. data/lib/google/cloud/dialogflow/v2/participant_pb.rb +11 -1
  63. data/lib/google/cloud/dialogflow/v2/participants/client.rb +2 -0
  64. data/lib/google/cloud/dialogflow/v2/participants/rest/client.rb +2 -0
  65. data/lib/google/cloud/dialogflow/v2/rest.rb +1 -1
  66. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +2 -0
  67. data/lib/google/cloud/dialogflow/v2/session_entity_types/rest/client.rb +2 -0
  68. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +2 -0
  69. data/lib/google/cloud/dialogflow/v2/sessions/rest/client.rb +2 -0
  70. data/lib/google/cloud/dialogflow/v2/sip_trunks/client.rb +2 -0
  71. data/lib/google/cloud/dialogflow/v2/sip_trunks/rest/client.rb +2 -0
  72. data/lib/google/cloud/dialogflow/v2/tool_call_pb.rb +1 -1
  73. data/lib/google/cloud/dialogflow/v2/tools/client.rb +2 -0
  74. data/lib/google/cloud/dialogflow/v2/tools/rest/client.rb +2 -0
  75. data/lib/google/cloud/dialogflow/v2/toolset_pb.rb +25 -0
  76. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  77. data/lib/google/cloud/dialogflow/v2/versions/client.rb +2 -0
  78. data/lib/google/cloud/dialogflow/v2/versions/rest/client.rb +2 -0
  79. data/lib/google/cloud/dialogflow/v2.rb +1 -1
  80. data/proto_docs/google/api/client.rb +149 -29
  81. data/proto_docs/google/cloud/dialogflow/v2/ces_app.rb +39 -0
  82. data/proto_docs/google/cloud/dialogflow/v2/ces_tool.rb +39 -0
  83. data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +106 -0
  84. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +24 -0
  85. data/proto_docs/google/cloud/dialogflow/v2/generator.rb +9 -0
  86. data/proto_docs/google/cloud/dialogflow/v2/participant.rb +271 -0
  87. data/proto_docs/google/cloud/dialogflow/v2/tool_call.rb +46 -0
  88. data/proto_docs/google/cloud/dialogflow/v2/toolset.rb +44 -0
  89. data/proto_docs/google/type/latlng.rb +3 -3
  90. metadata +9 -3
@@ -70,9 +70,18 @@ module Google
70
70
  # @!attribute [r] telephony_connection_info
71
71
  # @return [::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo]
72
72
  # Output only. The telephony connection information.
73
+ # @!attribute [r] initial_conversation_profile
74
+ # @return [::Google::Cloud::Dialogflow::V2::ConversationProfile]
75
+ # Optional. Output only. The initial conversation profile to be used to
76
+ # configure this conversation, which is a copy of the conversation profile
77
+ # config read at conversation creation time.
73
78
  # @!attribute [r] ingested_context_references
74
79
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Conversation::ContextReference}]
75
80
  # Output only. The context reference updates provided by external systems.
81
+ # @!attribute [r] initial_generator_contexts
82
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Conversation::GeneratorContext}]
83
+ # Output only. A map with generator name as key and generator context as
84
+ # value.
76
85
  class Conversation
77
86
  include ::Google::Protobuf::MessageExts
78
87
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -187,6 +196,39 @@ module Google
187
196
  end
188
197
  end
189
198
 
199
+ # Represents the context of a generator.
200
+ # @!attribute [r] generator_type
201
+ # @return [::Google::Cloud::Dialogflow::V2::Conversation::GeneratorContext::GeneratorType]
202
+ # Output only. The type of the generator.
203
+ class GeneratorContext
204
+ include ::Google::Protobuf::MessageExts
205
+ extend ::Google::Protobuf::MessageExts::ClassMethods
206
+
207
+ # The available generator types.
208
+ module GeneratorType
209
+ # Unspecified generator type.
210
+ GENERATOR_TYPE_UNSPECIFIED = 0
211
+
212
+ # Free form generator type.
213
+ FREE_FORM = 1
214
+
215
+ # Agent coaching generator type.
216
+ AGENT_COACHING = 2
217
+
218
+ # Summarization generator type.
219
+ SUMMARIZATION = 3
220
+
221
+ # Translation generator type.
222
+ TRANSLATION = 4
223
+
224
+ # Agent feedback generator type.
225
+ AGENT_FEEDBACK = 5
226
+
227
+ # Customer message generation generator type.
228
+ CUSTOMER_MESSAGE_GENERATION = 6
229
+ end
230
+ end
231
+
190
232
  # @!attribute [rw] key
191
233
  # @return [::String]
192
234
  # @!attribute [rw] value
@@ -196,6 +238,15 @@ module Google
196
238
  extend ::Google::Protobuf::MessageExts::ClassMethods
197
239
  end
198
240
 
241
+ # @!attribute [rw] key
242
+ # @return [::String]
243
+ # @!attribute [rw] value
244
+ # @return [::Google::Cloud::Dialogflow::V2::Conversation::GeneratorContext]
245
+ class InitialGeneratorContextsEntry
246
+ include ::Google::Protobuf::MessageExts
247
+ extend ::Google::Protobuf::MessageExts::ClassMethods
248
+ end
249
+
199
250
  # Enumeration of the completion status of the conversation.
200
251
  module LifecycleState
201
252
  # Unknown.
@@ -483,6 +534,10 @@ module Google
483
534
  # The summary content that is divided into sections. The key is the
484
535
  # section's name and the value is the section's content. There is no
485
536
  # specific format for the key or value.
537
+ # @!attribute [rw] sorted_text_sections
538
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryResponse::Summary::SummarySection>]
539
+ # Same as text_sections, but in an order that is consistent with the order
540
+ # of the sections in the generator.
486
541
  # @!attribute [rw] answer_record
487
542
  # @return [::String]
488
543
  # The name of the answer record. Format:
@@ -495,6 +550,18 @@ module Google
495
550
  include ::Google::Protobuf::MessageExts
496
551
  extend ::Google::Protobuf::MessageExts::ClassMethods
497
552
 
553
+ # A component of the generated summary.
554
+ # @!attribute [r] section
555
+ # @return [::String]
556
+ # Output only. Name of the section.
557
+ # @!attribute [r] summary
558
+ # @return [::String]
559
+ # Output only. Summary text for the section.
560
+ class SummarySection
561
+ include ::Google::Protobuf::MessageExts
562
+ extend ::Google::Protobuf::MessageExts::ClassMethods
563
+ end
564
+
498
565
  # @!attribute [rw] key
499
566
  # @return [::String]
500
567
  # @!attribute [rw] value
@@ -941,6 +1008,42 @@ module Google
941
1008
  end
942
1009
  end
943
1010
 
1011
+ # Debug information related to SearchKnowledge feature.
1012
+ # @!attribute [rw] datastore_response_reason
1013
+ # @return [::Google::Cloud::Dialogflow::V2::DatastoreResponseReason]
1014
+ # Response reason from datastore which indicates data serving status or
1015
+ # answer quality degradation.
1016
+ # @!attribute [rw] search_knowledge_behavior
1017
+ # @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeDebugInfo::SearchKnowledgeBehavior]
1018
+ # Configured behaviors for SearchKnowledge.
1019
+ # @!attribute [rw] ingested_context_reference_debug_info
1020
+ # @return [::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo]
1021
+ # Information about parameters ingested for search knowledge.
1022
+ # @!attribute [rw] service_latency
1023
+ # @return [::Google::Cloud::Dialogflow::V2::ServiceLatency]
1024
+ # The latency of the service.
1025
+ class SearchKnowledgeDebugInfo
1026
+ include ::Google::Protobuf::MessageExts
1027
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1028
+
1029
+ # Configured behaviors for SearchKnowledge.
1030
+ # @!attribute [rw] answer_generation_rewriter_on
1031
+ # @return [::Boolean]
1032
+ # Whether data store agent rewriter was turned on for the request.
1033
+ # @!attribute [rw] end_user_metadata_included
1034
+ # @return [::Boolean]
1035
+ # Whether end_user_metadata is included in the data store agent call.
1036
+ # @!attribute [rw] third_party_connector_allowed
1037
+ # @return [::Boolean]
1038
+ # This field indicates whether third party connectors are enabled for the
1039
+ # project. Note that this field only indicates if the project is
1040
+ # allowlisted for connectors.
1041
+ class SearchKnowledgeBehavior
1042
+ include ::Google::Protobuf::MessageExts
1043
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1044
+ end
1045
+ end
1046
+
944
1047
  # The response message for
945
1048
  # {::Google::Cloud::Dialogflow::V2::Conversations::Client#search_knowledge Conversations.SearchKnowledge}.
946
1049
  # @!attribute [rw] answers
@@ -950,6 +1053,9 @@ module Google
950
1053
  # @!attribute [rw] rewritten_query
951
1054
  # @return [::String]
952
1055
  # The rewritten query used to search knowledge.
1056
+ # @!attribute [rw] search_knowledge_debug_info
1057
+ # @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeDebugInfo]
1058
+ # Debug info for SearchKnowledge.
953
1059
  class SearchKnowledgeResponse
954
1060
  include ::Google::Protobuf::MessageExts
955
1061
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -617,6 +617,30 @@ module Google
617
617
  # {::Google::Cloud::Dialogflow::V2::ListMessagesResponse#messages ListMessagesResponse.messages.SentimentAnalysisResult}
618
618
  # If Pub/Sub notification is configured, result will be in
619
619
  # {::Google::Cloud::Dialogflow::V2::ConversationEvent#new_message_payload ConversationEvent.new_message_payload.SentimentAnalysisResult}.
620
+ # @!attribute [rw] enable_sentiment_analysis_v3
621
+ # @return [::Boolean]
622
+ # Optional. Enables sentiment analysis for audio input and conversation
623
+ # messages. If unspecified, defaults to false. If this flag is set to true,
624
+ # other 'enable_sentiment_analysis' fields will be ignored.
625
+ #
626
+ # Sentiment analysis inspects user input and identifies the prevailing
627
+ # subjective opinion, especially to determine a user's attitude as
628
+ # positive, negative, or neutral.
629
+ # https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
630
+ # For
631
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}
632
+ # method, result will be in
633
+ # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#message StreamingAnalyzeContentResponse.message.SentimentAnalysisResult}.
634
+ # For
635
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
636
+ # method, result will be in
637
+ # {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#message AnalyzeContentResponse.message.SentimentAnalysisResult}
638
+ # For
639
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}
640
+ # method, result will be in
641
+ # {::Google::Cloud::Dialogflow::V2::ListMessagesResponse#messages ListMessagesResponse.messages.SentimentAnalysisResult}
642
+ # If Pub/Sub notification is configured, result will be in
643
+ # {::Google::Cloud::Dialogflow::V2::ConversationEvent#new_message_payload ConversationEvent.new_message_payload.SentimentAnalysisResult}.
620
644
  class MessageAnalysisConfig
621
645
  include ::Google::Protobuf::MessageExts
622
646
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -391,6 +391,15 @@ module Google
391
391
  # @return [::Google::Cloud::Dialogflow::V2::SuggestionDedupingConfig]
392
392
  # Optional. Configuration for suggestion deduping. This is only applicable to
393
393
  # AI Coach feature.
394
+ # @!attribute [rw] toolset_tools
395
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::ToolsetTool>]
396
+ # Optional. List of CES toolset specs that the generator can choose from.
397
+ # @!attribute [rw] ces_tool_specs
398
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::CesToolSpec>]
399
+ # Optional. List of CES tool specs that the generator can choose from.
400
+ # @!attribute [rw] ces_app_specs
401
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::CesAppSpec>]
402
+ # Optional. List of CES app specs that the generator can choose from.
394
403
  class Generator
395
404
  include ::Google::Protobuf::MessageExts
396
405
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -522,6 +522,11 @@ module Google
522
522
  # is not enabled, response stream still contains only one final response even
523
523
  # if some `Fulfillment`s in Dialogflow CX agent have been configured to
524
524
  # return partial responses.
525
+ # @!attribute [rw] output_multiple_utterances
526
+ # @return [::Boolean]
527
+ # Optional. If multiple uttereances are detected in the audio stream, process
528
+ # them individually instead of stitching them together to form a single
529
+ # utterance.
525
530
  # @!attribute [rw] enable_debugging_info
526
531
  # @return [::Boolean]
527
532
  # If true, `StreamingAnalyzeContentResponse.debugging_info` will get
@@ -1237,6 +1242,235 @@ module Google
1237
1242
  extend ::Google::Protobuf::MessageExts::ClassMethods
1238
1243
  end
1239
1244
 
1245
+ # Debug information related to ingested context reference.
1246
+ # @!attribute [rw] project_not_allowlisted
1247
+ # @return [::Boolean]
1248
+ # Indicates if the project is allowlisted to use ingested context
1249
+ # reference.
1250
+ # @!attribute [rw] context_reference_retrieved
1251
+ # @return [::Boolean]
1252
+ # The status of context_reference retrieval from database.
1253
+ # @!attribute [rw] ingested_parameters_debug_info
1254
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo::IngestedParameterDebugInfo>]
1255
+ # Parameters ingested from the context reference.
1256
+ class IngestedContextReferenceDebugInfo
1257
+ include ::Google::Protobuf::MessageExts
1258
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1259
+
1260
+ # Debug information related to ingested parameters from context reference.
1261
+ # @!attribute [rw] parameter
1262
+ # @return [::String]
1263
+ # The name of the parameter in the context reference.
1264
+ # @!attribute [rw] ingestion_status
1265
+ # @return [::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo::IngestedParameterDebugInfo::IngestionStatus]
1266
+ # The ingestion status for this specific parameter.
1267
+ class IngestedParameterDebugInfo
1268
+ include ::Google::Protobuf::MessageExts
1269
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1270
+
1271
+ # Enum representing the various states of parameter ingestion.
1272
+ module IngestionStatus
1273
+ # Default value, indicates that the ingestion status is not specified.
1274
+ INGESTION_STATUS_UNSPECIFIED = 0
1275
+
1276
+ # Indicates that the parameter was successfully ingested.
1277
+ INGESTION_STATUS_SUCCEEDED = 1
1278
+
1279
+ # Indicates that the parameter was not available for ingestion.
1280
+ INGESTION_STATUS_CONTEXT_NOT_AVAILABLE = 2
1281
+
1282
+ # Indicates that there was a failure parsing the parameter content.
1283
+ INGESTION_STATUS_PARSE_FAILED = 3
1284
+
1285
+ # Indicates that the context reference had an unexpected number of
1286
+ # content entries as Context reference should only have one entry.
1287
+ INGESTION_STATUS_INVALID_ENTRY = 4
1288
+
1289
+ # Indicates that the context reference content was not in the expected
1290
+ # format (e.g., JSON).
1291
+ INGESTION_STATUS_INVALID_FORMAT = 5
1292
+
1293
+ # Indicates that the context reference language does not match the
1294
+ # conversation language.
1295
+ INGESTION_STATUS_LANGUAGE_MISMATCH = 6
1296
+ end
1297
+ end
1298
+ end
1299
+
1300
+ # Message to represent the latency of the service.
1301
+ # @!attribute [rw] internal_service_latencies
1302
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::ServiceLatency::InternalServiceLatency>]
1303
+ # A list of internal service latencies.
1304
+ class ServiceLatency
1305
+ include ::Google::Protobuf::MessageExts
1306
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1307
+
1308
+ # Message to represent the latency of an internal service.
1309
+ # @!attribute [rw] step
1310
+ # @return [::String]
1311
+ # The name of the internal service.
1312
+ # @!attribute [rw] latency_ms
1313
+ # @return [::Float]
1314
+ # The latency of the internal service in milliseconds.
1315
+ # @!attribute [rw] start_time
1316
+ # @return [::Google::Protobuf::Timestamp]
1317
+ # The start time of the internal service.
1318
+ # @!attribute [rw] complete_time
1319
+ # @return [::Google::Protobuf::Timestamp]
1320
+ # The completion time of the internal service.
1321
+ class InternalServiceLatency
1322
+ include ::Google::Protobuf::MessageExts
1323
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1324
+ end
1325
+ end
1326
+
1327
+ # Debug information related to Knowledge Assist feature.
1328
+ # @!attribute [rw] query_generation_failure_reason
1329
+ # @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryGenerationFailureReason]
1330
+ # Reason for query generation.
1331
+ # @!attribute [rw] query_categorization_failure_reason
1332
+ # @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryCategorizationFailureReason]
1333
+ # Reason for query categorization.
1334
+ # @!attribute [rw] datastore_response_reason
1335
+ # @return [::Google::Cloud::Dialogflow::V2::DatastoreResponseReason]
1336
+ # Response reason from datastore which indicates data serving status or
1337
+ # answer quality degradation.
1338
+ # @!attribute [rw] knowledge_assist_behavior
1339
+ # @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::KnowledgeAssistBehavior]
1340
+ # Configured behaviors for Knowedge Assist.
1341
+ # @!attribute [rw] ingested_context_reference_debug_info
1342
+ # @return [::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo]
1343
+ # Information about parameters ingested for search knowledge.
1344
+ # @!attribute [rw] service_latency
1345
+ # @return [::Google::Cloud::Dialogflow::V2::ServiceLatency]
1346
+ # The latency of the service.
1347
+ class KnowledgeAssistDebugInfo
1348
+ include ::Google::Protobuf::MessageExts
1349
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1350
+
1351
+ # Configured behaviors for Knowedge Assist.
1352
+ # @!attribute [rw] answer_generation_rewriter_on
1353
+ # @return [::Boolean]
1354
+ # Whether data store agent rewriter was turned off for the request.
1355
+ # @!attribute [rw] end_user_metadata_included
1356
+ # @return [::Boolean]
1357
+ # Whether end_user_metadata is included in the data store agent call.
1358
+ # @!attribute [rw] return_query_only
1359
+ # @return [::Boolean]
1360
+ # Whether customers configured to return query only in the
1361
+ # conversation profile.
1362
+ # @!attribute [rw] use_pubsub_delivery
1363
+ # @return [::Boolean]
1364
+ # Whether customers configured to use pubsub to deliver.
1365
+ # @!attribute [rw] disable_sync_delivery
1366
+ # @return [::Boolean]
1367
+ # Whether customers configured to disable the synchronous delivery of
1368
+ # Knowedge Assist response.
1369
+ # @!attribute [rw] previous_queries_included
1370
+ # @return [::Boolean]
1371
+ # Whether previously suggested queries are included in the query generation
1372
+ # process.
1373
+ # @!attribute [rw] use_translated_message
1374
+ # @return [::Boolean]
1375
+ # Translated message is included in query generation process.
1376
+ # @!attribute [rw] use_custom_safety_filter_level
1377
+ # @return [::Boolean]
1378
+ # Safety filter is adjusted by user.
1379
+ # @!attribute [rw] conversation_transcript_has_mixed_languages
1380
+ # @return [::Boolean]
1381
+ # Conversation transcript has mixed languages.
1382
+ # @!attribute [rw] query_generation_agent_language_mismatch
1383
+ # @return [::Boolean]
1384
+ # Whether the agent language from the translation generator mismatches the
1385
+ # end-user language.
1386
+ # @!attribute [rw] query_generation_end_user_language_mismatch
1387
+ # @return [::Boolean]
1388
+ # Whether the end-user language from the translation generator mismatches
1389
+ # the end-user language.
1390
+ # @!attribute [rw] third_party_connector_allowed
1391
+ # @return [::Boolean]
1392
+ # This field indicates whether third party connectors are enabled for the
1393
+ # project
1394
+ # @!attribute [rw] multiple_queries_generated
1395
+ # @return [::Boolean]
1396
+ # Indicates that the query generation model generated multiple queries.
1397
+ # @!attribute [rw] query_contained_search_context
1398
+ # @return [::Boolean]
1399
+ # Indicates that the generated query contains search context.
1400
+ # @!attribute [rw] invalid_items_query_suggestion_skipped
1401
+ # @return [::Boolean]
1402
+ # Indicates that invalid items were skipped when parsing the LLM response.
1403
+ # @!attribute [rw] primary_query_redacted_and_replaced
1404
+ # @return [::Boolean]
1405
+ # True if the primary suggested query was redacted and replaced by an
1406
+ # additional query.
1407
+ # @!attribute [rw] appended_search_context_count
1408
+ # @return [::Integer]
1409
+ # The number of search contexts appended to the query.
1410
+ class KnowledgeAssistBehavior
1411
+ include ::Google::Protobuf::MessageExts
1412
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1413
+ end
1414
+
1415
+ # Reason for query generation failure.
1416
+ module QueryGenerationFailureReason
1417
+ # Default value.
1418
+ QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED = 0
1419
+
1420
+ # Query generation is blocked due to out of quota.
1421
+ QUERY_GENERATION_OUT_OF_QUOTA = 1
1422
+
1423
+ # Call to Knowedge Assist query generation model fails.
1424
+ QUERY_GENERATION_FAILED = 2
1425
+
1426
+ # Query generation model decides that there is no new topic change or
1427
+ # there has been similar queries generated in the previous turns.
1428
+ QUERY_GENERATION_NO_QUERY_GENERATED = 3
1429
+
1430
+ # Knowedge Assist generated query is blocked by RAI (Responsible AI).
1431
+ QUERY_GENERATION_RAI_FAILED = 4
1432
+
1433
+ # Query generation is blocked by Knowledge Assist conversation profile
1434
+ # level / agent id level filtering.
1435
+ NOT_IN_ALLOWLIST = 5
1436
+
1437
+ # The generated query is blocked due to redaction.
1438
+ QUERY_GENERATION_QUERY_REDACTED = 6
1439
+
1440
+ # Query generation failed due to LLM response parse failure.
1441
+ QUERY_GENERATION_LLM_RESPONSE_PARSE_FAILED = 10
1442
+
1443
+ # The conversation has no messages.
1444
+ QUERY_GENERATION_EMPTY_CONVERSATION = 11
1445
+
1446
+ # The last message in the conversation is empty.
1447
+ QUERY_GENERATION_EMPTY_LAST_MESSAGE = 12
1448
+
1449
+ # The trigger event condition is not met.
1450
+ # This occurs in the following scenarios:
1451
+ # 1. The trigger_event is CUSTOMER_MESSAGE or UNSPECIFIED, but the last
1452
+ # message is not from the customer.
1453
+ # 2. The trigger_event is AGENT_MESSAGE, but the last message is not from
1454
+ # the agent.
1455
+ QUERY_GENERATION_TRIGGERING_EVENT_CONDITION_NOT_MET = 13
1456
+ end
1457
+
1458
+ # Reason for query categorization failure.
1459
+ module QueryCategorizationFailureReason
1460
+ # Default value.
1461
+ QUERY_CATEGORIZATION_FAILURE_REASON_UNSPECIFIED = 0
1462
+
1463
+ # Vertex AI Search config supplied for query categorization is invalid.
1464
+ QUERY_CATEGORIZATION_INVALID_CONFIG = 1
1465
+
1466
+ # Vertex AI Search result does not contain a query categorization result.
1467
+ QUERY_CATEGORIZATION_RESULT_NOT_FOUND = 2
1468
+
1469
+ # Vertex AI Search call fails.
1470
+ QUERY_CATEGORIZATION_FAILED = 3
1471
+ end
1472
+ end
1473
+
1240
1474
  # Represents a Knowledge Assist answer.
1241
1475
  # @!attribute [rw] suggested_query
1242
1476
  # @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::SuggestedQuery]
@@ -1251,6 +1485,9 @@ module Google
1251
1485
  # The name of the answer record.
1252
1486
  # Format: `projects/<Project ID>/locations/<location ID>/answer
1253
1487
  # Records/<Answer Record ID>`.
1488
+ # @!attribute [rw] knowledge_assist_debug_info
1489
+ # @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo]
1490
+ # Debug information related to Knowledge Assist feature.
1254
1491
  class KnowledgeAssistAnswer
1255
1492
  include ::Google::Protobuf::MessageExts
1256
1493
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1321,6 +1558,40 @@ module Google
1321
1558
  end
1322
1559
  end
1323
1560
  end
1561
+
1562
+ # Response reason from datastore which indicates data serving status or
1563
+ # answer quality degradation.
1564
+ module DatastoreResponseReason
1565
+ # Default value.
1566
+ DATASTORE_RESPONSE_REASON_UNSPECIFIED = 0
1567
+
1568
+ # No specific response reason from datastore.
1569
+ NONE = 1
1570
+
1571
+ # Search is blocked due to out of quota.
1572
+ SEARCH_OUT_OF_QUOTA = 2
1573
+
1574
+ # Search returns empty results.
1575
+ SEARCH_EMPTY_RESULTS = 3
1576
+
1577
+ # Generative AI is disabled.
1578
+ ANSWER_GENERATION_GEN_AI_DISABLED = 4
1579
+
1580
+ # Answer generation is blocked due to out of quota.
1581
+ ANSWER_GENERATION_OUT_OF_QUOTA = 5
1582
+
1583
+ # Answer generation encounters an error.
1584
+ ANSWER_GENERATION_ERROR = 6
1585
+
1586
+ # Answer generation does not have enough information to generate answer.
1587
+ ANSWER_GENERATION_NOT_ENOUGH_INFO = 7
1588
+
1589
+ # Answer generation is blocked by RAI (Responsible AI) failure.
1590
+ ANSWER_GENERATION_RAI_FAILED = 8
1591
+
1592
+ # Answer generation is not grounded on reliable sources.
1593
+ ANSWER_GENERATION_NOT_GROUNDED = 9
1594
+ end
1324
1595
  end
1325
1596
  end
1326
1597
  end
@@ -27,6 +27,29 @@ module Google
27
27
  # Optional. The {::Google::Cloud::Dialogflow::V2::Tool tool} associated with
28
28
  # this call. Format:
29
29
  # `projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>`.
30
+ #
31
+ # Note: The following fields are mutually exclusive: `tool`, `ces_tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared.
32
+ # @!attribute [rw] ces_tool
33
+ # @return [::String]
34
+ # Optional. CES tool name for this call.
35
+ # Format:
36
+ # `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/tools/<ToolID>`.
37
+ #
38
+ # Note: The following fields are mutually exclusive: `ces_tool`, `tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared.
39
+ # @!attribute [rw] ces_toolset
40
+ # @return [::String]
41
+ # Optional. CES toolset name for this call.
42
+ # Format:
43
+ # `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/toolsets/ToolsetID>`.
44
+ #
45
+ # Note: The following fields are mutually exclusive: `ces_toolset`, `tool`, `ces_tool`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared.
46
+ # @!attribute [rw] ces_app
47
+ # @return [::String]
48
+ # Optional. CES app name for this call.
49
+ # Format:
50
+ # `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>`.
51
+ #
52
+ # Note: The following fields are mutually exclusive: `ces_app`, `tool`, `ces_tool`, `ces_toolset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
30
53
  # @!attribute [rw] tool_display_name
31
54
  # @return [::String]
32
55
  # Optional. A human readable short name of the tool, to be shown on the UI.
@@ -71,6 +94,29 @@ module Google
71
94
  # Optional. The {::Google::Cloud::Dialogflow::V2::Tool tool} associated with
72
95
  # this call. Format:
73
96
  # `projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>`.
97
+ #
98
+ # Note: The following fields are mutually exclusive: `tool`, `ces_toolset`, `ces_tool`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared.
99
+ # @!attribute [rw] ces_toolset
100
+ # @return [::String]
101
+ # Optional. CES toolset name for this call.
102
+ # Format:
103
+ # `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/toolsets/ToolsetID>`.
104
+ #
105
+ # Note: The following fields are mutually exclusive: `ces_toolset`, `tool`, `ces_tool`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared.
106
+ # @!attribute [rw] ces_tool
107
+ # @return [::String]
108
+ # Optional. CES tool name for this call.
109
+ # Format:
110
+ # `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/tools/<ToolID>`.
111
+ #
112
+ # Note: The following fields are mutually exclusive: `ces_tool`, `tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared.
113
+ # @!attribute [rw] ces_app
114
+ # @return [::String]
115
+ # Optional. CES app name for this call.
116
+ # Format:
117
+ # `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>`.
118
+ #
119
+ # Note: The following fields are mutually exclusive: `ces_app`, `tool`, `ces_toolset`, `ces_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
74
120
  # @!attribute [rw] action
75
121
  # @return [::String]
76
122
  # Optional. The name of the tool's action associated with this call.
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Dialogflow
23
+ module V2
24
+ # A tool that is created from a toolset.
25
+ # @!attribute [rw] toolset
26
+ # @return [::String]
27
+ # Required. The name of the toolset to retrieve the schema for.
28
+ # Format:
29
+ # `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
30
+ # @!attribute [rw] operation_id
31
+ # @return [::String]
32
+ # Optional. The operationId field of the OpenAPI endpoint. The operationId
33
+ # must be present in the toolset's definition.
34
+ # @!attribute [rw] confirmation_requirement
35
+ # @return [::Google::Cloud::Dialogflow::V2::Tool::ConfirmationRequirement]
36
+ # Optional. Indicates whether the tool requires human confirmation.
37
+ class ToolsetTool
38
+ include ::Google::Protobuf::MessageExts
39
+ extend ::Google::Protobuf::MessageExts::ClassMethods
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
@@ -21,9 +21,9 @@ module Google
21
21
  module Type
22
22
  # An object that represents a latitude/longitude pair. This is expressed as a
23
23
  # pair of doubles to represent degrees latitude and degrees longitude. Unless
24
- # specified otherwise, this must conform to the
25
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
26
- # standard</a>. Values must be within normalized ranges.
24
+ # specified otherwise, this object must conform to the
25
+ # <a href="https://en.wikipedia.org/wiki/World_Geodetic_System#1984_version">
26
+ # WGS84 standard</a>. Values must be within normalized ranges.
27
27
  # @!attribute [rw] latitude
28
28
  # @return [::Float]
29
29
  # The latitude in degrees. It must be in the range [-90.0, +90.0].