Class: Vapi::AssistantVoice

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

Overview

These are the options for the assistant’s voice.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(member:, discriminant:) ⇒ Vapi::AssistantVoice

Parameters:

  • member (Object)
  • discriminant (String)


35
36
37
38
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 35

def initialize(member:, discriminant:)
  @member = member
  @discriminant = discriminant
end

Instance Attribute Details

#discriminantString (readonly)

Returns:

  • (String)


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

def discriminant
  @discriminant
end

#memberObject (readonly)

Returns:

  • (Object)


25
26
27
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 25

def member
  @member
end

Class Method Details

._11_labs(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



207
208
209
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 207

def self._11_labs(member:)
  new(member: member, discriminant: "11labs")
end

.azure(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



183
184
185
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 183

def self.azure(member:)
  new(member: member, discriminant: "azure")
end

.cartesia(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



189
190
191
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 189

def self.cartesia(member:)
  new(member: member, discriminant: "cartesia")
end

.custom_voice(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



195
196
197
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 195

def self.custom_voice(member:)
  new(member: member, discriminant: "custom-voice")
end

.deepgram(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



201
202
203
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 201

def self.deepgram(member:)
  new(member: member, discriminant: "deepgram")
end

.from_json(json_object:) ⇒ Vapi::AssistantVoice

Deserialize a JSON object to an instance of AssistantVoice

Parameters:

  • json_object (String)

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 44

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  member = case struct.provider
           when "azure"
             Vapi::AzureVoice.from_json(json_object: json_object)
           when "cartesia"
             Vapi::CartesiaVoice.from_json(json_object: json_object)
           when "custom-voice"
             Vapi::CustomVoice.from_json(json_object: json_object)
           when "deepgram"
             Vapi::DeepgramVoice.from_json(json_object: json_object)
           when "11labs"
             Vapi::ElevenLabsVoice.from_json(json_object: json_object)
           when "hume"
             Vapi::HumeVoice.from_json(json_object: json_object)
           when "lmnt"
             Vapi::LmntVoice.from_json(json_object: json_object)
           when "neuphonic"
             Vapi::NeuphonicVoice.from_json(json_object: json_object)
           when "openai"
             Vapi::OpenAiVoice.from_json(json_object: json_object)
           when "playht"
             Vapi::PlayHtVoice.from_json(json_object: json_object)
           when "rime-ai"
             Vapi::RimeAiVoice.from_json(json_object: json_object)
           when "smallest-ai"
             Vapi::SmallestAiVoice.from_json(json_object: json_object)
           when "tavus"
             Vapi::TavusVoice.from_json(json_object: json_object)
           when "vapi"
             Vapi::VapiVoice.from_json(json_object: json_object)
           when "sesame"
             Vapi::SesameVoice.from_json(json_object: json_object)
           when "inworld"
             Vapi::InworldVoice.from_json(json_object: json_object)
           else
             Vapi::AzureVoice.from_json(json_object: json_object)
           end
  new(member: member, discriminant: struct.provider)
end

.hume(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



213
214
215
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 213

def self.hume(member:)
  new(member: member, discriminant: "hume")
end

.inworld(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



273
274
275
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 273

def self.inworld(member:)
  new(member: member, discriminant: "inworld")
end

.lmnt(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



219
220
221
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 219

def self.lmnt(member:)
  new(member: member, discriminant: "lmnt")
end

.neuphonic(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



225
226
227
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 225

def self.neuphonic(member:)
  new(member: member, discriminant: "neuphonic")
end

.openai(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



231
232
233
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 231

def self.openai(member:)
  new(member: member, discriminant: "openai")
end

.playht(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



237
238
239
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 237

def self.playht(member:)
  new(member: member, discriminant: "playht")
end

.rime_ai(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



243
244
245
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 243

def self.rime_ai(member:)
  new(member: member, discriminant: "rime-ai")
end

.sesame(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



267
268
269
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 267

def self.sesame(member:)
  new(member: member, discriminant: "sesame")
end

.smallest_ai(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



249
250
251
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 249

def self.smallest_ai(member:)
  new(member: member, discriminant: "smallest-ai")
end

.tavus(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



255
256
257
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 255

def self.tavus(member:)
  new(member: member, discriminant: "tavus")
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)


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 134

def self.validate_raw(obj:)
  case obj.provider
  when "azure"
    Vapi::AzureVoice.validate_raw(obj: obj)
  when "cartesia"
    Vapi::CartesiaVoice.validate_raw(obj: obj)
  when "custom-voice"
    Vapi::CustomVoice.validate_raw(obj: obj)
  when "deepgram"
    Vapi::DeepgramVoice.validate_raw(obj: obj)
  when "11labs"
    Vapi::ElevenLabsVoice.validate_raw(obj: obj)
  when "hume"
    Vapi::HumeVoice.validate_raw(obj: obj)
  when "lmnt"
    Vapi::LmntVoice.validate_raw(obj: obj)
  when "neuphonic"
    Vapi::NeuphonicVoice.validate_raw(obj: obj)
  when "openai"
    Vapi::OpenAiVoice.validate_raw(obj: obj)
  when "playht"
    Vapi::PlayHtVoice.validate_raw(obj: obj)
  when "rime-ai"
    Vapi::RimeAiVoice.validate_raw(obj: obj)
  when "smallest-ai"
    Vapi::SmallestAiVoice.validate_raw(obj: obj)
  when "tavus"
    Vapi::TavusVoice.validate_raw(obj: obj)
  when "vapi"
    Vapi::VapiVoice.validate_raw(obj: obj)
  when "sesame"
    Vapi::SesameVoice.validate_raw(obj: obj)
  when "inworld"
    Vapi::InworldVoice.validate_raw(obj: obj)
  else
    raise("Passed value matched no type within the union, validation failed.")
  end
end

.vapi(member:) ⇒ Vapi::AssistantVoice

Parameters:

Returns:



261
262
263
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 261

def self.vapi(member:)
  new(member: member, discriminant: "vapi")
end

Instance Method Details

#is_a?(obj) ⇒ Boolean

For Union Types, is_a? functionality is delegated to the wrapped member.

Parameters:

  • obj (Object)

Returns:

  • (Boolean)


177
178
179
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 177

def is_a?(obj)
  @member.is_a?(obj)
end

#kind_of?Object



30
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 30

alias kind_of? is_a?

#to_json(*_args) ⇒ String

For Union Types, to_json functionality is delegated to the wrapped member.

Returns:

  • (String)


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
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/vapi_server_sdk/types/assistant_voice.rb', line 88

def to_json(*_args)
  case @discriminant
  when "azure"
    { **@member.to_json, provider: @discriminant }.to_json
  when "cartesia"
    { **@member.to_json, provider: @discriminant }.to_json
  when "custom-voice"
    { **@member.to_json, provider: @discriminant }.to_json
  when "deepgram"
    { **@member.to_json, provider: @discriminant }.to_json
  when "11labs"
    { **@member.to_json, provider: @discriminant }.to_json
  when "hume"
    { **@member.to_json, provider: @discriminant }.to_json
  when "lmnt"
    { **@member.to_json, provider: @discriminant }.to_json
  when "neuphonic"
    { **@member.to_json, provider: @discriminant }.to_json
  when "openai"
    { **@member.to_json, provider: @discriminant }.to_json
  when "playht"
    { **@member.to_json, provider: @discriminant }.to_json
  when "rime-ai"
    { **@member.to_json, provider: @discriminant }.to_json
  when "smallest-ai"
    { **@member.to_json, provider: @discriminant }.to_json
  when "tavus"
    { **@member.to_json, provider: @discriminant }.to_json
  when "vapi"
    { **@member.to_json, provider: @discriminant }.to_json
  when "sesame"
    { **@member.to_json, provider: @discriminant }.to_json
  when "inworld"
    { **@member.to_json, provider: @discriminant }.to_json
  else
    { "provider": @discriminant, value: @member }.to_json
  end
  @member.to_json
end