google-apis-dialogflow_v2 0.5.0 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4e9f488dc381f3e56d6dd118a910a580ec4f86e393792873c18c9f6f13c9d3ca
4
- data.tar.gz: 0f2efea8e12b88ec6c7f89db79c1273b41d45e712510186f27029a663e9a613f
3
+ metadata.gz: 91b09d28be6fb5698da2d1d82660fa1fdf720d7265b24800b9c41bae97569bd5
4
+ data.tar.gz: a32351e95163a5330c8e01b655bc69fa94b46baa5f2a546c492b59f21ed81754
5
5
  SHA512:
6
- metadata.gz: 99cb514fc927bd14c4eea730fc2a7aa48fe106e5fd899b1bd23ca8874daf370fa00f685c800041b647c88c3f949564143f003fc2edfd02b9dd791c19894421b9
7
- data.tar.gz: c7bf98046e03b3fe551a23efd6b67dda246b465456e841afa4c6320def60a2904fc54079f35c4388677f92b5b096f259e01440f777cd0405ed8b2878f394d512
6
+ metadata.gz: e9131e3bb084644c14210781450193f6fcf7e340f35939573f3d3099792cc868d8c372077188ef8dd9c6f13a15f024b50655318d4c87822069eb04fd4450578b
7
+ data.tar.gz: fc2c08b4921e57fcc735f0ac968aa1aae2256b83f91368069585b174a418cbeb52b72e2b9026e3f092c834a3e3c843e69d8583ad119a1c7c386ed785261ff149
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Release history for google-apis-dialogflow_v2
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-19)
12
+
13
+ * Regenerated from discovery document revision 20210318
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 = 'V2'
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::DialogflowV2::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
 
@@ -4486,7 +4515,8 @@ module Google
4486
4515
  end
4487
4516
  end
4488
4517
 
4489
- # The request message for a webhook call.
4518
+ # The request message for a webhook call. The request is sent as a JSON object
4519
+ # and the field names will be presented in camel cases.
4490
4520
  class GoogleCloudDialogflowCxV3beta1WebhookRequest
4491
4521
  include Google::Apis::Core::Hashable
4492
4522
 
@@ -4532,6 +4562,30 @@ module Google
4532
4562
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo]
4533
4563
  attr_accessor :session_info
4534
4564
 
4565
+ # If natural language text was provided as input, this field will contain a copy
4566
+ # of the text.
4567
+ # Corresponds to the JSON property `text`
4568
+ # @return [String]
4569
+ attr_accessor :text
4570
+
4571
+ # If natural language speech audio was provided as input, this field will
4572
+ # contain the transcript for the audio.
4573
+ # Corresponds to the JSON property `transcript`
4574
+ # @return [String]
4575
+ attr_accessor :transcript
4576
+
4577
+ # If an event was provided as input, this field will contain the name of the
4578
+ # event.
4579
+ # Corresponds to the JSON property `triggerEvent`
4580
+ # @return [String]
4581
+ attr_accessor :trigger_event
4582
+
4583
+ # If an intent was provided as input, this field will contain a copy of the
4584
+ # intent identifier. Format: `projects//locations//agents//intents/`.
4585
+ # Corresponds to the JSON property `triggerIntent`
4586
+ # @return [String]
4587
+ attr_accessor :trigger_intent
4588
+
4535
4589
  def initialize(**args)
4536
4590
  update!(**args)
4537
4591
  end
@@ -4546,6 +4600,10 @@ module Google
4546
4600
  @payload = args[:payload] if args.key?(:payload)
4547
4601
  @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result)
4548
4602
  @session_info = args[:session_info] if args.key?(:session_info)
4603
+ @text = args[:text] if args.key?(:text)
4604
+ @transcript = args[:transcript] if args.key?(:transcript)
4605
+ @trigger_event = args[:trigger_event] if args.key?(:trigger_event)
4606
+ @trigger_intent = args[:trigger_intent] if args.key?(:trigger_intent)
4549
4607
  end
4550
4608
  end
4551
4609
 
@@ -4847,6 +4905,181 @@ module Google
4847
4905
  end
4848
4906
  end
4849
4907
 
4908
+ # Detail feedback of Agent Assist result.
4909
+ class GoogleCloudDialogflowV2AgentAssistantFeedback
4910
+ include Google::Apis::Core::Hashable
4911
+
4912
+ # Optional. Whether or not the suggested answer is relevant. For example: *
4913
+ # Query: "Can I change my mailing address?" * Suggested document says: "Items
4914
+ # must be returned/exchanged within 60 days of the purchase date." *
4915
+ # answer_relevance: AnswerRelevance.IRRELEVANT
4916
+ # Corresponds to the JSON property `answerRelevance`
4917
+ # @return [String]
4918
+ attr_accessor :answer_relevance
4919
+
4920
+ # Optional. Whether or not the information in the document is correct. For
4921
+ # example: * Query: "Can I return the package in 2 days once received?" *
4922
+ # Suggested document says: "Items must be returned/exchanged within 60 days of
4923
+ # the purchase date." * Ground truth: "No return or exchange is allowed." * [
4924
+ # document_correctness]: INCORRECT
4925
+ # Corresponds to the JSON property `documentCorrectness`
4926
+ # @return [String]
4927
+ attr_accessor :document_correctness
4928
+
4929
+ # Optional. Whether or not the suggested document is efficient. For example, if
4930
+ # the document is poorly written, hard to understand, hard to use or too long to
4931
+ # find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT.
4932
+ # Corresponds to the JSON property `documentEfficiency`
4933
+ # @return [String]
4934
+ attr_accessor :document_efficiency
4935
+
4936
+ def initialize(**args)
4937
+ update!(**args)
4938
+ end
4939
+
4940
+ # Update properties of this object
4941
+ def update!(**args)
4942
+ @answer_relevance = args[:answer_relevance] if args.key?(:answer_relevance)
4943
+ @document_correctness = args[:document_correctness] if args.key?(:document_correctness)
4944
+ @document_efficiency = args[:document_efficiency] if args.key?(:document_efficiency)
4945
+ end
4946
+ end
4947
+
4948
+ # Represents a record of a human agent assist answer.
4949
+ class GoogleCloudDialogflowV2AgentAssistantRecord
4950
+ include Google::Apis::Core::Hashable
4951
+
4952
+ # Represents article answer.
4953
+ # Corresponds to the JSON property `articleSuggestionAnswer`
4954
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ArticleAnswer]
4955
+ attr_accessor :article_suggestion_answer
4956
+
4957
+ # Represents answer from "frequently asked questions".
4958
+ # Corresponds to the JSON property `faqAnswer`
4959
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2FaqAnswer]
4960
+ attr_accessor :faq_answer
4961
+
4962
+ def initialize(**args)
4963
+ update!(**args)
4964
+ end
4965
+
4966
+ # Update properties of this object
4967
+ def update!(**args)
4968
+ @article_suggestion_answer = args[:article_suggestion_answer] if args.key?(:article_suggestion_answer)
4969
+ @faq_answer = args[:faq_answer] if args.key?(:faq_answer)
4970
+ end
4971
+ end
4972
+
4973
+ # The request message for Participants.AnalyzeContent.
4974
+ class GoogleCloudDialogflowV2AnalyzeContentRequest
4975
+ include Google::Apis::Core::Hashable
4976
+
4977
+ # Events allow for matching intents by event name instead of the natural
4978
+ # language input. For instance, input `` can trigger a personalized welcome
4979
+ # response. The parameter `name` may be used by the agent in the response: `"
4980
+ # Hello #welcome_event.name! What can I do for you today?"`.
4981
+ # Corresponds to the JSON property `eventInput`
4982
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput]
4983
+ attr_accessor :event_input
4984
+
4985
+ # Represents the parameters of the conversational query.
4986
+ # Corresponds to the JSON property `queryParams`
4987
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryParameters]
4988
+ attr_accessor :query_params
4989
+
4990
+ # Instructs the speech synthesizer on how to generate the output audio content.
4991
+ # If this audio config is supplied in a request, it overrides all existing text-
4992
+ # to-speech settings applied to the agent.
4993
+ # Corresponds to the JSON property `replyAudioConfig`
4994
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig]
4995
+ attr_accessor :reply_audio_config
4996
+
4997
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
4998
+ # random UUID is recommended. This request is only idempotent if a `request_id`
4999
+ # is provided.
5000
+ # Corresponds to the JSON property `requestId`
5001
+ # @return [String]
5002
+ attr_accessor :request_id
5003
+
5004
+ # Represents the natural language text to be processed.
5005
+ # Corresponds to the JSON property `textInput`
5006
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput]
5007
+ attr_accessor :text_input
5008
+
5009
+ def initialize(**args)
5010
+ update!(**args)
5011
+ end
5012
+
5013
+ # Update properties of this object
5014
+ def update!(**args)
5015
+ @event_input = args[:event_input] if args.key?(:event_input)
5016
+ @query_params = args[:query_params] if args.key?(:query_params)
5017
+ @reply_audio_config = args[:reply_audio_config] if args.key?(:reply_audio_config)
5018
+ @request_id = args[:request_id] if args.key?(:request_id)
5019
+ @text_input = args[:text_input] if args.key?(:text_input)
5020
+ end
5021
+ end
5022
+
5023
+ # The response message for Participants.AnalyzeContent.
5024
+ class GoogleCloudDialogflowV2AnalyzeContentResponse
5025
+ include Google::Apis::Core::Hashable
5026
+
5027
+ # Represents a response from an automated agent.
5028
+ # Corresponds to the JSON property `automatedAgentReply`
5029
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AutomatedAgentReply]
5030
+ attr_accessor :automated_agent_reply
5031
+
5032
+ # The message in the response that indicates the parameters of DTMF.
5033
+ # Corresponds to the JSON property `dtmfParameters`
5034
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DtmfParameters]
5035
+ attr_accessor :dtmf_parameters
5036
+
5037
+ # The suggestions for end user. The order is the same as
5038
+ # HumanAgentAssistantConfig.SuggestionConfig.feature_configs of
5039
+ # HumanAgentAssistantConfig.end_user_suggestion_config.
5040
+ # Corresponds to the JSON property `endUserSuggestionResults`
5041
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionResult>]
5042
+ attr_accessor :end_user_suggestion_results
5043
+
5044
+ # The suggestions for most recent human agent. The order is the same as
5045
+ # HumanAgentAssistantConfig.SuggestionConfig.feature_configs of
5046
+ # HumanAgentAssistantConfig.human_agent_suggestion_config.
5047
+ # Corresponds to the JSON property `humanAgentSuggestionResults`
5048
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionResult>]
5049
+ attr_accessor :human_agent_suggestion_results
5050
+
5051
+ # Represents a message posted into a conversation.
5052
+ # Corresponds to the JSON property `message`
5053
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Message]
5054
+ attr_accessor :message
5055
+
5056
+ # Represents the natural language speech audio to be played to the end user.
5057
+ # Corresponds to the JSON property `replyAudio`
5058
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudio]
5059
+ attr_accessor :reply_audio
5060
+
5061
+ # The output text content. This field is set if the automated agent responded
5062
+ # with text to show to the user.
5063
+ # Corresponds to the JSON property `replyText`
5064
+ # @return [String]
5065
+ attr_accessor :reply_text
5066
+
5067
+ def initialize(**args)
5068
+ update!(**args)
5069
+ end
5070
+
5071
+ # Update properties of this object
5072
+ def update!(**args)
5073
+ @automated_agent_reply = args[:automated_agent_reply] if args.key?(:automated_agent_reply)
5074
+ @dtmf_parameters = args[:dtmf_parameters] if args.key?(:dtmf_parameters)
5075
+ @end_user_suggestion_results = args[:end_user_suggestion_results] if args.key?(:end_user_suggestion_results)
5076
+ @human_agent_suggestion_results = args[:human_agent_suggestion_results] if args.key?(:human_agent_suggestion_results)
5077
+ @message = args[:message] if args.key?(:message)
5078
+ @reply_audio = args[:reply_audio] if args.key?(:reply_audio)
5079
+ @reply_text = args[:reply_text] if args.key?(:reply_text)
5080
+ end
5081
+ end
5082
+
4850
5083
  # Represents a part of a message possibly annotated with an entity. The part can
4851
5084
  # be an entity or purely a part of the message between two entities or message
4852
5085
  # start/end.
@@ -4885,6 +5118,201 @@ module Google
4885
5118
  end
4886
5119
  end
4887
5120
 
5121
+ # Represents feedback the customer has about the quality & correctness of a
5122
+ # certain answer in a conversation.
5123
+ class GoogleCloudDialogflowV2AnswerFeedback
5124
+ include Google::Apis::Core::Hashable
5125
+
5126
+ # Detail feedback of Agent Assist result.
5127
+ # Corresponds to the JSON property `agentAssistantDetailFeedback`
5128
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AgentAssistantFeedback]
5129
+ attr_accessor :agent_assistant_detail_feedback
5130
+
5131
+ # Time when the answer/item was clicked.
5132
+ # Corresponds to the JSON property `clickTime`
5133
+ # @return [String]
5134
+ attr_accessor :click_time
5135
+
5136
+ # Indicates whether the answer/item was clicked by the human agent or not.
5137
+ # Default to false.
5138
+ # Corresponds to the JSON property `clicked`
5139
+ # @return [Boolean]
5140
+ attr_accessor :clicked
5141
+ alias_method :clicked?, :clicked
5142
+
5143
+ # The correctness level of the specific answer.
5144
+ # Corresponds to the JSON property `correctnessLevel`
5145
+ # @return [String]
5146
+ attr_accessor :correctness_level
5147
+
5148
+ # Time when the answer/item was displayed.
5149
+ # Corresponds to the JSON property `displayTime`
5150
+ # @return [String]
5151
+ attr_accessor :display_time
5152
+
5153
+ # Indicates whether the answer/item was displayed to the human agent in the
5154
+ # agent desktop UI. Default to false.
5155
+ # Corresponds to the JSON property `displayed`
5156
+ # @return [Boolean]
5157
+ attr_accessor :displayed
5158
+ alias_method :displayed?, :displayed
5159
+
5160
+ def initialize(**args)
5161
+ update!(**args)
5162
+ end
5163
+
5164
+ # Update properties of this object
5165
+ def update!(**args)
5166
+ @agent_assistant_detail_feedback = args[:agent_assistant_detail_feedback] if args.key?(:agent_assistant_detail_feedback)
5167
+ @click_time = args[:click_time] if args.key?(:click_time)
5168
+ @clicked = args[:clicked] if args.key?(:clicked)
5169
+ @correctness_level = args[:correctness_level] if args.key?(:correctness_level)
5170
+ @display_time = args[:display_time] if args.key?(:display_time)
5171
+ @displayed = args[:displayed] if args.key?(:displayed)
5172
+ end
5173
+ end
5174
+
5175
+ # Answer records are records to manage answer history and feedbacks for
5176
+ # Dialogflow. Currently, answer record includes: - human agent assistant article
5177
+ # suggestion - human agent assistant faq article It doesn't include: - `
5178
+ # DetectIntent` intent matching - `DetectIntent` knowledge Answer records are
5179
+ # not related to the conversation history in the Dialogflow Console. A Record is
5180
+ # generated even when the end-user disables conversation history in the console.
5181
+ # Records are created when there's a human agent assistant suggestion generated.
5182
+ # A typical workflow for customers provide feedback to an answer is: 1. For
5183
+ # human agent assistant, customers get suggestion via ListSuggestions API.
5184
+ # Together with the answers, AnswerRecord.name are returned to the customers. 2.
5185
+ # The customer uses the AnswerRecord.name to call the UpdateAnswerRecord method
5186
+ # to send feedback about a specific answer that they believe is wrong.
5187
+ class GoogleCloudDialogflowV2AnswerRecord
5188
+ include Google::Apis::Core::Hashable
5189
+
5190
+ # Represents a record of a human agent assist answer.
5191
+ # Corresponds to the JSON property `agentAssistantRecord`
5192
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AgentAssistantRecord]
5193
+ attr_accessor :agent_assistant_record
5194
+
5195
+ # Represents feedback the customer has about the quality & correctness of a
5196
+ # certain answer in a conversation.
5197
+ # Corresponds to the JSON property `answerFeedback`
5198
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerFeedback]
5199
+ attr_accessor :answer_feedback
5200
+
5201
+ # The unique identifier of this answer record. Format: `projects//locations//
5202
+ # answerRecords/`.
5203
+ # Corresponds to the JSON property `name`
5204
+ # @return [String]
5205
+ attr_accessor :name
5206
+
5207
+ def initialize(**args)
5208
+ update!(**args)
5209
+ end
5210
+
5211
+ # Update properties of this object
5212
+ def update!(**args)
5213
+ @agent_assistant_record = args[:agent_assistant_record] if args.key?(:agent_assistant_record)
5214
+ @answer_feedback = args[:answer_feedback] if args.key?(:answer_feedback)
5215
+ @name = args[:name] if args.key?(:name)
5216
+ end
5217
+ end
5218
+
5219
+ # Represents article answer.
5220
+ class GoogleCloudDialogflowV2ArticleAnswer
5221
+ include Google::Apis::Core::Hashable
5222
+
5223
+ # The name of answer record, in the format of "projects//locations//
5224
+ # answerRecords/"
5225
+ # Corresponds to the JSON property `answerRecord`
5226
+ # @return [String]
5227
+ attr_accessor :answer_record
5228
+
5229
+ # Article match confidence. The system's confidence score that this article is a
5230
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
5231
+ # to 1.0 (completely certain).
5232
+ # Corresponds to the JSON property `confidence`
5233
+ # @return [Float]
5234
+ attr_accessor :confidence
5235
+
5236
+ # A map that contains metadata about the answer and the document from which it
5237
+ # originates.
5238
+ # Corresponds to the JSON property `metadata`
5239
+ # @return [Hash<String,String>]
5240
+ attr_accessor :metadata
5241
+
5242
+ # Article snippets.
5243
+ # Corresponds to the JSON property `snippets`
5244
+ # @return [Array<String>]
5245
+ attr_accessor :snippets
5246
+
5247
+ # The article title.
5248
+ # Corresponds to the JSON property `title`
5249
+ # @return [String]
5250
+ attr_accessor :title
5251
+
5252
+ # The article URI.
5253
+ # Corresponds to the JSON property `uri`
5254
+ # @return [String]
5255
+ attr_accessor :uri
5256
+
5257
+ def initialize(**args)
5258
+ update!(**args)
5259
+ end
5260
+
5261
+ # Update properties of this object
5262
+ def update!(**args)
5263
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
5264
+ @confidence = args[:confidence] if args.key?(:confidence)
5265
+ @metadata = args[:metadata] if args.key?(:metadata)
5266
+ @snippets = args[:snippets] if args.key?(:snippets)
5267
+ @title = args[:title] if args.key?(:title)
5268
+ @uri = args[:uri] if args.key?(:uri)
5269
+ end
5270
+ end
5271
+
5272
+ # Defines the Automated Agent to connect to a conversation.
5273
+ class GoogleCloudDialogflowV2AutomatedAgentConfig
5274
+ include Google::Apis::Core::Hashable
5275
+
5276
+ # Required. ID of the Dialogflow agent environment to use. This project needs to
5277
+ # either be the same project as the conversation or you need to grant `service-@
5278
+ # gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API Service Agent`
5279
+ # role in this project. Format: `projects//locations//agent/environments/`. If
5280
+ # environment is not specified, the default `draft` environment is used. Refer
5281
+ # to [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.
5282
+ # dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest) for more details.
5283
+ # Corresponds to the JSON property `agent`
5284
+ # @return [String]
5285
+ attr_accessor :agent
5286
+
5287
+ def initialize(**args)
5288
+ update!(**args)
5289
+ end
5290
+
5291
+ # Update properties of this object
5292
+ def update!(**args)
5293
+ @agent = args[:agent] if args.key?(:agent)
5294
+ end
5295
+ end
5296
+
5297
+ # Represents a response from an automated agent.
5298
+ class GoogleCloudDialogflowV2AutomatedAgentReply
5299
+ include Google::Apis::Core::Hashable
5300
+
5301
+ # The message returned from the DetectIntent method.
5302
+ # Corresponds to the JSON property `detectIntentResponse`
5303
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse]
5304
+ attr_accessor :detect_intent_response
5305
+
5306
+ def initialize(**args)
5307
+ update!(**args)
5308
+ end
5309
+
5310
+ # Update properties of this object
5311
+ def update!(**args)
5312
+ @detect_intent_response = args[:detect_intent_response] if args.key?(:detect_intent_response)
5313
+ end
5314
+ end
5315
+
4888
5316
  # The request message for EntityTypes.BatchCreateEntities.
