Class: Vapi::SesameVoice
- Inherits:
-
Object
- Object
- Vapi::SesameVoice
- Defined in:
- lib/vapi_server_sdk/types/sesame_voice.rb
Constant Summary collapse
- OMIT =
Object.new
Instance Attribute Summary collapse
-
#additional_properties ⇒ OpenStruct
readonly
Additional properties unmapped to the current class definition.
-
#caching_enabled ⇒ Boolean
readonly
This is the flag to toggle voice caching for the assistant.
-
#chunk_plan ⇒ Vapi::ChunkPlan
readonly
This is the plan for chunking the model output before it is sent to the voice provider.
-
#fallback_plan ⇒ Vapi::FallbackPlan
readonly
This is the plan for voice provider fallbacks in the event that the primary voice provider fails.
-
#model ⇒ String
readonly
This is the model that will be used.
-
#voice_id ⇒ String
readonly
This is the provider-specific ID that will be used.
Class Method Summary collapse
-
.from_json(json_object:) ⇒ Vapi::SesameVoice
Deserialize a JSON object to an instance of SesameVoice.
-
.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.
Instance Method Summary collapse
- #initialize(voice_id:, model:, caching_enabled: OMIT, chunk_plan: OMIT, fallback_plan: OMIT, additional_properties: nil) ⇒ Vapi::SesameVoice constructor
-
#to_json(*_args) ⇒ String
Serialize an instance of SesameVoice to a JSON object.
Constructor Details
#initialize(voice_id:, model:, caching_enabled: OMIT, chunk_plan: OMIT, fallback_plan: OMIT, additional_properties: nil) ⇒ Vapi::SesameVoice
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 39 def initialize(voice_id:, model:, caching_enabled: OMIT, chunk_plan: OMIT, fallback_plan: OMIT, additional_properties: nil) @caching_enabled = caching_enabled if caching_enabled != OMIT @voice_id = voice_id @model = model @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, "chunkPlan": chunk_plan, "fallbackPlan": fallback_plan }.reject do |_k, v| v == OMIT end end |
Instance Attribute Details
#additional_properties ⇒ OpenStruct (readonly)
23 24 25 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 23 def additional_properties @additional_properties end |
#caching_enabled ⇒ Boolean (readonly)
11 12 13 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 11 def caching_enabled @caching_enabled end |
#chunk_plan ⇒ Vapi::ChunkPlan (readonly)
18 19 20 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 18 def chunk_plan @chunk_plan end |
#fallback_plan ⇒ Vapi::FallbackPlan (readonly)
21 22 23 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 21 def fallback_plan @fallback_plan end |
#model ⇒ String (readonly)
15 16 17 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 15 def model @model end |
#voice_id ⇒ String (readonly)
13 14 15 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 13 def voice_id @voice_id end |
Class Method Details
.from_json(json_object:) ⇒ Vapi::SesameVoice
Deserialize a JSON object to an instance of SesameVoice
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 62 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"] voice_id = parsed_json["voiceId"] model = parsed_json["model"] 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, 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.
103 104 105 106 107 108 109 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 103 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.") obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.") obj.model.is_a?(String) != false || raise("Passed value for field obj.model 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 SesameVoice to a JSON object
93 94 95 |
# File 'lib/vapi_server_sdk/types/sesame_voice.rb', line 93 def to_json(*_args) @_field_set&.to_json end |