Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1QueryResult
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1QueryResult
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/representations.rb
Overview
Represents the result of conversational query or event processing.
Instance Attribute Summary collapse
-
#action ⇒ String
The action name from the matched intent.
-
#all_required_params_present ⇒ Boolean
(also: #all_required_params_present?)
This field is set to: -
false
if the matched intent has required parameters and not all of the required parameter values have been collected. -
#diagnostic_info ⇒ Hash<String,Object>
The free-form diagnostic info.
-
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessage>
The collection of rich messages to present to the user.
-
#fulfillment_text ⇒ String
The text to be pronounced to the user or shown on the screen.
-
#intent ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Intent
Represents an intent.
-
#intent_detection_confidence ⇒ Float
The intent detection confidence.
-
#knowledge_answers ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1KnowledgeAnswers
Represents the result of querying a Knowledge base.
-
#language_code ⇒ String
The language that was triggered during intent detection.
-
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Context>
The collection of output contexts.
-
#parameters ⇒ Hash<String,Object>
The collection of extracted parameters.
-
#query_text ⇒ String
The original conversational query text: - If natural language text was provided as input,
query_text
contains a copy of the input. -
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SentimentAnalysisResult
The result of sentiment analysis as configured by
sentiment_analysis_request_config
. -
#speech_recognition_confidence ⇒ Float
The Speech recognition confidence between 0.0 and 1.0.
-
#webhook_payload ⇒ Hash<String,Object>
If the query was fulfilled by a webhook call, this field is set to the value of the
payload
field returned in the webhook response. -
#webhook_source ⇒ String
If the query was fulfilled by a webhook call, this field is set to the value of the
source
field returned in the webhook response.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1QueryResult
constructor
A new instance of GoogleCloudDialogflowV2beta1QueryResult.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1QueryResult
Returns a new instance of GoogleCloudDialogflowV2beta1QueryResult
4845 4846 4847 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4845 def initialize(**args) update!(**args) end |
Instance Attribute Details
#action ⇒ String
The action name from the matched intent.
Corresponds to the JSON property action
4728 4729 4730 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4728 def action @action end |
#all_required_params_present ⇒ Boolean Also known as: all_required_params_present?
This field is set to:
false
if the matched intent has required parameters and not all of the required parameter values have been collected.true
if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. Corresponds to the JSON propertyallRequiredParamsPresent
4737 4738 4739 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4737 def all_required_params_present @all_required_params_present end |
#diagnostic_info ⇒ Hash<String,Object>
The free-form diagnostic info. For example, this field could contain
webhook call latency. The string keys of the Struct's fields map can change
without notice.
Corresponds to the JSON property diagnosticInfo
4745 4746 4747 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4745 def diagnostic_info @diagnostic_info end |
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessage>
The collection of rich messages to present to the user.
Corresponds to the JSON property fulfillmentMessages
4750 4751 4752 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4750 def @fulfillment_messages end |
#fulfillment_text ⇒ String
The text to be pronounced to the user or shown on the screen.
Note: This is a legacy field, fulfillment_messages
should be preferred.
Corresponds to the JSON property fulfillmentText
4756 4757 4758 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4756 def fulfillment_text @fulfillment_text end |
#intent ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Intent
Represents an intent.
Intents convert a number of user expressions or patterns into an action. An
action is an extraction of a user command or sentence semantics.
Corresponds to the JSON property intent
4763 4764 4765 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4763 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.
If there are multiple knowledge_answers
messages, this value is set to
the greatest knowledgeAnswers.match_confidence
value in the list.
Corresponds to the JSON property intentDetectionConfidence
4775 4776 4777 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4775 def intent_detection_confidence @intent_detection_confidence end |
#knowledge_answers ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1KnowledgeAnswers
Represents the result of querying a Knowledge base.
Corresponds to the JSON property knowledgeAnswers
4780 4781 4782 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4780 def knowledge_answers @knowledge_answers 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
4788 4789 4790 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4788 def language_code @language_code end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Context>
The collection of output contexts. If applicable,
output_contexts.parameters
contains entries with name
<parameter name>.original
containing the original parameter values
before the query.
Corresponds to the JSON property outputContexts
4796 4797 4798 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4796 def output_contexts @output_contexts end |
#parameters ⇒ Hash<String,Object>
The collection of extracted parameters.
Corresponds to the JSON property parameters
4801 4802 4803 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4801 def parameters @parameters end |
#query_text ⇒ String
The original conversational query text:
- If natural language text was provided as input,
query_text
contains a copy of the input. - If natural language speech audio was provided as input,
query_text
contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled,
query_text
will contain the corrected user input. Corresponds to the JSON propertyqueryText
4813 4814 4815 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4813 def query_text @query_text end |
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SentimentAnalysisResult
The result of sentiment analysis as configured by
sentiment_analysis_request_config
.
Corresponds to the JSON property sentimentAnalysisResult
4819 4820 4821 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4819 def sentiment_analysis_result @sentiment_analysis_result end |
#speech_recognition_confidence ⇒ Float
The Speech recognition confidence between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. The default of 0.0 is a sentinel value indicating that confidence
was not set.
This field is not guaranteed to be accurate or set. In particular this
field isn't set for StreamingDetectIntent since the streaming endpoint has
separate confidence estimates per portion of the audio in
StreamingRecognitionResult.
Corresponds to the JSON property speechRecognitionConfidence
4831 4832 4833 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4831 def speech_recognition_confidence @speech_recognition_confidence end |
#webhook_payload ⇒ Hash<String,Object>
If the query was fulfilled by a webhook call, this field is set to the
value of the payload
field returned in the webhook response.
Corresponds to the JSON property webhookPayload
4837 4838 4839 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4837 def webhook_payload @webhook_payload end |
#webhook_source ⇒ String
If the query was fulfilled by a webhook call, this field is set to the
value of the source
field returned in the webhook response.
Corresponds to the JSON property webhookSource
4843 4844 4845 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4843 def webhook_source @webhook_source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4850 def update!(**args) @action = args[:action] if args.key?(:action) @all_required_params_present = args[:all_required_params_present] if args.key?(:all_required_params_present) @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info) @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) @intent = args[:intent] if args.key?(:intent) @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence) @knowledge_answers = args[:knowledge_answers] if args.key?(:knowledge_answers) @language_code = args[:language_code] if args.key?(:language_code) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @parameters = args[:parameters] if args.key?(:parameters) @query_text = args[:query_text] if args.key?(:query_text) @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result) @speech_recognition_confidence = args[:speech_recognition_confidence] if args.key?(:speech_recognition_confidence) @webhook_payload = args[:webhook_payload] if args.key?(:webhook_payload) @webhook_source = args[:webhook_source] if args.key?(:webhook_source) end |