Struct google_cognitive_apis::api::grpc::google::cloud::speechtotext::v1p1beta1::RecognitionConfig
source · [−]pub struct RecognitionConfig {Show 21 fields
pub encoding: i32,
pub sample_rate_hertz: i32,
pub audio_channel_count: i32,
pub enable_separate_recognition_per_channel: bool,
pub language_code: String,
pub alternative_language_codes: Vec<String>,
pub max_alternatives: i32,
pub profanity_filter: bool,
pub adaptation: Option<SpeechAdaptation>,
pub speech_contexts: Vec<SpeechContext>,
pub enable_word_time_offsets: bool,
pub enable_word_confidence: bool,
pub enable_automatic_punctuation: bool,
pub enable_spoken_punctuation: Option<bool>,
pub enable_spoken_emojis: Option<bool>,
pub enable_speaker_diarization: bool,
pub diarization_speaker_count: i32,
pub diarization_config: Option<SpeakerDiarizationConfig>,
pub metadata: Option<RecognitionMetadata>,
pub model: String,
pub use_enhanced: bool,
}
Expand description
Provides information to the recognizer that specifies how to process the request.
Fields
encoding: i32
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].
sample_rate_hertz: i32
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].
audio_channel_count: i32
The number of channels in the input audio data.
ONLY set this for MULTI-CHANNEL recognition.
Valid values for LINEAR16 and FLAC are 1
-8
.
Valid values for OGG_OPUS are ‘1’-‘254’.
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’.
enable_separate_recognition_per_channel: bool
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.
language_code: String
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 for a list of the currently supported language codes.
alternative_language_codes: Vec<String>
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 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).
max_alternatives: i32
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.
profanity_filter: bool
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.
adaptation: Option<SpeechAdaptation>
Speech adaptation configuration improves the accuracy of speech
recognition. When speech adaptation is set it supersedes the
speech_contexts
field. For more information, see the speech
adaptation
documentation.
speech_contexts: Vec<SpeechContext>
Array of [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. A means to provide context to assist the speech recognition. For more information, see speech adaptation.
enable_word_time_offsets: bool
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
.
enable_word_confidence: bool
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
.
enable_automatic_punctuation: bool
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.
enable_spoken_punctuation: Option<bool>
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.
enable_spoken_emojis: Option<bool>
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.
enable_speaker_diarization: bool
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.
diarization_speaker_count: i32
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.
diarization_config: Option<SpeakerDiarizationConfig>
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.
metadata: Option<RecognitionMetadata>
Metadata regarding this request.
model: String
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.
Model | Description |
command_and_search |
Best for short queries such as voice commands or voice search. |
phone_call |
Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). |
video |
Best for audio that originated from 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. |
default |
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. |
use_enhanced: bool
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.
Implementations
sourceimpl RecognitionConfig
impl RecognitionConfig
sourcepub fn encoding(&self) -> AudioEncoding
pub fn encoding(&self) -> AudioEncoding
Returns the enum value of encoding
, or the default if the field is set to an invalid enum value.
sourcepub fn set_encoding(&mut self, value: AudioEncoding)
pub fn set_encoding(&mut self, value: AudioEncoding)
Sets encoding
to the provided enum value.
Trait Implementations
sourceimpl Clone for RecognitionConfig
impl Clone for RecognitionConfig
sourcefn clone(&self) -> RecognitionConfig
fn clone(&self) -> RecognitionConfig
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for RecognitionConfig
impl Debug for RecognitionConfig
sourceimpl Default for RecognitionConfig
impl Default for RecognitionConfig
sourceimpl Into<RecognitionConfig> for RecognitionConfig
impl Into<RecognitionConfig> for RecognitionConfig
sourcefn into(self) -> GrpcRecognitionConfig
fn into(self) -> GrpcRecognitionConfig
Converts this type into the (usually inferred) input type.
sourceimpl Message for RecognitionConfig
impl Message for RecognitionConfig
sourcefn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Returns the encoded length of the message without a length delimiter.
sourcefn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
Encodes the message to a buffer. Read more
sourcefn encode_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn encode_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Encodes the message to a newly allocated buffer.
sourcefn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
Encodes the message with a length-delimiter to a buffer. Read more
sourcefn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Encodes the message with a length-delimiter to a newly allocated buffer.
sourcefn decode<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
Decodes an instance of the message from a buffer. Read more
sourcefn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
Decodes a length-delimited instance of the message from the buffer.
sourcefn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
Decodes an instance of the message from a buffer, and merges it into self
. Read more
sourcefn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
sourceimpl PartialEq<RecognitionConfig> for RecognitionConfig
impl PartialEq<RecognitionConfig> for RecognitionConfig
sourcefn eq(&self, other: &RecognitionConfig) -> bool
fn eq(&self, other: &RecognitionConfig) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
impl StructuralPartialEq for RecognitionConfig
Auto Trait Implementations
impl RefUnwindSafe for RecognitionConfig
impl Send for RecognitionConfig
impl Sync for RecognitionConfig
impl Unpin for RecognitionConfig
impl UnwindSafe for RecognitionConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
sourcefn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message T
in a tonic::Request