class Riffer::Messages::Tool

Represents a tool execution result in a conversation.

msg = Riffer::Messages::Tool.new(
  "The weather is sunny.",
  tool_call_id: "call_123",
  name: "weather_tool"
)
msg.role          # => :tool
msg.tool_call_id  # => "call_123"
msg.error?        # => false

Attributes

error [R]

The error message if the tool execution failed.

error_type [R]

The type of error (:unknown_tool, :validation_error, :execution_error, :timeout_error).

name [R]

The name of the tool that was called.

tool_call_id [R]

The ID of the tool call this result responds to.

Public Class Methods

new (content, tool_call_id:, name:, error: nil, error_type: nil)

Source

# File lib/riffer/messages/tool.rb, line 30
def initialize(content, tool_call_id:, name:, error: nil, error_type: nil)
  super(content)
  @tool_call_id = tool_call_id
  @name = name
  @error = error
  @error_type = error_type
end

Calls superclass method Riffer::Messages::Base::new

Public Instance Methods

error? ()

Source

# File lib/riffer/messages/tool.rb, line 42
def error?
  !@error.nil?
end

Returns true if the tool execution resulted in an error.

role ()

Source

# File lib/riffer/messages/tool.rb, line 48
def role
  :tool
end

to_h ()

Source

# File lib/riffer/messages/tool.rb, line 56
def to_h
  hash = {role: role, content: content, tool_call_id: tool_call_id, name: name}
  if error?
    hash[:error] = error
    hash[:error_type] = error_type
  end
  hash
end

Converts the message to a hash.