google.cloud.dialogflow.v2.StreamingDetectIntentRequest */ class StreamingDetectIntentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the session the query is sent to. * Format of the session name: * `projects//agent/sessions/`, or * `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume * default 'draft' environment. If `User ID` is not specified, we are using * "-". It's up to the API caller to choose an appropriate `Session ID` and * `User Id`. They can be a random number or some type of user and session * identifiers (preferably hashed). The length of the `Session ID` and * `User ID` must not exceed 36 characters. * For more information, see the [API interactions * guide](https://cloud.google.com/dialogflow/docs/api-overview). * Note: Always use agent versions for production traffic. * See [Versions and * environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). * * Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $session = ''; /** * The parameters of this query. * * Generated from protobuf field .google.cloud.dialogflow.v2.QueryParameters query_params = 2; */ private $query_params = null; /** * Required. The input specification. It can be set to: * 1. an audio config which instructs the speech recognizer how to process * the speech audio, * 2. a conversational query in the form of text, or * 3. an event that specifies which intent to trigger. * * Generated from protobuf field .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED]; */ private $query_input = null; /** * Please use * [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2.InputAudioConfig.single_utterance] * instead. If `false` (default), recognition does not cease until the client * closes the stream. If `true`, the recognizer will detect a single spoken * utterance in input audio. Recognition ceases when it detects the audio's * voice has stopped or paused. In this case, once a detected intent is * received, the client should close the stream and start a new request with a * new stream as needed. This setting is ignored when `query_input` is a piece * of text or an event. * * Generated from protobuf field bool single_utterance = 4 [deprecated = true]; * @deprecated */ protected $single_utterance = false; /** * Instructs the speech synthesizer how to generate the output * audio. If this field is not set and agent-level speech synthesizer is not * configured, no output audio is generated. * * Generated from protobuf field .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 5; */ private $output_audio_config = null; /** * Mask for * [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config] * indicating which settings in this request-level config should override * speech synthesizer settings defined at agent-level. * If unspecified or empty, * [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config] * replaces the agent-level config in its entirety. * * Generated from protobuf field .google.protobuf.FieldMask output_audio_config_mask = 7; */ private $output_audio_config_mask = null; /** * The input audio content to be recognized. Must be sent if * `query_input` was set to a streaming input audio config. The complete audio * over all streaming messages must not exceed 1 minute. * * Generated from protobuf field bytes input_audio = 6; */ private $input_audio = ''; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $session * Required. The name of the session the query is sent to. * Format of the session name: * `projects//agent/sessions/`, or * `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume * default 'draft' environment. If `User ID` is not specified, we are using * "-". It's up to the API caller to choose an appropriate `Session ID` and * `User Id`. They can be a random number or some type of user and session * identifiers (preferably hashed). The length of the `Session ID` and * `User ID` must not exceed 36 characters. * For more information, see the [API interactions * guide](https://cloud.google.com/dialogflow/docs/api-overview). * Note: Always use agent versions for production traffic. * See [Versions and * environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). * @type \Google\Cloud\Dialogflow\V2\QueryParameters $query_params * The parameters of this query. * @type \Google\Cloud\Dialogflow\V2\QueryInput $query_input * Required. The input specification. It can be set to: * 1. an audio config which instructs the speech recognizer how to process * the speech audio, * 2. a conversational query in the form of text, or * 3. an event that specifies which intent to trigger. * @type bool $single_utterance * Please use * [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2.InputAudioConfig.single_utterance] * instead. If `false` (default), recognition does not cease until the client * closes the stream. If `true`, the recognizer will detect a single spoken * utterance in input audio. Recognition ceases when it detects the audio's * voice has stopped or paused. In this case, once a detected intent is * received, the client should close the stream and start a new request with a * new stream as needed. This setting is ignored when `query_input` is a piece * of text or an event. * @type \Google\Cloud\Dialogflow\V2\OutputAudioConfig $output_audio_config * Instructs the speech synthesizer how to generate the output * audio. If this field is not set and agent-level speech synthesizer is not * configured, no output audio is generated. * @type \Google\Protobuf\FieldMask $output_audio_config_mask * Mask for * [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config] * indicating which settings in this request-level config should override * speech synthesizer settings defined at agent-level. * If unspecified or empty, * [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config] * replaces the agent-level config in its entirety. * @type string $input_audio * The input audio content to be recognized. Must be sent if * `query_input` was set to a streaming input audio config. The complete audio * over all streaming messages must not exceed 1 minute. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Dialogflow\V2\Session::initOnce(); parent::__construct($data); } /** * Required. The name of the session the query is sent to. * Format of the session name: * `projects//agent/sessions/`, or * `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume * default 'draft' environment. If `User ID` is not specified, we are using * "-". It's up to the API caller to choose an appropriate `Session ID` and * `User Id`. They can be a random number or some type of user and session * identifiers (preferably hashed). The length of the `Session ID` and * `User ID` must not exceed 36 characters. * For more information, see the [API interactions * guide](https://cloud.google.com/dialogflow/docs/api-overview). * Note: Always use agent versions for production traffic. * See [Versions and * environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). * * Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getSession() { return $this->session; } /** * Required. The name of the session the query is sent to. * Format of the session name: * `projects//agent/sessions/`, or * `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume * default 'draft' environment. If `User ID` is not specified, we are using * "-". It's up to the API caller to choose an appropriate `Session ID` and * `User Id`. They can be a random number or some type of user and session * identifiers (preferably hashed). The length of the `Session ID` and * `User ID` must not exceed 36 characters. * For more information, see the [API interactions * guide](https://cloud.google.com/dialogflow/docs/api-overview). * Note: Always use agent versions for production traffic. * See [Versions and * environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). * * Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ public function setSession($var) { GPBUtil::checkString($var, True); $this->session = $var; return $this; } /** * The parameters of this query. * * Generated from protobuf field .google.cloud.dialogflow.v2.QueryParameters query_params = 2; * @return \Google\Cloud\Dialogflow\V2\QueryParameters|null */ public function getQueryParams() { return $this->query_params; } public function hasQueryParams() { return isset($this->query_params); } public function clearQueryParams() { unset($this->query_params); } /** * The parameters of this query. * * Generated from protobuf field .google.cloud.dialogflow.v2.QueryParameters query_params = 2; * @param \Google\Cloud\Dialogflow\V2\QueryParameters $var * @return $this */ public function setQueryParams($var) { GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\QueryParameters::class); $this->query_params = $var; return $this; } /** * Required. The input specification. It can be set to: * 1. an audio config which instructs the speech recognizer how to process * the speech audio, * 2. a conversational query in the form of text, or * 3. an event that specifies which intent to trigger. * * Generated from protobuf field .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Dialogflow\V2\QueryInput|null */ public function getQueryInput() { return $this->query_input; } public function hasQueryInput() { return isset($this->query_input); } public function clearQueryInput() { unset($this->query_input); } /** * Required. The input specification. It can be set to: * 1. an audio config which instructs the speech recognizer how to process * the speech audio, * 2. a conversational query in the form of text, or * 3. an event that specifies which intent to trigger. * * Generated from protobuf field .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Dialogflow\V2\QueryInput $var * @return $this */ public function setQueryInput($var) { GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\QueryInput::class); $this->query_input = $var; return $this; } /** * Please use * [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2.InputAudioConfig.single_utterance] * instead. If `false` (default), recognition does not cease until the client * closes the stream. If `true`, the recognizer will detect a single spoken * utterance in input audio. Recognition ceases when it detects the audio's * voice has stopped or paused. In this case, once a detected intent is * received, the client should close the stream and start a new request with a * new stream as needed. This setting is ignored when `query_input` is a piece * of text or an event. * * Generated from protobuf field bool single_utterance = 4 [deprecated = true]; * @return bool * @deprecated */ public function getSingleUtterance() { @trigger_error('single_utterance is deprecated.', E_USER_DEPRECATED); return $this->single_utterance; } /** * Please use * [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2.InputAudioConfig.single_utterance] * instead. If `false` (default), recognition does not cease until the client * closes the stream. If `true`, the recognizer will detect a single spoken * utterance in input audio. Recognition ceases when it detects the audio's * voice has stopped or paused. In this case, once a detected intent is * received, the client should close the stream and start a new request with a * new stream as needed. This setting is ignored when `query_input` is a piece * of text or an event. * * Generated from protobuf field bool single_utterance = 4 [deprecated = true]; * @param bool $var * @return $this * @deprecated */ public function setSingleUtterance($var) { @trigger_error('single_utterance is deprecated.', E_USER_DEPRECATED); GPBUtil::checkBool($var); $this->single_utterance = $var; return $this; } /** * Instructs the speech synthesizer how to generate the output * audio. If this field is not set and agent-level speech synthesizer is not * configured, no output audio is generated. * * Generated from protobuf field .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 5; * @return \Google\Cloud\Dialogflow\V2\OutputAudioConfig|null */ public function getOutputAudioConfig() { return $this->output_audio_config; } public function hasOutputAudioConfig() { return isset($this->output_audio_config); } public function clearOutputAudioConfig() { unset($this->output_audio_config); } /** * Instructs the speech synthesizer how to generate the output * audio. If this field is not set and agent-level speech synthesizer is not * configured, no output audio is generated. * * Generated from protobuf field .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 5; * @param \Google\Cloud\Dialogflow\V2\OutputAudioConfig $var * @return $this */ public function setOutputAudioConfig($var) { GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\OutputAudioConfig::class); $this->output_audio_config = $var; return $this; } /** * Mask for * [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config] * indicating which settings in this request-level config should override * speech synthesizer settings defined at agent-level. * If unspecified or empty, * [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config] * replaces the agent-level config in its entirety. * * Generated from protobuf field .google.protobuf.FieldMask output_audio_config_mask = 7; * @return \Google\Protobuf\FieldMask|null */ public function getOutputAudioConfigMask() { return $this->output_audio_config_mask; } public function hasOutputAudioConfigMask() { return isset($this->output_audio_config_mask); } public function clearOutputAudioConfigMask() { unset($this->output_audio_config_mask); } /** * Mask for * [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config] * indicating which settings in this request-level config should override * speech synthesizer settings defined at agent-level. * If unspecified or empty, * [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config] * replaces the agent-level config in its entirety. * * Generated from protobuf field .google.protobuf.FieldMask output_audio_config_mask = 7; * @param \Google\Protobuf\FieldMask $var * @return $this */ public function setOutputAudioConfigMask($var) { GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); $this->output_audio_config_mask = $var; return $this; } /** * The input audio content to be recognized. Must be sent if * `query_input` was set to a streaming input audio config. The complete audio * over all streaming messages must not exceed 1 minute. * * Generated from protobuf field bytes input_audio = 6; * @return string */ public function getInputAudio() { return $this->input_audio; } /** * The input audio content to be recognized. Must be sent if * `query_input` was set to a streaming input audio config. The complete audio * over all streaming messages must not exceed 1 minute. * * Generated from protobuf field bytes input_audio = 6; * @param string $var * @return $this */ public function setInputAudio($var) { GPBUtil::checkString($var, False); $this->input_audio = $var; return $this; } }