Class: Vapi::OpenAiVoice

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(voice_id:, caching_enabled: OMIT, model: OMIT, instructions: OMIT, speed: OMIT, chunk_plan: OMIT, fallback_plan: OMIT, additional_properties: nil) ⇒ Vapi::OpenAiVoice 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 53

def initialize(voice_id:, caching_enabled: OMIT, model: OMIT, instructions: OMIT, speed: OMIT, chunk_plan: OMIT,
               fallback_plan: OMIT, additional_properties: nil)
  @caching_enabled = caching_enabled if caching_enabled != OMIT
  @voice_id = voice_id
  @model = model if model != OMIT
  @instructions = instructions if instructions != OMIT
  @speed = speed if speed != OMIT
  @chunk_plan = chunk_plan if chunk_plan != OMIT
  @fallback_plan = fallback_plan if fallback_plan != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "cachingEnabled": caching_enabled,
    "voiceId": voice_id,
    "model": model,
    "instructions": instructions,
    "speed": speed,
    "chunkPlan": chunk_plan,
    "fallbackPlan": fallback_plan
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly) 



32
33
34
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 32

def additional_properties
  @additional_properties
end

#caching_enabled ⇒ Boolean (readonly) 



13
14
15
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 13

def caching_enabled
  @caching_enabled
end

#chunk_plan ⇒ Vapi::ChunkPlan (readonly) 



27
28
29
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 27

def chunk_plan
  @chunk_plan
end

#fallback_plan ⇒ Vapi::FallbackPlan (readonly) 



30
31
32
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 30

def fallback_plan
  @fallback_plan
end

#instructions ⇒ String (readonly) 



22
23
24
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 22

def instructions
  @instructions
end

#model ⇒ Vapi::OpenAiVoiceModel (readonly) 



19
20
21
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 19

def model
  @model
end

#speed ⇒ Float (readonly) 



24
25
26
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 24

def speed
  @speed
end

#voice_id ⇒ Vapi::OpenAiVoiceId (readonly) 



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

def voice_id
  @voice_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::OpenAiVoice

Deserialize a JSON object to an instance of OpenAiVoice



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 80

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  caching_enabled = parsed_json["cachingEnabled"]
  if parsed_json["voiceId"].nil?
    voice_id = nil
  else
    voice_id = parsed_json["voiceId"].to_json
    voice_id = Vapi::OpenAiVoiceId.from_json(json_object: voice_id)
  end
  model = parsed_json["model"]
  instructions = parsed_json["instructions"]
  speed = parsed_json["speed"]
  if parsed_json["chunkPlan"].nil?
    chunk_plan = nil
  else
    chunk_plan = parsed_json["chunkPlan"].to_json
    chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
  end
  if parsed_json["fallbackPlan"].nil?
    fallback_plan = nil
  else
    fallback_plan = parsed_json["fallbackPlan"].to_json
    fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
  end
  new(
    caching_enabled: caching_enabled,
    voice_id: voice_id,
    model: model,
    instructions: instructions,
    speed: speed,
    chunk_plan: chunk_plan,
    fallback_plan: fallback_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.



130
131
132
133
134
135
136
137
138
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 130

def self.validate_raw(obj:)
  obj.caching_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.caching_enabled is not the expected type, validation failed.")
  Vapi::OpenAiVoiceId.validate_raw(obj: obj.voice_id)
  obj.model&.is_a?(Vapi::OpenAiVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
  obj.instructions&.is_a?(String) != false || raise("Passed value for field obj.instructions is not the expected type, validation failed.")
  obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
  obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
  obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of OpenAiVoice to a JSON object



120
121
122
 
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 120

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