Class RecognitionFeatures (4.77.0) 

public final class RecognitionFeatures extends GeneratedMessageV3 implements RecognitionFeaturesOrBuilder

Available recognition features.

Protobuf type google.cloud.speech.v2.RecognitionFeatures

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RecognitionFeatures

Static Fields

CUSTOM_PROMPT_CONFIG_FIELD_NUMBER

public static final int CUSTOM_PROMPT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DIARIZATION_CONFIG_FIELD_NUMBER

public static final int DIARIZATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_AUTOMATIC_PUNCTUATION_FIELD_NUMBER

public static final int ENABLE_AUTOMATIC_PUNCTUATION_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_SPOKEN_EMOJIS_FIELD_NUMBER

public static final int ENABLE_SPOKEN_EMOJIS_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_SPOKEN_PUNCTUATION_FIELD_NUMBER

public static final int ENABLE_SPOKEN_PUNCTUATION_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_WORD_CONFIDENCE_FIELD_NUMBER

public static final int ENABLE_WORD_CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_WORD_TIME_OFFSETS_FIELD_NUMBER

public static final int ENABLE_WORD_TIME_OFFSETS_FIELD_NUMBER
Field Value
Type Description
int

MAX_ALTERNATIVES_FIELD_NUMBER

public static final int MAX_ALTERNATIVES_FIELD_NUMBER
Field Value
Type Description
int

MULTI_CHANNEL_MODE_FIELD_NUMBER

public static final int MULTI_CHANNEL_MODE_FIELD_NUMBER
Field Value
Type Description
int

PROFANITY_FILTER_FIELD_NUMBER

public static final int PROFANITY_FILTER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RecognitionFeatures getDefaultInstance()
Returns
Type Description
RecognitionFeatures

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RecognitionFeatures.Builder newBuilder()
Returns
Type Description
RecognitionFeatures.Builder

newBuilder(RecognitionFeatures prototype)

public static RecognitionFeatures.Builder newBuilder(RecognitionFeatures prototype)
Parameter
Name Description
prototype RecognitionFeatures
Returns
Type Description
RecognitionFeatures.Builder

parseDelimitedFrom(InputStream input)

public static RecognitionFeatures parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognitionFeatures parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RecognitionFeatures parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RecognitionFeatures parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RecognitionFeatures parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RecognitionFeatures parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RecognitionFeatures parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognitionFeatures parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RecognitionFeatures parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognitionFeatures parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RecognitionFeatures parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RecognitionFeatures parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecognitionFeatures
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RecognitionFeatures> parser()
Returns
Type Description
Parser<RecognitionFeatures>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

Returns
Type Description
CustomPromptConfig

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

Returns
Type Description
CustomPromptConfigOrBuilder

getDefaultInstanceForType()

public RecognitionFeatures getDefaultInstanceForType()
Returns
Type Description
RecognitionFeatures

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;

Returns
Type Description
SpeakerDiarizationConfig

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;

Returns
Type Description
SpeakerDiarizationConfigOrBuilder

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;

Returns
Type Description
boolean

The enableAutomaticPunctuation.

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;

Returns
Type Description
boolean

The enableSpokenEmojis.

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;

Returns
Type Description
boolean

The enableSpokenPunctuation.

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;

Returns
Type Description
boolean

The enableWordConfidence.

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;

Returns
Type Description
boolean

The enableWordTimeOffsets.

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;

Returns
Type Description
int

The maxAlternatives.

getMultiChannelMode()

public RecognitionFeatures.MultiChannelMode getMultiChannelMode()

Mode for recognizing multi-channel audio.

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

Returns
Type Description
RecognitionFeatures.MultiChannelMode

The multiChannelMode.

getMultiChannelModeValue()

public int getMultiChannelModeValue()

Mode for recognizing multi-channel audio.

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

Returns
Type Description
int

The enum numeric value on the wire for multiChannelMode.

getParserForType()

public Parser<RecognitionFeatures> getParserForType()
Returns
Type Description
Parser<RecognitionFeatures>
Overrides

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;

Returns
Type Description
boolean

The profanityFilter.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

Returns
Type Description
boolean

Whether the customPromptConfig field is set.

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;

Returns
Type Description
boolean

Whether the diarizationConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RecognitionFeatures.Builder newBuilderForType()
Returns
Type Description
RecognitionFeatures.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RecognitionFeatures.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RecognitionFeatures.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RecognitionFeatures.Builder toBuilder()
Returns
Type Description
RecognitionFeatures.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException