Class: Vapi::ToolCallBlock

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, org_id:, created_at:, updated_at:, messages: OMIT, input_schema: OMIT, output_schema: OMIT, tool: OMIT, name: OMIT, tool_id: OMIT, additional_properties: nil) ⇒ Vapi::ToolCallBlock

Parameters:

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

    These are the pre-configured messages that will be spoken to the user while the block is running.

  • input_schema (Vapi::JsonSchema) (defaults to: OMIT) —

    This is the input schema for the block. This is the input the block needs to run. It’s given to the block as ‘steps.input` These are accessible as variables:

    • (Vapi::ToolCallBlock.{input{input.propertyName}) in context of the block execution (step)

    • (Vapi::ToolCallBlock.{stepName{stepName.input{stepName.input.propertyName}) in context of the workflow

  • output_schema (Vapi::JsonSchema) (defaults to: OMIT) —

    This is the output schema for the block. This is the output the block will return to the workflow (‘Vapi::ToolCallBlock.{stepName{stepName.output}`). These are accessible as variables:

    • (Vapi::ToolCallBlock.{output{output.propertyName}) in context of the block execution (step)

    • (Vapi::ToolCallBlock.{stepName{stepName.output{stepName.output.propertyName}) in context of the workflow (read caveat #1)

    • (Vapi::ToolCallBlock.{blockName{blockName.output{blockName.output.propertyName}) in context of the workflow (read caveat

    #2) Caveats:

    1. a workflow can execute a step multiple times. example, if a loop is used in

    the graph. Vapi::ToolCallBlock.{stepName{stepName.output{stepName.output.propertyName} will reference the latest usage of the step.

    1. a workflow can execute a block multiple times. example, if a step is called

    multiple times or if a block is used in multiple steps. Vapi::ToolCallBlock.{blockName{blockName.output{blockName.output.propertyName} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow with steps.

  • tool (Vapi::ToolCallBlockTool) (defaults to: OMIT) —

    This is the tool that the block will call. To use an existing tool, use ‘toolId`.

  • id (String) —

    This is the unique identifier for the block.

  • org_id (String) —

    This is the unique identifier for the organization that this block belongs to.

  • created_at (DateTime) —

    This is the ISO 8601 date-time string of when the block was created.

  • updated_at (DateTime) —

    This is the ISO 8601 date-time string of when the block was last updated.

  • name (String) (defaults to: OMIT) —

    This is the name of the block. This is just for your reference.

  • tool_id (String) (defaults to: OMIT) —

    This is the id of the tool that the block will call. To use a transient tool, use ‘tool`.

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

    Additional properties unmapped to the current class definition



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

def initialize(id:, org_id:, created_at:, updated_at:, messages: OMIT, input_schema: OMIT, output_schema: OMIT,
               tool: OMIT, name: OMIT, tool_id: OMIT, additional_properties: nil)
  @messages = messages if messages != OMIT
  @input_schema = input_schema if input_schema != OMIT
  @output_schema = output_schema if output_schema != OMIT
  @tool = tool if tool != OMIT
  @id = id
  @org_id = org_id
  @created_at = created_at
  @updated_at = updated_at
  @name = name if name != OMIT
  @tool_id = tool_id if tool_id != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "messages": messages,
    "inputSchema": input_schema,
    "outputSchema": output_schema,
    "tool": tool,
    "id": id,
    "orgId": org_id,
    "createdAt": created_at,
    "updatedAt": updated_at,
    "name": name,
    "toolId": tool_id
  }.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



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

def additional_properties
  @additional_properties
end

#created_at ⇒ DateTime (readonly)

Returns This is the ISO 8601 date-time string of when the block was created.

Returns:

  • (DateTime) —

    This is the ISO 8601 date-time string of when the block was created.



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

def created_at
  @created_at
end

#id ⇒ String (readonly)

Returns This is the unique identifier for the block.

Returns:

  • (String) —

    This is the unique identifier for the block.



42
43
44
 
# File 'lib/vapi_server_sdk/types/tool_call_block.rb', line 42

def id
  @id
end

#input_schema ⇒ Vapi::JsonSchema (readonly)

Returns This is the input schema for the block. This is the input the block needs to run. It’s given to the block as ‘steps.input` These are accessible as variables:

  • (Vapi::ToolCallBlock.{input{input.propertyName}) in context of the block execution (step)

  • (Vapi::ToolCallBlock.{stepName{stepName.input{stepName.input.propertyName}) in context of the workflow.

Returns:

  • (Vapi::JsonSchema) —

    This is the input schema for the block. This is the input the block needs to run. It’s given to the block as ‘steps.input` These are accessible as variables:

    • (Vapi::ToolCallBlock.{input{input.propertyName}) in context of the block execution (step)

    • (Vapi::ToolCallBlock.{stepName{stepName.input{stepName.input.propertyName}) in context of the workflow



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

def input_schema
  @input_schema
end

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

Returns These are the pre-configured messages that will be spoken to the user while the block is running.

Returns:



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

def messages
  @messages
end

#name ⇒ String (readonly)

Returns This is the name of the block. This is just for your reference.

Returns:

  • (String) —

    This is the name of the block. This is just for your reference.



50
51
52
 
# File 'lib/vapi_server_sdk/types/tool_call_block.rb', line 50

def name
  @name
end

#org_id ⇒ String (readonly)

Returns This is the unique identifier for the organization that this block belongs to.

Returns:

  • (String) —

    This is the unique identifier for the organization that this block belongs to.



44
45
46
 
# File 'lib/vapi_server_sdk/types/tool_call_block.rb', line 44

def org_id
  @org_id
end

#output_schema ⇒ Vapi::JsonSchema (readonly)

This is the output schema for the block. This is the output the block will return to the workflow (‘Vapi::ToolCallBlock.{stepName{stepName.output}`). These are accessible as variables:

  • (Vapi::ToolCallBlock.{output{output.propertyName}) in context of the block execution (step)

  • (Vapi::ToolCallBlock.{stepName{stepName.output{stepName.output.propertyName}) in context of the workflow (read caveat #1)

  • (Vapi::ToolCallBlock.{blockName{blockName.output{blockName.output.propertyName}) in context of the workflow (read caveat

#2) Caveats:

  1. a workflow can execute a step multiple times. example, if a loop is used in

the graph. Vapi::ToolCallBlock.{stepName{stepName.output{stepName.output.propertyName} will reference the latest usage of the step.

  1. a workflow can execute a block multiple times. example, if a step is called

multiple times or if a block is used in multiple steps. Vapi::ToolCallBlock.{blockName{blockName.output{blockName.output.propertyName} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow with steps.

Returns:

  • (Vapi::JsonSchema) —

    This is the output schema for the block. This is the output the block will return to the workflow (‘Vapi::ToolCallBlock.{stepName{stepName.output}`). These are accessible as variables:

    • (Vapi::ToolCallBlock.{output{output.propertyName}) in context of the block execution (step)

    • (Vapi::ToolCallBlock.{stepName{stepName.output{stepName.output.propertyName}) in context of the workflow (read caveat #1)

    • (Vapi::ToolCallBlock.{blockName{blockName.output{blockName.output.propertyName}) in context of the workflow (read caveat

    #2) Caveats:

    1. a workflow can execute a step multiple times. example, if a loop is used in

    the graph. Vapi::ToolCallBlock.{stepName{stepName.output{stepName.output.propertyName} will reference the latest usage of the step.

    1. a workflow can execute a block multiple times. example, if a step is called

    multiple times or if a block is used in multiple steps. Vapi::ToolCallBlock.{blockName{blockName.output{blockName.output.propertyName} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow with steps.



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

def output_schema
  @output_schema
end

#tool ⇒ Vapi::ToolCallBlockTool (readonly)

Returns This is the tool that the block will call. To use an existing tool, use ‘toolId`.

Returns:

  • (Vapi::ToolCallBlockTool) —

    This is the tool that the block will call. To use an existing tool, use ‘toolId`.



40
41
42
 
# File 'lib/vapi_server_sdk/types/tool_call_block.rb', line 40

def tool
  @tool
end

#tool_id ⇒ String (readonly)

Returns This is the id of the tool that the block will call. To use a transient tool, use ‘tool`.

Returns:

  • (String) —

    This is the id of the tool that the block will call. To use a transient tool, use ‘tool`.



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

def tool_id
  @tool_id
end

#updated_at ⇒ DateTime (readonly)

Returns This is the ISO 8601 date-time string of when the block was last updated.

Returns:

  • (DateTime) —

    This is the ISO 8601 date-time string of when the block was last updated.



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

def updated_at
  @updated_at
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ToolCallBlock

Deserialize a JSON object to an instance of ToolCallBlock

Parameters:

  • json_object (String)

Returns:



129
130
131
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
 
# File 'lib/vapi_server_sdk/types/tool_call_block.rb', line 129

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::ToolCallBlockMessagesItem.from_json(json_object: item)
  end
  if parsed_json["inputSchema"].nil?
    input_schema = nil
  else
    input_schema = parsed_json["inputSchema"].to_json
    input_schema = Vapi::JsonSchema.from_json(json_object: input_schema)
  end
  if parsed_json["outputSchema"].nil?
    output_schema = nil
  else
    output_schema = parsed_json["outputSchema"].to_json
    output_schema = Vapi::JsonSchema.from_json(json_object: output_schema)
  end
  if parsed_json["tool"].nil?
    tool = nil
  else
    tool = parsed_json["tool"].to_json
    tool = Vapi::ToolCallBlockTool.from_json(json_object: tool)
  end
  id = parsed_json["id"]
  org_id = parsed_json["orgId"]
  created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
  updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
  name = parsed_json["name"]
  tool_id = parsed_json["toolId"]
  new(
    messages: messages,
    input_schema: input_schema,
    output_schema: output_schema,
    tool: tool,
    id: id,
    org_id: org_id,
    created_at: created_at,
    updated_at: updated_at,
    name: name,
    tool_id: tool_id,
    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) 


188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/vapi_server_sdk/types/tool_call_block.rb', line 188

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.input_schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.input_schema)
  obj.output_schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.output_schema)
  obj.tool.nil? || Vapi::ToolCallBlockTool.validate_raw(obj: obj.tool)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
  obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.tool_id&.is_a?(String) != false || raise("Passed value for field obj.tool_id is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ToolCallBlock to a JSON object

Returns:

  • (String) 


178
179
180
 
# File 'lib/vapi_server_sdk/types/tool_call_block.rb', line 178

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