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
- (::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
- 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.
- (::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
- (::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
- value (::Boolean) — Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
- (::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
-
(::Google::Cloud::Dialogflow::CX::V3::Flow) — The current Flow. Some, not all
fields are filled in this message, including but not limited to
name
anddisplay_name
.
#current_flow=
def current_flow=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Flow
-
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
anddisplay_name
.
-
(::Google::Cloud::Dialogflow::CX::V3::Flow) — The current Flow. Some, not all
fields are filled in this message, including but not limited to
name
anddisplay_name
.
#current_page
def current_page() -> ::Google::Cloud::Dialogflow::CX::V3::Page
-
(::Google::Cloud::Dialogflow::CX::V3::Page) — The current Page. Some, not all
fields are filled in this message, including but not limited to
name
anddisplay_name
.
#current_page=
def current_page=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Page
-
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
anddisplay_name
.
-
(::Google::Cloud::Dialogflow::CX::V3::Page) — The current Page. Some, not all
fields are filled in this message, including but not limited to
name
anddisplay_name
.
#diagnostic_info
def diagnostic_info() -> ::Google::Protobuf::Struct
-
(::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
-
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.
-
(::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
- (::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
- value (::Google::Cloud::Dialogflow::CX::V3::DtmfInput) — If a DTMF was provided as input, this field will contain a copy of the DtmfInput.
- (::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
-
(::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
anddisplay_name
. This field is deprecated, please use QueryResult.match instead.
#intent=
def intent=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Intent
-
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
anddisplay_name
. This field is deprecated, please use QueryResult.match instead.
-
(::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
anddisplay_name
. This field is deprecated, please use QueryResult.match instead.
#intent_detection_confidence
def intent_detection_confidence() -> ::Float
- (::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
- 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.
- (::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
- (::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
- value (::String) — The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.
- (::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
- (::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
- value (::Google::Cloud::Dialogflow::CX::V3::Match) — Intent match result, could be an intent or an event.
- (::Google::Cloud::Dialogflow::CX::V3::Match) — Intent match result, could be an intent or an event.
#parameters
def parameters() -> ::Google::Protobuf::Struct
-
(::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
-
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.
-
(::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>
- (::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>
- 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.
- (::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
-
(::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
-
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.
-
(::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
- (::String) — If natural language text was provided as input, this field will contain a copy of the text.
#text=
def text=(value) -> ::String
- value (::String) — If natural language text was provided as input, this field will contain a copy of the text.
- (::String) — If natural language text was provided as input, this field will contain a copy of the text.
#transcript
def transcript() -> ::String
- (::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
- 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.
- (::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
- (::String) — If an event was provided as input, this field will contain the name of the event.
#trigger_event=
def trigger_event=(value) -> ::String
- value (::String) — If an event was provided as input, this field will contain the name of the event.
- (::String) — If an event was provided as input, this field will contain the name of the event.
#trigger_intent
def trigger_intent() -> ::String
-
(::String) — If an intent was provided as
input, this field will contain a copy of the intent identifier. Format:
projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>
.
#trigger_intent=
def trigger_intent=(value) -> ::String
-
value (::String) — If an intent was provided as
input, this field will contain a copy of the intent identifier. Format:
projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>
.
-
(::String) — If an intent was provided as
input, this field will contain a copy of the intent identifier. Format:
projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>
.
#webhook_display_names
def webhook_display_names() -> ::Array<::String>
- (::Array<::String>) — The list of webhook display names in the order of call sequence.
#webhook_display_names=
def webhook_display_names=(value) -> ::Array<::String>
- value (::Array<::String>) — The list of webhook display names in the order of call sequence.
- (::Array<::String>) — The list of webhook display names in the order of call sequence.
#webhook_ids
def webhook_ids() -> ::Array<::String>
- (::Array<::String>) — The list of webhook ids in the order of call sequence.
#webhook_ids=
def webhook_ids=(value) -> ::Array<::String>
- value (::Array<::String>) — The list of webhook ids in the order of call sequence.
- (::Array<::String>) — The list of webhook ids in the order of call sequence.
#webhook_latencies
def webhook_latencies() -> ::Array<::Google::Protobuf::Duration>
- (::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>
- value (::Array<::Google::Protobuf::Duration>) — The list of webhook latencies in the order of call sequence.
- (::Array<::Google::Protobuf::Duration>) — The list of webhook latencies in the order of call sequence.
#webhook_payloads
def webhook_payloads() -> ::Array<::Google::Protobuf::Struct>
-
(::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>
-
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.
-
(::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>
- (::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>
- value (::Array<::Google::Rpc::Status>) — The list of webhook call status in the order of call sequence.
- (::Array<::Google::Rpc::Status>) — The list of webhook call status in the order of call sequence.
#webhook_tags
def webhook_tags() -> ::Array<::String>
- (::Array<::String>) — The list of webhook tags in the order of call sequence.
#webhook_tags=
def webhook_tags=(value) -> ::Array<::String>
- value (::Array<::String>) — The list of webhook tags in the order of call sequence.
- (::Array<::String>) — The list of webhook tags in the order of call sequence.