Class: Telnyx::Models::AI::TranscriptionSettings

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/transcription_settings.rb,
sig/telnyx/models/ai/transcription_settings.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(api_key_ref: nil, language: nil, model: nil, region: nil, settings: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::TranscriptionSettings for more details.

Parameters:

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

    Integration secret identifier for the transcription provider API key. Currently

  • 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::AI::TranscriptionSettings::Model) (defaults to: nil) —

    The speech to text model to be used by the voice assistant. All Deepgram models

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

    Region on third party cloud providers (currently Azure) if using one of their mo

  • settings (Telnyx::Models::AI::TranscriptionSettingsConfig) (defaults to: nil) 



# File 'lib/telnyx/models/ai/transcription_settings.rb', line 73

Instance Attribute Details

#api_key_ref ⇒ String?

Integration secret identifier for the transcription provider API key. Currently used for Azure transcription regions that require a customer-provided API key.

Parameters:

  • (String)

Returns:

  • (String, nil) 


12
 
# File 'lib/telnyx/models/ai/transcription_settings.rb', line 12

optional :api_key_ref, String

#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. 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 and soniox/stt-rt-v5, auto omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. en, es) bias detection toward that language; settings.language_hints can pin multiple languages at once instead. 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. For cohere/ar-stt, supported values are ar and en; unlike other models, this model does not auto-detect and defaults to ar when language is omitted.

Parameters:

  • (String)

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/ai/transcription_settings.rb', line 34

optional :language, String

#model ⇒ Symbol, ...

The speech to text model to be used by the voice assistant. All Deepgram models are run on-premise.

  • deepgram/flux is optimized for turn-taking with multilingual language hints.
  • deepgram/nova-3 is multilingual with automatic language detection.
  • deepgram/nova-2 is Deepgram's previous-generation multilingual model.
  • azure/fast is a multilingual Azure transcription model.
  • assemblyai/universal-streaming is a multilingual streaming model with configurable turn detection.
  • xai/grok-stt is a multilingual Grok STT model.
  • soniox/stt-rt-v4 and soniox/stt-rt-v5 are multilingual streaming models with automatic language detection, configurable endpointing, term biasing (context), and language_hints.
  • nvidia/parakeet-v3 is a multilingual transcription model with automatic language detection.
  • humain/realtime is a streaming model with native Arabic and Arabic/English code-switching support.
  • reson8/turns is a turn-based streaming model covering 10 European languages with automatic language detection.
  • cohere/ar-stt is a non-streaming Arabic and English transcription model.

Returns:



59
 
# File 'lib/telnyx/models/ai/transcription_settings.rb', line 59

optional :model, enum: -> { Telnyx::AI::TranscriptionSettings::Model }

#region ⇒ String?

Region on third party cloud providers (currently Azure) if using one of their models. Some regions require api_key_ref.

Parameters:

  • (String)

Returns:

  • (String, nil) 


66
 
# File 'lib/telnyx/models/ai/transcription_settings.rb', line 66

optional :region, String

#settings ⇒ Telnyx::Models::AI::TranscriptionSettingsConfig?

Returns:



71
 
# File 'lib/telnyx/models/ai/transcription_settings.rb', line 71

optional :settings, -> { Telnyx::AI::TranscriptionSettingsConfig }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/telnyx/models/ai/transcription_settings.rbs', line 46

def to_hash: -> {