google-apis-dialogflow_v2 0.3.0 → 0.8.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: 983027da15ca1d00e0e19c5ffdcb075ebfc3f4ad0260b6034f7705f1940add41
4
- data.tar.gz: 90f458a42d9c125ea08a1378639f9220ab9b9742295b82a5a9bf8f2586b426d0
3
+ metadata.gz: 179d344ffbec066a2ac5eb9ee30bffad5fc6da1de71dc442bb3e050edbd8582c
4
+ data.tar.gz: d9e001c86c2f334fcf242024114698219f8154342f401d042fda90c4c972fb72
5
5
  SHA512:
6
- metadata.gz: df610e29f2e0a80727a0d0626cc65e99a3860d7f8df551f34b7b37f26cff924ac808d5e871ccd66e1ba125b1f948b3e3495cc4b6c2a27f3d5e03fea862707aed
7
- data.tar.gz: 7889379d9d90ad0e9ece9b15aaf95e81243199967f459c0adda6df94bfc4945d182fdb04d8f826fc5f028c70d1a443a37d9a8fcf4da11e6beac36fa5242acd69
6
+ metadata.gz: 6f2882102f08beac86ff74b2c21d1ab1be77de9071c11c153e5f30cad9879beb3870d34eff59d71c7fa9d6c71577a4758893d01ef7e5b43a972f58a9815a8d07
7
+ data.tar.gz: 50fea7ea5bb8d4d15e23885ec318ec1403be177ec54e93fe72d6e2d10908ffe853849693908caf3e6fa9b5d4dc4ebd218cb4fe131b4b23a0968731503ea1d08a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Release history for google-apis-dialogflow_v2
2
2
 
3
+ ### v0.8.0 (2021-03-19)
4
+
5
+ * Regenerated from discovery document revision 20210318
6
+
7
+ ### v0.7.0 (2021-03-09)
8
+
9
+ * Regenerated from discovery document revision 20210307
10
+ * Regenerated using generator version 0.2.0
11
+
12
+ ### v0.6.0 (2021-03-04)
13
+
14
+ * Unspecified changes
15
+
16
+ ### v0.5.0 (2021-02-24)
17
+
18
+ * Regenerated from discovery document revision 20210222
19
+
20
+ ### v0.4.0 (2021-02-17)
21
+
22
+ * Regenerated from discovery document revision 20210213
23
+
3
24
  ### v0.3.0 (2021-02-12)
4
25
 
5
26
  * Regenerated from discovery document revision 20210209
@@ -1371,7 +1371,7 @@ module Google
1371
1371
  attr_accessor :intent
1372
1372
 
1373
1373
  # Required. The language of the input. See [Language Support](https://cloud.
1374
- # google.com/dialogflow/docs/reference/language) for a list of the currently
1374
+ # google.com/dialogflow/cx/docs/reference/language) for a list of the currently
1375
1375
  # supported language codes. Note that queries in the same session do not
1376
1376
  # necessarily need to specify the same language.
1377
1377
  # Corresponds to the JSON property `languageCode`
@@ -3729,7 +3729,7 @@ module Google
3729
3729
  attr_accessor :intent
3730
3730
 
3731
3731
  # Required. The language of the input. See [Language Support](https://cloud.
3732
- # google.com/dialogflow/docs/reference/language) for a list of the currently
3732
+ # google.com/dialogflow/cx/docs/reference/language) for a list of the currently
3733
3733
  # supported language codes. Note that queries in the same session do not
3734
3734
  # necessarily need to specify the same language.
3735
3735
  # Corresponds to the JSON property `languageCode`
@@ -4847,6 +4847,181 @@ module Google
4847
4847
  end
4848
4848
  end
4849
4849
 
4850
+ # Detail feedback of Agent Assist result.
4851
+ class GoogleCloudDialogflowV2AgentAssistantFeedback
4852
+ include Google::Apis::Core::Hashable
4853
+
4854
+ # Optional. Whether or not the suggested answer is relevant. For example: *
4855
+ # Query: "Can I change my mailing address?" * Suggested document says: "Items
4856
+ # must be returned/exchanged within 60 days of the purchase date." *
4857
+ # answer_relevance: AnswerRelevance.IRRELEVANT
4858
+ # Corresponds to the JSON property `answerRelevance`
4859
+ # @return [String]
4860
+ attr_accessor :answer_relevance
4861
+
4862
+ # Optional. Whether or not the information in the document is correct. For
4863
+ # example: * Query: "Can I return the package in 2 days once received?" *
4864
+ # Suggested document says: "Items must be returned/exchanged within 60 days of
4865
+ # the purchase date." * Ground truth: "No return or exchange is allowed." * [
4866
+ # document_correctness]: INCORRECT
4867
+ # Corresponds to the JSON property `documentCorrectness`
4868
+ # @return [String]
4869
+ attr_accessor :document_correctness
4870
+
4871
+ # Optional. Whether or not the suggested document is efficient. For example, if
4872
+ # the document is poorly written, hard to understand, hard to use or too long to
4873
+ # find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT.
4874
+ # Corresponds to the JSON property `documentEfficiency`
4875
+ # @return [String]
4876
+ attr_accessor :document_efficiency
4877
+
4878
+ def initialize(**args)
4879
+ update!(**args)
4880
+ end
4881
+
4882
+ # Update properties of this object
4883
+ def update!(**args)
4884
+ @answer_relevance = args[:answer_relevance] if args.key?(:answer_relevance)
4885
+ @document_correctness = args[:document_correctness] if args.key?(:document_correctness)
4886
+ @document_efficiency = args[:document_efficiency] if args.key?(:document_efficiency)
4887
+ end
4888
+ end
4889
+
4890
+ # Represents a record of a human agent assist answer.
4891
+ class GoogleCloudDialogflowV2AgentAssistantRecord
4892
+ include Google::Apis::Core::Hashable
4893
+
4894
+ # Represents article answer.
4895
+ # Corresponds to the JSON property `articleSuggestionAnswer`
4896
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ArticleAnswer]
4897
+ attr_accessor :article_suggestion_answer
4898
+
4899
+ # Represents answer from "frequently asked questions".
4900
+ # Corresponds to the JSON property `faqAnswer`
4901
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2FaqAnswer]
4902
+ attr_accessor :faq_answer
4903
+
4904
+ def initialize(**args)
4905
+ update!(**args)
4906
+ end
4907
+
4908
+ # Update properties of this object
4909
+ def update!(**args)
4910
+ @article_suggestion_answer = args[:article_suggestion_answer] if args.key?(:article_suggestion_answer)
4911
+ @faq_answer = args[:faq_answer] if args.key?(:faq_answer)
4912
+ end
4913
+ end
4914
+
4915
+ # The request message for Participants.AnalyzeContent.
4916
+ class GoogleCloudDialogflowV2AnalyzeContentRequest
4917
+ include Google::Apis::Core::Hashable
4918
+
4919
+ # Events allow for matching intents by event name instead of the natural
4920
+ # language input. For instance, input `` can trigger a personalized welcome
4921
+ # response. The parameter `name` may be used by the agent in the response: `"
4922
+ # Hello #welcome_event.name! What can I do for you today?"`.
4923
+ # Corresponds to the JSON property `eventInput`
4924
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput]
4925
+ attr_accessor :event_input
4926
+
4927
+ # Represents the parameters of the conversational query.
4928
+ # Corresponds to the JSON property `queryParams`
4929
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryParameters]
4930
+ attr_accessor :query_params
4931
+
4932
+ # Instructs the speech synthesizer on how to generate the output audio content.
4933
+ # If this audio config is supplied in a request, it overrides all existing text-
4934
+ # to-speech settings applied to the agent.
4935
+ # Corresponds to the JSON property `replyAudioConfig`
4936
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig]
4937
+ attr_accessor :reply_audio_config
4938
+
4939
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
4940
+ # random UUID is recommended. This request is only idempotent if a `request_id`
4941
+ # is provided.
4942
+ # Corresponds to the JSON property `requestId`
4943
+ # @return [String]
4944
+ attr_accessor :request_id
4945
+
4946
+ # Represents the natural language text to be processed.
4947
+ # Corresponds to the JSON property `textInput`
4948
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput]
4949
+ attr_accessor :text_input
4950
+
4951
+ def initialize(**args)
4952
+ update!(**args)
4953
+ end
4954
+
4955
+ # Update properties of this object
4956
+ def update!(**args)
4957
+ @event_input = args[:event_input] if args.key?(:event_input)
4958
+ @query_params = args[:query_params] if args.key?(:query_params)
4959
+ @reply_audio_config = args[:reply_audio_config] if args.key?(:reply_audio_config)
4960
+ @request_id = args[:request_id] if args.key?(:request_id)
4961
+ @text_input = args[:text_input] if args.key?(:text_input)
4962
+ end
4963
+ end
4964
+
4965
+ # The response message for Participants.AnalyzeContent.
4966
+ class GoogleCloudDialogflowV2AnalyzeContentResponse
4967
+ include Google::Apis::Core::Hashable
4968
+
4969
+ # Represents a response from an automated agent.
4970
+ # Corresponds to the JSON property `automatedAgentReply`
4971
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AutomatedAgentReply]
4972
+ attr_accessor :automated_agent_reply
4973
+
4974
+ # The message in the response that indicates the parameters of DTMF.
4975
+ # Corresponds to the JSON property `dtmfParameters`
4976
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DtmfParameters]
4977
+ attr_accessor :dtmf_parameters
4978
+
4979
+ # The suggestions for end user. The order is the same as
4980
+ # HumanAgentAssistantConfig.SuggestionConfig.feature_configs of
4981
+ # HumanAgentAssistantConfig.end_user_suggestion_config.
4982
+ # Corresponds to the JSON property `endUserSuggestionResults`
4983
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionResult>]
4984
+ attr_accessor :end_user_suggestion_results
4985
+
4986
+ # The suggestions for most recent human agent. The order is the same as
4987
+ # HumanAgentAssistantConfig.SuggestionConfig.feature_configs of
4988
+ # HumanAgentAssistantConfig.human_agent_suggestion_config.
4989
+ # Corresponds to the JSON property `humanAgentSuggestionResults`
4990
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionResult>]
4991
+ attr_accessor :human_agent_suggestion_results
4992
+
4993
+ # Represents a message posted into a conversation.
4994
+ # Corresponds to the JSON property `message`
4995
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Message]
4996
+ attr_accessor :message
4997
+
4998
+ # Represents the natural language speech audio to be played to the end user.
4999
+ # Corresponds to the JSON property `replyAudio`
5000
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudio]
5001
+ attr_accessor :reply_audio
5002
+
5003
+ # The output text content. This field is set if the automated agent responded
5004
+ # with text to show to the user.
5005
+ # Corresponds to the JSON property `replyText`
5006
+ # @return [String]
5007
+ attr_accessor :reply_text
5008
+
5009
+ def initialize(**args)
5010
+ update!(**args)
5011
+ end
5012
+
5013
+ # Update properties of this object
5014
+ def update!(**args)
5015
+ @automated_agent_reply = args[:automated_agent_reply] if args.key?(:automated_agent_reply)
5016
+ @dtmf_parameters = args[:dtmf_parameters] if args.key?(:dtmf_parameters)
5017
+ @end_user_suggestion_results = args[:end_user_suggestion_results] if args.key?(:end_user_suggestion_results)
5018
+ @human_agent_suggestion_results = args[:human_agent_suggestion_results] if args.key?(:human_agent_suggestion_results)
5019
+ @message = args[:message] if args.key?(:message)
5020
+ @reply_audio = args[:reply_audio] if args.key?(:reply_audio)
5021
+ @reply_text = args[:reply_text] if args.key?(:reply_text)
5022
+ end
5023
+ end
5024
+
4850
5025
  # Represents a part of a message possibly annotated with an entity. The part can
4851
5026
  # be an entity or purely a part of the message between two entities or message
4852
5027
  # start/end.
@@ -4885,6 +5060,201 @@ module Google
4885
5060
  end
4886
5061
  end
4887
5062
 
