Class: LLM::Function

Inherits:
Object
  • Object
show all
Defined in:
lib/llm/function.rb

Overview

The LLM::Function class represents a local function that can be called by an LLM.

Examples:

example #1

LLM.function(:system) do |fn|
  fn.description "Runs system commands"
  fn.params do |schema|
    schema.object(command: schema.string.required)
  end
  fn.define do |command:|
    {success: Kernel.system(command)}
  end
end

example #2

class System
  def call(command:)
    {success: Kernel.system(command)}
  end
end

LLM.function(:system) do |fn|
  fn.description "Runs system commands"
  fn.params do |schema|
    schema.object(command: schema.string.required)
  end
  fn.register(System)
end

Defined Under Namespace

Classes: Return

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) {|self| ... } ⇒ Function

Returns a new instance of Function.

Parameters:

  • name (String) —

    The function name

Yield Parameters:



54
55
56
57
58
59
60
 
# File 'lib/llm/function.rb', line 54

def initialize(name, &b)
  @name = name
  @schema = LLM::Schema.new
  @called = false
  @cancelled = false
  yield(self)
end

Instance Attribute Details

#id ⇒ String?

Returns the function ID

Returns:

  • (String, nil) 


39
40
41
 
# File 'lib/llm/function.rb', line 39

def id
  @id
end

#name ⇒ String (readonly)

Returns the function name

Returns:

  • (String) 


44
45
46
 
# File 'lib/llm/function.rb', line 44

def name
  @name
end

#arguments ⇒ Array?

Returns function arguments

Returns:

  • (Array, nil) 


49
50
51
 
# File 'lib/llm/function.rb', line 49

def arguments
  @arguments
end

Instance Method Details

#format_openai(provider) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/llm/function.rb', line 148

def format_openai(provider)
  case provider.class.to_s
  when "LLM::OpenAI::Responses"
    {
      type: "function", name: @name, description: @description,
      parameters: @params.to_h.merge(additionalProperties: false), strict: true
    }.compact
  else
    {
      type: "function", name: @name,
      function: {name: @name, description: @description, parameters: @params}
    }.compact
  end
end

#description(desc = nil) ⇒ void

This method returns an undefined value.

Set the function description

Parameters:

  • desc (String) (defaults to: nil) —

    The function description



66
67
68
69
70
71
72
 
# File 'lib/llm/function.rb', line 66

def description(desc = nil)
  if desc
    @description = desc
  else
    @description
  end
end

#params {|schema| ... } ⇒ void

This method returns an undefined value.

Yield Parameters:



77
78
79
 
# File 'lib/llm/function.rb', line 77

def params
  @params = yield(@schema)
end

#define(klass = nil, &b) ⇒ void Also known as: register

This method returns an undefined value.

Set the function implementation

Parameters:

  • b (Proc, Class) —

    The function implementation



85
86
87
 
# File 'lib/llm/function.rb', line 85

def define(klass = nil, &b)
  @runner = klass || b
end

#call ⇒ LLM::Function::Return

Call the function

Returns:



93
94
95
96
97
98
 
# File 'lib/llm/function.rb', line 93

def call
  runner = ((Class === @runner) ? @runner.new : @runner)
  Return.new(id, name, runner.call(**arguments))
ensure
  @called = true
end

#cancel(reason: "function call cancelled") ⇒ LLM::Function::Return

Returns a value that communicates that the function call was cancelled

Examples:

llm = LLM.openai(key: ENV["KEY"])
bot = LLM::Bot.new(llm, tools: [fn1, fn2])
bot.chat "I want to run the functions"
bot.chat bot.functions.map(&:cancel)

Returns:



108
109
110
111
112
 
# File 'lib/llm/function.rb', line 108

def cancel(reason: "function call cancelled")
  Return.new(id, name, {cancelled: true, reason:})
ensure
  @cancelled = true
end

#called? ⇒ Boolean

Returns true when a function has been called

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/llm/function.rb', line 117

def called?
  @called
end

#cancelled? ⇒ Boolean

Returns true when a function has been cancelled

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/llm/function.rb', line 124

def cancelled?
  @cancelled
end

#pending? ⇒ Boolean

Returns true when a function has neither been called nor cancelled

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/llm/function.rb', line 131

def pending?
  !@called && !@cancelled
end

#format(provider) ⇒ Hash

Returns:

  • (Hash) 


137
138
139
140
141
142
143
144
145
146
 
# File 'lib/llm/function.rb', line 137

def format(provider)
  case provider.class.to_s
  when "LLM::Gemini"
    {name: @name, description: @description, parameters: @params}.compact
  when "LLM::Anthropic"
    {name: @name, description: @description, input_schema: @params}.compact
  else
    format_openai(provider)
  end
end