ollama-ruby 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4e3eda370660a57c7382a3548702359bdb3ea37afc2c785a26fc0ef1f199cd7
-  data.tar.gz: 77f392bc3c35948514cd78543560f3057b7b921487abd5803cad6f6f1cea9ac7
+  metadata.gz: 97a45592e9cf41628ed4b8fa86f98a2b8e5695669cf8b5919996df357b496301
+  data.tar.gz: 1a6fe9c40a33999e966e655c7cbf02956458c953bbcbf971c62a73c577290ed7
 SHA512:
-  metadata.gz: c7633fbcb2ed35181d8ffbdf129f4e151f1328ade92df8279a7f62ced065e3abfd05f0c5c93ac06871dc7421b5567d9c2b963a41a97ddd4e8fe51e8bd7ca7aeb
-  data.tar.gz: 93bdea4a001a9fb416100b6e5230c8a11d5524fe036b6216ccecc58e49584a703a1249e24510f1d66871866bcdd6483b703a4f47d0386253b0c5c3db613837d7
+  metadata.gz: 526e09b304cd3ebd743c037669eafe72cb5f4cd24bf0148744e67844924d8c99a71a1e649c8c27e3ea4dceb76617338b98bad8cd7d3a34d5888f9c3b18d0d26f
+  data.tar.gz: dd18fd50a3897fb1253d6c707fd57e2870e00d71e72f7540d79195fa0aa3e203db04e7374223034d0dbd4055de670d31acedac0b525434eb7d7e1f83630f89d5

data/CHANGES.md

@@ -1,5 +1,22 @@
 # Changes
 
+## 2026-07-17 v1.23.0
+
+### Added
+
+- Support for nested properties in tool definitions by adding the `properties`
+  attribute to `Ollama::Tool::Function::Parameters::Property`.
+- Support for array types in tool property definitions via the `items`
+  attribute in `Ollama::Tool::Function::Parameters::Property`.
+- Implementation of shallow `to_hash` and recursive `as_json` in `Ollama::DTO`
+  to ensure deep serialization into primitives, including the integration of
+  `Tins::DeepTransform`.
+
+### Changed
+
+- Increased the minimum required version of the `tins` gem to **1.54**.
+- Moved the custom models section into its own dedicated section.
+
 ## 2026-06-21 v1.22.0
 
 ### New Features

data/README.md

@@ -69,37 +69,6 @@ messages = Message.new(role: 'user', content: 'Why is the sky blue?')
 ollama.chat(model: 'llama3.1', stream: true, messages:, &Print)
 ```
 
-### Importing Custom Models
-
-You can import your own model files (e.g., `.gguf`) directly into Ollama. This
-is a two-step process: first, upload the binary file to obtain a SHA256 digest,
-and then create the model using that digest as a reference.
-
-This workflow is particularly convenient in the `ollama_console`:
-
-```ruby
-# 1. Upload the binary blob to get its digest
-# This will show a progress bar for both hashing and uploading
-digest = push_blob(body: File.new('my-model-q4_0.gguf', 'rb'))
-
-# 2. Define the model configuration
-template   = "<|system|>\n{{ .System }}</s>\n<|user|>\n{{ .Prompt }}</s>\n<|assistant|>\n"
-system     = "You are a helpful AI assistant."
-parameters = { stop: ["<|system|>", "<|user|>", "<|assistant|>", "</s>"] }
-
-# 3. Create the model using the digest (using Ruby 3 shorthand)
-create(
-  model: 'my-username/my-model:latest',
-  files: { 'my-model-q4_0.gguf' => digest },
-  template:,
-  system:,
-  parameters:
-)
-```
-
-This method is highly efficient as it uses streaming uploads and avoids
-redundant data transfers if the blob already exists on the server.
-
 ## Try out things in ollama\_console
 
 This is an interactive console where you can try out the different commands
@@ -280,6 +249,37 @@ jj ps
 jj version
 ```
 
+## Importing Custom Models
+
+You can import your own model files (e.g., `.gguf`) directly into Ollama. This
+is a two-step process: first, upload the binary file to obtain a SHA256 digest,
+and then create the model using that digest as a reference.
+
+This workflow is particularly convenient in the `ollama_console`:
+
+```ruby
+# 1. Upload the binary blob to get its digest
+# This will show a progress bar for both hashing and uploading
+digest = push_blob(body: File.new('my-model-q4_0.gguf', 'rb'))
+
+# 2. Define the model configuration
+template   = "<|system|>\n{{ .System }}</s>\n<|user|>\n{{ .Prompt }}</s>\n<|assistant|>\n"
+system     = "You are a helpful AI assistant."
+parameters = { stop: ["<|system|>", "<|user|>", "<|assistant|>", "</s>"] }
+
+# 3. Create the model using the digest (using Ruby 3 shorthand)
+create(
+  model: 'my-username/my-model:latest',
+  files: { 'my-model-q4_0.gguf' => digest },
+  template:,
+  system:,
+  parameters:
+)
+```
+
+This method is highly efficient as it uses streaming uploads and avoids
+redundant data transfers if the blob already exists on the server.
+
 ## Auxiliary objects
 
 The following objects are provided to interact with the ollama server. You can

data/Rakefile

@@ -34,7 +34,7 @@ GemHadar do
   dependency             'excon',                 '~> 1.0'
   dependency             'infobar',               '~> 0.8'
   dependency             'json',                  '~> 2.0'
-  dependency             'tins',                  '~> 1'
+  dependency             'tins',                  '~> 1.54'
   dependency             'term-ansicolor',        '~> 1.11'
   dependency             'kramdown-ansi',         '~> 0.0', '>= 0.0.1'
   dependency             'ostruct',               '~> 0.0'

data/lib/ollama/dto.rb

@@ -16,6 +16,7 @@
 #   end
 module Ollama::DTO
   extend Tins::Concern
+  include Tins::DeepTransform
 
   included do
     self.attributes = Set.new
@@ -116,20 +117,35 @@ module Ollama::DTO
     end
   end
 
+  # The to_hash method converts the object's attributes into a JSON-compatible
+  # hash representation without recursing into child objects.
+  #
+  # This provides a "shallow" view of the DTO, excluding any nil values or
+  # empty collections.
+  #
+  # @param ignored [ Array ] ignored arguments
+  # @return [ Hash ] a shallow hash containing the object's non-nil and
+  #   non-empty attributes
+  def to_hash(*ignored)
+    self.class.attributes.each_with_object({}) { |a, h| h[a] = send(a) }.
+      reject { _2.nil? || _2.ask_and_send(:size) == 0 }
+  end
+
   # The as_json method converts the object's attributes into a JSON-compatible
   # hash.
   #
-  # This method gathers all defined attributes of the object and constructs a
-  # hash representation, excluding any nil values or empty collections.
+  # This method leverages Tins::HashTransform to recursively collapse the DTO
+  # tree into pure Ruby primitives (Hashes and Arrays), ensuring that no DTO
+  # objects remain in the final output.
   #
   # @param ignored [ Array ] ignored arguments
-  # @return [ Hash ] a hash containing the object's non-nil and non-empty attributes
+  # @return [ Hash ] a fully collapsed hash containing the object's attributes
   def as_json(*ignored)
-    self.class.attributes.each_with_object({}) { |a, h| h[a] = send(a) }.
-      reject { _2.nil? || _2.ask_and_send(:size) == 0 }
+    deep_transform(circular: "[Circular Reference]")
   end
 
-  # The == method compares two objects for equality based on their JSON representation.
+  # The == method compares two objects for equality based on their JSON
+  # representation.
   #
   # This method checks if the JSON representation of the current object is
   # equal to the JSON representation of another object.
@@ -142,12 +158,10 @@ module Ollama::DTO
     as_json == other.as_json
   end
 
-  alias to_hash as_json
-
   # The empty? method checks whether the object has any attributes defined.
   #
   # This method determines if the object contains no attributes by checking
-  # if its hash representation is empty. It is typically used to verify
+  # if its hash representation is empty. This is typically used to verify
   # if an object, such as a DTO, has been initialized with any values.
   #
   # @return [ TrueClass, FalseClass ] true if the object has no attributes,

data/lib/ollama/tool/function/parameters/property.rb

@@ -37,13 +37,27 @@ class Ollama::Tool::Function::Parameters::Property
   #   property can take, or nil if not set
   attr_reader :enum
 
+  # The properties attribute reader returns the nested properties associated
+  # with the object.
+  #
+  # @return [ Hash, nil ] a map of property names to their corresponding Property objects,
+  #   or nil if not set
+  attr_reader :properties
+
+  # The items attribute reader returns the definition of elements for array types.
+  #
+  # @return [ Object, nil ] the schema definition for array items, or nil if not set
+  attr_reader :items
+
   # The initialize method sets up a new Property instance with the specified
   # attributes.
   #
   # @param type [ String ] the data type of the property
   # @param description [ String ] a detailed explanation of what the property represents
   # @param enum [ Array<String>, nil ] an optional array of valid values that the property can take
-  def initialize(type:, description:, enum: nil)
-    @type, @description, @enum = type, description, Array(enum)
+  # @param properties [ Hash, nil ] optional nested properties for 'object' types
+  # @param items [ Object, nil ] optional schema definition for 'array' type elements
+  def initialize(type:, description:, enum: nil, properties: nil, items: nil)
+    @type, @description, @enum, @properties, @items = type, description, Array(enum), properties, items
   end
 end

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '1.22.0'
+  VERSION         = '1.23.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.22.0 ruby lib
+# stub: ollama-ruby 1.23.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "1.22.0".freeze
+  s.version = "1.23.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -18,7 +18,7 @@ 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 = "4.0.10".freeze
+  s.rubygems_version = "4.0.17".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/blob_exists_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_blob_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/digester_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]
 
@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<excon>.freeze, ["~> 1.0".freeze])
   s.add_runtime_dependency(%q<infobar>.freeze, ["~> 0.8".freeze])
   s.add_runtime_dependency(%q<json>.freeze, ["~> 2.0".freeze])
-  s.add_runtime_dependency(%q<tins>.freeze, ["~> 1".freeze])
+  s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.54".freeze])
   s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.11".freeze])
   s.add_runtime_dependency(%q<kramdown-ansi>.freeze, ["~> 0.0".freeze, ">= 0.0.1".freeze])
   s.add_runtime_dependency(%q<ostruct>.freeze, ["~> 0.0".freeze])

data/spec/ollama/tool_spec.rb

