ollama-ruby 1.15.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e83f50382169132ae2774add6050e16e36bd9af29b5aca839007c0d48f0c51c0
-  data.tar.gz: 5b1d915ea8bbf426d4f2ae08556533e1c78e4483857a8d649b96e9f668857491
+  metadata.gz: 11d1c6bcf5eaea08074bbba02d8f7044f6b4c234287dde118443f4f886f275ae
+  data.tar.gz: 9004c648dd62e4a71b0f35ddd31d3944123e10dfae856314e6c8f57ed3dbdb34
 SHA512:
-  metadata.gz: 9b0e7e583bcf8baa2fa5050ba84e1b94b890ed3d2fa8b871c72bb3a4dcf15f64ecebb6e665a6e7e49dc0f08e030cf5f5db5d0874f42f7f2f917572e03ed24672
-  data.tar.gz: edae6c2a87f761b36fa0615073a999ba16451a3558a67d1d114f7cf510cdafaf44062ced275d21f1ea807c3badd0e3ae9d5fa4fc0b62cb8358bdf78bcbca9f44
+  metadata.gz: 8cab524ff7ecee59b700184b5194cc207ff54bfb22ff00467e80df37433822cee2cf19ddaefc75f7f41a269b538f9bb6fb617d1846c1d3f11176d8ffc9838e37
+  data.tar.gz: 7e7a30b30c2b581f34f30ccef4caa3f52a40ab9bf6e9a2f3e57c2830741cf6a3057d8f77db338213e15a9a54bcf4a0645739f3bf4dc41d8a422f8cee1c0bbd35

data/CHANGES.md

@@ -1,5 +1,32 @@
 # Changes
 
+## 2025-12-19 v1.17.0
+
+- Changed `s.required_ruby_version` in the gemspec from "~> 3.1" to ">= 3.1" to allow usage with **Ruby 3.1** and higher, including **4.0**
+- Updated `s.rubygems_version` from **3.7.2** to **4.0.2**
+- Replaced `bundle update` with `bundle update --all` in the update command
+- Added **4.0-rc** release candidate to the Ruby version matrix (commented out)
+- Enhanced `Ollama::Options` class with detailed inline comments for all
+  configuration parameters including `numa`, `num_ctx`, `num_batch`, `num_gpu`,
+  `main_gpu`, `low_vram`, `f16_kv`, `logits_all`, `vocab_only`, `use_mmap`,
+  `use_mlock`, `num_thread`, `num_keep`, `seed`, `num_predict`, `top_k`,
+  `top_p`, `min_p`, `tfs_z`, `typical_p`, `repeat_last_n`, `temperature`,
+  `repeat_penalty`, `presence_penalty`, `frequency_penalty`, `mirostat`,
+  `mirostat_tau`, `mirostat_eta`, `penalize_newline`, and `stop`
+- Updated documentation link format from `.md` to `.mdx`
+
+## 2025-12-09 v1.16.0
+
+- Added support for handling HTTP 400 Bad Request errors
+- Introduced new error class `Ollama::Errors::BadRequestError` for 400 status
+  codes
+- Updated `Ollama::Client#request` method to raise `BadRequestError` for 400
+  responses
+- Added test case in `spec/ollama/client_spec.rb` to verify 400 status code
+  handling
+- Documented the new error class with example usage for think mode errors
+- Maintained existing error handling for 404 and other status codes
+
 ## 2025-12-04 v1.15.0
 
 - Added documentation for `ollama_ps` executable utility in README

data/Rakefile

@@ -25,7 +25,7 @@ GemHadar do
     'static.yml' => {}
   )
 
-  required_ruby_version  '~> 3.1'
+  required_ruby_version  '>= 3.1'
 
   dependency             'excon',                 '~> 1.0'
   dependency             'infobar',               '~> 0.8'

data/lib/ollama/client.rb

@@ -173,6 +173,8 @@ class Ollama::Client
           response_line = parse_json(l)
           response_line and yielder.yield response_line
         end
+      when 400
+        raise Ollama::Errors::BadRequestError, "#{response.status} #{response.body.inspect}"
       when 404
         raise Ollama::Errors::NotFoundError, "#{response.status} #{response.body.inspect}"
       else

data/lib/ollama/errors.rb

@@ -29,6 +29,22 @@ module Ollama
     class NotFoundError < Error
     end
 
+    # Ollama error class for handling cases where a requested resource is not
+    # found.
+    #
+    # This exception is raised when the Ollama API returns a 400 status code,
+    # indicating that the request was bad, e. g. think mode was requested from
+    # a non-thinking model.
+    #
+    # @example Handling a bad request error
+    #   begin
+    #     ollama.generate(model: 'llama3.1', prompt: 'Hello World', think: true)
+    #   rescue Ollama::Errors::BadRequestError
+    #     puts "Thinking not supported"
+    #   end
+    class BadRequestError < Error
+    end
+
     # Ollama error class for handling timeout errors when communicating with
     # the Ollama API.
     #

data/lib/ollama/options.rb

@@ -15,41 +15,102 @@ require 'ollama/json_loader'
 #     top_p: 0.9
 #   )
 #
-# [Options are explained in the parameters for the modelfile.](https://github.com/ollama/ollama/blob/main/docs/modelfile.md#parameter)
+# [Options are explained in the parameters for the modelfile.](https://github.com/ollama/ollama/blob/main/docs/modelfile.mdx)
 class Ollama::Options
   include Ollama::DTO
   extend Ollama::JSONLoader
 
+  # Hash defining the valid types for each configuration parameter
+  # This is used for type validation in the setter methods
   @@types = {
+    # NUMA (Non-Uniform Memory Access) support - enables NUMA awareness
     numa:              [ false, true ],
+
+    # Context window size - maximum context length for the model
     num_ctx:           Integer,
+
+    # Batch size for processing - number of tokens to process together
     num_batch:         Integer,
+
+    # Number of GPUs to use - specifies how many GPU devices to utilize
     num_gpu:           Integer,
+
+    # Main GPU index - specifies which GPU to use as the primary device
     main_gpu:          Integer,
+
+    # Low VRAM mode - reduces memory usage at the cost of performance
     low_vram:          [ false, true ],
+
+    # Use FP16 for KV cache - enables half-precision floating point for key-value cache
     f16_kv:            [ false, true ],
+
+    # Output all logits - includes all token logits in the output (for debugging)
     logits_all:        [ false, true ],
+
+    # Vocabulary only mode - only loads vocabulary without weights
     vocab_only:        [ false, true ],
+
+    # Use memory mapping - enables memory mapping for model loading
     use_mmap:          [ false, true ],
+
+    # Use memory locking - locks model in memory to prevent swapping
     use_mlock:         [ false, true ],
+
+    # Number of threads to use - specifies CPU thread count for computation
     num_thread:        Integer,
+
+    # Number of tokens to keep - keeps the first N tokens from the context
     num_keep:          Integer,
+
+    # Random seed for reproducible results - sets the random seed for generation
     seed:              Integer,
+
+    # Maximum number of tokens to predict - limits generation length
     num_predict:       Integer,
+
+    # Top-K sampling - limits sampling to top K tokens
     top_k:             Integer,
+
+    # Top-P (nucleus) sampling - limits sampling to tokens that sum to P probability
     top_p:             Float,
+
+    # Minimum probability for token sampling - sets minimum token probability threshold
     min_p:             Float,
+
+    # Tail Free Sampling - controls the tail free sampling parameter
     tfs_z:             Float,
+
+    # Typical P sampling - controls the typical P sampling parameter
     typical_p:         Float,
+
+    # Repeat last N tokens - prevents repetition of last N tokens
     repeat_last_n:     Integer,
+
+    # Temperature - controls randomness in generation (0.0 = deterministic, 1.0 = default)
     temperature:       Float,
+
+    # Repeat penalty - penalizes repeated tokens (higher values = more diversity)
     repeat_penalty:    Float,
+
+    # Presence penalty - penalizes tokens that appear in the context
     presence_penalty:  Float,
+
+    # Frequency penalty - penalizes tokens based on their frequency in the context
     frequency_penalty: Float,
+
+    # Mirostat sampling - controls the Mirostat sampling algorithm (0 = disabled)
     mirostat:          Integer,
+
+    # Mirostat tau parameter - controls the target entropy for Mirostat
     mirostat_tau:      Float,
+
+    # Mirostat eta parameter - controls the learning rate for Mirostat
     mirostat_eta:      Float,
+
+    # Penalize newline tokens - whether to penalize newline tokens
     penalize_newline:  [ false, true ],
+
+    # Stop sequences - array of strings that will stop generation
     stop:              Array,
   }
 

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '1.15.0'
+  VERSION         = '1.17.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.15.0 ruby lib
+# stub: ollama-ruby 1.17.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "1.15.0".freeze
+  s.version = "1.17.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/flori/ollama-ruby".freeze
   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.7.2".freeze
+  s.required_ruby_version = Gem::Requirement.new(">= 3.1".freeze)
+  s.rubygems_version = "4.0.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]
 

data/spec/ollama/client_spec.rb

@@ -71,6 +71,13 @@ describe Ollama::Client do
     }.to raise_error(Ollama::Errors::Error)
   end
 
+  it 'can raise error based on status code 400' do
+    expect(excon).to receive(:send).and_return(double(status: 400, body: '{}'))
+    expect {
+      ollama.generate(model: 'llama3.1', prompt: 'Hello World', think: true)
+    }.to raise_error(Ollama::Errors::BadRequestError)
+  end
+
   it 'can raise error based on status code 404' do
     expect(excon).to receive(:send).and_return(double(status: 404, body: '{}'))
     expect {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Florian Frank
@@ -404,7 +404,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -413,7 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.2
 specification_version: 4
 summary: Interacting with the Ollama API
 test_files: