google_api_dialogflow v0.6.0 GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1QueryResult View Source

Represents the result of conversational query or event processing.

Attributes

  • parameters (%{optional(String.t) => String.t}): The collection of extracted parameters. Defaults to: null.
  • action (String.t): The action name from the matched intent. Defaults to: null.
  • allRequiredParamsPresent (boolean()): 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. Defaults to: null.
  • diagnosticInfo (%{optional(String.t) => String.t}): 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. Defaults to: null.
  • fulfillmentMessages ([GoogleCloudDialogflowV2beta1IntentMessage]): The collection of rich messages to present to the user. Defaults to: null.
  • fulfillmentText (String.t): The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred. Defaults to: null.
  • intent (GoogleCloudDialogflowV2beta1Intent): The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`. Defaults to: null.
  • intentDetectionConfidence (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. Defaults to: null.
  • knowledgeAnswers (GoogleCloudDialogflowV2beta1KnowledgeAnswers): The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`. Defaults to: null.
  • languageCode (String.t): The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes. Defaults to: null.
  • outputContexts ([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. Defaults to: null.
  • queryText (String.t): 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. Defaults to: null.
  • sentimentAnalysisResult (GoogleCloudDialogflowV2beta1SentimentAnalysisResult): The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request. Defaults to: null.
  • speechRecognitionConfidence (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. Defaults to: null.
  • webhookPayload (%{optional(String.t) => String.t}): 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. Defaults to: null.
  • webhookSource (String.t): 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. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1QueryResult{
  action: any(),
  allRequiredParamsPresent: any(),
  diagnosticInfo: map(),
  fulfillmentMessages: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1IntentMessage.t()
  ],
  fulfillmentText: any(),
  intent: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Intent.t(),
  intentDetectionConfidence: any(),
  knowledgeAnswers:
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1KnowledgeAnswers.t(),
  languageCode: any(),
  outputContexts: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Context.t()
  ],
  parameters: map(),
  queryText: any(),
  sentimentAnalysisResult:
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1SentimentAnalysisResult.t(),
  speechRecognitionConfidence: any(),
  webhookPayload: map(),
  webhookSource: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.