Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3QueryResult
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3QueryResult
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb
Overview
Represents the result of a conversational query.
Instance Attribute Summary collapse
-
#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
-
#allow_answer_feedback ⇒ Boolean
(also: #allow_answer_feedback?)
Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
-
#current_page ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page
A Dialogflow CX conversation (session) can be described and visualized as a state machine.
-
#diagnostic_info ⇒ Hash<String,Object>
The free-form diagnostic info.
-
#dtmf ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DtmfInput
Represents the input for dtmf event.
-
#intent ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
An intent represents a user's intent to interact with a conversational agent.
-
#intent_detection_confidence ⇒ Float
The intent detection confidence.
-
#language_code ⇒ String
The language that was triggered during intent detection.
-
#match ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Match
Represents one match result of MatchIntent.
-
#parameters ⇒ Hash<String,Object>
The collected session parameters.
-
#response_messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>
The list of rich messages returned to the client.
-
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SentimentAnalysisResult
The result of sentiment analysis.
-
#text ⇒ String
If natural language text was provided as input, this field will contain a copy of the text.
-
#transcript ⇒ String
If natural language speech audio was provided as input, this field will contain the transcript for the audio.
-
#trigger_event ⇒ String
If an event was provided as input, this field will contain the name of the event.
-
#trigger_intent ⇒ String
If an intent was provided as input, this field will contain a copy of the intent identifier.
-
#webhook_payloads ⇒ Array<Hash<String,Object>>
The list of webhook payload in WebhookResponse.payload, in the order of call sequence.
-
#webhook_statuses ⇒ Array<Google::Apis::DialogflowV3::GoogleRpcStatus>
The list of webhook call status in the order of call sequence.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3QueryResult
constructor
A new instance of GoogleCloudDialogflowCxV3QueryResult.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3QueryResult
Returns a new instance of GoogleCloudDialogflowCxV3QueryResult.
5438 5439 5440 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5438 def initialize(**args) update!(**args) end |
Instance Attribute Details
#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
Settings exposed at lower level overrides the settings exposed at higher level.
Overriding occurs at the sub-setting level. For example, the
playback_interruption_settings at fulfillment level only overrides the
playback_interruption_settings at the agent level, leaving other settings at
the agent level unchanged. DTMF settings does not override each other. DTMF
settings set at different levels define DTMF detections running in parallel.
Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
Corresponds to the JSON property advancedSettings
5299 5300 5301 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5299 def advanced_settings @advanced_settings end |
#allow_answer_feedback ⇒ Boolean Also known as: allow_answer_feedback?
Indicates whether the Thumbs up/Thumbs down rating controls are need to be
shown for the response in the Dialogflow Messenger widget.
Corresponds to the JSON property allowAnswerFeedback
5305 5306 5307 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5305 def allow_answer_feedback @allow_answer_feedback end |
#current_page ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page
A Dialogflow CX conversation (session) can be described and visualized as a
state machine. The states of a CX session are represented by pages. For each
flow, you define many pages, where your combined pages can handle a complete
conversation on the topics the flow is designed for. At any given moment,
exactly one page is the current page, the current page is considered active,
and the flow associated with that page is considered active. Every flow has a
special start page. When a flow initially becomes active, the start page page
becomes the current page. For each conversational turn, the current page will
either stay the same or transition to another page. You configure each page to
collect information from the end-user that is relevant for the conversational
state represented by the page. For more information, see the Page guide.
Corresponds to the JSON property currentPage
5322 5323 5324 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5322 def current_page @current_page end |
#diagnostic_info ⇒ Hash<String,Object>
The free-form diagnostic info. For example, this field could contain webhook
call latency. The fields of this data can change without notice, so you should
not write code that depends on its structure. One of the fields is called "
Alternative Matched Intents", which may aid with debugging. The following
describes these intent results: - The list is empty if no intent was matched
to end-user input. - Only intents that are referenced in the currently active
flow are included. - The matched intent is included. - Other intents that
could have matched end-user input, but did not match because they are
referenced by intent routes that are out of scope, are included. - Other intents
referenced by intent routes in scope that matched end-user input, but had a
lower confidence score.
Corresponds to the JSON property diagnosticInfo
5338 5339 5340 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5338 def diagnostic_info @diagnostic_info end |
#dtmf ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DtmfInput
Represents the input for dtmf event.
Corresponds to the JSON property dtmf
5343 5344 5345 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5343 def dtmf @dtmf end |
#intent ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
An intent represents a user's intent to interact with a conversational agent.
You can provide information for the Dialogflow API to use to match user input
to an intent by adding training phrases (i.e., examples of user input) to your
intent.
Corresponds to the JSON property intent
5351 5352 5353 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5351 def intent @intent end |
#intent_detection_confidence ⇒ Float
The intent detection confidence. Values range from 0.0 (completely uncertain)
to 1.0 (completely certain). This value is for informational purpose only and
is only used to help match the best intent within the classification threshold.
This value may change for the same end-user expression at any time due to a
model retraining or change in implementation. This field is deprecated, please
use QueryResult.match instead.
Corresponds to the JSON property intentDetectionConfidence
5361 5362 5363 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5361 def intent_detection_confidence @intent_detection_confidence end |
#language_code ⇒ String
The language that was triggered during intent detection. See Language Support for a list of
the currently supported language codes.
Corresponds to the JSON property languageCode
5368 5369 5370 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5368 def language_code @language_code end |
#match ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Match
Represents one match result of MatchIntent.
Corresponds to the JSON property match
5373 5374 5375 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5373 def match @match end |
#parameters ⇒ Hash<String,Object>
The collected session parameters. Depending on your protocol or client library
language, this is a map, associative array, symbol table, dictionary, or JSON
object composed of a collection of (MapKey, MapValue) pairs: * MapKey type:
string * MapKey value: parameter name * MapValue type: If parameter's entity
type is a composite entity then use map, otherwise, depending on the parameter
value type, it could be one of string, number, boolean, null, list or map. *
MapValue value: If parameter's entity type is a composite entity then use map
from composite entity property names to property values, otherwise, use
parameter value.
Corresponds to the JSON property parameters
5386 5387 5388 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5386 def parameters @parameters end |
#response_messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>
The list of rich messages returned to the client. Responses vary from simple
text messages to more sophisticated, structured payloads used to drive complex
logic.
Corresponds to the JSON property responseMessages
5393 5394 5395 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5393 def @response_messages end |
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SentimentAnalysisResult
The result of sentiment analysis. Sentiment analysis inspects user input and
identifies the prevailing subjective opinion, especially to determine a user's
attitude as positive, negative, or neutral.
Corresponds to the JSON property sentimentAnalysisResult
5400 5401 5402 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5400 def sentiment_analysis_result @sentiment_analysis_result end |
#text ⇒ String
If natural language text was provided as input, this field will contain a copy
of the text.
Corresponds to the JSON property text
5406 5407 5408 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5406 def text @text end |
#transcript ⇒ String
If natural language speech audio was provided as input, this field will
contain the transcript for the audio.
Corresponds to the JSON property transcript
5412 5413 5414 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5412 def transcript @transcript end |
#trigger_event ⇒ String
If an event was provided as input, this field will contain the name of the
event.
Corresponds to the JSON property triggerEvent
5418 5419 5420 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5418 def trigger_event @trigger_event end |
#trigger_intent ⇒ String
If an intent was provided as input, this field will contain a copy of the
intent identifier. Format: projects//locations//agents//intents/
.
Corresponds to the JSON property triggerIntent
5424 5425 5426 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5424 def trigger_intent @trigger_intent end |
#webhook_payloads ⇒ Array<Hash<String,Object>>
The list of webhook payload in WebhookResponse.payload, in the order of call
sequence. If some webhook call fails or doesn't return any payload, an empty
Struct
would be used instead.
Corresponds to the JSON property webhookPayloads
5431 5432 5433 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5431 def webhook_payloads @webhook_payloads end |
#webhook_statuses ⇒ Array<Google::Apis::DialogflowV3::GoogleRpcStatus>
The list of webhook call status in the order of call sequence.
Corresponds to the JSON property webhookStatuses
5436 5437 5438 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5436 def webhook_statuses @webhook_statuses end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5443 def update!(**args) @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings) @allow_answer_feedback = args[:allow_answer_feedback] if args.key?(:allow_answer_feedback) @current_page = args[:current_page] if args.key?(:current_page) @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info) @dtmf = args[:dtmf] if args.key?(:dtmf) @intent = args[:intent] if args.key?(:intent) @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence) @language_code = args[:language_code] if args.key?(:language_code) @match = args[:match] if args.key?(:match) @parameters = args[:parameters] if args.key?(:parameters) @response_messages = args[:response_messages] if args.key?(:response_messages) @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result) @text = args[:text] if args.key?(:text) @transcript = args[:transcript] if args.key?(:transcript) @trigger_event = args[:trigger_event] if args.key?(:trigger_event) @trigger_intent = args[:trigger_intent] if args.key?(:trigger_intent) @webhook_payloads = args[:webhook_payloads] if args.key?(:webhook_payloads) @webhook_statuses = args[:webhook_statuses] if args.key?(:webhook_statuses) end |