google-apis-dialogflow_v3beta1 0.5.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5bd0c113ef025877dad2f57f1e85854d024df249cb922bcfc3a64b3ec8becd96
4
- data.tar.gz: 0d7a2c9c5e103a5d2e94ccf7e399c9dc7680a66a3a9fa6add07e93bb82a7ab55
3
+ metadata.gz: f16ff9a0d7108d066f16ef9cd29d596f1e43e490ce8127fc862629c58adaf1a2
4
+ data.tar.gz: '08d7e624ee9245a82525b099d17bed416ddfe792d207b6576a65df84d2a43b99'
5
5
  SHA512:
6
- metadata.gz: a84d98617194f7113af1bb7e52f16495206137cfbe8e015be6935db8785a16dcfb6e9346af6e98047f796d2818d64af8b352b810079fe63a812f8ce6715144df
7
- data.tar.gz: 452650ec8675e46f711f50626bfa57f68cd01d2df099f53435ae9ab408c9ec02efad80715028ffae77d4b881f75543bd6949b8fea7984909488cfe7d7e6f4942
6
+ metadata.gz: b76fe2f0ccc8f5bbb30418028baa68f821dc235f82c7d5defaca635cc7de246f5a1c25c328dca8759bd7f8fa7813bc6b0ce9bab25f5f95992cde2a0a423aeca3
7
+ data.tar.gz: b550575b180be1a3e5fb79d6f95759cfff28e77d1bade8bcb3671f87dd930edbb333e504323cda1b1ed86a5d6276317a2ad04a7a3bd4ae339e3b910de4bdb917
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Release history for google-apis-dialogflow_v3beta1
2
2
 
3
+ ### v0.10.0 (2021-04-01)
4
+
5
+ * Regenerated from discovery document revision 20210329
6
+
7
+ ### v0.9.0 (2021-03-23)
8
+
9
+ * Regenerated from discovery document revision 20210320
10
+
11
+ ### v0.8.0 (2021-03-16)
12
+
13
+ * Regenerated from discovery document revision 20210314
14
+
15
+ ### v0.7.0 (2021-03-09)
16
+
17
+ * Regenerated from discovery document revision 20210307
18
+ * Regenerated using generator version 0.2.0
19
+
20
+ ### v0.6.0 (2021-03-04)
21
+
22
+ * Unspecified changes
23
+
3
24
  ### v0.5.0 (2021-02-24)
4
25
 
5
26
  * Regenerated from discovery document revision 20210222
@@ -30,7 +30,7 @@ module Google
30
30
  # This is NOT the gem version.
31
31
  VERSION = 'V3beta1'
32
32
 
33
- # View and manage your data across Google Cloud Platform services
33
+ # See, edit, configure, and delete your Google Cloud Platform data
34
34
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
35
35
 
36
36
  # View, manage and query your Dialogflow agents
@@ -2128,7 +2128,8 @@ module Google
2128
2128
  end
2129
2129
  end
2130
2130
 
2131
- # The request message for a webhook call.
2131
+ # The request message for a webhook call. The request is sent as a JSON object
2132
+ # and the field names will be presented in camel cases.
2132
2133
  class GoogleCloudDialogflowCxV3WebhookRequest
2133
2134
  include Google::Apis::Core::Hashable
2134
2135
 
@@ -2174,6 +2175,30 @@ module Google
2174
2175
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo]
2175
2176
  attr_accessor :session_info
2176
2177
 
2178
+ # If natural language text was provided as input, this field will contain a copy
2179
+ # of the text.
2180
+ # Corresponds to the JSON property `text`
2181
+ # @return [String]
2182
+ attr_accessor :text
2183
+
2184
+ # If natural language speech audio was provided as input, this field will
2185
+ # contain the transcript for the audio.
2186
+ # Corresponds to the JSON property `transcript`
2187
+ # @return [String]
2188
+ attr_accessor :transcript
2189
+
2190
+ # If an event was provided as input, this field will contain the name of the
2191
+ # event.
2192
+ # Corresponds to the JSON property `triggerEvent`
2193
+ # @return [String]
2194
+ attr_accessor :trigger_event
2195
+
2196
+ # If an intent was provided as input, this field will contain a copy of the
2197
+ # intent identifier. Format: `projects//locations//agents//intents/`.
2198
+ # Corresponds to the JSON property `triggerIntent`
2199
+ # @return [String]
2200
+ attr_accessor :trigger_intent
2201
+
2177
2202
  def initialize(**args)
2178
2203
  update!(**args)
2179
2204
  end
@@ -2188,6 +2213,10 @@ module Google
2188
2213
  @payload = args[:payload] if args.key?(:payload)
2189
2214
  @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result)
2190
2215
  @session_info = args[:session_info] if args.key?(:session_info)
2216
+ @text = args[:text] if args.key?(:text)
2217
+ @transcript = args[:transcript] if args.key?(:transcript)
2218
+ @trigger_event = args[:trigger_event] if args.key?(:trigger_event)
2219
+ @trigger_intent = args[:trigger_intent] if args.key?(:trigger_intent)
2191
2220
  end
2192
2221
  end
2193
2222
 
@@ -3278,7 +3307,9 @@ module Google
3278
3307
  # @return [String]
3279
3308
  attr_accessor :end_time
3280
3309
 
3281
- # Maximum number of days to run the experiment.
3310
+ # Maximum number of days to run the experiment. If auto-rollout is not enabled,
3311
+ # default value and maximum will be 30 days. If auto-rollout is enabled, default
3312
+ # value and maximum will be 6 days.
3282
3313
  # Corresponds to the JSON property `experimentLength`
3283
3314
  # @return [String]
3284
3315
  attr_accessor :experiment_length
@@ -3683,6 +3714,15 @@ module Google
3683
3714
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1NluSettings]
3684
3715
  attr_accessor :nlu_settings
3685
3716
 
3717
+ # A flow's transition route group serve two purposes: * They are responsible for
3718
+ # matching the user's first utterances in the flow. * They are inherited by
3719
+ # every page's transition route groups. Transition route groups defined in the
3720
+ # page have higher priority than those defined in the flow. Format:`projects//
3721
+ # locations//agents//flows//transitionRouteGroups/`.
3722
+ # Corresponds to the JSON property `transitionRouteGroups`
3723
+ # @return [Array<String>]
3724
+ attr_accessor :transition_route_groups
3725
+
3686
3726
  # A flow's transition routes serve two purposes: * They are responsible for
3687
3727
  # matching the user's first utterances in the flow. * They are inherited by
3688
3728
  # every page's transition routes and can support use cases such as the user
@@ -3707,6 +3747,7 @@ module Google
3707
3747
  @event_handlers = args[:event_handlers] if args.key?(:event_handlers)