5063
+ # Represents feedback the customer has about the quality & correctness of a
5064
+ # certain answer in a conversation.
5065
+ class GoogleCloudDialogflowV2AnswerFeedback
5066
+ include Google::Apis::Core::Hashable
5067
+
5068
+ # Detail feedback of Agent Assist result.
5069
+ # Corresponds to the JSON property `agentAssistantDetailFeedback`
5070
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AgentAssistantFeedback]
5071
+ attr_accessor :agent_assistant_detail_feedback
5072
+
5073
+ # Time when the answer/item was clicked.
5074
+ # Corresponds to the JSON property `clickTime`
5075
+ # @return [String]
5076
+ attr_accessor :click_time
5077
+
5078
+ # Indicates whether the answer/item was clicked by the human agent or not.
5079
+ # Default to false.
5080
+ # Corresponds to the JSON property `clicked`
5081
+ # @return [Boolean]
5082
+ attr_accessor :clicked
5083
+ alias_method :clicked?, :clicked
5084
+
5085
+ # The correctness level of the specific answer.
5086
+ # Corresponds to the JSON property `correctnessLevel`
5087
+ # @return [String]
5088
+ attr_accessor :correctness_level
5089
+
5090
+ # Time when the answer/item was displayed.
5091
+ # Corresponds to the JSON property `displayTime`
5092
+ # @return [String]
5093
+ attr_accessor :display_time
5094
+
5095
+ # Indicates whether the answer/item was displayed to the human agent in the
5096
+ # agent desktop UI. Default to false.
5097
+ # Corresponds to the JSON property `displayed`
5098
+ # @return [Boolean]
5099
+ attr_accessor :displayed
5100
+ alias_method :displayed?, :displayed
5101
+
5102
+ def initialize(**args)
5103
+ update!(**args)
5104
+ end
5105
+
5106
+ # Update properties of this object
5107
+ def update!(**args)
5108
+ @agent_assistant_detail_feedback = args[:agent_assistant_detail_feedback] if args.key?(:agent_assistant_detail_feedback)
5109
+ @click_time = args[:click_time] if args.key?(:click_time)
5110
+ @clicked = args[:clicked] if args.key?(:clicked)
5111
+ @correctness_level = args[:correctness_level] if args.key?(:correctness_level)
5112
+ @display_time = args[:display_time] if args.key?(:display_time)
5113
+ @displayed = args[:displayed] if args.key?(:displayed)
5114
+ end
5115
+ end
5116
+
5117
+ # Answer records are records to manage answer history and feedbacks for
5118
+ # Dialogflow. Currently, answer record includes: - human agent assistant article
5119
+ # suggestion - human agent assistant faq article It doesn't include: - `
5120
+ # DetectIntent` intent matching - `DetectIntent` knowledge Answer records are
5121
+ # not related to the conversation history in the Dialogflow Console. A Record is
5122
+ # generated even when the end-user disables conversation history in the console.
5123
+ # Records are created when there's a human agent assistant suggestion generated.
5124
+ # A typical workflow for customers provide feedback to an answer is: 1. For
5125
+ # human agent assistant, customers get suggestion via ListSuggestions API.
5126
+ # Together with the answers, AnswerRecord.name are returned to the customers. 2.
5127
+ # The customer uses the AnswerRecord.name to call the UpdateAnswerRecord method
5128
+ # to send feedback about a specific answer that they believe is wrong.
5129
+ class GoogleCloudDialogflowV2AnswerRecord
5130
+ include Google::Apis::Core::Hashable
5131
+
5132
+ # Represents a record of a human agent assist answer.
5133
+ # Corresponds to the JSON property `agentAssistantRecord`
5134
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AgentAssistantRecord]
5135
+ attr_accessor :agent_assistant_record
5136
+
5137
+ # Represents feedback the customer has about the quality & correctness of a
5138
+ # certain answer in a conversation.
5139
+ # Corresponds to the JSON property `answerFeedback`
5140
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerFeedback]
5141
+ attr_accessor :answer_feedback
5142
+
5143
+ # The unique identifier of this answer record. Format: `projects//locations//
5144
+ # answerRecords/`.
5145
+ # Corresponds to the JSON property `name`
5146
+ # @return [String]
5147
+ attr_accessor :name
5148
+
5149
+ def initialize(**args)
5150
+ update!(**args)
5151
+ end
5152
+
5153
+ # Update properties of this object
5154
+ def update!(**args)
5155
+ @agent_assistant_record = args[:agent_assistant_record] if args.key?(:agent_assistant_record)
5156
+ @answer_feedback = args[:answer_feedback] if args.key?(:answer_feedback)
5157
+ @name = args[:name] if args.key?(:name)
5158
+ end
5159
+ end
5160
+
5161
+ # Represents article answer.
5162
+ class GoogleCloudDialogflowV2ArticleAnswer
5163
+ include Google::Apis::Core::Hashable
5164
+
5165
+ # The name of answer record, in the format of "projects//locations//
5166
+ # answerRecords/"
5167
+ # Corresponds to the JSON property `answerRecord`
5168
+ # @return [String]
5169
+ attr_accessor :answer_record
5170
+
5171
+ # Article match confidence. The system's confidence score that this article is a
5172
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
5173
+ # to 1.0 (completely certain).
5174
+ # Corresponds to the JSON property `confidence`
5175
+ # @return [Float]
5176
+ attr_accessor :confidence
5177
+
5178
+ # A map that contains metadata about the answer and the document from which it
5179
+ # originates.
5180
+ # Corresponds to the JSON property `metadata`
5181
+ # @return [Hash<String,String>]
5182
+ attr_accessor :metadata
5183
+
5184
+ # Article snippets.
5185
+ # Corresponds to the JSON property `snippets`
5186
+ # @return [Array<String>]
5187
+ attr_accessor :snippets
5188
+
5189
+ # The article title.
5190
+ # Corresponds to the JSON property `title`
5191
+ # @return [String]
5192
+ attr_accessor :title
5193
+
5194
+ # The article URI.
5195
+ # Corresponds to the JSON property `uri`
5196
+ # @return [String]
5197
+ attr_accessor :uri
5198
+
5199
+ def initialize(**args)
5200
+ update!(**args)
5201
+ end
5202
+
5203
+ # Update properties of this object
5204
+ def update!(**args)
5205
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
5206
+ @confidence = args[:confidence] if args.key?(:confidence)
5207
+ @metadata = args[:metadata] if args.key?(:metadata)
5208
+ @snippets = args[:snippets] if args.key?(:snippets)
5209
+ @title = args[:title] if args.key?(:title)
5210
+ @uri = args[:uri] if args.key?(:uri)
5211
+ end
5212
+ end
5213
+
5214
+ # Defines the Automated Agent to connect to a conversation.
5215
+ class GoogleCloudDialogflowV2AutomatedAgentConfig
5216
+ include Google::Apis::Core::Hashable
5217
+
5218
+ # Required. ID of the Dialogflow agent environment to use. This project needs to
5219
+ # either be the same project as the conversation or you need to grant `service-@
5220
+ # gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API Service Agent`
5221
+ # role in this project. Format: `projects//locations//agent/environments/`. If
5222
+ # environment is not specified, the default `draft` environment is used. Refer
5223
+ # to [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.
5224
+ # dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest) for more details.
5225
+ # Corresponds to the JSON property `agent`
5226
+ # @return [String]
5227
+ attr_accessor :agent
5228
+
5229
+ def initialize(**args)
5230
+ update!(**args)
5231
+ end
5232
+
5233
+ # Update properties of this object
5234
+ def update!(**args)
5235
+ @agent = args[:agent] if args.key?(:agent)
5236
+ end
5237
+ end
5238
+
5239
+ # Represents a response from an automated agent.
5240
+ class GoogleCloudDialogflowV2AutomatedAgentReply
5241
+ include Google::Apis::Core::Hashable
5242
+
5243
+ # The message returned from the DetectIntent method.
5244
+ # Corresponds to the JSON property `detectIntentResponse`
5245
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse]
5246
+ attr_accessor :detect_intent_response
5247
+
5248
+ def initialize(**args)
5249
+ update!(**args)
5250
+ end
5251
+
5252
+ # Update properties of this object
5253
+ def update!(**args)
5254
+ @detect_intent_response = args[:detect_intent_response] if args.key?(:detect_intent_response)
5255
+ end
5256
+ end
5257
+
4888
5258
  # The request message for EntityTypes.BatchCreateEntities.
4889
5259
  class GoogleCloudDialogflowV2BatchCreateEntitiesRequest
4890
5260
  include Google::Apis::Core::Hashable
@@ -5144,6 +5514,19 @@ module Google
5144
5514
  end
5145
5515
  end
5146
5516
 
5517
+ # The request message for Conversations.CompleteConversation.
5518
+ class GoogleCloudDialogflowV2CompleteConversationRequest
5519
+ include Google::Apis::Core::Hashable
5520
+
5521
+ def initialize(**args)
5522
+ update!(**args)
5523
+ end
5524
+
5525
+ # Update properties of this object
5526
+ def update!(**args)
5527
+ end
5528
+ end
5529
+
5147
5530
  # Dialogflow contexts are similar to natural language context. If a person says
5148
5531
  # to you "they are orange", you need context in order to understand what "they"
5149
5532
  # is referring to. Similarly, for Dialogflow to handle an end-user expression
@@ -5205,6 +5588,75 @@ module Google
5205
5588
  end
5206
5589
  end
5207
5590
 
5591
+ # Represents a conversation. A conversation is an interaction between an agent,
5592
+ # including live agents and Dialogflow agents, and a support customer.
5593
+ # Conversations can include phone calls and text-based chat sessions.
5594
+ class GoogleCloudDialogflowV2Conversation
5595
+ include Google::Apis::Core::Hashable
5596
+
5597
+ # Required. The Conversation Profile to be used to configure this Conversation.
5598
+ # This field cannot be updated. Format: `projects//locations//
5599
+ # conversationProfiles/`.
5600
+ # Corresponds to the JSON property `conversationProfile`
5601
+ # @return [String]
5602
+ attr_accessor :conversation_profile
5603
+
5604
+ # The stage of a conversation. It indicates whether the virtual agent or a human
5605
+ # agent is handling the conversation. If the conversation is created with the
5606
+ # conversation profile that has Dialogflow config set, defaults to
5607
+ # ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to
5608
+ # ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the
5609
+ # conversation profile that has Dialogflow config set but explicitly sets
5610
+ # conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips
5611
+ # ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to
5612
+ # ConversationStage.HUMAN_ASSIST_STAGE.
5613
+ # Corresponds to the JSON property `conversationStage`
5614
+ # @return [String]
5615
+ attr_accessor :conversation_stage
5616
+
5617
+ # Output only. The time the conversation was finished.
5618
+ # Corresponds to the JSON property `endTime`
5619
+ # @return [String]
5620
+ attr_accessor :end_time
5621
+
5622
+ # Output only. The current state of the Conversation.
5623
+ # Corresponds to the JSON property `lifecycleState`
5624
+ # @return [String]
5625
+ attr_accessor :lifecycle_state
5626
+
5627
+ # Output only. The unique identifier of this conversation. Format: `projects//
5628
+ # locations//conversations/`.
5629
+ # Corresponds to the JSON property `name`
5630
+ # @return [String]
5631
+ attr_accessor :name
5632
+
5633
+ # Represents a phone number for telephony integration. It allows for connecting
5634
+ # a particular conversation over telephony.
5635
+ # Corresponds to the JSON property `phoneNumber`
5636
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationPhoneNumber]
5637
+ attr_accessor :phone_number
5638
+
5639
+ # Output only. The time the conversation was started.
5640
+ # Corresponds to the JSON property `startTime`
5641
+ # @return [String]
5642
+ attr_accessor :start_time
5643
+
5644
+ def initialize(**args)
5645
+ update!(**args)
5646
+ end
5647
+
5648
+ # Update properties of this object
5649
+ def update!(**args)
5650
+ @conversation_profile = args[:conversation_profile] if args.key?(:conversation_profile)
5651
+ @conversation_stage = args[:conversation_stage] if args.key?(:conversation_stage)
5652
+ @end_time = args[:end_time] if args.key?(:end_time)
5653
+ @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state)
5654
+ @name = args[:name] if args.key?(:name)
5655
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
5656
+ @start_time = args[:start_time] if args.key?(:start_time)
5657
+ end
5658
+ end
5659
+
5208
5660
  # Represents a notification sent to Pub/Sub subscribers for conversation
5209
5661
  # lifecycle events.
5210
5662
  class GoogleCloudDialogflowV2ConversationEvent
@@ -5249,32 +5701,134 @@ module Google
5249
5701
  end
5250
5702
  end
5251
5703
 
5252
- # The request to detect user's intent.
5253
- class GoogleCloudDialogflowV2DetectIntentRequest
5704
+ # Represents a phone number for telephony integration. It allows for connecting
5705
+ # a particular conversation over telephony.
5706
+ class GoogleCloudDialogflowV2ConversationPhoneNumber
5254
5707
  include Google::Apis::Core::Hashable
5255
5708
 
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
5258
- # can contain up to 1 minute of speech audio data.
5259
- # Corresponds to the JSON property `inputAudio`
5260
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
5709
+ # Output only. The phone number to connect to this conversation.
5710
+ # Corresponds to the JSON property `phoneNumber`
5261
5711
  # @return [String]
5262
- attr_accessor :input_audio
5712
+ attr_accessor :phone_number
5263
5713
 
5264
- # Instructs the speech synthesizer on how to generate the output audio content.
5265
- # If this audio config is supplied in a request, it overrides all existing text-
5266
- # to-speech settings applied to the agent.
5267
- # Corresponds to the JSON property `outputAudioConfig`
5268
- # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig]
5269
- attr_accessor :output_audio_config
5714
+ def initialize(**args)
5715
+ update!(**args)
5716
+ end
5270
5717
 
5271
- # Mask for output_audio_config indicating which settings in this request-level
5272
- # config should override speech synthesizer settings defined at agent-level. If
5273
- # unspecified or empty, output_audio_config replaces the agent-level config in
5274
- # its entirety.
5275
- # Corresponds to the JSON property `outputAudioConfigMask`
5276
- # @return [String]
5277
- attr_accessor :output_audio_config_mask
5718
+ # Update properties of this object
5719
+ def update!(**args)
5720
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
5721
+ end
5722
+ end
5723
+
5724
+ # Defines the services to connect to incoming Dialogflow conversations.
5725
+ class GoogleCloudDialogflowV2ConversationProfile
5726
+ include Google::Apis::Core::Hashable
5727
+
5728
+ # Defines the Automated Agent to connect to a conversation.
5729
+ # Corresponds to the JSON property `automatedAgentConfig`
5730
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AutomatedAgentConfig]
5731
+ attr_accessor :automated_agent_config
5732
+
5733
+ # Output only. Create time of the conversation profile.
5734
+ # Corresponds to the JSON property `createTime`
5735
+ # @return [String]
5736
+ attr_accessor :create_time
5737
+
5738
+ # Required. Human readable name for this profile. Max length 1024 bytes.
5739
+ # Corresponds to the JSON property `displayName`
5740
+ # @return [String]
5741
+ attr_accessor :display_name
5742
+
5743
+ # Defines the Human Agent Assist to connect to a conversation.
5744
+ # Corresponds to the JSON property `humanAgentAssistantConfig`
5745
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfig]
5746
+ attr_accessor :human_agent_assistant_config
5747
+
5748
+ # Language which represents the conversationProfile. If unspecified, the default
5749
+ # language code en-us applies. Users need to create a ConversationProfile for
5750
+ # each language they want to support.
5751
+ # Corresponds to the JSON property `languageCode`
5752
+ # @return [String]
5753
+ attr_accessor :language_code
5754
+
5755
+ # Defines logging behavior for conversation lifecycle events.
5756
+ # Corresponds to the JSON property `loggingConfig`
5757
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2LoggingConfig]
5758
+ attr_accessor :logging_config
5759
+
5760
+ # The unique identifier of this conversation profile. Format: `projects//
5761
+ # locations//conversationProfiles/`.
5762
+ # Corresponds to the JSON property `name`
5763
+ # @return [String]
5764
+ attr_accessor :name
5765
+
5766
+ # Defines notification behavior.
5767
+ # Corresponds to the JSON property `newMessageEventNotificationConfig`
5768
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig]
5769
+ attr_accessor :new_message_event_notification_config
5770
+
5771
+ # Defines notification behavior.
5772
+ # Corresponds to the JSON property `notificationConfig`
5773
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig]
5774
+ attr_accessor :notification_config
5775
+
5776
+ # Configures speech transcription for ConversationProfile.
5777
+ # Corresponds to the JSON property `sttConfig`
5778
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SpeechToTextConfig]
5779
+ attr_accessor :stt_config
5780
+
5781
+ # Output only. Update time of the conversation profile.
5782
+ # Corresponds to the JSON property `updateTime`
5783
+ # @return [String]
5784
+ attr_accessor :update_time
5785
+
5786
+ def initialize(**args)
5787
+ update!(**args)
5788
+ end
5789
+
5790
+ # Update properties of this object
5791
+ def update!(**args)
5792
+ @automated_agent_config = args[:automated_agent_config] if args.key?(:automated_agent_config)
5793
+ @create_time = args[:create_time] if args.key?(:create_time)
5794
+ @display_name = args[:display_name] if args.key?(:display_name)
5795
+ @human_agent_assistant_config = args[:human_agent_assistant_config] if args.key?(:human_agent_assistant_config)
5796
+ @language_code = args[:language_code] if args.key?(:language_code)
5797
+ @logging_config = args[:logging_config] if args.key?(:logging_config)
5798
+ @name = args[:name] if args.key?(:name)
5799
+ @new_message_event_notification_config = args[:new_message_event_notification_config] if args.key?(:new_message_event_notification_config)
5800
+ @notification_config = args[:notification_config] if args.key?(:notification_config)
5801
+ @stt_config = args[:stt_config] if args.key?(:stt_config)
5802
+ @update_time = args[:update_time] if args.key?(:update_time)
5803
+ end
5804
+ end
5805
+
5806
+ # The request to detect user's intent.
5807
+ class GoogleCloudDialogflowV2DetectIntentRequest
5808
+ include Google::Apis::Core::Hashable
5809
+
5810
+ # The natural language speech audio to be processed. This field should be
5811
+ # populated iff `query_input` is set to an input audio config. A single request
5812
+ # can contain up to 1 minute of speech audio data.
5813
+ # Corresponds to the JSON property `inputAudio`
5814
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
5815
+ # @return [String]
5816
+ attr_accessor :input_audio
5817
+
5818
+ # Instructs the speech synthesizer on how to generate the output audio content.
5819
+ # If this audio config is supplied in a request, it overrides all existing text-
5820
+ # to-speech settings applied to the agent.
5821
+ # Corresponds to the JSON property `outputAudioConfig`
5822
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig]
5823
+ attr_accessor :output_audio_config
5824
+
5825
+ # Mask for output_audio_config indicating which settings in this request-level
5826
+ # config should override speech synthesizer settings defined at agent-level. If
5827
+ # unspecified or empty, output_audio_config replaces the agent-level config in
5828
+ # its entirety.
5829
+ # Corresponds to the JSON property `outputAudioConfigMask`
5830
+ # @return [String]
5831
+ attr_accessor :output_audio_config_mask
5278
5832
 
5279
5833
  # Represents the query input. It can contain either: 1. An audio config which
5280
5834
  # instructs the speech recognizer how to process the speech audio. 2. A
@@ -5362,6 +5916,150 @@ module Google
5362
5916
  end
5363
5917
  end
5364
5918
 
5919
+ # A knowledge document to be used by a KnowledgeBase. For more information, see
5920
+ # the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/
5921
+ # knowledge-bases). Note: The `projects.agent.knowledgeBases.documents` resource
5922
+ # is deprecated; only use `projects.knowledgeBases.documents`.
5923
+ class GoogleCloudDialogflowV2Document
5924
+ include Google::Apis::Core::Hashable
5925
+
5926
+ # The URI where the file content is located. For documents stored in Google
5927
+ # Cloud Storage, these URIs must have the form `gs:///`. NOTE: External URLs
5928
+ # must correspond to public webpages, i.e., they must be indexed by Google
5929
+ # Search. In particular, URLs for showing documents in Google Cloud Storage (i.e.
5930
+ # the URL in your browser) are not supported. Instead use the `gs://` format
5931
+ # URI described above.
5932
+ # Corresponds to the JSON property `contentUri`
5933
+ # @return [String]
5934
+ attr_accessor :content_uri
5935
+
5936
+ # Required. The display name of the document. The name must be 1024 bytes or
5937
+ # less; otherwise, the creation request fails.
5938
+ # Corresponds to the JSON property `displayName`
5939
+ # @return [String]
5940
+ attr_accessor :display_name
5941
+
5942
+ # Optional. If true, we try to automatically reload the document every day (at a
5943
+ # time picked by the system). If false or unspecified, we don't try to
5944
+ # automatically reload the document. Currently you can only enable automatic
5945
+ # reload for documents sourced from a public url, see `source` field for the
5946
+ # source types. Reload status can be tracked in `latest_reload_status`. If a
5947
+ # reload fails, we will keep the document unchanged. If a reload fails with
5948
+ # internal errors, the system will try to reload the document on the next day.
5949
+ # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
5950
+ # system will not try to reload the document anymore. You need to manually
5951
+ # reload the document successfully by calling `ReloadDocument` and clear the
5952
+ # errors.
5953
+ # Corresponds to the JSON property `enableAutoReload`
5954
+ # @return [Boolean]
5955
+ attr_accessor :enable_auto_reload
5956
+ alias_method :enable_auto_reload?, :enable_auto_reload
5957
+
5958
+ # Required. The knowledge type of document content.
5959
+ # Corresponds to the JSON property `knowledgeTypes`
5960
+ # @return [Array<String>]
5961
+ attr_accessor :knowledge_types
5962
+
5963
+ # The status of a reload attempt.
5964
+ # Corresponds to the JSON property `latestReloadStatus`
5965
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DocumentReloadStatus]
5966
+ attr_accessor :latest_reload_status
5967
+
5968
+ # Optional. Metadata for the document. The metadata supports arbitrary key-value
5969
+ # pairs. Suggested use cases include storing a document's title, an external URL
5970
+ # distinct from the document's content_uri, etc. The max size of a `key` or a `
5971
+ # value` of the metadata is 1024 bytes.
5972
+ # Corresponds to the JSON property `metadata`
5973
+ # @return [Hash<String,String>]
5974
+ attr_accessor :metadata
5975
+
5976
+ # Required. The MIME type of this document.
5977
+ # Corresponds to the JSON property `mimeType`
5978
+ # @return [String]
5979
+ attr_accessor :mime_type
5980
+
5981
+ # Optional. The document resource name. The name must be empty when creating a
5982
+ # document. Format: `projects//locations//knowledgeBases//documents/`.
5983
+ # Corresponds to the JSON property `name`
5984
+ # @return [String]
5985
+ attr_accessor :name
5986
+
5987
+ # The raw content of the document. This field is only permitted for
5988
+ # EXTRACTIVE_QA and FAQ knowledge types.
5989
+ # Corresponds to the JSON property `rawContent`
5990
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
5991
+ # @return [String]
5992
+ attr_accessor :raw_content
5993
+
5994
+ def initialize(**args)
5995
+ update!(**args)
5996
+ end
5997
+
5998
+ # Update properties of this object
5999
+ def update!(**args)
6000
+ @content_uri = args[:content_uri] if args.key?(:content_uri)
6001
+ @display_name = args[:display_name] if args.key?(:display_name)
6002
+ @enable_auto_reload = args[:enable_auto_reload] if args.key?(:enable_auto_reload)
6003
+ @knowledge_types = args[:knowledge_types] if args.key?(:knowledge_types)
6004
+ @latest_reload_status = args[:latest_reload_status] if args.key?(:latest_reload_status)
6005
+ @metadata = args[:metadata] if args.key?(:metadata)
6006
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
6007
+ @name = args[:name] if args.key?(:name)
6008
+ @raw_content = args[:raw_content] if args.key?(:raw_content)
6009
+ end
6010
+ end
6011
+
6012
+ # The status of a reload attempt.
6013
+ class GoogleCloudDialogflowV2DocumentReloadStatus
6014
+ include Google::Apis::Core::Hashable
6015
+
6016
+ # The `Status` type defines a logical error model that is suitable for different
6017
+ # programming environments, including REST APIs and RPC APIs. It is used by [
6018
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
6019
+ # data: error code, error message, and error details. You can find out more
6020
+ # about this error model and how to work with it in the [API Design Guide](https:
6021
+ # //cloud.google.com/apis/design/errors).
6022
+ # Corresponds to the JSON property `status`
6023
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
6024
+ attr_accessor :status
6025
+
6026
+ # The time of a reload attempt. This reload may have been triggered
6027
+ # automatically or manually and may not have succeeded.
6028
+ # Corresponds to the JSON property `time`
6029
+ # @return [String]
6030
+ attr_accessor :time
6031
+
6032
+ def initialize(**args)
6033
+ update!(**args)
6034
+ end
6035
+
6036
+ # Update properties of this object
6037
+ def update!(**args)
6038
+ @status = args[:status] if args.key?(:status)
6039
+ @time = args[:time] if args.key?(:time)
6040
+ end
6041
+ end
6042
+
6043
+ # The message in the response that indicates the parameters of DTMF.
6044
+ class GoogleCloudDialogflowV2DtmfParameters
6045
+ include Google::Apis::Core::Hashable
6046
+
6047
+ # Indicates whether DTMF input can be handled in the next request.
6048
+ # Corresponds to the JSON property `acceptsDtmfInput`
6049
+ # @return [Boolean]
6050
+ attr_accessor :accepts_dtmf_input
6051
+ alias_method :accepts_dtmf_input?, :accepts_dtmf_input
6052
+
6053
+ def initialize(**args)
6054
+ update!(**args)
6055
+ end
6056
+
6057
+ # Update properties of this object
6058
+ def update!(**args)
6059
+ @accepts_dtmf_input = args[:accepts_dtmf_input] if args.key?(:accepts_dtmf_input)
6060
+ end
6061
+ end
6062
+
5365
6063
  # Each intent parameter has a type, called the entity type, which dictates
5366
6064
  # exactly how data from an end-user expression is extracted. Dialogflow provides
5367
6065
  # predefined system entities that can match many common types of data. For
@@ -5623,6 +6321,60 @@ module Google
5623
6321
  end
5624
6322
  end
5625
6323
 
6324
+ # Represents answer from "frequently asked questions".
6325
+ class GoogleCloudDialogflowV2FaqAnswer
6326
+ include Google::Apis::Core::Hashable
6327
+
6328
+ # The piece of text from the `source` knowledge base document.
6329
+ # Corresponds to the JSON property `answer`
6330
+ # @return [String]
6331
+ attr_accessor :answer
6332
+
6333
+ # The name of answer record, in the format of "projects//locations//
6334
+ # answerRecords/"
6335
+ # Corresponds to the JSON property `answerRecord`
6336
+ # @return [String]
6337
+ attr_accessor :answer_record
6338
+
6339
+ # The system's confidence score that this Knowledge answer is a good match for
6340
+ # this conversational query, range from 0.0 (completely uncertain) to 1.0 (
6341
+ # completely certain).
6342
+ # Corresponds to the JSON property `confidence`
6343
+ # @return [Float]
6344
+ attr_accessor :confidence
6345
+
6346
+ # A map that contains metadata about the answer and the document from which it
6347
+ # originates.
6348
+ # Corresponds to the JSON property `metadata`
6349
+ # @return [Hash<String,String>]
6350
+ attr_accessor :metadata
6351
+
6352
+ # The corresponding FAQ question.
6353
+ # Corresponds to the JSON property `question`
6354
+ # @return [String]
6355
+ attr_accessor :question
6356
+
6357
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
6358
+ # projects//locations//agent/knowledgeBases//documents/`.
6359
+ # Corresponds to the JSON property `source`
6360
+ # @return [String]
6361
+ attr_accessor :source
6362
+
6363
+ def initialize(**args)
6364
+ update!(**args)
6365
+ end
6366
+
6367
+ # Update properties of this object
6368
+ def update!(**args)
6369
+ @answer = args[:answer] if args.key?(:answer)
6370
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
6371
+ @confidence = args[:confidence] if args.key?(:confidence)
6372
+ @metadata = args[:metadata] if args.key?(:metadata)
6373
+ @question = args[:question] if args.key?(:question)
6374
+ @source = args[:source] if args.key?(:source)
6375
+ end
6376
+ end
6377
+
5626
6378
  # By default, your agent responds to a matched intent with a static response. As
5627
6379
  # an alternative, you can provide a more dynamic response by using fulfillment.
5628
6380
  # When you enable fulfillment for an intent, Dialogflow responds to that intent
@@ -5711,29 +6463,415 @@ module Google
5711
6463
  # integration. Defaults to false.
5712
6464
  # Corresponds to the JSON property `isCloudFunction`
5713
6465
  # @return [Boolean]
5714
- attr_accessor :is_cloud_function
5715
- alias_method :is_cloud_function?, :is_cloud_function
6466
+ attr_accessor :is_cloud_function
6467
+ alias_method :is_cloud_function?, :is_cloud_function
6468
+
6469
+ # Optional. The password for HTTP Basic authentication.
6470
+ # Corresponds to the JSON property `password`
6471
+ # @return [String]
6472
+ attr_accessor :password
6473
+
6474
+ # Optional. The HTTP request headers to send together with fulfillment requests.
6475
+ # Corresponds to the JSON property `requestHeaders`
6476
+ # @return [Hash<String,String>]
6477
+ attr_accessor :request_headers
6478
+
6479
+ # Required. The fulfillment URI for receiving POST requests. It must use https
6480
+ # protocol.
6481
+ # Corresponds to the JSON property `uri`
6482
+ # @return [String]
6483
+ attr_accessor :uri
6484
+
6485
+ # Optional. The user name for HTTP Basic authentication.
6486
+ # Corresponds to the JSON property `username`
6487
+ # @return [String]
6488
+ attr_accessor :username
6489
+
6490
+ def initialize(**args)
6491
+ update!(**args)
6492
+ end
6493
+
6494
+ # Update properties of this object
6495
+ def update!(**args)
6496
+ @is_cloud_function = args[:is_cloud_function] if args.key?(:is_cloud_function)
6497
+ @password = args[:password] if args.key?(:password)
6498
+ @request_headers = args[:request_headers] if args.key?(:request_headers)
6499
+ @uri = args[:uri] if args.key?(:uri)
6500
+ @username = args[:username] if args.key?(:username)
6501
+ end
6502
+ end
6503
+
6504
+ # Defines the Human Agent Assist to connect to a conversation.
6505
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfig
6506
+ include Google::Apis::Core::Hashable
6507
+
6508
+ # Detail human agent assistant config.
6509
+ # Corresponds to the JSON property `humanAgentSuggestionConfig`
6510
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig]
6511
+ attr_accessor :human_agent_suggestion_config
6512
+
6513
+ # Configuration for analyses to run on each conversation message.
6514
+ # Corresponds to the JSON property `messageAnalysisConfig`
6515
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig]
6516
+ attr_accessor :message_analysis_config
6517
+
6518
+ # Defines notification behavior.
6519
+ # Corresponds to the JSON property `notificationConfig`
6520
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig]
6521
+ attr_accessor :notification_config
6522
+
6523
+ def initialize(**args)
6524
+ update!(**args)
6525
+ end
6526
+
6527
+ # Update properties of this object
6528
+ def update!(**args)
6529
+ @human_agent_suggestion_config = args[:human_agent_suggestion_config] if args.key?(:human_agent_suggestion_config)
6530
+ @message_analysis_config = args[:message_analysis_config] if args.key?(:message_analysis_config)
6531
+ @notification_config = args[:notification_config] if args.key?(:notification_config)
6532
+ end
6533
+ end
6534
+
6535
+ # Custom conversation models used in agent assist feature. Supported feature:
6536
+ # ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY.
6537
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig
6538
+ include Google::Apis::Core::Hashable
6539
+
6540
+ # Required. Conversation model resource name. Format: `projects//
6541
+ # conversationModels/`.
6542
+ # Corresponds to the JSON property `model`
6543
+ # @return [String]
6544
+ attr_accessor :model
6545
+
6546
+ def initialize(**args)
6547
+ update!(**args)
6548
+ end
6549
+
6550
+ # Update properties of this object
6551
+ def update!(**args)
6552
+ @model = args[:model] if args.key?(:model)
6553
+ end
6554
+ end
6555
+
6556
+ # Configuration for analyses to run on each conversation message.
6557
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig
6558
+ include Google::Apis::Core::Hashable
6559
+
6560
+ # Enable sentiment analysis in conversation messages on [agent assist stage](
6561
+ # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
6562
+ # If unspecified, defaults to false. Sentiment analysis inspects user input and
6563
+ # identifies the prevailing subjective opinion, especially to determine a user's
6564
+ # attitude as positive, negative, or neutral: https://cloud.google.com/natural-
6565
+ # language/docs/basics#sentiment_analysis For Participants.
6566
+ # StreamingAnalyzeContent method, result will be in
6567
+ # StreamingAnalyzeContentResponse.message.SentimentAnalysisResult. For
6568
+ # Participants.AnalyzeContent method, result will be in AnalyzeContentResponse.
6569
+ # message.SentimentAnalysisResult For Conversations.ListMessages method, result
6570
+ # will be in ListMessagesResponse.messages.SentimentAnalysisResult If Pub/Sub
6571
+ # notification is configured, result will be in ConversationEvent.
6572
+ # new_message_payload.SentimentAnalysisResult.
6573
+ # Corresponds to the JSON property `enableSentimentAnalysis`
6574
+ # @return [Boolean]
6575
+ attr_accessor :enable_sentiment_analysis
6576
+ alias_method :enable_sentiment_analysis?, :enable_sentiment_analysis
6577
+
6578
+ def initialize(**args)
6579
+ update!(**args)
6580
+ end
6581
+
6582
+ # Update properties of this object
6583
+ def update!(**args)
6584
+ @enable_sentiment_analysis = args[:enable_sentiment_analysis] if args.key?(:enable_sentiment_analysis)
6585
+ end
6586
+ end
6587
+
6588
+ # Detail human agent assistant config.
6589
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig
6590
+ include Google::Apis::Core::Hashable
6591
+
6592
+ # Configuration of different suggestion features. One feature can have only one
6593
+ # config.
6594
+ # Corresponds to the JSON property `featureConfigs`
6595
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig>]
6596
+ attr_accessor :feature_configs
6597
+
6598
+ # If `group_suggestion_responses` is false, and there are multiple `
6599
+ # feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we
6600
+ # will try to deliver suggestions to customers as soon as we get new suggestion.
6601
+ # Different type of suggestions based on the same context will be in separate
6602
+ # Pub/Sub event or `StreamingAnalyzeContentResponse`. If `
6603
+ # group_suggestion_responses` set to true. All the suggestions to the same
6604
+ # participant based on the same context will be grouped into a single Pub/Sub
6605
+ # event or StreamingAnalyzeContentResponse.
6606
+ # Corresponds to the JSON property `groupSuggestionResponses`
6607
+ # @return [Boolean]
6608
+ attr_accessor :group_suggestion_responses
6609
+ alias_method :group_suggestion_responses?, :group_suggestion_responses
6610
+
6611
+ def initialize(**args)
6612
+ update!(**args)
6613
+ end
6614
+
6615
+ # Update properties of this object
6616
+ def update!(**args)
6617
+ @feature_configs = args[:feature_configs] if args.key?(:feature_configs)
6618
+ @group_suggestion_responses = args[:group_suggestion_responses] if args.key?(:group_suggestion_responses)
6619
+ end
6620
+ end
6621
+
6622
+ # Config for suggestion features.
6623
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig
6624
+ include Google::Apis::Core::Hashable
6625
+
6626
+ # Custom conversation models used in agent assist feature. Supported feature:
6627
+ # ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY.
6628
+ # Corresponds to the JSON property `conversationModelConfig`
6629
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig]
6630
+ attr_accessor :conversation_model_config
6631
+
6632
+ # Automatically iterates all participants and tries to compile suggestions.
6633
+ # Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST.
6634
+ # Corresponds to the JSON property `enableEventBasedSuggestion`
6635
+ # @return [Boolean]
6636
+ attr_accessor :enable_event_based_suggestion
6637
+ alias_method :enable_event_based_suggestion?, :enable_event_based_suggestion
6638
+
6639
+ # Config for suggestion query.
6640
+ # Corresponds to the JSON property `queryConfig`
6641
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig]
6642
+ attr_accessor :query_config
6643
+
6644
+ # The type of Human Agent Assistant API suggestion to perform, and the maximum
6645
+ # number of results to return for that type. Multiple `Feature` objects can be
6646
+ # specified in the `features` list.
6647
+ # Corresponds to the JSON property `suggestionFeature`
6648
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionFeature]
6649
+ attr_accessor :suggestion_feature
6650
+
6651
+ # Settings of suggestion trigger.
6652
+ # Corresponds to the JSON property `suggestionTriggerSettings`
6653
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionTriggerSettings]
6654
+ attr_accessor :suggestion_trigger_settings
6655
+
6656
+ def initialize(**args)
6657
+ update!(**args)
6658
+ end
6659
+
6660
+ # Update properties of this object
6661
+ def update!(**args)
6662
+ @conversation_model_config = args[:conversation_model_config] if args.key?(:conversation_model_config)
6663
+ @enable_event_based_suggestion = args[:enable_event_based_suggestion] if args.key?(:enable_event_based_suggestion)
6664
+ @query_config = args[:query_config] if args.key?(:query_config)
6665
+ @suggestion_feature = args[:suggestion_feature] if args.key?(:suggestion_feature)
6666
+ @suggestion_trigger_settings = args[:suggestion_trigger_settings] if args.key?(:suggestion_trigger_settings)
6667
+ end
6668
+ end
6669
+
6670
+ # Config for suggestion query.
6671
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig
6672
+ include Google::Apis::Core::Hashable
6673
+
6674
+ # Confidence threshold of query result. Agent Assist gives each suggestion a
6675
+ # score in the range [0.0, 1.0], based on the relevance between the suggestion
6676
+ # and the current conversation context. A score of 0.0 has no relevance, while a
6677
+ # score of 1.0 has high relevance. Only suggestions with a score greater than or
6678
+ # equal to the value of this field are included in the results. For a baseline
6679
+ # model (the default), the recommended value is in the range [0.05, 0.1]. For a
6680
+ # custom model, there is no recommended value. Tune this value by starting from
6681
+ # a very low value and slowly increasing until you have desired results. If this
6682
+ # field is not set, it defaults to 0.0, which means that all suggestions are
6683
+ # returned. Supported features: ARTICLE_SUGGESTION.
6684
+ # Corresponds to the JSON property `confidenceThreshold`
6685
+ # @return [Float]
6686
+ attr_accessor :confidence_threshold
6687
+
6688
+ # Settings that determine how to filter recent conversation context when
6689
+ # generating suggestions.
6690
+ # Corresponds to the JSON property `contextFilterSettings`
6691
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings]
6692
+ attr_accessor :context_filter_settings
6693
+
6694
+ # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST.
6695
+ # Corresponds to the JSON property `dialogflowQuerySource`
6696
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource]
6697
+ attr_accessor :dialogflow_query_source
6698
+
6699
+ # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE.
6700
+ # Corresponds to the JSON property `documentQuerySource`
6701
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource]
6702
+ attr_accessor :document_query_source
6703
+
6704
+ # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ.
6705
+ # Corresponds to the JSON property `knowledgeBaseQuerySource`
6706
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource]
6707
+ attr_accessor :knowledge_base_query_source
6708
+
6709
+ # Maximum number of results to return. Currently, if unset, defaults to 10. And
6710
+ # the max number is 20.
6711
+ # Corresponds to the JSON property `maxResults`
6712
+ # @return [Fixnum]
6713
+ attr_accessor :max_results
6714
+
6715
+ def initialize(**args)
6716
+ update!(**args)
6717
+ end
6718
+
6719
+ # Update properties of this object
6720
+ def update!(**args)
6721
+ @confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold)
6722
+ @context_filter_settings = args[:context_filter_settings] if args.key?(:context_filter_settings)
6723
+ @dialogflow_query_source = args[:dialogflow_query_source] if args.key?(:dialogflow_query_source)
6724
+ @document_query_source = args[:document_query_source] if args.key?(:document_query_source)
6725
+ @knowledge_base_query_source = args[:knowledge_base_query_source] if args.key?(:knowledge_base_query_source)
6726
+ @max_results = args[:max_results] if args.key?(:max_results)
6727
+ end
6728
+ end
6729
+
6730
+ # Settings that determine how to filter recent conversation context when
6731
+ # generating suggestions.
6732
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings
6733
+ include Google::Apis::Core::Hashable
6734
+
6735
+ # If set to true, the last message from virtual agent (hand off message) and the
6736
+ # message before it (trigger message of hand off) are dropped.
6737
+ # Corresponds to the JSON property `dropHandoffMessages`
6738
+ # @return [Boolean]
6739
+ attr_accessor :drop_handoff_messages
6740
+ alias_method :drop_handoff_messages?, :drop_handoff_messages
6741
+
6742
+ # If set to true, all messages from ivr stage are dropped.
6743
+ # Corresponds to the JSON property `dropIvrMessages`
6744
+ # @return [Boolean]
6745
+ attr_accessor :drop_ivr_messages
6746
+ alias_method :drop_ivr_messages?, :drop_ivr_messages
6747
+
6748
+ # If set to true, all messages from virtual agent are dropped.
6749
+ # Corresponds to the JSON property `dropVirtualAgentMessages`
6750
+ # @return [Boolean]
6751
+ attr_accessor :drop_virtual_agent_messages
6752
+ alias_method :drop_virtual_agent_messages?, :drop_virtual_agent_messages
6753
+
6754
+ def initialize(**args)
6755
+ update!(**args)
6756
+ end
6757
+
6758
+ # Update properties of this object
6759
+ def update!(**args)
6760
+ @drop_handoff_messages = args[:drop_handoff_messages] if args.key?(:drop_handoff_messages)
6761
+ @drop_ivr_messages = args[:drop_ivr_messages] if args.key?(:drop_ivr_messages)
6762
+ @drop_virtual_agent_messages = args[:drop_virtual_agent_messages] if args.key?(:drop_virtual_agent_messages)
6763
+ end
6764
+ end
6765
+
6766
+ # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST.
6767
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource
6768
+ include Google::Apis::Core::Hashable
6769
+
6770
+ # Required. The name of a Dialogflow virtual agent used for end user side intent
6771
+ # detection and suggestion. Format: `projects//locations//agent`. When multiple
6772
+ # agents are allowed in the same Dialogflow project.
6773
+ # Corresponds to the JSON property `agent`
6774
+ # @return [String]
6775
+ attr_accessor :agent
6776
+
6777
+ def initialize(**args)
6778
+ update!(**args)
6779
+ end
6780
+
6781
+ # Update properties of this object
6782
+ def update!(**args)
6783
+ @agent = args[:agent] if args.key?(:agent)
6784
+ end
6785
+ end
6786
+
6787
+ # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE.
6788
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource
6789
+ include Google::Apis::Core::Hashable
6790
+
6791
+ # Required. Knowledge documents to query from. Format: `projects//locations//
6792
+ # knowledgeBases//documents/`. Currently, at most 5 documents are supported.
6793
+ # Corresponds to the JSON property `documents`
6794
+ # @return [Array<String>]
6795
+ attr_accessor :documents
6796
+
6797
+ def initialize(**args)
6798
+ update!(**args)
6799
+ end
6800
+
6801
+ # Update properties of this object
6802
+ def update!(**args)
6803
+ @documents = args[:documents] if args.key?(:documents)
6804
+ end
6805
+ end
6806
+
6807
+ # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ.
6808
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource
6809
+ include Google::Apis::Core::Hashable
6810
+
6811
+ # Required. Knowledge bases to query. Format: `projects//locations//
6812
+ # knowledgeBases/`. Currently, at most 5 knowledge bases are supported.
6813
+ # Corresponds to the JSON property `knowledgeBases`
6814
+ # @return [Array<String>]
6815
+ attr_accessor :knowledge_bases
6816
+
6817
+ def initialize(**args)
6818
+ update!(**args)
6819
+ end
6820
+
6821
+ # Update properties of this object
6822
+ def update!(**args)
6823
+ @knowledge_bases = args[:knowledge_bases] if args.key?(:knowledge_bases)
6824
+ end
6825
+ end
6826
+
6827
+ # Settings of suggestion trigger.
6828
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionTriggerSettings
6829
+ include Google::Apis::Core::Hashable
6830
+
6831
+ # Do not trigger if last utterance is small talk.
6832
+ # Corresponds to the JSON property `noSmalltalk`
6833
+ # @return [Boolean]
6834
+ attr_accessor :no_smalltalk
6835
+ alias_method :no_smalltalk?, :no_smalltalk
6836
+
6837
+ # Only trigger suggestion if participant role of last utterance is END_USER.
6838
+ # Corresponds to the JSON property `onlyEndUser`
6839
+ # @return [Boolean]
6840
+ attr_accessor :only_end_user
6841
+ alias_method :only_end_user?, :only_end_user
5716
6842
 
5717
- # Optional. The password for HTTP Basic authentication.
5718
- # Corresponds to the JSON property `password`
5719
- # @return [String]
5720
- attr_accessor :password
6843
+ def initialize(**args)
6844
+ update!(**args)
6845
+ end
5721
6846
 
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
6847
+ # Update properties of this object
6848
+ def update!(**args)
6849
+ @no_smalltalk = args[:no_smalltalk] if args.key?(:no_smalltalk)
6850
+ @only_end_user = args[:only_end_user] if args.key?(:only_end_user)
6851
+ end
6852
+ end
5726
6853
 
5727
- # Required. The fulfillment URI for receiving POST requests. It must use https
5728
- # protocol.
5729
- # Corresponds to the JSON property `uri`
6854
+ # Represents a notification sent to Cloud Pub/Sub subscribers for human agent
6855
+ # assistant events in a specific conversation.
6856
+ class GoogleCloudDialogflowV2HumanAgentAssistantEvent
6857
+ include Google::Apis::Core::Hashable
6858
+
6859
+ # The conversation this notification refers to. Format: `projects//conversations/
6860
+ # `.
6861
+ # Corresponds to the JSON property `conversation`
5730
6862
  # @return [String]
5731
- attr_accessor :uri
6863
+ attr_accessor :conversation
5732
6864
 
5733
- # Optional. The user name for HTTP Basic authentication.
5734
- # Corresponds to the JSON property `username`
6865
+ # The participant that the suggestion is compiled for. Format: `projects//
6866
+ # conversations//participants/`. It will not be set in legacy workflow.
6867
+ # Corresponds to the JSON property `participant`
5735
6868
  # @return [String]
5736
- attr_accessor :username
6869
+ attr_accessor :participant
6870
+
6871
+ # The suggestion results payload that this notification refers to.
6872
+ # Corresponds to the JSON property `suggestionResults`
6873
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionResult>]
6874
+ attr_accessor :suggestion_results
5737
6875
 
5738
6876
  def initialize(**args)
5739
6877
  update!(**args)
@@ -5741,11 +6879,9 @@ module Google
5741
6879
 
5742
6880
  # Update properties of this object
5743
6881
  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)
6882
+ @conversation = args[:conversation] if args.key?(:conversation)
6883
+ @participant = args[:participant] if args.key?(:participant)
6884
+ @suggestion_results = args[:suggestion_results] if args.key?(:suggestion_results)
5749
6885
  end
5750
6886
  end
5751
6887
 
@@ -5785,6 +6921,14 @@ module Google
5785
6921
  # @return [String]
5786
6922
  attr_accessor :audio_encoding
5787
6923
 
6924
+ # Only used in Participants.AnalyzeContent and Participants.
6925
+ # StreamingAnalyzeContent. If `false` and recognition doesn't return any result,
6926
+ # trigger `NO_SPEECH_RECOGNIZED` event to Dialogflow agent.
6927
+ # Corresponds to the JSON property `disableNoSpeechRecognizedEvent`
6928
+ # @return [Boolean]
6929
+ attr_accessor :disable_no_speech_recognized_event
6930
+ alias_method :disable_no_speech_recognized_event?, :disable_no_speech_recognized_event
6931
+
5788
6932
  # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult
5789
6933
  # with information about the recognized speech words, e.g. start and end time
5790
6934
  # offsets. If false or unspecified, Speech doesn't return any word-level
@@ -5864,6 +7008,7 @@ module Google
5864
7008
  # Update properties of this object
5865
7009
  def update!(**args)
5866
7010
  @audio_encoding = args[:audio_encoding] if args.key?(:audio_encoding)
7011
+ @disable_no_speech_recognized_event = args[:disable_no_speech_recognized_event] if args.key?(:disable_no_speech_recognized_event)
5867
7012
  @enable_word_info = args[:enable_word_info] if args.key?(:enable_word_info)
5868
7013
  @language_code = args[:language_code] if args.key?(:language_code)
5869
7014
  @model = args[:model] if args.key?(:model)
@@ -5902,6 +7047,14 @@ module Google
5902
7047
  # @return [String]
5903
7048
  attr_accessor :display_name
5904
7049
 
7050
+ # Optional. Indicates that this intent ends an interaction. Some integrations (e.
7051
+ # g., Actions on Google or Dialogflow phone gateway) use this information to
7052
+ # close interaction with an end user. Default is false.
7053
+ # Corresponds to the JSON property `endInteraction`
7054
+ # @return [Boolean]
7055
+ attr_accessor :end_interaction
7056
+ alias_method :end_interaction?, :end_interaction
7057
+
5905
7058
  # Optional. The collection of event names that trigger the intent. If the
5906
7059
  # collection of input contexts is not empty, all of the contexts must be present
5907
7060
  # in the active user session for an event to trigger this intent. Event names
@@ -5928,6 +7081,14 @@ module Google
5928
7081
  attr_accessor :is_fallback
5929
7082
  alias_method :is_fallback?, :is_fallback
5930
7083
 
7084
+ # Optional. Indicates that a live agent should be brought in to handle the
7085
+ # interaction with the user. In most cases, when you set this flag to true, you
7086
+ # would also want to set end_interaction to true as well. Default is false.
7087
+ # Corresponds to the JSON property `liveAgentHandoff`
7088
+ # @return [Boolean]
7089
+ attr_accessor :live_agent_handoff
7090
+ alias_method :live_agent_handoff?, :live_agent_handoff
7091
+
5931
7092
  # Optional. The collection of rich messages corresponding to the `Response`
5932
7093
  # field in the Dialogflow console.
5933
7094
  # Corresponds to the JSON property `messages`
@@ -6014,10 +7175,12 @@ module Google
6014
7175
  @action = args[:action] if args.key?(:action)
6015
7176
  @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms)
6016
7177
  @display_name = args[:display_name] if args.key?(:display_name)
7178
+ @end_interaction = args[:end_interaction] if args.key?(:end_interaction)
6017
7179
  @events = args[:events] if args.key?(:events)
6018
7180
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
6019
7181
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
6020
7182
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
7183
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
6021
7184
  @messages = args[:messages] if args.key?(:messages)
6022
7185
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
6023
7186
  @name = args[:name] if args.key?(:name)
@@ -7125,6 +8288,94 @@ module Google
7125
8288
  end
7126
8289
  end
7127
8290
 
8291
+ # A knowledge base represents a collection of knowledge documents that you
8292
+ # provide to Dialogflow. Your knowledge documents contain information that may
8293
+ # be useful during conversations with end-users. Some Dialogflow features use
8294
+ # knowledge bases when looking for a response to an end-user input. For more
8295
+ # information, see the [knowledge base guide](https://cloud.google.com/
8296
+ # dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases`
8297
+ # resource is deprecated; only use `projects.knowledgeBases`.
8298
+ class GoogleCloudDialogflowV2KnowledgeBase
8299
+ include Google::Apis::Core::Hashable
8300
+
8301
+ # Required. The display name of the knowledge base. The name must be 1024 bytes
8302
+ # or less; otherwise, the creation request fails.
8303
+ # Corresponds to the JSON property `displayName`
8304
+ # @return [String]
8305
+ attr_accessor :display_name
8306
+
8307
+ # Language which represents the KnowledgeBase. When the KnowledgeBase is created/
8308
+ # updated, expect this to be present for non en-us languages. When unspecified,
8309
+ # the default language code en-us applies.
8310
+ # Corresponds to the JSON property `languageCode`
8311
+ # @return [String]
8312
+ attr_accessor :language_code
8313
+
8314
+ # The knowledge base resource name. The name must be empty when creating a
8315
+ # knowledge base. Format: `projects//locations//knowledgeBases/`.
8316
+ # Corresponds to the JSON property `name`
8317
+ # @return [String]
8318
+ attr_accessor :name
8319
+
8320
+ def initialize(**args)
8321
+ update!(**args)
8322
+ end
8323
+
8324
+ # Update properties of this object
8325
+ def update!(**args)
8326
+ @display_name = args[:display_name] if args.key?(:display_name)
8327
+ @language_code = args[:language_code] if args.key?(:language_code)
8328
+ @name = args[:name] if args.key?(:name)
8329
+ end
8330
+ end
8331
+
8332
+ # Metadata in google::longrunning::Operation for Knowledge operations.
8333
+ class GoogleCloudDialogflowV2KnowledgeOperationMetadata
8334
+ include Google::Apis::Core::Hashable
8335
+
8336
+ # Output only. The current state of this operation.
8337
+ # Corresponds to the JSON property `state`
8338
+ # @return [String]
8339
+ attr_accessor :state
8340
+
8341
+ def initialize(**args)
8342
+ update!(**args)
8343
+ end
8344
+
8345
+ # Update properties of this object
8346
+ def update!(**args)
8347
+ @state = args[:state] if args.key?(:state)
8348
+ end
8349
+ end
8350
+
8351
+ # Response message for AnswerRecords.ListAnswerRecords.
8352
+ class GoogleCloudDialogflowV2ListAnswerRecordsResponse
8353
+ include Google::Apis::Core::Hashable
8354
+
8355
+ # The list of answer records.
8356
+ # Corresponds to the JSON property `answerRecords`
8357
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord>]
8358
+ attr_accessor :answer_records
8359
+
8360
+ # A token to retrieve next page of results. Or empty if there are no more
8361
+ # results. Pass this value in the ListAnswerRecordsRequest.page_token field in
8362
+ # the subsequent call to `ListAnswerRecords` method to retrieve the next page of
8363
+ # results.
8364
+ # Corresponds to the JSON property `nextPageToken`
8365
+ # @return [String]
8366
+ attr_accessor :next_page_token
8367
+
8368
+ def initialize(**args)
8369
+ update!(**args)
8370
+ end
8371
+
8372
+ # Update properties of this object
8373
+ def update!(**args)
8374
+ @answer_records = args[:answer_records] if args.key?(:answer_records)
8375
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8376
+ end
8377
+ end
8378
+
7128
8379
  # The response message for Contexts.ListContexts.
7129
8380
  class GoogleCloudDialogflowV2ListContextsResponse
7130
8381
  include Google::Apis::Core::Hashable
@@ -7152,15 +8403,175 @@ module Google
7152
8403
  end
7153
8404
  end
7154
8405
 
7155
- # The response message for EntityTypes.ListEntityTypes.
7156
- class GoogleCloudDialogflowV2ListEntityTypesResponse
8406
+ # The response message for ConversationProfiles.ListConversationProfiles.
8407
+ class GoogleCloudDialogflowV2ListConversationProfilesResponse
8408
+ include Google::Apis::Core::Hashable
8409
+
8410
+ # The list of project conversation profiles. There is a maximum number of items
8411
+ # returned based on the page_size field in the request.
8412
+ # Corresponds to the JSON property `conversationProfiles`
8413
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile>]
8414
+ attr_accessor :conversation_profiles
8415
+
8416
+ # Token to retrieve the next page of results, or empty if there are no more
8417
+ # results in the list.
8418
+ # Corresponds to the JSON property `nextPageToken`
8419
+ # @return [String]
8420
+ attr_accessor :next_page_token
8421
+
8422
+ def initialize(**args)
8423
+ update!(**args)
8424
+ end
8425
+
8426
+ # Update properties of this object
8427
+ def update!(**args)
8428
+ @conversation_profiles = args[:conversation_profiles] if args.key?(:conversation_profiles)
8429
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8430
+ end
8431
+ end
8432
+
8433
+ # The response message for Conversations.ListConversations.
8434
+ class GoogleCloudDialogflowV2ListConversationsResponse
8435
+ include Google::Apis::Core::Hashable
8436
+
8437
+ # The list of conversations. There will be a maximum number of items returned
8438
+ # based on the page_size field in the request.
8439
+ # Corresponds to the JSON property `conversations`
8440
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation>]
8441
+ attr_accessor :conversations
8442
+
8443
+ # Token to retrieve the next page of results, or empty if there are no more
8444
+ # results in the list.
8445
+ # Corresponds to the JSON property `nextPageToken`
8446
+ # @return [String]
8447
+ attr_accessor :next_page_token
8448
+
8449
+ def initialize(**args)
8450
+ update!(**args)
8451
+ end
8452
+
8453
+ # Update properties of this object
8454
+ def update!(**args)
8455
+ @conversations = args[:conversations] if args.key?(:conversations)
8456
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8457
+ end
8458
+ end
8459
+
8460
+ # Response message for Documents.ListDocuments.
8461
+ class GoogleCloudDialogflowV2ListDocumentsResponse
8462
+ include Google::Apis::Core::Hashable
8463
+
8464
+ # The list of documents.
8465
+ # Corresponds to the JSON property `documents`
8466
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document>]
8467
+ attr_accessor :documents
8468
+
8469
+ # Token to retrieve the next page of results, or empty if there are no more
8470
+ # results in the list.
8471
+ # Corresponds to the JSON property `nextPageToken`
8472
+ # @return [String]
8473
+ attr_accessor :next_page_token
8474
+
8475
+ def initialize(**args)
8476
+ update!(**args)
8477
+ end
8478
+
8479
+ # Update properties of this object
8480
+ def update!(**args)
8481
+ @documents = args[:documents] if args.key?(:documents)
8482
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8483
+ end
8484
+ end
8485
+
8486
+ # The response message for EntityTypes.ListEntityTypes.
8487
+ class GoogleCloudDialogflowV2ListEntityTypesResponse
8488
+ include Google::Apis::Core::Hashable
8489
+
8490
+ # The list of agent entity types. There will be a maximum number of items
8491
+ # returned based on the page_size field in the request.
8492
+ # Corresponds to the JSON property `entityTypes`
8493
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType>]
8494
+ attr_accessor :entity_types
8495
+
8496
+ # Token to retrieve the next page of results, or empty if there are no more
8497
+ # results in the list.
8498
+ # Corresponds to the JSON property `nextPageToken`
8499
+ # @return [String]
8500
+ attr_accessor :next_page_token
8501
+
8502
+ def initialize(**args)
8503
+ update!(**args)
8504
+ end
8505
+
8506
+ # Update properties of this object
8507
+ def update!(**args)
8508
+ @entity_types = args[:entity_types] if args.key?(:entity_types)
8509
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8510
+ end
8511
+ end
8512
+
8513
+ # The response message for Environments.ListEnvironments.
8514
+ class GoogleCloudDialogflowV2ListEnvironmentsResponse
8515
+ include Google::Apis::Core::Hashable
8516
+
8517
+ # The list of agent environments. There will be a maximum number of items
8518
+ # returned based on the page_size field in the request.
8519
+ # Corresponds to the JSON property `environments`
8520
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment>]
8521
+ attr_accessor :environments
8522
+
8523
+ # Token to retrieve the next page of results, or empty if there are no more
8524
+ # results in the list.
8525
+ # Corresponds to the JSON property `nextPageToken`
8526
+ # @return [String]
8527
+ attr_accessor :next_page_token
8528
+
8529
+ def initialize(**args)
8530
+ update!(**args)
8531
+ end
8532
+
8533
+ # Update properties of this object
8534
+ def update!(**args)
8535
+ @environments = args[:environments] if args.key?(:environments)
8536
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8537
+ end
8538
+ end
8539
+
8540
+ # The response message for Intents.ListIntents.
8541
+ class GoogleCloudDialogflowV2ListIntentsResponse
8542
+ include Google::Apis::Core::Hashable
8543
+
8544
+ # The list of agent intents. There will be a maximum number of items returned
8545
+ # based on the page_size field in the request.
8546
+ # Corresponds to the JSON property `intents`
8547
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent>]
8548
+ attr_accessor :intents
8549
+
8550
+ # Token to retrieve the next page of results, or empty if there are no more
8551
+ # results in the list.
8552
+ # Corresponds to the JSON property `nextPageToken`
8553
+ # @return [String]
8554
+ attr_accessor :next_page_token
8555
+
8556
+ def initialize(**args)
8557
+ update!(**args)
8558
+ end
8559
+
8560
+ # Update properties of this object
8561
+ def update!(**args)
8562
+ @intents = args[:intents] if args.key?(:intents)
8563
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8564
+ end
8565
+ end
8566
+
8567
+ # Response message for KnowledgeBases.ListKnowledgeBases.
8568
+ class GoogleCloudDialogflowV2ListKnowledgeBasesResponse
7157
8569
  include Google::Apis::Core::Hashable
7158
8570
 
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
8571
+ # The list of knowledge bases.
8572
+ # Corresponds to the JSON property `knowledgeBases`
8573
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase>]
8574
+ attr_accessor :knowledge_bases
7164
8575
 
7165
8576
  # Token to retrieve the next page of results, or empty if there are no more
7166
8577
  # results in the list.
@@ -7174,20 +8585,21 @@ module Google
7174
8585
 
7175
8586
  # Update properties of this object
7176
8587
  def update!(**args)
7177
- @entity_types = args[:entity_types] if args.key?(:entity_types)
8588
+ @knowledge_bases = args[:knowledge_bases] if args.key?(:knowledge_bases)
7178
8589
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7179
8590
  end
7180
8591
  end
7181
8592
 
7182
- # The response message for Environments.ListEnvironments.
7183
- class GoogleCloudDialogflowV2ListEnvironmentsResponse
8593
+ # The response message for Conversations.ListMessages.
8594
+ class GoogleCloudDialogflowV2ListMessagesResponse
7184
8595
  include Google::Apis::Core::Hashable
7185
8596
 
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
8597
+ # The list of messages. There will be a maximum number of items returned based
8598
+ # on the page_size field in the request. `messages` is sorted by `create_time`
8599
+ # in descending order.
8600
+ # Corresponds to the JSON property `messages`
8601
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Message>]
8602
+ attr_accessor :messages
7191
8603
 
7192
8604
  # Token to retrieve the next page of results, or empty if there are no more
7193
8605
  # results in the list.
@@ -7201,35 +8613,35 @@ module Google
7201
8613
 
7202
8614
  # Update properties of this object
7203
8615
  def update!(**args)
7204
- @environments = args[:environments] if args.key?(:environments)
8616
+ @messages = args[:messages] if args.key?(:messages)
7205
8617
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7206
8618
  end
7207
8619
  end
7208
8620
 
7209
- # The response message for Intents.ListIntents.
7210
- class GoogleCloudDialogflowV2ListIntentsResponse
8621
+ # The response message for Participants.ListParticipants.
8622
+ class GoogleCloudDialogflowV2ListParticipantsResponse
7211
8623
  include Google::Apis::Core::Hashable
7212
8624
 
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
8625
+ # Token to retrieve the next page of results or empty if there are no more
7220
8626
  # results in the list.
7221
8627
  # Corresponds to the JSON property `nextPageToken`
7222
8628
  # @return [String]
7223
8629
  attr_accessor :next_page_token
7224
8630
 
8631
+ # The list of participants. There is a maximum number of items returned based on
8632
+ # the page_size field in the request.
8633
+ # Corresponds to the JSON property `participants`
8634
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant>]
8635
+ attr_accessor :participants
8636
+
7225
8637
  def initialize(**args)
7226
8638
  update!(**args)
7227
8639
  end
7228
8640
 
7229
8641
  # Update properties of this object
7230
8642
  def update!(**args)
7231
- @intents = args[:intents] if args.key?(:intents)
7232
8643
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8644
+ @participants = args[:participants] if args.key?(:participants)
7233
8645
  end
7234
8646
  end
7235
8647
 
@@ -7260,6 +8672,27 @@ module Google
7260
8672
  end
7261
8673
  end
7262
8674
 
8675
+ # Defines logging behavior for conversation lifecycle events.
8676
+ class GoogleCloudDialogflowV2LoggingConfig
8677
+ include Google::Apis::Core::Hashable
8678
+
8679
+ # Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in
8680
+ # the conversation project as JSON format ConversationEvent protos.
8681
+ # Corresponds to the JSON property `enableStackdriverLogging`
8682
+ # @return [Boolean]
8683
+ attr_accessor :enable_stackdriver_logging
8684
+ alias_method :enable_stackdriver_logging?, :enable_stackdriver_logging
8685
+
8686
+ def initialize(**args)
8687
+ update!(**args)
8688
+ end
8689
+
8690
+ # Update properties of this object
8691
+ def update!(**args)
8692
+ @enable_stackdriver_logging = args[:enable_stackdriver_logging] if args.key?(:enable_stackdriver_logging)
8693
+ end
8694
+ end
8695
+
7263
8696
  # Represents a message posted into a conversation.
7264
8697
  class GoogleCloudDialogflowV2Message
7265
8698
  include Google::Apis::Core::Hashable
@@ -7345,6 +8778,36 @@ module Google
7345
8778
  end
7346
8779
  end
7347
8780
 
8781
+ # Defines notification behavior.
8782
+ class GoogleCloudDialogflowV2NotificationConfig
8783
+ include Google::Apis::Core::Hashable
8784
+
8785
+ # Format of message.
8786
+ # Corresponds to the JSON property `messageFormat`
8787
+ # @return [String]
8788
+ attr_accessor :message_format
8789
+
8790
+ # Name of the Pub/Sub topic to publish conversation events like
8791
+ # CONVERSATION_STARTED as serialized ConversationEvent protos. Notification
8792
+ # works for phone calls, if this topic either is in the same project as the
8793
+ # conversation or you grant `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`
8794
+ # the `Dialogflow Service Agent` role in the topic project. Format: `projects//
8795
+ # locations//topics/`.
8796
+ # Corresponds to the JSON property `topic`
8797
+ # @return [String]
8798
+ attr_accessor :topic
8799
+
8800
+ def initialize(**args)
8801
+ update!(**args)
8802
+ end
8803
+
8804
+ # Update properties of this object
8805
+ def update!(**args)
8806
+ @message_format = args[:message_format] if args.key?(:message_format)
8807
+ @topic = args[:topic] if args.key?(:topic)
8808
+ end
8809
+ end
8810
+
7348
8811
  # Represents the contents of the original request that was passed to the `[
7349
8812
  # Streaming]DetectIntent` call.
7350
8813
  class GoogleCloudDialogflowV2OriginalDetectIntentRequest
@@ -7385,6 +8848,34 @@ module Google
7385
8848
  end
7386
8849
  end
7387
8850
 
8851
+ # Represents the natural language speech audio to be played to the end user.
8852
+ class GoogleCloudDialogflowV2OutputAudio
8853
+ include Google::Apis::Core::Hashable
8854
+
8855
+ # The natural language speech audio.
8856
+ # Corresponds to the JSON property `audio`
8857
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
8858
+ # @return [String]
8859
+ attr_accessor :audio
8860
+
8861
+ # Instructs the speech synthesizer on how to generate the output audio content.
8862
+ # If this audio config is supplied in a request, it overrides all existing text-
8863
+ # to-speech settings applied to the agent.
8864
+ # Corresponds to the JSON property `config`
8865
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig]
8866
+ attr_accessor :config
8867
+
8868
+ def initialize(**args)
8869
+ update!(**args)
8870
+ end
8871
+
8872
+ # Update properties of this object
8873
+ def update!(**args)
8874
+ @audio = args[:audio] if args.key?(:audio)
8875
+ @config = args[:config] if args.key?(:config)
8876
+ end
8877
+ end
8878
+
7388
8879
  # Instructs the speech synthesizer on how to generate the output audio content.
7389
8880
  # If this audio config is supplied in a request, it overrides all existing text-
7390
8881
  # to-speech settings applied to the agent.
@@ -7422,6 +8913,41 @@ module Google
7422
8913
  end
7423
8914
  end
7424
8915
 
8916
+ # Represents a conversation participant (human agent, virtual agent, end-user).
8917
+ class GoogleCloudDialogflowV2Participant
8918
+ include Google::Apis::Core::Hashable
8919
+
8920
+ # Optional. The unique identifier of this participant. Format: `projects//
8921
+ # locations//conversations//participants/`.
8922
+ # Corresponds to the JSON property `name`
8923
+ # @return [String]
8924
+ attr_accessor :name
8925
+
8926
+ # Immutable. The role this participant plays in the conversation. This field
8927
+ # must be set during participant creation and is then immutable.
8928
+ # Corresponds to the JSON property `role`
8929
+ # @return [String]
8930
+ attr_accessor :role
8931
+
8932
+ # Optional. Label applied to streams representing this participant in SIPREC XML
8933
+ # metadata and SDP. This is used to assign transcriptions from that media stream
8934
+ # to this participant. This field can be updated.
8935
+ # Corresponds to the JSON property `sipRecordingMediaLabel`
8936
+ # @return [String]
8937
+ attr_accessor :sip_recording_media_label
8938
+
8939
+ def initialize(**args)
8940
+ update!(**args)
8941
+ end
8942
+
8943
+ # Update properties of this object
8944
+ def update!(**args)
8945
+ @name = args[:name] if args.key?(:name)
8946
+ @role = args[:role] if args.key?(:role)
8947
+ @sip_recording_media_label = args[:sip_recording_media_label] if args.key?(:sip_recording_media_label)
8948
+ end
8949
+ end
8950
+
7425
8951
  # Represents the query input. It can contain either: 1. An audio config which
7426
8952
  # instructs the speech recognizer how to process the speech audio. 2. A
7427
8953
  # conversational query in the form of text,. 3. An event that specifies which
@@ -7693,6 +9219,27 @@ module Google
7693
9219
  end
7694
9220
  end
7695
9221
 
9222
+ # Request message for Documents.ReloadDocument.
9223
+ class GoogleCloudDialogflowV2ReloadDocumentRequest
9224
+ include Google::Apis::Core::Hashable
9225
+
9226
+ # Optional. The path of gcs source file for reloading document content. For now,
9227
+ # only gcs uri is supported. For documents stored in Google Cloud Storage, these
9228
+ # URIs must have the form `gs:///`.
9229
+ # Corresponds to the JSON property `contentUri`
9230
+ # @return [String]
9231
+ attr_accessor :content_uri
9232
+
9233
+ def initialize(**args)
9234
+ update!(**args)
9235
+ end
9236
+
9237
+ # Update properties of this object
9238
+ def update!(**args)
9239
+ @content_uri = args[:content_uri] if args.key?(:content_uri)
9240
+ end
9241
+ end
9242
+
7696
9243
  # The request message for Agents.RestoreAgent.
7697
9244
  class GoogleCloudDialogflowV2RestoreAgentRequest
7698
9245
  include Google::Apis::Core::Hashable
@@ -7837,21 +9384,226 @@ module Google
7837
9384
  # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityTypeEntity>]
7838
9385
  attr_accessor :entities
7839
9386
 
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
9387
+ # Required. Indicates whether the additional data should override or supplement
9388
+ # the custom entity type definition.
9389
+ # Corresponds to the JSON property `entityOverrideMode`
9390
+ # @return [String]
9391
+ attr_accessor :entity_override_mode
9392
+
9393
+ # Required. The unique identifier of this session entity type. Format: `projects/
9394
+ # /agent/sessions//entityTypes/`, or `projects//agent/environments//users//
9395
+ # sessions//entityTypes/`. If `Environment ID` is not specified, we assume
9396
+ # default 'draft' environment. If `User ID` is not specified, we assume default '
9397
+ # -' user. `` must be the display name of an existing entity type in the same
9398
+ # agent that will be overridden or supplemented.
9399
+ # Corresponds to the JSON property `name`
9400
+ # @return [String]
9401
+ attr_accessor :name
9402
+
9403
+ def initialize(**args)
9404
+ update!(**args)
9405
+ end
9406
+
9407
+ # Update properties of this object
9408
+ def update!(**args)
9409
+ @entities = args[:entities] if args.key?(:entities)
9410
+ @entity_override_mode = args[:entity_override_mode] if args.key?(:entity_override_mode)
9411
+ @name = args[:name] if args.key?(:name)
9412
+ end
9413
+ end
9414
+
9415
+ # Hints for the speech recognizer to help with recognition in a specific
9416
+ # conversation state.
9417
+ class GoogleCloudDialogflowV2SpeechContext
9418
+ include Google::Apis::Core::Hashable
9419
+
9420
+ # Optional. Boost for this context compared to other contexts: * If the boost is
9421
+ # positive, Dialogflow will increase the probability that the phrases in this
9422
+ # context are recognized over similar sounding phrases. * If the boost is
9423
+ # unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow
9424
+ # recommends that you use boosts in the range (0, 20] and that you find a value
9425
+ # that fits your use case with binary search.
9426
+ # Corresponds to the JSON property `boost`
9427
+ # @return [Float]
9428
+ attr_accessor :boost
9429
+
9430
+ # Optional. A list of strings containing words and phrases that the speech
9431
+ # recognizer should recognize with higher likelihood. This list can be used to: *
9432
+ # improve accuracy for words and phrases you expect the user to say, e.g.
9433
+ # typical commands for your Dialogflow agent * add additional words to the
9434
+ # speech recognizer vocabulary * ... See the [Cloud Speech documentation](https:/
9435
+ # /cloud.google.com/speech-to-text/quotas) for usage limits.
9436
+ # Corresponds to the JSON property `phrases`
9437
+ # @return [Array<String>]
9438
+ attr_accessor :phrases
9439
+
9440
+ def initialize(**args)
9441
+ update!(**args)
9442
+ end
9443
+
9444
+ # Update properties of this object
9445
+ def update!(**args)
9446
+ @boost = args[:boost] if args.key?(:boost)
9447
+ @phrases = args[:phrases] if args.key?(:phrases)
9448
+ end
9449
+ end
9450
+
9451
+ # Configures speech transcription for ConversationProfile.
9452
+ class GoogleCloudDialogflowV2SpeechToTextConfig
9453
+ include Google::Apis::Core::Hashable
9454
+
9455
+ # Optional. The speech model used in speech to text. `
9456
+ # SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `
9457
+ # USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and
9458
+ # StreamingAnalyzeContentRequest request.
9459
+ # Corresponds to the JSON property `speechModelVariant`
9460
+ # @return [String]
9461
+ attr_accessor :speech_model_variant
9462
+
9463
+ def initialize(**args)
9464
+ update!(**args)
9465
+ end
9466
+
9467
+ # Update properties of this object
9468
+ def update!(**args)
9469
+ @speech_model_variant = args[:speech_model_variant] if args.key?(:speech_model_variant)
9470
+ end
9471
+ end
9472
+
9473
+ # The request message for Participants.SuggestArticles.
9474
+ class GoogleCloudDialogflowV2SuggestArticlesRequest
9475
+ include Google::Apis::Core::Hashable
9476
+
9477
+ # Max number of messages prior to and including latest_message to use as context
9478
+ # when compiling the suggestion. By default 20 and at most 50.
9479
+ # Corresponds to the JSON property `contextSize`
9480
+ # @return [Fixnum]
9481
+ attr_accessor :context_size
9482
+
9483
+ # The name of the latest conversation message to compile suggestion for. If
9484
+ # empty, it will be the latest message of the conversation. Format: `projects//
9485
+ # locations//conversations//messages/`.
9486
+ # Corresponds to the JSON property `latestMessage`
9487
+ # @return [String]
9488
+ attr_accessor :latest_message
9489
+
9490
+ def initialize(**args)
9491
+ update!(**args)
9492
+ end
9493
+
9494
+ # Update properties of this object
9495
+ def update!(**args)
9496
+ @context_size = args[:context_size] if args.key?(:context_size)
9497
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9498
+ end
9499
+ end
9500
+
9501
+ # The response message for Participants.SuggestArticles.
9502
+ class GoogleCloudDialogflowV2SuggestArticlesResponse
9503
+ include Google::Apis::Core::Hashable
9504
+
9505
+ # Articles ordered by score in descending order.
9506
+ # Corresponds to the JSON property `articleAnswers`
9507
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ArticleAnswer>]
9508
+ attr_accessor :article_answers
9509
+
9510
+ # Number of messages prior to and including latest_message to compile the
9511
+ # suggestion. It may be smaller than the SuggestArticlesRequest.context_size
9512
+ # field in the request if there aren't that many messages in the conversation.
9513
+ # Corresponds to the JSON property `contextSize`
9514
+ # @return [Fixnum]
9515
+ attr_accessor :context_size
9516
+
9517
+ # The name of the latest conversation message used to compile suggestion for.
9518
+ # Format: `projects//locations//conversations//messages/`.
9519
+ # Corresponds to the JSON property `latestMessage`
9520
+ # @return [String]
9521
+ attr_accessor :latest_message
9522
+
9523
+ def initialize(**args)
9524
+ update!(**args)
9525
+ end
9526
+
9527
+ # Update properties of this object
9528
+ def update!(**args)
9529
+ @article_answers = args[:article_answers] if args.key?(:article_answers)
9530
+ @context_size = args[:context_size] if args.key?(:context_size)
9531
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9532
+ end
9533
+ end
9534
+
9535
+ # The request message for Participants.SuggestFaqAnswers.
9536
+ class GoogleCloudDialogflowV2SuggestFaqAnswersRequest
9537
+ include Google::Apis::Core::Hashable
9538
+
9539
+ # Max number of messages prior to and including [latest_message] to use as
9540
+ # context when compiling the suggestion. By default 20 and at most 50.
9541
+ # Corresponds to the JSON property `contextSize`
9542
+ # @return [Fixnum]
9543
+ attr_accessor :context_size
9544
+
9545
+ # The name of the latest conversation message to compile suggestion for. If
9546
+ # empty, it will be the latest message of the conversation. Format: `projects//
9547
+ # locations//conversations//messages/`.
9548
+ # Corresponds to the JSON property `latestMessage`
9549
+ # @return [String]
9550
+ attr_accessor :latest_message
9551
+
9552
+ def initialize(**args)
9553
+ update!(**args)
9554
+ end
9555
+
9556
+ # Update properties of this object
9557
+ def update!(**args)
9558
+ @context_size = args[:context_size] if args.key?(:context_size)
9559
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9560
+ end
9561
+ end
9562
+
9563
+ # The request message for Participants.SuggestFaqAnswers.
9564
+ class GoogleCloudDialogflowV2SuggestFaqAnswersResponse
9565
+ include Google::Apis::Core::Hashable
9566
+
9567
+ # Number of messages prior to and including latest_message to compile the
9568
+ # suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size
9569
+ # field in the request if there aren't that many messages in the conversation.
9570
+ # Corresponds to the JSON property `contextSize`
9571
+ # @return [Fixnum]
9572
+ attr_accessor :context_size
9573
+
9574
+ # Answers extracted from FAQ documents.
9575
+ # Corresponds to the JSON property `faqAnswers`
9576
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2FaqAnswer>]
9577
+ attr_accessor :faq_answers
9578
+
9579
+ # The name of the latest conversation message used to compile suggestion for.
9580
+ # Format: `projects//locations//conversations//messages/`.
9581
+ # Corresponds to the JSON property `latestMessage`
9582
+ # @return [String]
9583
+ attr_accessor :latest_message
9584
+
9585
+ def initialize(**args)
9586
+ update!(**args)
9587
+ end
9588
+
9589
+ # Update properties of this object
9590
+ def update!(**args)
9591
+ @context_size = args[:context_size] if args.key?(:context_size)
9592
+ @faq_answers = args[:faq_answers] if args.key?(:faq_answers)
9593
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9594
+ end
9595
+ end
9596
+
9597
+ # The type of Human Agent Assistant API suggestion to perform, and the maximum
9598
+ # number of results to return for that type. Multiple `Feature` objects can be
9599
+ # specified in the `features` list.
9600
+ class GoogleCloudDialogflowV2SuggestionFeature
9601
+ include Google::Apis::Core::Hashable
7845
9602
 
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`
9603
+ # Type of Human Agent Assistant API feature to request.
9604
+ # Corresponds to the JSON property `type`
7853
9605
  # @return [String]
7854
- attr_accessor :name
9606
+ attr_accessor :type
7855
9607
 
7856
9608
  def initialize(**args)
7857
9609
  update!(**args)
@@ -7859,36 +9611,35 @@ module Google
7859
9611
 
7860
9612
  # Update properties of this object
7861
9613
  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)
9614
+ @type = args[:type] if args.key?(:type)
7865
9615
  end
7866
9616
  end
7867
9617
 
7868
- # Hints for the speech recognizer to help with recognition in a specific
7869
- # conversation state.
7870
- class GoogleCloudDialogflowV2SpeechContext
9618
+ # One response of different type of suggestion response which is used in the
9619
+ # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
9620
+ # well as HumanAgentAssistantEvent.
9621
+ class GoogleCloudDialogflowV2SuggestionResult
7871
9622
  include Google::Apis::Core::Hashable
7872
9623
 
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
9624
+ # The `Status` type defines a logical error model that is suitable for different
9625
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9626
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9627
+ # data: error code, error message, and error details. You can find out more
9628
+ # about this error model and how to work with it in the [API Design Guide](https:
9629
+ # //cloud.google.com/apis/design/errors).
9630
+ # Corresponds to the JSON property `error`
9631
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
9632
+ attr_accessor :error
7882
9633
 
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
9634
+ # The response message for Participants.SuggestArticles.
9635
+ # Corresponds to the JSON property `suggestArticlesResponse`
9636
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse]
9637
+ attr_accessor :suggest_articles_response
9638
+
9639
+ # The request message for Participants.SuggestFaqAnswers.
9640
+ # Corresponds to the JSON property `suggestFaqAnswersResponse`
9641
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
9642
+ attr_accessor :suggest_faq_answers_response
7892
9643
 
7893
9644
  def initialize(**args)
7894
9645
  update!(**args)
@@ -7896,8 +9647,9 @@ module Google
7896
9647
 
7897
9648
  # Update properties of this object
7898
9649
  def update!(**args)
7899
- @boost = args[:boost] if args.key?(:boost)
7900
- @phrases = args[:phrases] if args.key?(:phrases)
9650
+ @error = args[:error] if args.key?(:error)
9651
+ @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
9652
+ @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
7901
9653
  end
7902
9654
  end
7903
9655
 
@@ -8212,6 +9964,89 @@ module Google
8212
9964
  end
8213
9965
  end
8214
9966
 
9967
+ # Represents a part of a message possibly annotated with an entity. The part can
9968
+ # be an entity or purely a part of the message between two entities or message
9969
+ # start/end.
9970
+ class GoogleCloudDialogflowV2beta1AnnotatedMessagePart
9971
+ include Google::Apis::Core::Hashable
9972
+
9973
+ # Optional. The [Dialogflow system entity type](https://cloud.google.com/
9974
+ # dialogflow/docs/reference/system-entities) of this message part. If this is
9975
+ # empty, Dialogflow could not annotate the phrase part with a system entity.
9976
+ # Corresponds to the JSON property `entityType`
9977
+ # @return [String]
9978
+ attr_accessor :entity_type
9979
+
9980
+ # Optional. The [Dialogflow system entity formatted value ](https://cloud.google.
9981
+ # com/dialogflow/docs/reference/system-entities) of this message part. For
9982
+ # example for a system entity of type `@sys.unit-currency`, this may contain: ` "
9983
+ # amount": 5, "currency": "USD" `
9984
+ # Corresponds to the JSON property `formattedValue`
9985
+ # @return [Object]
9986
+ attr_accessor :formatted_value
9987
+
9988
+ # Required. A part of a message possibly annotated with an entity.
9989
+ # Corresponds to the JSON property `text`
9990
+ # @return [String]
9991
+ attr_accessor :text
9992
+
9993
+ def initialize(**args)
9994
+ update!(**args)
9995
+ end
9996
+
9997
+ # Update properties of this object
9998
+ def update!(**args)
9999
+ @entity_type = args[:entity_type] if args.key?(:entity_type)
10000
+ @formatted_value = args[:formatted_value] if args.key?(:formatted_value)
10001
+ @text = args[:text] if args.key?(:text)
10002
+ end
10003
+ end
10004
+
10005
+ # Represents article answer.
10006
+ class GoogleCloudDialogflowV2beta1ArticleAnswer
10007
+ include Google::Apis::Core::Hashable
10008
+
10009
+ # The name of answer record, in the format of "projects//locations//
10010
+ # answerRecords/"
10011
+ # Corresponds to the JSON property `answerRecord`
10012
+ # @return [String]
10013
+ attr_accessor :answer_record
10014
+
10015
+ # A map that contains metadata about the answer and the document from which it
10016
+ # originates.
10017
+ # Corresponds to the JSON property `metadata`
10018
+ # @return [Hash<String,String>]
10019
+ attr_accessor :metadata
10020
+
10021
+ # Output only. Article snippets.
10022
+ # Corresponds to the JSON property `snippets`
10023
+ # @return [Array<String>]
10024
+ attr_accessor :snippets
10025
+
10026
+ # The article title.
10027
+ # Corresponds to the JSON property `title`
10028
+ # @return [String]
10029
+ attr_accessor :title
10030
+
10031
+ # The article URI.
10032
+ # Corresponds to the JSON property `uri`
10033
+ # @return [String]
10034
+ attr_accessor :uri
10035
+
10036
+ def initialize(**args)
10037
+ update!(**args)
10038
+ end
10039
+
10040
+ # Update properties of this object
10041
+ def update!(**args)
10042
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10043
+ @metadata = args[:metadata] if args.key?(:metadata)
10044
+ @snippets = args[:snippets] if args.key?(:snippets)
10045
+ @title = args[:title] if args.key?(:title)
10046
+ @uri = args[:uri] if args.key?(:uri)
10047
+ end
10048
+ end
10049
+
8215
10050
  # The response message for EntityTypes.BatchUpdateEntityTypes.
8216
10051
  class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse
8217
10052
  include Google::Apis::Core::Hashable
@@ -8312,6 +10147,50 @@ module Google
8312
10147
  end
8313
10148
  end
8314
10149
 
10150
+ # Represents a notification sent to Pub/Sub subscribers for conversation
10151
+ # lifecycle events.
10152
+ class GoogleCloudDialogflowV2beta1ConversationEvent
10153
+ include Google::Apis::Core::Hashable
10154
+
10155
+ # Required. The unique identifier of the conversation this notification refers
10156
+ # to. Format: `projects//conversations/`.
10157
+ # Corresponds to the JSON property `conversation`
10158
+ # @return [String]
10159
+ attr_accessor :conversation
10160
+
10161
+ # The `Status` type defines a logical error model that is suitable for different
10162
+ # programming environments, including REST APIs and RPC APIs. It is used by [
10163
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
10164
+ # data: error code, error message, and error details. You can find out more
10165
+ # about this error model and how to work with it in the [API Design Guide](https:
10166
+ # //cloud.google.com/apis/design/errors).
10167
+ # Corresponds to the JSON property `errorStatus`
10168
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
10169
+ attr_accessor :error_status
10170
+
10171
+ # Represents a message posted into a conversation.
10172
+ # Corresponds to the JSON property `newMessagePayload`
10173
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Message]
10174
+ attr_accessor :new_message_payload
10175
+
10176
+ # Required. The type of the event that this notification refers to.
10177
+ # Corresponds to the JSON property `type`
10178
+ # @return [String]
10179
+ attr_accessor :type
10180
+
10181
+ def initialize(**args)
10182
+ update!(**args)
10183
+ end
10184
+
10185
+ # Update properties of this object
10186
+ def update!(**args)
10187
+ @conversation = args[:conversation] if args.key?(:conversation)
10188
+ @error_status = args[:error_status] if args.key?(:error_status)
10189
+ @new_message_payload = args[:new_message_payload] if args.key?(:new_message_payload)
10190
+ @type = args[:type] if args.key?(:type)
10191
+ end
10192
+ end
10193
+
8315
10194
  # Each intent parameter has a type, called the entity type, which dictates
8316
10195
  # exactly how data from an end-user expression is extracted. Dialogflow provides
8317
10196
  # predefined system entities that can match many common types of data. For
@@ -8405,38 +10284,157 @@ module Google
8405
10284
  end
8406
10285
  end
8407
10286
 
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
10287
+ # Events allow for matching intents by event name instead of the natural
10288
+ # language input. For instance, input `` can trigger a personalized welcome
10289
+ # response. The parameter `name` may be used by the agent in the response: `"
10290
+ # Hello #welcome_event.name! What can I do for you today?"`.
10291
+ class GoogleCloudDialogflowV2beta1EventInput
10292
+ include Google::Apis::Core::Hashable
10293
+
10294
+ # Required. The language of this query. See [Language Support](https://cloud.
10295
+ # google.com/dialogflow/docs/reference/language) for a list of the currently
10296
+ # supported language codes. Note that queries in the same session do not
10297
+ # necessarily need to specify the same language.
10298
+ # Corresponds to the JSON property `languageCode`
10299
+ # @return [String]
10300
+ attr_accessor :language_code
10301
+
10302
+ # Required. The unique identifier of the event.
10303
+ # Corresponds to the JSON property `name`
10304
+ # @return [String]
10305
+ attr_accessor :name
10306
+
10307
+ # The collection of parameters associated with the event. Depending on your
10308
+ # protocol or client library language, this is a map, associative array, symbol
10309
+ # table, dictionary, or JSON object composed of a collection of (MapKey,
10310
+ # MapValue) pairs: - MapKey type: string - MapKey value: parameter name -
10311
+ # MapValue type: - If parameter's entity type is a composite entity: map - Else:
10312
+ # depending on parameter value type, could be one of string, number, boolean,
10313
+ # null, list or map - MapValue value: - If parameter's entity type is a
10314
+ # composite entity: map from composite entity property names to property values -
10315
+ # Else: parameter value
10316
+ # Corresponds to the JSON property `parameters`
10317
+ # @return [Hash<String,Object>]
10318
+ attr_accessor :parameters
10319
+
10320
+ def initialize(**args)
10321
+ update!(**args)
10322
+ end
10323
+
10324
+ # Update properties of this object
10325
+ def update!(**args)
10326
+ @language_code = args[:language_code] if args.key?(:language_code)
10327
+ @name = args[:name] if args.key?(:name)
10328
+ @parameters = args[:parameters] if args.key?(:parameters)
10329
+ end
10330
+ end
10331
+
10332
+ # The response message for Agents.ExportAgent.
10333
+ class GoogleCloudDialogflowV2beta1ExportAgentResponse
10334
+ include Google::Apis::Core::Hashable
10335
+
10336
+ # Zip compressed raw byte content for agent.
10337
+ # Corresponds to the JSON property `agentContent`
10338
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
10339
+ # @return [String]
10340
+ attr_accessor :agent_content
10341
+
10342
+ # The URI to a file containing the exported agent. This field is populated only
10343
+ # if `agent_uri` is specified in `ExportAgentRequest`.
10344
+ # Corresponds to the JSON property `agentUri`
10345
+ # @return [String]
10346
+ attr_accessor :agent_uri
10347
+
10348
+ def initialize(**args)
10349
+ update!(**args)
10350
+ end
10351
+
10352
+ # Update properties of this object
10353
+ def update!(**args)
10354
+ @agent_content = args[:agent_content] if args.key?(:agent_content)
10355
+ @agent_uri = args[:agent_uri] if args.key?(:agent_uri)
10356
+ end
10357
+ end
10358
+
10359
+ # Represents answer from "frequently asked questions".
10360
+ class GoogleCloudDialogflowV2beta1FaqAnswer
10361
+ include Google::Apis::Core::Hashable
10362
+
10363
+ # The piece of text from the `source` knowledge base document.
10364
+ # Corresponds to the JSON property `answer`
10365
+ # @return [String]
10366
+ attr_accessor :answer
10367
+
10368
+ # The name of answer record, in the format of "projects//locations//
10369
+ # answerRecords/"
10370
+ # Corresponds to the JSON property `answerRecord`
10371
+ # @return [String]
10372
+ attr_accessor :answer_record
10373
+
10374
+ # The system's confidence score that this Knowledge answer is a good match for
10375
+ # this conversational query, range from 0.0 (completely uncertain) to 1.0 (
10376
+ # completely certain).
10377
+ # Corresponds to the JSON property `confidence`
10378
+ # @return [Float]
10379
+ attr_accessor :confidence
10380
+
10381
+ # A map that contains metadata about the answer and the document from which it
10382
+ # originates.
10383
+ # Corresponds to the JSON property `metadata`
10384
+ # @return [Hash<String,String>]
10385
+ attr_accessor :metadata
10386
+
10387
+ # The corresponding FAQ question.
10388
+ # Corresponds to the JSON property `question`
10389
+ # @return [String]
10390
+ attr_accessor :question
10391
+
10392
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
10393
+ # projects//locations//agent/knowledgeBases//documents/`.
10394
+ # Corresponds to the JSON property `source`
10395
+ # @return [String]
10396
+ attr_accessor :source
10397
+
10398
+ def initialize(**args)
10399
+ update!(**args)
10400
+ end
10401
+
10402
+ # Update properties of this object
10403
+ def update!(**args)
10404
+ @answer = args[:answer] if args.key?(:answer)
10405
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10406
+ @confidence = args[:confidence] if args.key?(:confidence)
10407
+ @metadata = args[:metadata] if args.key?(:metadata)
10408
+ @question = args[:question] if args.key?(:question)
10409
+ @source = args[:source] if args.key?(:source)
10410
+ end
10411
+ end
10412
+
10413
+ # Output only. Represents a notification sent to Pub/Sub subscribers for agent
10414
+ # assistant events in a specific conversation.
10415
+ class GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent
8413
10416
  include Google::Apis::Core::Hashable
8414
10417
 
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`
10418
+ # The conversation this notification refers to. Format: `projects//conversations/
10419
+ # `.
10420
+ # Corresponds to the JSON property `conversation`
8420
10421
  # @return [String]
8421
- attr_accessor :language_code
10422
+ attr_accessor :conversation
8422
10423
 
8423
- # Required. The unique identifier of the event.
8424
- # Corresponds to the JSON property `name`
10424
+ # The participant that the suggestion is compiled for. And This field is used to
10425
+ # call Participants.ListSuggestions API. Format: `projects//conversations//
10426
+ # participants/`. It will not be set in legacy workflow.
10427
+ # HumanAgentAssistantConfig.name for more information.
10428
+ # Corresponds to the JSON property `participant`
8425
10429
  # @return [String]
8426
- attr_accessor :name
10430
+ attr_accessor :participant
8427
10431
 
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
10432
+ # The suggestion results payload that this notification refers to. It will only
10433
+ # be set when HumanAgentAssistantConfig.SuggestionConfig.
10434
+ # group_suggestion_responses sets to true.
10435
+ # Corresponds to the JSON property `suggestionResults`
10436
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SuggestionResult>]
10437
+ attr_accessor :suggestion_results
8440
10438
 
8441
10439
  def initialize(**args)
8442
10440
  update!(**args)
@@ -8444,27 +10442,20 @@ module Google
8444
10442
 
8445
10443
  # Update properties of this object
8446
10444
  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)
10445
+ @conversation = args[:conversation] if args.key?(:conversation)
10446
+ @participant = args[:participant] if args.key?(:participant)
10447
+ @suggestion_results = args[:suggestion_results] if args.key?(:suggestion_results)
8450
10448
  end
