google-cloud-dialogflow-v2 1.8.0 → 1.9.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.
@@ -297,6 +297,8 @@ module Google
297
297
  # @!attribute [rw] phrase_sets
298
298
  # @return [::Array<::String>]
299
299
  # List of names of Cloud Speech phrase sets that are used for transcription.
300
+ # For phrase set limitations, please refer to [Cloud Speech API quotas and
301
+ # limits](https://cloud.google.com/speech-to-text/quotas#content).
300
302
  # @!attribute [rw] audio_encoding
301
303
  # @return [::Google::Cloud::Dialogflow::V2::AudioEncoding]
302
304
  # Audio encoding of the audio content to process.
@@ -70,6 +70,9 @@ 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] ingested_context_references
74
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Conversation::ContextReference}]
75
+ # Output only. The context reference updates provided by external systems.
73
76
  class Conversation
74
77
  include ::Google::Protobuf::MessageExts
75
78
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -118,6 +121,74 @@ module Google
118
121
  end
119
122
  end
120
123
 
124
+ # Represents a section of ingested context information.
125
+ # @!attribute [rw] context_contents
126
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
127
+ # Required. The list of content updates for a context reference.
128
+ # @!attribute [rw] update_mode
129
+ # @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
130
+ # Required. The mode in which context reference contents are updated.
131
+ # @!attribute [rw] language_code
132
+ # @return [::String]
133
+ # Optional. The language of the information ingested, defaults to "en-US"
134
+ # if not set.
135
+ # @!attribute [r] create_time
136
+ # @return [::Google::Protobuf::Timestamp]
137
+ # Output only. The time the context reference was first created.
138
+ class ContextReference
139
+ include ::Google::Protobuf::MessageExts
140
+ extend ::Google::Protobuf::MessageExts::ClassMethods
141
+
142
+ # Contents ingested.
143
+ # @!attribute [rw] content
144
+ # @return [::String]
145
+ # Required. The information ingested in a single request.
146
+ # @!attribute [rw] content_format
147
+ # @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
148
+ # Required. The format of the ingested string.
149
+ # @!attribute [r] ingestion_time
150
+ # @return [::Google::Protobuf::Timestamp]
151
+ # Output only. The time when this information was incorporated into the
152
+ # relevant context reference.
153
+ class ContextContent
154
+ include ::Google::Protobuf::MessageExts
155
+ extend ::Google::Protobuf::MessageExts::ClassMethods
156
+
157
+ # Represents the format of the ingested string.
158
+ module ContentFormat
159
+ # Unspecified content format.
160
+ CONTENT_FORMAT_UNSPECIFIED = 0
161
+
162
+ # Content was provided in JSON format.
163
+ JSON = 1
164
+
165
+ # Content was provided as plain text.
166
+ PLAIN_TEXT = 2
167
+ end
168
+ end
169
+
170
+ # Represents the mode in which context reference contents are updated.
171
+ module UpdateMode
172
+ # Unspecified update mode.
173
+ UPDATE_MODE_UNSPECIFIED = 0
174
+
175
+ # Context content updates are applied in append mode.
176
+ APPEND = 1
177
+
178
+ # Context content updates are applied in overwrite mode.
179
+ OVERWRITE = 2
180
+ end
181
+ end
182
+
183
+ # @!attribute [rw] key
184
+ # @return [::String]
185
+ # @!attribute [rw] value
186
+ # @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
187
+ class IngestedContextReferencesEntry
188
+ include ::Google::Protobuf::MessageExts
189
+ extend ::Google::Protobuf::MessageExts::ClassMethods
190
+ end
191
+
121
192
  # Enumeration of the completion status of the conversation.
122
193
  module LifecycleState
123
194
  # Unknown.
@@ -299,6 +370,50 @@ module Google
299
370
  extend ::Google::Protobuf::MessageExts::ClassMethods
300
371
  end
301
372
 
