Class: RubyLLM::Parameter

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

Overview

Parameter definition for Tool methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, type: 'string', desc: nil, required: true) ⇒ Parameter

Returns a new instance of Parameter.



10
11
12
13
14
15
# File 'lib/ruby_llm/tool.rb', line 10

def initialize(name, type: 'string', desc: nil, required: true)
  @name = name
  @type = type
  @description = desc
  @required = required
end

Instance Attribute Details

#descriptionObject (readonly)

Returns the value of attribute description.



8
9
10
# File 'lib/ruby_llm/tool.rb', line 8

def description
  @description
end

#nameObject (readonly)

Returns the value of attribute name.



8
9
10
# File 'lib/ruby_llm/tool.rb', line 8

def name
  @name
end

#requiredObject (readonly)

Returns the value of attribute required.



8
9
10
# File 'lib/ruby_llm/tool.rb', line 8

def required
  @required
end

#typeObject (readonly)

Returns the value of attribute type.



8
9
10
# File 'lib/ruby_llm/tool.rb', line 8

def type
  @type
end