8451
10449
  end
8452
10450
 
8453
- # The response message for Agents.ExportAgent.
8454
- class GoogleCloudDialogflowV2beta1ExportAgentResponse
10451
+ # Response message for Documents.ImportDocuments.
10452
+ class GoogleCloudDialogflowV2beta1ImportDocumentsResponse
8455
10453
  include Google::Apis::Core::Hashable
8456
10454
 
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
10455
+ # Includes details about skipped documents or any other warnings.
10456
+ # Corresponds to the JSON property `warnings`
10457
+ # @return [Array<Google::Apis::DialogflowV2::GoogleRpcStatus>]
10458
+ attr_accessor :warnings
8468
10459
 
8469
10460
  def initialize(**args)
8470
10461
  update!(**args)
@@ -8472,8 +10463,7 @@ module Google
8472
10463
 
8473
10464
  # Update properties of this object
8474
10465
  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)
10466
+ @warnings = args[:warnings] if args.key?(:warnings)
8477
10467
  end
8478
10468
  end
8479
10469
 
@@ -8539,6 +10529,14 @@ module Google
8539
10529
  attr_accessor :is_fallback
8540
10530
  alias_method :is_fallback?, :is_fallback
8541
10531
 
10532
+ # Optional. Indicates that a live agent should be brought in to handle the
10533
+ # interaction with the user. In most cases, when you set this flag to true, you
10534
+ # would also want to set end_interaction to true as well. Default is false.
10535
+ # Corresponds to the JSON property `liveAgentHandoff`
10536
+ # @return [Boolean]
10537
+ attr_accessor :live_agent_handoff
10538
+ alias_method :live_agent_handoff?, :live_agent_handoff
10539
+
8542
10540
  # Optional. The collection of rich messages corresponding to the `Response`
8543
10541
  # field in the Dialogflow console.
8544
10542
  # Corresponds to the JSON property `messages`
@@ -8643,6 +10641,7 @@ module Google
8643
10641
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
8644
10642
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
8645
10643
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
10644
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
8646
10645
  @messages = args[:messages] if args.key?(:messages)
8647
10646
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
8648
10647
  @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled)
@@ -10285,6 +12284,110 @@ module Google
10285
12284
  end
10286
12285
  end
10287
12286
 
12287
+ # Represents a message posted into a conversation.
12288
+ class GoogleCloudDialogflowV2beta1Message
12289
+ include Google::Apis::Core::Hashable
12290
+
12291
+ # Required. The message content.
12292
+ # Corresponds to the JSON property `content`
12293
+ # @return [String]
12294
+ attr_accessor :content
12295
+
12296
+ # Output only. The time when the message was created in Contact Center AI.
12297
+ # Corresponds to the JSON property `createTime`
12298
+ # @return [String]
12299
+ attr_accessor :create_time
12300
+
12301
+ # Optional. The message language. This should be a [BCP-47](https://www.rfc-
12302
+ # editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
12303
+ # Corresponds to the JSON property `languageCode`
12304
+ # @return [String]
12305
+ attr_accessor :language_code
12306
+
12307
+ # Represents the result of annotation for the message.
12308
+ # Corresponds to the JSON property `messageAnnotation`
12309
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1MessageAnnotation]
12310
+ attr_accessor :message_annotation
12311
+
12312
+ # Optional. The unique identifier of the message. Format: `projects//locations//
12313
+ # conversations//messages/`.
12314
+ # Corresponds to the JSON property `name`
12315
+ # @return [String]
12316
+ attr_accessor :name
12317
+
12318
+ # Output only. The participant that sends this message.
12319
+ # Corresponds to the JSON property `participant`
12320
+ # @return [String]
12321
+ attr_accessor :participant
12322
+
12323
+ # Output only. The role of the participant.
12324
+ # Corresponds to the JSON property `participantRole`
12325
+ # @return [String]
12326
+ attr_accessor :participant_role
12327
+
12328
+ # Optional. The time when the message was sent.
12329
+ # Corresponds to the JSON property `sendTime`
12330
+ # @return [String]
12331
+ attr_accessor :send_time
12332
+
12333
+ # The result of sentiment analysis. Sentiment analysis inspects user input and
12334
+ # identifies the prevailing subjective opinion, especially to determine a user's
12335
+ # attitude as positive, negative, or neutral. For Participants.DetectIntent, it
12336
+ # needs to be configured in DetectIntentRequest.query_params. For Participants.
12337
+ # StreamingDetectIntent, it needs to be configured in
12338
+ # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent
12339
+ # and Participants.StreamingAnalyzeContent, it needs to be configured in
12340
+ # ConversationProfile.human_agent_assistant_config
12341
+ # Corresponds to the JSON property `sentimentAnalysis`
12342
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SentimentAnalysisResult]
12343
+ attr_accessor :sentiment_analysis
12344
+
12345
+ def initialize(**args)
12346
+ update!(**args)
12347
+ end
12348
+
12349
+ # Update properties of this object
12350
+ def update!(**args)
12351
+ @content = args[:content] if args.key?(:content)
12352
+ @create_time = args[:create_time] if args.key?(:create_time)
12353
+ @language_code = args[:language_code] if args.key?(:language_code)
12354
+ @message_annotation = args[:message_annotation] if args.key?(:message_annotation)
12355
+ @name = args[:name] if args.key?(:name)
12356
+ @participant = args[:participant] if args.key?(:participant)
12357
+ @participant_role = args[:participant_role] if args.key?(:participant_role)
12358
+ @send_time = args[:send_time] if args.key?(:send_time)
12359
+ @sentiment_analysis = args[:sentiment_analysis] if args.key?(:sentiment_analysis)
12360
+ end
12361
+ end
12362
+
12363
+ # Represents the result of annotation for the message.
12364
+ class GoogleCloudDialogflowV2beta1MessageAnnotation
12365
+ include Google::Apis::Core::Hashable
12366
+
12367
+ # Required. Indicates whether the text message contains entities.
12368
+ # Corresponds to the JSON property `containEntities`
12369
+ # @return [Boolean]
12370
+ attr_accessor :contain_entities
12371
+ alias_method :contain_entities?, :contain_entities
12372
+
12373
+ # Optional. The collection of annotated message parts ordered by their position
12374
+ # in the message. You can recover the annotated message by concatenating [
12375
+ # AnnotatedMessagePart.text].
12376
+ # Corresponds to the JSON property `parts`
12377
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1AnnotatedMessagePart>]
12378
+ attr_accessor :parts
12379
+
12380
+ def initialize(**args)
12381
+ update!(**args)
12382
+ end
12383
+
12384
+ # Update properties of this object
12385
+ def update!(**args)
12386
+ @contain_entities = args[:contain_entities] if args.key?(:contain_entities)
12387
+ @parts = args[:parts] if args.key?(:parts)
12388
+ end
12389
+ end
12390
+
10288
12391
  # Represents the contents of the original request that was passed to the `[
10289
12392
  # Streaming]DetectIntent` call.
10290
12393
  class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest
@@ -10585,6 +12688,188 @@ module Google
10585
12688
  end
10586
12689
  end
10587
12690
 
12691
+ # Represents a smart reply answer.
12692
+ class GoogleCloudDialogflowV2beta1SmartReplyAnswer
12693
+ include Google::Apis::Core::Hashable
12694
+
12695
+ # The name of answer record, in the format of "projects//locations//
12696
+ # answerRecords/"
12697
+ # Corresponds to the JSON property `answerRecord`
12698
+ # @return [String]
12699
+ attr_accessor :answer_record
12700
+
12701
+ # Smart reply confidence. The system's confidence score that this reply is a
12702
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
12703
+ # to 1.0 (completely certain).
12704
+ # Corresponds to the JSON property `confidence`
12705
+ # @return [Float]
12706
+ attr_accessor :confidence
12707
+
12708
+ # The content of the reply.
12709
+ # Corresponds to the JSON property `reply`
12710
+ # @return [String]
12711
+ attr_accessor :reply
12712
+
12713
+ def initialize(**args)
12714
+ update!(**args)
12715
+ end
12716
+
12717
+ # Update properties of this object
12718
+ def update!(**args)
12719
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
12720
+ @confidence = args[:confidence] if args.key?(:confidence)
12721
+ @reply = args[:reply] if args.key?(:reply)
12722
+ end
12723
+ end
12724
+
12725
+ # The response message for Participants.SuggestArticles.
12726
+ class GoogleCloudDialogflowV2beta1SuggestArticlesResponse
12727
+ include Google::Apis::Core::Hashable
12728
+
12729
+ # Output only. Articles ordered by score in descending order.
12730
+ # Corresponds to the JSON property `articleAnswers`
12731
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1ArticleAnswer>]
12732
+ attr_accessor :article_answers
12733
+
12734
+ # Number of messages prior to and including latest_message to compile the
12735
+ # suggestion. It may be smaller than the SuggestArticlesResponse.context_size
12736
+ # field in the request if there aren't that many messages in the conversation.
12737
+ # Corresponds to the JSON property `contextSize`
12738
+ # @return [Fixnum]
12739
+ attr_accessor :context_size
12740
+
12741
+ # The name of the latest conversation message used to compile suggestion for.
12742
+ # Format: `projects//locations//conversations//messages/`.
12743
+ # Corresponds to the JSON property `latestMessage`
12744
+ # @return [String]
12745
+ attr_accessor :latest_message
12746
+
12747
+ def initialize(**args)
12748
+ update!(**args)
12749
+ end
12750
+
12751
+ # Update properties of this object
12752
+ def update!(**args)
12753
+ @article_answers = args[:article_answers] if args.key?(:article_answers)
12754
+ @context_size = args[:context_size] if args.key?(:context_size)
12755
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12756
+ end
12757
+ end
12758
+
12759
+ # The request message for Participants.SuggestFaqAnswers.
12760
+ class GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse
12761
+ include Google::Apis::Core::Hashable
12762
+
12763
+ # Number of messages prior to and including latest_message to compile the
12764
+ # suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size
12765
+ # field in the request if there aren't that many messages in the conversation.
12766
+ # Corresponds to the JSON property `contextSize`
12767
+ # @return [Fixnum]
12768
+ attr_accessor :context_size
12769
+
12770
+ # Output only. Answers extracted from FAQ documents.
12771
+ # Corresponds to the JSON property `faqAnswers`
12772
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1FaqAnswer>]
12773
+ attr_accessor :faq_answers
12774
+
12775
+ # The name of the latest conversation message used to compile suggestion for.
12776
+ # Format: `projects//locations//conversations//messages/`.
12777
+ # Corresponds to the JSON property `latestMessage`
12778
+ # @return [String]
12779
+ attr_accessor :latest_message
12780
+
12781
+ def initialize(**args)
12782
+ update!(**args)
12783
+ end
12784
+
12785
+ # Update properties of this object
12786
+ def update!(**args)
12787
+ @context_size = args[:context_size] if args.key?(:context_size)
12788
+ @faq_answers = args[:faq_answers] if args.key?(:faq_answers)
12789
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12790
+ end
12791
+ end
12792
+
12793
+ # The response message for Participants.SuggestSmartReplies.
12794
+ class GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse
12795
+ include Google::Apis::Core::Hashable
12796
+
12797
+ # Number of messages prior to and including latest_message to compile the
12798
+ # suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size
12799
+ # field in the request if there aren't that many messages in the conversation.
12800
+ # Corresponds to the JSON property `contextSize`
12801
+ # @return [Fixnum]
12802
+ attr_accessor :context_size
12803
+
12804
+ # The name of the latest conversation message used to compile suggestion for.
12805
+ # Format: `projects//locations//conversations//messages/`.
12806
+ # Corresponds to the JSON property `latestMessage`
12807
+ # @return [String]
12808
+ attr_accessor :latest_message
12809
+
12810
+ # Output only. Multiple reply options provided by smart reply service. The order
12811
+ # is based on the rank of the model prediction. The maximum number of the
12812
+ # returned replies is set in SmartReplyConfig.
12813
+ # Corresponds to the JSON property `smartReplyAnswers`
12814
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SmartReplyAnswer>]
12815
+ attr_accessor :smart_reply_answers
12816
+
12817
+ def initialize(**args)
12818
+ update!(**args)
12819
+ end
12820
+
12821
+ # Update properties of this object
12822
+ def update!(**args)
12823
+ @context_size = args[:context_size] if args.key?(:context_size)
12824
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12825
+ @smart_reply_answers = args[:smart_reply_answers] if args.key?(:smart_reply_answers)
12826
+ end
12827
+ end
12828
+
12829
+ # One response of different type of suggestion response which is used in the
12830
+ # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
12831
+ # well as HumanAgentAssistantEvent.
12832
+ class GoogleCloudDialogflowV2beta1SuggestionResult
12833
+ include Google::Apis::Core::Hashable
12834
+
12835
+ # The `Status` type defines a logical error model that is suitable for different
12836
+ # programming environments, including REST APIs and RPC APIs. It is used by [
12837
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
12838
+ # data: error code, error message, and error details. You can find out more
12839
+ # about this error model and how to work with it in the [API Design Guide](https:
12840
+ # //cloud.google.com/apis/design/errors).
12841
+ # Corresponds to the JSON property `error`
12842
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
12843
+ attr_accessor :error
12844
+
12845
+ # The response message for Participants.SuggestArticles.
12846
+ # Corresponds to the JSON property `suggestArticlesResponse`
12847
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SuggestArticlesResponse]
12848
+ attr_accessor :suggest_articles_response
12849
+
12850
+ # The request message for Participants.SuggestFaqAnswers.
12851
+ # Corresponds to the JSON property `suggestFaqAnswersResponse`
12852
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse]
12853
+ attr_accessor :suggest_faq_answers_response
12854
+
12855
+ # The response message for Participants.SuggestSmartReplies.
12856
+ # Corresponds to the JSON property `suggestSmartRepliesResponse`
12857
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse]
12858
+ attr_accessor :suggest_smart_replies_response
12859
+
12860
+ def initialize(**args)
12861
+ update!(**args)
12862
+ end
12863
+
12864
+ # Update properties of this object
12865
+ def update!(**args)
12866
+ @error = args[:error] if args.key?(:error)
12867
+ @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
12868
+ @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
12869
+ @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
12870
+ end
12871
+ end
12872
+
10588
12873
  # The request message for a webhook call.
10589
12874
  class GoogleCloudDialogflowV2beta1WebhookRequest
10590
12875
  include Google::Apis::Core::Hashable
@@ -10675,6 +12960,14 @@ module Google
10675
12960
  # @return [String]
10676
12961
  attr_accessor :fulfillment_text
10677
12962
 
12963
+ # Indicates that a live agent should be brought in to handle the interaction
12964
+ # with the user. In most cases, when you set this flag to true, you would also
12965
+ # want to set end_interaction to true as well. Default is false.
12966
+ # Corresponds to the JSON property `liveAgentHandoff`
12967
+ # @return [Boolean]
12968
+ attr_accessor :live_agent_handoff
12969
+ alias_method :live_agent_handoff?, :live_agent_handoff
12970
+
10678
12971
  # Optional. The collection of output contexts that will overwrite currently
10679
12972
  # active contexts for the session and reset their lifespans. When provided,
10680
12973
  # Dialogflow uses this field to populate QueryResult.output_contexts sent to the
@@ -10721,6 +13014,7 @@ module Google
10721
13014
  @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input)
10722
13015
  @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages)
10723
13016
  @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text)
13017
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
10724
13018
  @output_contexts = args[:output_contexts] if args.key?(:output_contexts)
10725
13019
  @payload = args[:payload] if args.key?(:payload)
10726
13020
  @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types)