RecognitionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Provides information to the recognizer that specifies how to process the request.
Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Name | Description | ||||||||||
encoding |
google.cloud.speech_v1.types.RecognitionConfig.AudioEncoding
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.
| ||||||||||
sample_rate_hertz |
int
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.
| ||||||||||
audio_channel_count |
int
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 |
str
Required. The language of the supplied audio as a BCP-47 __
language tag. Example: "en-US". See `Language
Support | ||||||||||
max_alternatives |
int
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.
| ||||||||||
speech_contexts |
Sequence[google.cloud.speech_v1.types.SpeechContext]
Array of 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_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. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. | ||||||||||
diarization_config |
google.cloud.speech_v1.types.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 |
google.cloud.speech_v1.types.RecognitionMetadata
Metadata regarding this request. | ||||||||||
model |
str
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. .. raw:: html
| ||||||||||
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.
|
Classes
AudioEncoding
AudioEncoding(value)
The encoding of the audio data sent in the request.
All encodings support only 1 channel (mono) audio, unless the
audio_channel_count
and
enable_separate_recognition_per_channel
fields are set.
For best results, the audio source should be captured and
transmitted using a lossless encoding (FLAC
or LINEAR16
).
The accuracy of the speech recognition can be reduced if lossy
codecs are used to capture or transmit audio, particularly if
background noise is present. Lossy codecs include MULAW
,
AMR
, AMR_WB
, OGG_OPUS
, SPEEX_WITH_HEADER_BYTE
, and
MP3
.
The FLAC
and WAV
audio file formats include a header that
describes the included audio content. You can request recognition
for WAV
files that contain either LINEAR16
or MULAW
encoded audio. If you send FLAC
or WAV
audio file format in
your request, you do not need to specify an AudioEncoding
; the
audio encoding format is determined from the file header. If you
specify an AudioEncoding
when you send send FLAC
or WAV
audio, the encoding configuration must match the encoding described
in the audio header; otherwise the request returns an
google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]
error code.