Package com.google.cloud.speech.v2

Class RecognitionFeatures

  • All Implemented Interfaces:
    RecognitionFeaturesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class RecognitionFeatures
extends com.google.protobuf.GeneratedMessageV3
implements RecognitionFeaturesOrBuilder
     Available recognition features.
    Protobuf type google.cloud.speech.v2.RecognitionFeatures
    See Also:
    Serialized Form

    • 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

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

      • hasDiarizationConfig

        public boolean hasDiarizationConfig()
         Configuration to enable speaker diarization and set additional
 parameters to make diarization better suited for your application.
 When this is enabled, we send all the words from the beginning of the
 audio for the top alternative in every consecutive STREAMING responses.
 This is done in order to improve our speaker tags as our models learn to
 identify the speakers in the conversation over time.
 For non-streaming requests, the diarization results will be provided only
 in the top alternative of the FINAL SpeechRecognitionResult.
        .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 and set additional
 parameters to make diarization better suited for your application.
 When this is enabled, we send all the words from the beginning of the
 audio for the top alternative in every consecutive STREAMING responses.
 This is done in order to improve our speaker tags as our models learn to
 identify the speakers in the conversation over time.
 For non-streaming requests, the diarization results will be provided only
 in the top alternative of the FINAL SpeechRecognitionResult.
        .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 and set additional
 parameters to make diarization better suited for your application.
 When this is enabled, we send all the words from the beginning of the
 audio for the top alternative in every consecutive STREAMING responses.
 This is done in order to improve our speaker tags as our models learn to
 identify the speakers in the conversation over time.
 For non-streaming requests, the diarization results will be provided only
 in the top alternative of the FINAL SpeechRecognitionResult.
        .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.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public RecognitionFeatures getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder