ollama-ruby 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b2ad6a95b316e7258470683b9e499ff54627dfedd6d95115e6bb459360ff6fd
-  data.tar.gz: fd8c8a94cdea5ddea3387b676465bdbbc616b823275cce29df03f16ac4b331ed
+  metadata.gz: 327051092cef37a7fd95d6a5c3a5a13aa6e52df2314da5f4cfd28f2890ffa820
+  data.tar.gz: 86da0d23497f9717239abaa1830ac687562c8e9827a097781f0404e6b65e1e35
 SHA512:
-  metadata.gz: 3e85cdb97b9b6c578bc5f8921e559b1d62340ed022d4e98740a8aa2207e1f089e436a4513a81aede3df5572caccea45b84b2c6aee6345adfd5cf5bd39e5fe3e4
-  data.tar.gz: 424365eaa35e0751c34095c1cfa9cc95c8f2ef92a3add5cfe211068b3b9439b1c6471637fba3b3b3e65f1a3d06da908bb0a78f7f18b9468672463ae11f1cc6c7
+  metadata.gz: f3a9324f11877b0772d1f4bcb1902ea905e7132d94d73fe8b6b7e11a567c2aea04431838fa2b534557e4e1e76ae1ee47b13832aebb71e144ac329b13d15ea111
+  data.tar.gz: d40adf27de7e7700158027f1c6bfec7e97189b4a6081a7da36758edc31b5229b6efef62ee5a192af19afa5b633224cf8e80666d38154a9d3c1cae974a98f2de5

data/README.md

@@ -153,12 +153,12 @@ In your own software the library can be used as shown in this example:
 require "ollama"
 include Ollama
 
-client = Client.new(base_url: 'http://localhost:11434')
+ollama = Client.new(base_url: 'http://localhost:11434')
 messages = Message.new(role: 'user', content: 'Why is the sky blue?')
