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