google.cloud.dialogflow.v2.QueryResult
*/
class QueryResult extends \Google\Protobuf\Internal\Message
{
/**
* 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;
*/
protected $query_text = '';
/**
* The language that was triggered during intent detection.
* See [Language
* Support](https://cloud.google.com/dialogflow/docs/reference/language)
* for a list of the currently supported language codes.
*
* Generated from protobuf field string language_code = 15;
*/
protected $language_code = '';
/**
* 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;
*/
protected $speech_recognition_confidence = 0.0;
/**
* The action name from the matched intent.
*
* Generated from protobuf field string action = 3;
*/
protected $action = '';
/**
* 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.
*
* Generated from protobuf field .google.protobuf.Struct parameters = 4;
*/
protected $parameters = null;
/**
* 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;
*/
protected $all_required_params_present = false;
/**
* Indicates whether the conversational query triggers a cancellation for slot
* filling. For more information, see the [cancel slot filling
* documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).
*
* Generated from protobuf field bool cancels_slot_filling = 21;
*/
protected $cancels_slot_filling = false;
/**
* 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;
*/
protected $fulfillment_text = '';
/**
* The collection of rich messages to present to the user.
*
* Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
private $fulfillment_messages;
/**
* 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;
*/
protected $webhook_source = '';
/**
* 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;
*/
protected $webhook_payload = null;
/**
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `.original` containing the original parameter values
* before the query.
*
* Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
*/
private $output_contexts;
/**
* 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;
*/
protected $intent = null;
/**
* 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;
*/
protected $intent_detection_confidence = 0.0;
/**
* 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;
*/
protected $diagnostic_info = null;
/**
* 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;
*/
protected $sentiment_analysis_result = null;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $query_text
* 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.
* @type string $language_code
* The language that was triggered during intent detection.
* See [Language
* Support](https://cloud.google.com/dialogflow/docs/reference/language)
* for a list of the currently supported language codes.
* @type float $speech_recognition_confidence
* 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.
* @type string $action
* The action name from the matched intent.
* @type \Google\Protobuf\Struct $parameters
* 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.
* @type bool $all_required_params_present
* 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.
* @type bool $cancels_slot_filling
* Indicates whether the conversational query triggers a cancellation for slot
* filling. For more information, see the [cancel slot filling
* documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).
* @type string $fulfillment_text
* The text to be pronounced to the user or shown on the screen.
* Note: This is a legacy field, `fulfillment_messages` should be preferred.
* @type array<\Google\Cloud\Dialogflow\V2\Intent\Message>|\Google\Protobuf\Internal\RepeatedField $fulfillment_messages
* The collection of rich messages to present to the user.
* @type string $webhook_source
* 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.
* @type \Google\Protobuf\Struct $webhook_payload
* 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.
* @type array<\Google\Cloud\Dialogflow\V2\Context>|\Google\Protobuf\Internal\RepeatedField $output_contexts
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `.original` containing the original parameter values
* before the query.
* @type \Google\Cloud\Dialogflow\V2\Intent $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`.
* @type float $intent_detection_confidence
* 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.
* @type \Google\Protobuf\Struct $diagnostic_info
* 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
* @type \Google\Cloud\Dialogflow\V2\SentimentAnalysisResult $sentiment_analysis_result
* The sentiment analysis result, which depends on the
* `sentiment_analysis_request_config` specified in the request.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Dialogflow\V2\Session::initOnce();
parent::__construct($data);
}
/**
* 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;
* @return string
*/
public function getQueryText()
{
return $this->query_text;
}
/**
* 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;
* @param string $var
* @return $this
*/
public function setQueryText($var)
{
GPBUtil::checkString($var, True);
$this->query_text = $var;
return $this;
}
/**
* The language that was triggered during intent detection.
* See [Language
* Support](https://cloud.google.com/dialogflow/docs/reference/language)
* for a list of the currently supported language codes.
*
* Generated from protobuf field string language_code = 15;
* @return string
*/
public function getLanguageCode()
{
return $this->language_code;
}
/**
* The language that was triggered during intent detection.
* See [Language
* Support](https://cloud.google.com/dialogflow/docs/reference/language)
* for a list of the currently supported language codes.
*
* Generated from protobuf field string language_code = 15;
* @param string $var
* @return $this
*/
public function setLanguageCode($var)
{
GPBUtil::checkString($var, True);
$this->language_code = $var;
return $this;
}
/**
* 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;
* @return float
*/
public function getSpeechRecognitionConfidence()
{
return $this->speech_recognition_confidence;
}
/**
* 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;
* @param float $var
* @return $this
*/
public function setSpeechRecognitionConfidence($var)
{
GPBUtil::checkFloat($var);
$this->speech_recognition_confidence = $var;
return $this;
}
/**
* The action name from the matched intent.
*
* Generated from protobuf field string action = 3;
* @return string
*/
public function getAction()
{
return $this->action;
}
/**
* The action name from the matched intent.
*
* Generated from protobuf field string action = 3;
* @param string $var
* @return $this
*/
public function setAction($var)
{
GPBUtil::checkString($var, True);
$this->action = $var;
return $this;
}
/**
* 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.
*
* Generated from protobuf field .google.protobuf.Struct parameters = 4;
* @return \Google\Protobuf\Struct|null
*/
public function getParameters()
{
return $this->parameters;
}
public function hasParameters()
{
return isset($this->parameters);
}
public function clearParameters()
{
unset($this->parameters);
}
/**
* 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.
*
* Generated from protobuf field .google.protobuf.Struct parameters = 4;
* @param \Google\Protobuf\Struct $var
* @return $this
*/
public function setParameters($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class);
$this->parameters = $var;
return $this;
}
/**
* 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;
* @return bool
*/
public function getAllRequiredParamsPresent()
{
return $this->all_required_params_present;
}
/**
* 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;
* @param bool $var
* @return $this
*/
public function setAllRequiredParamsPresent($var)
{
GPBUtil::checkBool($var);
$this->all_required_params_present = $var;
return $this;
}
/**
* Indicates whether the conversational query triggers a cancellation for slot
* filling. For more information, see the [cancel slot filling
* documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).
*
* Generated from protobuf field bool cancels_slot_filling = 21;
* @return bool
*/
public function getCancelsSlotFilling()
{
return $this->cancels_slot_filling;
}
/**
* Indicates whether the conversational query triggers a cancellation for slot
* filling. For more information, see the [cancel slot filling
* documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).
*
* Generated from protobuf field bool cancels_slot_filling = 21;
* @param bool $var
* @return $this
*/
public function setCancelsSlotFilling($var)
{
GPBUtil::checkBool($var);
$this->cancels_slot_filling = $var;
return $this;
}
/**
* 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;
* @return string
*/
public function getFulfillmentText()
{
return $this->fulfillment_text;
}
/**
* 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;
* @param string $var
* @return $this
*/
public function setFulfillmentText($var)
{
GPBUtil::checkString($var, True);
$this->fulfillment_text = $var;
return $this;
}
/**
* The collection of rich messages to present to the user.
*
* Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getFulfillmentMessages()
{
return $this->fulfillment_messages;
}
/**
* The collection of rich messages to present to the user.
*
* Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
* @param array<\Google\Cloud\Dialogflow\V2\Intent\Message>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setFulfillmentMessages($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\V2\Intent\Message::class);
$this->fulfillment_messages = $arr;
return $this;
}
/**
* 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;
* @return string
*/
public function getWebhookSource()
{
return $this->webhook_source;
}
/**
* 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;
* @param string $var
* @return $this
*/
public function setWebhookSource($var)
{
GPBUtil::checkString($var, True);
$this->webhook_source = $var;
return $this;
}
/**
* 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;
* @return \Google\Protobuf\Struct|null
*/
public function getWebhookPayload()
{
return $this->webhook_payload;
}
public function hasWebhookPayload()
{
return isset($this->webhook_payload);
}
public function clearWebhookPayload()
{
unset($this->webhook_payload);
}
/**
* 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;
* @param \Google\Protobuf\Struct $var
* @return $this
*/
public function setWebhookPayload($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class);
$this->webhook_payload = $var;
return $this;
}
/**
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `.original` containing the original parameter values
* before the query.
*
* Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getOutputContexts()
{
return $this->output_contexts;
}
/**
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `.original` containing the original parameter values
* before the query.
*
* Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
* @param array<\Google\Cloud\Dialogflow\V2\Context>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setOutputContexts($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\V2\Context::class);
$this->output_contexts = $arr;
return $this;
}
/**
* 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;
* @return \Google\Cloud\Dialogflow\V2\Intent|null
*/
public function getIntent()
{
return $this->intent;
}
public function hasIntent()
{
return isset($this->intent);
}
public function clearIntent()
{
unset($this->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`.
*
* Generated from protobuf field .google.cloud.dialogflow.v2.Intent intent = 11;
* @param \Google\Cloud\Dialogflow\V2\Intent $var
* @return $this
*/
public function setIntent($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\Intent::class);
$this->intent = $var;
return $this;
}
/**
* 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;
* @return float
*/
public function getIntentDetectionConfidence()
{
return $this->intent_detection_confidence;
}
/**
* 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;
* @param float $var
* @return $this
*/
public function setIntentDetectionConfidence($var)
{
GPBUtil::checkFloat($var);
$this->intent_detection_confidence = $var;
return $this;
}
/**
* 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;
* @return \Google\Protobuf\Struct|null
*/
public function getDiagnosticInfo()
{
return $this->diagnostic_info;
}
public function hasDiagnosticInfo()
{
return isset($this->diagnostic_info);
}
public function clearDiagnosticInfo()
{
unset($this->diagnostic_info);
}
/**
* 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;
* @param \Google\Protobuf\Struct $var
* @return $this
*/
public function setDiagnosticInfo($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class);
$this->diagnostic_info = $var;
return $this;
}
/**
* 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;
* @return \Google\Cloud\Dialogflow\V2\SentimentAnalysisResult|null
*/
public function getSentimentAnalysisResult()
{
return $this->sentiment_analysis_result;
}
public function hasSentimentAnalysisResult()
{
return isset($this->sentiment_analysis_result);
}
public function clearSentimentAnalysisResult()
{
unset($this->sentiment_analysis_result);
}
/**
* 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;
* @param \Google\Cloud\Dialogflow\V2\SentimentAnalysisResult $var
* @return $this
*/
public function setSentimentAnalysisResult($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\SentimentAnalysisResult::class);
$this->sentiment_analysis_result = $var;
return $this;
}
}