ollama-ruby 0.15.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b2b4e2384b4f05a8457cf9dbcd7d9c654ceff267080245d5d7a1915554743b
-  data.tar.gz: b03c72fed7968802c87681464b6bcd365f05906a351f7cdcde61dc60661f15cd
+  metadata.gz: 6b75645170e207cb661e3b98fed0754610a8807012715343c674206a66b0b72a
+  data.tar.gz: 64617fa5bc78f5658db02ea7ae61dee6c537924951de022f2aaddda9ae933131
 SHA512:
-  metadata.gz: 7ab16b2e5b23dbe1b94f240124c70a9073184af44d7cbdc31c6fedab92960f30b0a605c4e499eb7ac0a93f7cdf2b72ea62a380d4ea29e2d5d79d2667eabfc1c0
-  data.tar.gz: 20e6c0e290ad0c076fede5bde2d0959da37697e17d0ed90fb6e136bc8f6ab3c4084202086299a38b27ca62084dafb6979394b9bb2d52c47f553ca2eeaa32959f
+  metadata.gz: 9e2968fca36a1c4345c0f948d12252d3f501186f24f5c433d824dd2cd8cfda8afeb65d7073655cca1f74ef2ff4f14546747ebf08f15cf842c2065a33e714d953
+  data.tar.gz: f09c3d81093347f898af01386a2f84bd9a97e99b6c7e33e41eaf3eb3261815107ac12723ba4fb00e7180203396c95f0e20f55b3cbbc65dc5d3c5e0dc92753ffe

data/CHANGES.md

@@ -1,5 +1,41 @@
 # Changes
 
+## 2025-04-15 v1.0.0
+
+**Use model parameter and support new create parameters**
+  * Update parameter names in Ollama::Commands::Create specs:
+    + Renamed `name` to `model` and `modelfile` to `system` in `described_class.new` calls.
+    + Updated corresponding JSON serialization and deserialization tests.
+  * Adjust parameters in Create class and add helper methods:
+    + Changed parameter names in `Ollama::Commands::Create` class.
+    + Added methods: `as_hash(obj)` and `as_array(obj)` in `Ollama::DTO`.
+  * Update parameter names in README to match new method arguments:
+    + Updated `name` to `model` in `README.md`.
+    + Updated `push` method in `lib/ollama/commands/push.rb` to use `model` instead of `name`.
+    + Updated tests in `spec/ollama/commands/push_spec.rb` to use `model` instead of `name`.
+  * Refactor delete command and model attribute name:
+    + Renamed `delete` method parameter from `name` to `model`.
+    + Updated code in README.md, lib/ollama/commands/delete.rb, and spec/ollama/commands/delete_spec.rb.
+  * Rename parameter name in Ollama::Commands::Show class:
+    + Renamed `name` parameters to `model`.
+    + Updated method initializers, attribute readers and writers accordingly.
+    + Updated spec tests for new parameter name.
+  * Renamed `name` parameters to `model` in the following places:
+    + `ollama_update` script
+    + `Ollama::Commands::Pull` class
+    + `pull_spec.rb` spec file
+
+## 2025-02-17 v0.16.0
+
+* Updated Ollama CLI with new handler that allows saving of chat and
+  continuation with `ollama_chat`:
+  * Added `require 'tins/xt/secure_write'` and `require 'tmpdir'`.
+  * Created a new `ChatStart` class that handles chat responses.
+  * Updated options parsing to use `ChatStart` as the default handler.
+  * Changed code to handle `ChatStart` instances.
+  * Added secure write functionality for chat conversation in tmpdir.
+* Added `yaml-dev` to `apk add` command in `.all_images.yml`
+
 ## 2025-02-12 v0.15.0
 
 * Added "version" command to display version of the ollama server:

data/README.md

@@ -140,7 +140,7 @@ tags.models.map(&:name) => ["llama3.1:latest",…]
 `default_handler` is **Single**, streaming is not possible.
 
 ```ruby
-show(name: 'llama3.1', &DumpJSON)
+show(model: 'llama3.1', &DumpJSON)
 ```
 
 ### Create
