Class: Telnyx::Models::AI::TranscriptionSettingsConfig

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

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(context: nil, eager_eot_threshold: nil, enable_endpoint_detection: nil, end_of_turn_confidence_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, interim_results: nil, keyterm: nil, language_hints: nil, max_endpoint_delay_ms: nil, max_turn_silence: nil, min_turn_silence: nil, numerals: nil, smart_format: nil) ⇒ Object

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

Parameters:

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

    Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A comma-separated list

  • eager_eot_threshold (Float) (defaults to: nil) —

    Available only for deepgram/flux. Confidence threshold for eager end of turn det

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

    Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. When true, Soniox emit

  • end_of_turn_confidence_threshold (Float) (defaults to: nil) —

    Available only for assemblyai/universal-streaming. Confidence level required to

  • eot_threshold (Float) (defaults to: nil) —

    Available only for deepgram/flux. Confidence required to trigger an end of turn.

  • eot_timeout_ms (Integer) (defaults to: nil) —

    Available only for deepgram/flux. Maximum milliseconds of silence before forcing

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

    Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. When true, Soniox stre

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

    Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of

  • language_hints (Array<String>) (defaults to: nil) —

    Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A list of ISO 639-1 la

  • max_endpoint_delay_ms (Integer) (defaults to: nil) —

    Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. Maximum silence (in mi

  • max_turn_silence (Integer) (defaults to: nil) —

    Available only for assemblyai/universal-streaming. Maximum duration of silence i

  • min_turn_silence (Integer) (defaults to: nil) —

    Available only for assemblyai/universal-streaming. Minimum duration of silence i

  • numerals (Boolean) (defaults to: nil)
  • smart_format (Boolean) (defaults to: nil) 



# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 117

Instance Attribute Details

#context ⇒ String?

Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A comma-separated list of terms to boost for recognition during transcription, for staff names, building names, or other domain-specific vocabulary. This field may be templated with dynamic variables using mustache syntax (e.g. Telnyx,{{customer_name}},VoIP). Variables are resolved at call time before the value is sent to Soniox.

Parameters:

  • (String)

Returns:

  • (String, nil) 


17
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 17

optional :context, String

#eager_eot_threshold ⇒ Float?

Available only for deepgram/flux. Confidence threshold for eager end of turn detection. Must be lower than or equal to eot_threshold. Setting this equal to eot_threshold effectively disables eager end of turn.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


25
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 25

optional :eager_eot_threshold, Float

#enable_endpoint_detection ⇒ Boolean?

Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. When true, Soniox emits end-of-utterance events at the cadence configured by max_endpoint_delay_ms.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


33
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 33

optional :enable_endpoint_detection, Telnyx::Internal::Type::Boolean

#end_of_turn_confidence_threshold ⇒ Float?

Available only for assemblyai/universal-streaming. Confidence level required to trigger an end of turn. Higher values require more certainty before ending a turn.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


41
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 41

optional :end_of_turn_confidence_threshold, Float

#eot_threshold ⇒ Float?

Available only for deepgram/flux. Confidence required to trigger an end of turn. Higher values = more reliable turn detection but slightly increased latency.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


48
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 48

optional :eot_threshold, Float

#eot_timeout_ms ⇒ Integer?

Available only for deepgram/flux. Maximum milliseconds of silence before forcing an end of turn, regardless of confidence.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


55
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 55

optional :eot_timeout_ms, Integer

#interim_results ⇒ Boolean?

Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. When true, Soniox streams interim (non-final) results in addition to finalized transcripts.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


62
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 62

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

#keyterm ⇒ String?

Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of key terms to boost for recognition during transcription. Helps improve accuracy for domain-specific terminology, proper nouns, or uncommon words. This field may be templated with dynamic variables using mustache syntax (e.g. Telnyx,{{customer_name}},VoIP). Variables are resolved at call time before the value is sent to the speech-to-text engine.

Parameters:

  • (String)

Returns:

  • (String, nil) 


74
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 74

optional :keyterm, String

#language_hints ⇒ Array<String>?

Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A list of ISO 639-1 language codes (e.g. ["nl", "fr"]) to pin recognition to multiple languages at once, overriding the single hint derived from language.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


82
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 82

optional :language_hints, Telnyx::Internal::Type::ArrayOf[String]

#max_endpoint_delay_ms ⇒ Integer?

Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event. Only honored when enable_endpoint_detection is true.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


90
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 90

optional :max_endpoint_delay_ms, Integer

#max_turn_silence ⇒ Integer?

Available only for assemblyai/universal-streaming. Maximum duration of silence in milliseconds before forcing an end of turn.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


97
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 97

optional :max_turn_silence, Integer

#min_turn_silence ⇒ Integer?

Available only for assemblyai/universal-streaming. Minimum duration of silence in milliseconds before a turn can end. Must be less than or equal to max_turn_silence.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


105
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 105

optional :min_turn_silence, Integer

#numerals ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


110
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 110

optional :numerals, Telnyx::Internal::Type::Boolean

#smart_format ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


115
 
# File 'lib/telnyx/models/ai/transcription_settings_config.rb', line 115

optional :smart_format, Telnyx::Internal::Type::Boolean

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


96
 
# File 'sig/telnyx/models/ai/transcription_settings_config.rbs', line 96

def to_hash: -> {