Package com.google.cloud.speech.v1
Class RecognitionConfig
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.speech.v1.RecognitionConfig
-
- All Implemented Interfaces:
RecognitionConfigOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class RecognitionConfig extends com.google.protobuf.GeneratedMessageV3 implements RecognitionConfigOrBuilder
Provides information to the recognizer that specifies how to process the request.
Protobuf typegoogle.cloud.speech.v1.RecognitionConfig
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RecognitionConfig.AudioEncoding
The encoding of the audio data sent in the request.static class
RecognitionConfig.Builder
Provides information to the recognizer that specifies how to process the request.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
ADAPTATION_FIELD_NUMBER
static int
ALTERNATIVE_LANGUAGE_CODES_FIELD_NUMBER
static int
AUDIO_CHANNEL_COUNT_FIELD_NUMBER
static int
DIARIZATION_CONFIG_FIELD_NUMBER
static int
ENABLE_AUTOMATIC_PUNCTUATION_FIELD_NUMBER
static int
ENABLE_SEPARATE_RECOGNITION_PER_CHANNEL_FIELD_NUMBER
static int
ENABLE_SPOKEN_EMOJIS_FIELD_NUMBER
static int
ENABLE_SPOKEN_PUNCTUATION_FIELD_NUMBER
static int
ENABLE_WORD_CONFIDENCE_FIELD_NUMBER
static int
ENABLE_WORD_TIME_OFFSETS_FIELD_NUMBER
static int
ENCODING_FIELD_NUMBER
static int
LANGUAGE_CODE_FIELD_NUMBER
static int
MAX_ALTERNATIVES_FIELD_NUMBER
static int
METADATA_FIELD_NUMBER
static int
MODEL_FIELD_NUMBER
static int
PROFANITY_FILTER_FIELD_NUMBER
static int
SAMPLE_RATE_HERTZ_FIELD_NUMBER
static int
SPEECH_CONTEXTS_FIELD_NUMBER
static int
USE_ENHANCED_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
SpeechAdaptation
getAdaptation()
Speech adaptation configuration improves the accuracy of speech recognition.SpeechAdaptationOrBuilder
getAdaptationOrBuilder()
Speech adaptation configuration improves the accuracy of speech recognition.String
getAlternativeLanguageCodes(int index)
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)
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()
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.ProtocolStringList
getAlternativeLanguageCodesList()
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()
The number of channels in the input audio data.static RecognitionConfig
getDefaultInstance()
RecognitionConfig
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
SpeakerDiarizationConfig
getDiarizationConfig()
Config to enable speaker diarization and set additional parameters to make diarization better suited for your application.SpeakerDiarizationConfigOrBuilder
getDiarizationConfigOrBuilder()
Config to enable speaker diarization and set additional parameters to make diarization better suited for your application.boolean
getEnableAutomaticPunctuation()
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.com.google.protobuf.BoolValue
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.com.google.protobuf.BoolValueOrBuilder
getEnableSpokenEmojisOrBuilder()
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.com.google.protobuf.BoolValue
getEnableSpokenPunctuation()
The spoken punctuation behavior for the call If not set, uses default behavior based on model of choice e.g.com.google.protobuf.BoolValueOrBuilder
getEnableSpokenPunctuationOrBuilder()
The spoken punctuation behavior for the call If not set, uses default behavior based on model of choice e.g.boolean
getEnableWordConfidence()
If `true`, the top result includes a list of words and the confidence for those words.boolean
getEnableWordTimeOffsets()
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.com.google.protobuf.ByteString
getLanguageCodeBytes()
Required.int
getMaxAlternatives()
Maximum number of recognition hypotheses to be returned.RecognitionMetadata
getMetadata()
Metadata regarding this request.RecognitionMetadataOrBuilder
getMetadataOrBuilder()
Metadata regarding this request.String
getModel()
Which model to select for the given request.com.google.protobuf.ByteString
getModelBytes()
Which model to select for the given request.com.google.protobuf.Parser<RecognitionConfig>
getParserForType()
boolean
getProfanityFilter()
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.int
getSerializedSize()
SpeechContext
getSpeechContexts(int index)
Array of [SpeechContext][google.cloud.speech.v1.SpeechContext].int
getSpeechContextsCount()
Array of [SpeechContext][google.cloud.speech.v1.SpeechContext].List<SpeechContext>
getSpeechContextsList()
Array of [SpeechContext][google.cloud.speech.v1.SpeechContext].SpeechContextOrBuilder
getSpeechContextsOrBuilder(int index)
Array of [SpeechContext][google.cloud.speech.v1.SpeechContext].List<? extends SpeechContextOrBuilder>
getSpeechContextsOrBuilderList()
Array of [SpeechContext][google.cloud.speech.v1.SpeechContext].boolean
getUseEnhanced()
Set to true to use an enhanced model for speech recognition.boolean
hasAdaptation()
Speech adaptation configuration improves the accuracy of speech recognition.boolean
hasDiarizationConfig()
Config to enable speaker diarization and set additional parameters to make diarization better suited for your application.boolean
hasEnableSpokenEmojis()
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.boolean
hasEnableSpokenPunctuation()
The spoken punctuation behavior for the call If not set, uses default behavior based on model of choice e.g.int
hashCode()
boolean
hasMetadata()
Metadata regarding this request.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static RecognitionConfig.Builder
newBuilder()
static RecognitionConfig.Builder
newBuilder(RecognitionConfig prototype)
RecognitionConfig.Builder
newBuilderForType()
protected RecognitionConfig.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RecognitionConfig
parseDelimitedFrom(InputStream input)
static RecognitionConfig
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionConfig
parseFrom(byte[] data)
static RecognitionConfig
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionConfig
parseFrom(com.google.protobuf.ByteString data)
static RecognitionConfig
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionConfig
parseFrom(com.google.protobuf.CodedInputStream input)
static RecognitionConfig
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionConfig
parseFrom(InputStream input)
static RecognitionConfig
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionConfig
parseFrom(ByteBuffer data)
static RecognitionConfig
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RecognitionConfig>
parser()
RecognitionConfig.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
ENCODING_FIELD_NUMBER
public static final int ENCODING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SAMPLE_RATE_HERTZ_FIELD_NUMBER
public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AUDIO_CHANNEL_COUNT_FIELD_NUMBER
public static final int AUDIO_CHANNEL_COUNT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_SEPARATE_RECOGNITION_PER_CHANNEL_FIELD_NUMBER
public static final int ENABLE_SEPARATE_RECOGNITION_PER_CHANNEL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ALTERNATIVE_LANGUAGE_CODES_FIELD_NUMBER
public static final int ALTERNATIVE_LANGUAGE_CODES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MAX_ALTERNATIVES_FIELD_NUMBER
public static final int MAX_ALTERNATIVES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PROFANITY_FILTER_FIELD_NUMBER
public static final int PROFANITY_FILTER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ADAPTATION_FIELD_NUMBER
public static final int ADAPTATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SPEECH_CONTEXTS_FIELD_NUMBER
public static final int SPEECH_CONTEXTS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_WORD_TIME_OFFSETS_FIELD_NUMBER
public static final int ENABLE_WORD_TIME_OFFSETS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_WORD_CONFIDENCE_FIELD_NUMBER
public static final int ENABLE_WORD_CONFIDENCE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_AUTOMATIC_PUNCTUATION_FIELD_NUMBER
public static final int ENABLE_AUTOMATIC_PUNCTUATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_SPOKEN_PUNCTUATION_FIELD_NUMBER
public static final int ENABLE_SPOKEN_PUNCTUATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_SPOKEN_EMOJIS_FIELD_NUMBER
public static final int ENABLE_SPOKEN_EMOJIS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DIARIZATION_CONFIG_FIELD_NUMBER
public static final int DIARIZATION_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
USE_ENHANCED_FIELD_NUMBER
public static final int USE_ENHANCED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getEncodingValue
public 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.v1.RecognitionConfig.AudioEncoding].
.google.cloud.speech.v1.RecognitionConfig.AudioEncoding encoding = 1;
- Specified by:
getEncodingValue
in interfaceRecognitionConfigOrBuilder
- Returns:
- The enum numeric value on the wire for encoding.
-
getEncoding
public 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.v1.RecognitionConfig.AudioEncoding].
.google.cloud.speech.v1.RecognitionConfig.AudioEncoding encoding = 1;
- Specified by:
getEncoding
in interfaceRecognitionConfigOrBuilder
- Returns:
- The encoding.
-
getSampleRateHertz
public 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, but is required for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding].
int32 sample_rate_hertz = 2;
- Specified by:
getSampleRateHertz
in interfaceRecognitionConfigOrBuilder
- Returns:
- The sampleRateHertz.
-
getAudioChannelCount
public int getAudioChannelCount()
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'.
int32 audio_channel_count = 7;
- Specified by:
getAudioChannelCount
in interfaceRecognitionConfigOrBuilder
- Returns:
- The audioChannelCount.
-
getEnableSeparateRecognitionPerChannel
public 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;
- Specified by:
getEnableSeparateRecognitionPerChannel
in interfaceRecognitionConfigOrBuilder
- Returns:
- The enableSeparateRecognitionPerChannel.
-
getLanguageCode
public 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](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.
string language_code = 3 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getLanguageCode
in interfaceRecognitionConfigOrBuilder
- Returns:
- The languageCode.
-
getLanguageCodeBytes
public 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](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.
string language_code = 3 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getLanguageCodeBytes
in interfaceRecognitionConfigOrBuilder
- Returns:
- The bytes for languageCode.
-
getAlternativeLanguageCodesList
public com.google.protobuf.ProtocolStringList getAlternativeLanguageCodesList()
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).
repeated string alternative_language_codes = 18;
- Specified by:
getAlternativeLanguageCodesList
in interfaceRecognitionConfigOrBuilder
- Returns:
- A list containing the alternativeLanguageCodes.
-
getAlternativeLanguageCodesCount
public int getAlternativeLanguageCodesCount()
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).
repeated string alternative_language_codes = 18;
- Specified by:
getAlternativeLanguageCodesCount
in interfaceRecognitionConfigOrBuilder
- Returns:
- The count of alternativeLanguageCodes.
-
getAlternativeLanguageCodes
public String getAlternativeLanguageCodes(int index)
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).
repeated string alternative_language_codes = 18;
- Specified by:
getAlternativeLanguageCodes
in interfaceRecognitionConfigOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The alternativeLanguageCodes at the given index.
-
getAlternativeLanguageCodesBytes
public com.google.protobuf.ByteString getAlternativeLanguageCodesBytes(int index)
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).
repeated string alternative_language_codes = 18;
- Specified by:
getAlternativeLanguageCodesBytes
in interfaceRecognitionConfigOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the alternativeLanguageCodes at the given index.
-
getMaxAlternatives
public int getMaxAlternatives()
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;
- Specified by:
getMaxAlternatives
in interfaceRecognitionConfigOrBuilder
- Returns:
- The maxAlternatives.
-
getProfanityFilter
public boolean getProfanityFilter()
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;
- Specified by:
getProfanityFilter
in interfaceRecognitionConfigOrBuilder
- Returns:
- The profanityFilter.
-
hasAdaptation
public boolean hasAdaptation()
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.
.google.cloud.speech.v1.SpeechAdaptation adaptation = 20;
- Specified by:
hasAdaptation
in interfaceRecognitionConfigOrBuilder
- Returns:
- Whether the adaptation field is set.
-
getAdaptation
public SpeechAdaptation getAdaptation()
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.
.google.cloud.speech.v1.SpeechAdaptation adaptation = 20;
- Specified by:
getAdaptation
in interfaceRecognitionConfigOrBuilder
- Returns:
- The adaptation.
-
getAdaptationOrBuilder
public SpeechAdaptationOrBuilder getAdaptationOrBuilder()
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.
.google.cloud.speech.v1.SpeechAdaptation adaptation = 20;
- Specified by:
getAdaptationOrBuilder
in interfaceRecognitionConfigOrBuilder
-
getSpeechContextsList
public List<SpeechContext> getSpeechContextsList()
Array of [SpeechContext][google.cloud.speech.v1.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).
repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
- Specified by:
getSpeechContextsList
in interfaceRecognitionConfigOrBuilder
-
getSpeechContextsOrBuilderList
public List<? extends SpeechContextOrBuilder> getSpeechContextsOrBuilderList()
Array of [SpeechContext][google.cloud.speech.v1.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).
repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
- Specified by:
getSpeechContextsOrBuilderList
in interfaceRecognitionConfigOrBuilder
-
getSpeechContextsCount
public int getSpeechContextsCount()
Array of [SpeechContext][google.cloud.speech.v1.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).
repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
- Specified by:
getSpeechContextsCount
in interfaceRecognitionConfigOrBuilder
-
getSpeechContexts
public SpeechContext getSpeechContexts(int index)
Array of [SpeechContext][google.cloud.speech.v1.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).
repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
- Specified by:
getSpeechContexts
in interfaceRecognitionConfigOrBuilder
-
getSpeechContextsOrBuilder
public SpeechContextOrBuilder getSpeechContextsOrBuilder(int index)
Array of [SpeechContext][google.cloud.speech.v1.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).
repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
- Specified by:
getSpeechContextsOrBuilder
in interfaceRecognitionConfigOrBuilder
-
getEnableWordTimeOffsets
public boolean getEnableWordTimeOffsets()
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;
- Specified by:
getEnableWordTimeOffsets
in interfaceRecognitionConfigOrBuilder
- Returns:
- The enableWordTimeOffsets.
-
getEnableWordConfidence
public boolean getEnableWordConfidence()
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;
- Specified by:
getEnableWordConfidence
in interfaceRecognitionConfigOrBuilder
- Returns:
- The enableWordConfidence.
-
getEnableAutomaticPunctuation
public boolean getEnableAutomaticPunctuation()
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.
bool enable_automatic_punctuation = 11;
- Specified by:
getEnableAutomaticPunctuation
in interfaceRecognitionConfigOrBuilder
- Returns:
- The enableAutomaticPunctuation.
-
hasEnableSpokenPunctuation
public boolean hasEnableSpokenPunctuation()
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.
.google.protobuf.BoolValue enable_spoken_punctuation = 22;
- Specified by:
hasEnableSpokenPunctuation
in interfaceRecognitionConfigOrBuilder
- Returns:
- Whether the enableSpokenPunctuation field is set.
-
getEnableSpokenPunctuation
public com.google.protobuf.BoolValue 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.
.google.protobuf.BoolValue enable_spoken_punctuation = 22;
- Specified by:
getEnableSpokenPunctuation
in interfaceRecognitionConfigOrBuilder
- Returns:
- The enableSpokenPunctuation.
-
getEnableSpokenPunctuationOrBuilder
public com.google.protobuf.BoolValueOrBuilder getEnableSpokenPunctuationOrBuilder()
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.
.google.protobuf.BoolValue enable_spoken_punctuation = 22;
- Specified by:
getEnableSpokenPunctuationOrBuilder
in interfaceRecognitionConfigOrBuilder
-
hasEnableSpokenEmojis
public boolean hasEnableSpokenEmojis()
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.
.google.protobuf.BoolValue enable_spoken_emojis = 23;
- Specified by:
hasEnableSpokenEmojis
in interfaceRecognitionConfigOrBuilder
- Returns:
- Whether the enableSpokenEmojis field is set.
-
getEnableSpokenEmojis
public com.google.protobuf.BoolValue 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.
.google.protobuf.BoolValue enable_spoken_emojis = 23;
- Specified by:
getEnableSpokenEmojis
in interfaceRecognitionConfigOrBuilder
- Returns:
- The enableSpokenEmojis.
-
getEnableSpokenEmojisOrBuilder
public com.google.protobuf.BoolValueOrBuilder getEnableSpokenEmojisOrBuilder()
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.
.google.protobuf.BoolValue enable_spoken_emojis = 23;
- Specified by:
getEnableSpokenEmojisOrBuilder
in interfaceRecognitionConfigOrBuilder
-
hasDiarizationConfig
public boolean hasDiarizationConfig()
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.
.google.cloud.speech.v1.SpeakerDiarizationConfig diarization_config = 19;
- Specified by:
hasDiarizationConfig
in interfaceRecognitionConfigOrBuilder
- Returns:
- Whether the diarizationConfig field is set.
-
getDiarizationConfig
public SpeakerDiarizationConfig getDiarizationConfig()
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.
.google.cloud.speech.v1.SpeakerDiarizationConfig diarization_config = 19;
- Specified by:
getDiarizationConfig
in interfaceRecognitionConfigOrBuilder
- Returns:
- The diarizationConfig.
-
getDiarizationConfigOrBuilder
public SpeakerDiarizationConfigOrBuilder getDiarizationConfigOrBuilder()
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.
.google.cloud.speech.v1.SpeakerDiarizationConfig diarization_config = 19;
- Specified by:
getDiarizationConfigOrBuilder
in interfaceRecognitionConfigOrBuilder
-
hasMetadata
public boolean hasMetadata()
Metadata regarding this request.
.google.cloud.speech.v1.RecognitionMetadata metadata = 9;
- Specified by:
hasMetadata
in interfaceRecognitionConfigOrBuilder
- Returns:
- Whether the metadata field is set.
-
getMetadata
public RecognitionMetadata getMetadata()
Metadata regarding this request.
.google.cloud.speech.v1.RecognitionMetadata metadata = 9;
- Specified by:
getMetadata
in interfaceRecognitionConfigOrBuilder
- Returns:
- The metadata.
-
getMetadataOrBuilder
public RecognitionMetadataOrBuilder getMetadataOrBuilder()
Metadata regarding this request.
.google.cloud.speech.v1.RecognitionMetadata metadata = 9;
- Specified by:
getMetadataOrBuilder
in interfaceRecognitionConfigOrBuilder
-
getModel
public String getModel()
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>latest_long</code></td> <td>Best for long form content like media or conversation.</td> </tr> <tr> <td><code>latest_short</code></td> <td>Best for short form content like commands or single shot directed speech.</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 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> <tr> <td><code>medical_conversation</code></td> <td>Best for audio that originated from a conversation between a medical provider and patient.</td> </tr> <tr> <td><code>medical_dictation</code></td> <td>Best for audio that originated from dictation notes by a medical provider.</td> </tr> </table>
string model = 13;
- Specified by:
getModel
in interfaceRecognitionConfigOrBuilder
- Returns:
- The model.
-
getModelBytes
public com.google.protobuf.ByteString getModelBytes()
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>latest_long</code></td> <td>Best for long form content like media or conversation.</td> </tr> <tr> <td><code>latest_short</code></td> <td>Best for short form content like commands or single shot directed speech.</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 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> <tr> <td><code>medical_conversation</code></td> <td>Best for audio that originated from a conversation between a medical provider and patient.</td> </tr> <tr> <td><code>medical_dictation</code></td> <td>Best for audio that originated from dictation notes by a medical provider.</td> </tr> </table>
string model = 13;
- Specified by:
getModelBytes
in interfaceRecognitionConfigOrBuilder
- Returns:
- The bytes for model.
-
getUseEnhanced
public boolean getUseEnhanced()
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.
bool use_enhanced = 14;
- Specified by:
getUseEnhanced
in interfaceRecognitionConfigOrBuilder
- Returns:
- The useEnhanced.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RecognitionConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecognitionConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecognitionConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecognitionConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecognitionConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecognitionConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecognitionConfig parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static RecognitionConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static RecognitionConfig parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static RecognitionConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static RecognitionConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static RecognitionConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public RecognitionConfig.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static RecognitionConfig.Builder newBuilder()
-
newBuilder
public static RecognitionConfig.Builder newBuilder(RecognitionConfig prototype)
-
toBuilder
public RecognitionConfig.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RecognitionConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static RecognitionConfig getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<RecognitionConfig> parser()
-
getParserForType
public com.google.protobuf.Parser<RecognitionConfig> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public RecognitionConfig getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-