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
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
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, |
↳ 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 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. |
↳ all_required_params_present |
bool
This field is set to: - |
↳ 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 |
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 |
↳ webhook_payload |
Google\Protobuf\Struct
If the query was fulfilled by a webhook call, this field is set to the value of the |
↳ output_contexts |
array<Google\Cloud\Dialogflow\V2\Context>
The collection of output contexts. If applicable, |
↳ 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: |
↳ 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 |
↳ 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 |
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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getLanguageCode
The language that was triggered during intent detection.
See Language Support for a list of the currently supported language codes.
Returns | |
---|---|
Type | Description |
string |
setLanguageCode
The language that was triggered during intent detection.
See Language Support for a list of the currently supported language codes.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
float
|
Returns | |
---|---|
Type | Description |
$this |
getAction
The action name from the matched intent.
Returns | |
---|---|
Type | Description |
string |
setAction
The action name from the matched intent.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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 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 | |
---|---|
Type | Description |
Google\Protobuf\Struct|null |
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 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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Struct
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getCancelsSlotFilling
Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation.
Returns | |
---|---|
Type | Description |
bool |
setCancelsSlotFilling
Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFulfillmentMessages
The collection of rich messages to present to the user.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setFulfillmentMessages
The collection of rich messages to present to the user.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Dialogflow\V2\Intent\Message>
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Struct|null |
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Struct
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
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.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Dialogflow\V2\Context>
|
Returns | |
---|---|
Type | Description |
$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
.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dialogflow\V2\Intent|null |
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
.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dialogflow\V2\Intent
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
float
|
Returns | |
---|---|
Type | Description |
$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
Returns | |
---|---|
Type | Description |
Google\Protobuf\Struct|null |
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
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Struct
|
Returns | |
---|---|
Type | Description |
$this |
getSentimentAnalysisResult
The sentiment analysis result, which depends on the
sentiment_analysis_request_config
specified in the request.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dialogflow\V2\SentimentAnalysisResult|null |
hasSentimentAnalysisResult
clearSentimentAnalysisResult
setSentimentAnalysisResult
The sentiment analysis result, which depends on the
sentiment_analysis_request_config
specified in the request.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dialogflow\V2\SentimentAnalysisResult
|
Returns | |
---|---|
Type | Description |
$this |