4889
5317
  class GoogleCloudDialogflowV2BatchCreateEntitiesRequest
4890
5318
  include Google::Apis::Core::Hashable
@@ -5144,6 +5572,19 @@ module Google
5144
5572
  end
5145
5573
  end
5146
5574
 
5575
+ # The request message for Conversations.CompleteConversation.
5576
+ class GoogleCloudDialogflowV2CompleteConversationRequest
5577
+ include Google::Apis::Core::Hashable
5578
+
5579
+ def initialize(**args)
5580
+ update!(**args)
5581
+ end
5582
+
5583
+ # Update properties of this object
5584
+ def update!(**args)
5585
+ end
5586
+ end
5587
+
5147
5588
  # Dialogflow contexts are similar to natural language context. If a person says
5148
5589
  # to you "they are orange", you need context in order to understand what "they"
5149
5590
  # is referring to. Similarly, for Dialogflow to handle an end-user expression
@@ -5205,6 +5646,75 @@ module Google
5205
5646
  end
5206
5647
  end
5207
5648
 
5649
+ # Represents a conversation. A conversation is an interaction between an agent,
5650
+ # including live agents and Dialogflow agents, and a support customer.
5651
+ # Conversations can include phone calls and text-based chat sessions.
5652
+ class GoogleCloudDialogflowV2Conversation
5653
+ include Google::Apis::Core::Hashable
5654
+
5655
+ # Required. The Conversation Profile to be used to configure this Conversation.
5656
+ # This field cannot be updated. Format: `projects//locations//
5657
+ # conversationProfiles/`.
5658
+ # Corresponds to the JSON property `conversationProfile`
5659
+ # @return [String]
5660
+ attr_accessor :conversation_profile
5661
+
5662
+ # The stage of a conversation. It indicates whether the virtual agent or a human
5663
+ # agent is handling the conversation. If the conversation is created with the
5664
+ # conversation profile that has Dialogflow config set, defaults to
5665
+ # ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to
5666
+ # ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the
5667
+ # conversation profile that has Dialogflow config set but explicitly sets
5668
+ # conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips
5669
+ # ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to
5670
+ # ConversationStage.HUMAN_ASSIST_STAGE.
5671
+ # Corresponds to the JSON property `conversationStage`
5672
+ # @return [String]
5673
+ attr_accessor :conversation_stage
5674
+
5675
+ # Output only. The time the conversation was finished.
5676
+ # Corresponds to the JSON property `endTime`
5677
+ # @return [String]
5678
+ attr_accessor :end_time
5679
+
5680
+ # Output only. The current state of the Conversation.
5681
+ # Corresponds to the JSON property `lifecycleState`
5682
+ # @return [String]
5683
+ attr_accessor :lifecycle_state
5684
+
5685
+ # Output only. The unique identifier of this conversation. Format: `projects//
5686
+ # locations//conversations/`.
5687
+ # Corresponds to the JSON property `name`
5688
+ # @return [String]
5689
+ attr_accessor :name
5690
+
5691
+ # Represents a phone number for telephony integration. It allows for connecting
5692
+ # a particular conversation over telephony.
5693
+ # Corresponds to the JSON property `phoneNumber`
5694
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationPhoneNumber]
5695
+ attr_accessor :phone_number
5696
+
5697
+ # Output only. The time the conversation was started.
5698
+ # Corresponds to the JSON property `startTime`
5699
+ # @return [String]
5700
+ attr_accessor :start_time
5701
+
5702
+ def initialize(**args)
5703
+ update!(**args)
5704
+ end
5705
+
5706
+ # Update properties of this object
5707
+ def update!(**args)
5708
+ @conversation_profile = args[:conversation_profile] if args.key?(:conversation_profile)
5709
+ @conversation_stage = args[:conversation_stage] if args.key?(:conversation_stage)
5710
+ @end_time = args[:end_time] if args.key?(:end_time)
5711
+ @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state)
5712
+ @name = args[:name] if args.key?(:name)
5713
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
5714
+ @start_time = args[:start_time] if args.key?(:start_time)
5715
+ end
5716
+ end
5717
+
5208
5718
  # Represents a notification sent to Pub/Sub subscribers for conversation
5209
5719
  # lifecycle events.
5210
5720
  class GoogleCloudDialogflowV2ConversationEvent
@@ -5249,12 +5759,122 @@ module Google
5249
5759
  end
5250
5760
  end
5251
5761
 
5252
- # The request to detect user's intent.
5253
- class GoogleCloudDialogflowV2DetectIntentRequest
5762
+ # Represents a phone number for telephony integration. It allows for connecting
5763
+ # a particular conversation over telephony.
5764
+ class GoogleCloudDialogflowV2ConversationPhoneNumber
5254
5765
  include Google::Apis::Core::Hashable
5255
5766
 
5256
- # The natural language speech audio to be processed. This field should be
5257
- # populated iff `query_input` is set to an input audio config. A single request
5767
+ # Output only. The phone number to connect to this conversation.
5768
+ # Corresponds to the JSON property `phoneNumber`
5769
+ # @return [String]
5770
+ attr_accessor :phone_number
5771
+
5772
+ def initialize(**args)
5773
+ update!(**args)
5774
+ end
5775
+
5776
+ # Update properties of this object
5777
+ def update!(**args)
5778
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
5779
+ end
5780
+ end
5781
+
5782
+ # Defines the services to connect to incoming Dialogflow conversations.
5783
+ class GoogleCloudDialogflowV2ConversationProfile
5784
+ include Google::Apis::Core::Hashable
5785
+
5786
+ # Defines the Automated Agent to connect to a conversation.
5787
+ # Corresponds to the JSON property `automatedAgentConfig`
5788
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AutomatedAgentConfig]
5789
+ attr_accessor :automated_agent_config
5790
+
5791
+ # Output only. Create time of the conversation profile.
5792
+ # Corresponds to the JSON property `createTime`
5793
+ # @return [String]
5794
+ attr_accessor :create_time
5795
+
5796
+ # Required. Human readable name for this profile. Max length 1024 bytes.
5797
+ # Corresponds to the JSON property `displayName`
5798
+ # @return [String]
5799
+ attr_accessor :display_name
5800
+
5801
+ # Defines the Human Agent Assist to connect to a conversation.
5802
+ # Corresponds to the JSON property `humanAgentAssistantConfig`
5803
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfig]
5804
+ attr_accessor :human_agent_assistant_config
5805
+
5806
+ # Defines the hand off to a live agent, typically on which external agent
5807
+ # service provider to connect to a conversation. Currently, this feature is not
5808
+ # general available, please contact Google to get access.
5809
+ # Corresponds to the JSON property `humanAgentHandoffConfig`
5810
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentHandoffConfig]
5811
+ attr_accessor :human_agent_handoff_config
5812
+
5813
+ # Language which represents the conversationProfile. If unspecified, the default
5814
+ # language code en-us applies. Users need to create a ConversationProfile for
5815
+ # each language they want to support.
5816
+ # Corresponds to the JSON property `languageCode`
5817
+ # @return [String]
5818
+ attr_accessor :language_code
5819
+
5820
+ # Defines logging behavior for conversation lifecycle events.
5821
+ # Corresponds to the JSON property `loggingConfig`
5822
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2LoggingConfig]
5823
+ attr_accessor :logging_config
5824
+
5825
+ # The unique identifier of this conversation profile. Format: `projects//
5826
+ # locations//conversationProfiles/`.
5827
+ # Corresponds to the JSON property `name`
5828
+ # @return [String]
5829
+ attr_accessor :name
5830
+
5831
+ # Defines notification behavior.
5832
+ # Corresponds to the JSON property `newMessageEventNotificationConfig`
5833
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig]
5834
+ attr_accessor :new_message_event_notification_config
5835
+
5836
+ # Defines notification behavior.
5837
+ # Corresponds to the JSON property `notificationConfig`
5838
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig]
5839
+ attr_accessor :notification_config
5840
+
5841
+ # Configures speech transcription for ConversationProfile.
5842
+ # Corresponds to the JSON property `sttConfig`
5843
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SpeechToTextConfig]
5844
+ attr_accessor :stt_config
5845
+
5846
+ # Output only. Update time of the conversation profile.
5847
+ # Corresponds to the JSON property `updateTime`
5848
+ # @return [String]
5849
+ attr_accessor :update_time
5850
+
5851
+ def initialize(**args)
5852
+ update!(**args)
5853
+ end
5854
+
5855
+ # Update properties of this object
5856
+ def update!(**args)
5857
+ @automated_agent_config = args[:automated_agent_config] if args.key?(:automated_agent_config)
5858
+ @create_time = args[:create_time] if args.key?(:create_time)
5859
+ @display_name = args[:display_name] if args.key?(:display_name)
5860
+ @human_agent_assistant_config = args[:human_agent_assistant_config] if args.key?(:human_agent_assistant_config)
5861
+ @human_agent_handoff_config = args[:human_agent_handoff_config] if args.key?(:human_agent_handoff_config)
5862
+ @language_code = args[:language_code] if args.key?(:language_code)
5863
+ @logging_config = args[:logging_config] if args.key?(:logging_config)
5864
+ @name = args[:name] if args.key?(:name)
5865
+ @new_message_event_notification_config = args[:new_message_event_notification_config] if args.key?(:new_message_event_notification_config)
5866
+ @notification_config = args[:notification_config] if args.key?(:notification_config)
5867
+ @stt_config = args[:stt_config] if args.key?(:stt_config)
5868
+ @update_time = args[:update_time] if args.key?(:update_time)
5869
+ end
5870
+ end
5871
+
5872
+ # The request to detect user's intent.
5873
+ class GoogleCloudDialogflowV2DetectIntentRequest
5874
+ include Google::Apis::Core::Hashable
5875
+
5876
+ # The natural language speech audio to be processed. This field should be
5877
+ # populated iff `query_input` is set to an input audio config. A single request
5258
5878
  # can contain up to 1 minute of speech audio data.
5259
5879
  # Corresponds to the JSON property `inputAudio`
5260
5880
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
@@ -5362,6 +5982,150 @@ module Google
5362
5982
  end
5363
5983
  end
5364
5984
 
