Class SpeechTranscriptionConfig

  • All Implemented Interfaces:
    SpeechTranscriptionConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class SpeechTranscriptionConfig
    extends com.google.protobuf.GeneratedMessageV3
    implements SpeechTranscriptionConfigOrBuilder
     Config for SPEECH_TRANSCRIPTION.
     
    Protobuf type google.cloud.videointelligence.v1p3beta1.SpeechTranscriptionConfig
    See Also:
    Serialized Form
    • Field Detail

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

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

        public static final int ENABLE_AUTOMATIC_PUNCTUATION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • AUDIO_TRACKS_FIELD_NUMBER

        public static final int AUDIO_TRACKS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ENABLE_SPEAKER_DIARIZATION_FIELD_NUMBER

        public static final int ENABLE_SPEAKER_DIARIZATION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DIARIZATION_SPEAKER_COUNT_FIELD_NUMBER

        public static final int DIARIZATION_SPEAKER_COUNT_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
    • 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
      • getLanguageCode

        public String getLanguageCode()
         Required. *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 = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLanguageCode in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The languageCode.
      • getLanguageCodeBytes

        public com.google.protobuf.ByteString getLanguageCodeBytes()
         Required. *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 = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLanguageCodeBytes in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The bytes for languageCode.
      • getMaxAlternatives

        public int getMaxAlternatives()
         Optional. Maximum number of recognition hypotheses to be returned.
         Specifically, the maximum number of `SpeechRecognitionAlternative` messages
         within each `SpeechTranscription`. 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 = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMaxAlternatives in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The maxAlternatives.
      • getFilterProfanity

        public boolean getFilterProfanity()
         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 filter_profanity = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterProfanity in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The filterProfanity.
      • getSpeechContextsList

        public List<SpeechContext> getSpeechContextsList()
         Optional. A means to provide context to assist the speech recognition.
         
        repeated .google.cloud.videointelligence.v1p3beta1.SpeechContext speech_contexts = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSpeechContextsList in interface SpeechTranscriptionConfigOrBuilder
      • getSpeechContextsCount

        public int getSpeechContextsCount()
         Optional. A means to provide context to assist the speech recognition.
         
        repeated .google.cloud.videointelligence.v1p3beta1.SpeechContext speech_contexts = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSpeechContextsCount in interface SpeechTranscriptionConfigOrBuilder
      • getSpeechContexts

        public SpeechContext getSpeechContexts​(int index)
         Optional. A means to provide context to assist the speech recognition.
         
        repeated .google.cloud.videointelligence.v1p3beta1.SpeechContext speech_contexts = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSpeechContexts in interface SpeechTranscriptionConfigOrBuilder
      • getEnableAutomaticPunctuation

        public boolean getEnableAutomaticPunctuation()
         Optional. If 'true', adds punctuation to recognition result hypotheses.
         This feature is only available in select languages. Setting this for
         requests in other languages has no effect at all. The default 'false' value
         does not add punctuation to result hypotheses. NOTE: "This is currently
         offered as an experimental service, complimentary to all users. In the
         future this may be exclusively available as a premium feature."
         
        bool enable_automatic_punctuation = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnableAutomaticPunctuation in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The enableAutomaticPunctuation.
      • getAudioTracksList

        public List<Integer> getAudioTracksList()
         Optional. For file formats, such as MXF or MKV, supporting multiple audio
         tracks, specify up to two tracks. Default: track 0.
         
        repeated int32 audio_tracks = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAudioTracksList in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        A list containing the audioTracks.
      • getAudioTracksCount

        public int getAudioTracksCount()
         Optional. For file formats, such as MXF or MKV, supporting multiple audio
         tracks, specify up to two tracks. Default: track 0.
         
        repeated int32 audio_tracks = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAudioTracksCount in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The count of audioTracks.
      • getAudioTracks

        public int getAudioTracks​(int index)
         Optional. For file formats, such as MXF or MKV, supporting multiple audio
         tracks, specify up to two tracks. Default: track 0.
         
        repeated int32 audio_tracks = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAudioTracks in interface SpeechTranscriptionConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The audioTracks at the given index.
      • getEnableSpeakerDiarization

        public boolean getEnableSpeakerDiarization()
         Optional. If 'true', enables speaker detection for each recognized word in
         the top alternative of the recognition result using a speaker_tag provided
         in the WordInfo.
         Note: When this is true, we send all the words from the beginning of the
         audio for the top alternative in every consecutive response.
         This is done in order to improve our speaker tags as our models learn to
         identify the speakers in the conversation over time.
         
        bool enable_speaker_diarization = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnableSpeakerDiarization in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The enableSpeakerDiarization.
      • getDiarizationSpeakerCount

        public int getDiarizationSpeakerCount()
         Optional. If set, specifies the estimated number of speakers in the
         conversation. If not set, defaults to '2'. Ignored unless
         enable_speaker_diarization is set to true.
         
        int32 diarization_speaker_count = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDiarizationSpeakerCount in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The diarizationSpeakerCount.
      • getEnableWordConfidence

        public boolean getEnableWordConfidence()
         Optional. 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 = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnableWordConfidence in interface SpeechTranscriptionConfigOrBuilder
        Returns:
        The enableWordConfidence.
      • 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 SpeechTranscriptionConfig parseFrom​(ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SpeechTranscriptionConfig parseFrom​(ByteBuffer data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SpeechTranscriptionConfig parseFrom​(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SpeechTranscriptionConfig parseFrom​(com.google.protobuf.ByteString data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SpeechTranscriptionConfig parseFrom​(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SpeechTranscriptionConfig parseFrom​(byte[] data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public SpeechTranscriptionConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public SpeechTranscriptionConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected SpeechTranscriptionConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<SpeechTranscriptionConfig> 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 SpeechTranscriptionConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder