Class: Telnyx::Models::SpeechToTextTranscribeParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::SpeechToTextTranscribeParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/speech_to_text_transcribe_params.rb

Overview

See Also:

• Resources::SpeechToText#transcribe

Defined Under Namespace

Modules: InputFormat, Model, TranscriptionEngine

Instance Attribute Summary

• #input_format ⇒ Symbol, Telnyx::Models::SpeechToTextTranscribeParams::InputFormat

  The format of input audio stream.

• #interim_results ⇒ Boolean^?

  Whether to receive interim transcription results.

• #language ⇒ String^?

  The language spoken in the audio stream.

• #model ⇒ Symbol, ...

  The specific model to use within the selected transcription engine.

• #transcription_engine ⇒ Symbol, Telnyx::Models::SpeechToTextTranscribeParams::TranscriptionEngine

  The transcription engine to use for processing the audio stream.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(input_format:, transcription_engine:, interim_results: nil, language: nil, model: nil, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(input_format:, transcription_engine:, interim_results: nil, language: nil, model: nil, request_options: {}) ⇒ Object

Parameters:

• input_format (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::InputFormat) —

  The format of input audio stream.

• transcription_engine (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::TranscriptionEngine) —

  The transcription engine to use for processing the audio stream.

• interim_results (Boolean) (defaults to: nil) —

  Whether to receive interim transcription results.

• language (String) (defaults to: nil) —

  The language spoken in the audio stream.

• model (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::Model) (defaults to: nil) —

  The specific model to use within the selected transcription engine.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/telnyx/models/speech_to_text_transcribe_params.rb', line 40

Instance Attribute Details

#input_format ⇒ Symbol, Telnyx::Models::SpeechToTextTranscribeParams::InputFormat

The format of input audio stream.

Returns:

• (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::InputFormat)

# File 'lib/telnyx/models/speech_to_text_transcribe_params.rb', line 14

required :input_format, enum: -> { Telnyx::SpeechToTextTranscribeParams::InputFormat }

#interim_results ⇒ Boolean^?

Whether to receive interim transcription results.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/speech_to_text_transcribe_params.rb', line 26

optional :interim_results, Telnyx::Internal::Type::Boolean

#language ⇒ String^?

The language spoken in the audio stream.

Returns:

• (String, nil)

# File 'lib/telnyx/models/speech_to_text_transcribe_params.rb', line 32

optional :language, String

#model ⇒ Symbol, ...

The specific model to use within the selected transcription engine.

Returns:

• (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::Model, nil)

# File 'lib/telnyx/models/speech_to_text_transcribe_params.rb', line 38

optional :model, enum: -> { Telnyx::SpeechToTextTranscribeParams::Model }

#transcription_engine ⇒ Symbol, Telnyx::Models::SpeechToTextTranscribeParams::TranscriptionEngine

The transcription engine to use for processing the audio stream.

Returns:

• (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::TranscriptionEngine)

# File 'lib/telnyx/models/speech_to_text_transcribe_params.rb', line 20

required :transcription_engine, enum: -> { Telnyx::SpeechToTextTranscribeParams::TranscriptionEngine }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/speech_to_text_transcribe_params.rb', line 60