5985
+ # A knowledge document to be used by a KnowledgeBase. For more information, see
5986
+ # the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/
5987
+ # knowledge-bases). Note: The `projects.agent.knowledgeBases.documents` resource
5988
+ # is deprecated; only use `projects.knowledgeBases.documents`.
5989
+ class GoogleCloudDialogflowV2Document
5990
+ include Google::Apis::Core::Hashable
5991
+
5992
+ # The URI where the file content is located. For documents stored in Google
5993
+ # Cloud Storage, these URIs must have the form `gs:///`. NOTE: External URLs
5994
+ # must correspond to public webpages, i.e., they must be indexed by Google
5995
+ # Search. In particular, URLs for showing documents in Google Cloud Storage (i.e.
5996
+ # the URL in your browser) are not supported. Instead use the `gs://` format
5997
+ # URI described above.
5998
+ # Corresponds to the JSON property `contentUri`
5999
+ # @return [String]
6000
+ attr_accessor :content_uri
6001
+
6002
+ # Required. The display name of the document. The name must be 1024 bytes or
6003
+ # less; otherwise, the creation request fails.
6004
+ # Corresponds to the JSON property `displayName`
6005
+ # @return [String]
6006
+ attr_accessor :display_name
6007
+
6008
+ # Optional. If true, we try to automatically reload the document every day (at a
6009
+ # time picked by the system). If false or unspecified, we don't try to
6010
+ # automatically reload the document. Currently you can only enable automatic
6011
+ # reload for documents sourced from a public url, see `source` field for the
6012
+ # source types. Reload status can be tracked in `latest_reload_status`. If a
6013
+ # reload fails, we will keep the document unchanged. If a reload fails with
6014
+ # internal errors, the system will try to reload the document on the next day.
6015
+ # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
6016
+ # system will not try to reload the document anymore. You need to manually
6017
+ # reload the document successfully by calling `ReloadDocument` and clear the
6018
+ # errors.
6019
+ # Corresponds to the JSON property `enableAutoReload`
6020
+ # @return [Boolean]
6021
+ attr_accessor :enable_auto_reload
6022
+ alias_method :enable_auto_reload?, :enable_auto_reload
6023
+
6024
+ # Required. The knowledge type of document content.
6025
+ # Corresponds to the JSON property `knowledgeTypes`
6026
+ # @return [Array<String>]
6027
+ attr_accessor :knowledge_types
6028
+
6029
+ # The status of a reload attempt.
6030
+ # Corresponds to the JSON property `latestReloadStatus`
6031
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DocumentReloadStatus]
6032
+ attr_accessor :latest_reload_status
6033
+
6034
+ # Optional. Metadata for the document. The metadata supports arbitrary key-value
6035
+ # pairs. Suggested use cases include storing a document's title, an external URL
6036
+ # distinct from the document's content_uri, etc. The max size of a `key` or a `
6037
+ # value` of the metadata is 1024 bytes.
6038
+ # Corresponds to the JSON property `metadata`
6039
+ # @return [Hash<String,String>]
6040
+ attr_accessor :metadata
6041
+
6042
+ # Required. The MIME type of this document.
6043
+ # Corresponds to the JSON property `mimeType`
6044
+ # @return [String]
6045
+ attr_accessor :mime_type
6046
+
6047
+ # Optional. The document resource name. The name must be empty when creating a
6048
+ # document. Format: `projects//locations//knowledgeBases//documents/`.
6049
+ # Corresponds to the JSON property `name`
6050
+ # @return [String]
6051
+ attr_accessor :name
6052
+
6053
+ # The raw content of the document. This field is only permitted for
6054
+ # EXTRACTIVE_QA and FAQ knowledge types.
6055
+ # Corresponds to the JSON property `rawContent`
6056
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
6057
+ # @return [String]
6058
+ attr_accessor :raw_content
6059
+
6060
+ def initialize(**args)
6061
+ update!(**args)
6062
+ end
6063
+
6064
+ # Update properties of this object
6065
+ def update!(**args)
6066
+ @content_uri = args[:content_uri] if args.key?(:content_uri)
6067
+ @display_name = args[:display_name] if args.key?(:display_name)
6068
+ @enable_auto_reload = args[:enable_auto_reload] if args.key?(:enable_auto_reload)
6069
+ @knowledge_types = args[:knowledge_types] if args.key?(:knowledge_types)
6070
+ @latest_reload_status = args[:latest_reload_status] if args.key?(:latest_reload_status)
6071
+ @metadata = args[:metadata] if args.key?(:metadata)
6072
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
6073
+ @name = args[:name] if args.key?(:name)
6074
+ @raw_content = args[:raw_content] if args.key?(:raw_content)
6075
+ end
6076
+ end
6077
+
6078
+ # The status of a reload attempt.
6079
+ class GoogleCloudDialogflowV2DocumentReloadStatus
6080
+ include Google::Apis::Core::Hashable
6081
+
6082
+ # The `Status` type defines a logical error model that is suitable for different
6083
+ # programming environments, including REST APIs and RPC APIs. It is used by [
6084
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
6085
+ # data: error code, error message, and error details. You can find out more
6086
+ # about this error model and how to work with it in the [API Design Guide](https:
6087
+ # //cloud.google.com/apis/design/errors).
6088
+ # Corresponds to the JSON property `status`
6089
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
6090
+ attr_accessor :status
6091
+
6092
+ # The time of a reload attempt. This reload may have been triggered
6093
+ # automatically or manually and may not have succeeded.
6094
+ # Corresponds to the JSON property `time`
6095
+ # @return [String]
6096
+ attr_accessor :time
6097
+
6098
+ def initialize(**args)
6099
+ update!(**args)
6100
+ end
6101
+
6102
+ # Update properties of this object
6103
+ def update!(**args)
6104
+ @status = args[:status] if args.key?(:status)
6105
+ @time = args[:time] if args.key?(:time)
6106
+ end
6107
+ end
6108
+
6109
+ # The message in the response that indicates the parameters of DTMF.
6110
+ class GoogleCloudDialogflowV2DtmfParameters
6111
+ include Google::Apis::Core::Hashable
6112
+
6113
+ # Indicates whether DTMF input can be handled in the next request.
6114
+ # Corresponds to the JSON property `acceptsDtmfInput`
6115
+ # @return [Boolean]
6116
+ attr_accessor :accepts_dtmf_input
6117
+ alias_method :accepts_dtmf_input?, :accepts_dtmf_input
6118
+
6119
+ def initialize(**args)
6120
+ update!(**args)
6121
+ end
6122
+
6123
+ # Update properties of this object
6124
+ def update!(**args)
6125
+ @accepts_dtmf_input = args[:accepts_dtmf_input] if args.key?(:accepts_dtmf_input)
6126
+ end
6127
+ end
6128
+
5365
6129
  # Each intent parameter has a type, called the entity type, which dictates
5366
6130
  # exactly how data from an end-user expression is extracted. Dialogflow provides
5367
6131
  # predefined system entities that can match many common types of data. For
@@ -5623,6 +6387,60 @@ module Google
5623
6387
  end
5624
6388
  end
5625
6389
 
6390
+ # Represents answer from "frequently asked questions".
6391
+ class GoogleCloudDialogflowV2FaqAnswer
6392
+ include Google::Apis::Core::Hashable
6393
+
6394
+ # The piece of text from the `source` knowledge base document.
6395
+ # Corresponds to the JSON property `answer`
6396
+ # @return [String]
6397
+ attr_accessor :answer
6398
+
6399
+ # The name of answer record, in the format of "projects//locations//
6400
+ # answerRecords/"
6401
+ # Corresponds to the JSON property `answerRecord`
6402
+ # @return [String]
6403
+ attr_accessor :answer_record
6404
+
6405
+ # The system's confidence score that this Knowledge answer is a good match for
6406
+ # this conversational query, range from 0.0 (completely uncertain) to 1.0 (
6407
+ # completely certain).
6408
+ # Corresponds to the JSON property `confidence`
6409
+ # @return [Float]
6410
+ attr_accessor :confidence
6411
+
6412
+ # A map that contains metadata about the answer and the document from which it
6413
+ # originates.
6414
+ # Corresponds to the JSON property `metadata`
6415
+ # @return [Hash<String,String>]
6416
+ attr_accessor :metadata
6417
+
6418
+ # The corresponding FAQ question.
6419
+ # Corresponds to the JSON property `question`
6420
+ # @return [String]
6421
+ attr_accessor :question
6422
+
6423
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
6424
+ # projects//locations//agent/knowledgeBases//documents/`.
6425
+ # Corresponds to the JSON property `source`
6426
+ # @return [String]
6427
+ attr_accessor :source
6428
+
6429
+ def initialize(**args)
6430
+ update!(**args)
6431
+ end
6432
+
6433
+ # Update properties of this object
6434
+ def update!(**args)
6435
+ @answer = args[:answer] if args.key?(:answer)
6436
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
6437
+ @confidence = args[:confidence] if args.key?(:confidence)
6438
+ @metadata = args[:metadata] if args.key?(:metadata)
6439
+ @question = args[:question] if args.key?(:question)
6440
+ @source = args[:source] if args.key?(:source)
6441
+ end
6442
+ end
6443
+
5626
6444
  # By default, your agent responds to a matched intent with a static response. As
5627
6445
  # an alternative, you can provide a more dynamic response by using fulfillment.
5628
6446
  # When you enable fulfillment for an intent, Dialogflow responds to that intent
@@ -5680,14 +6498,511 @@ module Google
5680
6498
  end
5681
6499
  end
5682
6500
 
