Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class QueryResult.
Represents the result of conversational query or event processing.
Generated from protobuf message google.cloud.dialogflow.v2.QueryResult
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ query_text
string
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 automatic spell correction is enabled, query_text
will contain the corrected user input.
↳ language_code
string
The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.
↳ speech_recognition_confidence
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.
↳ action
string
The action name from the matched intent.
↳ parameters
Google\Protobuf\Struct
The collection of extracted 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
↳ all_required_params_present
bool
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.
↳ cancels_slot_filling
bool
Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation .
↳ fulfillment_text
string
The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, fulfillment_messages
should be preferred.
↳ fulfillment_messages
array< Google\Cloud\Dialogflow\V2\Intent\Message
>
The collection of rich messages to present to the user.
↳ webhook_source
string
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.
↳ webhook_payload
Google\Protobuf\Struct
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.
↳ output_contexts
array< Google\Cloud\Dialogflow\V2\Context
>
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.
↳ intent
Google\Cloud\Dialogflow\V2\Intent
The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name
, display_name
, end_interaction
and is_fallback
.
↳ intent_detection_confidence
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. If there are multiple knowledge_answers
messages, this value is set to the greatest knowledgeAnswers.match_confidence
value in the list.
↳ diagnostic_info
Google\Protobuf\Struct
Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors
↳ sentiment_analysis_result
Google\Cloud\Dialogflow\V2\SentimentAnalysisResult
The sentiment analysis result, which depends on the sentiment_analysis_request_config
specified in the request.
getQueryText
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 automatic spell correction is enabled,
query_text
will contain the corrected user input.
string
setQueryText
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 automatic spell correction is enabled,
query_text
will contain the corrected user input.
var
string
$this
getLanguageCode
The language that was triggered during intent detection.
See Language Support for a list of the currently supported language codes.
string
setLanguageCode
The language that was triggered during intent detection.
See Language Support for a list of the currently supported language codes.
var
string
$this
getSpeechRecognitionConfidence
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.
float
setSpeechRecognitionConfidence
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.
var
float
$this
getAction
The action name from the matched intent.
string
setAction
The action name from the matched intent.
var
string
$this
getParameters
The collection of extracted 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
hasParameters
clearParameters
setParameters
The collection of extracted 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
$this
getAllRequiredParamsPresent
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.
bool
setAllRequiredParamsPresent
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.
var
bool
$this
getCancelsSlotFilling
Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation .
bool
setCancelsSlotFilling
Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation .
var
bool
$this
getFulfillmentText
The text to be pronounced to the user or shown on the screen.
Note: This is a legacy field, fulfillment_messages
should be preferred.
string
setFulfillmentText
The text to be pronounced to the user or shown on the screen.
Note: This is a legacy field, fulfillment_messages
should be preferred.
var
string
$this
getFulfillmentMessages
The collection of rich messages to present to the user.
setFulfillmentMessages
The collection of rich messages to present to the user.
$this
getWebhookSource
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.
string
setWebhookSource
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.
var
string
$this
getWebhookPayload
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.
hasWebhookPayload
clearWebhookPayload
setWebhookPayload
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.
$this
getOutputContexts
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.
setOutputContexts
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.
$this
getIntent
The intent that matched the conversational query. Some, not
all fields are filled in this message, including but not limited to: name
, display_name
, end_interaction
and is_fallback
.
hasIntent
clearIntent
setIntent
The intent that matched the conversational query. Some, not
all fields are filled in this message, including but not limited to: name
, display_name
, end_interaction
and is_fallback
.
$this
getIntentDetectionConfidence
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.
If there are multiple knowledge_answers
messages, this value is set to
the greatest knowledgeAnswers.match_confidence
value in the list.
float
setIntentDetectionConfidence
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.
If there are multiple knowledge_answers
messages, this value is set to
the greatest knowledgeAnswers.match_confidence
value in the list.
var
float
$this
getDiagnosticInfo
Free-form diagnostic information for the associated detect intent request.
The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain:
- webhook call latency
- webhook errors
hasDiagnosticInfo
clearDiagnosticInfo
setDiagnosticInfo
Free-form diagnostic information for the associated detect intent request.
The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain:
- webhook call latency
- webhook errors
$this
getSentimentAnalysisResult
The sentiment analysis result, which depends on the sentiment_analysis_request_config
specified in the request.
hasSentimentAnalysisResult
clearSentimentAnalysisResult
setSentimentAnalysisResult
The sentiment analysis result, which depends on the sentiment_analysis_request_config
specified in the request.
$this