google_api_dialogflow v0.7.0 GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1QueryResult View Source
Represents the result of conversational query or event processing.
Attributes
action
(type:String.t
, default:nil
) - The action name from the matched intent.allRequiredParamsPresent
(type:boolean()
, default:nil
) - 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.
diagnosticInfo
(type:map()
, default:nil
) - 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.fulfillmentMessages
(type:list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1IntentMessage.t)
, default:nil
) - The collection of rich messages to present to the user.fulfillmentText
(type:String.t
, default:nil
) - The text to be pronounced to the user or shown on the screen. Note: This is a legacy field,fulfillment_messages
should be preferred.intent
(type:GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Intent.t
, default:nil
) - The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to:name
,display_name
andwebhook_state
.intentDetectionConfidence
(type:number()
, default:nil
) - The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there aremultiple knowledge_answers
messages, this value is set to the greatestknowledgeAnswers.match_confidence
value in the list.knowledgeAnswers
(type:GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1KnowledgeAnswers.t
, default:nil
) - The result from Knowledge Connector (if any), ordered by decreasingKnowledgeAnswers.match_confidence
.languageCode
(type:String.t
, default:nil
) - The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.outputContexts
(type:list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Context.t)
, default:nil
) - 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.parameters
(type:map()
, default:nil
) - The collection of extracted parameters.queryText
(type:String.t
, default:nil
) - 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.
- If natural language text was provided as input,
sentimentAnalysisResult
(type:GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1SentimentAnalysisResult.t
, default:nil
) - The sentiment analysis result, which depends on thesentiment_analysis_request_config
specified in the request.speechRecognitionConfidence
(type:number()
, default:nil
) - 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.
webhookPayload
(type:map()
, default:nil
) - If the query was fulfilled by a webhook call, this field is set to the value of thepayload
field returned in the webhook response.webhookSource
(type:String.t
, default:nil
) - If the query was fulfilled by a webhook call, this field is set to the value of thesource
field returned in the webhook response.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Source
t() :: %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1QueryResult{
action: String.t(),
allRequiredParamsPresent: boolean(),
diagnosticInfo: map(),
fulfillmentMessages: [
GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1IntentMessage.t()
],
fulfillmentText: String.t(),
intent: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Intent.t(),
intentDetectionConfidence: number(),
knowledgeAnswers:
GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1KnowledgeAnswers.t(),
languageCode: String.t(),
outputContexts: [
GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Context.t()
],
parameters: map(),
queryText: String.t(),
sentimentAnalysisResult:
GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1SentimentAnalysisResult.t(),
speechRecognitionConfidence: number(),
webhookPayload: map(),
webhookSource: String.t()
}
t() :: %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1QueryResult{ action: String.t(), allRequiredParamsPresent: boolean(), diagnosticInfo: map(), fulfillmentMessages: [ GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1IntentMessage.t() ], fulfillmentText: String.t(), intent: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Intent.t(), intentDetectionConfidence: number(), knowledgeAnswers: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1KnowledgeAnswers.t(), languageCode: String.t(), outputContexts: [ GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Context.t() ], parameters: map(), queryText: String.t(), sentimentAnalysisResult: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1SentimentAnalysisResult.t(), speechRecognitionConfidence: number(), webhookPayload: map(), webhookSource: String.t() }
Link to this section Functions
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.