Class: Telnyx::Models::Calls::TranscriptionConfig

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/calls/transcription_config.rb,
sig/telnyx/models/calls/transcription_config.rbs

Defined Under Namespace

Modules: Model

Instance Attribute Summary collapse

Instance Method Summary collapse

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(language: nil, model: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Calls::TranscriptionConfig for more details.

The settings associated with speech to text for the voice assistant. This is only relevant if the assistant uses a text-to-text language model. Any assistant using a model with native audio support (e.g. fixie-ai/ultravox-v0_4) will ignore this field.

Parameters:

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

    The language of the audio to be transcribed. If not set, or if set to auto, su

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

    The speech to text model to be used by the voice assistant. Supported models inc




# File 'lib/telnyx/models/calls/transcription_config.rb', line 59

Instance Attribute Details

#language ⇒ String?

The language of the audio to be transcribed. If not set, or if set to auto, supported models will automatically detect the language. Supported and meaningful values depend on the selected transcription model. For deepgram/flux, supported values are: auto (Telnyx language detection controls the language hint), multi (no language hint), and language-specific hints en, es, fr, de, hi, ru, pt, ja, it, and nl. For soniox/stt-rt-v4, auto omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. en, es) bias detection toward that language. For assemblyai/universal-streaming, auto (or unset) enables native multilingual code-switching; ISO 639-1 codes (en, es, de, fr, pt, it, tr, nl, sv, no, da, fi, hi, vi, ar, he, ja, zh) bias the session to that language. For humain/realtime, supported values are ar, en, codeswitch (Arabic/English code-switching), and auto (resolves server-side to code-switching). Unlike other models, humain/realtime does not fall back to auto when language is omitted — omitting it applies en instead. For reson8/turns, supported values are auto (or unset) for automatic language detection, and the language codes nl, en, fr, fy, de, it, pl, pt, es, and sv to fix the transcription language.

Parameters:

  • (String)

Returns:

  • (String, nil) 


28
 
# File 'lib/telnyx/models/calls/transcription_config.rb', line 28

optional :language, String

#model ⇒ Symbol, ...

The speech to text model to be used by the voice assistant. Supported models include:

  • deepgram/flux (or flux) for live streaming turn-taking.
  • deepgram/nova-3 and deepgram/nova-2 for live streaming transcription.
  • speechmatics/standard and speechmatics/enhanced for live streaming transcription.
  • assemblyai/universal-streaming for live streaming transcription.
  • xai/grok-stt for live streaming transcription.
  • soniox/stt-rt-v4 for live streaming multilingual transcription with automatic language detection.
  • nvidia/parakeet-v3 for multilingual transcription with automatic language detection.
  • humain/realtime for live streaming transcription with native Arabic and Arabic/English code-switching support.
  • reson8/turns for live streaming turn-based transcription of 10 European languages with automatic language detection.
  • azure/fast and azure/realtime; Azure models require region, and unsupported regions require api_key_ref.
  • google/latest_long for non-streaming multilingual transcription.
  • distil-whisper/distil-large-v2 for lower-latency English-only non-streaming transcription.
  • openai/whisper-large-v3-turbo for multilingual non-streaming transcription with automatic language detection.

Returns:



57
 
# File 'lib/telnyx/models/calls/transcription_config.rb', line 57

optional :model, enum: -> { Telnyx::Calls::TranscriptionConfig::Model }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


26
 
# File 'sig/telnyx/models/calls/transcription_config.rbs', line 26

def to_hash: -> {