Class: Telnyx::Models::Calls::TranscriptionEngineAConfig

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::TranscriptionEngineAConfig

Defined in:

lib/telnyx/models/calls/transcription_engine_a_config.rb

Defined Under Namespace

Modules: Model, TranscriptionEngine Classes: SpeechContext

Instance Attribute Summary

• #enable_speaker_diarization ⇒ Boolean^?

  Enables speaker diarization.

• #hints ⇒ Array<String>^?

  Hints to improve transcription accuracy.

• #interim_results ⇒ Boolean^?

  Whether to send also interim results.

• #language ⇒ Symbol, ...

  Language to use for speech recognition.

• #max_speaker_count ⇒ Integer^?

  Defines maximum number of speakers in the conversation.

• #min_speaker_count ⇒ Integer^?

  Defines minimum number of speakers in the conversation.

• #model ⇒ Symbol, ...

  The model to use for transcription.

• #profanity_filter ⇒ Boolean^?

  Enables profanity_filter.

• #speech_context ⇒ Array<Telnyx::Models::Calls::TranscriptionEngineAConfig::SpeechContext>^?

  Speech context to improve transcription accuracy.

• #transcription_engine ⇒ Symbol, ...

  Engine identifier for Google transcription service.

• #use_enhanced ⇒ Boolean^?

  Enables enhanced transcription, this works for models ‘phone_call` and `video`.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(boost: nil, phrases: nil) ⇒ Object constructor

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(boost: nil, phrases: nil) ⇒ Object

Parameters:

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

  Boost factor for the speech context.

• phrases (Array<String>) (defaults to: nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 76

Instance Attribute Details

#enable_speaker_diarization ⇒ Boolean^?

Enables speaker diarization.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 11

optional :enable_speaker_diarization, Telnyx::Internal::Type::Boolean

#hints ⇒ Array<String>^?

Hints to improve transcription accuracy.

Returns:

• (Array<String>, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 17

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

#interim_results ⇒ Boolean^?

Whether to send also interim results. If set to false, only final results will be sent.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 24

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

#language ⇒ Symbol, ...

Language to use for speech recognition

Returns:

• (Symbol, Telnyx::Models::Calls::GoogleTranscriptionLanguage, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 30

optional :language, enum: -> { Telnyx::Calls::GoogleTranscriptionLanguage }

#max_speaker_count ⇒ Integer^?

Defines maximum number of speakers in the conversation.

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 36

optional :max_speaker_count, Integer

#min_speaker_count ⇒ Integer^?

Defines minimum number of speakers in the conversation.

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 42

optional :min_speaker_count, Integer

#model ⇒ Symbol, ...

The model to use for transcription.

Returns:

• (Symbol, Telnyx::Models::Calls::TranscriptionEngineAConfig::Model, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 48

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

#profanity_filter ⇒ Boolean^?

Enables profanity_filter.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 54

optional :profanity_filter, Telnyx::Internal::Type::Boolean

#speech_context ⇒ Array<Telnyx::Models::Calls::TranscriptionEngineAConfig::SpeechContext>^?

Speech context to improve transcription accuracy.

Returns:

• (Array<Telnyx::Models::Calls::TranscriptionEngineAConfig::SpeechContext>, nil)

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

optional :speech_context,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::TranscriptionEngineAConfig::SpeechContext] }

#transcription_engine ⇒ Symbol, ...

Engine identifier for Google transcription service

Returns:

• (Symbol, Telnyx::Models::Calls::TranscriptionEngineAConfig::TranscriptionEngine, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 67

optional :transcription_engine,
enum: -> { Telnyx::Calls::TranscriptionEngineAConfig::TranscriptionEngine }

#use_enhanced ⇒ Boolean^?

Enables enhanced transcription, this works for models ‘phone_call` and `video`.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 74

optional :use_enhanced, Telnyx::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/calls/transcription_engine_a_config.rb', line 117