com.google.cloud.speech.v2

Class RecognitionFeatures

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.speech.v2.RecognitionFeatures

All Implemented Interfaces:

RecognitionFeaturesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class RecognitionFeatures
extends com.google.protobuf.GeneratedMessage
implements RecognitionFeaturesOrBuilder

 Available recognition features.
 

Protobuf type google.cloud.speech.v2.RecognitionFeatures

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecognitionFeatures.Builder Available recognition features.
static class	RecognitionFeatures.MultiChannelMode Options for how to recognize multi-channel audio.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CUSTOM_PROMPT_CONFIG_FIELD_NUMBER
static int	DIARIZATION_CONFIG_FIELD_NUMBER
static int	ENABLE_AUTOMATIC_PUNCTUATION_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	MAX_ALTERNATIVES_FIELD_NUMBER
static int	MULTI_CHANNEL_MODE_FIELD_NUMBER
static int	PROFANITY_FILTER_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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(Object obj)
CustomPromptConfig	getCustomPromptConfig() Optional.
CustomPromptConfigOrBuilder	getCustomPromptConfigOrBuilder() Optional.
static RecognitionFeatures	getDefaultInstance()
RecognitionFeatures	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
SpeakerDiarizationConfig	getDiarizationConfig() Configuration to enable speaker diarization.
SpeakerDiarizationConfigOrBuilder	getDiarizationConfigOrBuilder() Configuration to enable speaker diarization.
boolean	getEnableAutomaticPunctuation() If `true`, adds punctuation to recognition result hypotheses.
boolean	getEnableSpokenEmojis() The spoken emoji behavior for the call.
boolean	getEnableSpokenPunctuation() The spoken punctuation behavior for the call.
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.
int	getMaxAlternatives() Maximum number of recognition hypotheses to be returned.
RecognitionFeatures.MultiChannelMode	getMultiChannelMode() Mode for recognizing multi-channel audio.
int	getMultiChannelModeValue() Mode for recognizing multi-channel audio.
com.google.protobuf.Parser<RecognitionFeatures>	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, for instance, "f***".
int	getSerializedSize()
boolean	hasCustomPromptConfig() Optional.
boolean	hasDiarizationConfig() Configuration to enable speaker diarization.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RecognitionFeatures.Builder	newBuilder()
static RecognitionFeatures.Builder	newBuilder(RecognitionFeatures prototype)
RecognitionFeatures.Builder	newBuilderForType()
protected RecognitionFeatures.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RecognitionFeatures	parseDelimitedFrom(InputStream input)
static RecognitionFeatures	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionFeatures	parseFrom(byte[] data)
static RecognitionFeatures	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionFeatures	parseFrom(ByteBuffer data)
static RecognitionFeatures	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionFeatures	parseFrom(com.google.protobuf.ByteString data)
static RecognitionFeatures	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionFeatures	parseFrom(com.google.protobuf.CodedInputStream input)
static RecognitionFeatures	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecognitionFeatures	parseFrom(InputStream input)
static RecognitionFeatures	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RecognitionFeatures>	parser()
RecognitionFeatures.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PROFANITY_FILTER_FIELD_NUMBER

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

MULTI_CHANNEL_MODE_FIELD_NUMBER

public static final int MULTI_CHANNEL_MODE_FIELD_NUMBER

See Also:

Constant Field Values

DIARIZATION_CONFIG_FIELD_NUMBER

public static final int DIARIZATION_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

MAX_ALTERNATIVES_FIELD_NUMBER

public static final int MAX_ALTERNATIVES_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_PROMPT_CONFIG_FIELD_NUMBER

public static final int CUSTOM_PROMPT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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, for instance, "f***". If set to `false` or omitted, profanities
 won't be filtered out.
 

bool profanity_filter = 1;

Specified by:

getProfanityFilter in interface RecognitionFeaturesOrBuilder

Returns:

The profanityFilter.

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

Specified by:

getEnableWordTimeOffsets in interface RecognitionFeaturesOrBuilder

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 = 3;

Specified by:

getEnableWordConfidence in interface RecognitionFeaturesOrBuilder

Returns:

The enableWordConfidence.

getEnableAutomaticPunctuation

public boolean getEnableAutomaticPunctuation()

 If `true`, adds punctuation to recognition result hypotheses. This feature
 is only available in select languages. The default `false` value does not
 add punctuation to result hypotheses.
 

bool enable_automatic_punctuation = 4;

Specified by:

getEnableAutomaticPunctuation in interface RecognitionFeaturesOrBuilder

Returns:

The enableAutomaticPunctuation.

getEnableSpokenPunctuation

public boolean getEnableSpokenPunctuation()

 The spoken punctuation behavior for the call. 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.
 

bool enable_spoken_punctuation = 14;

Specified by:

getEnableSpokenPunctuation in interface RecognitionFeaturesOrBuilder

Returns:

The enableSpokenPunctuation.

getEnableSpokenEmojis

public boolean getEnableSpokenEmojis()

 The spoken emoji behavior for the call. 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.
 

bool enable_spoken_emojis = 15;

Specified by:

getEnableSpokenEmojis in interface RecognitionFeaturesOrBuilder

Returns:

The enableSpokenEmojis.

getMultiChannelModeValue

public int getMultiChannelModeValue()

 Mode for recognizing multi-channel audio.
 

.google.cloud.speech.v2.RecognitionFeatures.MultiChannelMode multi_channel_mode = 17;

Specified by:

getMultiChannelModeValue in interface RecognitionFeaturesOrBuilder

Returns:

The enum numeric value on the wire for multiChannelMode.

getMultiChannelMode

public RecognitionFeatures.MultiChannelMode getMultiChannelMode()

 Mode for recognizing multi-channel audio.
 

.google.cloud.speech.v2.RecognitionFeatures.MultiChannelMode multi_channel_mode = 17;

Specified by:

getMultiChannelMode in interface RecognitionFeaturesOrBuilder

Returns:

The multiChannelMode.

hasDiarizationConfig

public boolean hasDiarizationConfig()

 Configuration to enable speaker diarization. To enable diarization, set
 this field to an empty SpeakerDiarizationConfig message.
 

.google.cloud.speech.v2.SpeakerDiarizationConfig diarization_config = 9;

Specified by:

hasDiarizationConfig in interface RecognitionFeaturesOrBuilder

Returns:

Whether the diarizationConfig field is set.

getDiarizationConfig

public SpeakerDiarizationConfig getDiarizationConfig()

 Configuration to enable speaker diarization. To enable diarization, set
 this field to an empty SpeakerDiarizationConfig message.
 

.google.cloud.speech.v2.SpeakerDiarizationConfig diarization_config = 9;

Specified by:

getDiarizationConfig in interface RecognitionFeaturesOrBuilder

Returns:

The diarizationConfig.

getDiarizationConfigOrBuilder

public SpeakerDiarizationConfigOrBuilder getDiarizationConfigOrBuilder()

 Configuration to enable speaker diarization. To enable diarization, set
 this field to an empty SpeakerDiarizationConfig message.
 

.google.cloud.speech.v2.SpeakerDiarizationConfig diarization_config = 9;

Specified by:

getDiarizationConfigOrBuilder in interface RecognitionFeaturesOrBuilder

getMaxAlternatives

public int getMaxAlternatives()

 Maximum number of recognition hypotheses to be returned.
 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 = 16;

Specified by:

getMaxAlternatives in interface RecognitionFeaturesOrBuilder

Returns:

The maxAlternatives.

hasCustomPromptConfig

public boolean hasCustomPromptConfig()

 Optional. Configuration to enable custom prompt for chirp3.
 

.google.cloud.speech.v2.CustomPromptConfig custom_prompt_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasCustomPromptConfig in interface RecognitionFeaturesOrBuilder

Returns:

Whether the customPromptConfig field is set.

getCustomPromptConfig

public CustomPromptConfig getCustomPromptConfig()

 Optional. Configuration to enable custom prompt for chirp3.
 

.google.cloud.speech.v2.CustomPromptConfig custom_prompt_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomPromptConfig in interface RecognitionFeaturesOrBuilder

Returns:

The customPromptConfig.

getCustomPromptConfigOrBuilder

public CustomPromptConfigOrBuilder getCustomPromptConfigOrBuilder()

 Optional. Configuration to enable custom prompt for chirp3.
 

.google.cloud.speech.v2.CustomPromptConfig custom_prompt_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomPromptConfigOrBuilder in interface RecognitionFeaturesOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RecognitionFeatures parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecognitionFeatures parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecognitionFeatures parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecognitionFeatures parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecognitionFeatures parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecognitionFeatures parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecognitionFeatures parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static RecognitionFeatures parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static RecognitionFeatures parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static RecognitionFeatures parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static RecognitionFeatures parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static RecognitionFeatures parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public RecognitionFeatures.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RecognitionFeatures.Builder newBuilder()

newBuilder

public static RecognitionFeatures.Builder newBuilder(RecognitionFeatures prototype)

toBuilder

public RecognitionFeatures.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RecognitionFeatures.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static RecognitionFeatures getDefaultInstance()

parser

public static com.google.protobuf.Parser<RecognitionFeatures> parser()

getParserForType

public com.google.protobuf.Parser<RecognitionFeatures> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public RecognitionFeatures getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder