google-apis-dialogflow_v2 0.25.0 → 0.29.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -476,7 +476,7 @@ module Google
476
476
  include Google::Apis::Core::Hashable
477
477
 
478
478
  # Whether to run test cases in TestCasesConfig.test_cases periodically. Default
479
- # false. If set to ture, run once a day.
479
+ # false. If set to true, run once a day.
480
480
  # Corresponds to the JSON property `enableContinuousRun`
481
481
  # @return [Boolean]
482
482
  attr_accessor :enable_continuous_run
@@ -1526,6 +1526,12 @@ module Google
1526
1526
  # @return [String]
1527
1527
  attr_accessor :current_page
1528
1528
 
1529
+ # Always present for WebhookRequest. Ignored for WebhookResponse. The display
1530
+ # name of the current page.
1531
+ # Corresponds to the JSON property `displayName`
1532
+ # @return [String]
1533
+ attr_accessor :display_name
1534
+
1529
1535
  # Represents form information.
1530
1536
  # Corresponds to the JSON property `formInfo`
1531
1537
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3PageInfoFormInfo]
@@ -1538,6 +1544,7 @@ module Google
1538
1544
  # Update properties of this object
1539
1545
  def update!(**args)
1540
1546
  @current_page = args[:current_page] if args.key?(:current_page)
1547
+ @display_name = args[:display_name] if args.key?(:display_name)
1541
1548
  @form_info = args[:form_info] if args.key?(:form_info)
1542
1549
  end
1543
1550
  end
@@ -1760,6 +1767,12 @@ module Google
1760
1767
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio]
1761
1768
  attr_accessor :play_audio
1762
1769
 
1770
+ # Represents the signal that telles the client to transfer the phone call
1771
+ # connected to the agent to a third-party endpoint.
1772
+ # Corresponds to the JSON property `telephonyTransferCall`
1773
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall]
1774
+ attr_accessor :telephony_transfer_call
1775
+
1763
1776
  # The text response message.
1764
1777
  # Corresponds to the JSON property `text`
1765
1778
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3ResponseMessageText]
@@ -1778,6 +1791,7 @@ module Google
1778
1791
  @output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text)
1779
1792
  @payload = args[:payload] if args.key?(:payload)
1780
1793
  @play_audio = args[:play_audio] if args.key?(:play_audio)
1794
+ @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call)
1781
1795
  @text = args[:text] if args.key?(:text)
1782
1796
  end
1783
1797
  end
@@ -1970,6 +1984,27 @@ module Google
1970
1984
  end
1971
1985
  end
1972
1986
 
1987
+ # Represents the signal that telles the client to transfer the phone call
1988
+ # connected to the agent to a third-party endpoint.
1989
+ class GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall
1990
+ include Google::Apis::Core::Hashable
1991
+
1992
+ # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/
1993
+ # wiki/E.164).
1994
+ # Corresponds to the JSON property `phoneNumber`
1995
+ # @return [String]
1996
+ attr_accessor :phone_number
1997
+
1998
+ def initialize(**args)
1999
+ update!(**args)
2000
+ end
2001
+
2002
+ # Update properties of this object
2003
+ def update!(**args)
2004
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
2005
+ end
2006
+ end
2007
+
1973
2008
  # The text response message.
1974
2009
  class GoogleCloudDialogflowCxV3ResponseMessageText
1975
2010
  include Google::Apis::Core::Hashable
@@ -4233,6 +4268,12 @@ module Google
4233
4268
  # @return [String]
4234
4269
  attr_accessor :current_page
4235
4270
 
4271
+ # Always present for WebhookRequest. Ignored for WebhookResponse. The display
4272
+ # name of the current page.
4273
+ # Corresponds to the JSON property `displayName`
4274
+ # @return [String]
4275
+ attr_accessor :display_name
4276
+
4236
4277
  # Represents form information.
4237
4278
  # Corresponds to the JSON property `formInfo`
4238
4279
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo]
@@ -4245,6 +4286,7 @@ module Google
4245
4286
  # Update properties of this object
4246
4287
  def update!(**args)
4247
4288
  @current_page = args[:current_page] if args.key?(:current_page)
4289
+ @display_name = args[:display_name] if args.key?(:display_name)
4248
4290
  @form_info = args[:form_info] if args.key?(:form_info)
4249
4291
  end
4250
4292
  end
@@ -4467,6 +4509,12 @@ module Google
4467
4509
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio]
4468
4510
  attr_accessor :play_audio
4469
4511
 
4512
+ # Represents the signal that telles the client to transfer the phone call
4513
+ # connected to the agent to a third-party endpoint.
4514
+ # Corresponds to the JSON property `telephonyTransferCall`
4515
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall]
4516
+ attr_accessor :telephony_transfer_call
4517
+
4470
4518
  # The text response message.
4471
4519
  # Corresponds to the JSON property `text`
4472
4520
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
@@ -4485,6 +4533,7 @@ module Google
4485
4533
  @output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text)
4486
4534
  @payload = args[:payload] if args.key?(:payload)
4487
4535
  @play_audio = args[:play_audio] if args.key?(:play_audio)
4536
+ @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call)
4488
4537
  @text = args[:text] if args.key?(:text)
4489
4538
  end
4490
4539
  end
@@ -4677,6 +4726,27 @@ module Google
4677
4726
  end
4678
4727
  end
4679
4728
 
4729
+ # Represents the signal that telles the client to transfer the phone call
4730
+ # connected to the agent to a third-party endpoint.
4731
+ class GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall
4732
+ include Google::Apis::Core::Hashable
4733
+
4734
+ # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/
4735
+ # wiki/E.164).
4736
+ # Corresponds to the JSON property `phoneNumber`
4737
+ # @return [String]
4738
+ attr_accessor :phone_number
4739
+
4740
+ def initialize(**args)
4741
+ update!(**args)
4742
+ end
4743
+
4744
+ # Update properties of this object
4745
+ def update!(**args)
4746
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
4747
+ end
4748
+ end
4749
+
4680
4750
  # The text response message.
4681
4751
  class GoogleCloudDialogflowCxV3beta1ResponseMessageText
4682
4752
  include Google::Apis::Core::Hashable
@@ -5614,6 +5684,11 @@ module Google
5614
5684
  class GoogleCloudDialogflowV2AnalyzeContentRequest
5615
5685
  include Google::Apis::Core::Hashable
5616
5686
 
5687
+ # Represents the parameters of human assist query.
5688
+ # Corresponds to the JSON property `assistQueryParams`
5689
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AssistQueryParameters]
5690
+ attr_accessor :assist_query_params
5691
+
5617
5692
  # Events allow for matching intents by event name instead of the natural
5618
5693
  # language input. For instance, input `` can trigger a personalized welcome
5619
5694
  # response. The parameter `name` may be used by the agent in the response: `"
@@ -5652,6 +5727,7 @@ module Google
5652
5727
 
5653
5728
  # Update properties of this object
5654
5729
  def update!(**args)
5730
+ @assist_query_params = args[:assist_query_params] if args.key?(:assist_query_params)
5655
5731
  @event_input = args[:event_input] if args.key?(:event_input)
5656
5732
  @query_params = args[:query_params] if args.key?(:query_params)
5657
5733
  @reply_audio_config = args[:reply_audio_config] if args.key?(:reply_audio_config)
@@ -5909,6 +5985,31 @@ module Google
5909
5985
  end
5910
5986
  end
5911
5987
 
5988
+ # Represents the parameters of human assist query.
5989
+ class GoogleCloudDialogflowV2AssistQueryParameters
5990
+ include Google::Apis::Core::Hashable
5991
+
5992
+ # Key-value filters on the metadata of documents returned by article suggestion.
5993
+ # If specified, article suggestion only returns suggested documents that match
5994
+ # all filters in their Document.metadata. Multiple values for a metadata key
5995
+ # should be concatenated by comma. For example, filters to match all documents
5996
+ # that have 'US' or 'CA' in their market metadata values and 'agent' in their
5997
+ # user metadata values will be ``` documents_metadata_filters ` key: "market"
5998
+ # value: "US,CA" ` documents_metadata_filters ` key: "user" value: "agent" ` ```
5999
+ # Corresponds to the JSON property `documentsMetadataFilters`
6000
+ # @return [Hash<String,String>]
6001
+ attr_accessor :documents_metadata_filters
6002
+
6003
+ def initialize(**args)
6004
+ update!(**args)
6005
+ end
6006
+
6007
+ # Update properties of this object
6008
+ def update!(**args)
6009
+ @documents_metadata_filters = args[:documents_metadata_filters] if args.key?(:documents_metadata_filters)
6010
+ end
6011
+ end
6012
+
5912
6013
  # Defines the Automated Agent to connect to a conversation.
5913
6014
  class GoogleCloudDialogflowV2AutomatedAgentConfig
5914
6015
  include Google::Apis::Core::Hashable
@@ -7146,6 +7247,40 @@ module Google
7146
7247
  end
7147
7248
  end
7148
7249
 
7250
+ # Request message for Documents.ExportDocument.
7251
+ class GoogleCloudDialogflowV2ExportDocumentRequest
7252
+ include Google::Apis::Core::Hashable
7253
+
7254
+ # When enabled, export the full content of the document including empirical
7255
+ # probability.
7256
+ # Corresponds to the JSON property `exportFullContent`
7257
+ # @return [Boolean]
7258
+ attr_accessor :export_full_content
7259
+ alias_method :export_full_content?, :export_full_content
7260
+
7261
+ # Google Cloud Storage location for the output.
7262
+ # Corresponds to the JSON property `gcsDestination`
7263
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GcsDestination]
7264
+ attr_accessor :gcs_destination
7265
+
7266
+ # When enabled, export the smart messaging allowlist document for partial update.
7267
+ # Corresponds to the JSON property `smartMessagingPartialUpdate`
7268
+ # @return [Boolean]
7269
+ attr_accessor :smart_messaging_partial_update
7270
+ alias_method :smart_messaging_partial_update?, :smart_messaging_partial_update
7271
+
7272
+ def initialize(**args)
7273
+ update!(**args)
7274
+ end
7275
+
7276
+ # Update properties of this object
7277
+ def update!(**args)
7278
+ @export_full_content = args[:export_full_content] if args.key?(:export_full_content)
7279
+ @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
7280
+ @smart_messaging_partial_update = args[:smart_messaging_partial_update] if args.key?(:smart_messaging_partial_update)
7281
+ end
7282
+ end
7283
+
7149
7284
  # Represents answer from "frequently asked questions".
7150
7285
  class GoogleCloudDialogflowV2FaqAnswer
7151
7286
  include Google::Apis::Core::Hashable
@@ -7329,6 +7464,48 @@ module Google
7329
7464
  end
7330
7465
  end
7331
7466
 
7467
+ # Google Cloud Storage location for the output.
7468
+ class GoogleCloudDialogflowV2GcsDestination
7469
+ include Google::Apis::Core::Hashable
7470
+
7471
+ # The Google Cloud Storage URIs for the output. A URI is of the form: gs://
7472
+ # bucket/object-prefix-or-name Whether a prefix or name is used depends on the
7473
+ # use case. The requesting user must have "write-permission" to the bucket.
7474
+ # Corresponds to the JSON property `uri`
7475
+ # @return [String]
7476
+ attr_accessor :uri
7477
+
7478
+ def initialize(**args)
7479
+ update!(**args)
7480
+ end
7481
+
7482
+ # Update properties of this object
7483
+ def update!(**args)
7484
+ @uri = args[:uri] if args.key?(:uri)
7485
+ end
7486
+ end
7487
+
7488
+ # Google Cloud Storage location for the inputs.
7489
+ class GoogleCloudDialogflowV2GcsSources
7490
+ include Google::Apis::Core::Hashable
7491
+
7492
+ # Required. Google Cloud Storage URIs for the inputs. A URI is of the form: gs://
7493
+ # bucket/object-prefix-or-name Whether a prefix or name is used depends on the
7494
+ # use case.
7495
+ # Corresponds to the JSON property `uris`
7496
+ # @return [Array<String>]
7497
+ attr_accessor :uris
7498
+
7499
+ def initialize(**args)
7500
+ update!(**args)
7501
+ end
7502
+
7503
+ # Update properties of this object
7504
+ def update!(**args)
7505
+ @uris = args[:uris] if args.key?(:uris)
7506
+ end
7507
+ end
7508
+
7332
7509
  # Defines the Human Agent Assist to connect to a conversation.
7333
7510
  class GoogleCloudDialogflowV2HumanAgentAssistantConfig
7334
7511
  include Google::Apis::Core::Hashable
@@ -7386,6 +7563,26 @@ module Google
7386
7563
  end
7387
7564
  end
7388
7565
 
7566
+ # Config to process conversation.
7567
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig
7568
+ include Google::Apis::Core::Hashable
7569
+
7570
+ # Number of recent non-small-talk sentences to use as context for article and
7571
+ # FAQ suggestion
7572
+ # Corresponds to the JSON property `recentSentencesCount`
7573
+ # @return [Fixnum]
7574
+ attr_accessor :recent_sentences_count
7575
+
7576
+ def initialize(**args)
7577
+ update!(**args)
7578
+ end
7579
+
7580
+ # Update properties of this object
7581
+ def update!(**args)
7582
+ @recent_sentences_count = args[:recent_sentences_count] if args.key?(:recent_sentences_count)
7583
+ end
7584
+ end
7585
+
7389
7586
  # Configuration for analyses to run on each conversation message.
7390
7587
  class GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig
7391
7588
  include Google::Apis::Core::Hashable
@@ -7472,6 +7669,11 @@ module Google
7472
7669
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig]
7473
7670
  attr_accessor :conversation_model_config
7474
7671
 
7672
+ # Config to process conversation.
7673
+ # Corresponds to the JSON property `conversationProcessConfig`
7674
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig]
7675
+ attr_accessor :conversation_process_config
7676
+
7475
7677
  # Automatically iterates all participants and tries to compile suggestions.
7476
7678
  # Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST.
7477
7679
  # Corresponds to the JSON property `enableEventBasedSuggestion`
@@ -7503,6 +7705,7 @@ module Google
7503
7705
  # Update properties of this object
7504
7706
  def update!(**args)
7505
7707
  @conversation_model_config = args[:conversation_model_config] if args.key?(:conversation_model_config)
7708
+ @conversation_process_config = args[:conversation_process_config] if args.key?(:conversation_process_config)
7506
7709
  @enable_event_based_suggestion = args[:enable_event_based_suggestion] if args.key?(:enable_event_based_suggestion)
7507
7710
  @query_config = args[:query_config] if args.key?(:query_config)
7508
7711
  @suggestion_feature = args[:suggestion_feature] if args.key?(:suggestion_feature)
@@ -7843,6 +8046,92 @@ module Google
7843
8046
  end
7844
8047
  end
7845
8048
 
8049
+ # The template used for importing documents.
8050
+ class GoogleCloudDialogflowV2ImportDocumentTemplate
8051
+ include Google::Apis::Core::Hashable
8052
+
8053
+ # Required. The knowledge type of document content.
8054
+ # Corresponds to the JSON property `knowledgeTypes`
8055
+ # @return [Array<String>]
8056
+ attr_accessor :knowledge_types
8057
+
8058
+ # Metadata for the document. The metadata supports arbitrary key-value pairs.
8059
+ # Suggested use cases include storing a document's title, an external URL
8060
+ # distinct from the document's content_uri, etc. The max size of a `key` or a `
8061
+ # value` of the metadata is 1024 bytes.
8062
+ # Corresponds to the JSON property `metadata`
8063
+ # @return [Hash<String,String>]
8064
+ attr_accessor :metadata
8065
+
8066
+ # Required. The MIME type of the document.
8067
+ # Corresponds to the JSON property `mimeType`
8068
+ # @return [String]
8069
+ attr_accessor :mime_type
8070
+
8071
+ def initialize(**args)
8072
+ update!(**args)
8073
+ end
8074
+
8075
+ # Update properties of this object
8076
+ def update!(**args)
8077
+ @knowledge_types = args[:knowledge_types] if args.key?(:knowledge_types)
8078
+ @metadata = args[:metadata] if args.key?(:metadata)
8079
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
8080
+ end
8081
+ end
8082
+
8083
+ # Request message for Documents.ImportDocuments.
8084
+ class GoogleCloudDialogflowV2ImportDocumentsRequest
8085
+ include Google::Apis::Core::Hashable
8086
+
8087
+ # The template used for importing documents.
8088
+ # Corresponds to the JSON property `documentTemplate`
8089
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentTemplate]
8090
+ attr_accessor :document_template
8091
+
8092
+ # Google Cloud Storage location for the inputs.
8093
+ # Corresponds to the JSON property `gcsSource`
8094
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GcsSources]
8095
+ attr_accessor :gcs_source
8096
+
8097
+ # Whether to import custom metadata from Google Cloud Storage. Only valid when
8098
+ # the document source is Google Cloud Storage URI.
8099
+ # Corresponds to the JSON property `importGcsCustomMetadata`
8100
+ # @return [Boolean]
8101
+ attr_accessor :import_gcs_custom_metadata
8102
+ alias_method :import_gcs_custom_metadata?, :import_gcs_custom_metadata
8103
+
8104
+ def initialize(**args)
8105
+ update!(**args)
8106
+ end
8107
+
8108
+ # Update properties of this object
8109
+ def update!(**args)
8110
+ @document_template = args[:document_template] if args.key?(:document_template)
8111
+ @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
8112
+ @import_gcs_custom_metadata = args[:import_gcs_custom_metadata] if args.key?(:import_gcs_custom_metadata)
8113
+ end
8114
+ end
8115
+
8116
+ # Response message for Documents.ImportDocuments.
8117
+ class GoogleCloudDialogflowV2ImportDocumentsResponse
8118
+ include Google::Apis::Core::Hashable
8119
+
8120
+ # Includes details about skipped documents or any other warnings.
8121
+ # Corresponds to the JSON property `warnings`
8122
+ # @return [Array<Google::Apis::DialogflowV2::GoogleRpcStatus>]
8123
+ attr_accessor :warnings
8124
+
8125
+ def initialize(**args)
8126
+ update!(**args)
8127
+ end
8128
+
8129
+ # Update properties of this object
8130
+ def update!(**args)
8131
+ @warnings = args[:warnings] if args.key?(:warnings)
8132
+ end
8133
+ end
8134
+
7846
8135
  # Instructs the speech recognizer how to process the audio content.
7847
8136
  class GoogleCloudDialogflowV2InputAudioConfig
7848
8137
  include Google::Apis::Core::Hashable
@@ -9266,6 +9555,11 @@ module Google
9266
9555
  class GoogleCloudDialogflowV2KnowledgeOperationMetadata
9267
9556
  include Google::Apis::Core::Hashable
9268
9557
 
9558
+ # The name of the knowledge base interacted with during the operation.
9559
+ # Corresponds to the JSON property `knowledgeBase`
9560
+ # @return [String]
9561
+ attr_accessor :knowledge_base
9562
+
9269
9563
  # Output only. The current state of this operation.
9270
9564
  # Corresponds to the JSON property `state`
9271
9565
  # @return [String]
@@ -9277,6 +9571,7 @@ module Google
9277
9571
 
9278
9572
  # Update properties of this object
9279
9573
  def update!(**args)
9574
+ @knowledge_base = args[:knowledge_base] if args.key?(:knowledge_base)
9280
9575
  @state = args[:state] if args.key?(:state)
9281
9576
  end
9282
9577
  end
@@ -9662,7 +9957,7 @@ module Google
9662
9957
  # @return [String]
9663
9958
  attr_accessor :content
9664
9959
 
9665
- # Output only. The time when the message was created.
9960
+ # Output only. The time when the message was created in Contact Center AI.
9666
9961
  # Corresponds to the JSON property `createTime`
9667
9962
  # @return [String]
9668
9963
  attr_accessor :create_time
@@ -9678,7 +9973,7 @@ module Google
9678
9973
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2MessageAnnotation]
9679
9974
  attr_accessor :message_annotation
9680
9975
 
9681
- # The unique identifier of the message. Format: `projects//locations//
9976
+ # Optional. The unique identifier of the message. Format: `projects//locations//
9682
9977
  # conversations//messages/`.
9683
9978
  # Corresponds to the JSON property `name`
9684
9979
  # @return [String]
@@ -9694,6 +9989,23 @@ module Google
9694
9989
  # @return [String]
9695
9990
  attr_accessor :participant_role
9696
9991
 
9992
+ # Optional. The time when the message was sent.
9993
+ # Corresponds to the JSON property `sendTime`
9994
+ # @return [String]
9995
+ attr_accessor :send_time
9996
+
9997
+ # The result of sentiment analysis. Sentiment analysis inspects user input and
9998
+ # identifies the prevailing subjective opinion, especially to determine a user's
9999
+ # attitude as positive, negative, or neutral. For Participants.DetectIntent, it
10000
+ # needs to be configured in DetectIntentRequest.query_params. For Participants.
10001
+ # StreamingDetectIntent, it needs to be configured in
10002
+ # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent
10003
+ # and Participants.StreamingAnalyzeContent, it needs to be configured in
10004
+ # ConversationProfile.human_agent_assistant_config
10005
+ # Corresponds to the JSON property `sentimentAnalysis`
10006
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisResult]
10007
+ attr_accessor :sentiment_analysis
10008
+
9697
10009
  def initialize(**args)
9698
10010
  update!(**args)
9699
10011
  end
@@ -9707,6 +10019,8 @@ module Google
9707
10019
  @name = args[:name] if args.key?(:name)
9708
10020
  @participant = args[:participant] if args.key?(:participant)
9709
10021
  @participant_role = args[:participant_role] if args.key?(:participant_role)
10022
+ @send_time = args[:send_time] if args.key?(:send_time)
10023
+ @sentiment_analysis = args[:sentiment_analysis] if args.key?(:sentiment_analysis)
9710
10024
  end
9711
10025
  end
9712
10026
 
@@ -9877,6 +10191,18 @@ module Google
9877
10191
  class GoogleCloudDialogflowV2Participant
9878
10192
  include Google::Apis::Core::Hashable
9879
10193
 
10194
+ # Optional. Key-value filters on the metadata of documents returned by article
10195
+ # suggestion. If specified, article suggestion only returns suggested documents
10196
+ # that match all filters in their Document.metadata. Multiple values for a
10197
+ # metadata key should be concatenated by comma. For example, filters to match
10198
+ # all documents that have 'US' or 'CA' in their market metadata values and '
10199
+ # agent' in their user metadata values will be ``` documents_metadata_filters `
10200
+ # key: "market" value: "US,CA" ` documents_metadata_filters ` key: "user" value:
10201
+ # "agent" ` ```
10202
+ # Corresponds to the JSON property `documentsMetadataFilters`
10203
+ # @return [Hash<String,String>]
10204
+ attr_accessor :documents_metadata_filters
10205
+
9880
10206
  # Optional. The unique identifier of this participant. Format: `projects//
9881
10207
  # locations//conversations//participants/`.
9882
10208
  # Corresponds to the JSON property `name`
@@ -9902,6 +10228,7 @@ module Google
9902
10228
 
9903
10229
  # Update properties of this object
9904
10230
  def update!(**args)
10231
+ @documents_metadata_filters = args[:documents_metadata_filters] if args.key?(:documents_metadata_filters)
9905
10232
  @name = args[:name] if args.key?(:name)
9906
10233
  @role = args[:role] if args.key?(:role)
9907
10234
  @sip_recording_media_label = args[:sip_recording_media_label] if args.key?(:sip_recording_media_label)
@@ -10198,6 +10525,20 @@ module Google
10198
10525
  # @return [String]
10199
10526
  attr_accessor :content_uri
10200
10527
 
10528
+ # Optional. Whether to import custom metadata from Google Cloud Storage. Only
10529
+ # valid when the document source is Google Cloud Storage URI.
10530
+ # Corresponds to the JSON property `importGcsCustomMetadata`
10531
+ # @return [Boolean]
10532
+ attr_accessor :import_gcs_custom_metadata
10533
+ alias_method :import_gcs_custom_metadata?, :import_gcs_custom_metadata
10534
+
10535
+ # Optional. When enabled, the reload request is to apply partial update to the
10536
+ # smart messaging allowlist.
10537
+ # Corresponds to the JSON property `smartMessagingPartialUpdate`
10538
+ # @return [Boolean]
10539
+ attr_accessor :smart_messaging_partial_update
10540
+ alias_method :smart_messaging_partial_update?, :smart_messaging_partial_update
10541
+
10201
10542
  def initialize(**args)
10202
10543
  update!(**args)
10203
10544
  end
@@ -10205,6 +10546,8 @@ module Google
10205
10546
  # Update properties of this object
10206
10547
  def update!(**args)
10207
10548
  @content_uri = args[:content_uri] if args.key?(:content_uri)
10549
+ @import_gcs_custom_metadata = args[:import_gcs_custom_metadata] if args.key?(:import_gcs_custom_metadata)
10550
+ @smart_messaging_partial_update = args[:smart_messaging_partial_update] if args.key?(:smart_messaging_partial_update)
10208
10551
  end
10209
10552
  end
10210
10553
 
@@ -10380,6 +10723,40 @@ module Google
10380
10723
  end
10381
10724
  end
10382
10725
 
10726
+ # Represents a smart reply answer.
10727
+ class GoogleCloudDialogflowV2SmartReplyAnswer
10728
+ include Google::Apis::Core::Hashable
10729
+
10730
+ # The name of answer record, in the format of "projects//locations//
10731
+ # answerRecords/"
10732
+ # Corresponds to the JSON property `answerRecord`
10733
+ # @return [String]
10734
+ attr_accessor :answer_record
10735
+
10736
+ # Smart reply confidence. The system's confidence score that this reply is a
10737
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
10738
+ # to 1.0 (completely certain).
10739
+ # Corresponds to the JSON property `confidence`
10740
+ # @return [Float]
10741
+ attr_accessor :confidence
10742
+
10743
+ # The content of the reply.
10744
+ # Corresponds to the JSON property `reply`
10745
+ # @return [String]
10746
+ attr_accessor :reply
10747
+
10748
+ def initialize(**args)
10749
+ update!(**args)
10750
+ end
10751
+
10752
+ # Update properties of this object
10753
+ def update!(**args)
10754
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10755
+ @confidence = args[:confidence] if args.key?(:confidence)
10756
+ @reply = args[:reply] if args.key?(:reply)
10757
+ end
10758
+ end
10759
+
10383
10760
  # Hints for the speech recognizer to help with recognition in a specific
10384
10761
  # conversation state.
10385
10762
  class GoogleCloudDialogflowV2SpeechContext
@@ -10420,10 +10797,11 @@ module Google
10420
10797
  class GoogleCloudDialogflowV2SpeechToTextConfig
10421
10798
  include Google::Apis::Core::Hashable
10422
10799
 
10423
- # Optional. The speech model used in speech to text. `
10424
- # SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `
10425
- # USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and
10426
- # StreamingAnalyzeContentRequest request.
10800
+ # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `
10801
+ # USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in
10802
+ # AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced
10803
+ # model variant is specified and an enhanced version of the specified model for
10804
+ # the language does not exist, then it would emit an error.
10427
10805
  # Corresponds to the JSON property `speechModelVariant`
10428
10806
  # @return [String]
10429
10807
  attr_accessor :speech_model_variant
@@ -10442,15 +10820,20 @@ module Google
10442
10820
  class GoogleCloudDialogflowV2SuggestArticlesRequest
10443
10821
  include Google::Apis::Core::Hashable
10444
10822
 
10445
- # Max number of messages prior to and including latest_message to use as context
10446
- # when compiling the suggestion. By default 20 and at most 50.
10823
+ # Represents the parameters of human assist query.
10824
+ # Corresponds to the JSON property `assistQueryParams`
10825
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AssistQueryParameters]
10826
+ attr_accessor :assist_query_params
10827
+
10828
+ # Optional. Max number of messages prior to and including latest_message to use
10829
+ # as context when compiling the suggestion. By default 20 and at most 50.
10447
10830
  # Corresponds to the JSON property `contextSize`
10448
10831
  # @return [Fixnum]
10449
10832
  attr_accessor :context_size
10450
10833
 
10451
- # The name of the latest conversation message to compile suggestion for. If
10452
- # empty, it will be the latest message of the conversation. Format: `projects//
10453
- # locations//conversations//messages/`.
10834
+ # Optional. The name of the latest conversation message to compile suggestion
10835
+ # for. If empty, it will be the latest message of the conversation. Format: `
10836
+ # projects//locations//conversations//messages/`.
10454
10837
  # Corresponds to the JSON property `latestMessage`
10455
10838
  # @return [String]
10456
10839
  attr_accessor :latest_message
@@ -10461,6 +10844,7 @@ module Google
10461
10844
 
10462
10845
  # Update properties of this object
10463
10846
  def update!(**args)
10847
+ @assist_query_params = args[:assist_query_params] if args.key?(:assist_query_params)
10464
10848
  @context_size = args[:context_size] if args.key?(:context_size)
10465
10849
  @latest_message = args[:latest_message] if args.key?(:latest_message)
10466
10850
  end
@@ -10504,15 +10888,20 @@ module Google
10504
10888
  class GoogleCloudDialogflowV2SuggestFaqAnswersRequest
10505
10889
  include Google::Apis::Core::Hashable
10506
10890
 
10507
- # Max number of messages prior to and including [latest_message] to use as
10508
- # context when compiling the suggestion. By default 20 and at most 50.
10891
+ # Represents the parameters of human assist query.
10892
+ # Corresponds to the JSON property `assistQueryParams`
10893
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AssistQueryParameters]
10894
+ attr_accessor :assist_query_params
10895
+
10896
+ # Optional. Max number of messages prior to and including [latest_message] to
10897
+ # use as context when compiling the suggestion. By default 20 and at most 50.
10509
10898
  # Corresponds to the JSON property `contextSize`
10510
10899
  # @return [Fixnum]
10511
10900
  attr_accessor :context_size
10512
10901
 
10513
- # The name of the latest conversation message to compile suggestion for. If
10514
- # empty, it will be the latest message of the conversation. Format: `projects//
10515
- # locations//conversations//messages/`.
10902
+ # Optional. The name of the latest conversation message to compile suggestion
10903
+ # for. If empty, it will be the latest message of the conversation. Format: `
10904
+ # projects//locations//conversations//messages/`.
10516
10905
  # Corresponds to the JSON property `latestMessage`
10517
10906
  # @return [String]
10518
10907
  attr_accessor :latest_message
@@ -10523,6 +10912,7 @@ module Google
10523
10912
 
10524
10913
  # Update properties of this object
10525
10914
  def update!(**args)
10915
+ @assist_query_params = args[:assist_query_params] if args.key?(:assist_query_params)
10526
10916
  @context_size = args[:context_size] if args.key?(:context_size)
10527
10917
  @latest_message = args[:latest_message] if args.key?(:latest_message)
10528
10918
  end
@@ -10562,6 +10952,76 @@ module Google
10562
10952
  end
10563
10953
  end
10564
10954
 
10955
+ # The request message for Participants.SuggestSmartReplies.
10956
+ class GoogleCloudDialogflowV2SuggestSmartRepliesRequest
10957
+ include Google::Apis::Core::Hashable
10958
+
10959
+ # Max number of messages prior to and including [latest_message] to use as
10960
+ # context when compiling the suggestion. By default 20 and at most 50.
10961
+ # Corresponds to the JSON property `contextSize`
10962
+ # @return [Fixnum]
10963
+ attr_accessor :context_size
10964
+
10965
+ # Represents the natural language text to be processed.
10966
+ # Corresponds to the JSON property `currentTextInput`
10967
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput]
10968
+ attr_accessor :current_text_input
10969
+
10970
+ # The name of the latest conversation message to compile suggestion for. If
10971
+ # empty, it will be the latest message of the conversation. Format: `projects//
10972
+ # locations//conversations//messages/`.
10973
+ # Corresponds to the JSON property `latestMessage`
10974
+ # @return [String]
10975
+ attr_accessor :latest_message
10976
+
10977
+ def initialize(**args)
10978
+ update!(**args)
10979
+ end
10980
+
10981
+ # Update properties of this object
10982
+ def update!(**args)
10983
+ @context_size = args[:context_size] if args.key?(:context_size)
10984
+ @current_text_input = args[:current_text_input] if args.key?(:current_text_input)
10985
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
10986
+ end
10987
+ end
10988
+
10989
+ # The response message for Participants.SuggestSmartReplies.
10990
+ class GoogleCloudDialogflowV2SuggestSmartRepliesResponse
10991
+ include Google::Apis::Core::Hashable
10992
+
10993
+ # Number of messages prior to and including latest_message to compile the
10994
+ # suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size
10995
+ # field in the request if there aren't that many messages in the conversation.
10996
+ # Corresponds to the JSON property `contextSize`
10997
+ # @return [Fixnum]
10998
+ attr_accessor :context_size
10999
+
11000
+ # The name of the latest conversation message used to compile suggestion for.
11001
+ # Format: `projects//locations//conversations//messages/`.
11002
+ # Corresponds to the JSON property `latestMessage`
11003
+ # @return [String]
11004
+ attr_accessor :latest_message
11005
+
11006
+ # Output only. Multiple reply options provided by smart reply service. The order
11007
+ # is based on the rank of the model prediction. The maximum number of the
11008
+ # returned replies is set in SmartReplyConfig.
11009
+ # Corresponds to the JSON property `smartReplyAnswers`
11010
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SmartReplyAnswer>]
11011
+ attr_accessor :smart_reply_answers
11012
+
11013
+ def initialize(**args)
11014
+ update!(**args)
11015
+ end
11016
+
11017
+ # Update properties of this object
11018
+ def update!(**args)
11019
+ @context_size = args[:context_size] if args.key?(:context_size)
11020
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
11021
+ @smart_reply_answers = args[:smart_reply_answers] if args.key?(:smart_reply_answers)
11022
+ end
11023
+ end
11024
+
10565
11025
  # The type of Human Agent Assistant API suggestion to perform, and the maximum
10566
11026
  # number of results to return for that type. Multiple `Feature` objects can be
10567
11027
  # specified in the `features` list.
@@ -10609,6 +11069,11 @@ module Google
10609
11069
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
10610
11070
  attr_accessor :suggest_faq_answers_response
10611
11071
 
11072
+ # The response message for Participants.SuggestSmartReplies.
11073
+ # Corresponds to the JSON property `suggestSmartRepliesResponse`
11074
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse]
11075
+ attr_accessor :suggest_smart_replies_response
11076
+
10612
11077
  def initialize(**args)
10613
11078
  update!(**args)
10614
11079
  end
@@ -10618,6 +11083,7 @@ module Google
10618
11083
  @error = args[:error] if args.key?(:error)
10619
11084
  @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
10620
11085
  @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
11086
+ @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
10621
11087
  end
10622
11088
  end
10623
11089
 
@@ -13337,6 +13803,11 @@ module Google
13337
13803
  class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata
13338
13804
  include Google::Apis::Core::Hashable
13339
13805
 
13806
+ # The name of the knowledge base interacted with during the operation.
13807
+ # Corresponds to the JSON property `knowledgeBase`
13808
+ # @return [String]
13809
+ attr_accessor :knowledge_base
13810
+
13340
13811
  # Required. Output only. The current state of this operation.
13341
13812
  # Corresponds to the JSON property `state`
13342
13813
  # @return [String]
@@ -13348,6 +13819,7 @@ module Google
13348
13819
 
13349
13820
  # Update properties of this object
13350
13821
  def update!(**args)
13822
+ @knowledge_base = args[:knowledge_base] if args.key?(:knowledge_base)
13351
13823
  @state = args[:state] if args.key?(:state)
13352
13824
  end
13353
13825
  end