Class: Vapi::OpenAiVoice
- Inherits:
-
Object
- Object
- Vapi::OpenAiVoice
- Defined in:
- lib/vapi_server_sdk/types/open_ai_voice.rb
Constant Summary collapse
- OMIT =
Object.new
Instance Attribute Summary collapse
-
#additional_properties ⇒ OpenStruct
readonly
Additional properties unmapped to the current class definition.
-
#chunk_plan ⇒ Vapi::ChunkPlan
readonly
This is the plan for chunking the model output before it is sent to the voice provider.
-
#filler_injection_enabled ⇒ Boolean
readonly
This determines whether fillers are injected into the model output before inputting it into the voice provider.
-
#speed ⇒ Float
readonly
This is the speed multiplier that will be used.
-
#voice_id ⇒ Vapi::OpenAiVoiceId
readonly
This is the provider-specific ID that will be used.
Class Method Summary collapse
-
.from_json(json_object:) ⇒ Vapi::OpenAiVoice
Deserialize a JSON object to an instance of OpenAiVoice.
-
.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:, filler_injection_enabled: OMIT, speed: OMIT, chunk_plan: OMIT, additional_properties: nil) ⇒ Vapi::OpenAiVoice constructor
-
#to_json(*_args) ⇒ String
Serialize an instance of OpenAiVoice to a JSON object.
Constructor Details
#initialize(voice_id:, filler_injection_enabled: OMIT, speed: OMIT, chunk_plan: OMIT, additional_properties: nil) ⇒ Vapi::OpenAiVoice
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 38 def initialize(voice_id:, filler_injection_enabled: OMIT, speed: OMIT, chunk_plan: OMIT, additional_properties: nil) @filler_injection_enabled = filler_injection_enabled if filler_injection_enabled != OMIT @voice_id = voice_id @speed = speed if speed != OMIT @chunk_plan = chunk_plan if chunk_plan != OMIT @additional_properties = additional_properties @_field_set = { "fillerInjectionEnabled": filler_injection_enabled, "voiceId": voice_id, "speed": speed, "chunkPlan": chunk_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.
22 23 24 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 22 def additional_properties @additional_properties end |
#chunk_plan ⇒ Vapi::ChunkPlan (readonly)
Returns This is the plan for chunking the model output before it is sent to the voice provider.
20 21 22 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 20 def chunk_plan @chunk_plan end |
#filler_injection_enabled ⇒ Boolean (readonly)
Returns This determines whether fillers are injected into the model output before inputting it into the voice provider. Default ‘false` because you can achieve better results with prompting the model.
13 14 15 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 13 def filler_injection_enabled @filler_injection_enabled end |
#speed ⇒ Float (readonly)
Returns This is the speed multiplier that will be used.
17 18 19 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 17 def speed @speed end |
#voice_id ⇒ Vapi::OpenAiVoiceId (readonly)
Returns This is the provider-specific ID that will be used.
15 16 17 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 15 def voice_id @voice_id end |
Class Method Details
.from_json(json_object:) ⇒ Vapi::OpenAiVoice
Deserialize a JSON object to an instance of OpenAiVoice
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 58 def self.from_json(json_object:) struct = JSON.parse(json_object, object_class: OpenStruct) parsed_json = JSON.parse(json_object) filler_injection_enabled = parsed_json["fillerInjectionEnabled"] voice_id = parsed_json["voiceId"] 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 new( filler_injection_enabled: filler_injection_enabled, voice_id: voice_id, speed: speed, chunk_plan: chunk_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.
92 93 94 95 96 97 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 92 def self.validate_raw(obj:) obj.filler_injection_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.filler_injection_enabled is not the expected type, validation failed.") obj.voice_id.is_a?(Vapi::OpenAiVoiceId) != false || raise("Passed value for field obj.voice_id 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) end |
Instance Method Details
#to_json(*_args) ⇒ String
Serialize an instance of OpenAiVoice to a JSON object
82 83 84 |
# File 'lib/vapi_server_sdk/types/open_ai_voice.rb', line 82 def to_json(*_args) @_field_set&.to_json end |