class Riffer::Tools::Response

Represents the result of a tool execution; every tool’s call must return one.

class MyTool < Riffer::Tool
  def call(context:, **kwargs)
    result = perform_operation
    Riffer::Tools::Response.success(result)
  rescue MyError => e
    Riffer::Tools::Response.error(e.message)
  end
end

Constants

VALID_FORMATS: @rbs @success: bool

Attributes

content [R]

The response content.

error_message [R]

The error message, or nil on success.

error_type [R]

The error type, or nil on success.

exception [R]

The exception an unhandled failure was folded from, or nil. Kept out of every serialized form so it never reaches an LLM or a message payload.

Public Class Methods

error (message, type: :execution_error, exception: nil)

Source

# File lib/riffer/tools/response.rb, line 70
def self.error(message, type: :execution_error, exception: nil)
  new(content: message, success: false, error_message: message, error_type: type, exception: exception)
end

Creates an error response.

json (result)

Source

# File lib/riffer/tools/response.rb, line 62
def self.json(result)
  success(result, format: :json)
end

Creates a success response with JSON format.

new (content:, success:, error_message: nil, error_type: nil, exception: nil)

Source

# File lib/riffer/tools/response.rb, line 96
def initialize(content:, success:, error_message: nil, error_type: nil, exception: nil)
  @content = content
  @success = success
  @error_message = error_message
  @error_type = error_type
  @exception = exception
end

success (result, format: :text)

Source

# File lib/riffer/tools/response.rb, line 41
def self.success(result, format: :text)
  unless VALID_FORMATS.include?(format)
    raise Riffer::ArgumentError, "Invalid format: #{format}. Must be one of: #{VALID_FORMATS.join(', ')}"
  end

  content = format == :json ? result.to_json : result.to_s
  new(content: content, success: true)
end

Creates a success response.

Raises Riffer::ArgumentError if format is invalid.

text (result)

Source

# File lib/riffer/tools/response.rb, line 54
def self.text(result)
  success(result, format: :text)
end

Creates a success response with text format.

Public Instance Methods

error? (= !@success)

Source

# File lib/riffer/tools/response.rb, line 82
  def error? = !@success

  # Returns a hash representation of the response.
  #
  #--
  #: () -> Hash[Symbol, untyped]
  def to_h
    { content: @content, error: @error_message, error_type: @error_type }
  end

  private

  #--
  #: (content: String, success: bool, ?error_message: String?, ?error_type: Symbol?, ?exception: Exception?) -> void
  def initialize(content:, success:, error_message: nil, error_type: nil, exception: nil)
    @content = content
    @success = success
    @error_message = error_message
    @error_type = error_type
    @exception = exception
  end
end

Returns true if the tool execution failed.

success? (= @success)

Source

# File lib/riffer/tools/response.rb, line 77
def success? = @success

# Returns true if the tool execution failed.
#--
#: () -> bool
def error? = !@success

# Returns a hash representation of the response.
#
#--
#: () -> Hash[Symbol, untyped]
def to_h
  { content: @content, error: @error_message, error_type: @error_type }
end

private

#--
#: (content: String, success: bool, ?error_message: String?, ?error_type: Symbol?, ?exception: Exception?) -> void
def initialize(content:, success:, error_message: nil, error_type: nil, exception: nil)
  @content = content
  @success = success
  @error_message = error_message
  @error_type = error_type
  @exception = exception
end

Returns true if the tool execution succeeded.

to_h ()

Source

# File lib/riffer/tools/response.rb, line 88
def to_h
  { content: @content, error: @error_message, error_type: @error_type }
end

Returns a hash representation of the response.