Class: LLM::Ollama

Inherits:
Provider show all
Defined in:
lib/llm/providers/ollama.rb,
lib/llm/providers/ollama/format.rb,
lib/llm/providers/ollama/models.rb,
lib/llm/providers/ollama/error_handler.rb,
lib/llm/providers/ollama/stream_parser.rb,
lib/llm/providers/ollama/response_parser.rb

Overview

The Ollama class implements a provider for Ollama.

This provider supports a wide range of models, it is relatively straight forward to run on your own hardware, and includes multi-modal models that can process images and text. See the example for a demonstration of a multi-modal model by the name llava

Examples:

#!/usr/bin/env ruby
require "llm"

llm = LLM.ollama(nil)
bot = LLM::Bot.new(llm, model: "llava")
bot.chat LLM::File("/images/capybara.png")
bot.chat "Describe the image"
bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }

Defined Under Namespace

Classes: Models

Constant Summary collapse

HOST = 
"localhost"

Instance Method Summary collapse

Methods inherited from Provider

#audio, #chat, #chat!, #files, #images, #inspect, #moderations, #respond, #respond!, #responses, #schema, #with

Constructor Details

#initialize ⇒ Ollama

Returns a new instance of Ollama.

Parameters:

  • key (String, nil) —

    The secret key for authentication



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

def initialize(**)
  super(host: HOST, port: 11434, ssl: false, **)
end

Instance Method Details

#embed(input, model: default_model, **params) ⇒ LLM::Response::Embedding

Provides an embedding

Parameters:

  • input (String, Array<String>) —

    The input to embed

  • model (String) (defaults to: default_model) —

    The embedding model to use

  • params (Hash) —

    Other embedding parameters

Returns:



45
46
47
48
49
50
51
 
# File 'lib/llm/providers/ollama.rb', line 45

def embed(input, model: default_model, **params)
  params   = {model:}.merge!(params)
  req      = Net::HTTP::Post.new("/v1/embeddings", headers)
  req.body = JSON.dump({input:}.merge!(params))
  res      = execute(request: req)
  Response::Embedding.new(res).extend(response_parser)
end

#complete(prompt, params = {}) ⇒ LLM::Response::Completion

Provides an interface to the chat completions API

Examples:

llm = LLM.openai(ENV["KEY"])
messages = [{role: "system", content: "Your task is to answer all of my questions"}]
res = llm.complete("5 + 2 ?", messages:)
print "[#{res.choices[0].role}]", res.choices[0].content, "\n"

Parameters:

  • prompt (String) —

    The input prompt to be completed

  • params (Hash) (defaults to: {}) —

    The parameters to maintain throughout the conversation. Any parameter the provider supports can be included and not only those listed here.

Returns:

Raises:

  • (LLM::Error::PromptError) —

    When given an object a provider does not understand

See Also:



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/llm/providers/ollama.rb', line 63

def complete(prompt, params = {})
  params = {role: :user, model: default_model, stream: true}.merge!(params)
  params = [params, {format: params[:schema]}, format_tools(params)].inject({}, &:merge!).compact
  role, stream = params.delete(:role), params.delete(:stream)
  params[:stream] = true if stream.respond_to?(:<<) || stream == true
  req = Net::HTTP::Post.new("/api/chat", headers)
  messages = [*(params.delete(:messages) || []), LLM::Message.new(role, prompt)]
  body = JSON.dump({messages: [format(messages)].flatten}.merge!(params))
  set_body_stream(req, StringIO.new(body))
  res = execute(request: req, stream:)
  Response::Completion.new(res).extend(response_parser)
end

#models ⇒ LLM::Ollama::Models

Provides an interface to Ollama’s models API

Returns:

See Also:



80
81
82
 
# File 'lib/llm/providers/ollama.rb', line 80

def models
  LLM::Ollama::Models.new(self)
end

#assistant_role ⇒ String

Returns the role of the assistant in the conversation. Usually “assistant” or “model”

Returns:

  • (String) —

    Returns the role of the assistant in the conversation. Usually “assistant” or “model”



86
87
88
 
# File 'lib/llm/providers/ollama.rb', line 86

def assistant_role
  "assistant"
end

#default_model ⇒ String

Returns the default model for chat completions

Returns:

  • (String)

See Also:



94
95
96
 
# File 'lib/llm/providers/ollama.rb', line 94

def default_model
  "qwen3:latest"
end