Interface RecognitionFeaturesOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RecognitionFeatures, RecognitionFeatures.Builder

    public interface RecognitionFeaturesOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      SpeakerDiarizationConfig getDiarizationConfig()
      Configuration to enable speaker diarization and set additional parameters to make diarization better suited for your application.
      SpeakerDiarizationConfigOrBuilder getDiarizationConfigOrBuilder()
      Configuration to enable speaker diarization and set additional parameters to make diarization better suited for your application.
      boolean getEnableAutomaticPunctuation()
      If `true`, adds punctuation to recognition result hypotheses.
      boolean getEnableSpokenEmojis()
      The spoken emoji behavior for the call.
      boolean getEnableSpokenPunctuation()
      The spoken punctuation behavior for the call.
      boolean getEnableWordConfidence()
      If `true`, the top result includes a list of words and the confidence for those words.
      boolean getEnableWordTimeOffsets()
      If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words.
      int getMaxAlternatives()
      Maximum number of recognition hypotheses to be returned.
      RecognitionFeatures.MultiChannelMode getMultiChannelMode()
      Mode for recognizing multi-channel audio.
      int getMultiChannelModeValue()
      Mode for recognizing multi-channel audio.
      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***".
      boolean hasDiarizationConfig()
      Configuration to enable speaker diarization and set additional parameters to make diarization better suited for your application.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • 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, for instance, "f***". If set to `false` or omitted, profanities
         won't be filtered out.
         
        bool profanity_filter = 1;
        Returns:
        The profanityFilter.
      • 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 = 2;
        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 = 3;
        Returns:
        The enableWordConfidence.
      • getEnableAutomaticPunctuation

        boolean getEnableAutomaticPunctuation()
         If `true`, adds punctuation to recognition result hypotheses. This feature
         is only available in select languages. The default `false` value does not
         add punctuation to result hypotheses.
         
        bool enable_automatic_punctuation = 4;
        Returns:
        The enableAutomaticPunctuation.
      • getEnableSpokenPunctuation

        boolean getEnableSpokenPunctuation()
         The spoken punctuation behavior for the call. If `true`, replaces spoken
         punctuation with the corresponding symbols in the request. For example,
         "how are you question mark" becomes "how are you?". See
         https://cloud.google.com/speech-to-text/docs/spoken-punctuation for
         support. If `false`, spoken punctuation is not replaced.
         
        bool enable_spoken_punctuation = 14;
        Returns:
        The enableSpokenPunctuation.
      • getEnableSpokenEmojis

        boolean getEnableSpokenEmojis()
         The spoken emoji behavior for the call. If `true`, adds spoken emoji
         formatting for the request. This will replace spoken emojis with the
         corresponding Unicode symbols in the final transcript. If `false`, spoken
         emojis are not replaced.
         
        bool enable_spoken_emojis = 15;
        Returns:
        The enableSpokenEmojis.
      • getMultiChannelModeValue

        int getMultiChannelModeValue()
         Mode for recognizing multi-channel audio.
         
        .google.cloud.speech.v2.RecognitionFeatures.MultiChannelMode multi_channel_mode = 17;
        Returns:
        The enum numeric value on the wire for multiChannelMode.
      • getMultiChannelMode

        RecognitionFeatures.MultiChannelMode getMultiChannelMode()
         Mode for recognizing multi-channel audio.
         
        .google.cloud.speech.v2.RecognitionFeatures.MultiChannelMode multi_channel_mode = 17;
        Returns:
        The multiChannelMode.
      • hasDiarizationConfig

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

        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;
        Returns:
        The diarizationConfig.
      • getDiarizationConfigOrBuilder

        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;
      • getMaxAlternatives

        int getMaxAlternatives()
         Maximum number of recognition hypotheses to be returned.
         The server may return fewer than `max_alternatives`.
         Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of
         one. If omitted, will return a maximum of one.
         
        int32 max_alternatives = 16;
        Returns:
        The maxAlternatives.