Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::QueryResult (v1.2.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::QueryResult.

Represents the result of a conversational query.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#advanced_settings

def advanced_settings() -> ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns

(::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.

#advanced_settings=

def advanced_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.

Returns

(::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.

#allow_answer_feedback

def allow_answer_feedback() -> ::Boolean

Returns

(::Boolean) — Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.

#allow_answer_feedback=

def allow_answer_feedback=(value) -> ::Boolean

Parameter

value (::Boolean) — Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.

Returns

(::Boolean) — Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.

#current_flow

def current_flow() -> ::Google::Cloud::Dialogflow::CX::V3::Flow

Returns

(::Google::Cloud::Dialogflow::CX::V3::Flow) — The current Flow. Some, not all fields are filled in this message, including but not limited to name and display_name.

#current_flow=

def current_flow=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Flow

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Flow) — The current Flow. Some, not all fields are filled in this message, including but not limited to name and display_name.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Flow) — The current Flow. Some, not all fields are filled in this message, including but not limited to name and display_name.

#current_page

def current_page() -> ::Google::Cloud::Dialogflow::CX::V3::Page

Returns

(::Google::Cloud::Dialogflow::CX::V3::Page) — The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.

#current_page=

def current_page=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Page

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Page) — The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Page) — The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.

#data_store_connection_signals

def data_store_connection_signals() -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals

Returns

(::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals) — Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request.

#data_store_connection_signals=

def data_store_connection_signals=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals) — Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request.

Returns

(::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals) — Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request.

#diagnostic_info

def diagnostic_info() -> ::Google::Protobuf::Struct

Returns

(::Google::Protobuf::Struct) —
The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure.

One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results:
- The list is empty if no intent was matched to end-user input.
- Only intents that are referenced in the currently active flow are included.
- The matched intent is included.
- Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.
- Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.

#diagnostic_info=

def diagnostic_info=(value) -> ::Google::Protobuf::Struct

Parameter

value (::Google::Protobuf::Struct) —
The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure.

One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results:
- The list is empty if no intent was matched to end-user input.
- Only intents that are referenced in the currently active flow are included.
- The matched intent is included.
- Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.
- Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.

Returns

(::Google::Protobuf::Struct) —
The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure.

One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results:
- The list is empty if no intent was matched to end-user input.
- Only intents that are referenced in the currently active flow are included.
- The matched intent is included.
- Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.
- Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.

#dtmf

def dtmf() -> ::Google::Cloud::Dialogflow::CX::V3::DtmfInput

Returns

(::Google::Cloud::Dialogflow::CX::V3::DtmfInput) — If a DTMF was provided as input, this field will contain a copy of the DtmfInput.

#dtmf=

def dtmf=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DtmfInput

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::DtmfInput) — If a DTMF was provided as input, this field will contain a copy of the DtmfInput.

Returns

(::Google::Cloud::Dialogflow::CX::V3::DtmfInput) — If a DTMF was provided as input, this field will contain a copy of the DtmfInput.

#intent

def intent() -> ::Google::Cloud::Dialogflow::CX::V3::Intent

Returns

(::Google::Cloud::Dialogflow::CX::V3::Intent) — The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name and display_name. This field is deprecated, please use QueryResult.match instead.

#intent=

def intent=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Intent

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Intent) — The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name and display_name. This field is deprecated, please use QueryResult.match instead.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Intent) — The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name and display_name. This field is deprecated, please use QueryResult.match instead.

#intent_detection_confidence

def intent_detection_confidence() -> ::Float

Returns

(::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. This field is deprecated, please use QueryResult.match instead.

#intent_detection_confidence=

def intent_detection_confidence=(value) -> ::Float

Parameter

value (::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. This field is deprecated, please use QueryResult.match instead.

Returns

(::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. This field is deprecated, please use QueryResult.match instead.

#language_code

def language_code() -> ::String

Returns

(::String) — The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

#language_code=

def language_code=(value) -> ::String

Parameter

value (::String) — The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

Returns

(::String) — The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

#match

def match() -> ::Google::Cloud::Dialogflow::CX::V3::Match

Returns

(::Google::Cloud::Dialogflow::CX::V3::Match) — Intent match result, could be an intent or an event.

#match=

def match=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Match

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Match) — Intent match result, could be an intent or an event.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Match) — Intent match result, could be an intent or an event.

#parameters

def parameters() -> ::Google::Protobuf::Struct

Returns

(::Google::Protobuf::Struct) —
The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
- MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

#parameters=

def parameters=(value) -> ::Google::Protobuf::Struct

Parameter

value (::Google::Protobuf::Struct) —
The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
- MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

Returns

(::Google::Protobuf::Struct) —
The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
- MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

#response_messages

def response_messages() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>) — 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.

#response_messages=

def response_messages=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>

Parameter

value (::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>) — 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.

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>) — 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.

#sentiment_analysis_result

def sentiment_analysis_result() -> ::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult

Returns

(::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult) — The sentiment analyss result, which depends on [analyze_query_text_sentiment] [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.

#sentiment_analysis_result=

def sentiment_analysis_result=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult) — The sentiment analyss result, which depends on [analyze_query_text_sentiment] [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.

Returns

(::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult) — The sentiment analyss result, which depends on [analyze_query_text_sentiment] [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.

#text

def text() -> ::String

Returns

(::String) — If natural language text was provided as input, this field will contain a copy of the text.

#text=

def text=(value) -> ::String

Parameter

value (::String) — If natural language text was provided as input, this field will contain a copy of the text.

Returns

(::String) — If natural language text was provided as input, this field will contain a copy of the text.

#transcript

def transcript() -> ::String

Returns

(::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

#transcript=

def transcript=(value) -> ::String

Parameter

value (::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

Returns

(::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

#trigger_event

def trigger_event() -> ::String

Returns

(::String) — If an event was provided as input, this field will contain the name of the event.

#trigger_event=

def trigger_event=(value) -> ::String

Parameter

value (::String) — If an event was provided as input, this field will contain the name of the event.

Returns

(::String) — If an event was provided as input, this field will contain the name of the event.

#trigger_intent

def trigger_intent() -> ::String

Returns

(::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.

#trigger_intent=

def trigger_intent=(value) -> ::String

Parameter

value (::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.

Returns

(::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.

#webhook_display_names

def webhook_display_names() -> ::Array<::String>

Returns

(::Array<::String>) — The list of webhook display names in the order of call sequence.

#webhook_display_names=

def webhook_display_names=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — The list of webhook display names in the order of call sequence.

Returns

(::Array<::String>) — The list of webhook display names in the order of call sequence.

#webhook_ids

def webhook_ids() -> ::Array<::String>

Returns

(::Array<::String>) — The list of webhook ids in the order of call sequence.

#webhook_ids=

def webhook_ids=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — The list of webhook ids in the order of call sequence.

Returns

(::Array<::String>) — The list of webhook ids in the order of call sequence.

#webhook_latencies

def webhook_latencies() -> ::Array<::Google::Protobuf::Duration>

Returns

(::Array<::Google::Protobuf::Duration>) — The list of webhook latencies in the order of call sequence.

#webhook_latencies=

def webhook_latencies=(value) -> ::Array<::Google::Protobuf::Duration>

Parameter

value (::Array<::Google::Protobuf::Duration>) — The list of webhook latencies in the order of call sequence.

Returns

(::Array<::Google::Protobuf::Duration>) — The list of webhook latencies in the order of call sequence.

#webhook_payloads

def webhook_payloads() -> ::Array<::Google::Protobuf::Struct>

Returns

(::Array<::Google::Protobuf::Struct>) — 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.

#webhook_payloads=

def webhook_payloads=(value) -> ::Array<::Google::Protobuf::Struct>

Parameter

value (::Array<::Google::Protobuf::Struct>) — 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.

Returns

(::Array<::Google::Protobuf::Struct>) — 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.

#webhook_statuses

def webhook_statuses() -> ::Array<::Google::Rpc::Status>

Returns

(::Array<::Google::Rpc::Status>) — The list of webhook call status in the order of call sequence.

#webhook_statuses=

def webhook_statuses=(value) -> ::Array<::Google::Rpc::Status>

Parameter

value (::Array<::Google::Rpc::Status>) — The list of webhook call status in the order of call sequence.

Returns

(::Array<::Google::Rpc::Status>) — The list of webhook call status in the order of call sequence.

#webhook_tags

def webhook_tags() -> ::Array<::String>

Returns

(::Array<::String>) — The list of webhook tags in the order of call sequence.

#webhook_tags=

def webhook_tags=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — The list of webhook tags in the order of call sequence.

Returns

(::Array<::String>) — The list of webhook tags in the order of call sequence.