Class: Vapi::ServerMessageKnowledgeBaseRequest

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(messages_open_ai_formatted:, phone_number: OMIT, messages: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT, chat: OMIT, additional_properties: nil) ⇒ Vapi::ServerMessageKnowledgeBaseRequest

Parameters:

  • phone_number (Vapi::ServerMessageKnowledgeBaseRequestPhoneNumber) (defaults to: OMIT) —

    This is the phone number that the message is associated with.

  • messages (Array<Vapi::ServerMessageKnowledgeBaseRequestMessagesItem>) (defaults to: OMIT) —

    These are the messages that are going to be sent to the ‘model` right after the `knowledge-base-request` webhook completes.

  • messages_open_ai_formatted (Array<Vapi::OpenAiMessage>) —

    This is just ‘messages` formatted for OpenAI.

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

    This is the timestamp of the message.

  • artifact (Vapi::Artifact) (defaults to: OMIT) —

    This is a live version of the ‘call.artifact`. This matches what is stored on `call.artifact` after the call.

  • assistant (Vapi::CreateAssistantDto) (defaults to: OMIT) —

    This is the assistant that the message is associated with.

  • customer (Vapi::CreateCustomerDto) (defaults to: OMIT) —

    This is the customer that the message is associated with.

  • call (Vapi::Call) (defaults to: OMIT) —

    This is the call that the message is associated with.

  • chat (Vapi::Chat) (defaults to: OMIT) —

    This is the chat object.

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

    Additional properties unmapped to the current class definition



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
 
# File 'lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb', line 57

def initialize(messages_open_ai_formatted:, phone_number: OMIT, messages: OMIT, timestamp: OMIT, artifact: OMIT,
               assistant: OMIT, customer: OMIT, call: OMIT, chat: OMIT, additional_properties: nil)
  @phone_number = phone_number if phone_number != OMIT
  @messages = messages if messages != OMIT
  @messages_open_ai_formatted = messages_open_ai_formatted
  @timestamp = timestamp if timestamp != OMIT
  @artifact = artifact if artifact != OMIT
  @assistant = assistant if assistant != OMIT
  @customer = customer if customer != OMIT
  @call = call if call != OMIT
  @chat = chat if chat != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "phoneNumber": phone_number,
    "messages": messages,
    "messagesOpenAIFormatted": messages_open_ai_formatted,
    "timestamp": timestamp,
    "artifact": artifact,
    "assistant": assistant,
    "customer": customer,
    "call": call,
    "chat": chat
  }.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



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

def additional_properties
  @additional_properties
end

#artifact ⇒ Vapi::Artifact (readonly)

Returns This is a live version of the ‘call.artifact`. This matches what is stored on `call.artifact` after the call.

Returns:

  • (Vapi::Artifact) —

    This is a live version of the ‘call.artifact`. This matches what is stored on `call.artifact` after the call.



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

def artifact
  @artifact
end

#assistant ⇒ Vapi::CreateAssistantDto (readonly)

Returns This is the assistant that the message is associated with.

Returns:



29
30
31
 
# File 'lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb', line 29

def assistant
  @assistant
end

#call ⇒ Vapi::Call (readonly)

Returns This is the call that the message is associated with.

Returns:

  • (Vapi::Call) —

    This is the call that the message is associated with.



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

def call
  @call
end

#chat ⇒ Vapi::Chat (readonly)

Returns This is the chat object.

Returns:



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

def chat
  @chat
end

#customer ⇒ Vapi::CreateCustomerDto (readonly)

Returns This is the customer that the message is associated with.

Returns:



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

def customer
  @customer
end

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

Returns These are the messages that are going to be sent to the ‘model` right after the `knowledge-base-request` webhook completes.

Returns:



20
21
22
 
# File 'lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb', line 20

def messages
  @messages
end

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

Returns This is just ‘messages` formatted for OpenAI.

Returns:



22
23
24
 
# File 'lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb', line 22

def messages_open_ai_formatted
  @messages_open_ai_formatted
end

#phone_number ⇒ Vapi::ServerMessageKnowledgeBaseRequestPhoneNumber (readonly)

Returns This is the phone number that the message is associated with.

Returns:



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

def phone_number
  @phone_number
end

#timestamp ⇒ Float (readonly)

Returns This is the timestamp of the message.

Returns:

  • (Float) —

    This is the timestamp of the message.



24
25
26
 
# File 'lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb', line 24

def timestamp
  @timestamp
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ServerMessageKnowledgeBaseRequest

Deserialize a JSON object to an instance of ServerMessageKnowledgeBaseRequest

Parameters:

  • json_object (String)

Returns:



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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb', line 88

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["phoneNumber"].nil?
    phone_number = nil
  else
    phone_number = parsed_json["phoneNumber"].to_json
    phone_number = Vapi::ServerMessageKnowledgeBaseRequestPhoneNumber.from_json(json_object: phone_number)
  end
  messages = parsed_json["messages"]&.map do |item|
    item = item.to_json
    Vapi::ServerMessageKnowledgeBaseRequestMessagesItem.from_json(json_object: item)
  end
  messages_open_ai_formatted = parsed_json["messagesOpenAIFormatted"]&.map do |item|
    item = item.to_json
    Vapi::OpenAiMessage.from_json(json_object: item)
  end
  timestamp = parsed_json["timestamp"]
  if parsed_json["artifact"].nil?
    artifact = nil
  else
    artifact = parsed_json["artifact"].to_json
    artifact = Vapi::Artifact.from_json(json_object: artifact)
  end
  if parsed_json["assistant"].nil?
    assistant = nil
  else
    assistant = parsed_json["assistant"].to_json
    assistant = Vapi::CreateAssistantDto.from_json(json_object: assistant)
  end
  if parsed_json["customer"].nil?
    customer = nil
  else
    customer = parsed_json["customer"].to_json
    customer = Vapi::CreateCustomerDto.from_json(json_object: customer)
  end
  if parsed_json["call"].nil?
    call = nil
  else
    call = parsed_json["call"].to_json
    call = Vapi::Call.from_json(json_object: call)
  end
  if parsed_json["chat"].nil?
    chat = nil
  else
    chat = parsed_json["chat"].to_json
    chat = Vapi::Chat.from_json(json_object: chat)
  end
  new(
    phone_number: phone_number,
    messages: messages,
    messages_open_ai_formatted: messages_open_ai_formatted,
    timestamp: timestamp,
    artifact: artifact,
    assistant: assistant,
    customer: customer,
    call: call,
    chat: chat,
    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) 


163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb', line 163

def self.validate_raw(obj:)
  obj.phone_number.nil? || Vapi::ServerMessageKnowledgeBaseRequestPhoneNumber.validate_raw(obj: obj.phone_number)
  obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
  obj.messages_open_ai_formatted.is_a?(Array) != false || raise("Passed value for field obj.messages_open_ai_formatted is not the expected type, validation failed.")
  obj.timestamp&.is_a?(Float) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
  obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
  obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)
  obj.customer.nil? || Vapi::CreateCustomerDto.validate_raw(obj: obj.customer)
  obj.call.nil? || Vapi::Call.validate_raw(obj: obj.call)
  obj.chat.nil? || Vapi::Chat.validate_raw(obj: obj.chat)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ServerMessageKnowledgeBaseRequest to a JSON object

Returns:

  • (String) 


153
154
155
 
# File 'lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb', line 153

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