Google Cloud Dialogflow V2 Client - Class QueryResult (1.0.1)

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.

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

Generated from protobuf field string query_text = 1;

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

Generated from protobuf field string query_text = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLanguageCode

The language that was triggered during intent detection.

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

Generated from protobuf field string language_code = 15;

Returns
TypeDescription
string

setLanguageCode

The language that was triggered during intent detection.

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

Generated from protobuf field string language_code = 15;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field float speech_recognition_confidence = 2;

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

Generated from protobuf field float speech_recognition_confidence = 2;

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getAction

The action name from the matched intent.

Generated from protobuf field string action = 3;

Returns
TypeDescription
string

setAction

The action name from the matched intent.

Generated from protobuf field string action = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$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

Generated from protobuf field .google.protobuf.Struct parameters = 4;

Returns
TypeDescription
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: 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

Generated from protobuf field .google.protobuf.Struct parameters = 4;

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$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.

Generated from protobuf field bool all_required_params_present = 5;

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

Generated from protobuf field bool all_required_params_present = 5;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getCancelsSlotFilling

Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation.

Generated from protobuf field bool cancels_slot_filling = 21;

Returns
TypeDescription
bool

setCancelsSlotFilling

Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation.

Generated from protobuf field bool cancels_slot_filling = 21;

Parameter
NameDescription
var bool
Returns
TypeDescription
$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.

Generated from protobuf field string fulfillment_text = 6;

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

Generated from protobuf field string fulfillment_text = 6;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFulfillmentMessages

The collection of rich messages to present to the user.

Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFulfillmentMessages

The collection of rich messages to present to the user.

Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameter
NameDescription
var array<Google\Cloud\Dialogflow\V2\Intent\Message>
Returns
TypeDescription
$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.

Generated from protobuf field string webhook_source = 8;

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

Generated from protobuf field string webhook_source = 8;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field .google.protobuf.Struct webhook_payload = 9;

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

Generated from protobuf field .google.protobuf.Struct webhook_payload = 9;

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$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.

Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;

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

Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;

Parameter
NameDescription
var array<Google\Cloud\Dialogflow\V2\Context>
Returns
TypeDescription
$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.

Generated from protobuf field .google.cloud.dialogflow.v2.Intent intent = 11;

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

Generated from protobuf field .google.cloud.dialogflow.v2.Intent intent = 11;

Parameter
NameDescription
var Google\Cloud\Dialogflow\V2\Intent
Returns
TypeDescription
$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.

Generated from protobuf field float intent_detection_confidence = 12;

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

Generated from protobuf field float intent_detection_confidence = 12;

Parameter
NameDescription
var float
Returns
TypeDescription
$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

Generated from protobuf field .google.protobuf.Struct diagnostic_info = 14;

Returns
TypeDescription
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

Generated from protobuf field .google.protobuf.Struct diagnostic_info = 14;

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$this

getSentimentAnalysisResult

The sentiment analysis result, which depends on the sentiment_analysis_request_config specified in the request.

Generated from protobuf field .google.cloud.dialogflow.v2.SentimentAnalysisResult sentiment_analysis_result = 17;

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

Generated from protobuf field .google.cloud.dialogflow.v2.SentimentAnalysisResult sentiment_analysis_result = 17;

Parameter
NameDescription
var Google\Cloud\Dialogflow\V2\SentimentAnalysisResult
Returns
TypeDescription
$this