Module: LLM

Defined in:
lib/llm.rb,
lib/llm/bot.rb,
lib/llm/error.rb,
lib/llm/buffer.rb,
lib/llm/client.rb,
lib/llm/message.rb,
lib/llm/version.rb,
lib/llm/response.rb,
lib/llm/eventhandler.rb,
lib/llm/providers/xai.rb,
lib/llm/providers/zai.rb,
lib/llm/providers/gemini.rb,
lib/llm/providers/ollama.rb,
lib/llm/providers/openai.rb,
lib/llm/providers/deepseek.rb,
lib/llm/providers/llamacpp.rb,
lib/llm/providers/anthropic.rb

Defined Under Namespace

Modules: Client, EventStream, Utils Classes: Anthropic, Bot, Buffer, Builder, DeepSeek, Error, EventHandler, File, Function, Gemini, LlamaCpp, Message, Mime, Multipart, Object, Ollama, OpenAI, Provider, Response, ResponseError, Schema, ServerTool, Tool, XAI, ZAI

Constant Summary collapse

UnauthorizedError =

HTTPUnauthorized

Class.new(ResponseError)
RateLimitError =

HTTPTooManyRequests

Class.new(ResponseError)
ServerError =

HTTPServerError

Class.new(ResponseError)
NoImageError =

When no images are found in a response

Class.new(ResponseError)
FormatError =

When an given an input object that is not understood

Class.new(Error)
PromptError =

When given a prompt object that is not understood

Class.new(FormatError)
VERSION = 
"2.0.1"

Class Method Summary collapse

Class Method Details

.anthropic ⇒ Anthropic

Returns a new instance of Anthropic.

Parameters:

  • key (String, nil) —

    The secret key for authentication

  • host (String) —

    The host address of the LLM provider

  • port (Integer) —

    The port number

  • timeout (Integer) —

    The number of seconds to wait for a response

  • ssl (Boolean) —

    Whether to use SSL for the connection

  • persistent (Boolean) —

    Whether to use a persistent connection. Requires the net-http-persistent gem.

Returns:

  • (Anthropic) —

    a new instance of Anthropic



34
35
36
37
 
# File 'lib/llm.rb', line 34

def anthropic(**)
  lock(:require) { require_relative "llm/providers/anthropic" unless defined?(LLM::Anthropic) }
  LLM::Anthropic.new(**)
end

.deepseek ⇒ LLM::DeepSeek

Parameters:

  • key (String, nil) —

    The secret key for authentication

Returns:



66
67
68
69
 
# File 'lib/llm.rb', line 66

def deepseek(**)
  lock(:require) { require_relative "llm/providers/deepseek" unless defined?(LLM::DeepSeek) }
  LLM::DeepSeek.new(**)
end

.File(obj) ⇒ LLM::File

Parameters:

  • obj (String, File, LLM::Response) —

    The path to the file, or an existing file reference

Returns:



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/llm/file.rb', line 82

def LLM.File(obj)
  case obj
  when File
    obj.close unless obj.closed?
    LLM.File(obj.path)
  when LLM::File, LLM::Response then obj
  when String then LLM::File.new(obj)
  else raise TypeError, "don't know how to handle #{obj.class} objects"
  end
end

.function(key, &b) ⇒ LLM::Function

Define a function

Examples:

LLM.function(:system) do |fn|
  fn.description "Run system command"
  fn.params do |schema|
    schema.object(command: schema.string.required)
  end
  fn.define do |command:|
    system(command)
  end
end

Parameters:

  • key (Symbol) —

    The function name / key

  • b (Proc) —

    The block to define the function

Returns:



112
113
114
 
# File 'lib/llm.rb', line 112

def function(key, &b)
  LLM::Function.new(key, &b)
end

.gemini ⇒ Gemini

Returns a new instance of Gemini.

Parameters:

  • key (String, nil) —

    The secret key for authentication

  • host (String) —

    The host address of the LLM provider

  • port (Integer) —

    The port number

  • timeout (Integer) —

    The number of seconds to wait for a response

  • ssl (Boolean) —

    Whether to use SSL for the connection

  • persistent (Boolean) —

    Whether to use a persistent connection. Requires the net-http-persistent gem.

Returns:

  • (Gemini) —

    a new instance of Gemini



42
43
44
45
 
# File 'lib/llm.rb', line 42

def gemini(**)
  lock(:require) { require_relative "llm/providers/gemini" unless defined?(LLM::Gemini) }
  LLM::Gemini.new(**)
end

.llamacpp(key: nil) ⇒ LLM::LlamaCpp

Parameters:

  • key (String, nil) (defaults to: nil) —

    The secret key for authentication

Returns:



58
59
60
61
 
# File 'lib/llm.rb', line 58

def llamacpp(key: nil, **)
  lock(:require) { require_relative "llm/providers/llamacpp" unless defined?(LLM::LlamaCpp) }
  LLM::LlamaCpp.new(key:, **)
end

.lock(name) ⇒ void

This method returns an undefined value.

Provides a thread-safe lock

Parameters:

  • name (Symbol) —

    The name of the lock

  • & (Proc) —

    The block to execute within the lock



121
 
# File 'lib/llm.rb', line 121

def lock(name, &) = @monitors[name].synchronize(&)

.ollama(key: nil) ⇒ Ollama

Returns a new instance of Ollama.

Parameters:

  • key (String, nil) (defaults to: nil) —

    The secret key for authentication

Returns:

  • (Ollama) —

    a new instance of Ollama



50
51
52
53
 
# File 'lib/llm.rb', line 50

def ollama(key: nil, **)
  lock(:require) { require_relative "llm/providers/ollama" unless defined?(LLM::Ollama) }
  LLM::Ollama.new(key:, **)
end

.openai ⇒ OpenAI

Returns a new instance of OpenAI.

Parameters:

  • key (String, nil) —

    The secret key for authentication

Returns:

  • (OpenAI) —

    a new instance of OpenAI



74
75
76
77
 
# File 'lib/llm.rb', line 74

def openai(**)
  lock(:require) { require_relative "llm/providers/openai" unless defined?(LLM::OpenAI) }
  LLM::OpenAI.new(**)
end

.xai ⇒ XAI

Returns a new instance of XAI.

Parameters:

  • key (String, nil) —

    The secret key for authentication

  • host (String) —

    A regional host or the default (“api.x.ai”)

Returns:

  • (XAI) —

    a new instance of XAI



83
84
85
86
 
# File 'lib/llm.rb', line 83

def xai(**)
  lock(:require) { require_relative "llm/providers/xai" unless defined?(LLM::XAI) }
  LLM::XAI.new(**)
end

.zai ⇒ ZAI

Returns a new instance of ZAI.

Parameters:

  • key (String, nil) —

    The secret key for authentication

  • host (String) —

    A regional host or the default (“api.z.ai”)

Returns:

  • (ZAI) —

    a new instance of ZAI



92
93
94
95
 
# File 'lib/llm.rb', line 92

def zai(**)
  lock(:require) { require_relative "llm/providers/zai" unless defined?(LLM::ZAI) }
  LLM::ZAI.new(**)
end