Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryResult
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryResult
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2beta1/classes.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb,
generated/google/apis/dialogflow_v2beta1/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::DialogflowV2beta1::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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent
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::DialogflowV2beta1::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. -
#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
3577 3578 3579 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3577 def initialize(**args) update!(**args) end |
Instance Attribute Details
#action ⇒ String
The action name from the matched intent.
Corresponds to the JSON property action
3479 3480 3481 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3479 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
3488 3489 3490 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3488 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.
Corresponds to the JSON property diagnosticInfo
3495 3496 3497 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3495 def diagnostic_info @diagnostic_info end |
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessage>
The collection of rich messages to present to the user.
Corresponds to the JSON property fulfillmentMessages
3500 3501 3502 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3500 def @fulfillment_messages end |
#fulfillment_text ⇒ String
The text to be pronounced to the user or shown on the screen.
Corresponds to the JSON property fulfillmentText
3505 3506 3507 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3505 def fulfillment_text @fulfillment_text end |
#intent ⇒ Google::Apis::DialogflowV2beta1::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
3512 3513 3514 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3512 def intent @intent end |
#intent_detection_confidence ⇒ Float
The intent detection confidence. Values range from 0.0
(completely uncertain) to 1.0 (completely certain).
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
3520 3521 3522 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3520 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
3527 3528 3529 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3527 def language_code @language_code end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV2beta1::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
3535 3536 3537 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3535 def output_contexts @output_contexts end |
#parameters ⇒ Hash<String,Object>
The collection of extracted parameters.
Corresponds to the JSON property parameters
3540 3541 3542 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3540 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 an event was provided as input,
query_text
is not set. Corresponds to the JSON propertyqueryText
3551 3552 3553 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3551 def query_text @query_text 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
3563 3564 3565 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3563 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
3569 3570 3571 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3569 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
3575 3576 3577 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3575 def webhook_source @webhook_source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3582 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) @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 |