Class: Vapi::GhlToolWithToolCall

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tool_call:, metadata:, messages: OMIT, function: OMIT, additional_properties: nil) ⇒ Vapi::GhlToolWithToolCall

Parameters:

  • messages (Array<Vapi::GhlToolWithToolCallMessagesItem>) (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.

  • tool_call (Vapi::ToolCall)
  • metadata (Vapi::GhlToolMetadata)
  • 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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb', line 56

def initialize(tool_call:, metadata:, messages: OMIT, function: OMIT, additional_properties: nil)
  @messages = messages if messages != OMIT
  @tool_call = tool_call
  @metadata = metadata
  @function = function if function != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "messages": messages,
    "toolCall": tool_call,
    "metadata": metadata,
    "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



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

def additional_properties
  @additional_properties
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.



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

def function
  @function
end

#messages ⇒ Array<Vapi::GhlToolWithToolCallMessagesItem> (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::GhlToolWithToolCallMessagesItem>) —

    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.



16
17
18
 
# File 'lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb', line 16

def messages
  @messages
end

#metadata ⇒ Vapi::GhlToolMetadata (readonly)

Returns:



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

def metadata
  @metadata
end

#tool_call ⇒ Vapi::ToolCall (readonly)

Returns:



18
19
20
 
# File 'lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb', line 18

def tool_call
  @tool_call
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::GhlToolWithToolCall

Deserialize a JSON object to an instance of GhlToolWithToolCall

Parameters:

  • json_object (String)

Returns:



76
77
78
79
80
81
82
83
84
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/ghl_tool_with_tool_call.rb', line 76

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::GhlToolWithToolCallMessagesItem.from_json(json_object: item)
  end
  if parsed_json["toolCall"].nil?
    tool_call = nil
  else
    tool_call = parsed_json["toolCall"].to_json
    tool_call = Vapi::ToolCall.from_json(json_object: tool_call)
  end
  if parsed_json["metadata"].nil?
    metadata = nil
  else
    metadata = parsed_json["metadata"].to_json
    metadata = Vapi::GhlToolMetadata.from_json(json_object: metadata)
  end
  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,
    tool_call: tool_call,
    metadata: metadata,
    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) 


123
124
125
126
127
128
 
# File 'lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb', line 123

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.")
  Vapi::ToolCall.validate_raw(obj: obj.tool_call)
  Vapi::GhlToolMetadata.validate_raw(obj: obj.metadata)
  obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of GhlToolWithToolCall to a JSON object

Returns:

  • (String) 


113
114
115
 
# File 'lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb', line 113

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