5683
- # Whether fulfillment is enabled for the specific feature.
5684
- class GoogleCloudDialogflowV2FulfillmentFeature
6501
+ # Whether fulfillment is enabled for the specific feature.
6502
+ class GoogleCloudDialogflowV2FulfillmentFeature
6503
+ include Google::Apis::Core::Hashable
6504
+
6505
+ # The type of the feature that enabled for fulfillment.
6506
+ # Corresponds to the JSON property `type`
6507
+ # @return [String]
6508
+ attr_accessor :type
6509
+
6510
+ def initialize(**args)
6511
+ update!(**args)
6512
+ end
6513
+
6514
+ # Update properties of this object
6515
+ def update!(**args)
6516
+ @type = args[:type] if args.key?(:type)
6517
+ end
6518
+ end
6519
+
6520
+ # Represents configuration for a generic web service. Dialogflow supports two
6521
+ # mechanisms for authentications: - Basic authentication with username and
6522
+ # password. - Authentication with additional authentication headers. More
6523
+ # information could be found at: https://cloud.google.com/dialogflow/docs/
6524
+ # fulfillment-configure.
6525
+ class GoogleCloudDialogflowV2FulfillmentGenericWebService
6526
+ include Google::Apis::Core::Hashable
6527
+
6528
+ # Optional. Indicates if generic web service is created through Cloud Functions
6529
+ # integration. Defaults to false.
6530
+ # Corresponds to the JSON property `isCloudFunction`
6531
+ # @return [Boolean]
6532
+ attr_accessor :is_cloud_function
6533
+ alias_method :is_cloud_function?, :is_cloud_function
6534
+
6535
+ # Optional. The password for HTTP Basic authentication.
6536
+ # Corresponds to the JSON property `password`
6537
+ # @return [String]
6538
+ attr_accessor :password
6539
+
6540
+ # Optional. The HTTP request headers to send together with fulfillment requests.
6541
+ # Corresponds to the JSON property `requestHeaders`
6542
+ # @return [Hash<String,String>]
6543
+ attr_accessor :request_headers
6544
+
6545
+ # Required. The fulfillment URI for receiving POST requests. It must use https
6546
+ # protocol.
6547
+ # Corresponds to the JSON property `uri`
6548
+ # @return [String]
6549
+ attr_accessor :uri
6550
+
6551
+ # Optional. The user name for HTTP Basic authentication.
6552
+ # Corresponds to the JSON property `username`
6553
+ # @return [String]
6554
+ attr_accessor :username
6555
+
6556
+ def initialize(**args)
6557
+ update!(**args)
6558
+ end
6559
+
6560
+ # Update properties of this object
6561
+ def update!(**args)
6562
+ @is_cloud_function = args[:is_cloud_function] if args.key?(:is_cloud_function)
6563
+ @password = args[:password] if args.key?(:password)
6564
+ @request_headers = args[:request_headers] if args.key?(:request_headers)
6565
+ @uri = args[:uri] if args.key?(:uri)
6566
+ @username = args[:username] if args.key?(:username)
6567
+ end
6568
+ end
6569
+
6570
+ # Defines the Human Agent Assist to connect to a conversation.
6571
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfig
6572
+ include Google::Apis::Core::Hashable
6573
+
6574
+ # Detail human agent assistant config.
6575
+ # Corresponds to the JSON property `endUserSuggestionConfig`
6576
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig]
6577
+ attr_accessor :end_user_suggestion_config
6578
+
6579
+ # Detail human agent assistant config.
6580
+ # Corresponds to the JSON property `humanAgentSuggestionConfig`
6581
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig]
6582
+ attr_accessor :human_agent_suggestion_config
6583
+
6584
+ # Configuration for analyses to run on each conversation message.
6585
+ # Corresponds to the JSON property `messageAnalysisConfig`
6586
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig]
6587
+ attr_accessor :message_analysis_config
6588
+
6589
+ # Defines notification behavior.
6590
+ # Corresponds to the JSON property `notificationConfig`
6591
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig]
6592
+ attr_accessor :notification_config
6593
+
6594
+ def initialize(**args)
6595
+ update!(**args)
6596
+ end
6597
+
6598
+ # Update properties of this object
6599
+ def update!(**args)
6600
+ @end_user_suggestion_config = args[:end_user_suggestion_config] if args.key?(:end_user_suggestion_config)
6601
+ @human_agent_suggestion_config = args[:human_agent_suggestion_config] if args.key?(:human_agent_suggestion_config)
6602
+ @message_analysis_config = args[:message_analysis_config] if args.key?(:message_analysis_config)
6603
+ @notification_config = args[:notification_config] if args.key?(:notification_config)
6604
+ end
6605
+ end
6606
+
6607
+ # Custom conversation models used in agent assist feature. Supported feature:
6608
+ # ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY.
6609
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig
6610
+ include Google::Apis::Core::Hashable
6611
+
6612
+ # Required. Conversation model resource name. Format: `projects//
6613
+ # conversationModels/`.
6614
+ # Corresponds to the JSON property `model`
6615
+ # @return [String]
6616
+ attr_accessor :model
6617
+
6618
+ def initialize(**args)
6619
+ update!(**args)
6620
+ end
6621
+
6622
+ # Update properties of this object
6623
+ def update!(**args)
6624
+ @model = args[:model] if args.key?(:model)
6625
+ end
6626
+ end
6627
+
6628
+ # Configuration for analyses to run on each conversation message.
6629
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig
6630
+ include Google::Apis::Core::Hashable
6631
+
6632
+ # Enable entity extraction in conversation messages on [agent assist stage](
6633
+ # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
6634
+ # If unspecified, defaults to false. Currently, this feature is not general
6635
+ # available, please contact Google to get access.
6636
+ # Corresponds to the JSON property `enableEntityExtraction`
6637
+ # @return [Boolean]
6638
+ attr_accessor :enable_entity_extraction
6639
+ alias_method :enable_entity_extraction?, :enable_entity_extraction
6640
+
6641
+ # Enable sentiment analysis in conversation messages on [agent assist stage](
6642
+ # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
6643
+ # If unspecified, defaults to false. Sentiment analysis inspects user input and
6644
+ # identifies the prevailing subjective opinion, especially to determine a user's
6645
+ # attitude as positive, negative, or neutral: https://cloud.google.com/natural-
6646
+ # language/docs/basics#sentiment_analysis For Participants.
6647
+ # StreamingAnalyzeContent method, result will be in
6648
+ # StreamingAnalyzeContentResponse.message.SentimentAnalysisResult. For
6649
+ # Participants.AnalyzeContent method, result will be in AnalyzeContentResponse.
6650
+ # message.SentimentAnalysisResult For Conversations.ListMessages method, result
6651
+ # will be in ListMessagesResponse.messages.SentimentAnalysisResult If Pub/Sub
6652
+ # notification is configured, result will be in ConversationEvent.
6653
+ # new_message_payload.SentimentAnalysisResult.
6654
+ # Corresponds to the JSON property `enableSentimentAnalysis`
6655
+ # @return [Boolean]
6656
+ attr_accessor :enable_sentiment_analysis
6657
+ alias_method :enable_sentiment_analysis?, :enable_sentiment_analysis
6658
+
6659
+ def initialize(**args)
6660
+ update!(**args)
6661
+ end
6662
+
6663
+ # Update properties of this object
6664
+ def update!(**args)
6665
+ @enable_entity_extraction = args[:enable_entity_extraction] if args.key?(:enable_entity_extraction)
6666
+ @enable_sentiment_analysis = args[:enable_sentiment_analysis] if args.key?(:enable_sentiment_analysis)
6667
+ end
6668
+ end
6669
+
6670
+ # Detail human agent assistant config.
6671
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig
6672
+ include Google::Apis::Core::Hashable
6673
+
6674
+ # Configuration of different suggestion features. One feature can have only one
6675
+ # config.
6676
+ # Corresponds to the JSON property `featureConfigs`
6677
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig>]
6678
+ attr_accessor :feature_configs
6679
+
6680
+ # If `group_suggestion_responses` is false, and there are multiple `
6681
+ # feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we
6682
+ # will try to deliver suggestions to customers as soon as we get new suggestion.
6683
+ # Different type of suggestions based on the same context will be in separate
6684
+ # Pub/Sub event or `StreamingAnalyzeContentResponse`. If `
6685
+ # group_suggestion_responses` set to true. All the suggestions to the same
6686
+ # participant based on the same context will be grouped into a single Pub/Sub
6687
+ # event or StreamingAnalyzeContentResponse.
6688
+ # Corresponds to the JSON property `groupSuggestionResponses`
6689
+ # @return [Boolean]
6690
+ attr_accessor :group_suggestion_responses
6691
+ alias_method :group_suggestion_responses?, :group_suggestion_responses
6692
+
6693
+ def initialize(**args)
6694
+ update!(**args)
6695
+ end
6696
+
6697
+ # Update properties of this object
6698
+ def update!(**args)
6699
+ @feature_configs = args[:feature_configs] if args.key?(:feature_configs)
6700
+ @group_suggestion_responses = args[:group_suggestion_responses] if args.key?(:group_suggestion_responses)
6701
+ end
6702
+ end
6703
+
6704
+ # Config for suggestion features.
6705
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig
6706
+ include Google::Apis::Core::Hashable
6707
+
6708
+ # Custom conversation models used in agent assist feature. Supported feature:
6709
+ # ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY.
6710
+ # Corresponds to the JSON property `conversationModelConfig`
6711
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig]
6712
+ attr_accessor :conversation_model_config
6713
+
6714
+ # Automatically iterates all participants and tries to compile suggestions.
6715
+ # Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST.
6716
+ # Corresponds to the JSON property `enableEventBasedSuggestion`
6717
+ # @return [Boolean]
6718
+ attr_accessor :enable_event_based_suggestion
6719
+ alias_method :enable_event_based_suggestion?, :enable_event_based_suggestion
6720
+
6721
+ # Config for suggestion query.
6722
+ # Corresponds to the JSON property `queryConfig`
6723
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig]
6724
+ attr_accessor :query_config
6725
+
6726
+ # The type of Human Agent Assistant API suggestion to perform, and the maximum
6727
+ # number of results to return for that type. Multiple `Feature` objects can be
6728
+ # specified in the `features` list.
6729
+ # Corresponds to the JSON property `suggestionFeature`
6730
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionFeature]
6731
+ attr_accessor :suggestion_feature
6732
+
6733
+ # Settings of suggestion trigger.
6734
+ # Corresponds to the JSON property `suggestionTriggerSettings`
6735
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionTriggerSettings]
6736
+ attr_accessor :suggestion_trigger_settings
6737
+
6738
+ def initialize(**args)
6739
+ update!(**args)
6740
+ end
6741
+
6742
+ # Update properties of this object
6743
+ def update!(**args)
6744
+ @conversation_model_config = args[:conversation_model_config] if args.key?(:conversation_model_config)
6745
+ @enable_event_based_suggestion = args[:enable_event_based_suggestion] if args.key?(:enable_event_based_suggestion)
6746
+ @query_config = args[:query_config] if args.key?(:query_config)
6747
+ @suggestion_feature = args[:suggestion_feature] if args.key?(:suggestion_feature)
6748
+ @suggestion_trigger_settings = args[:suggestion_trigger_settings] if args.key?(:suggestion_trigger_settings)
6749
+ end
6750
+ end
6751
+
6752
+ # Config for suggestion query.
6753
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig
6754
+ include Google::Apis::Core::Hashable
6755
+
6756
+ # Confidence threshold of query result. Agent Assist gives each suggestion a
6757
+ # score in the range [0.0, 1.0], based on the relevance between the suggestion
6758
+ # and the current conversation context. A score of 0.0 has no relevance, while a
6759
+ # score of 1.0 has high relevance. Only suggestions with a score greater than or
6760
+ # equal to the value of this field are included in the results. For a baseline
6761
+ # model (the default), the recommended value is in the range [0.05, 0.1]. For a
6762
+ # custom model, there is no recommended value. Tune this value by starting from
6763
+ # a very low value and slowly increasing until you have desired results. If this
6764
+ # field is not set, it defaults to 0.0, which means that all suggestions are
6765
+ # returned. Supported features: ARTICLE_SUGGESTION.
6766
+ # Corresponds to the JSON property `confidenceThreshold`
6767
+ # @return [Float]
6768
+ attr_accessor :confidence_threshold
6769
+
6770
+ # Settings that determine how to filter recent conversation context when
6771
+ # generating suggestions.
6772
+ # Corresponds to the JSON property `contextFilterSettings`
6773
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings]
6774
+ attr_accessor :context_filter_settings
6775
+
6776
+ # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST.
6777
+ # Corresponds to the JSON property `dialogflowQuerySource`
6778
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource]
6779
+ attr_accessor :dialogflow_query_source
6780
+
6781
+ # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE.
6782
+ # Corresponds to the JSON property `documentQuerySource`
6783
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource]
6784
+ attr_accessor :document_query_source
6785
+
6786
+ # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ.
6787
+ # Corresponds to the JSON property `knowledgeBaseQuerySource`
6788
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource]
6789
+ attr_accessor :knowledge_base_query_source
6790
+
6791
+ # Maximum number of results to return. Currently, if unset, defaults to 10. And
6792
+ # the max number is 20.
6793
+ # Corresponds to the JSON property `maxResults`
6794
+ # @return [Fixnum]
6795
+ attr_accessor :max_results
6796
+
6797
+ def initialize(**args)
6798
+ update!(**args)
6799
+ end
6800
+
6801
+ # Update properties of this object
6802
+ def update!(**args)
6803
+ @confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold)
6804
+ @context_filter_settings = args[:context_filter_settings] if args.key?(:context_filter_settings)
6805
+ @dialogflow_query_source = args[:dialogflow_query_source] if args.key?(:dialogflow_query_source)
6806
+ @document_query_source = args[:document_query_source] if args.key?(:document_query_source)
6807
+ @knowledge_base_query_source = args[:knowledge_base_query_source] if args.key?(:knowledge_base_query_source)
6808
+ @max_results = args[:max_results] if args.key?(:max_results)
6809
+ end
6810
+ end
6811
+
6812
+ # Settings that determine how to filter recent conversation context when
6813
+ # generating suggestions.
6814
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings
6815
+ include Google::Apis::Core::Hashable
6816
+
6817
+ # If set to true, the last message from virtual agent (hand off message) and the
6818
+ # message before it (trigger message of hand off) are dropped.
6819
+ # Corresponds to the JSON property `dropHandoffMessages`
6820
+ # @return [Boolean]
6821
+ attr_accessor :drop_handoff_messages
6822
+ alias_method :drop_handoff_messages?, :drop_handoff_messages
6823
+
6824
+ # If set to true, all messages from ivr stage are dropped.
6825
+ # Corresponds to the JSON property `dropIvrMessages`
6826
+ # @return [Boolean]
6827
+ attr_accessor :drop_ivr_messages
6828
+ alias_method :drop_ivr_messages?, :drop_ivr_messages
6829
+
6830
+ # If set to true, all messages from virtual agent are dropped.
6831
+ # Corresponds to the JSON property `dropVirtualAgentMessages`
6832
+ # @return [Boolean]
6833
+ attr_accessor :drop_virtual_agent_messages
6834
+ alias_method :drop_virtual_agent_messages?, :drop_virtual_agent_messages
6835
+
6836
+ def initialize(**args)
6837
+ update!(**args)
6838
+ end
6839
+
6840
+ # Update properties of this object
6841
+ def update!(**args)
6842
+ @drop_handoff_messages = args[:drop_handoff_messages] if args.key?(:drop_handoff_messages)
6843
+ @drop_ivr_messages = args[:drop_ivr_messages] if args.key?(:drop_ivr_messages)
6844
+ @drop_virtual_agent_messages = args[:drop_virtual_agent_messages] if args.key?(:drop_virtual_agent_messages)
6845
+ end
6846
+ end
6847
+
6848
+ # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST.
6849
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource
6850
+ include Google::Apis::Core::Hashable
6851
+
6852
+ # Required. The name of a Dialogflow virtual agent used for end user side intent
6853
+ # detection and suggestion. Format: `projects//locations//agent`. When multiple
6854
+ # agents are allowed in the same Dialogflow project.
6855
+ # Corresponds to the JSON property `agent`
6856
+ # @return [String]
6857
+ attr_accessor :agent
6858
+
6859
+ def initialize(**args)
6860
+ update!(**args)
6861
+ end
6862
+
6863
+ # Update properties of this object
6864
+ def update!(**args)
6865
+ @agent = args[:agent] if args.key?(:agent)
6866
+ end
6867
+ end
6868
+
6869
+ # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE.
6870
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource
6871
+ include Google::Apis::Core::Hashable
6872
+
6873
+ # Required. Knowledge documents to query from. Format: `projects//locations//
6874
+ # knowledgeBases//documents/`. Currently, at most 5 documents are supported.
6875
+ # Corresponds to the JSON property `documents`
6876
+ # @return [Array<String>]
6877
+ attr_accessor :documents
6878
+
6879
+ def initialize(**args)
6880
+ update!(**args)
6881
+ end
6882
+
6883
+ # Update properties of this object
6884
+ def update!(**args)
6885
+ @documents = args[:documents] if args.key?(:documents)
6886
+ end
6887
+ end
6888
+
6889
+ # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ.
6890
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource
6891
+ include Google::Apis::Core::Hashable
6892
+
6893
+ # Required. Knowledge bases to query. Format: `projects//locations//
6894
+ # knowledgeBases/`. Currently, at most 5 knowledge bases are supported.
6895
+ # Corresponds to the JSON property `knowledgeBases`
6896
+ # @return [Array<String>]
6897
+ attr_accessor :knowledge_bases
6898
+
6899
+ def initialize(**args)
6900
+ update!(**args)
6901
+ end
6902
+
6903
+ # Update properties of this object
6904
+ def update!(**args)
6905
+ @knowledge_bases = args[:knowledge_bases] if args.key?(:knowledge_bases)
6906
+ end
6907
+ end
6908
+
6909
+ # Settings of suggestion trigger.
6910
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionTriggerSettings
6911
+ include Google::Apis::Core::Hashable
6912
+
6913
+ # Do not trigger if last utterance is small talk.
6914
+ # Corresponds to the JSON property `noSmalltalk`
6915
+ # @return [Boolean]
6916
+ attr_accessor :no_smalltalk
6917
+ alias_method :no_smalltalk?, :no_smalltalk
6918
+
6919
+ # Only trigger suggestion if participant role of last utterance is END_USER.
6920
+ # Corresponds to the JSON property `onlyEndUser`
6921
+ # @return [Boolean]
6922
+ attr_accessor :only_end_user
6923
+ alias_method :only_end_user?, :only_end_user
6924
+
6925
+ def initialize(**args)
6926
+ update!(**args)
6927
+ end
6928
+
6929
+ # Update properties of this object
6930
+ def update!(**args)
6931
+ @no_smalltalk = args[:no_smalltalk] if args.key?(:no_smalltalk)
6932
+ @only_end_user = args[:only_end_user] if args.key?(:only_end_user)
6933
+ end
6934
+ end
6935
+
6936
+ # Represents a notification sent to Cloud Pub/Sub subscribers for human agent
6937
+ # assistant events in a specific conversation.
6938
+ class GoogleCloudDialogflowV2HumanAgentAssistantEvent
6939
+ include Google::Apis::Core::Hashable
6940
+
6941
+ # The conversation this notification refers to. Format: `projects//conversations/
6942
+ # `.
6943
+ # Corresponds to the JSON property `conversation`
6944
+ # @return [String]
6945
+ attr_accessor :conversation
6946
+
6947
+ # The participant that the suggestion is compiled for. Format: `projects//
6948
+ # conversations//participants/`. It will not be set in legacy workflow.
6949
+ # Corresponds to the JSON property `participant`
6950
+ # @return [String]
6951
+ attr_accessor :participant
6952
+
6953
+ # The suggestion results payload that this notification refers to.
6954
+ # Corresponds to the JSON property `suggestionResults`
6955
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionResult>]
6956
+ attr_accessor :suggestion_results
6957
+
6958
+ def initialize(**args)
6959
+ update!(**args)
6960
+ end
6961
+
6962
+ # Update properties of this object
6963
+ def update!(**args)
6964
+ @conversation = args[:conversation] if args.key?(:conversation)
6965
+ @participant = args[:participant] if args.key?(:participant)
6966
+ @suggestion_results = args[:suggestion_results] if args.key?(:suggestion_results)
6967
+ end
6968
+ end
6969
+
6970
+ # Defines the hand off to a live agent, typically on which external agent
6971
+ # service provider to connect to a conversation. Currently, this feature is not
6972
+ # general available, please contact Google to get access.
6973
+ class GoogleCloudDialogflowV2HumanAgentHandoffConfig
6974
+ include Google::Apis::Core::Hashable
6975
+
6976
+ # Configuration specific to LivePerson (https://www.liveperson.com).
6977
+ # Corresponds to the JSON property `livePersonConfig`
6978
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentHandoffConfigLivePersonConfig]
6979
+ attr_accessor :live_person_config
6980
+
6981
+ # Configuration specific to Salesforce Live Agent.
6982
+ # Corresponds to the JSON property `salesforceLiveAgentConfig`
6983
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentHandoffConfigSalesforceLiveAgentConfig]
6984
+ attr_accessor :salesforce_live_agent_config
6985
+
6986
+ def initialize(**args)
6987
+ update!(**args)
6988
+ end
6989
+
6990
+ # Update properties of this object
6991
+ def update!(**args)
6992
+ @live_person_config = args[:live_person_config] if args.key?(:live_person_config)
6993
+ @salesforce_live_agent_config = args[:salesforce_live_agent_config] if args.key?(:salesforce_live_agent_config)
6994
+ end
6995
+ end
6996
+
6997
+ # Configuration specific to LivePerson (https://www.liveperson.com).
6998
+ class GoogleCloudDialogflowV2HumanAgentHandoffConfigLivePersonConfig
5685
6999
  include Google::Apis::Core::Hashable
5686
7000
 
5687
- # The type of the feature that enabled for fulfillment.
5688
- # Corresponds to the JSON property `type`
7001
+ # Required. Account number of the LivePerson account to connect. This is the
7002
+ # account number you input at the login page.
7003
+ # Corresponds to the JSON property `accountNumber`
5689
7004
  # @return [String]
5690
- attr_accessor :type
7005
+ attr_accessor :account_number
5691
7006
 
5692
7007
  def initialize(**args)
5693
7008
  update!(**args)
@@ -5695,45 +7010,36 @@ module Google
5695
7010
 
5696
7011
  # Update properties of this object
5697
7012
  def update!(**args)
5698
- @type = args[:type] if args.key?(:type)
7013
+ @account_number = args[:account_number] if args.key?(:account_number)
5699
7014
  end
5700
7015
  end
5701
7016
 
5702
- # Represents configuration for a generic web service. Dialogflow supports two
5703
- # mechanisms for authentications: - Basic authentication with username and
5704
- # password. - Authentication with additional authentication headers. More
5705
- # information could be found at: https://cloud.google.com/dialogflow/docs/
5706
- # fulfillment-configure.
5707
- class GoogleCloudDialogflowV2FulfillmentGenericWebService
7017
+ # Configuration specific to Salesforce Live Agent.
7018
+ class GoogleCloudDialogflowV2HumanAgentHandoffConfigSalesforceLiveAgentConfig
5708
7019
  include Google::Apis::Core::Hashable
5709
7020
 
5710
- # Optional. Indicates if generic web service is created through Cloud Functions
5711
- # integration. Defaults to false.
5712
- # Corresponds to the JSON property `isCloudFunction`
5713
- # @return [Boolean]
5714
- attr_accessor :is_cloud_function
5715
- alias_method :is_cloud_function?, :is_cloud_function
5716
-
5717
- # Optional. The password for HTTP Basic authentication.
5718
- # Corresponds to the JSON property `password`
7021
+ # Required. Live Agent chat button ID.
7022
+ # Corresponds to the JSON property `buttonId`
5719
7023
  # @return [String]
5720
- attr_accessor :password
7024
+ attr_accessor :button_id
5721
7025
 
5722
- # Optional. The HTTP request headers to send together with fulfillment requests.
5723
- # Corresponds to the JSON property `requestHeaders`
5724
- # @return [Hash<String,String>]
5725
- attr_accessor :request_headers
7026
+ # Required. Live Agent deployment ID.
7027
+ # Corresponds to the JSON property `deploymentId`
7028
+ # @return [String]
7029
+ attr_accessor :deployment_id
5726
7030
 
5727
- # Required. The fulfillment URI for receiving POST requests. It must use https
5728
- # protocol.
5729
- # Corresponds to the JSON property `uri`
7031
+ # Required. Domain of the Live Agent endpoint for this agent. You can find the
7032
+ # endpoint URL in the `Live Agent settings` page. For example if URL has the
7033
+ # form https://d.la4-c2-phx.salesforceliveagent.com/..., you should fill in d.
7034
+ # la4-c2-phx.salesforceliveagent.com.
7035
+ # Corresponds to the JSON property `endpointDomain`
5730
7036
  # @return [String]
5731
- attr_accessor :uri
7037
+ attr_accessor :endpoint_domain
5732
7038
 
5733
- # Optional. The user name for HTTP Basic authentication.
5734
- # Corresponds to the JSON property `username`
7039
+ # Required. The organization ID of the Salesforce account.
7040
+ # Corresponds to the JSON property `organizationId`
5735
7041
  # @return [String]
5736
- attr_accessor :username
7042
+ attr_accessor :organization_id
5737
7043
 
5738
7044
  def initialize(**args)
5739
7045
  update!(**args)
@@ -5741,11 +7047,10 @@ module Google
5741
7047
 
5742
7048
  # Update properties of this object
5743
7049
  def update!(**args)
5744
- @is_cloud_function = args[:is_cloud_function] if args.key?(:is_cloud_function)
5745
- @password = args[:password] if args.key?(:password)
5746
- @request_headers = args[:request_headers] if args.key?(:request_headers)
5747
- @uri = args[:uri] if args.key?(:uri)
5748
- @username = args[:username] if args.key?(:username)
7050
+ @button_id = args[:button_id] if args.key?(:button_id)
7051
+ @deployment_id = args[:deployment_id] if args.key?(:deployment_id)
7052
+ @endpoint_domain = args[:endpoint_domain] if args.key?(:endpoint_domain)
7053
+ @organization_id = args[:organization_id] if args.key?(:organization_id)
5749
7054
  end
5750
7055
  end
5751
7056
 
@@ -5785,6 +7090,14 @@ module Google
5785
7090
  # @return [String]
5786
7091
  attr_accessor :audio_encoding
5787
7092
 
7093
+ # Only used in Participants.AnalyzeContent and Participants.
7094
+ # StreamingAnalyzeContent. If `false` and recognition doesn't return any result,
7095
+ # trigger `NO_SPEECH_RECOGNIZED` event to Dialogflow agent.
7096
+ # Corresponds to the JSON property `disableNoSpeechRecognizedEvent`
7097
+ # @return [Boolean]
7098
+ attr_accessor :disable_no_speech_recognized_event
7099
+ alias_method :disable_no_speech_recognized_event?, :disable_no_speech_recognized_event
7100
+
5788
7101
  # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult
5789
7102
  # with information about the recognized speech words, e.g. start and end time
5790
7103
  # offsets. If false or unspecified, Speech doesn't return any word-level
@@ -5864,6 +7177,7 @@ module Google
5864
7177
  # Update properties of this object
5865
7178
  def update!(**args)
5866
7179
  @audio_encoding = args[:audio_encoding] if args.key?(:audio_encoding)
7180
+ @disable_no_speech_recognized_event = args[:disable_no_speech_recognized_event] if args.key?(:disable_no_speech_recognized_event)
5867
7181
  @enable_word_info = args[:enable_word_info] if args.key?(:enable_word_info)
5868
7182
  @language_code = args[:language_code] if args.key?(:language_code)
5869
7183
  @model = args[:model] if args.key?(:model)
@@ -5902,6 +7216,14 @@ module Google
5902
7216
  # @return [String]
5903
7217
  attr_accessor :display_name
5904
7218
 
7219
+ # Optional. Indicates that this intent ends an interaction. Some integrations (e.
7220
+ # g., Actions on Google or Dialogflow phone gateway) use this information to
7221
+ # close interaction with an end user. Default is false.
7222
+ # Corresponds to the JSON property `endInteraction`
7223
+ # @return [Boolean]
7224
+ attr_accessor :end_interaction
7225
+ alias_method :end_interaction?, :end_interaction
7226
+
5905
7227
  # Optional. The collection of event names that trigger the intent. If the
5906
7228
  # collection of input contexts is not empty, all of the contexts must be present
5907
7229
  # in the active user session for an event to trigger this intent. Event names
@@ -5928,6 +7250,14 @@ module Google
5928
7250
  attr_accessor :is_fallback
5929
7251
  alias_method :is_fallback?, :is_fallback
5930
7252
 
7253
+ # Optional. Indicates that a live agent should be brought in to handle the
7254
+ # interaction with the user. In most cases, when you set this flag to true, you
7255
+ # would also want to set end_interaction to true as well. Default is false.
7256
+ # Corresponds to the JSON property `liveAgentHandoff`
7257
+ # @return [Boolean]
7258
+ attr_accessor :live_agent_handoff
7259
+ alias_method :live_agent_handoff?, :live_agent_handoff
7260
+
5931
7261
  # Optional. The collection of rich messages corresponding to the `Response`
5932
7262
  # field in the Dialogflow console.
5933
7263
  # Corresponds to the JSON property `messages`
@@ -6014,10 +7344,12 @@ module Google
6014
7344
  @action = args[:action] if args.key?(:action)
6015
7345
  @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms)
6016
7346
  @display_name = args[:display_name] if args.key?(:display_name)
7347
+ @end_interaction = args[:end_interaction] if args.key?(:end_interaction)
6017
7348
  @events = args[:events] if args.key?(:events)
6018
7349
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
6019
7350
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
6020
7351
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
7352
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
6021
7353
  @messages = args[:messages] if args.key?(:messages)
6022
7354
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
6023
7355
  @name = args[:name] if args.key?(:name)
@@ -7125,6 +8457,94 @@ module Google
7125
8457
  end
7126
8458
  end
7127
8459
 
8460
+ # A knowledge base represents a collection of knowledge documents that you
8461
+ # provide to Dialogflow. Your knowledge documents contain information that may
8462
+ # be useful during conversations with end-users. Some Dialogflow features use
8463
+ # knowledge bases when looking for a response to an end-user input. For more
8464
+ # information, see the [knowledge base guide](https://cloud.google.com/
8465
+ # dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases`
8466
+ # resource is deprecated; only use `projects.knowledgeBases`.
8467
+ class GoogleCloudDialogflowV2KnowledgeBase
8468
+ include Google::Apis::Core::Hashable
8469
+
8470
+ # Required. The display name of the knowledge base. The name must be 1024 bytes
8471
+ # or less; otherwise, the creation request fails.
8472
+ # Corresponds to the JSON property `displayName`
8473
+ # @return [String]
8474
+ attr_accessor :display_name
8475
+
8476
+ # Language which represents the KnowledgeBase. When the KnowledgeBase is created/
8477
+ # updated, expect this to be present for non en-us languages. When unspecified,
8478
+ # the default language code en-us applies.
8479
+ # Corresponds to the JSON property `languageCode`
8480
+ # @return [String]
8481
+ attr_accessor :language_code
8482
+
8483
+ # The knowledge base resource name. The name must be empty when creating a
8484
+ # knowledge base. Format: `projects//locations//knowledgeBases/`.
8485
+ # Corresponds to the JSON property `name`
8486
+ # @return [String]
8487
+ attr_accessor :name
8488
+
8489
+ def initialize(**args)
8490
+ update!(**args)
8491
+ end
8492
+
8493
+ # Update properties of this object
8494
+ def update!(**args)
8495
+ @display_name = args[:display_name] if args.key?(:display_name)
8496
+ @language_code = args[:language_code] if args.key?(:language_code)
8497
+ @name = args[:name] if args.key?(:name)
8498
+ end
8499
+ end
8500
+
8501
+ # Metadata in google::longrunning::Operation for Knowledge operations.
8502
+ class GoogleCloudDialogflowV2KnowledgeOperationMetadata
8503
+ include Google::Apis::Core::Hashable
8504
+
8505
+ # Output only. The current state of this operation.
8506
+ # Corresponds to the JSON property `state`
8507
+ # @return [String]
8508
+ attr_accessor :state
8509
+
8510
+ def initialize(**args)
8511
+ update!(**args)
8512
+ end
8513
+
8514
+ # Update properties of this object
8515
+ def update!(**args)
8516
+ @state = args[:state] if args.key?(:state)
8517
+ end
8518
+ end
8519
+
8520
+ # Response message for AnswerRecords.ListAnswerRecords.
8521
+ class GoogleCloudDialogflowV2ListAnswerRecordsResponse
8522
+ include Google::Apis::Core::Hashable
8523
+
8524
+ # The list of answer records.
8525
+ # Corresponds to the JSON property `answerRecords`
8526
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord>]
8527
+ attr_accessor :answer_records
8528
+
8529
+ # A token to retrieve next page of results. Or empty if there are no more
8530
+ # results. Pass this value in the ListAnswerRecordsRequest.page_token field in
8531
+ # the subsequent call to `ListAnswerRecords` method to retrieve the next page of
8532
+ # results.
8533
+ # Corresponds to the JSON property `nextPageToken`
8534
+ # @return [String]
8535
+ attr_accessor :next_page_token
8536
+
8537
+ def initialize(**args)
8538
+ update!(**args)
8539
+ end
8540
+
8541
+ # Update properties of this object
8542
+ def update!(**args)
8543
+ @answer_records = args[:answer_records] if args.key?(:answer_records)
8544
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8545
+ end
8546
+ end
8547
+
7128
8548
  # The response message for Contexts.ListContexts.
7129
8549
  class GoogleCloudDialogflowV2ListContextsResponse
7130
8550
  include Google::Apis::Core::Hashable
@@ -7152,15 +8572,175 @@ module Google
7152
8572
  end
7153
8573
  end
7154
8574
 
7155
- # The response message for EntityTypes.ListEntityTypes.
7156
- class GoogleCloudDialogflowV2ListEntityTypesResponse
8575
+ # The response message for ConversationProfiles.ListConversationProfiles.
8576
+ class GoogleCloudDialogflowV2ListConversationProfilesResponse
8577
+ include Google::Apis::Core::Hashable
8578
+
8579
+ # The list of project conversation profiles. There is a maximum number of items
8580
+ # returned based on the page_size field in the request.
8581
+ # Corresponds to the JSON property `conversationProfiles`
8582
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile>]
8583
+ attr_accessor :conversation_profiles
8584
+
8585
+ # Token to retrieve the next page of results, or empty if there are no more
8586
+ # results in the list.
8587
+ # Corresponds to the JSON property `nextPageToken`
8588
+ # @return [String]
8589
+ attr_accessor :next_page_token
8590
+
8591
+ def initialize(**args)
8592
+ update!(**args)
8593
+ end
8594
+
8595
+ # Update properties of this object
8596
+ def update!(**args)
8597
+ @conversation_profiles = args[:conversation_profiles] if args.key?(:conversation_profiles)
8598
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8599
+ end
8600
+ end
8601
+
8602
+ # The response message for Conversations.ListConversations.
8603
+ class GoogleCloudDialogflowV2ListConversationsResponse
8604
+ include Google::Apis::Core::Hashable
8605
+
8606
+ # The list of conversations. There will be a maximum number of items returned
8607
+ # based on the page_size field in the request.
8608
+ # Corresponds to the JSON property `conversations`
8609
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation>]
8610
+ attr_accessor :conversations
8611
+
8612
+ # Token to retrieve the next page of results, or empty if there are no more
8613
+ # results in the list.
8614
+ # Corresponds to the JSON property `nextPageToken`
8615
+ # @return [String]
8616
+ attr_accessor :next_page_token
8617
+
8618
+ def initialize(**args)
8619
+ update!(**args)
8620
+ end
8621
+
8622
+ # Update properties of this object
8623
+ def update!(**args)
8624
+ @conversations = args[:conversations] if args.key?(:conversations)
8625
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8626
+ end
8627
+ end
8628
+
8629
+ # Response message for Documents.ListDocuments.
8630
+ class GoogleCloudDialogflowV2ListDocumentsResponse
8631
+ include Google::Apis::Core::Hashable
8632
+
8633
+ # The list of documents.
8634
+ # Corresponds to the JSON property `documents`
8635
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document>]
8636
+ attr_accessor :documents
8637
+
8638
+ # Token to retrieve the next page of results, or empty if there are no more
8639
+ # results in the list.
8640
+ # Corresponds to the JSON property `nextPageToken`
8641
+ # @return [String]
8642
+ attr_accessor :next_page_token
8643
+
8644
+ def initialize(**args)
8645
+ update!(**args)
8646
+ end
8647
+
8648
+ # Update properties of this object
8649
+ def update!(**args)
8650
+ @documents = args[:documents] if args.key?(:documents)
8651
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8652
+ end
8653
+ end
8654
+
8655
+ # The response message for EntityTypes.ListEntityTypes.
8656
+ class GoogleCloudDialogflowV2ListEntityTypesResponse
8657
+ include Google::Apis::Core::Hashable
8658
+
8659
+ # The list of agent entity types. There will be a maximum number of items
8660
+ # returned based on the page_size field in the request.
8661
+ # Corresponds to the JSON property `entityTypes`
8662
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType>]
8663
+ attr_accessor :entity_types
8664
+
8665
+ # Token to retrieve the next page of results, or empty if there are no more
8666
+ # results in the list.
8667
+ # Corresponds to the JSON property `nextPageToken`
8668
+ # @return [String]
8669
+ attr_accessor :next_page_token
8670
+
8671
+ def initialize(**args)
8672
+ update!(**args)
8673
+ end
8674
+
8675
+ # Update properties of this object
8676
+ def update!(**args)
8677
+ @entity_types = args[:entity_types] if args.key?(:entity_types)
8678
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8679
+ end
8680
+ end
8681
+
8682
+ # The response message for Environments.ListEnvironments.
8683
+ class GoogleCloudDialogflowV2ListEnvironmentsResponse
8684
+ include Google::Apis::Core::Hashable
8685
+
8686
+ # The list of agent environments. There will be a maximum number of items
8687
+ # returned based on the page_size field in the request.
8688
+ # Corresponds to the JSON property `environments`
8689
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment>]
8690
+ attr_accessor :environments
8691
+
8692
+ # Token to retrieve the next page of results, or empty if there are no more
8693
+ # results in the list.
8694
+ # Corresponds to the JSON property `nextPageToken`
8695
+ # @return [String]
8696
+ attr_accessor :next_page_token
8697
+
8698
+ def initialize(**args)
8699
+ update!(**args)
8700
+ end
8701
+
8702
+ # Update properties of this object
8703
+ def update!(**args)
8704
+ @environments = args[:environments] if args.key?(:environments)
8705
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8706
+ end
8707
+ end
8708
+
8709
+ # The response message for Intents.ListIntents.
8710
+ class GoogleCloudDialogflowV2ListIntentsResponse
8711
+ include Google::Apis::Core::Hashable
8712
+
8713
+ # The list of agent intents. There will be a maximum number of items returned
8714
+ # based on the page_size field in the request.
8715
+ # Corresponds to the JSON property `intents`
8716
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent>]
8717
+ attr_accessor :intents
8718
+
8719
+ # Token to retrieve the next page of results, or empty if there are no more
8720
+ # results in the list.
8721
+ # Corresponds to the JSON property `nextPageToken`
8722
+ # @return [String]
8723
+ attr_accessor :next_page_token
8724
+
8725
+ def initialize(**args)
8726
+ update!(**args)
8727
+ end
8728
+
8729
+ # Update properties of this object
8730
+ def update!(**args)
8731
+ @intents = args[:intents] if args.key?(:intents)
8732
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8733
+ end
8734
+ end
8735
+
8736
+ # Response message for KnowledgeBases.ListKnowledgeBases.
8737
+ class GoogleCloudDialogflowV2ListKnowledgeBasesResponse
7157
8738
  include Google::Apis::Core::Hashable
7158
8739
 
7159
- # The list of agent entity types. There will be a maximum number of items
7160
- # returned based on the page_size field in the request.
7161
- # Corresponds to the JSON property `entityTypes`
7162
- # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType>]
7163
- attr_accessor :entity_types
8740
+ # The list of knowledge bases.
8741
+ # Corresponds to the JSON property `knowledgeBases`
8742
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase>]
8743
+ attr_accessor :knowledge_bases
7164
8744
 
7165
8745
  # Token to retrieve the next page of results, or empty if there are no more
7166
8746
  # results in the list.
@@ -7174,20 +8754,21 @@ module Google
7174
8754
 
7175
8755
  # Update properties of this object
7176
8756
  def update!(**args)
7177
- @entity_types = args[:entity_types] if args.key?(:entity_types)
8757
+ @knowledge_bases = args[:knowledge_bases] if args.key?(:knowledge_bases)
7178
8758
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7179
8759
  end
7180
8760
  end
7181
8761
 
7182
- # The response message for Environments.ListEnvironments.
7183
- class GoogleCloudDialogflowV2ListEnvironmentsResponse
8762
+ # The response message for Conversations.ListMessages.
8763
+ class GoogleCloudDialogflowV2ListMessagesResponse
7184
8764
  include Google::Apis::Core::Hashable
7185
8765
 
7186
- # The list of agent environments. There will be a maximum number of items
7187
- # returned based on the page_size field in the request.
7188
- # Corresponds to the JSON property `environments`
7189
- # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment>]
7190
- attr_accessor :environments
8766
+ # The list of messages. There will be a maximum number of items returned based
8767
+ # on the page_size field in the request. `messages` is sorted by `create_time`
8768
+ # in descending order.
8769
+ # Corresponds to the JSON property `messages`
8770
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Message>]
8771
+ attr_accessor :messages
7191
8772
 
7192
8773
  # Token to retrieve the next page of results, or empty if there are no more
7193
8774
  # results in the list.
@@ -7201,35 +8782,35 @@ module Google
7201
8782
 
7202
8783
  # Update properties of this object
7203
8784
  def update!(**args)
7204
- @environments = args[:environments] if args.key?(:environments)
8785
+ @messages = args[:messages] if args.key?(:messages)
7205
8786
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7206
8787
  end
7207
8788
  end
7208
8789
 
7209
- # The response message for Intents.ListIntents.
7210
- class GoogleCloudDialogflowV2ListIntentsResponse
8790
+ # The response message for Participants.ListParticipants.
8791
+ class GoogleCloudDialogflowV2ListParticipantsResponse
7211
8792
  include Google::Apis::Core::Hashable
7212
8793
 
7213
- # The list of agent intents. There will be a maximum number of items returned
7214
- # based on the page_size field in the request.
7215
- # Corresponds to the JSON property `intents`
7216
- # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent>]
7217
- attr_accessor :intents
7218
-
7219
- # Token to retrieve the next page of results, or empty if there are no more
8794
+ # Token to retrieve the next page of results or empty if there are no more
7220
8795
  # results in the list.
7221
8796
  # Corresponds to the JSON property `nextPageToken`
7222
8797
  # @return [String]
7223
8798
  attr_accessor :next_page_token
7224
8799
 
8800
+ # The list of participants. There is a maximum number of items returned based on
8801
+ # the page_size field in the request.
8802
+ # Corresponds to the JSON property `participants`
8803
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant>]
8804
+ attr_accessor :participants
8805
+
7225
8806
  def initialize(**args)
7226
8807
  update!(**args)
7227
8808
  end
7228
8809
 
7229
8810
  # Update properties of this object
7230
8811
  def update!(**args)
7231
- @intents = args[:intents] if args.key?(:intents)
7232
8812
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8813
+ @participants = args[:participants] if args.key?(:participants)
7233
8814
  end
7234
8815
  end
7235
8816
 
@@ -7260,6 +8841,27 @@ module Google
7260
8841
  end
7261
8842
  end
7262
8843
 
