Package com.google.cloud.speech.v1p1beta1

Class RecognitionConfig

  • All Implemented Interfaces:
    RecognitionConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class RecognitionConfig
extends com.google.protobuf.GeneratedMessageV3
implements RecognitionConfigOrBuilder
     Provides information to the recognizer that specifies how to process the
 request.
    Protobuf type google.cloud.speech.v1p1beta1.RecognitionConfig
    See Also:
    Serialized Form

    • Field Detail

      • SAMPLE_RATE_HERTZ_FIELD_NUMBER

        public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUDIO_CHANNEL_COUNT_FIELD_NUMBER

        public static final int AUDIO_CHANNEL_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_SEPARATE_RECOGNITION_PER_CHANNEL_FIELD_NUMBER

        public static final int ENABLE_SEPARATE_RECOGNITION_PER_CHANNEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LANGUAGE_CODE_FIELD_NUMBER

        public static final int LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALTERNATIVE_LANGUAGE_CODES_FIELD_NUMBER

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

      • ADAPTATION_FIELD_NUMBER

        public static final int ADAPTATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSCRIPT_NORMALIZATION_FIELD_NUMBER

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

      • 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

      • 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

      • DIARIZATION_CONFIG_FIELD_NUMBER

        public static final int DIARIZATION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_ENHANCED_FIELD_NUMBER

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

      • getEncodingValue

        public int getEncodingValue()
         Encoding of audio data sent in all `RecognitionAudio` messages.
 This field is optional for `FLAC` and `WAV` audio files and required
 for all other audio formats. For details, see
 [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
        .google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;
        Specified by:
        getEncodingValue in interface RecognitionConfigOrBuilder
        Returns:
        The enum numeric value on the wire for encoding.

      • getEncoding

        public RecognitionConfig.AudioEncoding getEncoding()
         Encoding of audio data sent in all `RecognitionAudio` messages.
 This field is optional for `FLAC` and `WAV` audio files and required
 for all other audio formats. For details, see
 [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
        .google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;
        Specified by:
        getEncoding in interface RecognitionConfigOrBuilder
        Returns:
        The encoding.

      • getSampleRateHertz

        public int getSampleRateHertz()
         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).
 This field is optional for FLAC and WAV audio files, but is
 required for all other audio formats. For details, see
 [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding].
        int32 sample_rate_hertz = 2;
        Specified by:
        getSampleRateHertz in interface RecognitionConfigOrBuilder
        Returns:
        The sampleRateHertz.

      • getAudioChannelCount

        public int getAudioChannelCount()
         The number of channels in the input audio data.
 ONLY set this for MULTI-CHANNEL recognition.
 Valid values for LINEAR16, OGG_OPUS and FLAC are `1`-`8`.
 Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`.
 If `0` or omitted, defaults to one channel (mono).
 Note: We only recognize the first channel by default.
 To perform independent recognition on each channel set
 `enable_separate_recognition_per_channel` to 'true'.
        int32 audio_channel_count = 7;
        Specified by:
        getAudioChannelCount in interface RecognitionConfigOrBuilder
        Returns:
        The audioChannelCount.

      • getEnableSeparateRecognitionPerChannel

        public boolean getEnableSeparateRecognitionPerChannel()
         This needs to be set to `true` explicitly and `audio_channel_count` > 1
 to get each channel recognized separately. The recognition result will
 contain a `channel_tag` field to state which channel that result belongs
 to. If this is not true, we will only recognize the first channel. The
 request is billed cumulatively for all channels recognized:
 `audio_channel_count` multiplied by the length of the audio.
        bool enable_separate_recognition_per_channel = 12;
        Specified by:
        getEnableSeparateRecognitionPerChannel in interface RecognitionConfigOrBuilder
        Returns:
        The enableSeparateRecognitionPerChannel.

      • getLanguageCode

        public 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-to-text/docs/languages) for a list
 of the currently supported language codes.
        string language_code = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLanguageCode in interface RecognitionConfigOrBuilder
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        public com.google.protobuf.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-to-text/docs/languages) for a list
 of the currently supported language codes.
        string language_code = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLanguageCodeBytes in interface RecognitionConfigOrBuilder
        Returns:
        The bytes for languageCode.

      • getAlternativeLanguageCodesList

        public com.google.protobuf.ProtocolStringList getAlternativeLanguageCodesList()
         A list of up to 3 additional
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
 listing possible alternative languages of the supplied audio.
 See [Language
 Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
 of the currently supported language codes. If alternative languages are
 listed, recognition result will contain recognition in the most likely
 language detected including the main language_code. The recognition result
 will include the language tag of the language detected in the audio. Note:
 This feature is only supported for Voice Command and Voice Search use cases
 and performance may vary for other use cases (e.g., phone call
 transcription).
        repeated string alternative_language_codes = 18;
        Specified by:
        getAlternativeLanguageCodesList in interface RecognitionConfigOrBuilder
        Returns:
        A list containing the alternativeLanguageCodes.

      • getAlternativeLanguageCodesCount

        public int getAlternativeLanguageCodesCount()
         A list of up to 3 additional
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
 listing possible alternative languages of the supplied audio.
 See [Language
 Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
 of the currently supported language codes. If alternative languages are
 listed, recognition result will contain recognition in the most likely
 language detected including the main language_code. The recognition result
 will include the language tag of the language detected in the audio. Note:
 This feature is only supported for Voice Command and Voice Search use cases
 and performance may vary for other use cases (e.g., phone call
 transcription).
        repeated string alternative_language_codes = 18;
        Specified by:
        getAlternativeLanguageCodesCount in interface RecognitionConfigOrBuilder
        Returns:
        The count of alternativeLanguageCodes.

      • getAlternativeLanguageCodes

        public String getAlternativeLanguageCodes​(int index)
         A list of up to 3 additional
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
 listing possible alternative languages of the supplied audio.
 See [Language
 Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
 of the currently supported language codes. If alternative languages are
 listed, recognition result will contain recognition in the most likely
 language detected including the main language_code. The recognition result
 will include the language tag of the language detected in the audio. Note:
 This feature is only supported for Voice Command and Voice Search use cases
 and performance may vary for other use cases (e.g., phone call
 transcription).
        repeated string alternative_language_codes = 18;
        Specified by:
        getAlternativeLanguageCodes in interface RecognitionConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The alternativeLanguageCodes at the given index.

      • getAlternativeLanguageCodesBytes

        public com.google.protobuf.ByteString getAlternativeLanguageCodesBytes​(int index)
         A list of up to 3 additional
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
 listing possible alternative languages of the supplied audio.
 See [Language
 Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
 of the currently supported language codes. If alternative languages are
 listed, recognition result will contain recognition in the most likely
 language detected including the main language_code. The recognition result
 will include the language tag of the language detected in the audio. Note:
 This feature is only supported for Voice Command and Voice Search use cases
 and performance may vary for other use cases (e.g., phone call
 transcription).
        repeated string alternative_language_codes = 18;
        Specified by:
        getAlternativeLanguageCodesBytes in interface RecognitionConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the alternativeLanguageCodes at the given index.

      • getMaxAlternatives

        public int getMaxAlternatives()
         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
        Returns:
        The maxAlternatives.

      • 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, 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
        Returns:
        The profanityFilter.

      • hasAdaptation

        public boolean hasAdaptation()
         Speech adaptation configuration improves the accuracy of speech
 recognition. For more information, see the [speech
 adaptation](https://cloud.google.com/speech-to-text/docs/adaptation)
 documentation.
 When speech adaptation is set it supersedes the `speech_contexts` field.
        .google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;
        Specified by:
        hasAdaptation in interface RecognitionConfigOrBuilder
        Returns:
        Whether the adaptation field is set.

      • getAdaptation

        public SpeechAdaptation getAdaptation()
         Speech adaptation configuration improves the accuracy of speech
 recognition. For more information, see the [speech
 adaptation](https://cloud.google.com/speech-to-text/docs/adaptation)
 documentation.
 When speech adaptation is set it supersedes the `speech_contexts` field.
        .google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;
        Specified by:
        getAdaptation in interface RecognitionConfigOrBuilder
        Returns:
        The adaptation.

      • getAdaptationOrBuilder

        public SpeechAdaptationOrBuilder getAdaptationOrBuilder()
         Speech adaptation configuration improves the accuracy of speech
 recognition. For more information, see the [speech
 adaptation](https://cloud.google.com/speech-to-text/docs/adaptation)
 documentation.
 When speech adaptation is set it supersedes the `speech_contexts` field.
        .google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;
        Specified by:
        getAdaptationOrBuilder in interface RecognitionConfigOrBuilder

      • hasTranscriptNormalization

        public boolean hasTranscriptNormalization()
         Use transcription normalization to automatically replace parts of the
 transcript with phrases of your choosing. For StreamingRecognize, this
 normalization only applies to stable partial transcripts (stability > 0.8)
 and final transcripts.
        .google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;
        Specified by:
        hasTranscriptNormalization in interface RecognitionConfigOrBuilder
        Returns:
        Whether the transcriptNormalization field is set.

      • getTranscriptNormalization

        public TranscriptNormalization getTranscriptNormalization()
         Use transcription normalization to automatically replace parts of the
 transcript with phrases of your choosing. For StreamingRecognize, this
 normalization only applies to stable partial transcripts (stability > 0.8)
 and final transcripts.
        .google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;
        Specified by:
        getTranscriptNormalization in interface RecognitionConfigOrBuilder
        Returns:
        The transcriptNormalization.

      • getTranscriptNormalizationOrBuilder

        public TranscriptNormalizationOrBuilder getTranscriptNormalizationOrBuilder()
         Use transcription normalization to automatically replace parts of the
 transcript with phrases of your choosing. For StreamingRecognize, this
 normalization only applies to stable partial transcripts (stability > 0.8)
 and final transcripts.
        .google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;
        Specified by:
        getTranscriptNormalizationOrBuilder in interface RecognitionConfigOrBuilder

      • getSpeechContextsList

        public List<SpeechContext> getSpeechContextsList()
         Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
 A means to provide context to assist the speech recognition. For more
 information, see
 [speech
 adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
        repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;
        Specified by:
        getSpeechContextsList in interface RecognitionConfigOrBuilder

      • getSpeechContextsOrBuilderList

        public List<? extends SpeechContextOrBuilder> getSpeechContextsOrBuilderList()
         Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
 A means to provide context to assist the speech recognition. For more
 information, see
 [speech
 adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
        repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;
        Specified by:
        getSpeechContextsOrBuilderList in interface RecognitionConfigOrBuilder

      • getSpeechContextsCount

        public int getSpeechContextsCount()
         Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
 A means to provide context to assist the speech recognition. For more
 information, see
 [speech
 adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
        repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;
        Specified by:
        getSpeechContextsCount in interface RecognitionConfigOrBuilder

      • getSpeechContexts

        public SpeechContext getSpeechContexts​(int index)
         Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
 A means to provide context to assist the speech recognition. For more
 information, see
 [speech
 adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
        repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;
        Specified by:
        getSpeechContexts in interface RecognitionConfigOrBuilder

      • getSpeechContextsOrBuilder

        public SpeechContextOrBuilder getSpeechContextsOrBuilder​(int index)
         Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext].
 A means to provide context to assist the speech recognition. For more
 information, see
 [speech
 adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
        repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;
        Specified by:
        getSpeechContextsOrBuilder in interface RecognitionConfigOrBuilder

      • 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 = 8;
        Specified by:
        getEnableWordTimeOffsets in interface RecognitionConfigOrBuilder
        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 = 15;
        Specified by:
        getEnableWordConfidence in interface RecognitionConfigOrBuilder
        Returns:
        The enableWordConfidence.

      • getEnableAutomaticPunctuation

        public boolean getEnableAutomaticPunctuation()
         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.
        bool enable_automatic_punctuation = 11;
        Specified by:
        getEnableAutomaticPunctuation in interface RecognitionConfigOrBuilder
        Returns:
        The enableAutomaticPunctuation.

      • hasEnableSpokenPunctuation

        public boolean hasEnableSpokenPunctuation()
         The spoken punctuation behavior for the call
 If not set, uses default behavior based on model of choice
 e.g. command_and_search will enable spoken punctuation by default
 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.
        .google.protobuf.BoolValue enable_spoken_punctuation = 22;
        Specified by:
        hasEnableSpokenPunctuation in interface RecognitionConfigOrBuilder
        Returns:
        Whether the enableSpokenPunctuation field is set.

      • getEnableSpokenPunctuation

        public com.google.protobuf.BoolValue getEnableSpokenPunctuation()
         The spoken punctuation behavior for the call
 If not set, uses default behavior based on model of choice
 e.g. command_and_search will enable spoken punctuation by default
 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.
        .google.protobuf.BoolValue enable_spoken_punctuation = 22;
        Specified by:
        getEnableSpokenPunctuation in interface RecognitionConfigOrBuilder
        Returns:
        The enableSpokenPunctuation.

      • getEnableSpokenPunctuationOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getEnableSpokenPunctuationOrBuilder()
         The spoken punctuation behavior for the call
 If not set, uses default behavior based on model of choice
 e.g. command_and_search will enable spoken punctuation by default
 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.
        .google.protobuf.BoolValue enable_spoken_punctuation = 22;
        Specified by:
        getEnableSpokenPunctuationOrBuilder in interface RecognitionConfigOrBuilder

      • hasEnableSpokenEmojis

        public boolean hasEnableSpokenEmojis()
         The spoken emoji behavior for the call
 If not set, uses default behavior based on model of choice
 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.
        .google.protobuf.BoolValue enable_spoken_emojis = 23;
        Specified by:
        hasEnableSpokenEmojis in interface RecognitionConfigOrBuilder
        Returns:
        Whether the enableSpokenEmojis field is set.

      • getEnableSpokenEmojis

        public com.google.protobuf.BoolValue getEnableSpokenEmojis()
         The spoken emoji behavior for the call
 If not set, uses default behavior based on model of choice
 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.
        .google.protobuf.BoolValue enable_spoken_emojis = 23;
        Specified by:
        getEnableSpokenEmojis in interface RecognitionConfigOrBuilder
        Returns:
        The enableSpokenEmojis.

      • getEnableSpokenEmojisOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getEnableSpokenEmojisOrBuilder()
         The spoken emoji behavior for the call
 If not set, uses default behavior based on model of choice
 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.
        .google.protobuf.BoolValue enable_spoken_emojis = 23;
        Specified by:
        getEnableSpokenEmojisOrBuilder in interface RecognitionConfigOrBuilder

      • getEnableSpeakerDiarization

        @Deprecated
public boolean getEnableSpeakerDiarization()
        Deprecated.
        google.cloud.speech.v1p1beta1.RecognitionConfig.enable_speaker_diarization is deprecated. See google/cloud/speech/v1p1beta1/cloud_speech.proto;l=401
         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: Use diarization_config instead.
        bool enable_speaker_diarization = 16 [deprecated = true];
        Specified by:
        getEnableSpeakerDiarization in interface RecognitionConfigOrBuilder
        Returns:
        The enableSpeakerDiarization.

      • getDiarizationSpeakerCount

        @Deprecated
public int getDiarizationSpeakerCount()
        Deprecated.
        google.cloud.speech.v1p1beta1.RecognitionConfig.diarization_speaker_count is deprecated. See google/cloud/speech/v1p1beta1/cloud_speech.proto;l=406
         If set, specifies the estimated number of speakers in the conversation.
 Defaults to '2'. Ignored unless enable_speaker_diarization is set to true.
 Note: Use diarization_config instead.
        int32 diarization_speaker_count = 17 [deprecated = true];
        Specified by:
        getDiarizationSpeakerCount in interface RecognitionConfigOrBuilder
        Returns:
        The diarizationSpeakerCount.

      • hasDiarizationConfig

        public boolean hasDiarizationConfig()
         Config to enable speaker diarization and set additional
 parameters to make diarization better suited for your application.
 Note: 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.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;
        Specified by:
        hasDiarizationConfig in interface RecognitionConfigOrBuilder
        Returns:
        Whether the diarizationConfig field is set.

      • getDiarizationConfig

        public SpeakerDiarizationConfig getDiarizationConfig()
         Config to enable speaker diarization and set additional
 parameters to make diarization better suited for your application.
 Note: 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.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;
        Specified by:
        getDiarizationConfig in interface RecognitionConfigOrBuilder
        Returns:
        The diarizationConfig.

      • getDiarizationConfigOrBuilder

        public SpeakerDiarizationConfigOrBuilder getDiarizationConfigOrBuilder()
         Config to enable speaker diarization and set additional
 parameters to make diarization better suited for your application.
 Note: 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.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;
        Specified by:
        getDiarizationConfigOrBuilder in interface RecognitionConfigOrBuilder

      • hasMetadata

        public boolean hasMetadata()
         Metadata regarding this request.
        .google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;
        Specified by:
        hasMetadata in interface RecognitionConfigOrBuilder
        Returns:
        Whether the metadata field is set.

      • getModel

        public String getModel()
         Which model to select for the given request. Select the model
 best suited to your domain to get best results. If a model is not
 explicitly specified, then we auto-select a model based on the parameters
 in the RecognitionConfig.
 <table>
   <tr>
     <td><b>Model</b></td>
     <td><b>Description</b></td>
   </tr>
   <tr>
     <td><code>latest_long</code></td>
     <td>Best for long form content like media or conversation.</td>
   </tr>
   <tr>
     <td><code>latest_short</code></td>
     <td>Best for short form content like commands or single shot directed
     speech.</td>
   </tr>
   <tr>
     <td><code>command_and_search</code></td>
     <td>Best for short queries such as voice commands or voice search.</td>
   </tr>
   <tr>
     <td><code>phone_call</code></td>
     <td>Best for audio that originated from a phone call (typically
     recorded at an 8khz sampling rate).</td>
   </tr>
   <tr>
     <td><code>video</code></td>
     <td>Best for audio that originated from video or includes multiple
         speakers. Ideally the audio is recorded at a 16khz or greater
         sampling rate. This is a premium model that costs more than the
         standard rate.</td>
   </tr>
   <tr>
     <td><code>default</code></td>
     <td>Best for audio that is not one of the specific audio models.
         For example, long-form audio. Ideally the audio is high-fidelity,
         recorded at a 16khz or greater sampling rate.</td>
   </tr>
   <tr>
     <td><code>medical_conversation</code></td>
     <td>Best for audio that originated from a conversation between a
         medical provider and patient.</td>
   </tr>
   <tr>
     <td><code>medical_dictation</code></td>
     <td>Best for audio that originated from dictation notes by a medical
         provider.</td>
   </tr>
 </table>
        string model = 13;
        Specified by:
        getModel in interface RecognitionConfigOrBuilder
        Returns:
        The model.

      • getModelBytes

        public com.google.protobuf.ByteString getModelBytes()
         Which model to select for the given request. Select the model
 best suited to your domain to get best results. If a model is not
 explicitly specified, then we auto-select a model based on the parameters
 in the RecognitionConfig.
 <table>
   <tr>
     <td><b>Model</b></td>
     <td><b>Description</b></td>
   </tr>
   <tr>
     <td><code>latest_long</code></td>
     <td>Best for long form content like media or conversation.</td>
   </tr>
   <tr>
     <td><code>latest_short</code></td>
     <td>Best for short form content like commands or single shot directed
     speech.</td>
   </tr>
   <tr>
     <td><code>command_and_search</code></td>
     <td>Best for short queries such as voice commands or voice search.</td>
   </tr>
   <tr>
     <td><code>phone_call</code></td>
     <td>Best for audio that originated from a phone call (typically
     recorded at an 8khz sampling rate).</td>
   </tr>
   <tr>
     <td><code>video</code></td>
     <td>Best for audio that originated from video or includes multiple
         speakers. Ideally the audio is recorded at a 16khz or greater
         sampling rate. This is a premium model that costs more than the
         standard rate.</td>
   </tr>
   <tr>
     <td><code>default</code></td>
     <td>Best for audio that is not one of the specific audio models.
         For example, long-form audio. Ideally the audio is high-fidelity,
         recorded at a 16khz or greater sampling rate.</td>
   </tr>
   <tr>
     <td><code>medical_conversation</code></td>
     <td>Best for audio that originated from a conversation between a
         medical provider and patient.</td>
   </tr>
   <tr>
     <td><code>medical_dictation</code></td>
     <td>Best for audio that originated from dictation notes by a medical
         provider.</td>
   </tr>
 </table>
        string model = 13;
        Specified by:
        getModelBytes in interface RecognitionConfigOrBuilder
        Returns:
        The bytes for model.

      • getUseEnhanced

        public boolean getUseEnhanced()
         Set to true to use an enhanced model for speech recognition.
 If `use_enhanced` is set to true and the `model` field is not set, then
 an appropriate enhanced model is chosen if an enhanced model exists for
 the audio.

 If `use_enhanced` is true and an enhanced version of the specified model
 does not exist, then the speech is recognized using the standard version
 of the specified model.
        bool use_enhanced = 14;
        Specified by:
        getUseEnhanced in interface RecognitionConfigOrBuilder
        Returns:
        The useEnhanced.

      • 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 RecognitionConfig parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static RecognitionConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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