@@ -68,4 +68,164 @@ describe Ollama::Tool do
       %{{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather for a location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The location to get the weather for, e.g. Berlin, Berlin"},"format":{"type":"string","description":"The format to return the weather in, e.g. 'celsius' or 'fahrenheit'","enum":["celsius","fahrenheit"]}},"required":["location","format"]}}}}
     )
   end
+
+  context 'with nested properties' do
+    let :address do
+      Ollama::Tool::Function::Parameters::Property.new(
+        type: 'string',
+        description: 'Street address',
+      )
+    end
+
+    let :city do
+      Ollama::Tool::Function::Parameters::Property.new(
+        type: 'string',
+        description: 'City name',
+      )
+    end
+
+    let :location_details do
+      Ollama::Tool::Function::Parameters::Property.new(
+        type: 'object',
+        description: 'Location details',
+        properties: { address: address, city: city },
+      )
+    end
+
+    let :nested_parameters do
+      Ollama::Tool::Function::Parameters.new(
+        type: 'object',
+        properties: { location: location_details },
+        required: %w[ location ],
+      )
+    end
+
+    let :nested_tool do
+      described_class.new(
+        type: 'function',
+        function: Ollama::Tool::Function.new(
+          name: 'get_location',
+          description: 'Get location info',
+          parameters: nested_parameters,
+        ),
+      )
+    end
+
+    it 'can serialize nested properties' do
+      expect(nested_tool.as_json[:function][:parameters][:properties][:location]).to eq({
+        type: 'object',
+        description: 'Location details',
+        properties: {
+          address: { type: 'string', description: 'Street address' },
+          city: { type: 'string', description: 'City name' }
+        }
+      })
+    end
+
+    it 'can serialize deeply nested properties' do
+      lat = Ollama::Tool::Function::Parameters::Property.new(type: 'number', description: 'Latitude')
+      lng = Ollama::Tool::Function::Parameters::Property.new(type: 'number', description: 'Longitude')
+      coords = Ollama::Tool::Function::Parameters::Property.new(
+        type: 'object',
+        description: 'GPS coordinates',
+        properties: { lat: lat, lng: lng }
+      )
+      loc = Ollama::Tool::Function::Parameters::Property.new(
+        type: 'object',
+        description: 'Location',
+        properties: { coordinates: coords }
+      )
+      event = Ollama::Tool::Function::Parameters::Property.new(
+        type: 'object',
+        description: 'Event',
+        properties: { location: loc }
+      )
+
+      deep_tool = described_class.new(
+        type: 'function',
+        function: Ollama::Tool::Function.new(
+          name: 'get_event',
+          description: 'Get event info',
+          parameters: Ollama::Tool::Function::Parameters.new(
+            type: 'object',
+            properties: { details: event },
+            required: %w[ details ]
+          )
+        )
+      )
+
+      expect(deep_tool.as_json[:function][:parameters][:properties][:details][:properties][:location][:properties][:coordinates][:properties][:lat][:type]).to eq('number')
+    end
+  end
+
+  context 'with array properties' do
+    let :tags do
+      Ollama::Tool::Function::Parameters::Property.new(
+        type: 'array',
+        description: 'A list of tags',
+        items: 'string'
+      )
+    end
+
+    let :edit_item do
+      Ollama::Tool::Function::Parameters::Property.new(
+        type: 'object',
+        description: 'An edit block',
+        properties: {
+          search: Ollama::Tool::Function::Parameters::Property.new(type: 'string', description: 'Search text'),
+          replace: Ollama::Tool::Function::Parameters::Property.new(type: 'string', description: 'Replace text')
+        }
+      )
+    end
+
+    let :edits do
+      Ollama::Tool::Function::Parameters::Property.new(
+        type: 'array',
+        description: 'A list of edits',
+        items: edit_item
+      )
+    end
+
+    let :array_parameters do
+      Ollama::Tool::Function::Parameters.new(
+        type: 'object',
+        properties: { tags: tags, edits: edits },
+        required: %w[ tags edits ]
+      )
+    end
+
+    let :array_tool do
+      described_class.new(
+        type: 'function',
+        function: Ollama::Tool::Function.new(
+          name: 'update_content',
+          description: 'Update content with tags and edits',
+          parameters: array_parameters
+        )
+      )
+    end
+
+    it 'can serialize simple array properties' do
+      expect(array_tool.as_json[:function][:parameters][:properties][:tags]).to eq({
+        type: 'array',
+        description: 'A list of tags',
+        items: 'string'
+      })
+    end
+
+    it 'can serialize complex array properties (objects)' do
+      expect(array_tool.as_json[:function][:parameters][:properties][:edits]).to eq({
+        type: 'array',
+        description: 'A list of edits',
+        items: {
+          type: 'object',
+          description: 'An edit block',
+          properties: {
+            search: { type: 'string', description: 'Search text' },
+            replace: { type: 'string', description: 'Replace text' }
+          }
+        }
+      })
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Florian Frank
@@ -169,14 +169,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.54'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.54'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -424,7 +424,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Interacting with the Ollama API
 test_files: