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, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

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.v1.RecognitionConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecognitionConfig.AudioEncoding Audio encoding of the data sent in the audio message.
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

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
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	PROFANITY_FILTER_FIELD_NUMBER
static int	SAMPLE_RATE_HERTZ_FIELD_NUMBER
static int	SPEECH_CONTEXTS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static RecognitionConfig	getDefaultInstance()
RecognitionConfig	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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() *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
int	getEncodingValue() *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
java.lang.String	getLanguageCode() *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
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.
Parser<RecognitionConfig>	getParserForType()
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() *Required* Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages.
int	getSerializedSize()
SpeechContext	getSpeechContexts(int index) *Optional* A means to provide context to assist the speech recognition.
int	getSpeechContextsCount() *Optional* A means to provide context to assist the speech recognition.
java.util.List<SpeechContext>	getSpeechContextsList() *Optional* A means to provide context to assist the speech recognition.
SpeechContextOrBuilder	getSpeechContextsOrBuilder(int index) *Optional* A means to provide context to assist the speech recognition.
java.util.List<? extends SpeechContextOrBuilder>	getSpeechContextsOrBuilderList() *Optional* A means to provide context to assist the speech recognition.
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RecognitionConfig.Builder	newBuilder()
static RecognitionConfig.Builder	newBuilder(RecognitionConfig prototype)
RecognitionConfig.Builder	newBuilderForType()
protected RecognitionConfig.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static RecognitionConfig	parseDelimitedFrom(java.io.InputStream input)
static RecognitionConfig	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static RecognitionConfig	parseFrom(byte[] data)
static RecognitionConfig	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static RecognitionConfig	parseFrom(java.nio.ByteBuffer data)
static RecognitionConfig	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static RecognitionConfig	parseFrom(ByteString data)
static RecognitionConfig	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static RecognitionConfig	parseFrom(CodedInputStream input)
static RecognitionConfig	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static RecognitionConfig	parseFrom(java.io.InputStream input)
static RecognitionConfig	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<RecognitionConfig>	parser()
RecognitionConfig.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

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

LANGUAGE_CODE_FIELD_NUMBER

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

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

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getEncodingValue

public int getEncodingValue()

 *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
 

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

Specified by:

getEncodingValue in interface RecognitionConfigOrBuilder

getEncoding

public RecognitionConfig.AudioEncoding getEncoding()

 *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
 

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

Specified by:

getEncoding in interface RecognitionConfigOrBuilder

getSampleRateHertz

public int getSampleRateHertz()

 *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_hertz = 2;

Specified by:

getSampleRateHertz in interface RecognitionConfigOrBuilder

getLanguageCode

public java.lang.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/docs/languages)
 for a list of the currently supported language codes.
 

string language_code = 3;

Specified by:

getLanguageCode in interface RecognitionConfigOrBuilder

getLanguageCodeBytes

public 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/docs/languages)
 for a list of the currently supported language codes.
 

string language_code = 3;

Specified by:

getLanguageCodeBytes in interface RecognitionConfigOrBuilder

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;

Specified by:

getMaxAlternatives in interface RecognitionConfigOrBuilder

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;

Specified by:

getProfanityFilter in interface RecognitionConfigOrBuilder

getSpeechContextsList

public java.util.List<SpeechContext> getSpeechContextsList()

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

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

Specified by:

getSpeechContextsList in interface RecognitionConfigOrBuilder

getSpeechContextsOrBuilderList

public java.util.List<? extends SpeechContextOrBuilder> getSpeechContextsOrBuilderList()

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

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

Specified by:

getSpeechContextsOrBuilderList in interface RecognitionConfigOrBuilder

getSpeechContextsCount

public int getSpeechContextsCount()

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

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

Specified by:

getSpeechContextsCount in interface RecognitionConfigOrBuilder

getSpeechContexts

public SpeechContext getSpeechContexts(int index)

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

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

Specified by:

getSpeechContexts in interface RecognitionConfigOrBuilder

getSpeechContextsOrBuilder

public SpeechContextOrBuilder getSpeechContextsOrBuilder(int index)

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

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

Specified by:

getSpeechContextsOrBuilder in interface RecognitionConfigOrBuilder

getEnableWordTimeOffsets

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

Specified by:

getEnableWordTimeOffsets in interface RecognitionConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static RecognitionConfig parseFrom(java.nio.ByteBuffer data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RecognitionConfig parseFrom(java.nio.ByteBuffer data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RecognitionConfig parseFrom(ByteString data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RecognitionConfig parseFrom(ByteString data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RecognitionConfig parseFrom(byte[] data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RecognitionConfig parseFrom(byte[] data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RecognitionConfig parseFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static RecognitionConfig parseFrom(java.io.InputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static RecognitionConfig parseDelimitedFrom(java.io.InputStream input)
                                            throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static RecognitionConfig parseDelimitedFrom(java.io.InputStream input,
                                                   ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static RecognitionConfig parseFrom(CodedInputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static RecognitionConfig parseFrom(CodedInputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public RecognitionConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static RecognitionConfig.Builder newBuilder()

newBuilder

public static RecognitionConfig.Builder newBuilder(RecognitionConfig prototype)

toBuilder

public RecognitionConfig.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected RecognitionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static RecognitionConfig getDefaultInstance()

parser

public static Parser<RecognitionConfig> parser()

getParserForType

public Parser<RecognitionConfig> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public RecognitionConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder