Class: RubyLLM::Tool::SchemaDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_llm/tool.rb

Overview

Wraps schema handling for tool parameters, supporting JSON Schema hashes, RubyLLM::Schema instances/classes, and DSL blocks.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schema: nil, block: nil) ⇒ SchemaDefinition

Returns a new instance of SchemaDefinition.



164
165
166
167
 
# File 'lib/ruby_llm/tool.rb', line 164

def initialize(schema: nil, block: nil)
  @schema = schema
  @block = block
end

Class Method Details

.default_items_schema ⇒ Object 



160
161
162
 
# File 'lib/ruby_llm/tool.rb', line 160

def self.default_items_schema
  { type: 'string' }
end

.from_parameters(parameters) ⇒ Object 



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
 
# File 'lib/ruby_llm/tool.rb', line 121

def self.from_parameters(parameters)
  return nil if parameters.nil? || parameters.empty?

  properties = parameters.to_h do |name, param|
    schema = {
      type: map_type(param.type),
      description: param.description
    }.compact

    schema[:items] = default_items_schema if schema[:type] == 'array'

    [name.to_s, schema]
  end

  required = parameters.select { |_, param| param.required }.keys.map(&:to_s)

  json_schema = {
    type: 'object',
    properties: properties,
    required: required,
    additionalProperties: false,
    strict: true
  }

  new(schema: json_schema)
end

.map_type(type) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/ruby_llm/tool.rb', line 148

def self.map_type(type)
  case type.to_s
  when 'integer', 'int' then 'integer'
  when 'number', 'float', 'double' then 'number'
  when 'boolean' then 'boolean'
  when 'array' then 'array'
  when 'object' then 'object'
  else
    'string'
  end
end

Instance Method Details

#json_schema ⇒ Object 



173
174
175
 
# File 'lib/ruby_llm/tool.rb', line 173

def json_schema
  @json_schema ||= RubyLLM::Utils.deep_stringify_keys(resolve_schema)
end

#present? ⇒ Boolean

Returns:

  • (Boolean) 


169
170
171
 
# File 'lib/ruby_llm/tool.rb', line 169

def present?
  @schema || @block
end