Class RecognitionConfig (4.25.0)

public final class RecognitionConfig extends GeneratedMessageV3 implements RecognitionConfigOrBuilder

Provides information to the recognizer that specifies how to process the request.

Protobuf type google.cloud.speech.v1beta1.RecognitionConfig

Static Fields

ENCODING_FIELD_NUMBER

public static final int ENCODING_FIELD_NUMBER
Field Value
TypeDescription
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_ALTERNATIVES_FIELD_NUMBER

public static final int MAX_ALTERNATIVES_FIELD_NUMBER
Field Value
TypeDescription
int

PROFANITY_FILTER_FIELD_NUMBER

public static final int PROFANITY_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

SAMPLE_RATE_FIELD_NUMBER

public static final int SAMPLE_RATE_FIELD_NUMBER
Field Value
TypeDescription
int

SPEECH_CONTEXT_FIELD_NUMBER

public static final int SPEECH_CONTEXT_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

getDefaultInstanceForType()

public RecognitionConfig getDefaultInstanceForType()
Returns
TypeDescription
RecognitionConfig

getEncoding()

public RecognitionConfig.AudioEncoding getEncoding()

Required Encoding of audio data sent in all RecognitionAudio messages.

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

Returns
TypeDescription
RecognitionConfig.AudioEncoding

getEncodingValue()

public int getEncodingValue()

Required Encoding of audio data sent in all RecognitionAudio messages.

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

Returns
TypeDescription
int

getLanguageCode()

public String getLanguageCode()

Optional The language of the supplied audio as a BCP-47 language tag. Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt If omitted, defaults to "en-US". See Language Support for a list of the currently supported language codes.

string language_code = 3;

Returns
TypeDescription
String

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Optional The language of the supplied audio as a BCP-47 language tag. Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt If omitted, defaults to "en-US". See Language Support for a list of the currently supported language codes.

string language_code = 3;

Returns
TypeDescription
ByteString

getMaxAlternatives()

public 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;

Returns
TypeDescription
int

getParserForType()

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

getProfanityFilter()

public 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;

Returns
TypeDescription
boolean

getSampleRate()

public int getSampleRate()

Required 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).

int32 sample_rate = 2;

Returns
TypeDescription
int

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpeechContext()

public SpeechContext getSpeechContext()

Optional A means to provide context to assist the speech recognition.

.google.cloud.speech.v1beta1.SpeechContext speech_context = 6;

Returns
TypeDescription
SpeechContext

getSpeechContextOrBuilder()

public SpeechContextOrBuilder getSpeechContextOrBuilder()

Optional A means to provide context to assist the speech recognition.

.google.cloud.speech.v1beta1.SpeechContext speech_context = 6;

Returns
TypeDescription
SpeechContextOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasSpeechContext()

public boolean hasSpeechContext()

Optional A means to provide context to assist the speech recognition.

.google.cloud.speech.v1beta1.SpeechContext speech_context = 6;

Returns
TypeDescription
boolean

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

toBuilder()

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

writeTo(CodedOutputStream output)

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