Class: Vapi::CreateComputerToolDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sub_type:, name:, display_width_px:, display_height_px:, messages: OMIT, server: OMIT, display_number: OMIT, function: OMIT, additional_properties: nil) ⇒ Vapi::CreateComputerToolDto

Parameters:

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

    These are the messages that will be spoken to the user as the tool is running. For some tools, this is auto-filled based on special fields like tool.destinations. For others like the function tool, these can be custom configured.

  • sub_type (String) —

    The sub type of tool.

  • server (Vapi::Server) (defaults to: OMIT) —

    This is the server where a tool-calls webhook will be sent. Notes:

    • Webhook is sent to this server when a tool call is made.

    • Webhook contains the call, assistant, and phone number objects.

    • Webhook contains the variables set on the assistant.

    • Webhook is sent to the first available URL in this order:

    Vapi::CreateComputerToolDto.{tool{tool.server{tool.server.url}, Vapi::CreateComputerToolDto.{assistant{assistant.server{assistant.server.url}, Vapi::CreateComputerToolDto.{phoneNumber{phoneNumber.server{phoneNumber.server.url}, Vapi::CreateComputerToolDto.{org{org.server{org.server.url}.

    • Webhook expects a response with tool call result.

  • name (String) —

    The name of the tool, fixed to ‘computer’

  • display_width_px (Float) —

    The display width in pixels

  • display_height_px (Float) —

    The display height in pixels

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

    Optional display number

  • function (Vapi::OpenAiFunction) (defaults to: OMIT) —

    This is the function definition of the tool. For endCall, transferCall, and dtmf tools, this is auto-filled based on tool-specific fields like tool.destinations. But, even in those cases, you can provide a custom function definition for advanced use cases. An example of an advanced use case is if you want to customize the message that’s spoken for endCall tool. You can specify a function where it returns an argument “reason”. Then, in messages array, you can have many “request-complete” messages. One of these messages will be triggered if the messages[].conditions matches the “reason” argument.

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

    Additional properties unmapped to the current class definition



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/vapi_server_sdk/types/create_computer_tool_dto.rb', line 85

def initialize(sub_type:, name:, display_width_px:, display_height_px:, messages: OMIT, server: OMIT,
               display_number: OMIT, function: OMIT, additional_properties: nil)
  @messages = messages if messages != OMIT
  @sub_type = sub_type
  @server = server if server != OMIT
  @name = name
  @display_width_px = display_width_px
  @display_height_px = display_height_px
  @display_number = display_number if display_number != OMIT
  @function = function if function != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "messages": messages,
    "subType": sub_type,
    "server": server,
    "name": name,
    "displayWidthPx": display_width_px,
    "displayHeightPx": display_height_px,
    "displayNumber": display_number,
    "function": function
  }.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



48
49
50
 
# File 'lib/vapi_server_sdk/types/create_computer_tool_dto.rb', line 48

def additional_properties
  @additional_properties
end

#display_height_px ⇒ Float (readonly)

Returns The display height in pixels.

Returns:

  • (Float) —

    The display height in pixels



34
35
36
 
# File 'lib/vapi_server_sdk/types/create_computer_tool_dto.rb', line 34

def display_height_px
  @display_height_px
end

#display_number ⇒ Float (readonly)

Returns Optional display number.

Returns:

  • (Float) —

    Optional display number



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

def display_number
  @display_number
end

#display_width_px ⇒ Float (readonly)

Returns The display width in pixels.

Returns:

  • (Float) —

    The display width in pixels



32
33
34
 
# File 'lib/vapi_server_sdk/types/create_computer_tool_dto.rb', line 32

def display_width_px
  @display_width_px
end

#function ⇒ Vapi::OpenAiFunction (readonly)

Returns This is the function definition of the tool. For endCall, transferCall, and dtmf tools, this is auto-filled based on tool-specific fields like tool.destinations. But, even in those cases, you can provide a custom function definition for advanced use cases. An example of an advanced use case is if you want to customize the message that’s spoken for endCall tool. You can specify a function where it returns an argument “reason”. Then, in messages array, you can have many “request-complete” messages. One of these messages will be triggered if the messages[].conditions matches the “reason” argument.

Returns:

  • (Vapi::OpenAiFunction) —

    This is the function definition of the tool. For endCall, transferCall, and dtmf tools, this is auto-filled based on tool-specific fields like tool.destinations. But, even in those cases, you can provide a custom function definition for advanced use cases. An example of an advanced use case is if you want to customize the message that’s spoken for endCall tool. You can specify a function where it returns an argument “reason”. Then, in messages array, you can have many “request-complete” messages. One of these messages will be triggered if the messages[].conditions matches the “reason” argument.



46
47
48
 
# File 'lib/vapi_server_sdk/types/create_computer_tool_dto.rb', line 46

def function
  @function
end

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

Returns These are the messages that will be spoken to the user as the tool is running. For some tools, this is auto-filled based on special fields like tool.destinations. For others like the function tool, these can be custom configured.

Returns:

  • (Array<Vapi::CreateComputerToolDtoMessagesItem>) —

    These are the messages that will be spoken to the user as the tool is running. For some tools, this is auto-filled based on special fields like tool.destinations. For others like the function tool, these can be custom configured.



15
16
17
 
# File 'lib/vapi_server_sdk/types/create_computer_tool_dto.rb', line 15

def messages
  @messages
end

#name ⇒ String (readonly)

Returns The name of the tool, fixed to ‘computer’.

Returns:

  • (String) —

    The name of the tool, fixed to ‘computer’



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

def name
  @name
end

#server ⇒ Vapi::Server (readonly)

Returns This is the server where a tool-calls webhook will be sent. Notes:

  • Webhook is sent to this server when a tool call is made.

  • Webhook contains the call, assistant, and phone number objects.

  • Webhook contains the variables set on the assistant.

  • Webhook is sent to the first available URL in this order:

Vapi::CreateComputerToolDto.{tool{tool.server{tool.server.url}, Vapi::CreateComputerToolDto.{assistant{assistant.server{assistant.server.url}, Vapi::CreateComputerToolDto.{phoneNumber{phoneNumber.server{phoneNumber.server.url}, Vapi::CreateComputerToolDto.{org{org.server{org.server.url}.

  • Webhook expects a response with tool call result.

Returns:

  • (Vapi::Server) —

    This is the server where a tool-calls webhook will be sent. Notes:

    • Webhook is sent to this server when a tool call is made.

    • Webhook contains the call, assistant, and phone number objects.

    • Webhook contains the variables set on the assistant.

    • Webhook is sent to the first available URL in this order:

    Vapi::CreateComputerToolDto.{tool{tool.server{tool.server.url}, Vapi::CreateComputerToolDto.{assistant{assistant.server{assistant.server.url}, Vapi::CreateComputerToolDto.{phoneNumber{phoneNumber.server{phoneNumber.server.url}, Vapi::CreateComputerToolDto.{org{org.server{org.server.url}.

    • Webhook expects a response with tool call result.



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

def server
  @server
end

#sub_type ⇒ String (readonly)

Returns The sub type of tool.

Returns:

  • (String) —

    The sub type of tool.



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

def sub_type
  @sub_type
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CreateComputerToolDto

Deserialize a JSON object to an instance of CreateComputerToolDto

Parameters:

  • json_object (String)

Returns:



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
149
 
# File 'lib/vapi_server_sdk/types/create_computer_tool_dto.rb', line 114

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::CreateComputerToolDtoMessagesItem.from_json(json_object: item)
  end
  sub_type = parsed_json["subType"]
  if parsed_json["server"].nil?
    server = nil
  else
    server = parsed_json["server"].to_json
    server = Vapi::Server.from_json(json_object: server)
  end
  name = parsed_json["name"]
  display_width_px = parsed_json["displayWidthPx"]
  display_height_px = parsed_json["displayHeightPx"]
  display_number = parsed_json["displayNumber"]
  if parsed_json["function"].nil?
    function = nil
  else
    function = parsed_json["function"].to_json
    function = Vapi::OpenAiFunction.from_json(json_object: function)
  end
  new(
    messages: messages,
    sub_type: sub_type,
    server: server,
    name: name,
    display_width_px: display_width_px,
    display_height_px: display_height_px,
    display_number: display_number,
    function: function,
    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) 


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

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.sub_type.is_a?(String) != false || raise("Passed value for field obj.sub_type is not the expected type, validation failed.")
  obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.display_width_px.is_a?(Float) != false || raise("Passed value for field obj.display_width_px is not the expected type, validation failed.")
  obj.display_height_px.is_a?(Float) != false || raise("Passed value for field obj.display_height_px is not the expected type, validation failed.")
  obj.display_number&.is_a?(Float) != false || raise("Passed value for field obj.display_number is not the expected type, validation failed.")
  obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CreateComputerToolDto to a JSON object

Returns:

  • (String) 


154
155
156
 
# File 'lib/vapi_server_sdk/types/create_computer_tool_dto.rb', line 154

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