Struct nvidia_riva::nvidia::riva::asr::RecognitionConfig

pub struct RecognitionConfig {

    pub encoding: i32,
    pub sample_rate_hertz: i32,
    pub language_code: String,
    pub max_alternatives: i32,
    pub profanity_filter: bool,
    pub speech_contexts: Vec<SpeechContext>,
    pub audio_channel_count: i32,
    pub enable_word_time_offsets: bool,
    pub enable_automatic_punctuation: bool,
    pub enable_separate_recognition_per_channel: bool,
    pub model: String,
    pub verbatim_transcripts: bool,
    pub diarization_config: Option<SpeakerDiarizationConfig>,
    pub custom_configuration: HashMap<String, String>,
}

Provides information to the recognizer that specifies how to process the request

Fields

encoding: i32

The encoding of the audio data sent in the request.

All encodings support only 1 channel (mono) audio.

sample_rate_hertz: i32

The sample rate in hertz (Hz) of the audio data sent in the RecognizeRequest or StreamingRecognizeRequest messages. The Riva server will automatically down-sample/up-sample the audio to match the ASR acoustic model sample rate. The sample rate value below 8kHz will not produce any meaningful output.

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”.

max_alternatives: i32

Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of SpeechRecognizeAlternative messages within each SpeechRecognizeResult. The server may return fewer than max_alternatives. If omitted, will return a maximum of one.

profanity_filter: bool

A custom field that enables profanity filtering for the generated transcripts. If set to ‘true’, the server filters out profanities, replacing all but the initial character in each filtered word with asterisks. For example, “x**”. If set to false or omitted, profanities will not be filtered out. The default is false.

speech_contexts: Vec<SpeechContext>

Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see SpeechContext section

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_word_time_offsets: bool

If true, the top result includes a list of words and the start and end time offsets (timestamps), and confidence scores 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. The default ‘false’ value does not add punctuation to result hypotheses.

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.

model: String

Which model to select for the given request. If empty, Riva will select the right model based on the other RecognitionConfig parameters. The model should correspond to the name passed to riva-build with the --name argument

verbatim_transcripts: bool

The verbatim_transcripts flag enables or disable inverse text normalization. ‘true’ returns exactly what was said, with no denormalization. ‘false’ applies inverse text normalization, also this is the default

diarization_config: Option<SpeakerDiarizationConfig>

Config to enable speaker diarization and set additional parameters. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult.

custom_configuration: HashMap<String, String>

Custom fields for passing request-level configuration options to plugins used in the model pipeline.

Implementations

impl RecognitionConfig

pub fn encoding(&self) -> AudioEncoding

Returns the enum value of encoding, or the default if the field is set to an invalid enum value.

pub fn set_encoding(&mut self, value: AudioEncoding)

Sets encoding to the provided enum value.

Trait Implementations

impl Clone for RecognitionConfig

fn clone(&self) -> RecognitionConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecognitionConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RecognitionConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for RecognitionConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<RecognitionConfig> for RecognitionConfig

fn eq(&self, other: &RecognitionConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RecognitionConfig