Package com.google.cloud.speech.v1

Interface RecognitionConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RecognitionConfig, RecognitionConfig.Builder
@Generated public interface RecognitionConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getEncodingValue

      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.v1.RecognitionConfig.AudioEncoding].
      .google.cloud.speech.v1.RecognitionConfig.AudioEncoding encoding = 1;
      Returns:
      The enum numeric value on the wire for encoding.

    • getEncoding

      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.v1.RecognitionConfig.AudioEncoding].
      .google.cloud.speech.v1.RecognitionConfig.AudioEncoding encoding = 1;
      Returns:
      The encoding.

    • getSampleRateHertz

      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.v1.RecognitionConfig.AudioEncoding].
      int32 sample_rate_hertz = 2;
      Returns:
      The sampleRateHertz.

    • getAudioChannelCount

      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;
      Returns:
      The audioChannelCount.

    • getEnableSeparateRecognitionPerChannel

      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;
      Returns:
      The enableSeparateRecognitionPerChannel.

    • getLanguageCode

      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];
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      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];
      Returns:
      The bytes for languageCode.

    • getAlternativeLanguageCodesList

      List<String> 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;
      Returns:
      A list containing the alternativeLanguageCodes.

    • getAlternativeLanguageCodesCount

      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;
      Returns:
      The count of alternativeLanguageCodes.

    • getAlternativeLanguageCodes

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The alternativeLanguageCodes at the given index.

    • getAlternativeLanguageCodesBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the alternativeLanguageCodes at the given index.

    • getMaxAlternatives

      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;
      Returns:
      The maxAlternatives.

    • getProfanityFilter

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

    • hasAdaptation

      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.v1.SpeechAdaptation adaptation = 20;
      Returns:
      Whether the adaptation field is set.

    • getAdaptation

      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.v1.SpeechAdaptation adaptation = 20;
      Returns:
      The adaptation.

    • getAdaptationOrBuilder

      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.v1.SpeechAdaptation adaptation = 20;

    • hasTranscriptNormalization

      boolean hasTranscriptNormalization()
       Optional. 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.v1.TranscriptNormalization transcript_normalization = 24 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the transcriptNormalization field is set.

    • getTranscriptNormalization

      TranscriptNormalization getTranscriptNormalization()
       Optional. 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.v1.TranscriptNormalization transcript_normalization = 24 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The transcriptNormalization.

    • getTranscriptNormalizationOrBuilder

      TranscriptNormalizationOrBuilder getTranscriptNormalizationOrBuilder()
       Optional. 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.v1.TranscriptNormalization transcript_normalization = 24 [(.google.api.field_behavior) = OPTIONAL];

    • getSpeechContextsList

      List<SpeechContext> getSpeechContextsList()
       Array of [SpeechContext][google.cloud.speech.v1.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.v1.SpeechContext speech_contexts = 6;

    • getSpeechContexts

      SpeechContext getSpeechContexts(int index)
       Array of [SpeechContext][google.cloud.speech.v1.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.v1.SpeechContext speech_contexts = 6;

    • getSpeechContextsCount

      int getSpeechContextsCount()
       Array of [SpeechContext][google.cloud.speech.v1.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.v1.SpeechContext speech_contexts = 6;

    • getSpeechContextsOrBuilderList

      List<? extends SpeechContextOrBuilder> getSpeechContextsOrBuilderList()
       Array of [SpeechContext][google.cloud.speech.v1.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.v1.SpeechContext speech_contexts = 6;

    • getSpeechContextsOrBuilder

      SpeechContextOrBuilder getSpeechContextsOrBuilder(int index)
       Array of [SpeechContext][google.cloud.speech.v1.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.v1.SpeechContext speech_contexts = 6;

    • getEnableWordTimeOffsets

      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;
      Returns:
      The enableWordTimeOffsets.

    • getEnableWordConfidence

      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;
      Returns:
      The enableWordConfidence.

    • getEnableAutomaticPunctuation

      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;
      Returns:
      The enableAutomaticPunctuation.

    • hasEnableSpokenPunctuation

      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;
      Returns:
      Whether the enableSpokenPunctuation field is set.

    • getEnableSpokenPunctuation

      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;
      Returns:
      The enableSpokenPunctuation.

    • getEnableSpokenPunctuationOrBuilder

      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;

    • hasEnableSpokenEmojis

      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;
      Returns:
      Whether the enableSpokenEmojis field is set.

    • getEnableSpokenEmojis

      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;
      Returns:
      The enableSpokenEmojis.

    • getEnableSpokenEmojisOrBuilder

      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;

    • hasDiarizationConfig

      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.v1.SpeakerDiarizationConfig diarization_config = 19;
      Returns:
      Whether the diarizationConfig field is set.

    • getDiarizationConfig

      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.v1.SpeakerDiarizationConfig diarization_config = 19;
      Returns:
      The diarizationConfig.

    • getDiarizationConfigOrBuilder

      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.v1.SpeakerDiarizationConfig diarization_config = 19;

    • hasMetadata

      boolean hasMetadata()
       Metadata regarding this request.
      .google.cloud.speech.v1.RecognitionMetadata metadata = 9;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      RecognitionMetadata getMetadata()
       Metadata regarding this request.
      .google.cloud.speech.v1.RecognitionMetadata metadata = 9;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      RecognitionMetadataOrBuilder getMetadataOrBuilder()
       Metadata regarding this request.
      .google.cloud.speech.v1.RecognitionMetadata metadata = 9;

    • getModel

      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;
      Returns:
      The model.

    • getModelBytes

      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;
      Returns:
      The bytes for model.

    • getUseEnhanced

      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;
      Returns:
      The useEnhanced.