com.google.cloud.speech.v1p1beta1

Interface RecognitionConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RecognitionConfig, RecognitionConfig.Builder

public interface RecognitionConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAlternativeLanguageCodes(int index) *Optional* 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.
com.google.protobuf.ByteString	getAlternativeLanguageCodesBytes(int index) *Optional* 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.
int	getAlternativeLanguageCodesCount() *Optional* 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.
List<String>	getAlternativeLanguageCodesList() *Optional* 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.
int	getAudioChannelCount() *Optional* The number of channels in the input audio data.
int	getDiarizationSpeakerCount() *Optional* If set, specifies the estimated number of speakers in the conversation.
boolean	getEnableAutomaticPunctuation() *Optional* If 'true', adds punctuation to recognition result hypotheses.
boolean	getEnableSeparateRecognitionPerChannel() This needs to be set to ‘true’ explicitly and `audio_channel_count` > 1 to get each channel recognized separately.
boolean	getEnableSpeakerDiarization() *Optional* 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.
boolean	getEnableWordConfidence() *Optional* If `true`, the top result includes a list of words and the confidence for those words.
boolean	getEnableWordTimeOffsets() *Optional* If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words.
RecognitionConfig.AudioEncoding	getEncoding() Encoding of audio data sent in all `RecognitionAudio` messages.
int	getEncodingValue() Encoding of audio data sent in all `RecognitionAudio` messages.
String	getLanguageCode() *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
com.google.protobuf.ByteString	getLanguageCodeBytes() *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
int	getMaxAlternatives() *Optional* Maximum number of recognition hypotheses to be returned.
RecognitionMetadata	getMetadata() *Optional* Metadata regarding this request.
RecognitionMetadataOrBuilder	getMetadataOrBuilder() *Optional* Metadata regarding this request.
String	getModel() *Optional* Which model to select for the given request.
com.google.protobuf.ByteString	getModelBytes() *Optional* Which model to select for the given request.
boolean	getProfanityFilter() *Optional* 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.
int	getSampleRateHertz() Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages.
SpeechContext	getSpeechContexts(int index) *Optional* array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
int	getSpeechContextsCount() *Optional* array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
List<SpeechContext>	getSpeechContextsList() *Optional* array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
SpeechContextOrBuilder	getSpeechContextsOrBuilder(int index) *Optional* array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
List<? extends SpeechContextOrBuilder>	getSpeechContextsOrBuilderList() *Optional* array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
boolean	getUseEnhanced() *Optional* Set to true to use an enhanced model for speech recognition.
boolean	hasMetadata() *Optional* Metadata regarding this request.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getEncodingValue

int getEncodingValue()

 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].
 

.google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;

getEncoding

RecognitionConfig.AudioEncoding getEncoding()

 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].
 

.google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;

getSampleRateHertz

int getSampleRateHertz()

 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 and required
 for all other audio formats. For details, see
 [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
 

int32 sample_rate_hertz = 2;

getAudioChannelCount

int getAudioChannelCount()

 *Optional* The number of channels in the input audio data.
 ONLY set this for MULTI-CHANNEL recognition.
 Valid values for LINEAR16 and FLAC are `1`-`8`.
 Valid values for OGG_OPUS are '1'-'254'.
 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'.
 

int32 audio_channel_count = 7;

getEnableSeparateRecognitionPerChannel

boolean getEnableSeparateRecognitionPerChannel()

 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.
 

bool enable_separate_recognition_per_channel = 12;

getLanguageCode

String getLanguageCode()

 *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](/speech-to-text/docs/languages)
 for a list of the currently supported language codes.
 

string language_code = 3;

getLanguageCodeBytes

com.google.protobuf.ByteString getLanguageCodeBytes()

 *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](/speech-to-text/docs/languages)
 for a list of the currently supported language codes.
 

string language_code = 3;

getAlternativeLanguageCodesList

List<String> getAlternativeLanguageCodesList()

 *Optional* 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](/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).
 

repeated string alternative_language_codes = 18;

getAlternativeLanguageCodesCount

int getAlternativeLanguageCodesCount()

 *Optional* 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](/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).
 

repeated string alternative_language_codes = 18;

getAlternativeLanguageCodes

String getAlternativeLanguageCodes(int index)

 *Optional* 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](/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).
 

repeated string alternative_language_codes = 18;

getAlternativeLanguageCodesBytes

com.google.protobuf.ByteString getAlternativeLanguageCodesBytes(int index)

 *Optional* 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](/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).
 

repeated string alternative_language_codes = 18;

getMaxAlternatives

int getMaxAlternatives()

 *Optional* 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.
 

int32 max_alternatives = 4;

getProfanityFilter

boolean getProfanityFilter()

 *Optional* 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.
 

bool profanity_filter = 5;

getSpeechContextsList

List<SpeechContext> getSpeechContextsList()

 *Optional* array of
 [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. A means to
 provide context to assist the speech recognition. For more information, see
 [Phrase Hints](/speech-to-text/docs/basics#phrase-hints).
 

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

getSpeechContexts

SpeechContext getSpeechContexts(int index)

 *Optional* array of
 [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. A means to
 provide context to assist the speech recognition. For more information, see
 [Phrase Hints](/speech-to-text/docs/basics#phrase-hints).
 

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

getSpeechContextsCount

int getSpeechContextsCount()

 *Optional* array of
 [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. A means to
 provide context to assist the speech recognition. For more information, see
 [Phrase Hints](/speech-to-text/docs/basics#phrase-hints).
 

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

getSpeechContextsOrBuilderList

List<? extends SpeechContextOrBuilder> getSpeechContextsOrBuilderList()

 *Optional* array of
 [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. A means to
 provide context to assist the speech recognition. For more information, see
 [Phrase Hints](/speech-to-text/docs/basics#phrase-hints).
 

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

getSpeechContextsOrBuilder

SpeechContextOrBuilder getSpeechContextsOrBuilder(int index)

 *Optional* array of
 [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. A means to
 provide context to assist the speech recognition. For more information, see
 [Phrase Hints](/speech-to-text/docs/basics#phrase-hints).
 

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

getEnableWordTimeOffsets

boolean getEnableWordTimeOffsets()

 *Optional* 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`.
 

bool enable_word_time_offsets = 8;

getEnableWordConfidence

boolean getEnableWordConfidence()

 *Optional* 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`.
 

bool enable_word_confidence = 15;

getEnableAutomaticPunctuation

boolean getEnableAutomaticPunctuation()

 *Optional* 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.
 Note: This is currently offered as an experimental service, complimentary
 to all users. In the future this may be exclusively available as a
 premium feature.
 

bool enable_automatic_punctuation = 11;

getEnableSpeakerDiarization

boolean getEnableSpeakerDiarization()

 *Optional* 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: When this is true, 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.
 

bool enable_speaker_diarization = 16;

getDiarizationSpeakerCount

int getDiarizationSpeakerCount()

 *Optional*
 If set, specifies the estimated number of speakers in the conversation.
 If not set, defaults to '2'.
 Ignored unless enable_speaker_diarization is set to true."
 

int32 diarization_speaker_count = 17;

hasMetadata

boolean hasMetadata()

 *Optional* Metadata regarding this request.
 

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

getMetadata

RecognitionMetadata getMetadata()

 *Optional* Metadata regarding this request.
 

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

getMetadataOrBuilder

RecognitionMetadataOrBuilder getMetadataOrBuilder()

 *Optional* Metadata regarding this request.
 

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

getModel

String getModel()

 *Optional* 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.
 <table>
   <tr>
     <td><b>Model</b></td>
     <td><b>Description</b></td>
   </tr>
   <tr>
     <td><code>command_and_search</code></td>
     <td>Best for short queries such as voice commands or voice search.</td>
   </tr>
   <tr>
     <td><code>phone_call</code></td>
     <td>Best for audio that originated from a phone call (typically
     recorded at an 8khz sampling rate).</td>
   </tr>
   <tr>
     <td><code>video</code></td>
     <td>Best for audio that originated from 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.</td>
   </tr>
   <tr>
     <td><code>default</code></td>
     <td>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.</td>
   </tr>
 </table>
 

string model = 13;

getModelBytes

com.google.protobuf.ByteString getModelBytes()

 *Optional* 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.
 <table>
   <tr>
     <td><b>Model</b></td>
     <td><b>Description</b></td>
   </tr>
   <tr>
     <td><code>command_and_search</code></td>
     <td>Best for short queries such as voice commands or voice search.</td>
   </tr>
   <tr>
     <td><code>phone_call</code></td>
     <td>Best for audio that originated from a phone call (typically
     recorded at an 8khz sampling rate).</td>
   </tr>
   <tr>
     <td><code>video</code></td>
     <td>Best for audio that originated from 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.</td>
   </tr>
   <tr>
     <td><code>default</code></td>
     <td>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.</td>
   </tr>
 </table>
 

string model = 13;

getUseEnhanced

boolean getUseEnhanced()

 *Optional* 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:
 1. project is eligible for requesting enhanced models
 2. 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.
 Enhanced speech models require that you opt-in to data logging using
 instructions in the
 [documentation](/speech-to-text/docs/enable-data-logging). If you set
 `use_enhanced` to true and you have not enabled audio logging, then you
 will receive an error.
 

bool use_enhanced = 14;