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.



226
227
228
229
 
# File 'lib/ruby_llm/tool.rb', line 226

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

Class Method Details

.default_items_schema ⇒ Object 



222
223
224
 
# File 'lib/ruby_llm/tool.rb', line 222

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

.from_parameters(parameters, allow_empty: false) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ruby_llm/tool.rb', line 183

def self.from_parameters(parameters, allow_empty: false)
  return nil if parameters.nil? || (parameters.empty? && !allow_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 



210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/ruby_llm/tool.rb', line 210

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 



235
236
237
 
# File 'lib/ruby_llm/tool.rb', line 235

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

#present? ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/ruby_llm/tool.rb', line 231

def present?
  @schema || @block
end