com.google.cloud.speech.v1.RecognitionConfigOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-google-cloud-speech-v1 Show documentation
GRPC library for grpc-google-cloud-speech-v1
There is a newer version: 4.44.0
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/speech/v1/cloud_speech.proto

package com.google.cloud.speech.v1;

public interface RecognitionConfigOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.cloud.speech.v1.RecognitionConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
   * 
   *
   * optional .google.cloud.speech.v1.RecognitionConfig.AudioEncoding encoding = 1;
   */
  int getEncodingValue();
  /**
   *    * *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
   * 
   *
   * optional .google.cloud.speech.v1.RecognitionConfig.AudioEncoding encoding = 1;
   */
  com.google.cloud.speech.v1.RecognitionConfig.AudioEncoding getEncoding();

  /**
   *    * *Required* 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).
   * 
   *
   * optional int32 sample_rate_hertz = 2;
   */
  int getSampleRateHertz();

  /**
   *    * *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.
   * 
   *
   * optional string language_code = 3;
   */
  java.lang.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/docs/languages)
   * for a list of the currently supported language codes.
   * 
   *
   * optional string language_code = 3;
   */
  com.google.protobuf.ByteString
      getLanguageCodeBytes();

  /**
   *    * *Optional* 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.
   * 
   *
   * optional int32 max_alternatives = 4;
   */
  int getMaxAlternatives();

  /**
   *    * *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.
   * 
   *
   * optional bool profanity_filter = 5;
   */
  boolean getProfanityFilter();

  /**
   *    * *Optional* A means to provide context to assist the speech recognition.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
   */
  java.util.List 
      getSpeechContextsList();
  /**
   *    * *Optional* A means to provide context to assist the speech recognition.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
   */
  com.google.cloud.speech.v1.SpeechContext getSpeechContexts(int index);
  /**
   *    * *Optional* A means to provide context to assist the speech recognition.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
   */
  int getSpeechContextsCount();
  /**
   *    * *Optional* A means to provide context to assist the speech recognition.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
   */
  java.util.List 
      getSpeechContextsOrBuilderList();
  /**
   *    * *Optional* A means to provide context to assist the speech recognition.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechContext speech_contexts = 6;
   */
  com.google.cloud.speech.v1.SpeechContextOrBuilder getSpeechContextsOrBuilder(
      int index);
}