Class: Vapi::RimeAiVoice

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/rime_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, speed: OMIT, pause_between_brackets: OMIT, phonemize_between_brackets: OMIT, reduce_latency: OMIT, inline_speed_alpha: OMIT, chunk_plan: OMIT, fallback_plan: OMIT, additional_properties: nil) ⇒ Vapi::RimeAiVoice

Parameters:

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

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

  • voice_id (Vapi::RimeAiVoiceId) —

    This is the provider-specific ID that will be used.

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

    This is the model that will be used. Defaults to ‘mistv2’ when not specified.

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

    This is the speed multiplier that will be used.

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

    This is a flag that controls whether to add slight pauses using angle brackets. Example: “Hi. <200> I’d love to have a conversation with you.” adds a 200ms pause between the first and second sentences.

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

    This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: “Vapi::RimeAiVoice.h’Elh’El.o World” will pronounce “Hello” as expected.

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

    This is a flag that controls whether to optimize for reduced latency in streaming. docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency

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

    This is a string that allows inline speed control using alpha notation. docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha

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

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

  • fallback_plan (Vapi::FallbackPlan) (defaults to: OMIT) —

    This is the plan for voice provider fallbacks in the event that the primary voice provider fails.

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

    Additional properties unmapped to the current class definition



70
71
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
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 70

def initialize(voice_id:, caching_enabled: OMIT, model: OMIT, speed: OMIT, pause_between_brackets: OMIT,
               phonemize_between_brackets: OMIT, reduce_latency: OMIT, inline_speed_alpha: 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
  @speed = speed if speed != OMIT
  @pause_between_brackets = pause_between_brackets if pause_between_brackets != OMIT
  @phonemize_between_brackets = phonemize_between_brackets if phonemize_between_brackets != OMIT
  @reduce_latency = reduce_latency if reduce_latency != OMIT
  @inline_speed_alpha = inline_speed_alpha if inline_speed_alpha != 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,
    "speed": speed,
    "pauseBetweenBrackets": pause_between_brackets,
    "phonemizeBetweenBrackets": phonemize_between_brackets,
    "reduceLatency": reduce_latency,
    "inlineSpeedAlpha": inline_speed_alpha,
    "chunkPlan": chunk_plan,
    "fallbackPlan": fallback_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



42
43
44
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 42

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.



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

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.



37
38
39
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 37

def chunk_plan
  @chunk_plan
end

#fallback_plan ⇒ Vapi::FallbackPlan (readonly)

Returns This is the plan for voice provider fallbacks in the event that the primary voice provider fails.

Returns:

  • (Vapi::FallbackPlan) —

    This is the plan for voice provider fallbacks in the event that the primary voice provider fails.



40
41
42
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 40

def fallback_plan
  @fallback_plan
end

#inline_speed_alpha ⇒ String (readonly)

Returns This is a string that allows inline speed control using alpha notation. docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha.

Returns:



34
35
36
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 34

def inline_speed_alpha
  @inline_speed_alpha
end

#model ⇒ Vapi::RimeAiVoiceModel (readonly)

Returns This is the model that will be used. Defaults to ‘mistv2’ when not specified.

Returns:

  • (Vapi::RimeAiVoiceModel) —

    This is the model that will be used. Defaults to ‘mistv2’ when not specified.



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

def model
  @model
end

#pause_between_brackets ⇒ Boolean (readonly)

Returns This is a flag that controls whether to add slight pauses using angle brackets. Example: “Hi. <200> I’d love to have a conversation with you.” adds a 200ms pause between the first and second sentences.

Returns:

  • (Boolean) —

    This is a flag that controls whether to add slight pauses using angle brackets. Example: “Hi. <200> I’d love to have a conversation with you.” adds a 200ms pause between the first and second sentences.



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

def pause_between_brackets
  @pause_between_brackets
end

#phonemize_between_brackets ⇒ Boolean (readonly)

Returns This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: “Vapi::RimeAiVoice.h’Elh’El.o World” will pronounce “Hello” as expected.

Returns:

  • (Boolean) —

    This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: “Vapi::RimeAiVoice.h’Elh’El.o World” will pronounce “Hello” as expected.



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

def phonemize_between_brackets
  @phonemize_between_brackets
end

#reduce_latency ⇒ Boolean (readonly)

Returns This is a flag that controls whether to optimize for reduced latency in streaming. docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency.

Returns:



31
32
33
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 31

def reduce_latency
  @reduce_latency
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.



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

def speed
  @speed
end

#voice_id ⇒ Vapi::RimeAiVoiceId (readonly)

Returns This is the provider-specific ID that will be used.

Returns:



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

def voice_id
  @voice_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::RimeAiVoice

Deserialize a JSON object to an instance of RimeAiVoice

Parameters:

  • json_object (String)

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 103

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::RimeAiVoiceId.from_json(json_object: voice_id)
  end
  model = parsed_json["model"]
  speed = parsed_json["speed"]
  pause_between_brackets = parsed_json["pauseBetweenBrackets"]
  phonemize_between_brackets = parsed_json["phonemizeBetweenBrackets"]
  reduce_latency = parsed_json["reduceLatency"]
  inline_speed_alpha = parsed_json["inlineSpeedAlpha"]
  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,
    speed: speed,
    pause_between_brackets: pause_between_brackets,
    phonemize_between_brackets: phonemize_between_brackets,
    reduce_latency: reduce_latency,
    inline_speed_alpha: inline_speed_alpha,
    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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 159

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::RimeAiVoiceId.validate_raw(obj: obj.voice_id)
  obj.model&.is_a?(Vapi::RimeAiVoiceModel) != false || raise("Passed value for field obj.model 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.pause_between_brackets&.is_a?(Boolean) != false || raise("Passed value for field obj.pause_between_brackets is not the expected type, validation failed.")
  obj.phonemize_between_brackets&.is_a?(Boolean) != false || raise("Passed value for field obj.phonemize_between_brackets is not the expected type, validation failed.")
  obj.reduce_latency&.is_a?(Boolean) != false || raise("Passed value for field obj.reduce_latency is not the expected type, validation failed.")
  obj.inline_speed_alpha&.is_a?(String) != false || raise("Passed value for field obj.inline_speed_alpha 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 RimeAiVoice to a JSON object

Returns:

  • (String) 


149
150
151
 
# File 'lib/vapi_server_sdk/types/rime_ai_voice.rb', line 149

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