Class: Vapi::WorkflowVoice

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

Overview

This is the voice for the workflow.

This can be overridden at node level using `nodes[n].voice`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:

  • member (Object)
  • discriminant (String) 


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

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

Instance Attribute Details

#discriminant ⇒ String (readonly)

Returns:

  • (String) 


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

def discriminant
  @discriminant
end

#member ⇒ Object (readonly)

Returns:

  • (Object) 


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

def member
  @member
end

Class Method Details

._11_labs(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



208
209
210
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 208

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

.azure(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



184
185
186
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 184

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

.cartesia(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



190
191
192
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 190

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

.custom_voice(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



196
197
198
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 196

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

.deepgram(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



202
203
204
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 202

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

.from_json(json_object:) ⇒ Vapi::WorkflowVoice

Deserialize a JSON object to an instance of WorkflowVoice

Parameters:

  • json_object (String)

Returns:



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
84
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 45

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::WorkflowVoice

Parameters:

Returns:



214
215
216
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 214

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

.inworld(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



274
275
276
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 274

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

.lmnt(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



220
221
222
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 220

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

.neuphonic(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



226
227
228
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 226

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

.openai(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



232
233
234
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 232

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

.playht(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



238
239
240
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 238

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

.rime_ai(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



244
245
246
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 244

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

.sesame(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



268
269
270
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 268

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

.smallest_ai(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



250
251
252
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 250

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

.tavus(member:) ⇒ Vapi::WorkflowVoice

Parameters:

Returns:



256
257
258
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 256

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) 


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
172
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 135

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::WorkflowVoice

Parameters:

Returns:



262
263
264
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 262

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) 


178
179
180
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 178

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

#kind_of? ⇒ Object 



31
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 31

alias kind_of? is_a?

#to_json(*_args) ⇒ String

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

Returns:

  • (String) 


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
127
 
# File 'lib/vapi_server_sdk/types/workflow_voice.rb', line 89

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