8844
+ # Defines logging behavior for conversation lifecycle events.
8845
+ class GoogleCloudDialogflowV2LoggingConfig
8846
+ include Google::Apis::Core::Hashable
8847
+
8848
+ # Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in
8849
+ # the conversation project as JSON format ConversationEvent protos.
8850
+ # Corresponds to the JSON property `enableStackdriverLogging`
8851
+ # @return [Boolean]
8852
+ attr_accessor :enable_stackdriver_logging
8853
+ alias_method :enable_stackdriver_logging?, :enable_stackdriver_logging
8854
+
8855
+ def initialize(**args)
8856
+ update!(**args)
8857
+ end
8858
+
8859
+ # Update properties of this object
8860
+ def update!(**args)
8861
+ @enable_stackdriver_logging = args[:enable_stackdriver_logging] if args.key?(:enable_stackdriver_logging)
8862
+ end
8863
+ end
8864
+
7263
8865
  # Represents a message posted into a conversation.
7264
8866
  class GoogleCloudDialogflowV2Message
7265
8867
  include Google::Apis::Core::Hashable
@@ -7345,6 +8947,36 @@ module Google
7345
8947
  end
7346
8948
  end
7347
8949
 
8950
+ # Defines notification behavior.
8951
+ class GoogleCloudDialogflowV2NotificationConfig
8952
+ include Google::Apis::Core::Hashable
8953
+
8954
+ # Format of message.
8955
+ # Corresponds to the JSON property `messageFormat`
8956
+ # @return [String]
8957
+ attr_accessor :message_format
8958
+
8959
+ # Name of the Pub/Sub topic to publish conversation events like
8960
+ # CONVERSATION_STARTED as serialized ConversationEvent protos. Notification
8961
+ # works for phone calls, if this topic either is in the same project as the
8962
+ # conversation or you grant `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`
8963
+ # the `Dialogflow Service Agent` role in the topic project. Format: `projects//
8964
+ # locations//topics/`.
8965
+ # Corresponds to the JSON property `topic`
8966
+ # @return [String]
8967
+ attr_accessor :topic
8968
+
8969
+ def initialize(**args)
8970
+ update!(**args)
8971
+ end
8972
+
8973
+ # Update properties of this object
8974
+ def update!(**args)
8975
+ @message_format = args[:message_format] if args.key?(:message_format)
8976
+ @topic = args[:topic] if args.key?(:topic)
8977
+ end
8978
+ end
8979
+
7348
8980
  # Represents the contents of the original request that was passed to the `[
7349
8981
  # Streaming]DetectIntent` call.
7350
8982
  class GoogleCloudDialogflowV2OriginalDetectIntentRequest
@@ -7385,6 +9017,34 @@ module Google
7385
9017
  end
7386
9018
  end
7387
9019
 
9020
+ # Represents the natural language speech audio to be played to the end user.
9021
+ class GoogleCloudDialogflowV2OutputAudio
9022
+ include Google::Apis::Core::Hashable
9023
+
9024
+ # The natural language speech audio.
9025
+ # Corresponds to the JSON property `audio`
9026
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
9027
+ # @return [String]
9028
+ attr_accessor :audio
9029
+
9030
+ # Instructs the speech synthesizer on how to generate the output audio content.
9031
+ # If this audio config is supplied in a request, it overrides all existing text-
9032
+ # to-speech settings applied to the agent.
9033
+ # Corresponds to the JSON property `config`
9034
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig]
9035
+ attr_accessor :config
9036
+
9037
+ def initialize(**args)
9038
+ update!(**args)
9039
+ end
9040
+
9041
+ # Update properties of this object
9042
+ def update!(**args)
9043
+ @audio = args[:audio] if args.key?(:audio)
9044
+ @config = args[:config] if args.key?(:config)
9045
+ end
9046
+ end
9047
+
7388
9048
  # Instructs the speech synthesizer on how to generate the output audio content.
7389
9049
  # If this audio config is supplied in a request, it overrides all existing text-
7390
9050
  # to-speech settings applied to the agent.
@@ -7422,6 +9082,41 @@ module Google
7422
9082
  end
7423
9083
  end
7424
9084
 
9085
+ # Represents a conversation participant (human agent, virtual agent, end-user).
9086
+ class GoogleCloudDialogflowV2Participant
9087
+ include Google::Apis::Core::Hashable
9088
+
9089
+ # Optional. The unique identifier of this participant. Format: `projects//
9090
+ # locations//conversations//participants/`.
9091
+ # Corresponds to the JSON property `name`
9092
+ # @return [String]
9093
+ attr_accessor :name
9094
+
9095
+ # Immutable. The role this participant plays in the conversation. This field
9096
+ # must be set during participant creation and is then immutable.
9097
+ # Corresponds to the JSON property `role`
9098
+ # @return [String]
9099
+ attr_accessor :role
9100
+
9101
+ # Optional. Label applied to streams representing this participant in SIPREC XML
9102
+ # metadata and SDP. This is used to assign transcriptions from that media stream
9103
+ # to this participant. This field can be updated.
9104
+ # Corresponds to the JSON property `sipRecordingMediaLabel`
9105
+ # @return [String]
9106
+ attr_accessor :sip_recording_media_label
9107
+
9108
+ def initialize(**args)
9109
+ update!(**args)
9110
+ end
9111
+
9112
+ # Update properties of this object
9113
+ def update!(**args)
9114
+ @name = args[:name] if args.key?(:name)
9115
+ @role = args[:role] if args.key?(:role)
9116
+ @sip_recording_media_label = args[:sip_recording_media_label] if args.key?(:sip_recording_media_label)
9117
+ end
9118
+ end
9119
+
7425
9120
  # Represents the query input. It can contain either: 1. An audio config which
7426
9121
  # instructs the speech recognizer how to process the speech audio. 2. A
7427
9122
  # conversational query in the form of text,. 3. An event that specifies which
@@ -7693,6 +9388,27 @@ module Google
7693
9388
  end
7694
9389
  end
7695
9390
 
9391
+ # Request message for Documents.ReloadDocument.
9392
+ class GoogleCloudDialogflowV2ReloadDocumentRequest
9393
+ include Google::Apis::Core::Hashable
9394
+
9395
+ # Optional. The path of gcs source file for reloading document content. For now,
9396
+ # only gcs uri is supported. For documents stored in Google Cloud Storage, these
9397
+ # URIs must have the form `gs:///`.
9398
+ # Corresponds to the JSON property `contentUri`
9399
+ # @return [String]
9400
+ attr_accessor :content_uri
9401
+
9402
+ def initialize(**args)
9403
+ update!(**args)
9404
+ end
9405
+
9406
+ # Update properties of this object
9407
+ def update!(**args)
9408
+ @content_uri = args[:content_uri] if args.key?(:content_uri)
9409
+ end
9410
+ end
9411
+
7696
9412
  # The request message for Agents.RestoreAgent.
7697
9413
  class GoogleCloudDialogflowV2RestoreAgentRequest
7698
9414
  include Google::Apis::Core::Hashable
@@ -7837,21 +9553,226 @@ module Google
7837
9553
  # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityTypeEntity>]
7838
9554
  attr_accessor :entities
7839
9555
 
7840
- # Required. Indicates whether the additional data should override or supplement
7841
- # the custom entity type definition.
7842
- # Corresponds to the JSON property `entityOverrideMode`
7843
- # @return [String]
7844
- attr_accessor :entity_override_mode
9556
+ # Required. Indicates whether the additional data should override or supplement
9557
+ # the custom entity type definition.
9558
+ # Corresponds to the JSON property `entityOverrideMode`
9559
+ # @return [String]
9560
+ attr_accessor :entity_override_mode
9561
+
9562
+ # Required. The unique identifier of this session entity type. Format: `projects/
9563
+ # /agent/sessions//entityTypes/`, or `projects//agent/environments//users//
9564
+ # sessions//entityTypes/`. If `Environment ID` is not specified, we assume
9565
+ # default 'draft' environment. If `User ID` is not specified, we assume default '
9566
+ # -' user. `` must be the display name of an existing entity type in the same
9567
+ # agent that will be overridden or supplemented.
9568
+ # Corresponds to the JSON property `name`
9569
+ # @return [String]
9570
+ attr_accessor :name
9571
+
9572
+ def initialize(**args)
9573
+ update!(**args)
9574
+ end
9575
+
9576
+ # Update properties of this object
9577
+ def update!(**args)
9578
+ @entities = args[:entities] if args.key?(:entities)
9579
+ @entity_override_mode = args[:entity_override_mode] if args.key?(:entity_override_mode)
9580
+ @name = args[:name] if args.key?(:name)
9581
+ end
9582
+ end
9583
+
9584
+ # Hints for the speech recognizer to help with recognition in a specific
9585
+ # conversation state.
9586
+ class GoogleCloudDialogflowV2SpeechContext
9587
+ include Google::Apis::Core::Hashable
9588
+
9589
+ # Optional. Boost for this context compared to other contexts: * If the boost is
9590
+ # positive, Dialogflow will increase the probability that the phrases in this
9591
+ # context are recognized over similar sounding phrases. * If the boost is
9592
+ # unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow
9593
+ # recommends that you use boosts in the range (0, 20] and that you find a value
9594
+ # that fits your use case with binary search.
9595
+ # Corresponds to the JSON property `boost`
9596
+ # @return [Float]
9597
+ attr_accessor :boost
9598
+
9599
+ # Optional. A list of strings containing words and phrases that the speech
9600
+ # recognizer should recognize with higher likelihood. This list can be used to: *
9601
+ # improve accuracy for words and phrases you expect the user to say, e.g.
9602
+ # typical commands for your Dialogflow agent * add additional words to the
9603
+ # speech recognizer vocabulary * ... See the [Cloud Speech documentation](https:/
9604
+ # /cloud.google.com/speech-to-text/quotas) for usage limits.
9605
+ # Corresponds to the JSON property `phrases`
9606
+ # @return [Array<String>]
9607
+ attr_accessor :phrases
9608
+
9609
+ def initialize(**args)
9610
+ update!(**args)
9611
+ end
9612
+
9613
+ # Update properties of this object
9614
+ def update!(**args)
9615
+ @boost = args[:boost] if args.key?(:boost)
9616
+ @phrases = args[:phrases] if args.key?(:phrases)
9617
+ end
9618
+ end
9619
+
9620
+ # Configures speech transcription for ConversationProfile.
9621
+ class GoogleCloudDialogflowV2SpeechToTextConfig
9622
+ include Google::Apis::Core::Hashable
9623
+
9624
+ # Optional. The speech model used in speech to text. `
9625
+ # SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `
9626
+ # USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and
9627
+ # StreamingAnalyzeContentRequest request.
9628
+ # Corresponds to the JSON property `speechModelVariant`
9629
+ # @return [String]
9630
+ attr_accessor :speech_model_variant
9631
+
9632
+ def initialize(**args)
9633
+ update!(**args)
9634
+ end
9635
+
9636
+ # Update properties of this object
9637
+ def update!(**args)
9638
+ @speech_model_variant = args[:speech_model_variant] if args.key?(:speech_model_variant)
9639
+ end
9640
+ end
9641
+
9642
+ # The request message for Participants.SuggestArticles.
9643
+ class GoogleCloudDialogflowV2SuggestArticlesRequest
9644
+ include Google::Apis::Core::Hashable
9645
+
9646
+ # Max number of messages prior to and including latest_message to use as context
9647
+ # when compiling the suggestion. By default 20 and at most 50.
9648
+ # Corresponds to the JSON property `contextSize`
9649
+ # @return [Fixnum]
9650
+ attr_accessor :context_size
9651
+
9652
+ # The name of the latest conversation message to compile suggestion for. If
9653
+ # empty, it will be the latest message of the conversation. Format: `projects//
9654
+ # locations//conversations//messages/`.
9655
+ # Corresponds to the JSON property `latestMessage`
9656
+ # @return [String]
9657
+ attr_accessor :latest_message
9658
+
9659
+ def initialize(**args)
9660
+ update!(**args)
9661
+ end
9662
+
9663
+ # Update properties of this object
9664
+ def update!(**args)
9665
+ @context_size = args[:context_size] if args.key?(:context_size)
9666
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9667
+ end
9668
+ end
9669
+
9670
+ # The response message for Participants.SuggestArticles.
9671
+ class GoogleCloudDialogflowV2SuggestArticlesResponse
9672
+ include Google::Apis::Core::Hashable
9673
+
9674
+ # Articles ordered by score in descending order.
9675
+ # Corresponds to the JSON property `articleAnswers`
9676
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ArticleAnswer>]
9677
+ attr_accessor :article_answers
9678
+
9679
+ # Number of messages prior to and including latest_message to compile the
9680
+ # suggestion. It may be smaller than the SuggestArticlesRequest.context_size
9681
+ # field in the request if there aren't that many messages in the conversation.
9682
+ # Corresponds to the JSON property `contextSize`
9683
+ # @return [Fixnum]
9684
+ attr_accessor :context_size
9685
+
9686
+ # The name of the latest conversation message used to compile suggestion for.
9687
+ # Format: `projects//locations//conversations//messages/`.
9688
+ # Corresponds to the JSON property `latestMessage`
9689
+ # @return [String]
9690
+ attr_accessor :latest_message
9691
+
9692
+ def initialize(**args)
9693
+ update!(**args)
9694
+ end
9695
+
9696
+ # Update properties of this object
9697
+ def update!(**args)
9698
+ @article_answers = args[:article_answers] if args.key?(:article_answers)
9699
+ @context_size = args[:context_size] if args.key?(:context_size)
9700
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9701
+ end
9702
+ end
9703
+
9704
+ # The request message for Participants.SuggestFaqAnswers.
9705
+ class GoogleCloudDialogflowV2SuggestFaqAnswersRequest
9706
+ include Google::Apis::Core::Hashable
9707
+
9708
+ # Max number of messages prior to and including [latest_message] to use as
9709
+ # context when compiling the suggestion. By default 20 and at most 50.
9710
+ # Corresponds to the JSON property `contextSize`
9711
+ # @return [Fixnum]
9712
+ attr_accessor :context_size
9713
+
9714
+ # The name of the latest conversation message to compile suggestion for. If
9715
+ # empty, it will be the latest message of the conversation. Format: `projects//
9716
+ # locations//conversations//messages/`.
9717
+ # Corresponds to the JSON property `latestMessage`
9718
+ # @return [String]
9719
+ attr_accessor :latest_message
9720
+
9721
+ def initialize(**args)
9722
+ update!(**args)
9723
+ end
9724
+
9725
+ # Update properties of this object
9726
+ def update!(**args)
9727
+ @context_size = args[:context_size] if args.key?(:context_size)
9728
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9729
+ end
9730
+ end
9731
+
9732
+ # The request message for Participants.SuggestFaqAnswers.
9733
+ class GoogleCloudDialogflowV2SuggestFaqAnswersResponse
9734
+ include Google::Apis::Core::Hashable
9735
+
9736
+ # Number of messages prior to and including latest_message to compile the
9737
+ # suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size
9738
+ # field in the request if there aren't that many messages in the conversation.
9739
+ # Corresponds to the JSON property `contextSize`
9740
+ # @return [Fixnum]
9741
+ attr_accessor :context_size
9742
+
9743
+ # Answers extracted from FAQ documents.
9744
+ # Corresponds to the JSON property `faqAnswers`
9745
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2FaqAnswer>]
9746
+ attr_accessor :faq_answers
9747
+
9748
+ # The name of the latest conversation message used to compile suggestion for.
9749
+ # Format: `projects//locations//conversations//messages/`.
9750
+ # Corresponds to the JSON property `latestMessage`
9751
+ # @return [String]
9752
+ attr_accessor :latest_message
9753
+
9754
+ def initialize(**args)
9755
+ update!(**args)
9756
+ end
9757
+
9758
+ # Update properties of this object
9759
+ def update!(**args)
9760
+ @context_size = args[:context_size] if args.key?(:context_size)
9761
+ @faq_answers = args[:faq_answers] if args.key?(:faq_answers)
9762
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9763
+ end
9764
+ end
9765
+
9766
+ # The type of Human Agent Assistant API suggestion to perform, and the maximum
9767
+ # number of results to return for that type. Multiple `Feature` objects can be
9768
+ # specified in the `features` list.
9769
+ class GoogleCloudDialogflowV2SuggestionFeature
9770
+ include Google::Apis::Core::Hashable
7845
9771
 
7846
- # Required. The unique identifier of this session entity type. Format: `projects/
7847
- # /agent/sessions//entityTypes/`, or `projects//agent/environments//users//
7848
- # sessions//entityTypes/`. If `Environment ID` is not specified, we assume
7849
- # default 'draft' environment. If `User ID` is not specified, we assume default '
7850
- # -' user. `` must be the display name of an existing entity type in the same
7851
- # agent that will be overridden or supplemented.
7852
- # Corresponds to the JSON property `name`
9772
+ # Type of Human Agent Assistant API feature to request.
9773
+ # Corresponds to the JSON property `type`
7853
9774
  # @return [String]
7854
- attr_accessor :name
9775
+ attr_accessor :type
7855
9776
 
7856
9777
  def initialize(**args)
7857
9778
  update!(**args)
@@ -7859,36 +9780,35 @@ module Google
7859
9780
 
7860
9781
  # Update properties of this object
7861
9782
  def update!(**args)
7862
- @entities = args[:entities] if args.key?(:entities)
7863
- @entity_override_mode = args[:entity_override_mode] if args.key?(:entity_override_mode)
7864
- @name = args[:name] if args.key?(:name)
9783
+ @type = args[:type] if args.key?(:type)
7865
9784
  end
7866
9785
  end
7867
9786
 
7868
- # Hints for the speech recognizer to help with recognition in a specific
7869
- # conversation state.
7870
- class GoogleCloudDialogflowV2SpeechContext
9787
+ # One response of different type of suggestion response which is used in the
9788
+ # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
9789
+ # well as HumanAgentAssistantEvent.
9790
+ class GoogleCloudDialogflowV2SuggestionResult
7871
9791
  include Google::Apis::Core::Hashable
7872
9792
 
7873
- # Optional. Boost for this context compared to other contexts: * If the boost is
7874
- # positive, Dialogflow will increase the probability that the phrases in this
7875
- # context are recognized over similar sounding phrases. * If the boost is
7876
- # unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow
7877
- # recommends that you use boosts in the range (0, 20] and that you find a value
7878
- # that fits your use case with binary search.
7879
- # Corresponds to the JSON property `boost`
7880
- # @return [Float]
7881
- attr_accessor :boost
9793
+ # The `Status` type defines a logical error model that is suitable for different
9794
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9795
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9796
+ # data: error code, error message, and error details. You can find out more
9797
+ # about this error model and how to work with it in the [API Design Guide](https:
9798
+ # //cloud.google.com/apis/design/errors).
9799
+ # Corresponds to the JSON property `error`
9800
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
9801
+ attr_accessor :error
7882
9802
 
7883
- # Optional. A list of strings containing words and phrases that the speech
7884
- # recognizer should recognize with higher likelihood. This list can be used to: *
7885
- # improve accuracy for words and phrases you expect the user to say, e.g.
7886
- # typical commands for your Dialogflow agent * add additional words to the
7887
- # speech recognizer vocabulary * ... See the [Cloud Speech documentation](https:/
7888
- # /cloud.google.com/speech-to-text/quotas) for usage limits.
7889
- # Corresponds to the JSON property `phrases`
7890
- # @return [Array<String>]
7891
- attr_accessor :phrases
9803
+ # The response message for Participants.SuggestArticles.
9804
+ # Corresponds to the JSON property `suggestArticlesResponse`
9805
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse]
9806
+ attr_accessor :suggest_articles_response
9807
+
9808
+ # The request message for Participants.SuggestFaqAnswers.
9809
+ # Corresponds to the JSON property `suggestFaqAnswersResponse`
9810
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
9811
+ attr_accessor :suggest_faq_answers_response
7892
9812
 
7893
9813
  def initialize(**args)
7894
9814
  update!(**args)
@@ -7896,8 +9816,9 @@ module Google
7896
9816
 
7897
9817
  # Update properties of this object
7898
9818
  def update!(**args)
7899
- @boost = args[:boost] if args.key?(:boost)
7900
- @phrases = args[:phrases] if args.key?(:phrases)
9819
+ @error = args[:error] if args.key?(:error)
9820
+ @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
9821
+ @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
7901
9822
  end
7902
9823
  end
7903
9824
 
@@ -8212,6 +10133,89 @@ module Google
8212
10133
  end
8213
10134
  end
8214
10135
 
10136
+ # Represents a part of a message possibly annotated with an entity. The part can
10137
+ # be an entity or purely a part of the message between two entities or message
10138
+ # start/end.
10139
+ class GoogleCloudDialogflowV2beta1AnnotatedMessagePart
10140
+ include Google::Apis::Core::Hashable
10141
+
10142
+ # Optional. The [Dialogflow system entity type](https://cloud.google.com/
10143
+ # dialogflow/docs/reference/system-entities) of this message part. If this is
10144
+ # empty, Dialogflow could not annotate the phrase part with a system entity.
10145
+ # Corresponds to the JSON property `entityType`
10146
+ # @return [String]
10147
+ attr_accessor :entity_type
10148
+
10149
+ # Optional. The [Dialogflow system entity formatted value ](https://cloud.google.
10150
+ # com/dialogflow/docs/reference/system-entities) of this message part. For
10151
+ # example for a system entity of type `@sys.unit-currency`, this may contain: ` "
10152
+ # amount": 5, "currency": "USD" `
10153
+ # Corresponds to the JSON property `formattedValue`
10154
+ # @return [Object]
10155
+ attr_accessor :formatted_value
10156
+
10157
+ # Required. A part of a message possibly annotated with an entity.
10158
+ # Corresponds to the JSON property `text`
10159
+ # @return [String]
10160
+ attr_accessor :text
10161
+
10162
+ def initialize(**args)
10163
+ update!(**args)
10164
+ end
10165
+
10166
+ # Update properties of this object
10167
+ def update!(**args)
10168
+ @entity_type = args[:entity_type] if args.key?(:entity_type)
10169
+ @formatted_value = args[:formatted_value] if args.key?(:formatted_value)
10170
+ @text = args[:text] if args.key?(:text)
10171
+ end
10172
+ end
10173
+
10174
+ # Represents article answer.
10175
+ class GoogleCloudDialogflowV2beta1ArticleAnswer
10176
+ include Google::Apis::Core::Hashable
10177
+
10178
+ # The name of answer record, in the format of "projects//locations//
10179
+ # answerRecords/"
10180
+ # Corresponds to the JSON property `answerRecord`
10181
+ # @return [String]
10182
+ attr_accessor :answer_record
10183
+
10184
+ # A map that contains metadata about the answer and the document from which it
10185
+ # originates.
10186
+ # Corresponds to the JSON property `metadata`
10187
+ # @return [Hash<String,String>]
10188
+ attr_accessor :metadata
10189
+
10190
+ # Output only. Article snippets.
10191
+ # Corresponds to the JSON property `snippets`
10192
+ # @return [Array<String>]
10193
+ attr_accessor :snippets
10194
+
10195
+ # The article title.
10196
+ # Corresponds to the JSON property `title`
10197
+ # @return [String]
10198
+ attr_accessor :title
10199
+
10200
+ # The article URI.
10201
+ # Corresponds to the JSON property `uri`
10202
+ # @return [String]
10203
+ attr_accessor :uri
10204
+
10205
+ def initialize(**args)
10206
+ update!(**args)
10207
+ end
10208
+
10209
+ # Update properties of this object
10210
+ def update!(**args)
10211
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10212
+ @metadata = args[:metadata] if args.key?(:metadata)
10213
+ @snippets = args[:snippets] if args.key?(:snippets)
10214
+ @title = args[:title] if args.key?(:title)
10215
+ @uri = args[:uri] if args.key?(:uri)
10216
+ end
10217
+ end
10218
+
8215
10219
  # The response message for EntityTypes.BatchUpdateEntityTypes.
8216
10220
  class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse
8217
10221
  include Google::Apis::Core::Hashable
@@ -8312,6 +10316,50 @@ module Google
8312
10316
  end
8313
10317
  end
8314
10318
 
10319
+ # Represents a notification sent to Pub/Sub subscribers for conversation
10320
+ # lifecycle events.
10321
+ class GoogleCloudDialogflowV2beta1ConversationEvent
10322
+ include Google::Apis::Core::Hashable
10323
+
10324
+ # Required. The unique identifier of the conversation this notification refers
10325
+ # to. Format: `projects//conversations/`.
10326
+ # Corresponds to the JSON property `conversation`
10327
+ # @return [String]
10328
+ attr_accessor :conversation
10329
+
10330
+ # The `Status` type defines a logical error model that is suitable for different
10331
+ # programming environments, including REST APIs and RPC APIs. It is used by [
10332
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
10333
+ # data: error code, error message, and error details. You can find out more
10334
+ # about this error model and how to work with it in the [API Design Guide](https:
10335
+ # //cloud.google.com/apis/design/errors).
10336
+ # Corresponds to the JSON property `errorStatus`
10337
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
10338
+ attr_accessor :error_status
10339
+
10340
+ # Represents a message posted into a conversation.
10341
+ # Corresponds to the JSON property `newMessagePayload`
10342
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Message]
10343
+ attr_accessor :new_message_payload
10344
+
10345
+ # Required. The type of the event that this notification refers to.
10346
+ # Corresponds to the JSON property `type`
10347
+ # @return [String]
10348
+ attr_accessor :type
10349
+
10350
+ def initialize(**args)
10351
+ update!(**args)
10352
+ end
10353
+
10354
+ # Update properties of this object
10355
+ def update!(**args)
10356
+ @conversation = args[:conversation] if args.key?(:conversation)
10357
+ @error_status = args[:error_status] if args.key?(:error_status)
10358
+ @new_message_payload = args[:new_message_payload] if args.key?(:new_message_payload)
10359
+ @type = args[:type] if args.key?(:type)
10360
+ end
10361
+ end
10362
+
8315
10363
  # Each intent parameter has a type, called the entity type, which dictates
8316
10364
  # exactly how data from an end-user expression is extracted. Dialogflow provides
8317
10365
  # predefined system entities that can match many common types of data. For
@@ -8405,38 +10453,157 @@ module Google
8405
10453
  end
8406
10454
  end
8407
10455
 
8408
- # Events allow for matching intents by event name instead of the natural
8409
- # language input. For instance, input `` can trigger a personalized welcome
8410
- # response. The parameter `name` may be used by the agent in the response: `"
8411
- # Hello #welcome_event.name! What can I do for you today?"`.
8412
- class GoogleCloudDialogflowV2beta1EventInput
10456
+ # Events allow for matching intents by event name instead of the natural
10457
+ # language input. For instance, input `` can trigger a personalized welcome
10458
+ # response. The parameter `name` may be used by the agent in the response: `"
10459
+ # Hello #welcome_event.name! What can I do for you today?"`.
10460
+ class GoogleCloudDialogflowV2beta1EventInput
10461
+ include Google::Apis::Core::Hashable
10462
+
10463
+ # Required. The language of this query. See [Language Support](https://cloud.
10464
+ # google.com/dialogflow/docs/reference/language) for a list of the currently
10465
+ # supported language codes. Note that queries in the same session do not
10466
+ # necessarily need to specify the same language.
10467
+ # Corresponds to the JSON property `languageCode`
10468
+ # @return [String]
10469
+ attr_accessor :language_code
10470
+
10471
+ # Required. The unique identifier of the event.
10472
+ # Corresponds to the JSON property `name`
10473
+ # @return [String]
10474
+ attr_accessor :name
10475
+
10476
+ # The collection of parameters associated with the event. Depending on your
10477
+ # protocol or client library language, this is a map, associative array, symbol
10478
+ # table, dictionary, or JSON object composed of a collection of (MapKey,
10479
+ # MapValue) pairs: - MapKey type: string - MapKey value: parameter name -
10480
+ # MapValue type: - If parameter's entity type is a composite entity: map - Else:
10481
+ # depending on parameter value type, could be one of string, number, boolean,
10482
+ # null, list or map - MapValue value: - If parameter's entity type is a
10483
+ # composite entity: map from composite entity property names to property values -
10484
+ # Else: parameter value
10485
+ # Corresponds to the JSON property `parameters`
10486
+ # @return [Hash<String,Object>]
10487
+ attr_accessor :parameters
10488
+
10489
+ def initialize(**args)
10490
+ update!(**args)
10491
+ end
10492
+
10493
+ # Update properties of this object
10494
+ def update!(**args)
10495
+ @language_code = args[:language_code] if args.key?(:language_code)
10496
+ @name = args[:name] if args.key?(:name)
10497
+ @parameters = args[:parameters] if args.key?(:parameters)
10498
+ end
10499
+ end
10500
+
10501
+ # The response message for Agents.ExportAgent.
10502
+ class GoogleCloudDialogflowV2beta1ExportAgentResponse
10503
+ include Google::Apis::Core::Hashable
10504
+
10505
+ # Zip compressed raw byte content for agent.
10506
+ # Corresponds to the JSON property `agentContent`
10507
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
10508
+ # @return [String]
10509
+ attr_accessor :agent_content
10510
+
10511
+ # The URI to a file containing the exported agent. This field is populated only
10512
+ # if `agent_uri` is specified in `ExportAgentRequest`.
10513
+ # Corresponds to the JSON property `agentUri`
10514
+ # @return [String]
10515
+ attr_accessor :agent_uri
10516
+
10517
+ def initialize(**args)
10518
+ update!(**args)
10519
+ end
10520
+
10521
+ # Update properties of this object
10522
+ def update!(**args)
10523
+ @agent_content = args[:agent_content] if args.key?(:agent_content)
10524
+ @agent_uri = args[:agent_uri] if args.key?(:agent_uri)
10525
+ end
10526
+ end
10527
+
10528
+ # Represents answer from "frequently asked questions".
10529
+ class GoogleCloudDialogflowV2beta1FaqAnswer
10530
+ include Google::Apis::Core::Hashable
10531
+
10532
+ # The piece of text from the `source` knowledge base document.
10533
+ # Corresponds to the JSON property `answer`
10534
+ # @return [String]
10535
+ attr_accessor :answer
10536
+
10537
+ # The name of answer record, in the format of "projects//locations//
10538
+ # answerRecords/"
10539
+ # Corresponds to the JSON property `answerRecord`
10540
+ # @return [String]
10541
+ attr_accessor :answer_record
10542
+
10543
+ # The system's confidence score that this Knowledge answer is a good match for
10544
+ # this conversational query, range from 0.0 (completely uncertain) to 1.0 (
10545
+ # completely certain).
10546
+ # Corresponds to the JSON property `confidence`
10547
+ # @return [Float]
10548
+ attr_accessor :confidence
10549
+
10550
+ # A map that contains metadata about the answer and the document from which it
10551
+ # originates.
10552
+ # Corresponds to the JSON property `metadata`
10553
+ # @return [Hash<String,String>]
10554
+ attr_accessor :metadata
10555
+
10556
+ # The corresponding FAQ question.
10557
+ # Corresponds to the JSON property `question`
10558
+ # @return [String]
10559
+ attr_accessor :question
10560
+
10561
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
10562
+ # projects//locations//agent/knowledgeBases//documents/`.
10563
+ # Corresponds to the JSON property `source`
10564
+ # @return [String]
10565
+ attr_accessor :source
10566
+
10567
+ def initialize(**args)
10568
+ update!(**args)
10569
+ end
10570
+
10571
+ # Update properties of this object
10572
+ def update!(**args)
10573
+ @answer = args[:answer] if args.key?(:answer)
10574
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10575
+ @confidence = args[:confidence] if args.key?(:confidence)
10576
+ @metadata = args[:metadata] if args.key?(:metadata)
10577
+ @question = args[:question] if args.key?(:question)
10578
+ @source = args[:source] if args.key?(:source)
10579
+ end
10580
+ end
10581
+
10582
+ # Output only. Represents a notification sent to Pub/Sub subscribers for agent
10583
+ # assistant events in a specific conversation.
10584
+ class GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent
8413
10585
  include Google::Apis::Core::Hashable
8414
10586
 
8415
- # Required. The language of this query. See [Language Support](https://cloud.
8416
- # google.com/dialogflow/docs/reference/language) for a list of the currently
8417
- # supported language codes. Note that queries in the same session do not
8418
- # necessarily need to specify the same language.
8419
- # Corresponds to the JSON property `languageCode`
10587
+ # The conversation this notification refers to. Format: `projects//conversations/
10588
+ # `.
10589
+ # Corresponds to the JSON property `conversation`
8420
10590
  # @return [String]
8421
- attr_accessor :language_code
10591
+ attr_accessor :conversation
8422
10592
 
8423
- # Required. The unique identifier of the event.
8424
- # Corresponds to the JSON property `name`
10593
+ # The participant that the suggestion is compiled for. And This field is used to
10594
+ # call Participants.ListSuggestions API. Format: `projects//conversations//
10595
+ # participants/`. It will not be set in legacy workflow.
10596
+ # HumanAgentAssistantConfig.name for more information.
10597
+ # Corresponds to the JSON property `participant`
8425
10598
  # @return [String]
8426
- attr_accessor :name
10599
+ attr_accessor :participant
8427
10600
 
8428
- # The collection of parameters associated with the event. Depending on your
8429
- # protocol or client library language, this is a map, associative array, symbol
8430
- # table, dictionary, or JSON object composed of a collection of (MapKey,
8431
- # MapValue) pairs: - MapKey type: string - MapKey value: parameter name -
8432
- # MapValue type: - If parameter's entity type is a composite entity: map - Else:
8433
- # depending on parameter value type, could be one of string, number, boolean,
8434
- # null, list or map - MapValue value: - If parameter's entity type is a
8435
- # composite entity: map from composite entity property names to property values -
8436
- # Else: parameter value
8437
- # Corresponds to the JSON property `parameters`
8438
- # @return [Hash<String,Object>]
8439
- attr_accessor :parameters
10601
+ # The suggestion results payload that this notification refers to. It will only
10602
+ # be set when HumanAgentAssistantConfig.SuggestionConfig.
10603
+ # group_suggestion_responses sets to true.
10604
+ # Corresponds to the JSON property `suggestionResults`
10605
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SuggestionResult>]
10606
+ attr_accessor :suggestion_results
8440
10607
 
8441
10608
  def initialize(**args)
8442
10609
  update!(**args)
@@ -8444,27 +10611,20 @@ module Google
8444
10611
 
8445
10612
  # Update properties of this object
8446
10613
  def update!(**args)
8447
- @language_code = args[:language_code] if args.key?(:language_code)
8448
- @name = args[:name] if args.key?(:name)
8449
- @parameters = args[:parameters] if args.key?(:parameters)
10614
+ @conversation = args[:conversation] if args.key?(:conversation)
10615
+ @participant = args[:participant] if args.key?(:participant)
10616
+ @suggestion_results = args[:suggestion_results] if args.key?(:suggestion_results)
8450
10617
  end
8451
10618
  end
8452
10619
 
8453
- # The response message for Agents.ExportAgent.
8454
- class GoogleCloudDialogflowV2beta1ExportAgentResponse
10620
+ # Response message for Documents.ImportDocuments.
10621
+ class GoogleCloudDialogflowV2beta1ImportDocumentsResponse
8455
10622
  include Google::Apis::Core::Hashable
8456
10623
 
8457
- # Zip compressed raw byte content for agent.
8458
- # Corresponds to the JSON property `agentContent`
8459
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
8460
- # @return [String]
8461
- attr_accessor :agent_content
8462
-
8463
- # The URI to a file containing the exported agent. This field is populated only
8464
- # if `agent_uri` is specified in `ExportAgentRequest`.
8465
- # Corresponds to the JSON property `agentUri`
8466
- # @return [String]
8467
- attr_accessor :agent_uri
10624
+ # Includes details about skipped documents or any other warnings.
10625
+ # Corresponds to the JSON property `warnings`
10626
+ # @return [Array<Google::Apis::DialogflowV2::GoogleRpcStatus>]
10627
+ attr_accessor :warnings
8468
10628
 
8469
10629
  def initialize(**args)
8470
10630
  update!(**args)
@@ -8472,8 +10632,7 @@ module Google
8472
10632
 
8473
10633
  # Update properties of this object
8474
10634
  def update!(**args)
8475
- @agent_content = args[:agent_content] if args.key?(:agent_content)
8476
- @agent_uri = args[:agent_uri] if args.key?(:agent_uri)
10635
+ @warnings = args[:warnings] if args.key?(:warnings)
8477
10636
  end
8478
10637
  end
8479
10638
 
@@ -8539,6 +10698,14 @@ module Google
8539
10698
  attr_accessor :is_fallback
8540
10699
  alias_method :is_fallback?, :is_fallback
8541
10700
 
10701
+ # Optional. Indicates that a live agent should be brought in to handle the
10702
+ # interaction with the user. In most cases, when you set this flag to true, you
10703
+ # would also want to set end_interaction to true as well. Default is false.
10704
+ # Corresponds to the JSON property `liveAgentHandoff`
10705
+ # @return [Boolean]
10706
+ attr_accessor :live_agent_handoff
10707
+ alias_method :live_agent_handoff?, :live_agent_handoff
10708
+
8542
10709
  # Optional. The collection of rich messages corresponding to the `Response`
8543
10710
  # field in the Dialogflow console.
8544
10711
  # Corresponds to the JSON property `messages`
@@ -8643,6 +10810,7 @@ module Google
8643
10810
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
8644
10811
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
8645
10812
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
10813
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
8646
10814
  @messages = args[:messages] if args.key?(:messages)
8647
10815
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
8648
10816
  @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled)
@@ -10285,6 +12453,110 @@ module Google
10285
12453
  end
10286
12454
  end
10287
12455
 
12456
+ # Represents a message posted into a conversation.
12457
+ class GoogleCloudDialogflowV2beta1Message
12458
+ include Google::Apis::Core::Hashable
12459
+
12460
+ # Required. The message content.
12461
+ # Corresponds to the JSON property `content`
12462
+ # @return [String]
12463
+ attr_accessor :content
12464
+
12465
+ # Output only. The time when the message was created in Contact Center AI.
12466
+ # Corresponds to the JSON property `createTime`
12467
+ # @return [String]
12468
+ attr_accessor :create_time
12469
+
12470
+ # Optional. The message language. This should be a [BCP-47](https://www.rfc-
12471
+ # editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
12472
+ # Corresponds to the JSON property `languageCode`
12473
+ # @return [String]
12474
+ attr_accessor :language_code
12475
+
12476
+ # Represents the result of annotation for the message.
12477
+ # Corresponds to the JSON property `messageAnnotation`
12478
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1MessageAnnotation]
12479
+ attr_accessor :message_annotation
12480
+
12481
+ # Optional. The unique identifier of the message. Format: `projects//locations//
12482
+ # conversations//messages/`.
12483
+ # Corresponds to the JSON property `name`
12484
+ # @return [String]
12485
+ attr_accessor :name
12486
+
12487
+ # Output only. The participant that sends this message.
12488
+ # Corresponds to the JSON property `participant`
12489
+ # @return [String]
12490
+ attr_accessor :participant
12491
+
12492
+ # Output only. The role of the participant.
12493
+ # Corresponds to the JSON property `participantRole`
12494
+ # @return [String]
12495
+ attr_accessor :participant_role
12496
+
12497
+ # Optional. The time when the message was sent.
12498
+ # Corresponds to the JSON property `sendTime`
12499
+ # @return [String]
12500
+ attr_accessor :send_time
12501
+
12502
+ # The result of sentiment analysis. Sentiment analysis inspects user input and
12503
+ # identifies the prevailing subjective opinion, especially to determine a user's
12504
+ # attitude as positive, negative, or neutral. For Participants.DetectIntent, it
12505
+ # needs to be configured in DetectIntentRequest.query_params. For Participants.
12506
+ # StreamingDetectIntent, it needs to be configured in
12507
+ # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent
12508
+ # and Participants.StreamingAnalyzeContent, it needs to be configured in
12509
+ # ConversationProfile.human_agent_assistant_config
12510
+ # Corresponds to the JSON property `sentimentAnalysis`
12511
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SentimentAnalysisResult]
12512
+ attr_accessor :sentiment_analysis
12513
+
12514
+ def initialize(**args)
12515
+ update!(**args)
12516
+ end
12517
+
12518
+ # Update properties of this object
12519
+ def update!(**args)
12520
+ @content = args[:content] if args.key?(:content)
12521
+ @create_time = args[:create_time] if args.key?(:create_time)
12522
+ @language_code = args[:language_code] if args.key?(:language_code)
12523
+ @message_annotation = args[:message_annotation] if args.key?(:message_annotation)
12524
+ @name = args[:name] if args.key?(:name)
12525
+ @participant = args[:participant] if args.key?(:participant)
12526
+ @participant_role = args[:participant_role] if args.key?(:participant_role)
12527
+ @send_time = args[:send_time] if args.key?(:send_time)
12528
+ @sentiment_analysis = args[:sentiment_analysis] if args.key?(:sentiment_analysis)
12529
+ end
12530
+ end
12531
+
12532
+ # Represents the result of annotation for the message.
12533
+ class GoogleCloudDialogflowV2beta1MessageAnnotation
12534
+ include Google::Apis::Core::Hashable
12535
+
12536
+ # Required. Indicates whether the text message contains entities.
12537
+ # Corresponds to the JSON property `containEntities`
12538
+ # @return [Boolean]
12539
+ attr_accessor :contain_entities
12540
+ alias_method :contain_entities?, :contain_entities
12541
+
12542
+ # Optional. The collection of annotated message parts ordered by their position
12543
+ # in the message. You can recover the annotated message by concatenating [
12544
+ # AnnotatedMessagePart.text].
12545
+ # Corresponds to the JSON property `parts`
12546
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1AnnotatedMessagePart>]
12547
+ attr_accessor :parts
12548
+
12549
+ def initialize(**args)
12550
+ update!(**args)
12551
+ end
12552
+
12553
+ # Update properties of this object
12554
+ def update!(**args)
12555
+ @contain_entities = args[:contain_entities] if args.key?(:contain_entities)
12556
+ @parts = args[:parts] if args.key?(:parts)
12557
+ end
12558
+ end
12559
+
10288
12560
  # Represents the contents of the original request that was passed to the `[
10289
12561
  # Streaming]DetectIntent` call.
10290
12562
  class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest
@@ -10585,6 +12857,188 @@ module Google
10585
12857
  end
10586
12858
  end
10587
12859
 
12860
+ # Represents a smart reply answer.
12861
+ class GoogleCloudDialogflowV2beta1SmartReplyAnswer
12862
+ include Google::Apis::Core::Hashable
12863
+
12864
+ # The name of answer record, in the format of "projects//locations//
12865
+ # answerRecords/"
12866
+ # Corresponds to the JSON property `answerRecord`
12867
+ # @return [String]
12868
+ attr_accessor :answer_record
12869
+
12870
+ # Smart reply confidence. The system's confidence score that this reply is a
12871
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
12872
+ # to 1.0 (completely certain).
12873
+ # Corresponds to the JSON property `confidence`
12874
+ # @return [Float]
12875
+ attr_accessor :confidence
12876
+
12877
+ # The content of the reply.
12878
+ # Corresponds to the JSON property `reply`
12879
+ # @return [String]
12880
+ attr_accessor :reply
12881
+
12882
+ def initialize(**args)
12883
+ update!(**args)
12884
+ end
12885
+
12886
+ # Update properties of this object
12887
+ def update!(**args)
12888
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
12889
+ @confidence = args[:confidence] if args.key?(:confidence)
12890
+ @reply = args[:reply] if args.key?(:reply)
12891
+ end
12892
+ end
12893
+
12894
+ # The response message for Participants.SuggestArticles.
12895
+ class GoogleCloudDialogflowV2beta1SuggestArticlesResponse
12896
+ include Google::Apis::Core::Hashable
12897
+
12898
+ # Output only. Articles ordered by score in descending order.
12899
+ # Corresponds to the JSON property `articleAnswers`
12900
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1ArticleAnswer>]
12901
+ attr_accessor :article_answers
12902
+
12903
+ # Number of messages prior to and including latest_message to compile the
12904
+ # suggestion. It may be smaller than the SuggestArticlesResponse.context_size
12905
+ # field in the request if there aren't that many messages in the conversation.
12906
+ # Corresponds to the JSON property `contextSize`
12907
+ # @return [Fixnum]
12908
+ attr_accessor :context_size
12909
+
12910
+ # The name of the latest conversation message used to compile suggestion for.
12911
+ # Format: `projects//locations//conversations//messages/`.
12912
+ # Corresponds to the JSON property `latestMessage`
12913
+ # @return [String]
12914
+ attr_accessor :latest_message
12915
+
12916
+ def initialize(**args)
12917
+ update!(**args)
12918
+ end
12919
+
12920
+ # Update properties of this object
12921
+ def update!(**args)
12922
+ @article_answers = args[:article_answers] if args.key?(:article_answers)
12923
+ @context_size = args[:context_size] if args.key?(:context_size)
12924
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12925
+ end
12926
+ end
12927
+
12928
+ # The request message for Participants.SuggestFaqAnswers.
12929
+ class GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse
12930
+ include Google::Apis::Core::Hashable
12931
+
12932
+ # Number of messages prior to and including latest_message to compile the
12933
+ # suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size
12934
+ # field in the request if there aren't that many messages in the conversation.
12935
+ # Corresponds to the JSON property `contextSize`
12936
+ # @return [Fixnum]
12937
+ attr_accessor :context_size
12938
+
12939
+ # Output only. Answers extracted from FAQ documents.
12940
+ # Corresponds to the JSON property `faqAnswers`
12941
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1FaqAnswer>]
12942
+ attr_accessor :faq_answers
12943
+
12944
+ # The name of the latest conversation message used to compile suggestion for.
12945
+ # Format: `projects//locations//conversations//messages/`.
12946
+ # Corresponds to the JSON property `latestMessage`
12947
+ # @return [String]
12948
+ attr_accessor :latest_message
12949
+
12950
+ def initialize(**args)
12951
+ update!(**args)
12952
+ end
12953
+
12954
+ # Update properties of this object
12955
+ def update!(**args)
12956
+ @context_size = args[:context_size] if args.key?(:context_size)
12957
+ @faq_answers = args[:faq_answers] if args.key?(:faq_answers)
12958
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12959
+ end
12960
+ end
12961
+
12962
+ # The response message for Participants.SuggestSmartReplies.
12963
+ class GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse
12964
+ include Google::Apis::Core::Hashable
12965
+
12966
+ # Number of messages prior to and including latest_message to compile the
12967
+ # suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size
12968
+ # field in the request if there aren't that many messages in the conversation.
12969
+ # Corresponds to the JSON property `contextSize`
12970
+ # @return [Fixnum]
12971
+ attr_accessor :context_size
12972
+
12973
+ # The name of the latest conversation message used to compile suggestion for.
12974
+ # Format: `projects//locations//conversations//messages/`.
12975
+ # Corresponds to the JSON property `latestMessage`
12976
+ # @return [String]
12977
+ attr_accessor :latest_message
12978
+
12979
+ # Output only. Multiple reply options provided by smart reply service. The order
12980
+ # is based on the rank of the model prediction. The maximum number of the
12981
+ # returned replies is set in SmartReplyConfig.
12982
+ # Corresponds to the JSON property `smartReplyAnswers`
12983
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SmartReplyAnswer>]
12984
+ attr_accessor :smart_reply_answers
12985
+
12986
+ def initialize(**args)
12987
+ update!(**args)
12988
+ end
12989
+
12990
+ # Update properties of this object
12991
+ def update!(**args)
12992
+ @context_size = args[:context_size] if args.key?(:context_size)
12993
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12994
+ @smart_reply_answers = args[:smart_reply_answers] if args.key?(:smart_reply_answers)
12995
+ end
12996
+ end
12997
+
12998
+ # One response of different type of suggestion response which is used in the
12999
+ # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
13000
+ # well as HumanAgentAssistantEvent.
13001
+ class GoogleCloudDialogflowV2beta1SuggestionResult
13002
+ include Google::Apis::Core::Hashable
13003
+
13004
+ # The `Status` type defines a logical error model that is suitable for different
13005
+ # programming environments, including REST APIs and RPC APIs. It is used by [
13006
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
13007
+ # data: error code, error message, and error details. You can find out more
13008
+ # about this error model and how to work with it in the [API Design Guide](https:
13009
+ # //cloud.google.com/apis/design/errors).
13010
+ # Corresponds to the JSON property `error`
13011
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
13012
+ attr_accessor :error
13013
+
13014
+ # The response message for Participants.SuggestArticles.
13015
+ # Corresponds to the JSON property `suggestArticlesResponse`
13016
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SuggestArticlesResponse]
13017
+ attr_accessor :suggest_articles_response
13018
+
13019
+ # The request message for Participants.SuggestFaqAnswers.
13020
+ # Corresponds to the JSON property `suggestFaqAnswersResponse`
13021
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse]
13022
+ attr_accessor :suggest_faq_answers_response
13023
+
13024
+ # The response message for Participants.SuggestSmartReplies.
13025
+ # Corresponds to the JSON property `suggestSmartRepliesResponse`
13026
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse]
13027
+ attr_accessor :suggest_smart_replies_response
13028
+
13029
+ def initialize(**args)
13030
+ update!(**args)
13031
+ end
13032
+
13033
+ # Update properties of this object
13034
+ def update!(**args)
13035
+ @error = args[:error] if args.key?(:error)
13036
+ @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
13037
+ @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
13038
+ @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
13039
+ end
13040
+ end
13041
+
10588
13042
  # The request message for a webhook call.
10589
13043
  class GoogleCloudDialogflowV2beta1WebhookRequest
10590
13044
  include Google::Apis::Core::Hashable
@@ -10675,6 +13129,14 @@ module Google
10675
13129
  # @return [String]
10676
13130
  attr_accessor :fulfillment_text
10677
13131
 
13132
+ # Indicates that a live agent should be brought in to handle the interaction
13133
+ # with the user. In most cases, when you set this flag to true, you would also
13134
+ # want to set end_interaction to true as well. Default is false.
13135
+ # Corresponds to the JSON property `liveAgentHandoff`
13136
+ # @return [Boolean]
13137
+ attr_accessor :live_agent_handoff
13138
+ alias_method :live_agent_handoff?, :live_agent_handoff
13139
+
10678
13140
  # Optional. The collection of output contexts that will overwrite currently
10679
13141
  # active contexts for the session and reset their lifespans. When provided,
10680
13142
  # Dialogflow uses this field to populate QueryResult.output_contexts sent to the
@@ -10721,6 +13183,7 @@ module Google
10721
13183
  @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input)
10722
13184
  @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages)
10723
13185
  @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text)
13186
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
10724
13187
  @output_contexts = args[:output_contexts] if args.key?(:output_contexts)
10725
13188
  @payload = args[:payload] if args.key?(:payload)
10726
13189
  @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types)