@@ -149,12 +149,7 @@ show(name: 'llama3.1', &DumpJSON)
 `stream` is true by default.
 
 ```ruby
-modelfile=<<~end
-  FROM llama3.1
-  SYSTEM You are WOPR from WarGames and you think the user is Dr. Stephen Falken.
-end
-
-create(name: 'llama3.1-wopr', stream: true, modelfile:)
+create(model: 'llama3.1-wopr', stream: true, from: 'llama3.1', system: 'You are WOPR from WarGames and you think the user is Dr. Stephen Falken.')
 ```
 
 ### Copy
@@ -170,7 +165,7 @@ copy(source: 'llama3.1', destination: 'user/llama3.1')
 `default_handler` is **Single**, streaming is not possible.
 
 ```ruby
-delete(name: 'user/llama3.1')
+delete(model: 'user/llama3.1')
 ```
 
 ### Pull
@@ -179,7 +174,7 @@ delete(name: 'user/llama3.1')
 `stream` is true by default.
 
 ```ruby
-pull(name: 'llama3.1')
+pull(model: 'llama3.1')
 ```
 
 ### Push
@@ -188,7 +183,7 @@ pull(name: 'llama3.1')
 `stream` is true by default.
 
 ```ruby
-push(name: 'user/llama3.1')
+push(model: 'user/llama3.1')
 ```
 
 ### Embed
@@ -309,7 +304,7 @@ The library raises specific errors like `Ollama::Errors::NotFoundError` when
 a model is not found:
 
 ```ruby
-(show(name: 'nixda', &DumpJSON) rescue $!).class # => Ollama::NotFoundError
+(show(model: 'nixda', &DumpJSON) rescue $!).class # => Ollama::NotFoundError
 ```
 
 If `Ollama::Errors::TimeoutError` is raised, it might help to increase the

data/bin/ollama_cli

@@ -4,7 +4,30 @@ require 'ollama'
 include Ollama
 require 'tins'
 include Tins::GO
+require 'tins/xt/secure_write'
 require 'json'
+require 'tmpdir'
+
+class ChatStart
+  include Ollama::Handlers::Concern
+
+  def initialize(output: $stdout)
+    super
+    @output.sync = true
+    @content     = ''
+  end
+
+  attr_reader :content
+
+  def call(response)
+    if content = response.response
+      @content << content
+      @output << content
+    end
+    response.done and @output.puts
+    self
+  end
+end
 
 # Returns the contents of a file or string, or a default value if neither is provided.
 #
@@ -49,7 +72,7 @@ def usage
       -p PROMPT      the user prompt to use as a file, $OLLAMA_PROMPT
                      if it contains %{stdin} it is substituted by stdin input
       -P VARIABLE    sets prompt var %{foo} to "bar" if VARIABLE is foo=bar
-      -H HANDLER     the handler to use for the response, defaults to Print
+      -H HANDLER     the handler to use for the response, defaults to ChatStart
       -S             use streaming for generation
       -h             this help
 
@@ -57,7 +80,7 @@ def usage
   exit 0
 end
 
-opts = go 'u:m:M:s:p:P:H:Sh', defaults: { ?H => 'Print', ?M => '{}' }
+opts = go 'u:m:M:s:p:P:H:Sh', defaults: { ?H => 'ChatStart', ?M => '{}' }
 
 opts[?h] and usage
 
@@ -91,11 +114,30 @@ if ENV['DEBUG'].to_i == 1
   EOT
 end
 
+handler = Object.const_get(opts[?H])
+handler == ChatStart and handler = handler.new
+
 Client.new(base_url:, read_timeout: 120).generate(
   model:,
   system:,
   prompt:,
   options:,
   stream: !!opts[?S],
-  &Object.const_get(opts[?H])
+  &handler
 )
+
+if handler.is_a?(ChatStart)
+  filename = File.join(Dir.tmpdir, 'chat_start_%u.json' % $$)
+  File.secure_write(filename) do |out|
+    JSON.dump(
+      [
+        Message.new(role: 'user', content: prompt),
+        Message.new(role: 'assistant', content: handler.content),
+      ],
+      out
+    )
+  end
+  if STDERR.tty?
+    STDERR.puts "\nContinue the chat with:\n  ollama_chat -c '%s'" % filename
+  end
+end

data/bin/ollama_update

@@ -13,7 +13,7 @@ ollama.tags.models.each do |model|
   infobar.puts(
     "Updating model #{bold {name}} (last modified at #{modified_at.iso8601}):"
   )
-  ollama.pull(name:)
+  ollama.pull(model: name)
 rescue Ollama::Errors::Error => e
   infobar.puts "Caught #{e.class} for model #{bold { model.name }}: #{e} => Continuing."
 end

data/lib/ollama/commands/create.rb

@@ -5,12 +5,13 @@ class Ollama::Commands::Create
     '/api/create'
   end
 
-  def initialize(name:, modelfile: nil, quantize: nil, stream: nil, path: nil)
-    @name, @modelfile, @quantize, @stream, @path =
-      name, modelfile, quantize, stream, path
+  def initialize(model:, from: nil, files: nil, adapters: nil, template: nil, license: nil, system: nil, parameters: nil, messages: nil, stream: true, quantize: nil)
+    @model, @from, @files, @adapters, @license, @system, @parameters, @messages, @stream, @quantize =
+      model, from, as_hash(files), as_hash(adapters), as_array(license), system,
+      as_hash(parameters), as_array_of_hashes(messages), stream, quantize
   end
 
-  attr_reader :name, :modelfile, :quantize, :stream, :path
+  attr_reader :model, :from, :files, :adapters, :license, :system, :parameters, :messages, :stream, :quantize
 
   attr_writer :client
 

data/lib/ollama/commands/delete.rb

@@ -5,11 +5,11 @@ class Ollama::Commands::Delete
     '/api/delete'
   end
 
-  def initialize(name:)
-    @name, @stream = name, false
+  def initialize(model:)
+    @model, @stream = model, false
   end
 
-  attr_reader :name, :stream
+  attr_reader :model, :stream
 
   attr_writer :client
 

data/lib/ollama/commands/pull.rb

@@ -5,11 +5,11 @@ class Ollama::Commands::Pull
     '/api/pull'
   end
 
-  def initialize(name:, insecure: nil, stream: true)
-    @name, @insecure, @stream = name, insecure, stream
+  def initialize(model:, insecure: nil, stream: true)
+    @model, @insecure, @stream = model, insecure, stream
   end
 
-  attr_reader :name, :insecure, :stream
+  attr_reader :model, :insecure, :stream
 
   attr_writer :client
 

data/lib/ollama/commands/push.rb

@@ -5,11 +5,11 @@ class Ollama::Commands::Push
     '/api/push'
   end
 
-  def initialize(name:, insecure: nil, stream: true)
-    @name, @insecure, @stream = name, insecure, stream
+  def initialize(model:, insecure: nil, stream: true)
+    @model, @insecure, @stream = model, insecure, stream
   end
 
-  attr_reader :name, :insecure, :stream
+  attr_reader :model, :insecure, :stream
 
   attr_writer :client
 

data/lib/ollama/commands/show.rb

@@ -5,12 +5,12 @@ class Ollama::Commands::Show
     '/api/show'
   end
 
-  def initialize(name:, verbose: nil)
-    @name, @verbose = name, verbose
+  def initialize(model:, verbose: nil)
+    @model, @verbose = model, verbose
     @stream = false
   end
 
-  attr_reader :name, :verbose, :stream
+  attr_reader :model, :verbose, :stream
 
   attr_writer :client
 

data/lib/ollama/dto.rb

@@ -26,6 +26,20 @@ module Ollama::DTO
     end
   end
 
+  def as_hash(obj)
+    obj&.to_hash
+  end
+
+  def as_array(obj)
+    if obj.nil?
+      obj
+    elsif obj.respond_to?(:to_ary)
+      obj.to_ary
+    else
+      [ obj ]
+    end
+  end
+
   def as_json(*)
     self.class.attributes.each_with_object({}) { |a, h| h[a] = send(a) }.
       reject { _2.nil? || _2.ask_and_send(:size) == 0 }

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '0.15.0'
+  VERSION         = '1.0.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/ollama-ruby.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 0.15.0 ruby lib
+# stub: ollama-ruby 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "0.15.0".freeze
+  s.version = "1.0.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2025-02-12"
+  s.date = "2025-04-14"
   s.description = "Library that allows interacting with the Ollama API".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["ollama_console".freeze, "ollama_update".freeze, "ollama_cli".freeze]
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.19".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.20".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.6".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<kramdown>.freeze, ["~> 2.0".freeze])

