com.google.cloud.dialogflow.v2.SpeechToTextConfigOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2/audio_config.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dialogflow.v2;
public interface SpeechToTextConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.SpeechToTextConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The speech model used in speech to text.
* `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as
* `USE_ENHANCED`. It can be overridden in
* [AnalyzeContentRequest][google.cloud.dialogflow.v2.AnalyzeContentRequest]
* and
* [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest]
* request. If enhanced model variant is specified and an enhanced version of
* the specified model for the language does not exist, then it would emit an
* error.
*
*
* .google.cloud.dialogflow.v2.SpeechModelVariant speech_model_variant = 1;
*
* @return The enum numeric value on the wire for speechModelVariant.
*/
int getSpeechModelVariantValue();
/**
*
*
*
* The speech model used in speech to text.
* `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as
* `USE_ENHANCED`. It can be overridden in
* [AnalyzeContentRequest][google.cloud.dialogflow.v2.AnalyzeContentRequest]
* and
* [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest]
* request. If enhanced model variant is specified and an enhanced version of
* the specified model for the language does not exist, then it would emit an
* error.
*
*
* .google.cloud.dialogflow.v2.SpeechModelVariant speech_model_variant = 1;
*
* @return The speechModelVariant.
*/
com.google.cloud.dialogflow.v2.SpeechModelVariant getSpeechModelVariant();
/**
*
*
*
* Which Speech model to select. Select the
* model best suited to your domain to get best results. If a model is not
* explicitly specified, then Dialogflow auto-selects a model based on other
* parameters in the SpeechToTextConfig and Agent settings.
* If enhanced speech model is enabled for the agent and an enhanced
* version of the specified model for the language does not exist, then the
* speech is recognized using the standard version of the specified model.
* Refer to
* [Cloud Speech API
* documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)
* for more details.
* If you specify a model, the following models typically have the best
* performance:
*
* - phone_call (best for Agent Assist and telephony)
* - latest_short (best for Dialogflow non-telephony)
* - command_and_search
*
* Leave this field unspecified to use
* [Agent Speech
* settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech)
* for model selection.
*
*
* string model = 2;
*
* @return The model.
*/
java.lang.String getModel();
/**
*
*
*
* Which Speech model to select. Select the
* model best suited to your domain to get best results. If a model is not
* explicitly specified, then Dialogflow auto-selects a model based on other
* parameters in the SpeechToTextConfig and Agent settings.
* If enhanced speech model is enabled for the agent and an enhanced
* version of the specified model for the language does not exist, then the
* speech is recognized using the standard version of the specified model.
* Refer to
* [Cloud Speech API
* documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)
* for more details.
* If you specify a model, the following models typically have the best
* performance:
*
* - phone_call (best for Agent Assist and telephony)
* - latest_short (best for Dialogflow non-telephony)
* - command_and_search
*
* Leave this field unspecified to use
* [Agent Speech
* settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech)
* for model selection.
*
*
* string model = 2;
*
* @return The bytes for model.
*/
com.google.protobuf.ByteString getModelBytes();
/**
*
*
*
* Audio encoding of the audio content to process.
*
*
* .google.cloud.dialogflow.v2.AudioEncoding audio_encoding = 6;
*
* @return The enum numeric value on the wire for audioEncoding.
*/
int getAudioEncodingValue();
/**
*
*
*
* Audio encoding of the audio content to process.
*
*
* .google.cloud.dialogflow.v2.AudioEncoding audio_encoding = 6;
*
* @return The audioEncoding.
*/
com.google.cloud.dialogflow.v2.AudioEncoding getAudioEncoding();
/**
*
*
*
* Sample rate (in Hertz) of the audio content sent in the query.
* Refer to [Cloud Speech API
* documentation](https://cloud.google.com/speech-to-text/docs/basics) for
* more details.
*
*
* int32 sample_rate_hertz = 7;
*
* @return The sampleRateHertz.
*/
int getSampleRateHertz();
/**
*
*
*
* The language of the supplied audio. Dialogflow does not do
* translations. See [Language
* Support](https://cloud.google.com/dialogflow/docs/reference/language)
* for a list of the currently supported language codes. Note that queries in
* the same session do not necessarily need to specify the same language.
*
*
* string language_code = 8;
*
* @return The languageCode.
*/
java.lang.String getLanguageCode();
/**
*
*
*
* The language of the supplied audio. Dialogflow does not do
* translations. See [Language
* Support](https://cloud.google.com/dialogflow/docs/reference/language)
* for a list of the currently supported language codes. Note that queries in
* the same session do not necessarily need to specify the same language.
*
*
* string language_code = 8;
*
* @return The bytes for languageCode.
*/
com.google.protobuf.ByteString getLanguageCodeBytes();
/**
*
*
*
* If `true`, Dialogflow returns
* [SpeechWordInfo][google.cloud.dialogflow.v2.SpeechWordInfo] in
* [StreamingRecognitionResult][google.cloud.dialogflow.v2.StreamingRecognitionResult]
* with information about the recognized speech words, e.g. start and end time
* offsets. If false or unspecified, Speech doesn't return any word-level
* information.
*
*
* bool enable_word_info = 9;
*
* @return The enableWordInfo.
*/
boolean getEnableWordInfo();
/**
*
*
*
* Use timeout based endpointing, interpreting endpointer sensitivy as
* seconds of timeout value.
*
*
* bool use_timeout_based_endpointing = 11;
*
* @return The useTimeoutBasedEndpointing.
*/
boolean getUseTimeoutBasedEndpointing();
}