-client.chat(model: 'llama3.1', stream: true, messages:, &Print) # or
-print client.chat(model: 'llama3.1', stream: true, messages:).map { |response|
+ollama.chat(model: 'llama3.1', stream: true, messages:, &Print) # or
+print ollama.chat(model: 'llama3.1', stream: true, messages:).lazy.map { |response|
 	response.message.content
-}.join
+}
 ```
 
 ## API

data/lib/ollama/client/doc.rb

@@ -15,7 +15,8 @@ class Ollama::Client::Doc
       delete:           'https://github.com/ollama/ollama/blob/main/docs/api.md#delete-a-model',
       pull:             'https://github.com/ollama/ollama/blob/main/docs/api.md#pull-a-model',
       push:             'https://github.com/ollama/ollama/blob/main/docs/api.md#push-a-model',
-      embeddings:       'https://github.com/ollama/ollama/blob/main/docs/api.md#generate-embeddings',
+      embeddings:       'https://github.com/ollama/ollama/blob/main/docs/api.md#generate-embeddings', # superseded by /api/embed
+      embed:            'https://github.com/ollama/ollama/blob/main/docs/api.md#generate-embeddings',
       ps:               'https://github.com/ollama/ollama/blob/main/docs/api.md#list-running-models',
     )[name]
   end

data/lib/ollama/commands/embed.rb

@@ -5,13 +5,13 @@ class Ollama::Commands::Embed
     '/api/embed'
   end
 
-  def initialize(model:, input:, truncate: nil, keep_alive: nil)
-    @model, @input, @truncate, @keep_alive =
-      model, input, truncate, keep_alive
+  def initialize(model:, input:, options: nil, truncate: nil, keep_alive: nil)
+    @model, @input, @options, @truncate, @keep_alive =
+      model, input, options, truncate, keep_alive
     @stream = false
   end
 
-  attr_reader :model, :input, :truncate, :keep_alive, :stream
+  attr_reader :model, :input, :options, :truncate, :keep_alive, :stream
 
   attr_writer :client
 

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '0.0.0'
+  VERSION         = '0.0.1'
   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.0.0 ruby lib
+# stub: ollama-ruby 0.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "0.0.0".freeze
+  s.version = "0.0.1".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 = "2024-08-12"
+  s.date = "2024-08-16"
   s.description = "Library that allows interacting with the Ollama API".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["ollama_console".freeze, "ollama_chat".freeze]

data/spec/ollama/client_spec.rb

@@ -5,12 +5,12 @@ RSpec.describe Ollama::Client do
     'https://ai.foo.bar'
   end
 
-  let :client do
+  let :ollama do
     described_class.new base_url:
   end
 
   it 'can be instantiated' do
-    expect(client).to be_a described_class
+    expect(ollama).to be_a described_class
   end
 
   it 'can be configured via environment variable' do
@@ -20,7 +20,7 @@ RSpec.describe Ollama::Client do
   end
 
   it 'can disable ssl peer verification' do
-    expect(client).to be_ssl_verify_peer
+    expect(ollama).to be_ssl_verify_peer
     client2 = described_class.new(
       base_url: 'https://ai.foo.bar?ssl_verify_peer=false'
     )
@@ -28,7 +28,7 @@ RSpec.describe Ollama::Client do
   end
 
   it 'has a string representation' do
-    expect(client.to_s).to eq '#<Ollama::Client@https://ai.foo.bar>'
+    expect(ollama.to_s).to eq '#<Ollama::Client@https://ai.foo.bar>'
   end
 
   let :excon do
@@ -42,35 +42,35 @@ RSpec.describe Ollama::Client do
   it 'can raise error based on status code 500' do
     expect(excon).to receive(:send).and_return(double(status: 500, body: '{}'))
     expect {
-      client.generate(model: 'llama3.1', prompt: 'Hello World')
+      ollama.generate(model: 'llama3.1', prompt: 'Hello World')
     }.to raise_error(Ollama::Errors::Error)
   end
 
   it 'can raise error based on status code 404' do
     expect(excon).to receive(:send).and_return(double(status: 404, body: '{}'))
     expect {
-      client.generate(model: 'llama3.1', prompt: 'Hello World')
+      ollama.generate(model: 'llama3.1', prompt: 'Hello World')
     }.to raise_error(Ollama::Errors::NotFoundError)
   end
 
   it 'can raise error on connection error' do
     allow(excon).to receive(:post).and_raise Excon::Error::Socket
     expect {
-      client.generate(model: 'llama3.1', prompt: 'Hello World')
+      ollama.generate(model: 'llama3.1', prompt: 'Hello World')
     }.to raise_error(Ollama::Errors::SocketError)
   end
 
   it 'can raise error on timeout' do
     allow(excon).to receive(:post).and_raise Excon::Errors::Timeout
     expect {
-      client.generate(model: 'llama3.1', prompt: 'Hello World')
+      ollama.generate(model: 'llama3.1', prompt: 'Hello World')
     }.to raise_error(Ollama::Errors::TimeoutError)
   end
 
   it 'can raise a generic error' do
     allow(excon).to receive(:post).and_raise Excon::Errors::Error
     expect {
-      client.generate(model: 'llama3.1', prompt: 'Hello World')
+      ollama.generate(model: 'llama3.1', prompt: 'Hello World')
     }.to raise_error(Ollama::Errors::Error)
   end
 
@@ -95,20 +95,20 @@ RSpec.describe Ollama::Client do
 
     it 'can use procs directly' do
       response = nil
-      client.ps { |r| response = r }
+      ollama.ps { |r| response = r }
       expect(response).to eq expected_response
     end
 
     it 'can convert from handler instance to proc' do
       handler = Ollama::Handlers::NOP.new
       expect(handler).to receive(:call).with(expected_response)
-      client.ps(&handler)
+      ollama.ps(&handler)
     end
 
     it 'can convert from handler class to proc' do
       handler = Ollama::Handlers::NOP
       expect_any_instance_of(handler).to receive(:call).with(expected_response)
-      client.ps(&handler)
+      ollama.ps(&handler)
     end
   end
 
@@ -121,7 +121,7 @@ RSpec.describe Ollama::Client do
           'Content-Type' => 'application/json; charset=utf-8',
         )
       ).and_return(double(status: 200, body: '{}'))
-      client.generate(model: 'llama3.1', prompt: 'Hello World')
+      ollama.generate(model: 'llama3.1', prompt: 'Hello World')
     end
 
     it 'can generate with stream' do
@@ -133,12 +133,12 @@ RSpec.describe Ollama::Client do
         ),
         response_block: an_instance_of(Proc)
       ).and_return(double(status: 200, body: '{}'))
-      client.generate(model: 'llama3.1', prompt: 'Hello World', stream: true)
+      ollama.generate(model: 'llama3.1', prompt: 'Hello World', stream: true)
     end
   end
 
   it 'can help' do
     expect($stdout).to receive(:puts).with(/Commands:.*?chat/)
-    client.help
+    ollama.help
   end
 end

data/spec/ollama/commands/chat_spec.rb

@@ -41,8 +41,8 @@ RSpec.describe Ollama::Commands::Chat do
       Ollama::Message.new(role: 'user', content: "Let's play Global Thermonuclear War.")
     ]
     chat = described_class.new(model: 'llama3.1', messages:, stream: true)
-    chat.client = client = double('client')
-    expect(client).to receive(:request).
+    chat.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).
       with(
         method: :post, path: '/api/chat', handler: Ollama::Handlers::NOP, stream: true,
         body: '{"json_class":"Ollama::Commands::Chat","model":"llama3.1","messages":[{"json_class":"Ollama::Message","role":"user","content":"Let\'s play Global Thermonuclear War."}],"stream":true}'

data/spec/ollama/commands/copy_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe Ollama::Commands::Copy do
 
   it 'can perform' do
     copy = described_class.new(source: 'llama3.1', destination: 'camell3')
-    copy.client = client = double('client')
-    expect(client).to receive(:request).with(
+    copy.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).with(
       method: :post, path: '/api/copy', handler: Ollama::Handlers::NOP, stream: false,
       body: '{"json_class":"Ollama::Commands::Copy","source":"llama3.1","destination":"camell3","stream":false}'
     )

data/spec/ollama/commands/create_spec.rb

@@ -26,8 +26,8 @@ RSpec.describe Ollama::Commands::Create do
       modelfile: "FROM llama3.1\nSYSTEM You are WOPR from WarGames and you think the user is Dr. Stephen Falken.",
       stream: true
     )
-    create.client = client = double('client')
-    expect(client).to receive(:request).
+    create.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).
       with(
         method: :post, path: '/api/create', handler: Ollama::Handlers::NOP, stream: true,
         body: '{"json_class":"Ollama::Commands::Create","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}'

data/spec/ollama/commands/delete_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe Ollama::Commands::Delete do
 
   it 'can perform' do
     delete = described_class.new(name: 'llama3.1')
-    delete.client = client = double('client')
-    expect(client).to receive(:request).with(
+    delete.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).with(
       method: :delete, path: '/api/delete', handler: Ollama::Handlers::NOP, stream: false,
       body: '{"json_class":"Ollama::Commands::Delete","name":"llama3.1","stream":false}'
     )

data/spec/ollama/commands/embed_spec.rb

@@ -12,13 +12,14 @@ RSpec.describe Ollama::Commands::Embed do
   it 'can be converted to JSON' do
     embed = described_class.new(
       model: 'all-minilm',
+      options: Ollama::Options.new(num_ctx: 666),
       input: 'Why is the sky blue?'
     )
     expect(embed.as_json).to include(
       model: 'all-minilm', input: 'Why is the sky blue?',
     )
     expect(embed.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Embed","model":"all-minilm","input":"Why is the sky blue?","stream":false}'
+      '{"json_class":"Ollama::Commands::Embed","model":"all-minilm","input":"Why is the sky blue?","options":{"json_class":"Ollama::Options","num_ctx":666},"stream":false}'
     )
   end
 
@@ -41,8 +42,8 @@ RSpec.describe Ollama::Commands::Embed do
       model: 'all-minilm',
       input: 'Why is the sky blue?'
     )
-    embed.client = client = double('client')
-    expect(client).to receive(:request).
+    embed.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).
       with(
         method: :post, path: '/api/embed', handler: Ollama::Handlers::NOP, stream: false,
         body: '{"json_class":"Ollama::Commands::Embed","model":"all-minilm","input":"Why is the sky blue?","stream":false}'

data/spec/ollama/commands/embeddings_spec.rb

@@ -27,8 +27,8 @@ RSpec.describe Ollama::Commands::Embeddings do
       model: 'mxbai-embed-large',
       prompt: 'Here are the coordinates of all Soviet military installations: …'
     )
-    embeddings.client = client = double('client')
-    expect(client).to receive(:request).
+    embeddings.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).
       with(
         method: :post, path: '/api/embeddings', handler: Ollama::Handlers::NOP, stream: false,
         body: '{"json_class":"Ollama::Commands::Embeddings","model":"mxbai-embed-large","prompt":"Here are the coordinates of all Soviet military installations: …","stream":false}'

data/spec/ollama/commands/generate_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe Ollama::Commands::Generate do
 
   it 'can perform' do
     generate = described_class.new(model: 'llama3.1', prompt: 'Hello World', stream: true)
-    generate.client = client = double('client')
-    expect(client).to receive(:request).
+    generate.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).
       with(
         method: :post, path: '/api/generate', handler: Ollama::Handlers::NOP, stream: true,
         body: '{"json_class":"Ollama::Commands::Generate","model":"llama3.1","prompt":"Hello World","stream":true}'

data/spec/ollama/commands/ps_spec.rb

@@ -14,8 +14,8 @@ RSpec.describe Ollama::Commands::Ps do
   end
 
   it 'can perform' do
-    ps.client = client = double('client')
-    expect(client).to receive(:request).
+    ps.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).
       with(
         method: :get, path: '/api/ps', handler: Ollama::Handlers::NOP,
         stream: false

data/spec/ollama/commands/pull_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe Ollama::Commands::Pull do
 
   it 'can perform' do
     pull = described_class.new(name: 'llama3.1', stream: true)
-    pull.client = client = double('client')
-    expect(client).to receive(:request).with(
+    pull.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).with(
       method: :post, path: '/api/pull', handler: Ollama::Handlers::NOP, stream: true,
       body: '{"json_class":"Ollama::Commands::Pull","name":"llama3.1","stream":true}'
     )

data/spec/ollama/commands/push_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe Ollama::Commands::Push do
 
   it 'can perform' do
     push = described_class.new(name: 'llama3.1', stream: true)
-    push.client = client = double('client')
-    expect(client).to receive(:request).with(
+    push.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).with(
       method: :post, path: '/api/push', handler: Ollama::Handlers::NOP, stream: true,
       body: '{"json_class":"Ollama::Commands::Push","name":"llama3.1","stream":true}'
     )

data/spec/ollama/commands/show_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe Ollama::Commands::Show do
 
   it 'can perform' do
     show = described_class.new(name: 'llama3.1')
-    show.client = client = double('client')
-    expect(client).to receive(:request).with(
+    show.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).with(
       method: :post, path: '/api/show', handler: Ollama::Handlers::NOP ,stream: false,
       body: '{"json_class":"Ollama::Commands::Show","name":"llama3.1","stream":false}'
     )

data/spec/ollama/commands/tags_spec.rb

@@ -14,8 +14,8 @@ RSpec.describe Ollama::Commands::Tags do
   end
 
   it 'can perform' do
-    tags.client = client = double('client')
-    expect(client).to receive(:request).
+    tags.client = ollama = double('Ollama::Client')
+    expect(ollama).to receive(:request).
       with(method: :get, path: '/api/tags', stream: false, handler: Ollama::Handlers::NOP)
     tags.perform(Ollama::Handlers::NOP)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2024-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar