.google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;
*/
private $encoding = 0;
/**
* Sample rate in Hertz of the audio data sent in all
* `RecognitionAudio` messages. Valid values are: 8000-48000.
* 16000 is optimal. For best results, set the sampling rate of the audio
* source to 16000 Hz. If that's not possible, use the native sample rate of
* the audio source (instead of re-sampling).
* This field is optional for FLAC and WAV audio files, but is
* required for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
*
* Generated from protobuf field int32 sample_rate_hertz = 2;
*/
private $sample_rate_hertz = 0;
/**
* The number of channels in the input audio data.
* ONLY set this for MULTI-CHANNEL recognition.
* Valid values for LINEAR16, OGG_OPUS and FLAC are `1`-`8`.
* Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`.
* If `0` or omitted, defaults to one channel (mono).
* Note: We only recognize the first channel by default.
* To perform independent recognition on each channel set
* `enable_separate_recognition_per_channel` to 'true'.
*
* Generated from protobuf field int32 audio_channel_count = 7;
*/
private $audio_channel_count = 0;
/**
* This needs to be set to `true` explicitly and `audio_channel_count` > 1
* to get each channel recognized separately. The recognition result will
* contain a `channel_tag` field to state which channel that result belongs
* to. If this is not true, we will only recognize the first channel. The
* request is billed cumulatively for all channels recognized:
* `audio_channel_count` multiplied by the length of the audio.
*
* Generated from protobuf field bool enable_separate_recognition_per_channel = 12;
*/
private $enable_separate_recognition_per_channel = false;
/**
* Required. The language of the supplied audio as a
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
* Example: "en-US".
* See [Language
* Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
* of the currently supported language codes.
*
* Generated from protobuf field string language_code = 3 [(.google.api.field_behavior) = REQUIRED];
*/
private $language_code = '';
/**
* A list of up to 3 additional
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
* listing possible alternative languages of the supplied audio.
* See [Language
* Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
* of the currently supported language codes. If alternative languages are
* listed, recognition result will contain recognition in the most likely
* language detected including the main language_code. The recognition result
* will include the language tag of the language detected in the audio. Note:
* This feature is only supported for Voice Command and Voice Search use cases
* and performance may vary for other use cases (e.g., phone call
* transcription).
*
* Generated from protobuf field repeated string alternative_language_codes = 18;
*/
private $alternative_language_codes;
/**
* Maximum number of recognition hypotheses to be returned.
* Specifically, the maximum number of `SpeechRecognitionAlternative` messages
* within each `SpeechRecognitionResult`.
* The server may return fewer than `max_alternatives`.
* Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of
* one. If omitted, will return a maximum of one.
*
* Generated from protobuf field int32 max_alternatives = 4;
*/
private $max_alternatives = 0;
/**
* If set to `true`, the server will attempt to filter out
* profanities, replacing all but the initial character in each filtered word
* with asterisks, e.g. "f***". If set to `false` or omitted, profanities
* won't be filtered out.
*
* Generated from protobuf field bool profanity_filter = 5;
*/
private $profanity_filter = false;
/**
* Speech adaptation configuration improves the accuracy of speech
* recognition. For more information, see the [speech
* adaptation](https://cloud.google.com/speech-to-text/docs/adaptation)
* documentation.
* When speech adaptation is set it supersedes the `speech_contexts` field.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;
*/
private $adaptation = null;
/**
* Use transcription normalization to automatically replace parts of the
* transcript with phrases of your choosing. For StreamingRecognize, this
* normalization only applies to stable partial transcripts (stability > 0.8)
* and final transcripts.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;
*/
private $transcript_normalization = null;
/**
* Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
* A means to provide context to assist the speech recognition. For more
* information, see
* [speech
* adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
*
* Generated from protobuf field repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;
*/
private $speech_contexts;
/**
* If `true`, the top result includes a list of words and
* the start and end time offsets (timestamps) for those words. If
* `false`, no word-level time offset information is returned. The default is
* `false`.
*
* Generated from protobuf field bool enable_word_time_offsets = 8;
*/
private $enable_word_time_offsets = false;
/**
* If `true`, the top result includes a list of words and the
* confidence for those words. If `false`, no word-level confidence
* information is returned. The default is `false`.
*
* Generated from protobuf field bool enable_word_confidence = 15;
*/
private $enable_word_confidence = false;
/**
* If 'true', adds punctuation to recognition result hypotheses.
* This feature is only available in select languages. Setting this for
* requests in other languages has no effect at all.
* The default 'false' value does not add punctuation to result hypotheses.
*
* Generated from protobuf field bool enable_automatic_punctuation = 11;
*/
private $enable_automatic_punctuation = false;
/**
* The spoken punctuation behavior for the call
* If not set, uses default behavior based on model of choice
* e.g. command_and_search will enable spoken punctuation by default
* If 'true', replaces spoken punctuation with the corresponding symbols in
* the request. For example, "how are you question mark" becomes "how are
* you?". See https://cloud.google.com/speech-to-text/docs/spoken-punctuation
* for support. If 'false', spoken punctuation is not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_punctuation = 22;
*/
private $enable_spoken_punctuation = null;
/**
* The spoken emoji behavior for the call
* If not set, uses default behavior based on model of choice
* If 'true', adds spoken emoji formatting for the request. This will replace
* spoken emojis with the corresponding Unicode symbols in the final
* transcript. If 'false', spoken emojis are not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_emojis = 23;
*/
private $enable_spoken_emojis = null;
/**
* If 'true', enables speaker detection for each recognized word in
* the top alternative of the recognition result using a speaker_tag provided
* in the WordInfo.
* Note: Use diarization_config instead.
*
* Generated from protobuf field bool enable_speaker_diarization = 16 [deprecated = true];
* @deprecated
*/
protected $enable_speaker_diarization = false;
/**
* If set, specifies the estimated number of speakers in the conversation.
* Defaults to '2'. Ignored unless enable_speaker_diarization is set to true.
* Note: Use diarization_config instead.
*
* Generated from protobuf field int32 diarization_speaker_count = 17 [deprecated = true];
* @deprecated
*/
protected $diarization_speaker_count = 0;
/**
* Config to enable speaker diarization and set additional
* parameters to make diarization better suited for your application.
* Note: When this is enabled, we send all the words from the beginning of the
* audio for the top alternative in every consecutive STREAMING responses.
* This is done in order to improve our speaker tags as our models learn to
* identify the speakers in the conversation over time.
* For non-streaming requests, the diarization results will be provided only
* in the top alternative of the FINAL SpeechRecognitionResult.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;
*/
private $diarization_config = null;
/**
* Metadata regarding this request.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;
*/
private $metadata = null;
/**
* Which model to select for the given request. Select the model
* best suited to your domain to get best results. If a model is not
* explicitly specified, then we auto-select a model based on the parameters
* in the RecognitionConfig.
* | Model | *Description | *
latest_long |
* Best for long form content like media or conversation. | *
latest_short |
* Best for short form content like commands or single shot directed * speech. | *
command_and_search |
* Best for short queries such as voice commands or voice search. | *
phone_call |
* Best for audio that originated from a phone call (typically * recorded at an 8khz sampling rate). | *
video |
* Best for audio that originated from video or includes multiple * speakers. Ideally the audio is recorded at a 16khz or greater * sampling rate. This is a premium model that costs more than the * standard rate. | *
default |
* Best for audio that is not one of the specific audio models. * For example, long-form audio. Ideally the audio is high-fidelity, * recorded at a 16khz or greater sampling rate. | *
medical_conversation |
* Best for audio that originated from a conversation between a * medical provider and patient. | *
medical_dictation |
* Best for audio that originated from dictation notes by a medical * provider. | *
string model = 13;
*/
private $model = '';
/**
* Set to true to use an enhanced model for speech recognition.
* If `use_enhanced` is set to true and the `model` field is not set, then
* an appropriate enhanced model is chosen if an enhanced model exists for
* the audio.
* If `use_enhanced` is true and an enhanced version of the specified model
* does not exist, then the speech is recognized using the standard version
* of the specified model.
*
* Generated from protobuf field bool use_enhanced = 14;
*/
private $use_enhanced = false;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type int $encoding
* Encoding of audio data sent in all `RecognitionAudio` messages.
* This field is optional for `FLAC` and `WAV` audio files and required
* for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
* @type int $sample_rate_hertz
* Sample rate in Hertz of the audio data sent in all
* `RecognitionAudio` messages. Valid values are: 8000-48000.
* 16000 is optimal. For best results, set the sampling rate of the audio
* source to 16000 Hz. If that's not possible, use the native sample rate of
* the audio source (instead of re-sampling).
* This field is optional for FLAC and WAV audio files, but is
* required for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
* @type int $audio_channel_count
* The number of channels in the input audio data.
* ONLY set this for MULTI-CHANNEL recognition.
* Valid values for LINEAR16, OGG_OPUS and FLAC are `1`-`8`.
* Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`.
* If `0` or omitted, defaults to one channel (mono).
* Note: We only recognize the first channel by default.
* To perform independent recognition on each channel set
* `enable_separate_recognition_per_channel` to 'true'.
* @type bool $enable_separate_recognition_per_channel
* This needs to be set to `true` explicitly and `audio_channel_count` > 1
* to get each channel recognized separately. The recognition result will
* contain a `channel_tag` field to state which channel that result belongs
* to. If this is not true, we will only recognize the first channel. The
* request is billed cumulatively for all channels recognized:
* `audio_channel_count` multiplied by the length of the audio.
* @type string $language_code
* Required. The language of the supplied audio as a
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
* Example: "en-US".
* See [Language
* Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
* of the currently supported language codes.
* @type array| Model | *Description | *
latest_long |
* Best for long form content like media or conversation. | *
latest_short |
* Best for short form content like commands or single shot directed * speech. | *
command_and_search |
* Best for short queries such as voice commands or voice search. | *
phone_call |
* Best for audio that originated from a phone call (typically * recorded at an 8khz sampling rate). | *
video |
* Best for audio that originated from video or includes multiple * speakers. Ideally the audio is recorded at a 16khz or greater * sampling rate. This is a premium model that costs more than the * standard rate. | *
default |
* Best for audio that is not one of the specific audio models. * For example, long-form audio. Ideally the audio is high-fidelity, * recorded at a 16khz or greater sampling rate. | *
medical_conversation |
* Best for audio that originated from a conversation between a * medical provider and patient. | *
medical_dictation |
* Best for audio that originated from dictation notes by a medical * provider. | *
.google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;
* @return int
*/
public function getEncoding()
{
return $this->encoding;
}
/**
* Encoding of audio data sent in all `RecognitionAudio` messages.
* This field is optional for `FLAC` and `WAV` audio files and required
* for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;
* @param int $var
* @return $this
*/
public function setEncoding($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Speech\V1p1beta1\RecognitionConfig\AudioEncoding::class);
$this->encoding = $var;
return $this;
}
/**
* Sample rate in Hertz of the audio data sent in all
* `RecognitionAudio` messages. Valid values are: 8000-48000.
* 16000 is optimal. For best results, set the sampling rate of the audio
* source to 16000 Hz. If that's not possible, use the native sample rate of
* the audio source (instead of re-sampling).
* This field is optional for FLAC and WAV audio files, but is
* required for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
*
* Generated from protobuf field int32 sample_rate_hertz = 2;
* @return int
*/
public function getSampleRateHertz()
{
return $this->sample_rate_hertz;
}
/**
* Sample rate in Hertz of the audio data sent in all
* `RecognitionAudio` messages. Valid values are: 8000-48000.
* 16000 is optimal. For best results, set the sampling rate of the audio
* source to 16000 Hz. If that's not possible, use the native sample rate of
* the audio source (instead of re-sampling).
* This field is optional for FLAC and WAV audio files, but is
* required for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
*
* Generated from protobuf field int32 sample_rate_hertz = 2;
* @param int $var
* @return $this
*/
public function setSampleRateHertz($var)
{
GPBUtil::checkInt32($var);
$this->sample_rate_hertz = $var;
return $this;
}
/**
* The number of channels in the input audio data.
* ONLY set this for MULTI-CHANNEL recognition.
* Valid values for LINEAR16, OGG_OPUS and FLAC are `1`-`8`.
* Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`.
* If `0` or omitted, defaults to one channel (mono).
* Note: We only recognize the first channel by default.
* To perform independent recognition on each channel set
* `enable_separate_recognition_per_channel` to 'true'.
*
* Generated from protobuf field int32 audio_channel_count = 7;
* @return int
*/
public function getAudioChannelCount()
{
return $this->audio_channel_count;
}
/**
* The number of channels in the input audio data.
* ONLY set this for MULTI-CHANNEL recognition.
* Valid values for LINEAR16, OGG_OPUS and FLAC are `1`-`8`.
* Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`.
* If `0` or omitted, defaults to one channel (mono).
* Note: We only recognize the first channel by default.
* To perform independent recognition on each channel set
* `enable_separate_recognition_per_channel` to 'true'.
*
* Generated from protobuf field int32 audio_channel_count = 7;
* @param int $var
* @return $this
*/
public function setAudioChannelCount($var)
{
GPBUtil::checkInt32($var);
$this->audio_channel_count = $var;
return $this;
}
/**
* This needs to be set to `true` explicitly and `audio_channel_count` > 1
* to get each channel recognized separately. The recognition result will
* contain a `channel_tag` field to state which channel that result belongs
* to. If this is not true, we will only recognize the first channel. The
* request is billed cumulatively for all channels recognized:
* `audio_channel_count` multiplied by the length of the audio.
*
* Generated from protobuf field bool enable_separate_recognition_per_channel = 12;
* @return bool
*/
public function getEnableSeparateRecognitionPerChannel()
{
return $this->enable_separate_recognition_per_channel;
}
/**
* This needs to be set to `true` explicitly and `audio_channel_count` > 1
* to get each channel recognized separately. The recognition result will
* contain a `channel_tag` field to state which channel that result belongs
* to. If this is not true, we will only recognize the first channel. The
* request is billed cumulatively for all channels recognized:
* `audio_channel_count` multiplied by the length of the audio.
*
* Generated from protobuf field bool enable_separate_recognition_per_channel = 12;
* @param bool $var
* @return $this
*/
public function setEnableSeparateRecognitionPerChannel($var)
{
GPBUtil::checkBool($var);
$this->enable_separate_recognition_per_channel = $var;
return $this;
}
/**
* Required. The language of the supplied audio as a
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
* Example: "en-US".
* See [Language
* Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
* of the currently supported language codes.
*
* Generated from protobuf field string language_code = 3 [(.google.api.field_behavior) = REQUIRED];
* @return string
*/
public function getLanguageCode()
{
return $this->language_code;
}
/**
* Required. The language of the supplied audio as a
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
* Example: "en-US".
* See [Language
* Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
* of the currently supported language codes.
*
* Generated from protobuf field string language_code = 3 [(.google.api.field_behavior) = REQUIRED];
* @param string $var
* @return $this
*/
public function setLanguageCode($var)
{
GPBUtil::checkString($var, True);
$this->language_code = $var;
return $this;
}
/**
* A list of up to 3 additional
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
* listing possible alternative languages of the supplied audio.
* See [Language
* Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
* of the currently supported language codes. If alternative languages are
* listed, recognition result will contain recognition in the most likely
* language detected including the main language_code. The recognition result
* will include the language tag of the language detected in the audio. Note:
* This feature is only supported for Voice Command and Voice Search use cases
* and performance may vary for other use cases (e.g., phone call
* transcription).
*
* Generated from protobuf field repeated string alternative_language_codes = 18;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getAlternativeLanguageCodes()
{
return $this->alternative_language_codes;
}
/**
* A list of up to 3 additional
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
* listing possible alternative languages of the supplied audio.
* See [Language
* Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
* of the currently supported language codes. If alternative languages are
* listed, recognition result will contain recognition in the most likely
* language detected including the main language_code. The recognition result
* will include the language tag of the language detected in the audio. Note:
* This feature is only supported for Voice Command and Voice Search use cases
* and performance may vary for other use cases (e.g., phone call
* transcription).
*
* Generated from protobuf field repeated string alternative_language_codes = 18;
* @param arrayint32 max_alternatives = 4;
* @return int
*/
public function getMaxAlternatives()
{
return $this->max_alternatives;
}
/**
* Maximum number of recognition hypotheses to be returned.
* Specifically, the maximum number of `SpeechRecognitionAlternative` messages
* within each `SpeechRecognitionResult`.
* The server may return fewer than `max_alternatives`.
* Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of
* one. If omitted, will return a maximum of one.
*
* Generated from protobuf field int32 max_alternatives = 4;
* @param int $var
* @return $this
*/
public function setMaxAlternatives($var)
{
GPBUtil::checkInt32($var);
$this->max_alternatives = $var;
return $this;
}
/**
* If set to `true`, the server will attempt to filter out
* profanities, replacing all but the initial character in each filtered word
* with asterisks, e.g. "f***". If set to `false` or omitted, profanities
* won't be filtered out.
*
* Generated from protobuf field bool profanity_filter = 5;
* @return bool
*/
public function getProfanityFilter()
{
return $this->profanity_filter;
}
/**
* If set to `true`, the server will attempt to filter out
* profanities, replacing all but the initial character in each filtered word
* with asterisks, e.g. "f***". If set to `false` or omitted, profanities
* won't be filtered out.
*
* Generated from protobuf field bool profanity_filter = 5;
* @param bool $var
* @return $this
*/
public function setProfanityFilter($var)
{
GPBUtil::checkBool($var);
$this->profanity_filter = $var;
return $this;
}
/**
* Speech adaptation configuration improves the accuracy of speech
* recognition. For more information, see the [speech
* adaptation](https://cloud.google.com/speech-to-text/docs/adaptation)
* documentation.
* When speech adaptation is set it supersedes the `speech_contexts` field.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;
* @return \Google\Cloud\Speech\V1p1beta1\SpeechAdaptation|null
*/
public function getAdaptation()
{
return $this->adaptation;
}
public function hasAdaptation()
{
return isset($this->adaptation);
}
public function clearAdaptation()
{
unset($this->adaptation);
}
/**
* Speech adaptation configuration improves the accuracy of speech
* recognition. For more information, see the [speech
* adaptation](https://cloud.google.com/speech-to-text/docs/adaptation)
* documentation.
* When speech adaptation is set it supersedes the `speech_contexts` field.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;
* @param \Google\Cloud\Speech\V1p1beta1\SpeechAdaptation $var
* @return $this
*/
public function setAdaptation($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V1p1beta1\SpeechAdaptation::class);
$this->adaptation = $var;
return $this;
}
/**
* Use transcription normalization to automatically replace parts of the
* transcript with phrases of your choosing. For StreamingRecognize, this
* normalization only applies to stable partial transcripts (stability > 0.8)
* and final transcripts.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;
* @return \Google\Cloud\Speech\V1p1beta1\TranscriptNormalization|null
*/
public function getTranscriptNormalization()
{
return $this->transcript_normalization;
}
public function hasTranscriptNormalization()
{
return isset($this->transcript_normalization);
}
public function clearTranscriptNormalization()
{
unset($this->transcript_normalization);
}
/**
* Use transcription normalization to automatically replace parts of the
* transcript with phrases of your choosing. For StreamingRecognize, this
* normalization only applies to stable partial transcripts (stability > 0.8)
* and final transcripts.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;
* @param \Google\Cloud\Speech\V1p1beta1\TranscriptNormalization $var
* @return $this
*/
public function setTranscriptNormalization($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V1p1beta1\TranscriptNormalization::class);
$this->transcript_normalization = $var;
return $this;
}
/**
* Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
* A means to provide context to assist the speech recognition. For more
* information, see
* [speech
* adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
*
* Generated from protobuf field repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getSpeechContexts()
{
return $this->speech_contexts;
}
/**
* Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
* A means to provide context to assist the speech recognition. For more
* information, see
* [speech
* adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
*
* Generated from protobuf field repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;
* @param array<\Google\Cloud\Speech\V1p1beta1\SpeechContext>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setSpeechContexts($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Speech\V1p1beta1\SpeechContext::class);
$this->speech_contexts = $arr;
return $this;
}
/**
* If `true`, the top result includes a list of words and
* the start and end time offsets (timestamps) for those words. If
* `false`, no word-level time offset information is returned. The default is
* `false`.
*
* Generated from protobuf field bool enable_word_time_offsets = 8;
* @return bool
*/
public function getEnableWordTimeOffsets()
{
return $this->enable_word_time_offsets;
}
/**
* If `true`, the top result includes a list of words and
* the start and end time offsets (timestamps) for those words. If
* `false`, no word-level time offset information is returned. The default is
* `false`.
*
* Generated from protobuf field bool enable_word_time_offsets = 8;
* @param bool $var
* @return $this
*/
public function setEnableWordTimeOffsets($var)
{
GPBUtil::checkBool($var);
$this->enable_word_time_offsets = $var;
return $this;
}
/**
* If `true`, the top result includes a list of words and the
* confidence for those words. If `false`, no word-level confidence
* information is returned. The default is `false`.
*
* Generated from protobuf field bool enable_word_confidence = 15;
* @return bool
*/
public function getEnableWordConfidence()
{
return $this->enable_word_confidence;
}
/**
* If `true`, the top result includes a list of words and the
* confidence for those words. If `false`, no word-level confidence
* information is returned. The default is `false`.
*
* Generated from protobuf field bool enable_word_confidence = 15;
* @param bool $var
* @return $this
*/
public function setEnableWordConfidence($var)
{
GPBUtil::checkBool($var);
$this->enable_word_confidence = $var;
return $this;
}
/**
* If 'true', adds punctuation to recognition result hypotheses.
* This feature is only available in select languages. Setting this for
* requests in other languages has no effect at all.
* The default 'false' value does not add punctuation to result hypotheses.
*
* Generated from protobuf field bool enable_automatic_punctuation = 11;
* @return bool
*/
public function getEnableAutomaticPunctuation()
{
return $this->enable_automatic_punctuation;
}
/**
* If 'true', adds punctuation to recognition result hypotheses.
* This feature is only available in select languages. Setting this for
* requests in other languages has no effect at all.
* The default 'false' value does not add punctuation to result hypotheses.
*
* Generated from protobuf field bool enable_automatic_punctuation = 11;
* @param bool $var
* @return $this
*/
public function setEnableAutomaticPunctuation($var)
{
GPBUtil::checkBool($var);
$this->enable_automatic_punctuation = $var;
return $this;
}
/**
* The spoken punctuation behavior for the call
* If not set, uses default behavior based on model of choice
* e.g. command_and_search will enable spoken punctuation by default
* If 'true', replaces spoken punctuation with the corresponding symbols in
* the request. For example, "how are you question mark" becomes "how are
* you?". See https://cloud.google.com/speech-to-text/docs/spoken-punctuation
* for support. If 'false', spoken punctuation is not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_punctuation = 22;
* @return \Google\Protobuf\BoolValue|null
*/
public function getEnableSpokenPunctuation()
{
return $this->enable_spoken_punctuation;
}
public function hasEnableSpokenPunctuation()
{
return isset($this->enable_spoken_punctuation);
}
public function clearEnableSpokenPunctuation()
{
unset($this->enable_spoken_punctuation);
}
/**
* Returns the unboxed value from getEnableSpokenPunctuation()
* The spoken punctuation behavior for the call
* If not set, uses default behavior based on model of choice
* e.g. command_and_search will enable spoken punctuation by default
* If 'true', replaces spoken punctuation with the corresponding symbols in
* the request. For example, "how are you question mark" becomes "how are
* you?". See https://cloud.google.com/speech-to-text/docs/spoken-punctuation
* for support. If 'false', spoken punctuation is not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_punctuation = 22;
* @return bool|null
*/
public function getEnableSpokenPunctuationValue()
{
return $this->readWrapperValue("enable_spoken_punctuation");
}
/**
* The spoken punctuation behavior for the call
* If not set, uses default behavior based on model of choice
* e.g. command_and_search will enable spoken punctuation by default
* If 'true', replaces spoken punctuation with the corresponding symbols in
* the request. For example, "how are you question mark" becomes "how are
* you?". See https://cloud.google.com/speech-to-text/docs/spoken-punctuation
* for support. If 'false', spoken punctuation is not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_punctuation = 22;
* @param \Google\Protobuf\BoolValue $var
* @return $this
*/
public function setEnableSpokenPunctuation($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\BoolValue::class);
$this->enable_spoken_punctuation = $var;
return $this;
}
/**
* Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
* The spoken punctuation behavior for the call
* If not set, uses default behavior based on model of choice
* e.g. command_and_search will enable spoken punctuation by default
* If 'true', replaces spoken punctuation with the corresponding symbols in
* the request. For example, "how are you question mark" becomes "how are
* you?". See https://cloud.google.com/speech-to-text/docs/spoken-punctuation
* for support. If 'false', spoken punctuation is not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_punctuation = 22;
* @param bool|null $var
* @return $this
*/
public function setEnableSpokenPunctuationValue($var)
{
$this->writeWrapperValue("enable_spoken_punctuation", $var);
return $this;}
/**
* The spoken emoji behavior for the call
* If not set, uses default behavior based on model of choice
* If 'true', adds spoken emoji formatting for the request. This will replace
* spoken emojis with the corresponding Unicode symbols in the final
* transcript. If 'false', spoken emojis are not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_emojis = 23;
* @return \Google\Protobuf\BoolValue|null
*/
public function getEnableSpokenEmojis()
{
return $this->enable_spoken_emojis;
}
public function hasEnableSpokenEmojis()
{
return isset($this->enable_spoken_emojis);
}
public function clearEnableSpokenEmojis()
{
unset($this->enable_spoken_emojis);
}
/**
* Returns the unboxed value from getEnableSpokenEmojis()
* The spoken emoji behavior for the call
* If not set, uses default behavior based on model of choice
* If 'true', adds spoken emoji formatting for the request. This will replace
* spoken emojis with the corresponding Unicode symbols in the final
* transcript. If 'false', spoken emojis are not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_emojis = 23;
* @return bool|null
*/
public function getEnableSpokenEmojisValue()
{
return $this->readWrapperValue("enable_spoken_emojis");
}
/**
* The spoken emoji behavior for the call
* If not set, uses default behavior based on model of choice
* If 'true', adds spoken emoji formatting for the request. This will replace
* spoken emojis with the corresponding Unicode symbols in the final
* transcript. If 'false', spoken emojis are not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_emojis = 23;
* @param \Google\Protobuf\BoolValue $var
* @return $this
*/
public function setEnableSpokenEmojis($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\BoolValue::class);
$this->enable_spoken_emojis = $var;
return $this;
}
/**
* Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
* The spoken emoji behavior for the call
* If not set, uses default behavior based on model of choice
* If 'true', adds spoken emoji formatting for the request. This will replace
* spoken emojis with the corresponding Unicode symbols in the final
* transcript. If 'false', spoken emojis are not replaced.
*
* Generated from protobuf field .google.protobuf.BoolValue enable_spoken_emojis = 23;
* @param bool|null $var
* @return $this
*/
public function setEnableSpokenEmojisValue($var)
{
$this->writeWrapperValue("enable_spoken_emojis", $var);
return $this;}
/**
* If 'true', enables speaker detection for each recognized word in
* the top alternative of the recognition result using a speaker_tag provided
* in the WordInfo.
* Note: Use diarization_config instead.
*
* Generated from protobuf field bool enable_speaker_diarization = 16 [deprecated = true];
* @return bool
* @deprecated
*/
public function getEnableSpeakerDiarization()
{
@trigger_error('enable_speaker_diarization is deprecated.', E_USER_DEPRECATED);
return $this->enable_speaker_diarization;
}
/**
* If 'true', enables speaker detection for each recognized word in
* the top alternative of the recognition result using a speaker_tag provided
* in the WordInfo.
* Note: Use diarization_config instead.
*
* Generated from protobuf field bool enable_speaker_diarization = 16 [deprecated = true];
* @param bool $var
* @return $this
* @deprecated
*/
public function setEnableSpeakerDiarization($var)
{
@trigger_error('enable_speaker_diarization is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkBool($var);
$this->enable_speaker_diarization = $var;
return $this;
}
/**
* If set, specifies the estimated number of speakers in the conversation.
* Defaults to '2'. Ignored unless enable_speaker_diarization is set to true.
* Note: Use diarization_config instead.
*
* Generated from protobuf field int32 diarization_speaker_count = 17 [deprecated = true];
* @return int
* @deprecated
*/
public function getDiarizationSpeakerCount()
{
@trigger_error('diarization_speaker_count is deprecated.', E_USER_DEPRECATED);
return $this->diarization_speaker_count;
}
/**
* If set, specifies the estimated number of speakers in the conversation.
* Defaults to '2'. Ignored unless enable_speaker_diarization is set to true.
* Note: Use diarization_config instead.
*
* Generated from protobuf field int32 diarization_speaker_count = 17 [deprecated = true];
* @param int $var
* @return $this
* @deprecated
*/
public function setDiarizationSpeakerCount($var)
{
@trigger_error('diarization_speaker_count is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkInt32($var);
$this->diarization_speaker_count = $var;
return $this;
}
/**
* Config to enable speaker diarization and set additional
* parameters to make diarization better suited for your application.
* Note: When this is enabled, we send all the words from the beginning of the
* audio for the top alternative in every consecutive STREAMING responses.
* This is done in order to improve our speaker tags as our models learn to
* identify the speakers in the conversation over time.
* For non-streaming requests, the diarization results will be provided only
* in the top alternative of the FINAL SpeechRecognitionResult.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;
* @return \Google\Cloud\Speech\V1p1beta1\SpeakerDiarizationConfig|null
*/
public function getDiarizationConfig()
{
return $this->diarization_config;
}
public function hasDiarizationConfig()
{
return isset($this->diarization_config);
}
public function clearDiarizationConfig()
{
unset($this->diarization_config);
}
/**
* Config to enable speaker diarization and set additional
* parameters to make diarization better suited for your application.
* Note: When this is enabled, we send all the words from the beginning of the
* audio for the top alternative in every consecutive STREAMING responses.
* This is done in order to improve our speaker tags as our models learn to
* identify the speakers in the conversation over time.
* For non-streaming requests, the diarization results will be provided only
* in the top alternative of the FINAL SpeechRecognitionResult.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;
* @param \Google\Cloud\Speech\V1p1beta1\SpeakerDiarizationConfig $var
* @return $this
*/
public function setDiarizationConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V1p1beta1\SpeakerDiarizationConfig::class);
$this->diarization_config = $var;
return $this;
}
/**
* Metadata regarding this request.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;
* @return \Google\Cloud\Speech\V1p1beta1\RecognitionMetadata|null
*/
public function getMetadata()
{
return $this->metadata;
}
public function hasMetadata()
{
return isset($this->metadata);
}
public function clearMetadata()
{
unset($this->metadata);
}
/**
* Metadata regarding this request.
*
* Generated from protobuf field .google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;
* @param \Google\Cloud\Speech\V1p1beta1\RecognitionMetadata $var
* @return $this
*/
public function setMetadata($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V1p1beta1\RecognitionMetadata::class);
$this->metadata = $var;
return $this;
}
/**
* Which model to select for the given request. Select the model
* best suited to your domain to get best results. If a model is not
* explicitly specified, then we auto-select a model based on the parameters
* in the RecognitionConfig.
* | Model | *Description | *
latest_long |
* Best for long form content like media or conversation. | *
latest_short |
* Best for short form content like commands or single shot directed * speech. | *
command_and_search |
* Best for short queries such as voice commands or voice search. | *
phone_call |
* Best for audio that originated from a phone call (typically * recorded at an 8khz sampling rate). | *
video |
* Best for audio that originated from video or includes multiple * speakers. Ideally the audio is recorded at a 16khz or greater * sampling rate. This is a premium model that costs more than the * standard rate. | *
default |
* Best for audio that is not one of the specific audio models. * For example, long-form audio. Ideally the audio is high-fidelity, * recorded at a 16khz or greater sampling rate. | *
medical_conversation |
* Best for audio that originated from a conversation between a * medical provider and patient. | *
medical_dictation |
* Best for audio that originated from dictation notes by a medical * provider. | *
string model = 13;
* @return string
*/
public function getModel()
{
return $this->model;
}
/**
* Which model to select for the given request. Select the model
* best suited to your domain to get best results. If a model is not
* explicitly specified, then we auto-select a model based on the parameters
* in the RecognitionConfig.
* | Model | *Description | *
latest_long |
* Best for long form content like media or conversation. | *
latest_short |
* Best for short form content like commands or single shot directed * speech. | *
command_and_search |
* Best for short queries such as voice commands or voice search. | *
phone_call |
* Best for audio that originated from a phone call (typically * recorded at an 8khz sampling rate). | *
video |
* Best for audio that originated from video or includes multiple * speakers. Ideally the audio is recorded at a 16khz or greater * sampling rate. This is a premium model that costs more than the * standard rate. | *
default |
* Best for audio that is not one of the specific audio models. * For example, long-form audio. Ideally the audio is high-fidelity, * recorded at a 16khz or greater sampling rate. | *
medical_conversation |
* Best for audio that originated from a conversation between a * medical provider and patient. | *
medical_dictation |
* Best for audio that originated from dictation notes by a medical * provider. | *
string model = 13;
* @param string $var
* @return $this
*/
public function setModel($var)
{
GPBUtil::checkString($var, True);
$this->model = $var;
return $this;
}
/**
* Set to true to use an enhanced model for speech recognition.
* If `use_enhanced` is set to true and the `model` field is not set, then
* an appropriate enhanced model is chosen if an enhanced model exists for
* the audio.
* If `use_enhanced` is true and an enhanced version of the specified model
* does not exist, then the speech is recognized using the standard version
* of the specified model.
*
* Generated from protobuf field bool use_enhanced = 14;
* @return bool
*/
public function getUseEnhanced()
{
return $this->use_enhanced;
}
/**
* Set to true to use an enhanced model for speech recognition.
* If `use_enhanced` is set to true and the `model` field is not set, then
* an appropriate enhanced model is chosen if an enhanced model exists for
* the audio.
* If `use_enhanced` is true and an enhanced version of the specified model
* does not exist, then the speech is recognized using the standard version
* of the specified model.
*
* Generated from protobuf field bool use_enhanced = 14;
* @param bool $var
* @return $this
*/
public function setUseEnhanced($var)
{
GPBUtil::checkBool($var);
$this->use_enhanced = $var;
return $this;
}
}