Class RecognitionConfig (4.25.0)

public final class RecognitionConfig extends GeneratedMessageV3 implements RecognitionConfigOrBuilder

Provides information to the Recognizer that specifies how to process the recognition request.

Protobuf type google.cloud.speech.v2.RecognitionConfig

Static Fields

ADAPTATION_FIELD_NUMBER

public static final int ADAPTATION_FIELD_NUMBER
Field Value
TypeDescription
int

AUTO_DECODING_CONFIG_FIELD_NUMBER

public static final int AUTO_DECODING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

EXPLICIT_DECODING_CONFIG_FIELD_NUMBER

public static final int EXPLICIT_DECODING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER
Field Value
TypeDescription
int

LANGUAGE_CODES_FIELD_NUMBER

public static final int LANGUAGE_CODES_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSCRIPT_NORMALIZATION_FIELD_NUMBER

public static final int TRANSCRIPT_NORMALIZATION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RecognitionConfig getDefaultInstance()
Returns
TypeDescription
RecognitionConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RecognitionConfig.Builder newBuilder()
Returns
TypeDescription
RecognitionConfig.Builder

newBuilder(RecognitionConfig prototype)

public static RecognitionConfig.Builder newBuilder(RecognitionConfig prototype)
Parameter
NameDescription
prototypeRecognitionConfig
Returns
TypeDescription
RecognitionConfig.Builder

parseDelimitedFrom(InputStream input)

public static RecognitionConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognitionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RecognitionConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RecognitionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RecognitionConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RecognitionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RecognitionConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognitionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RecognitionConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognitionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RecognitionConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RecognitionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognitionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RecognitionConfig> parser()
Returns
TypeDescription
Parser<RecognitionConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAdaptation()

public SpeechAdaptation getAdaptation()

Speech adaptation context that weights recognizer predictions for specific words and phrases.

.google.cloud.speech.v2.SpeechAdaptation adaptation = 6;

Returns
TypeDescription
SpeechAdaptation

The adaptation.

getAdaptationOrBuilder()

public SpeechAdaptationOrBuilder getAdaptationOrBuilder()

Speech adaptation context that weights recognizer predictions for specific words and phrases.

.google.cloud.speech.v2.SpeechAdaptation adaptation = 6;

Returns
TypeDescription
SpeechAdaptationOrBuilder

getAutoDecodingConfig()

public AutoDetectDecodingConfig getAutoDecodingConfig()

Automatically detect decoding parameters. Preferred for supported formats.

.google.cloud.speech.v2.AutoDetectDecodingConfig auto_decoding_config = 7;

Returns
TypeDescription
AutoDetectDecodingConfig

The autoDecodingConfig.

getAutoDecodingConfigOrBuilder()

public AutoDetectDecodingConfigOrBuilder getAutoDecodingConfigOrBuilder()

Automatically detect decoding parameters. Preferred for supported formats.

.google.cloud.speech.v2.AutoDetectDecodingConfig auto_decoding_config = 7;

Returns
TypeDescription
AutoDetectDecodingConfigOrBuilder

getDecodingConfigCase()

public RecognitionConfig.DecodingConfigCase getDecodingConfigCase()
Returns
TypeDescription
RecognitionConfig.DecodingConfigCase

getDefaultInstanceForType()

public RecognitionConfig getDefaultInstanceForType()
Returns
TypeDescription
RecognitionConfig

getExplicitDecodingConfig()

public ExplicitDecodingConfig getExplicitDecodingConfig()

Explicitly specified decoding parameters. Required if using headerless PCM audio (linear16, mulaw, alaw).

.google.cloud.speech.v2.ExplicitDecodingConfig explicit_decoding_config = 8;

Returns
TypeDescription
ExplicitDecodingConfig

The explicitDecodingConfig.

getExplicitDecodingConfigOrBuilder()

public ExplicitDecodingConfigOrBuilder getExplicitDecodingConfigOrBuilder()

Explicitly specified decoding parameters. Required if using headerless PCM audio (linear16, mulaw, alaw).

.google.cloud.speech.v2.ExplicitDecodingConfig explicit_decoding_config = 8;

Returns
TypeDescription
ExplicitDecodingConfigOrBuilder

getFeatures()

public RecognitionFeatures getFeatures()

Speech recognition features to enable.

.google.cloud.speech.v2.RecognitionFeatures features = 2;

Returns
TypeDescription
RecognitionFeatures

The features.

getFeaturesOrBuilder()

public RecognitionFeaturesOrBuilder getFeaturesOrBuilder()

Speech recognition features to enable.

.google.cloud.speech.v2.RecognitionFeatures features = 2;

Returns
TypeDescription
RecognitionFeaturesOrBuilder

getLanguageCodes(int index)

public String getLanguageCodes(int index)

Optional. The language of the supplied audio as a BCP-47 language tag. Language tags are normalized to BCP-47 before they are used eg "en-us" becomes "en-US".

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio.

repeated string language_codes = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The languageCodes at the given index.

getLanguageCodesBytes(int index)

public ByteString getLanguageCodesBytes(int index)

Optional. The language of the supplied audio as a BCP-47 language tag. Language tags are normalized to BCP-47 before they are used eg "en-us" becomes "en-US".

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio.

repeated string language_codes = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the languageCodes at the given index.

getLanguageCodesCount()

public int getLanguageCodesCount()

Optional. The language of the supplied audio as a BCP-47 language tag. Language tags are normalized to BCP-47 before they are used eg "en-us" becomes "en-US".

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio.

repeated string language_codes = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of languageCodes.

getLanguageCodesList()

public ProtocolStringList getLanguageCodesList()

Optional. The language of the supplied audio as a BCP-47 language tag. Language tags are normalized to BCP-47 before they are used eg "en-us" becomes "en-US".

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio.

repeated string language_codes = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the languageCodes.

getModel()

public String getModel()

Optional. Which model to use for recognition requests. Select the model best suited to your domain to get best results.

Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.

string model = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The model.

getModelBytes()

public ByteString getModelBytes()

Optional. Which model to use for recognition requests. Select the model best suited to your domain to get best results.

Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.

string model = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for model.

getParserForType()

public Parser<RecognitionConfig> getParserForType()
Returns
TypeDescription
Parser<RecognitionConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTranscriptNormalization()

public TranscriptNormalization getTranscriptNormalization()

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

.google.cloud.speech.v2.TranscriptNormalization transcript_normalization = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
TranscriptNormalization

The transcriptNormalization.

getTranscriptNormalizationOrBuilder()

public TranscriptNormalizationOrBuilder getTranscriptNormalizationOrBuilder()

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

.google.cloud.speech.v2.TranscriptNormalization transcript_normalization = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
TranscriptNormalizationOrBuilder

hasAdaptation()

public boolean hasAdaptation()

Speech adaptation context that weights recognizer predictions for specific words and phrases.

.google.cloud.speech.v2.SpeechAdaptation adaptation = 6;

Returns
TypeDescription
boolean

Whether the adaptation field is set.

hasAutoDecodingConfig()

public boolean hasAutoDecodingConfig()

Automatically detect decoding parameters. Preferred for supported formats.

.google.cloud.speech.v2.AutoDetectDecodingConfig auto_decoding_config = 7;

Returns
TypeDescription
boolean

Whether the autoDecodingConfig field is set.

hasExplicitDecodingConfig()

public boolean hasExplicitDecodingConfig()

Explicitly specified decoding parameters. Required if using headerless PCM audio (linear16, mulaw, alaw).

.google.cloud.speech.v2.ExplicitDecodingConfig explicit_decoding_config = 8;

Returns
TypeDescription
boolean

Whether the explicitDecodingConfig field is set.

hasFeatures()

public boolean hasFeatures()

Speech recognition features to enable.

.google.cloud.speech.v2.RecognitionFeatures features = 2;

Returns
TypeDescription
boolean

Whether the features field is set.

hasTranscriptNormalization()

public boolean hasTranscriptNormalization()

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

.google.cloud.speech.v2.TranscriptNormalization transcript_normalization = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the transcriptNormalization field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RecognitionConfig.Builder newBuilderForType()
Returns
TypeDescription
RecognitionConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RecognitionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RecognitionConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RecognitionConfig.Builder toBuilder()
Returns
TypeDescription
RecognitionConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException