class Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3QueryResult
Represents the result of a conversational query.
Attributes
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide]( cloud.google.com/dialogflow/cx/docs/concept/page). Corresponds to the JSON property `currentPage` @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page]
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` @return [Hash<String,Object>]
An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. Corresponds to the JSON property `intent` @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent]
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. This field is deprecated, please use QueryResult.match instead. Corresponds to the JSON property `intentDetectionConfidence` @return [Float]
The language that was triggered during intent detection. See [Language Support] (cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. Corresponds to the JSON property `languageCode` @return [String]
Represents one match result of MatchIntent. Corresponds to the JSON property `match` @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Match]
The collected session parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value Corresponds to the JSON property `parameters` @return [Hash<String,Object>]
The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. Corresponds to the JSON property `responseMessages` @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>]
The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. Corresponds to the JSON property `sentimentAnalysisResult` @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SentimentAnalysisResult]
If natural language text was provided as input, this field will contain a copy of the text. Corresponds to the JSON property `text` @return [String]
If natural language speech audio was provided as input, this field will contain the transcript for the audio. Corresponds to the JSON property `transcript` @return [String]
If an event was provided as input, this field will contain the name of the event. Corresponds to the JSON property `triggerEvent` @return [String]
If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. Corresponds to the JSON property `triggerIntent` @return [String]
The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty ` Struct` would be used instead. Corresponds to the JSON property `webhookPayloads` @return [Array<Hash<String,Object>>]
The list of webhook call status in the order of call sequence. Corresponds to the JSON property `webhookStatuses` @return [Array<Google::Apis::DialogflowV3::GoogleRpcStatus>]
Public Class Methods
# File lib/google/apis/dialogflow_v3/classes.rb, line 3692 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/dialogflow_v3/classes.rb, line 3697 def update!(**args) @current_page = args[:current_page] if args.key?(:current_page) @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info) @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) @match = args[:match] if args.key?(:match) @parameters = args[:parameters] if args.key?(:parameters) @response_messages = args[:response_messages] if args.key?(:response_messages) @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result) @text = args[:text] if args.key?(:text) @transcript = args[:transcript] if args.key?(:transcript) @trigger_event = args[:trigger_event] if args.key?(:trigger_event) @trigger_intent = args[:trigger_intent] if args.key?(:trigger_intent) @webhook_payloads = args[:webhook_payloads] if args.key?(:webhook_payloads) @webhook_statuses = args[:webhook_statuses] if args.key?(:webhook_statuses) end