Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryResult
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryResult
- 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>
Free-form diagnostic information for the associated detect intent request.
-
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessage>
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::GoogleCloudDialogflowV2Intent
Represents an intent.
-
#intent_detection_confidence ⇒ Float
The intent detection confidence.
-
#language_code ⇒ String
The language that was triggered during intent detection.
-
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context>
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::GoogleCloudDialogflowV2SentimentAnalysisResult
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) ⇒ GoogleCloudDialogflowV2QueryResult
constructor
A new instance of GoogleCloudDialogflowV2QueryResult.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2QueryResult
Returns a new instance of GoogleCloudDialogflowV2QueryResult.
3049 3050 3051 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3049 def initialize(**args) update!(**args) end |
Instance Attribute Details
#action ⇒ String
The action name from the matched intent.
Corresponds to the JSON property action
2934 2935 2936 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2934 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
2943 2944 2945 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2943 def all_required_params_present @all_required_params_present end |
#diagnostic_info ⇒ Hash<String,Object>
Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain:
- webhook call latency
- webhook errors
Corresponds to the JSON property
diagnosticInfo
2954 2955 2956 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2954 def diagnostic_info @diagnostic_info end |
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessage>
The collection of rich messages to present to the user.
Corresponds to the JSON property fulfillmentMessages
2959 2960 2961 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2959 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
2965 2966 2967 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2965 def fulfillment_text @fulfillment_text end |
#intent ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
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
2972 2973 2974 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2972 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
2984 2985 2986 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2984 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
2992 2993 2994 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2992 def language_code @language_code end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context>
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
3000 3001 3002 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3000 def output_contexts @output_contexts end |
#parameters ⇒ Hash<String,Object>
The collection of extracted parameters.
Corresponds to the JSON property parameters
3005 3006 3007 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3005 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
3017 3018 3019 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3017 def query_text @query_text end |
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisResult
The result of sentiment analysis as configured by
sentiment_analysis_request_config
.
Corresponds to the JSON property sentimentAnalysisResult
3023 3024 3025 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3023 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
3035 3036 3037 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3035 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
3041 3042 3043 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3041 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
3047 3048 3049 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3047 def webhook_source @webhook_source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3054 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) @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 |