data/spec/ollama/commands/create_spec.rb

@@ -2,35 +2,47 @@ require 'spec_helper'
 
 RSpec.describe Ollama::Commands::Create do
   it 'can be instantiated' do
-    create = described_class.new(name: 'llama3.1', stream: true)
+    create = described_class.new(model: 'llama3.1', stream: true)
     expect(create).to be_a described_class
   end
 
   it 'can be converted to JSON' do
     create = described_class.new(
-      name: 'llama3.1-wopr',
-      modelfile: "FROM llama3.1\nSYSTEM You are WOPR from WarGames and you think the user is Dr. Stephen Falken.",
+      model: 'llama3.1-wopr',
+      from: 'llama3.1',
+      system: 'You are WOPR from WarGames and you think the user is Dr. Stephen Falken.',
+      license: 'Falso License',
+      files: { 'foo' => 'bar' },
+      messages: Ollama::Message.new(role: 'user', content: 'hello'),
       stream: true
     )
     expect(create.as_json).to include(
-      name: 'llama3.1-wopr', modelfile: "FROM llama3.1\nSYSTEM You are WOPR from WarGames and you think the user is Dr. Stephen Falken.", stream: true,
+      model: 'llama3.1-wopr',
+      from: 'llama3.1',
+      system: 'You are WOPR from WarGames and you think the user is Dr. Stephen Falken.',
+      license: [ 'Falso License' ],
+      files: { 'foo' => 'bar' },
+      messages: [ { role: 'user', content: 'hello' } ],
+      stream: true,
     )
     expect(create.to_json).to eq(
-      '{"name":"llama3.1-wopr","modelfile":"FROM llama3.1\nSYSTEM You are WOPR from WarGames and you think the user is Dr. Stephen Falken.","stream":true}'
+      "{\"model\":\"llama3.1-wopr\",\"from\":\"llama3.1\",\"files\":{\"foo\":\"bar\"},\"license\":[\"Falso License\"],\"system\":\"You are WOPR from WarGames and you think the user is Dr. Stephen Falken.\",\"messages\":[{\"role\":\"user\",\"content\":\"hello\"}],\"stream\":true}"
     )
   end
 
   it 'can perform' do
     create = described_class.new(
-      name: 'llama3.1-wopr',
-      modelfile: "FROM llama3.1\nSYSTEM You are WOPR from WarGames and you think the user is Dr. Stephen Falken.",
+      model: 'llama3.1-wopr',
+      from: 'llama3.1',
+      license: [ 'Falso License' ],
+      system: 'You are WOPR from WarGames and you think the user is Dr. Stephen Falken.',
       stream: true
     )
-    create.client = ollama = double('Ollama::Client')
+     create.client = ollama = double('Ollama::Client')
     expect(ollama).to receive(:request).
       with(
         method: :post, path: '/api/create', handler: Ollama::Handlers::NOP, stream: true,
-        body: '{"name":"llama3.1-wopr","modelfile":"FROM llama3.1\nSYSTEM You are WOPR from WarGames and you think the user is Dr. Stephen Falken.","stream":true}'
+        body: "{\"model\":\"llama3.1-wopr\",\"from\":\"llama3.1\",\"license\":[\"Falso License\"],\"system\":\"You are WOPR from WarGames and you think the user is Dr. Stephen Falken.\",\"stream\":true}"
       )
     create.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/delete_spec.rb

@@ -2,26 +2,26 @@ require 'spec_helper'
 
 RSpec.describe Ollama::Commands::Delete do
   it 'can be instantiated' do
-    delete = described_class.new(name: 'llama3.1')
+    delete = described_class.new(model: 'llama3.1')
     expect(delete).to be_a described_class
   end
 
   it 'can be converted to JSON' do
-    delete = described_class.new(name: 'llama3.1')
+    delete = described_class.new(model: 'llama3.1')
     expect(delete.as_json).to include(
-      name: 'llama3.1', stream: false
+      model: 'llama3.1', stream: false
     )
     expect(delete.to_json).to eq(
-      '{"name":"llama3.1","stream":false}'
+      '{"model":"llama3.1","stream":false}'
     )
   end
 
   it 'can perform' do
-    delete = described_class.new(name: 'llama3.1')
+    delete = described_class.new(model: 'llama3.1')
     delete.client = ollama = double('Ollama::Client')
     expect(ollama).to receive(:request).with(
       method: :delete, path: '/api/delete', handler: Ollama::Handlers::NOP, stream: false,
-      body: '{"name":"llama3.1","stream":false}'
+      body: '{"model":"llama3.1","stream":false}'
     )
     delete.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/pull_spec.rb

@@ -2,26 +2,26 @@ require 'spec_helper'
 
 RSpec.describe Ollama::Commands::Pull do
   it 'can be instantiated' do
-    pull = described_class.new(name: 'llama3.1')
+    pull = described_class.new(model: 'llama3.1')
     expect(pull).to be_a described_class
   end
 
   it 'can be converted to JSON' do
-    pull = described_class.new(name: 'llama3.1', stream: true)
+    pull = described_class.new(model: 'llama3.1', stream: true)
     expect(pull.as_json).to include(
-      name: 'llama3.1', stream: true
+      model: 'llama3.1', stream: true
     )
     expect(pull.to_json).to eq(
-      '{"name":"llama3.1","stream":true}'
+      '{"model":"llama3.1","stream":true}'
     )
   end
 
   it 'can perform' do
-    pull = described_class.new(name: 'llama3.1', stream: true)
+    pull = described_class.new(model: 'llama3.1', stream: true)
     pull.client = ollama = double('Ollama::Client')
     expect(ollama).to receive(:request).with(
       method: :post, path: '/api/pull', handler: Ollama::Handlers::NOP, stream: true,
-      body: '{"name":"llama3.1","stream":true}'
+      body: '{"model":"llama3.1","stream":true}'
     )
     pull.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/push_spec.rb

@@ -2,26 +2,26 @@ require 'spec_helper'
 
 RSpec.describe Ollama::Commands::Push do
   it 'can be instantiated' do
-    push = described_class.new(name: 'llama3.1')
+    push = described_class.new(model: 'llama3.1')
     expect(push).to be_a described_class
   end
 
   it 'can be converted to JSON' do
-    push = described_class.new(name: 'llama3.1', stream: true)
+    push = described_class.new(model: 'llama3.1', stream: true)
     expect(push.as_json).to include(
-      name: 'llama3.1', stream: true
+      model: 'llama3.1', stream: true
     )
     expect(push.to_json).to eq(
-      '{"name":"llama3.1","stream":true}'
+      '{"model":"llama3.1","stream":true}'
     )
   end
 
   it 'can perform' do
-    push = described_class.new(name: 'llama3.1', stream: true)
+    push = described_class.new(model: 'llama3.1', stream: true)
     push.client = ollama = double('Ollama::Client')
     expect(ollama).to receive(:request).with(
       method: :post, path: '/api/push', handler: Ollama::Handlers::NOP, stream: true,
-      body: '{"name":"llama3.1","stream":true}'
+      body: '{"model":"llama3.1","stream":true}'
     )
     push.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/show_spec.rb

@@ -2,26 +2,26 @@ require 'spec_helper'
 
 RSpec.describe Ollama::Commands::Show do
   it 'can be instantiated' do
-    show = described_class.new(name: 'llama3.1')
+    show = described_class.new(model: 'llama3.1')
     expect(show).to be_a described_class
   end
 
   it 'can be converted to JSON' do
-    show = described_class.new(name: 'llama3.1')
+    show = described_class.new(model: 'llama3.1')
     expect(show.as_json).to include(
-      name: 'llama3.1', stream: false
+      model: 'llama3.1', stream: false
     )
     expect(show.to_json).to eq(
-      '{"name":"llama3.1","stream":false}'
+      '{"model":"llama3.1","stream":false}'
     )
   end
 
   it 'can perform' do
-    show = described_class.new(name: 'llama3.1')
+    show = described_class.new(model: 'llama3.1')
     show.client = ollama = double('Ollama::Client')
     expect(ollama).to receive(:request).with(
       method: :post, path: '/api/show', handler: Ollama::Handlers::NOP ,stream: false,
-      body: '{"name":"llama3.1","stream":false}'
+      body: '{"model":"llama3.1","stream":false}'
     )
     show.perform(Ollama::Handlers::NOP)
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Florian Frank
 bindir: bin
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement