Class: Vapi::BackgroundSpeechDenoisingPlan

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/background_speech_denoising_plan.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(smart_denoising_plan: OMIT, fourier_denoising_plan: OMIT, additional_properties: nil) ⇒ Vapi::BackgroundSpeechDenoisingPlan

Parameters:

  • smart_denoising_plan (Vapi::SmartDenoisingPlan) (defaults to: OMIT) —

    Whether smart denoising using Krisp is enabled.

  • fourier_denoising_plan (Vapi::FourierDenoisingPlan) (defaults to: OMIT) —

    Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected. This can be combined with smart denoising, and will be run afterwards.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/vapi_server_sdk/types/background_speech_denoising_plan.rb', line 30

def initialize(smart_denoising_plan: OMIT, fourier_denoising_plan: OMIT, additional_properties: nil)
  @smart_denoising_plan = smart_denoising_plan if smart_denoising_plan != OMIT
  @fourier_denoising_plan = fourier_denoising_plan if fourier_denoising_plan != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "smartDenoisingPlan": smart_denoising_plan,
    "fourierDenoisingPlan": fourier_denoising_plan
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



17
18
19
 
# File 'lib/vapi_server_sdk/types/background_speech_denoising_plan.rb', line 17

def additional_properties
  @additional_properties
end

#fourier_denoising_plan ⇒ Vapi::FourierDenoisingPlan (readonly)

Returns Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected. This can be combined with smart denoising, and will be run afterwards.

Returns:

  • (Vapi::FourierDenoisingPlan) —

    Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected. This can be combined with smart denoising, and will be run afterwards.



15
16
17
 
# File 'lib/vapi_server_sdk/types/background_speech_denoising_plan.rb', line 15

def fourier_denoising_plan
  @fourier_denoising_plan
end

#smart_denoising_plan ⇒ Vapi::SmartDenoisingPlan (readonly)

Returns Whether smart denoising using Krisp is enabled.

Returns:



11
12
13
 
# File 'lib/vapi_server_sdk/types/background_speech_denoising_plan.rb', line 11

def smart_denoising_plan
  @smart_denoising_plan
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::BackgroundSpeechDenoisingPlan

Deserialize a JSON object to an instance of BackgroundSpeechDenoisingPlan

Parameters:

  • json_object (String)

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/vapi_server_sdk/types/background_speech_denoising_plan.rb', line 46

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["smartDenoisingPlan"].nil?
    smart_denoising_plan = nil
  else
    smart_denoising_plan = parsed_json["smartDenoisingPlan"].to_json
    smart_denoising_plan = Vapi::SmartDenoisingPlan.from_json(json_object: smart_denoising_plan)
  end
  if parsed_json["fourierDenoisingPlan"].nil?
    fourier_denoising_plan = nil
  else
    fourier_denoising_plan = parsed_json["fourierDenoisingPlan"].to_json
    fourier_denoising_plan = Vapi::FourierDenoisingPlan.from_json(json_object: fourier_denoising_plan)
  end
  new(
    smart_denoising_plan: smart_denoising_plan,
    fourier_denoising_plan: fourier_denoising_plan,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


81
82
83
84
 
# File 'lib/vapi_server_sdk/types/background_speech_denoising_plan.rb', line 81

def self.validate_raw(obj:)
  obj.smart_denoising_plan.nil? || Vapi::SmartDenoisingPlan.validate_raw(obj: obj.smart_denoising_plan)
  obj.fourier_denoising_plan.nil? || Vapi::FourierDenoisingPlan.validate_raw(obj: obj.fourier_denoising_plan)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of BackgroundSpeechDenoisingPlan to a JSON object

Returns:

  • (String) 


71
72
73
 
# File 'lib/vapi_server_sdk/types/background_speech_denoising_plan.rb', line 71

def to_json(*_args)
  @_field_set&.to_json
end