Class: Vapi::OpenAiMessage

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role:, content: OMIT, additional_properties: nil) ⇒ Vapi::OpenAiMessage

Parameters:

  • content (String) (defaults to: OMIT)
  • role (Vapi::OpenAiMessageRole)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
31
32
 
# File 'lib/vapi_server_sdk/types/open_ai_message.rb', line 25

def initialize(role:, content: OMIT, additional_properties: nil)
  @content = content if content != OMIT
  @role = role
  @additional_properties = additional_properties
  @_field_set = { "content": content, "role": role }.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



14
15
16
 
# File 'lib/vapi_server_sdk/types/open_ai_message.rb', line 14

def additional_properties
  @additional_properties
end

#content ⇒ String (readonly)

Returns:

  • (String) 


10
11
12
 
# File 'lib/vapi_server_sdk/types/open_ai_message.rb', line 10

def content
  @content
end

#role ⇒ Vapi::OpenAiMessageRole (readonly)

Returns:



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

def role
  @role
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::OpenAiMessage

Deserialize a JSON object to an instance of OpenAiMessage

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/vapi_server_sdk/types/open_ai_message.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  content = parsed_json["content"]
  role = parsed_json["role"]
  new(
    content: content,
    role: role,
    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) 


63
64
65
66
 
# File 'lib/vapi_server_sdk/types/open_ai_message.rb', line 63

def self.validate_raw(obj:)
  obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
  obj.role.is_a?(Vapi::OpenAiMessageRole) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of OpenAiMessage to a JSON object

Returns:

  • (String) 


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

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