3708
3748
  @name = args[:name] if args.key?(:name)
3709
3749
  @nlu_settings = args[:nlu_settings] if args.key?(:nlu_settings)
3750
+ @transition_route_groups = args[:transition_route_groups] if args.key?(:transition_route_groups)
3710
3751
  @transition_routes = args[:transition_routes] if args.key?(:transition_routes)
3711
3752
  end
3712
3753
  end
@@ -5149,7 +5190,7 @@ module Google
5149
5190
  attr_accessor :text
5150
5191
 
5151
5192
  # If natural language speech audio was provided as input, this field will
5152
- # contain the trascript for the audio.
5193
+ # contain the transcript for the audio.
5153
5194
  # Corresponds to the JSON property `transcript`
5154
5195
  # @return [String]
5155
5196
  attr_accessor :transcript
@@ -5161,7 +5202,7 @@ module Google
5161
5202
  attr_accessor :trigger_event
5162
5203
 
5163
5204
  # If an intent was provided as input, this field will contain a copy of the
5164
- # intent identifier.
5205
+ # intent identifier. Format: `projects//locations//agents//intents/`.
5165
5206
  # Corresponds to the JSON property `triggerIntent`
5166
5207
  # @return [String]
5167
5208
  attr_accessor :trigger_intent
@@ -5514,6 +5555,16 @@ module Google
5514
5555
  attr_accessor :analyze_query_text_sentiment
5515
5556
  alias_method :analyze_query_text_sentiment?, :analyze_query_text_sentiment
5516
5557
 
5558
+ # The unique identifier of the page to override the current page in the session.
5559
+ # Format: `projects//locations//agents//pages/`. If `current_page` is specified,
5560
+ # the previous state of the session will be ignored by Dialogflow, including the
5561
+ # previous page and the previous session parameters. In most cases, current_page
5562
+ # and parameters should be configured together to direct a session to a specific
5563
+ # state.
5564
+ # Corresponds to the JSON property `currentPage`
5565
+ # @return [String]
5566
+ attr_accessor :current_page
5567
+
5517
5568
  # Whether to disable webhook calls for this request.
5518
5569
  # Corresponds to the JSON property `disableWebhook`
5519
5570
  # @return [Boolean]
@@ -5581,6 +5632,7 @@ module Google
5581
5632
  # Update properties of this object
5582
5633
  def update!(**args)
5583
5634
  @analyze_query_text_sentiment = args[:analyze_query_text_sentiment] if args.key?(:analyze_query_text_sentiment)
5635
+ @current_page = args[:current_page] if args.key?(:current_page)
5584
5636
  @disable_webhook = args[:disable_webhook] if args.key?(:disable_webhook)
5585
5637
  @geo_location = args[:geo_location] if args.key?(:geo_location)
5586
5638
  @parameters = args[:parameters] if args.key?(:parameters)
@@ -5681,7 +5733,7 @@ module Google
5681
5733
  attr_accessor :text
5682
5734
 
5683
5735
  # If natural language speech audio was provided as input, this field will
5684
- # contain the trascript for the audio.
5736
+ # contain the transcript for the audio.
5685
5737
  # Corresponds to the JSON property `transcript`
5686
5738
  # @return [String]
5687
5739
  attr_accessor :transcript
@@ -5693,7 +5745,7 @@ module Google
5693
5745
  attr_accessor :trigger_event
5694
5746
 
5695
5747
  # If an intent was provided as input, this field will contain a copy of the
5696
- # intent identifier.
5748
+ # intent identifier. Format: `projects//locations//agents//intents/`.
5697
5749
  # Corresponds to the JSON property `triggerIntent`
5698
5750
  # @return [String]
5699
5751
  attr_accessor :trigger_intent
@@ -6100,6 +6152,11 @@ module Google
6100
6152
  # @return [String]
6101
6153
  attr_accessor :agent_uri
6102
6154
 
6155
+ # Agent restore mode. If not specified, `KEEP` is assumed.
6156
+ # Corresponds to the JSON property `restoreOption`
6157
+ # @return [String]
6158
+ attr_accessor :restore_option
6159
+
6103
6160
  def initialize(**args)
6104
6161
  update!(**args)
6105
6162
  end
@@ -6108,6 +6165,7 @@ module Google
6108
6165
  def update!(**args)
6109
6166
  @agent_content = args[:agent_content] if args.key?(:agent_content)
6110
6167
  @agent_uri = args[:agent_uri] if args.key?(:agent_uri)
6168
+ @restore_option = args[:restore_option] if args.key?(:restore_option)
6111
6169
  end
6112
6170
  end
6113
6171
 
@@ -7385,7 +7443,8 @@ module Google
7385
7443
  end
7386
7444
  end
7387
7445
 
7388
- # The request message for a webhook call.
7446
+ # The request message for a webhook call. The request is sent as a JSON object
7447
+ # and the field names will be presented in camel cases.
7389
7448
  class GoogleCloudDialogflowCxV3beta1WebhookRequest
7390
7449
  include Google::Apis::Core::Hashable
7391
7450
 
@@ -7431,6 +7490,30 @@ module Google
7431
7490
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionInfo]
7432
7491
  attr_accessor :session_info
7433
7492
 
7493
+ # If natural language text was provided as input, this field will contain a copy
7494
+ # of the text.
7495
+ # Corresponds to the JSON property `text`
7496
+ # @return [String]
7497
+ attr_accessor :text
7498
+
7499
+ # If natural language speech audio was provided as input, this field will
7500
+ # contain the transcript for the audio.
7501
+ # Corresponds to the JSON property `transcript`
7502
+ # @return [String]
7503
+ attr_accessor :transcript
7504
+
7505
+ # If an event was provided as input, this field will contain the name of the
7506
+ # event.
7507
+ # Corresponds to the JSON property `triggerEvent`
7508
+ # @return [String]
7509
+ attr_accessor :trigger_event
7510
+
7511
+ # If an intent was provided as input, this field will contain a copy of the
7512
+ # intent identifier. Format: `projects//locations//agents//intents/`.
7513
+ # Corresponds to the JSON property `triggerIntent`
7514
+ # @return [String]
7515
+ attr_accessor :trigger_intent
7516
+
7434
7517
  def initialize(**args)
7435
7518
  update!(**args)
7436
7519
  end
@@ -7445,6 +7528,10 @@ module Google
7445
7528
  @payload = args[:payload] if args.key?(:payload)
7446
7529
  @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result)
7447
7530
  @session_info = args[:session_info] if args.key?(:session_info)
7531
+ @text = args[:text] if args.key?(:text)
7532
+ @transcript = args[:transcript] if args.key?(:transcript)
7533
+ @trigger_event = args[:trigger_event] if args.key?(:trigger_event)
7534
+ @trigger_intent = args[:trigger_intent] if args.key?(:trigger_intent)
7448
7535
  end
7449
7536
  end
7450
7537
 
@@ -7675,6 +7762,59 @@ module Google
7675
7762
  end
7676
7763
  end
7677
7764
 
7765
+ # Represents article answer.
7766
+ class GoogleCloudDialogflowV2ArticleAnswer
7767
+ include Google::Apis::Core::Hashable
7768
+
7769
+ # The name of answer record, in the format of "projects//locations//
7770
+ # answerRecords/"
7771
+ # Corresponds to the JSON property `answerRecord`
7772
+ # @return [String]
7773
+ attr_accessor :answer_record
7774
+
7775
+ # Article match confidence. The system's confidence score that this article is a
7776
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
7777
+ # to 1.0 (completely certain).
7778
+ # Corresponds to the JSON property `confidence`
7779
+ # @return [Float]
7780
+ attr_accessor :confidence
7781
+
7782
+ # A map that contains metadata about the answer and the document from which it
7783
+ # originates.
7784
+ # Corresponds to the JSON property `metadata`
7785
+ # @return [Hash<String,String>]
7786
+ attr_accessor :metadata
7787
+
7788
+ # Article snippets.
7789
+ # Corresponds to the JSON property `snippets`
7790
+ # @return [Array<String>]
7791
+ attr_accessor :snippets
7792
+
7793
+ # The article title.
7794
+ # Corresponds to the JSON property `title`
7795
+ # @return [String]
7796
+ attr_accessor :title
7797
+
7798
+ # The article URI.
7799
+ # Corresponds to the JSON property `uri`
7800
+ # @return [String]
7801
+ attr_accessor :uri
7802
+
7803
+ def initialize(**args)
7804
+ update!(**args)
7805
+ end
7806
+
7807
+ # Update properties of this object
7808
+ def update!(**args)
7809
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
7810
+ @confidence = args[:confidence] if args.key?(:confidence)
7811
+ @metadata = args[:metadata] if args.key?(:metadata)
7812
+ @snippets = args[:snippets] if args.key?(:snippets)
7813
+ @title = args[:title] if args.key?(:title)
7814
+ @uri = args[:uri] if args.key?(:uri)
7815
+ end
7816
+ end
7817
+
7678
7818
  # The response message for EntityTypes.BatchUpdateEntityTypes.
7679
7819
  class GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse
7680
7820
  include Google::Apis::Core::Hashable
@@ -7982,6 +8122,94 @@ module Google
7982
8122
  end
7983
8123
  end
7984
8124
 
8125
+ # Represents answer from "frequently asked questions".
8126
+ class GoogleCloudDialogflowV2FaqAnswer
8127
+ include Google::Apis::Core::Hashable
8128
+
8129
+ # The piece of text from the `source` knowledge base document.
8130
+ # Corresponds to the JSON property `answer`
8131
+ # @return [String]
8132
+ attr_accessor :answer
8133
+
8134
+ # The name of answer record, in the format of "projects//locations//
8135
+ # answerRecords/"
8136
+ # Corresponds to the JSON property `answerRecord`
8137
+ # @return [String]
8138
+ attr_accessor :answer_record
8139
+
8140
+ # The system's confidence score that this Knowledge answer is a good match for
8141
+ # this conversational query, range from 0.0 (completely uncertain) to 1.0 (
8142
+ # completely certain).
8143
+ # Corresponds to the JSON property `confidence`
8144
+ # @return [Float]
8145
+ attr_accessor :confidence
8146
+
8147
+ # A map that contains metadata about the answer and the document from which it
8148
+ # originates.
8149
+ # Corresponds to the JSON property `metadata`
8150
+ # @return [Hash<String,String>]
8151
+ attr_accessor :metadata
8152
+
8153
+ # The corresponding FAQ question.
8154
+ # Corresponds to the JSON property `question`
8155
+ # @return [String]
8156
+ attr_accessor :question
8157
+
8158
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
8159
+ # projects//locations//agent/knowledgeBases//documents/`.
8160
+ # Corresponds to the JSON property `source`
8161
+ # @return [String]
8162
+ attr_accessor :source
8163
+
8164
+ def initialize(**args)
8165
+ update!(**args)
8166
+ end
8167
+
8168
+ # Update properties of this object
8169
+ def update!(**args)
8170
+ @answer = args[:answer] if args.key?(:answer)
8171
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
8172
+ @confidence = args[:confidence] if args.key?(:confidence)
8173
+ @metadata = args[:metadata] if args.key?(:metadata)
8174
+ @question = args[:question] if args.key?(:question)
8175
+ @source = args[:source] if args.key?(:source)
8176
+ end
8177
+ end
8178
+
8179
+ # Represents a notification sent to Cloud Pub/Sub subscribers for human agent
8180
+ # assistant events in a specific conversation.
8181
+ class GoogleCloudDialogflowV2HumanAgentAssistantEvent
8182
+ include Google::Apis::Core::Hashable
8183
+
8184
+ # The conversation this notification refers to. Format: `projects//conversations/
8185
+ # `.
8186
+ # Corresponds to the JSON property `conversation`
8187
+ # @return [String]
8188
+ attr_accessor :conversation
8189
+
8190
+ # The participant that the suggestion is compiled for. Format: `projects//
8191
+ # conversations//participants/`. It will not be set in legacy workflow.
8192
+ # Corresponds to the JSON property `participant`
8193
+ # @return [String]
8194
+ attr_accessor :participant
8195
+
8196
+ # The suggestion results payload that this notification refers to.
8197
+ # Corresponds to the JSON property `suggestionResults`
8198
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SuggestionResult>]
8199
+ attr_accessor :suggestion_results
8200
+
8201
+ def initialize(**args)
8202
+ update!(**args)
8203
+ end
8204
+
8205
+ # Update properties of this object
8206
+ def update!(**args)
8207
+ @conversation = args[:conversation] if args.key?(:conversation)
8208
+ @participant = args[:participant] if args.key?(:participant)
8209
+ @suggestion_results = args[:suggestion_results] if args.key?(:suggestion_results)
8210
+ end
8211
+ end
8212
+
7985
8213
  # An intent categorizes an end-user's intention for one conversation turn. For
7986
8214
  # each agent, you define many intents, where your combined intents can handle a
7987
8215
  # complete conversation. When an end-user writes or says something, referred to
@@ -8009,6 +8237,14 @@ module Google
8009
8237
  # @return [String]
8010
8238
  attr_accessor :display_name
8011
8239
 
8240
+ # Optional. Indicates that this intent ends an interaction. Some integrations (e.
8241
+ # g., Actions on Google or Dialogflow phone gateway) use this information to
8242
+ # close interaction with an end user. Default is false.
8243
+ # Corresponds to the JSON property `endInteraction`
8244
+ # @return [Boolean]
8245
+ attr_accessor :end_interaction
8246
+ alias_method :end_interaction?, :end_interaction
8247
+
8012
8248
  # Optional. The collection of event names that trigger the intent. If the
8013
8249
  # collection of input contexts is not empty, all of the contexts must be present
8014
8250
  # in the active user session for an event to trigger this intent. Event names
@@ -8035,6 +8271,14 @@ module Google
8035
8271
  attr_accessor :is_fallback
8036
8272
  alias_method :is_fallback?, :is_fallback
8037
8273
 
8274
+ # Optional. Indicates that a live agent should be brought in to handle the
8275
+ # interaction with the user. In most cases, when you set this flag to true, you
8276
+ # would also want to set end_interaction to true as well. Default is false.
8277
+ # Corresponds to the JSON property `liveAgentHandoff`
8278
+ # @return [Boolean]
8279
+ attr_accessor :live_agent_handoff
8280
+ alias_method :live_agent_handoff?, :live_agent_handoff
8281
+
8038
8282
  # Optional. The collection of rich messages corresponding to the `Response`
8039
8283
  # field in the Dialogflow console.
8040
8284
  # Corresponds to the JSON property `messages`
@@ -8121,10 +8365,12 @@ module Google
8121
8365
  @action = args[:action] if args.key?(:action)
8122
8366
  @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms)
8123
8367
  @display_name = args[:display_name] if args.key?(:display_name)
8368
+ @end_interaction = args[:end_interaction] if args.key?(:end_interaction)
8124
8369
  @events = args[:events] if args.key?(:events)
8125
8370
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
8126
8371
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
8127
8372
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
8373
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
8128
8374
  @messages = args[:messages] if args.key?(:messages)
8129
8375
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
8130
8376
  @name = args[:name] if args.key?(:name)
@@ -9213,6 +9459,25 @@ module Google
9213
9459
  end
9214
9460
  end
9215
9461
 
9462
+ # Metadata in google::longrunning::Operation for Knowledge operations.
9463
+ class GoogleCloudDialogflowV2KnowledgeOperationMetadata
9464
+ include Google::Apis::Core::Hashable
9465
+
9466
+ # Output only. The current state of this operation.
9467
+ # Corresponds to the JSON property `state`
9468
+ # @return [String]
9469
+ attr_accessor :state
9470
+
9471
+ def initialize(**args)
9472
+ update!(**args)
9473
+ end
9474
+
9475
+ # Update properties of this object
9476
+ def update!(**args)
9477
+ @state = args[:state] if args.key?(:state)
9478
+ end
9479
+ end
9480
+
9216
9481
  # Represents a message posted into a conversation.
9217
9482
  class GoogleCloudDialogflowV2Message
9218
9483
  include Google::Apis::Core::Hashable
@@ -9589,6 +9854,112 @@ module Google
9589
9854
  end
9590
9855
  end
9591
9856
 
9857
+ # The response message for Participants.SuggestArticles.
9858
+ class GoogleCloudDialogflowV2SuggestArticlesResponse
9859
+ include Google::Apis::Core::Hashable
9860
+
9861
+ # Articles ordered by score in descending order.
9862
+ # Corresponds to the JSON property `articleAnswers`
9863
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2ArticleAnswer>]
9864
+ attr_accessor :article_answers
9865
+
9866
+ # Number of messages prior to and including latest_message to compile the
9867
+ # suggestion. It may be smaller than the SuggestArticlesRequest.context_size
9868
+ # field in the request if there aren't that many messages in the conversation.
9869
+ # Corresponds to the JSON property `contextSize`
9870
+ # @return [Fixnum]
9871
+ attr_accessor :context_size
9872
+
9873
+ # The name of the latest conversation message used to compile suggestion for.
9874
+ # Format: `projects//locations//conversations//messages/`.
9875
+ # Corresponds to the JSON property `latestMessage`
9876
+ # @return [String]
9877
+ attr_accessor :latest_message
9878
+
9879
+ def initialize(**args)
9880
+ update!(**args)
9881
+ end
9882
+
9883
+ # Update properties of this object
9884
+ def update!(**args)
9885
+ @article_answers = args[:article_answers] if args.key?(:article_answers)
9886
+ @context_size = args[:context_size] if args.key?(:context_size)
9887
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9888
+ end
9889
+ end
9890
+
9891
+ # The request message for Participants.SuggestFaqAnswers.
9892
+ class GoogleCloudDialogflowV2SuggestFaqAnswersResponse
9893
+ include Google::Apis::Core::Hashable
9894
+
9895
+ # Number of messages prior to and including latest_message to compile the
9896
+ # suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size
9897
+ # field in the request if there aren't that many messages in the conversation.
9898
+ # Corresponds to the JSON property `contextSize`
9899
+ # @return [Fixnum]
9900
+ attr_accessor :context_size
9901
+
9902
+ # Answers extracted from FAQ documents.
9903
+ # Corresponds to the JSON property `faqAnswers`
9904
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2FaqAnswer>]
9905
+ attr_accessor :faq_answers
9906
+
9907
+ # The name of the latest conversation message used to compile suggestion for.
9908
+ # Format: `projects//locations//conversations//messages/`.
9909
+ # Corresponds to the JSON property `latestMessage`
9910
+ # @return [String]
9911
+ attr_accessor :latest_message
9912
+
9913
+ def initialize(**args)
9914
+ update!(**args)
9915
+ end
9916
+
9917
+ # Update properties of this object
9918
+ def update!(**args)
9919
+ @context_size = args[:context_size] if args.key?(:context_size)
9920
+ @faq_answers = args[:faq_answers] if args.key?(:faq_answers)
9921
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9922
+ end
9923
+ end
9924
+
9925
+ # One response of different type of suggestion response which is used in the
9926
+ # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
9927
+ # well as HumanAgentAssistantEvent.
9928
+ class GoogleCloudDialogflowV2SuggestionResult
9929
+ include Google::Apis::Core::Hashable
9930
+
9931
+ # The `Status` type defines a logical error model that is suitable for different
9932
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9933
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9934
+ # data: error code, error message, and error details. You can find out more
9935
+ # about this error model and how to work with it in the [API Design Guide](https:
9936
+ # //cloud.google.com/apis/design/errors).
9937
+ # Corresponds to the JSON property `error`
9938
+ # @return [Google::Apis::DialogflowV3beta1::GoogleRpcStatus]
9939
+ attr_accessor :error
9940
+
9941
+ # The response message for Participants.SuggestArticles.
9942
+ # Corresponds to the JSON property `suggestArticlesResponse`
9943
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SuggestArticlesResponse]
9944
+ attr_accessor :suggest_articles_response
9945
+
9946
+ # The request message for Participants.SuggestFaqAnswers.
9947
+ # Corresponds to the JSON property `suggestFaqAnswersResponse`
9948
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
9949
+ attr_accessor :suggest_faq_answers_response
9950
+
9951
+ def initialize(**args)
9952
+ update!(**args)
9953
+ end
9954
+
9955
+ # Update properties of this object
9956
+ def update!(**args)
9957
+ @error = args[:error] if args.key?(:error)
9958
+ @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
9959
+ @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
9960
+ end
9961
+ end
9962
+
9592
9963
  # The request message for a webhook call.
9593
9964
  class GoogleCloudDialogflowV2WebhookRequest
9594
9965
  include Google::Apis::Core::Hashable
@@ -9715,12 +10086,95 @@ module Google
9715
10086
  end
9716
10087
  end
9717
10088
 
9718
- # The response message for EntityTypes.BatchUpdateEntityTypes.
9719
- class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse
10089
+ # Represents a part of a message possibly annotated with an entity. The part can
10090
+ # be an entity or purely a part of the message between two entities or message
10091
+ # start/end.
10092
+ class GoogleCloudDialogflowV2beta1AnnotatedMessagePart
9720
10093
  include Google::Apis::Core::Hashable
9721
10094
 
9722
- # The collection of updated or created entity types.
9723
- # Corresponds to the JSON property `entityTypes`
10095
+ # Optional. The [Dialogflow system entity type](https://cloud.google.com/
10096
+ # dialogflow/docs/reference/system-entities) of this message part. If this is
10097
+ # empty, Dialogflow could not annotate the phrase part with a system entity.
10098
+ # Corresponds to the JSON property `entityType`
10099
+ # @return [String]
10100
+ attr_accessor :entity_type
10101
+
10102
+ # Optional. The [Dialogflow system entity formatted value ](https://cloud.google.
10103
+ # com/dialogflow/docs/reference/system-entities) of this message part. For
10104
+ # example for a system entity of type `@sys.unit-currency`, this may contain: ` "
10105
+ # amount": 5, "currency": "USD" `
10106
+ # Corresponds to the JSON property `formattedValue`
10107
+ # @return [Object]
10108
+ attr_accessor :formatted_value
10109
+
10110
+ # Required. A part of a message possibly annotated with an entity.
10111
+ # Corresponds to the JSON property `text`
10112
+ # @return [String]
10113
+ attr_accessor :text
10114
+
10115
+ def initialize(**args)
10116
+ update!(**args)
10117
+ end
10118
+
10119
+ # Update properties of this object
10120
+ def update!(**args)
10121
+ @entity_type = args[:entity_type] if args.key?(:entity_type)
10122
+ @formatted_value = args[:formatted_value] if args.key?(:formatted_value)
10123
+ @text = args[:text] if args.key?(:text)
10124
+ end
10125
+ end
10126
+
10127
+ # Represents article answer.
10128
+ class GoogleCloudDialogflowV2beta1ArticleAnswer
10129
+ include Google::Apis::Core::Hashable
10130
+
10131
+ # The name of answer record, in the format of "projects//locations//
10132
+ # answerRecords/"
10133
+ # Corresponds to the JSON property `answerRecord`
10134
+ # @return [String]
10135
+ attr_accessor :answer_record
10136
+
10137
+ # A map that contains metadata about the answer and the document from which it
10138
+ # originates.
10139
+ # Corresponds to the JSON property `metadata`
10140
+ # @return [Hash<String,String>]
10141
+ attr_accessor :metadata
10142
+
10143
+ # Output only. Article snippets.
10144
+ # Corresponds to the JSON property `snippets`
10145
+ # @return [Array<String>]
10146
+ attr_accessor :snippets
10147
+
10148
+ # The article title.
10149
+ # Corresponds to the JSON property `title`
10150
+ # @return [String]
10151
+ attr_accessor :title
10152
+
10153
+ # The article URI.
10154
+ # Corresponds to the JSON property `uri`
10155
+ # @return [String]
10156
+ attr_accessor :uri
10157
+
10158
+ def initialize(**args)
10159
+ update!(**args)
10160
+ end
10161
+
10162
+ # Update properties of this object
10163
+ def update!(**args)
10164
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10165
+ @metadata = args[:metadata] if args.key?(:metadata)
10166
+ @snippets = args[:snippets] if args.key?(:snippets)
10167
+ @title = args[:title] if args.key?(:title)
10168
+ @uri = args[:uri] if args.key?(:uri)
10169
+ end
10170
+ end
10171
+
10172
+ # The response message for EntityTypes.BatchUpdateEntityTypes.
10173
+ class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse
10174
+ include Google::Apis::Core::Hashable
10175
+
10176
+ # The collection of updated or created entity types.
10177
+ # Corresponds to the JSON property `entityTypes`
9724
10178
  # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EntityType>]
9725
10179
  attr_accessor :entity_types
9726
10180
 
@@ -9815,6 +10269,50 @@ module Google
9815
10269
  end
9816
10270
  end
9817
10271
 
10272
+ # Represents a notification sent to Pub/Sub subscribers for conversation
10273
+ # lifecycle events.
10274
+ class GoogleCloudDialogflowV2beta1ConversationEvent
10275
+ include Google::Apis::Core::Hashable
10276
+
10277
+ # Required. The unique identifier of the conversation this notification refers
10278
+ # to. Format: `projects//conversations/`.
10279
+ # Corresponds to the JSON property `conversation`
10280
+ # @return [String]
10281
+ attr_accessor :conversation
10282
+
10283
+ # The `Status` type defines a logical error model that is suitable for different
10284
+ # programming environments, including REST APIs and RPC APIs. It is used by [
10285
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
10286
+ # data: error code, error message, and error details. You can find out more
10287
+ # about this error model and how to work with it in the [API Design Guide](https:
10288
+ # //cloud.google.com/apis/design/errors).
10289
+ # Corresponds to the JSON property `errorStatus`
10290
+ # @return [Google::Apis::DialogflowV3beta1::GoogleRpcStatus]
10291
+ attr_accessor :error_status
10292
+
10293
+ # Represents a message posted into a conversation.
10294
+ # Corresponds to the JSON property `newMessagePayload`
10295
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Message]
10296
+ attr_accessor :new_message_payload
10297
+
10298
+ # Required. The type of the event that this notification refers to.
10299
+ # Corresponds to the JSON property `type`
10300
+ # @return [String]
10301
+ attr_accessor :type
10302
+
10303
+ def initialize(**args)
10304
+ update!(**args)
10305
+ end
10306
+
10307
+ # Update properties of this object
10308
+ def update!(**args)
10309
+ @conversation = args[:conversation] if args.key?(:conversation)
10310
+ @error_status = args[:error_status] if args.key?(:error_status)
10311
+ @new_message_payload = args[:new_message_payload] if args.key?(:new_message_payload)
10312
+ @type = args[:type] if args.key?(:type)
10313
+ end
10314
+ end
10315
+
9818
10316
  # Each intent parameter has a type, called the entity type, which dictates
9819
10317
  # exactly how data from an end-user expression is extracted. Dialogflow provides
9820
10318
  # predefined system entities that can match many common types of data. For
@@ -9980,6 +10478,117 @@ module Google
9980
10478
  end
9981
10479
  end
9982
10480
 
10481
+ # Represents answer from "frequently asked questions".
10482
+ class GoogleCloudDialogflowV2beta1FaqAnswer
10483
+ include Google::Apis::Core::Hashable
10484
+
10485
+ # The piece of text from the `source` knowledge base document.
10486
+ # Corresponds to the JSON property `answer`
10487
+ # @return [String]
10488
+ attr_accessor :answer
10489
+
10490
+ # The name of answer record, in the format of "projects//locations//
10491
+ # answerRecords/"
10492
+ # Corresponds to the JSON property `answerRecord`
10493
+ # @return [String]
10494
+ attr_accessor :answer_record
10495
+
10496
+ # The system's confidence score that this Knowledge answer is a good match for
10497
+ # this conversational query, range from 0.0 (completely uncertain) to 1.0 (
10498
+ # completely certain).
10499
+ # Corresponds to the JSON property `confidence`
10500
+ # @return [Float]
10501
+ attr_accessor :confidence
10502
+
10503
+ # A map that contains metadata about the answer and the document from which it
10504
+ # originates.
10505
+ # Corresponds to the JSON property `metadata`
10506
+ # @return [Hash<String,String>]
10507
+ attr_accessor :metadata
10508
+
10509
+ # The corresponding FAQ question.
10510
+ # Corresponds to the JSON property `question`
10511
+ # @return [String]
10512
+ attr_accessor :question
10513
+
10514
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
10515
+ # projects//locations//agent/knowledgeBases//documents/`.
10516
+ # Corresponds to the JSON property `source`
10517
+ # @return [String]
10518
+ attr_accessor :source
10519
+
10520
+ def initialize(**args)
10521
+ update!(**args)
10522
+ end
10523
+
10524
+ # Update properties of this object
10525
+ def update!(**args)
10526
+ @answer = args[:answer] if args.key?(:answer)
10527
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10528
+ @confidence = args[:confidence] if args.key?(:confidence)
10529
+ @metadata = args[:metadata] if args.key?(:metadata)
10530
+ @question = args[:question] if args.key?(:question)
10531
+ @source = args[:source] if args.key?(:source)
10532
+ end
10533
+ end
10534
+
10535
+ # Output only. Represents a notification sent to Pub/Sub subscribers for agent
10536
+ # assistant events in a specific conversation.
10537
+ class GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent
10538
+ include Google::Apis::Core::Hashable
10539
+
10540
+ # The conversation this notification refers to. Format: `projects//conversations/
10541
+ # `.
10542
+ # Corresponds to the JSON property `conversation`
10543
+ # @return [String]
10544
+ attr_accessor :conversation
10545
+
10546
+ # The participant that the suggestion is compiled for. And This field is used to
10547
+ # call Participants.ListSuggestions API. Format: `projects//conversations//
10548
+ # participants/`. It will not be set in legacy workflow.
10549
+ # HumanAgentAssistantConfig.name for more information.
10550
+ # Corresponds to the JSON property `participant`
10551
+ # @return [String]
10552
+ attr_accessor :participant
10553
+
10554
+ # The suggestion results payload that this notification refers to. It will only
10555
+ # be set when HumanAgentAssistantConfig.SuggestionConfig.
10556
+ # group_suggestion_responses sets to true.
10557
+ # Corresponds to the JSON property `suggestionResults`
10558
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SuggestionResult>]
10559
+ attr_accessor :suggestion_results
10560
+
10561
+ def initialize(**args)
10562
+ update!(**args)
10563
+ end
10564
+
10565
+ # Update properties of this object
10566
+ def update!(**args)
10567
+ @conversation = args[:conversation] if args.key?(:conversation)
10568
+ @participant = args[:participant] if args.key?(:participant)
10569
+ @suggestion_results = args[:suggestion_results] if args.key?(:suggestion_results)
10570
+ end
10571
+ end
10572
+
10573
+ # Response message for Documents.ImportDocuments.
10574
+ class GoogleCloudDialogflowV2beta1ImportDocumentsResponse
10575
+ include Google::Apis::Core::Hashable
10576
+
10577
+ # Includes details about skipped documents or any other warnings.
10578
+ # Corresponds to the JSON property `warnings`
10579
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleRpcStatus>]
10580
+ attr_accessor :warnings
10581
+
10582
+ def initialize(**args)
10583
+ update!(**args)
10584
+ end
10585
+
10586
+ # Update properties of this object
10587
+ def update!(**args)
10588
+ @warnings = args[:warnings] if args.key?(:warnings)
10589
+ end
10590
+ end
10591
+
9983
10592
  # An intent categorizes an end-user's intention for one conversation turn. For
9984
10593
  # each agent, you define many intents, where your combined intents can handle a
9985
10594
  # complete conversation. When an end-user writes or says something, referred to
@@ -10042,6 +10651,14 @@ module Google
10042
10651
  attr_accessor :is_fallback
10043
10652
  alias_method :is_fallback?, :is_fallback
10044
10653
 
10654
+ # Optional. Indicates that a live agent should be brought in to handle the
10655
+ # interaction with the user. In most cases, when you set this flag to true, you
10656
+ # would also want to set end_interaction to true as well. Default is false.
10657
+ # Corresponds to the JSON property `liveAgentHandoff`
10658
+ # @return [Boolean]
10659
+ attr_accessor :live_agent_handoff
10660
+ alias_method :live_agent_handoff?, :live_agent_handoff
10661
+
10045
10662
  # Optional. The collection of rich messages corresponding to the `Response`
10046
10663
  # field in the Dialogflow console.
10047
10664
  # Corresponds to the JSON property `messages`
@@ -10146,6 +10763,7 @@ module Google
10146
10763
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
10147
10764
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
10148
10765
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
10766
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
10149
10767
  @messages = args[:messages] if args.key?(:messages)
10150
10768
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
10151
10769
  @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled)
@@ -11788,6 +12406,110 @@ module Google
11788
12406
  end
11789
12407
  end
11790
12408
 
12409
+ # Represents a message posted into a conversation.
12410
+ class GoogleCloudDialogflowV2beta1Message
12411
+ include Google::Apis::Core::Hashable
12412
+
12413
+ # Required. The message content.
12414
+ # Corresponds to the JSON property `content`
12415
+ # @return [String]
12416
+ attr_accessor :content
12417
+
12418
+ # Output only. The time when the message was created in Contact Center AI.
12419
+ # Corresponds to the JSON property `createTime`
12420
+ # @return [String]
12421
+ attr_accessor :create_time
12422
+
12423
+ # Optional. The message language. This should be a [BCP-47](https://www.rfc-
12424
+ # editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
12425
+ # Corresponds to the JSON property `languageCode`
12426
+ # @return [String]
12427
+ attr_accessor :language_code
12428
+
12429
+ # Represents the result of annotation for the message.
12430
+ # Corresponds to the JSON property `messageAnnotation`
12431
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1MessageAnnotation]
12432
+ attr_accessor :message_annotation
12433
+
12434
+ # Optional. The unique identifier of the message. Format: `projects//locations//
12435
+ # conversations//messages/`.
12436
+ # Corresponds to the JSON property `name`
12437
+ # @return [String]
12438
+ attr_accessor :name
12439
+
12440
+ # Output only. The participant that sends this message.
12441
+ # Corresponds to the JSON property `participant`
12442
+ # @return [String]
12443
+ attr_accessor :participant
12444
+
12445
+ # Output only. The role of the participant.
12446
+ # Corresponds to the JSON property `participantRole`
12447
+ # @return [String]
12448
+ attr_accessor :participant_role
12449
+
12450
+ # Optional. The time when the message was sent.
12451
+ # Corresponds to the JSON property `sendTime`
12452
+ # @return [String]
12453
+ attr_accessor :send_time
12454
+
12455
+ # The result of sentiment analysis. Sentiment analysis inspects user input and
12456
+ # identifies the prevailing subjective opinion, especially to determine a user's
12457
+ # attitude as positive, negative, or neutral. For Participants.DetectIntent, it
12458
+ # needs to be configured in DetectIntentRequest.query_params. For Participants.
12459
+ # StreamingDetectIntent, it needs to be configured in
12460
+ # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent
12461
+ # and Participants.StreamingAnalyzeContent, it needs to be configured in
12462
+ # ConversationProfile.human_agent_assistant_config
12463
+ # Corresponds to the JSON property `sentimentAnalysis`
12464
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisResult]
12465
+ attr_accessor :sentiment_analysis
12466
+
12467
+ def initialize(**args)
12468
+ update!(**args)
12469
+ end
12470
+
12471
+ # Update properties of this object
12472
+ def update!(**args)
12473
+ @content = args[:content] if args.key?(:content)
12474
+ @create_time = args[:create_time] if args.key?(:create_time)
12475
+ @language_code = args[:language_code] if args.key?(:language_code)
12476
+ @message_annotation = args[:message_annotation] if args.key?(:message_annotation)
12477
+ @name = args[:name] if args.key?(:name)
12478
+ @participant = args[:participant] if args.key?(:participant)
12479
+ @participant_role = args[:participant_role] if args.key?(:participant_role)
12480
+ @send_time = args[:send_time] if args.key?(:send_time)
12481
+ @sentiment_analysis = args[:sentiment_analysis] if args.key?(:sentiment_analysis)
12482
+ end
12483
+ end
12484
+
12485
+ # Represents the result of annotation for the message.
12486
+ class GoogleCloudDialogflowV2beta1MessageAnnotation
12487
+ include Google::Apis::Core::Hashable
12488
+
12489
+ # Required. Indicates whether the text message contains entities.
12490
+ # Corresponds to the JSON property `containEntities`
12491
+ # @return [Boolean]
12492
+ attr_accessor :contain_entities
12493
+ alias_method :contain_entities?, :contain_entities
12494
+
12495
+ # Optional. The collection of annotated message parts ordered by their position
12496
+ # in the message. You can recover the annotated message by concatenating [
12497
+ # AnnotatedMessagePart.text].
12498
+ # Corresponds to the JSON property `parts`
12499
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1AnnotatedMessagePart>]
12500
+ attr_accessor :parts
12501
+
12502
+ def initialize(**args)
12503
+ update!(**args)
12504
+ end
12505
+
12506
+ # Update properties of this object
12507
+ def update!(**args)
12508
+ @contain_entities = args[:contain_entities] if args.key?(:contain_entities)
12509
+ @parts = args[:parts] if args.key?(:parts)
12510
+ end
12511
+ end
12512
+
11791
12513
  # Represents the contents of the original request that was passed to the `[
11792
12514
  # Streaming]DetectIntent` call.
11793
12515
  class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest
@@ -12088,6 +12810,188 @@ module Google
12088
12810
  end
12089
12811
  end
12090
12812
 
12813
+ # Represents a smart reply answer.
12814
+ class GoogleCloudDialogflowV2beta1SmartReplyAnswer
12815
+ include Google::Apis::Core::Hashable
12816
+
12817
+ # The name of answer record, in the format of "projects//locations//
12818
+ # answerRecords/"
12819
+ # Corresponds to the JSON property `answerRecord`
12820
+ # @return [String]
12821
+ attr_accessor :answer_record
12822
+
12823
+ # Smart reply confidence. The system's confidence score that this reply is a
12824
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
12825
+ # to 1.0 (completely certain).
12826
+ # Corresponds to the JSON property `confidence`
12827
+ # @return [Float]
12828
+ attr_accessor :confidence
12829
+
12830
+ # The content of the reply.
12831
+ # Corresponds to the JSON property `reply`
12832
+ # @return [String]
12833
+ attr_accessor :reply
12834
+
12835
+ def initialize(**args)
12836
+ update!(**args)
12837
+ end
12838
+
12839
+ # Update properties of this object
12840
+ def update!(**args)
12841
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
12842
+ @confidence = args[:confidence] if args.key?(:confidence)
12843
+ @reply = args[:reply] if args.key?(:reply)
12844
+ end
12845
+ end
12846
+
12847
+ # The response message for Participants.SuggestArticles.
12848
+ class GoogleCloudDialogflowV2beta1SuggestArticlesResponse
12849
+ include Google::Apis::Core::Hashable
12850
+
12851
+ # Output only. Articles ordered by score in descending order.
12852
+ # Corresponds to the JSON property `articleAnswers`
12853
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1ArticleAnswer>]
12854
+ attr_accessor :article_answers
12855
+
12856
+ # Number of messages prior to and including latest_message to compile the
12857
+ # suggestion. It may be smaller than the SuggestArticlesResponse.context_size
12858
+ # field in the request if there aren't that many messages in the conversation.
12859
+ # Corresponds to the JSON property `contextSize`
12860
+ # @return [Fixnum]
12861
+ attr_accessor :context_size
12862
+
12863
+ # The name of the latest conversation message used to compile suggestion for.
12864
+ # Format: `projects//locations//conversations//messages/`.
12865
+ # Corresponds to the JSON property `latestMessage`
12866
+ # @return [String]
12867
+ attr_accessor :latest_message
12868
+
12869
+ def initialize(**args)
12870
+ update!(**args)
12871
+ end
12872
+
12873
+ # Update properties of this object
12874
+ def update!(**args)
12875
+ @article_answers = args[:article_answers] if args.key?(:article_answers)
12876
+ @context_size = args[:context_size] if args.key?(:context_size)
12877
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12878
+ end
12879
+ end
12880
+
12881
+ # The request message for Participants.SuggestFaqAnswers.
12882
+ class GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse
12883
+ include Google::Apis::Core::Hashable
12884
+
12885
+ # Number of messages prior to and including latest_message to compile the
12886
+ # suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size
12887
+ # field in the request if there aren't that many messages in the conversation.
12888
+ # Corresponds to the JSON property `contextSize`
12889
+ # @return [Fixnum]
12890
+ attr_accessor :context_size
12891
+
12892
+ # Output only. Answers extracted from FAQ documents.
12893
+ # Corresponds to the JSON property `faqAnswers`
12894
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1FaqAnswer>]
12895
+ attr_accessor :faq_answers
12896
+
12897
+ # The name of the latest conversation message used to compile suggestion for.
12898
+ # Format: `projects//locations//conversations//messages/`.
12899
+ # Corresponds to the JSON property `latestMessage`
12900
+ # @return [String]
12901
+ attr_accessor :latest_message
12902
+
12903
+ def initialize(**args)
12904
+ update!(**args)
12905
+ end
12906
+
12907
+ # Update properties of this object
12908
+ def update!(**args)
12909
+ @context_size = args[:context_size] if args.key?(:context_size)
12910
+ @faq_answers = args[:faq_answers] if args.key?(:faq_answers)
12911
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12912
+ end
12913
+ end
12914
+
12915
+ # The response message for Participants.SuggestSmartReplies.
12916
+ class GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse
12917
+ include Google::Apis::Core::Hashable
12918
+
12919
+ # Number of messages prior to and including latest_message to compile the
12920
+ # suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size
12921
+ # field in the request if there aren't that many messages in the conversation.
12922
+ # Corresponds to the JSON property `contextSize`
12923
+ # @return [Fixnum]
12924
+ attr_accessor :context_size
12925
+
12926
+ # The name of the latest conversation message used to compile suggestion for.
12927
+ # Format: `projects//locations//conversations//messages/`.
12928
+ # Corresponds to the JSON property `latestMessage`
12929
+ # @return [String]
12930
+ attr_accessor :latest_message
12931
+
12932
+ # Output only. Multiple reply options provided by smart reply service. The order
12933
+ # is based on the rank of the model prediction. The maximum number of the
12934
+ # returned replies is set in SmartReplyConfig.
12935
+ # Corresponds to the JSON property `smartReplyAnswers`
12936
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SmartReplyAnswer>]
12937
+ attr_accessor :smart_reply_answers
12938
+
12939
+ def initialize(**args)
12940
+ update!(**args)
12941
+ end
12942
+
12943
+ # Update properties of this object
12944
+ def update!(**args)
12945
+ @context_size = args[:context_size] if args.key?(:context_size)
12946
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12947
+ @smart_reply_answers = args[:smart_reply_answers] if args.key?(:smart_reply_answers)
12948
+ end
12949
+ end
12950
+
12951
+ # One response of different type of suggestion response which is used in the
12952
+ # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
12953
+ # well as HumanAgentAssistantEvent.
12954
+ class GoogleCloudDialogflowV2beta1SuggestionResult
12955
+ include Google::Apis::Core::Hashable
12956
+
12957
+ # The `Status` type defines a logical error model that is suitable for different
12958
+ # programming environments, including REST APIs and RPC APIs. It is used by [
12959
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
12960
+ # data: error code, error message, and error details. You can find out more
12961
+ # about this error model and how to work with it in the [API Design Guide](https:
12962
+ # //cloud.google.com/apis/design/errors).
12963
+ # Corresponds to the JSON property `error`
12964
+ # @return [Google::Apis::DialogflowV3beta1::GoogleRpcStatus]
12965
+ attr_accessor :error
12966
+
12967
+ # The response message for Participants.SuggestArticles.
12968
+ # Corresponds to the JSON property `suggestArticlesResponse`
12969
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SuggestArticlesResponse]
12970
+ attr_accessor :suggest_articles_response
12971
+
12972
+ # The request message for Participants.SuggestFaqAnswers.
12973
+ # Corresponds to the JSON property `suggestFaqAnswersResponse`
12974
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse]
12975
+ attr_accessor :suggest_faq_answers_response
12976
+
12977
+ # The response message for Participants.SuggestSmartReplies.
12978
+ # Corresponds to the JSON property `suggestSmartRepliesResponse`
12979
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse]
12980
+ attr_accessor :suggest_smart_replies_response
12981
+
12982
+ def initialize(**args)
12983
+ update!(**args)
12984
+ end
12985
+
12986
+ # Update properties of this object
12987
+ def update!(**args)
12988
+ @error = args[:error] if args.key?(:error)
12989
+ @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
12990
+ @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
12991
+ @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
12992
+ end
12993
+ end
12994
+
12091
12995
  # The request message for a webhook call.
12092
12996
  class GoogleCloudDialogflowV2beta1WebhookRequest
12093
12997
  include Google::Apis::Core::Hashable
@@ -12178,6 +13082,14 @@ module Google
12178
13082
  # @return [String]
12179
13083
  attr_accessor :fulfillment_text
12180
13084
 
13085
+ # Indicates that a live agent should be brought in to handle the interaction
13086
+ # with the user. In most cases, when you set this flag to true, you would also
13087
+ # want to set end_interaction to true as well. Default is false.
13088
+ # Corresponds to the JSON property `liveAgentHandoff`
13089
+ # @return [Boolean]
13090
+ attr_accessor :live_agent_handoff
13091
+ alias_method :live_agent_handoff?, :live_agent_handoff
13092
+
12181
13093
  # Optional. The collection of output contexts that will overwrite currently
12182
13094
  # active contexts for the session and reset their lifespans. When provided,
12183
13095
  # Dialogflow uses this field to populate QueryResult.output_contexts sent to the
@@ -12224,6 +13136,7 @@ module Google
12224
13136
  @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input)
12225
13137
  @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages)
12226
13138
  @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text)
13139
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
12227
13140
  @output_contexts = args[:output_contexts] if args.key?(:output_contexts)
12228
13141
  @payload = args[:payload] if args.key?(:payload)
12229
13142
  @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types)