Class: Vapi::FallbackOpenAiVoice

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/fallback_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, additional_properties: nil) ⇒ Vapi::FallbackOpenAiVoice

Parameters:

  • caching_enabled (Boolean) (defaults to: OMIT) —

    This is the flag to toggle voice caching for the assistant.

  • voice_id (Vapi::FallbackOpenAiVoiceId) —

    This is the provider-specific ID that will be used. Please note that ash, ballad, coral, sage, and verse may only be used with realtime models.

  • model (Vapi::FallbackOpenAiVoiceModel) (defaults to: OMIT) —

    This is the model that will be used for text-to-speech.

  • instructions (String) (defaults to: OMIT) —

    This is a prompt that allows you to control the voice of your generated audio. Does not work with ‘tts-1’ or ‘tts-1-hd’ models.

  • speed (Float) (defaults to: OMIT) —

    This is the speed multiplier that will be used.

  • chunk_plan (Vapi::ChunkPlan) (defaults to: OMIT) —

    This is the plan for chunking the model output before it is sent to the voice provider.

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

    Additional properties unmapped to the current class definition



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/fallback_open_ai_voice.rb', line 47

def initialize(voice_id:, caching_enabled: OMIT, model: OMIT, instructions: OMIT, speed: OMIT, chunk_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
  @additional_properties = additional_properties
  @_field_set = {
    "cachingEnabled": caching_enabled,
    "voiceId": voice_id,
    "model": model,
    "instructions": instructions,
    "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.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



28
29
30
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 28

def additional_properties
  @additional_properties
end

#caching_enabled ⇒ Boolean (readonly)

Returns This is the flag to toggle voice caching for the assistant.

Returns:

  • (Boolean) —

    This is the flag to toggle voice caching for the assistant.



12
13
14
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 12

def caching_enabled
  @caching_enabled
end

#chunk_plan ⇒ Vapi::ChunkPlan (readonly)

Returns This is the plan for chunking the model output before it is sent to the voice provider.

Returns:

  • (Vapi::ChunkPlan) —

    This is the plan for chunking the model output before it is sent to the voice provider.



26
27
28
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 26

def chunk_plan
  @chunk_plan
end

#instructions ⇒ String (readonly)

Returns This is a prompt that allows you to control the voice of your generated audio. Does not work with ‘tts-1’ or ‘tts-1-hd’ models.

Returns:

  • (String) —

    This is a prompt that allows you to control the voice of your generated audio. Does not work with ‘tts-1’ or ‘tts-1-hd’ models.



21
22
23
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 21

def instructions
  @instructions
end

#model ⇒ Vapi::FallbackOpenAiVoiceModel (readonly)

Returns This is the model that will be used for text-to-speech.

Returns:



18
19
20
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 18

def model
  @model
end

#speed ⇒ Float (readonly)

Returns This is the speed multiplier that will be used.

Returns:

  • (Float) —

    This is the speed multiplier that will be used.



23
24
25
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 23

def speed
  @speed
end

#voice_id ⇒ Vapi::FallbackOpenAiVoiceId (readonly)

Returns This is the provider-specific ID that will be used. Please note that ash, ballad, coral, sage, and verse may only be used with realtime models.

Returns:

  • (Vapi::FallbackOpenAiVoiceId) —

    This is the provider-specific ID that will be used. Please note that ash, ballad, coral, sage, and verse may only be used with realtime models.



16
17
18
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 16

def voice_id
  @voice_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::FallbackOpenAiVoice

Deserialize a JSON object to an instance of FallbackOpenAiVoice

Parameters:

  • json_object (String)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 72

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::FallbackOpenAiVoiceId.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
  new(
    caching_enabled: caching_enabled,
    voice_id: voice_id,
    model: model,
    instructions: instructions,
    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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


115
116
117
118
119
120
121
122
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 115

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::FallbackOpenAiVoiceId.validate_raw(obj: obj.voice_id)
  obj.model&.is_a?(Vapi::FallbackOpenAiVoiceModel) != 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)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of FallbackOpenAiVoice to a JSON object

Returns:

  • (String) 


105
106
107
 
# File 'lib/vapi_server_sdk/types/fallback_open_ai_voice.rb', line 105

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