Class: Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig

Defined in:

lib/telnyx/models/calls/action_start_noise_suppression_params.rb

Defined Under Namespace

Modules: Family, Mode, Model, Size

Instance Attribute Summary

• #attenuation_limit ⇒ Integer^?

  The attenuation limit for noise suppression (0-100).

• #enhancement_level ⇒ Float^?

  Enhancement intensity (0.0-1.0).

• #family ⇒ Symbol, ...

  AiCoustics model family.

• #mode ⇒ Symbol, ...

  Processing mode.

• #model ⇒ Symbol, ...

  The Krisp model to use.

• #size ⇒ Symbol, ...

  AiCoustics model size.

• #suppression_level ⇒ Float^?

  Suppression level (0.0-100.0).

• #voice_gain ⇒ Float^?

  Voice gain multiplier (0.1-4.0).

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(attenuation_limit: nil, enhancement_level: nil, family: nil, mode: nil, model: nil, size: nil, suppression_level: nil, voice_gain: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see NoiseSuppressionEngineConfig for more details.

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(attenuation_limit: nil, enhancement_level: nil, family: nil, mode: nil, model: nil, size: nil, suppression_level: nil, voice_gain: nil) ⇒ Object

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

Configuration parameters for noise suppression engines. Different engines support different parameters.

Parameters:

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

  The attenuation limit for noise suppression (0-100). Only applicable for DeepFil

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

  Enhancement intensity (0.0-1.0). Only applicable for AiCoustics.

• family (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Family) (defaults to: nil) —

  AiCoustics model family. ‘sparrow’ optimized for human-to-human calls, ‘quail’ o

• mode (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Mode) (defaults to: nil) —

  Processing mode. Only applicable for DeepFilterNet.

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

  The Krisp model to use. Only applicable for Krisp.

• size (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Size) (defaults to: nil) —

  AiCoustics model size. ‘s’ and ‘l’ work with both families. ‘xs’ and ‘xxs’ are s

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

  Suppression level (0.0-100.0). Only applicable for Krisp.

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

  Voice gain multiplier (0.1-4.0). Only applicable for AiCoustics.

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 155

Instance Attribute Details

#attenuation_limit ⇒ Integer^?

The attenuation limit for noise suppression (0-100). Only applicable for DeepFilterNet.

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 104

optional :attenuation_limit, Integer

#enhancement_level ⇒ Float^?

Enhancement intensity (0.0-1.0). Only applicable for AiCoustics.

Returns:

• (Float, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 110

optional :enhancement_level, Float

#family ⇒ Symbol, ...

AiCoustics model family. ‘sparrow’ optimized for human-to-human calls, ‘quail’ optimized for Voice AI/STT. Only applicable for AiCoustics.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Family, nil)

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

optional :family,
enum: -> { Telnyx::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Family }

#mode ⇒ Symbol, ...

Processing mode. Only applicable for DeepFilterNet.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Mode, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 124

optional :mode,
enum: -> { Telnyx::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Mode }

#model ⇒ Symbol, ...

The Krisp model to use. Only applicable for Krisp.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Model, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 131

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

#size ⇒ Symbol, ...

AiCoustics model size. ‘s’ and ‘l’ work with both families. ‘xs’ and ‘xxs’ are sparrow-only. ‘vf_l’ and ‘vf_1_1_l’ are quail-only. Only applicable for AiCoustics.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Size, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 140

optional :size,
enum: -> { Telnyx::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig::Size }

#suppression_level ⇒ Float^?

Suppression level (0.0-100.0). Only applicable for Krisp.

Returns:

• (Float, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 147

optional :suppression_level, Float

#voice_gain ⇒ Float^?

Voice gain multiplier (0.1-4.0). Only applicable for AiCoustics.

Returns:

• (Float, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 153

optional :voice_gain, Float

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 189