Class: Vapi::VapiModel

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider:, model:, messages: OMIT, tools: OMIT, tool_ids: OMIT, knowledge_base: OMIT, knowledge_base_id: OMIT, workflow_id: OMIT, workflow: OMIT, temperature: OMIT, max_tokens: OMIT, emotion_recognition_enabled: OMIT, num_fast_turns: OMIT, additional_properties: nil) ⇒ Vapi::VapiModel 



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/vapi_model.rb', line 93

def initialize(provider:, model:, messages: OMIT, tools: OMIT, tool_ids: OMIT, knowledge_base: OMIT,
               knowledge_base_id: OMIT, workflow_id: OMIT, workflow: OMIT, temperature: OMIT, max_tokens: OMIT, emotion_recognition_enabled: OMIT, num_fast_turns: OMIT, additional_properties: nil)
  @messages = messages if messages != OMIT
  @tools = tools if tools != OMIT
  @tool_ids = tool_ids if tool_ids != OMIT
  @knowledge_base = knowledge_base if knowledge_base != OMIT
  @knowledge_base_id = knowledge_base_id if knowledge_base_id != OMIT
  @provider = provider
  @workflow_id = workflow_id if workflow_id != OMIT
  @workflow = workflow if workflow != OMIT
  @model = model
  @temperature = temperature if temperature != OMIT
  @max_tokens = max_tokens if max_tokens != OMIT
  @emotion_recognition_enabled = emotion_recognition_enabled if emotion_recognition_enabled != OMIT
  @num_fast_turns = num_fast_turns if num_fast_turns != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "messages": messages,
    "tools": tools,
    "toolIds": tool_ids,
    "knowledgeBase": knowledge_base,
    "knowledgeBaseId": knowledge_base_id,
    "provider": provider,
    "workflowId": workflow_id,
    "workflow": workflow,
    "model": model,
    "temperature": temperature,
    "maxTokens": max_tokens,
    "emotionRecognitionEnabled": emotion_recognition_enabled,
    "numFastTurns": num_fast_turns
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly) 



55
56
57
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 55

def additional_properties
  @additional_properties
end

#emotion_recognition_enabled ⇒ Boolean (readonly) 



47
48
49
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 47

def emotion_recognition_enabled
  @emotion_recognition_enabled
end

#knowledge_base ⇒ Vapi::CreateCustomKnowledgeBaseDto (readonly) 



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

def knowledge_base
  @knowledge_base
end

#knowledge_base_id ⇒ String (readonly) 



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

def knowledge_base_id
  @knowledge_base_id
end

#max_tokens ⇒ Float (readonly) 



41
42
43
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 41

def max_tokens
  @max_tokens
end

#messages ⇒ Array<Vapi::OpenAiMessage> (readonly) 



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

def messages
  @messages
end

#model ⇒ String (readonly) 



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

def model
  @model
end

#num_fast_turns ⇒ Float (readonly) 



53
54
55
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 53

def num_fast_turns
  @num_fast_turns
end

#provider ⇒ String (readonly) 



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

def provider
  @provider
end

#temperature ⇒ Float (readonly) 



38
39
40
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 38

def temperature
  @temperature
end

#tool_ids ⇒ Array<String> (readonly) 



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

def tool_ids
  @tool_ids
end

#tools ⇒ Array<Vapi::VapiModelToolsItem> (readonly) 



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

def tools
  @tools
end

#workflow ⇒ Vapi::WorkflowUserEditable (readonly) 



33
34
35
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 33

def workflow
  @workflow
end

#workflow_id ⇒ String (readonly) 



30
31
32
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 30

def workflow_id
  @workflow_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::VapiModel

Deserialize a JSON object to an instance of VapiModel



132
133
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
172
173
174
175
176
177
178
179
180
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 132

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  messages = parsed_json["messages"]&.map do |item|
    item = item.to_json
    Vapi::OpenAiMessage.from_json(json_object: item)
  end
  tools = parsed_json["tools"]&.map do |item|
    item = item.to_json
    Vapi::VapiModelToolsItem.from_json(json_object: item)
  end
  tool_ids = parsed_json["toolIds"]
  if parsed_json["knowledgeBase"].nil?
    knowledge_base = nil
  else
    knowledge_base = parsed_json["knowledgeBase"].to_json
    knowledge_base = Vapi::CreateCustomKnowledgeBaseDto.from_json(json_object: knowledge_base)
  end
  knowledge_base_id = parsed_json["knowledgeBaseId"]
  provider = parsed_json["provider"]
  workflow_id = parsed_json["workflowId"]
  if parsed_json["workflow"].nil?
    workflow = nil
  else
    workflow = parsed_json["workflow"].to_json
    workflow = Vapi::WorkflowUserEditable.from_json(json_object: workflow)
  end
  model = parsed_json["model"]
  temperature = parsed_json["temperature"]
  max_tokens = parsed_json["maxTokens"]
  emotion_recognition_enabled = parsed_json["emotionRecognitionEnabled"]
  num_fast_turns = parsed_json["numFastTurns"]
  new(
    messages: messages,
    tools: tools,
    tool_ids: tool_ids,
    knowledge_base: knowledge_base,
    knowledge_base_id: knowledge_base_id,
    provider: provider,
    workflow_id: workflow_id,
    workflow: workflow,
    model: model,
    temperature: temperature,
    max_tokens: max_tokens,
    emotion_recognition_enabled: emotion_recognition_enabled,
    num_fast_turns: num_fast_turns,
    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.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 195

def self.validate_raw(obj:)
  obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
  obj.tools&.is_a?(Array) != false || raise("Passed value for field obj.tools is not the expected type, validation failed.")
  obj.tool_ids&.is_a?(Array) != false || raise("Passed value for field obj.tool_ids is not the expected type, validation failed.")
  obj.knowledge_base.nil? || Vapi::CreateCustomKnowledgeBaseDto.validate_raw(obj: obj.knowledge_base)
  obj.knowledge_base_id&.is_a?(String) != false || raise("Passed value for field obj.knowledge_base_id is not the expected type, validation failed.")
  obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
  obj.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_id is not the expected type, validation failed.")
  obj.workflow.nil? || Vapi::WorkflowUserEditable.validate_raw(obj: obj.workflow)
  obj.model.is_a?(String) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
  obj.temperature&.is_a?(Float) != false || raise("Passed value for field obj.temperature is not the expected type, validation failed.")
  obj.max_tokens&.is_a?(Float) != false || raise("Passed value for field obj.max_tokens is not the expected type, validation failed.")
  obj.emotion_recognition_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.emotion_recognition_enabled is not the expected type, validation failed.")
  obj.num_fast_turns&.is_a?(Float) != false || raise("Passed value for field obj.num_fast_turns is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of VapiModel to a JSON object



185
186
187
 
# File 'lib/vapi_server_sdk/types/vapi_model.rb', line 185

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