373
+ # The request message for [ConversationsService.IngestContextReferences][].
374
+ # @!attribute [rw] conversation
375
+ # @return [::String]
376
+ # Required. Resource identifier of the conversation to ingest context
377
+ # information for. Format: `projects/<Project ID>/locations/<Location
378
+ # ID>/conversations/<Conversation ID>`.
379
+ # @!attribute [rw] context_references
380
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Conversation::ContextReference}]
381
+ # Required. The context references to ingest. The key is the name of the
382
+ # context reference and the value contains the contents of the context
383
+ # reference. The key is used to incorporate ingested context references to
384
+ # enhance the generator.
385
+ class IngestContextReferencesRequest
386
+ include ::Google::Protobuf::MessageExts
387
+ extend ::Google::Protobuf::MessageExts::ClassMethods
388
+
389
+ # @!attribute [rw] key
390
+ # @return [::String]
391
+ # @!attribute [rw] value
392
+ # @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
393
+ class ContextReferencesEntry
394
+ include ::Google::Protobuf::MessageExts
395
+ extend ::Google::Protobuf::MessageExts::ClassMethods
396
+ end
397
+ end
398
+
399
+ # The response message for [ConversationsService.IngestContextReferences][].
400
+ # @!attribute [rw] ingested_context_references
401
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Conversation::ContextReference}]
402
+ # All context references ingested.
403
+ class IngestContextReferencesResponse
404
+ include ::Google::Protobuf::MessageExts
405
+ extend ::Google::Protobuf::MessageExts::ClassMethods
406
+
407
+ # @!attribute [rw] key
408
+ # @return [::String]
409
+ # @!attribute [rw] value
410
+ # @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
411
+ class IngestedContextReferencesEntry
412
+ include ::Google::Protobuf::MessageExts
413
+ extend ::Google::Protobuf::MessageExts::ClassMethods
414
+ end
415
+ end
416
+
302
417
  # The request message for
303
418
  # {::Google::Cloud::Dialogflow::V2::Conversations::Client#suggest_conversation_summary Conversations.SuggestConversationSummary}.
304
419
  # @!attribute [rw] conversation
@@ -497,6 +612,12 @@ module Google
497
612
  # `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
498
613
  #
499
614
  # Note: The following fields are mutually exclusive: `generator_name`, `generator`. If a field in that set is populated, all other fields in the set will automatically be cleared.
615
+ # @!attribute [rw] context_references
616
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Conversation::ContextReference}]
617
+ # Optional. A section of ingested context information. The key is the name of
618
+ # the context reference and the value contains the contents of the context
619
+ # reference. The key is used to incorporate ingested context references to
620
+ # enhance the generator.
500
621
  # @!attribute [rw] conversation_context
501
622
  # @return [::Google::Cloud::Dialogflow::V2::ConversationContext]
502
623
  # Optional. Context of the conversation, including transcripts.
@@ -507,6 +628,15 @@ module Google
507
628
  class GenerateStatelessSuggestionRequest
508
629
  include ::Google::Protobuf::MessageExts
509
630
  extend ::Google::Protobuf::MessageExts::ClassMethods
631
+
632
+ # @!attribute [rw] key
633
+ # @return [::String]
634
+ # @!attribute [rw] value
635
+ # @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
636
+ class ContextReferencesEntry
637
+ include ::Google::Protobuf::MessageExts
638
+ extend ::Google::Protobuf::MessageExts::ClassMethods
639
+ end
510
640
  end
511
641
 
512
642
  # The response message for
@@ -861,6 +991,30 @@ module Google
861
991
  INTENT = 3
862
992
  end
863
993
  end
994
+
995
+ # The request message for
996
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#generate_suggestions Conversations.GenerateSuggestions}.
997
+ # @!attribute [rw] conversation
998
+ # @return [::String]
999
+ # Required. The conversation for which the suggestions are generated. Format:
1000
+ # `projects/<Project ID>/locations/<Location
1001
+ # ID>/conversations/<Conversation ID>`.
1002
+ #
1003
+ # The conversation must be created with a conversation profile which has
1004
+ # generators configured in it to be able to get suggestions.
1005
+ # @!attribute [rw] latest_message
1006
+ # @return [::String]
1007
+ # Optional. The name of the latest conversation message for which the request
1008
+ # is triggered. Format: `projects/<Project ID>/locations/<Location
1009
+ # ID>/conversations/<Conversation ID>/messages/<Message ID>`.
1010
+ # @!attribute [rw] trigger_events
1011
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::TriggerEvent>]
1012
+ # Optional. A list of trigger events. Only generators configured in the
1013
+ # conversation_profile whose trigger_event is listed here will be triggered.
1014
+ class GenerateSuggestionsRequest
1015
+ include ::Google::Protobuf::MessageExts
1016
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1017
+ end
864
1018
  end
865
1019
  end
866
1020
  end
@@ -278,6 +278,14 @@ module Google
278
278
 
279
279
  # Customer defined sections.
280
280
  CUSTOMER_DEFINED = 7
281
+
282
+ # Concise version of the situation section. This type is only available if
283
+ # type SITUATION is not selected.
284
+ SITUATION_CONCISE = 9
285
+
286
+ # Concise version of the action section. This type is only available if
287
+ # type ACTION is not selected.
288
+ ACTION_CONCISE = 10
281
289
  end
282
290
  end
283
291
 
@@ -303,6 +311,15 @@ module Google
303
311
  extend ::Google::Protobuf::MessageExts::ClassMethods
304
312
  end
305
313
 
314
+ # Free form generator context that customer can configure.
315
+ # @!attribute [rw] text
316
+ # @return [::String]
317
+ # Optional. Free form text input to LLM.
318
+ class FreeFormContext
319
+ include ::Google::Protobuf::MessageExts
320
+ extend ::Google::Protobuf::MessageExts::ClassMethods
321
+ end
322
+
306
323
  # LLM generator.
307
324
  # @!attribute [r] name
308
325
  # @return [::String]
@@ -311,9 +328,16 @@ module Google
311
328
  # @!attribute [rw] description
312
329
  # @return [::String]
313
330
  # Optional. Human readable description of the generator.
331
+ # @!attribute [rw] free_form_context
332
+ # @return [::Google::Cloud::Dialogflow::V2::FreeFormContext]
333
+ # Input of free from generator to LLM.
334
+ #
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.
314
336
  # @!attribute [rw] summarization_context
315
337
  # @return [::Google::Cloud::Dialogflow::V2::SummarizationContext]
316
338
  # Input of prebuilt Summarization feature.
339
+ #
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.
317
341
  # @!attribute [rw] inference_parameter
318
342
  # @return [::Google::Cloud::Dialogflow::V2::InferenceParameter]
319
343
  # Optional. Inference parameters for this generator.
@@ -321,6 +345,13 @@ module Google
321
345
  # @return [::Google::Cloud::Dialogflow::V2::TriggerEvent]
322
346
  # Optional. The trigger event of the generator. It defines when the generator
323
347
  # is triggered in a conversation.
348
+ # @!attribute [rw] published_model
349
+ # @return [::String]
350
+ # Optional. The published Large Language Model name.
351
+ # * To use the latest model version, specify the model name without version
352
+ # number. Example: `text-bison`
353
+ # * To use a stable model version, specify the version number as well.
354
+ # Example: `text-bison@002`.
324
355
  # @!attribute [r] create_time
325
356
  # @return [::Google::Protobuf::Timestamp]
326
357
  # Output only. Creation time of this generator.
@@ -332,6 +363,15 @@ module Google
332
363
  extend ::Google::Protobuf::MessageExts::ClassMethods
333
364
  end
334
365
 
366
+ # Suggestion generated using free form generator.
367
+ # @!attribute [rw] response
368
+ # @return [::String]
369
+ # Required. Free form suggestion.
370
+ class FreeFormSuggestion
371
+ include ::Google::Protobuf::MessageExts
372
+ extend ::Google::Protobuf::MessageExts::ClassMethods
373
+ end
374
+
335
375
  # Suggested summary of the conversation.
336
376
  # @!attribute [rw] summary_sections
337
377
  # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarySuggestion::SummarySection>]
@@ -354,9 +394,16 @@ module Google
354
394
  end
355
395
 
356
396
  # Suggestion generated using a Generator.
397
+ # @!attribute [rw] free_form_suggestion
398
+ # @return [::Google::Cloud::Dialogflow::V2::FreeFormSuggestion]
399
+ # Optional. Free form suggestion.
400
+ #
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.
357
402
  # @!attribute [rw] summary_suggestion
358
403
  # @return [::Google::Cloud::Dialogflow::V2::SummarySuggestion]
359
404
  # Optional. Suggested summary.
405
+ #
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.
360
407
  class GeneratorSuggestion
361
408
  include ::Google::Protobuf::MessageExts
362
409
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -374,6 +421,12 @@ module Google
374
421
  # Conversations.GenerateStatelessSuggestion and
375
422
  # Conversations.GenerateSuggestions.
376
423
  MANUAL_CALL = 2
424
+
425
+ # Triggers after each customer message only.
426
+ CUSTOMER_MESSAGE = 3
427
+
428
+ # Triggers after each agent message only.
429
+ AGENT_MESSAGE = 4
377
430
  end
378
431
  end
379
432
  end
@@ -681,6 +681,41 @@ module Google
681
681
  extend ::Google::Protobuf::MessageExts::ClassMethods
682
682
  end
683
683
 
684
+ # The response message for
685
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#generate_suggestions Conversations.GenerateSuggestions}.
686
+ # @!attribute [rw] generator_suggestion_answers
687
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::GenerateSuggestionsResponse::GeneratorSuggestionAnswer>]
688
+ # The answers generated for the conversation based on context.
689
+ # @!attribute [rw] latest_message
690
+ # @return [::String]
691
+ # The name of the latest conversation message used as context for
692
+ # compiling suggestion.
693
+ #
694
+ # Format: `projects/<Project ID>/locations/<Location
695
+ # ID>/conversations/<Conversation ID>/messages/<Message ID>`.
696
+ class GenerateSuggestionsResponse
697
+ include ::Google::Protobuf::MessageExts
698
+ extend ::Google::Protobuf::MessageExts::ClassMethods
699
+
700
+ # A GeneratorSuggestion answer.
701
+ # @!attribute [rw] generator_suggestion
702
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorSuggestion]
703
+ # Suggestion details.
704
+ # @!attribute [rw] source_generator
705
+ # @return [::String]
706
+ # The name of the generator used to generate this suggestion. Format:
707
+ # `projects/<Project ID>/locations/<Location ID>/generators/<Generator
708
+ # ID>`.
709
+ # @!attribute [rw] answer_record
710
+ # @return [::String]
711
+ # Answer record that uniquely identifies the suggestion. This can be used
712
+ # to provide suggestion feedback.
713
+ class GeneratorSuggestionAnswer
714
+ include ::Google::Protobuf::MessageExts
715
+ extend ::Google::Protobuf::MessageExts::ClassMethods
716
+ end
717
+ end
718
+
684
719
  # The request message for
685
720
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_smart_replies Participants.SuggestSmartReplies}.
686
721
  # @!attribute [rw] parent
@@ -953,27 +988,33 @@ module Google
953
988
  # @return [::Google::Rpc::Status]
954
989
  # Error status if the request failed.
955
990
  #
956
- # Note: The following fields are mutually exclusive: `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
991
+ # Note: The following fields are mutually exclusive: `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`, `generate_suggestions_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
957
992
  # @!attribute [rw] suggest_articles_response
958
993
  # @return [::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse]
959
994
  # SuggestArticlesResponse if request is for ARTICLE_SUGGESTION.
960
995
  #
961
- # Note: The following fields are mutually exclusive: `suggest_articles_response`, `error`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
996
+ # Note: The following fields are mutually exclusive: `suggest_articles_response`, `error`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`, `generate_suggestions_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
962
997
  # @!attribute [rw] suggest_knowledge_assist_response
963
998
  # @return [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse]
964
999
  # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST.
965
1000
  #
966
- # Note: The following fields are mutually exclusive: `suggest_knowledge_assist_response`, `error`, `suggest_articles_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1001
+ # Note: The following fields are mutually exclusive: `suggest_knowledge_assist_response`, `error`, `suggest_articles_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`, `generate_suggestions_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
967
1002
  # @!attribute [rw] suggest_faq_answers_response
968
1003
  # @return [::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse]
969
1004
  # SuggestFaqAnswersResponse if request is for FAQ_ANSWER.
970
1005
  #
971
- # Note: The following fields are mutually exclusive: `suggest_faq_answers_response`, `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1006
+ # Note: The following fields are mutually exclusive: `suggest_faq_answers_response`, `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_smart_replies_response`, `generate_suggestions_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
972
1007
  # @!attribute [rw] suggest_smart_replies_response
973
1008
  # @return [::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse]
974
1009
  # SuggestSmartRepliesResponse if request is for SMART_REPLY.
975
1010
  #
976
- # Note: The following fields are mutually exclusive: `suggest_smart_replies_response`, `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1011
+ # Note: The following fields are mutually exclusive: `suggest_smart_replies_response`, `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`, `generate_suggestions_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1012
+ # @!attribute [rw] generate_suggestions_response
1013
+ # @return [::Google::Cloud::Dialogflow::V2::GenerateSuggestionsResponse]
1014
+ # Suggestions generated using generators triggered by customer or agent
1015
+ # messages.
1016
+ #
1017
+ # Note: The following fields are mutually exclusive: `generate_suggestions_response`, `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
977
1018
  class SuggestionResult
978
1019
  include ::Google::Protobuf::MessageExts
979
1020
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dialogflow-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.0
4
+ version: 1.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-03-06 00:00:00.000000000 Z
10
+ date: 2025-03-12 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: gapic-common