Google Cloud Dialogflow Cx V3 Client - Class QueryResult (0.4.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class QueryResult.

Represents the result of a conversational query.

Generated from protobuf message google.cloud.dialogflow.cx.v3.QueryResult

Constructor.

If natural language text was provided as input, this field will contain a copy of the text.

If natural language text was provided as input, this field will contain a copy of the text.

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> .

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> .

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

If an event was provided as input, this field will contain the name of the event.

If an event was provided as input, this field will contain the name of the event.

If a DTMF was provided as input, this field will contain a copy of the DtmfInput .

If a DTMF was provided as input, this field will contain a copy of the DtmfInput .

The language that was triggered during intent detection.

See Language Support for a list of the currently supported language codes.

The language that was triggered during intent detection.

See Language Support for a list of the currently supported language codes.

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 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.

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 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.

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.

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.

The list of webhook ids in the order of call sequence.

The list of webhook ids in the order of call sequence.

The list of webhook display names in the order of call sequence.

The list of webhook display names in the order of call sequence.

The list of webhook latencies in the order of call sequence.

The list of webhook latencies in the order of call sequence.

The list of webhook tags in the order of call sequence.

The list of webhook tags in the order of call sequence.

The list of webhook call status in the order of call sequence.

The list of webhook call status in the order of call sequence.

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.

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.

The current Page . Some, not all fields are filled in this message, including but not limited to name and display_name .

The current Page . Some, not all fields are filled in this message, including but not limited to name and display_name .

The current Flow . Some, not all fields are filled in this message, including but not limited to name and display_name .

The current Flow . Some, not all fields are filled in this message, including but not limited to name and display_name .

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.

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.

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.

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 match result, could be an intent or an event.

Intent match result, could be an intent or an event.

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.

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.

The sentiment analyss result, which depends on analyze_query_text_sentiment , specified in the request.

The sentiment analyss result, which depends on analyze_query_text_sentiment , specified in the request.

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 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.

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

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

Optional. Data store connection feature output signals.

Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request.

Optional. Data store connection feature output signals.

Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request.