ollama-ruby 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88a823911175700e401b5b07a47b9b7c9b3303c781384fa5f99d51b1ebbc1822
-  data.tar.gz: dfa6fc2fc22dcd0d89dbbaa2260238c11746682d53339b1cb059d679c013d38b
+  metadata.gz: 91ae1baa5bfbaca61fabd8b999527a323ba0ec345a62d7ba1d4fdd8a3f2afea0
+  data.tar.gz: d33bdaf8a42d9063acc125d90864fdf639e82a1362e51f731a85a3dd427bea60
 SHA512:
-  metadata.gz: 0152e3bf64b1094852872cc3e58391d6e8464815d6377324eeddda4ed7f1b401727ae2c12db7a322e8eef6b54af67fde2bfacc49565cbe71480d2d1785c03976
-  data.tar.gz: cd351d0b035f528f2fe16ec345424bdcbe084c2aa885809adb035fa37c4d6daab80b70e69c4b19ae40e8b2c7b628d91bc60feb06ff3cce432cd5009ad18e9521
+  metadata.gz: e604e07547c56818453993713847d6ce769f328f2872c652f37940c02983c41d56de5c630f0b735eee71c141753f28c51b9f6f8303a47e554ced93ab0c7164f3
+  data.tar.gz: ba902456a6f6a674668b9c8c97bf7d2f9d06beebac239fe908bc8456b6b4681a23da54447424d287fa926b7a1ef75779a496d37627cce77e09419e4e111997a6

data/CHANGES.md

@@ -1,5 +1,33 @@
 # Changes
 
+## 2025-10-20 v1.9.0
+
+- Added `dimensions` parameter to `Ollama::Commands::Embed#initialize`
+  - Added `attr_reader :dimensions` for accessing the `dimensions` parameter
+  - Updated JSON serialization to include `dimensions` field
+  - Added specs for `dimensions` parameter instantiation and JSON conversion
+  - Parameter defaults to `nil` following same pattern as other optional params
+  - Supports truncating output embeddings to specified dimensions as per Ollama API
+  - Maintains backward compatibility with existing code
+  - Parameter type documented as `Integer, nil` in YARD comments
+- Added new GitHub Actions workflow file `.github/workflows/static.yml`
+  - Configured workflow to deploy static content to GitHub Pages
+  - Set up Ruby environment with version **3.4** for documentation generation
+  - Added steps to install `gem_hadar`, run `bundle install`, and execute `rake doc`
+  - Updated `README.md` to include documentation link at
+    https://flori.github.io/ollama-ruby/
+- Updated comment style guideline for `initialize` methods
+- Skip `say` handler tests on non-macOS systems
+  - Add conditional check for `say` command availability using `File.executable?`
+  - Skip `Ollama::Handlers::Say` tests when `say` command is not found
+  - Use `skip: skip_reason` metadata to control test execution
+- Update CI configuration
+  - Add `openssl-dev` and `ghostscript` dependencies to Dockerfile
+  - Change test command from `rake test` to `rake spec`
+  - Enable `fail_fast: true` in CI configuration
+  - Remove `rm -f Gemfile.lock` step from CI script
+  - Update `build-base` and `yaml-dev` apk packages in Dockerfile
+
 ## 2025-09-13 v1.8.1
 
 - Added `.yardopts` and `tmp` to `package_ignore` in `Rakefile`

data/README.md

@@ -6,6 +6,10 @@ Ollama is a Ruby library gem that provides a client interface to interact with
 an ollama server via the
 [Ollama API](https://github.com/ollama/ollama/blob/main/docs/api.md).
 
+## Documentation
+
+Complete API documentation is available at: [GitHub.io](https://flori.github.io/ollama-ruby/)
+
 ## Installation (gem & bundler)
 
 To install Ollama, you can use the following methods:
@@ -484,7 +488,7 @@ The homepage of this library is located at
 
 ## License
 
-This software is licensed under the <i>MIT</i> license.
+This software is licensed under the [MIT License](./LICENSE).
 
 ---
 

data/Rakefile

@@ -13,14 +13,17 @@ GemHadar do
   description 'Library that allows interacting with the Ollama API'
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle',
-    '.yardoc', 'doc', 'tags', 'errors.lst', 'cscope.out', 'coverage', 'tmp',
-    'yard'
+    '.yardoc', 'doc', 'tags', 'errors.lst', 'cscope.out', 'coverage', 'tmp'
   package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
     '.rspec', '.github', '.contexts', '.yardopts'
   readme      'README.md'
 
   executables << 'ollama_console' << 'ollama_update' << 'ollama_cli' << 'ollama_browse'
 
+  github_workflows(
+    'static.yml' => {}
+  )
+
   required_ruby_version  '~> 3.1'
 
   dependency             'excon',                 '~> 1.0'

data/lib/ollama/commands/embed.rb

@@ -36,9 +36,10 @@ class Ollama::Commands::Embed
   # @param options [ Ollama::Options, nil ] optional configuration parameters for the model
   # @param truncate [ Boolean, nil ] whether to truncate the input if it exceeds context length
   # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
-  def initialize(model:, input:, options: nil, truncate: nil, keep_alive: nil)
-    @model, @input, @options, @truncate, @keep_alive =
-      model, input, options, truncate, keep_alive
+  # @param dimensions [ Integer, nil ] truncates the output embedding to the specified dimension.
+  def initialize(model:, input:, options: nil, truncate: nil, keep_alive: nil, dimensions: nil)
+    @model, @input, @options, @truncate, @keep_alive, @dimensions =
+      model, input, options, truncate, keep_alive, dimensions
     @stream = false
   end
 
@@ -67,6 +68,12 @@ class Ollama::Commands::Embed
   # @return [ String, nil ] duration to keep the model loaded in memory
   attr_reader :keep_alive
 
+  # The dimensions attribute reader returns the dimensions associated with the
+  # object.
+  #
+  # @return [ Integer, nil ] the dimensions value stored in the instance variable
+  attr_reader :dimensions
+
   # The stream attribute reader returns the streaming behavior setting
   # associated with the object.
   #
@@ -74,7 +81,6 @@ class Ollama::Commands::Embed
   #         streaming is enabled for the command execution (always false for embed commands)
   attr_reader :stream
 
-
   # The client attribute writer allows setting the client instance associated
   # with the object.
   #

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '1.8.1'
+  VERSION         = '1.9.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,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 1.8.1 ruby lib
+# stub: ollama-ruby 1.9.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "1.8.1".freeze
+  s.version = "1.9.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -18,13 +18,13 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "Ollama-ruby - Interacting with the Ollama API".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new("~> 3.1".freeze)
-  s.rubygems_version = "3.6.9".freeze
+  s.rubygems_version = "3.7.2".freeze
   s.summary = "Interacting with the Ollama API".freeze
   s.test_files = ["spec/ollama/client/doc_spec.rb".freeze, "spec/ollama/client_spec.rb".freeze, "spec/ollama/commands/chat_spec.rb".freeze, "spec/ollama/commands/copy_spec.rb".freeze, "spec/ollama/commands/create_spec.rb".freeze, "spec/ollama/commands/delete_spec.rb".freeze, "spec/ollama/commands/embed_spec.rb".freeze, "spec/ollama/commands/embeddings_spec.rb".freeze, "spec/ollama/commands/generate_spec.rb".freeze, "spec/ollama/commands/ps_spec.rb".freeze, "spec/ollama/commands/pull_spec.rb".freeze, "spec/ollama/commands/push_spec.rb".freeze, "spec/ollama/commands/show_spec.rb".freeze, "spec/ollama/commands/tags_spec.rb".freeze, "spec/ollama/commands/version_spec.rb".freeze, "spec/ollama/handlers/collector_spec.rb".freeze, "spec/ollama/handlers/dump_json_spec.rb".freeze, "spec/ollama/handlers/dump_yaml_spec.rb".freeze, "spec/ollama/handlers/markdown_spec.rb".freeze, "spec/ollama/handlers/nop_spec.rb".freeze, "spec/ollama/handlers/print_spec.rb".freeze, "spec/ollama/handlers/progress_spec.rb".freeze, "spec/ollama/handlers/say_spec.rb".freeze, "spec/ollama/handlers/single_spec.rb".freeze, "spec/ollama/image_spec.rb".freeze, "spec/ollama/message_spec.rb".freeze, "spec/ollama/options_spec.rb".freeze, "spec/ollama/tool_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.6".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.8".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/embed_spec.rb

@@ -36,6 +36,31 @@ describe Ollama::Commands::Embed do
     )
   end
 
+  it 'can be instantiated with dimensions' do
+    embed = described_class.new(
+      model: 'all-minilm',
+      input: 'Why is the sky blue?',
+      dimensions: 128
+    )
+    expect(embed).to be_a described_class
+    expect(embed.dimensions).to eq(128)
+  end
+
+  it 'can be converted to JSON with dimensions' do
+    embed = described_class.new(
+      model: 'all-minilm',
+      input: 'Why is the sky blue?',
+      dimensions: 128
+    )
+    expect(embed.as_json).to include(
+      model: 'all-minilm',
+      input: 'Why is the sky blue?',
+      dimensions: 128
+    )
+    expect(embed.to_json).to eq(
+      '{"model":"all-minilm","input":"Why is the sky blue?","dimensions":128,"stream":false}'
+    )
+  end
 
   it 'can perform' do
     embed = described_class.new(

data/spec/ollama/handlers/say_spec.rb

@@ -1,6 +1,11 @@
 require 'spec_helper'
 
-describe Ollama::Handlers::Say do
+skip_reason = nil
+unless File.executable?(`which say`.chomp)
+  skip_reason = 'Command say not in path'
+end
+
+describe Ollama::Handlers::Say, skip: skip_reason do
   let :say do
     described_class.new
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -383,7 +383,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Interacting with the Ollama API
 test_files: