ollama-ruby 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 204e16b85ab8d61e7baee8fcfe42db2ece4b2898180a019419d7847a2cb2711f
-  data.tar.gz: 6e7c9135a0047cdd945a6ce2781665c993f808d2c044aaf164c9c71ed1705410
+  metadata.gz: d979768964258e0f21d54b480b0afcd23c01ceefb75be3f828cb0440c45cd5d1
+  data.tar.gz: b07ae78174a0614b146cd3cc7e4aeefc60ab86bc307b1b967f40c04841cce557
 SHA512:
-  metadata.gz: e38ed0cc5e945d5b7bfd3e41d325612d080dabaf544c2457c8270fe836ed223bd536cb58af4dd806fc6e233dc3e694c6d58620d3816721623de03533d19c7d21
-  data.tar.gz: c14520ca5f1cd8ecf5317489e71b32575e687b107b5b6c030052333ea95e9fcc608079273703895f597b80a81ea195ffb7bc9899283d2b778e79bc851c9a117d
+  metadata.gz: 2251a33cfdd40e1c53ebd9edb06a71994c68ef5a27ed82b35d691525459930e771a10dc93a0c8cc665e93980949a5abb60379f274954cee78a3edfeb4d92183e
+  data.tar.gz: a956187b7c3cb96f9398ed3677e332251b21db0407c21468b04c540e9a1e925a3cb4a4ff7bfe2e946164d80a262e8cd6ce5219cb3bd51625bc39e8841fed2933

data/CHANGES.md

@@ -1,5 +1,16 @@
 # Changes
 
+## 2025-11-30 v1.12.0
+
+- `ollama_cli`
+    - Added `-i` flag to display Ollama server version using `ollama.version.version`
+    - Refactored model options handling to use `Ollama::Options.from_hash` or `Ollama::Options.new`
+    - Stored client configuration in `ollama` variable for reuse
+    - Added `-d` flag for debug mode in `ollama_cli` instead of using environment variable
+- Included `Ollama::DTO` in `Client::Config` class for consistent behavior
+- Improved documentation formatting in `dto.rb` file
+- Added documentation that `think` can be "high", "medium", "low" instead of just `true`
+
 ## 2025-11-05 v1.11.0
 
 - Replaced `tabulo` gem with `terminal-table` **version 3.0** for table

data/bin/ollama_cli

@@ -22,13 +22,13 @@
 #   - OLLAMA_MODEL_OPTIONS: JSON model options
 #   - OLLAMA_SYSTEM: Default system prompt
 #   - OLLAMA_PROMPT: Default user prompt
-#   - DEBUG: Set to 1 for verbose output
 
 require 'ollama'
 include Ollama
 require 'tins'
 include Tins::GO
 require 'tins/xt/secure_write'
+require 'tins/xt/full'
 require 'json'
 require 'tmpdir'
 
@@ -124,29 +124,40 @@ def usage
       -H HANDLER     the handler to use for the response, defaults to ChatStart
       -S             use streaming for generation
       -T             use thinking for generation
+      -d             enable debug mode
+      -i             display ollama server version information
       -h             this help
 
   EOT
   exit 0
 end
 
-opts = go 'u:m:M:s:p:P:H:c:STh', defaults: { ?H => 'ChatStart' }
+opts = go 'u:m:M:s:p:P:H:c:STdih', defaults: { ?H => 'ChatStart' }
 
 opts[?h] and usage
 
 base_url  = opts[?u] || ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
 client_config = Client::Config[
-  { base_url: } |
+  { base_url:, debug: !!opts[?d] } |
   JSON(get_file_argument(opts[?c], default: ENV['OLLAMA_CLIENT']).full? || '{}')
 ]
-model    = opts[?m] || ENV.fetch('OLLAMA_MODEL', 'llama3.1')
-options  = Ollama::Options.from_hash(JSON(
-  get_file_argument(opts[?M], default: ENV['OLLAMA_MODEL_OPTIONS'])
-))
-system   = get_file_argument(opts[?s], default: ENV['OLLAMA_SYSTEM'])
-prompt   = get_file_argument(opts[?p], default: ENV['OLLAMA_PROMPT'])
-
-if prompt.nil?
+model         = (opts[?m] || ENV['OLLAMA_MODEL']).full? || 'llama3.1'
+model_options = JSON(get_file_argument(opts[?M], default: ENV['OLLAMA_MODEL_OPTIONS']))
+options = if model_options.is_a?(Hash)
+            Ollama::Options.from_hash(model_options)
+          else
+            Ollama::Options.new
+          end
+system = get_file_argument(opts[?s], default: ENV['OLLAMA_SYSTEM'])
+prompt = get_file_argument(opts[?p], default: ENV['OLLAMA_PROMPT'])
+
+ollama = Client.configure_with(client_config)
+
+case
+when opts[?i]
+  puts ollama.version.version
+  exit
+when prompt.nil?
   prompt = STDIN.read
 else
   vars = prompt.named_placeholders
@@ -163,13 +174,14 @@ else
   prompt = prompt.named_placeholders_interpolate(values, default:)
 end
 
-if ENV['DEBUG'].to_i == 1
+if opts[?d]
   puts <<~EOT
-    base_url = #{base_url.inspect}
-    model    = #{model.inspect}
-    system   = #{system.inspect}
-    prompt   = #{prompt.inspect}
-    options  = #{options.to_json}
+    base_url      = #{base_url.inspect}
+    model         = #{model.inspect}
+    system        = #{system.inspect}
+    prompt        = #{prompt.inspect}
+    options       = #{options.to_json}
+    client_config = #{client_config.to_json}
   EOT
 end
 
@@ -183,7 +195,7 @@ handler = case
             handler
           end
 
-Client.configure_with(client_config).generate(
+ollama.generate(
   model:,
   system:,
   prompt:,

data/bin/ollama_console

@@ -32,17 +32,52 @@ def base_url
   ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
 end
 
+# The client_config method retrieves and merges client configuration settings.
+#
+# This method fetches the base URL from the instance variable and combines it
+# with configuration data parsed from the OLLAMA_CLIENT environment variable.
+# If the environment variable is not set, it defaults to an empty JSON object.
+#
+# @return [ Hash ] a hash containing the merged configuration settings
+def client_config
+  Client::Config[ { base_url: } | JSON(ENV.fetch('OLLAMA_CLIENT', '{}')) ]
+end
+
 # The ollama method provides access to a configured Ollama client instance.
 #
 # This method initializes and returns a singleton instance of the Ollama client,
 # using the base URL specified in the base_url parameter. If an instance already
 # exists, it returns the cached version instead of creating a new one.
 #
-# @param base_url [ String ] the base URL for the Ollama API endpoint
 # @return [ Ollama::Client ] a configured Ollama client instance
 def ollama
-  $ollama ||= Client.new(base_url:)
+  $ollama ||= Client.configure_with(client_config)
 end
+
+# The model method retrieves the Ollama model name from the environment
+#
+# This method returns the name of the Ollama model to be used for API requests,
+# falling back to a default value of 'llama3.1' if the OLLAMA_MODEL environment
+# variable is not set.
+#
+# @return [ String ] the name of the Ollama model to use, either from the
+#         OLLAMA_MODEL environment variable or the default 'llama3.1'
+def model
+  ENV.fetch('OLLAMA_MODEL', 'llama3.1')
+end
+
+# The options method retrieves and parses model options from the environment.
+#
+# This method fetches the OLLAMA_MODEL_OPTIONS environment variable, parses it
+# as JSON, and converts it into an Ollama::Options object for use with model
+# commands.
+#
+# @return [ Ollama::Options ] an options object initialized with values from
+#   the environment
+def options
+  Ollama::Options.from_hash(JSON(ENV.fetch('OLLAMA_MODEL_OPTIONS', '{}')))
+end
+
 IRB.setup nil
 IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
 IRB.conf[:HISTORY_FILE] = File.join(ENV.fetch('HOME'), '.ollama_console-history')

data/lib/ollama/client/configuration/config.rb

@@ -17,8 +17,6 @@ require 'ollama/json_loader'
 #   config = Ollama::Client::Config.load_from_json('path/to/config.json')
 #   client = Ollama::Client.configure_with(config)
 module Ollama::Client::Configuration
-
-
   # A class that encapsulates configuration settings for Ollama clients.
   #
   # This class provides a structured way to define and manage various
@@ -37,6 +35,7 @@ module Ollama::Client::Configuration
   # @example Loading configuration from a JSON file
   #   config = Ollama::Client::Config.load_from_json('path/to/config.json')
   class Config
+    include Ollama::DTO
     extend Ollama::JSONLoader
 
     # The initialize method sets up a new configuration instance with the

data/lib/ollama/commands/chat.rb

@@ -39,7 +39,8 @@ class Ollama::Commands::Chat
   # @param options [ Ollama::Options, nil ] configuration parameters for the model
   # @param stream [ TrueClass, FalseClass, nil ] whether to enable streaming for the operation
   # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
-  # @param think [ Boolean, nil ] whether to enable thinking mode for reasoning
+  # @param think [ Boolean, String, nil ] whether to enable thinking mode for
+  #   generation. Can be "high", "medium", "low" instead of true
   def initialize(model:, messages:, tools: nil, format: nil, options: nil, stream: nil, keep_alive: nil, think: nil)
     @model, @messages, @tools, @format, @options, @stream, @keep_alive, @think =
       model, as_array_of_hashes(messages), as_array_of_hashes(tools),
@@ -85,7 +86,7 @@ class Ollama::Commands::Chat
 
   # The think attribute reader returns the thinking mode setting associated with the object.
   #
-  # @return [ Boolean, nil ] whether thinking mode is enabled for reasoning
+  # @return [ Boolean, String, nil ] whether thinking mode is enabled for reasoning
   attr_reader :think
 
   # The client attribute writer allows setting the client instance associated
@@ -98,7 +99,6 @@ class Ollama::Commands::Chat
   # @attr_writer [ Ollama::Client ] the assigned client instance
   attr_writer :client
 
-
   # The perform method executes a command request using the specified handler.
   #
   # This method initiates a POST request to the Ollama API's chat endpoint,

data/lib/ollama/commands/generate.rb

@@ -42,7 +42,8 @@ class Ollama::Commands::Generate
   # @param stream [ Boolean, nil ] whether to stream responses (default: false)
   # @param raw [ Boolean, nil ] whether to return raw output without formatting
   # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
-  # @param think [ Boolean, nil ] whether to enable thinking mode for generation
+  # @param think [ Boolean, String, nil ] whether to enable thinking mode for
+  #   generation. Can be "high", "medium", "low" instead of true
   def initialize(model:, prompt:, suffix: nil, images: nil, format: nil, options: nil, system: nil, template: nil, context: nil, stream: nil, raw: nil, keep_alive: nil, think: nil)
     @model, @prompt, @suffix, @images, @format, @options, @system, @template, @context, @stream, @raw, @keep_alive, @think =
       model, prompt, suffix, (Array(images) if images), format, options, system, template, context, stream, raw, keep_alive, think
@@ -110,7 +111,7 @@ class Ollama::Commands::Generate
 
   # The think attribute reader returns whether thinking mode is enabled for generation.
   #
-  # @return [ Boolean, nil ] whether to enable thinking mode for generation
+  # @return [ Boolean, String, nil ] whether to enable thinking mode for generation
   attr_reader :think
 
   # The client attribute writer allows setting the client instance associated
@@ -130,7 +131,6 @@ class Ollama::Commands::Generate
   # method for actual HTTP communication.
   #
   # @param handler [ Ollama::Handler ] the handler to process responses from the API
-  # @return [ void ]
   def perform(handler)
     @client.request(method: :post, path: self.class.path, body: to_json, stream:, handler:)
   end

data/lib/ollama/dto.rb

@@ -47,11 +47,22 @@ module Ollama::DTO
     # attributes set.
     #
     # @param names [ Array<Symbol> ] one or more attribute names to be declared
-    # as readable and registered
+    #   as readable and registered
     def attr_reader(*names)
       super
       attributes.merge(names.map(&:to_sym))
     end
+
+    # The attr_accessor method extends the functionality of the standard
+    # attr_accessor by also registering the declared attributes in the class's
+    # attributes set.
+    #
+    # @param names [ Array<Symbol> ] one or more attribute names to be declared
+    #   as readable and registered
+    def attr_accessor(*names)
+      super
+      attributes.merge(names.map(&:to_sym))
+    end
   end
 
   # The as_array_of_hashes method converts an object into an array of hashes.
@@ -63,7 +74,7 @@ module Ollama::DTO
   # @param obj [ Object ] the object to be converted
   #
   # @return [ Array<Hash>, nil ] an array of hashes if the conversion was
-  # possible, or nil otherwise
+  #   possible, or nil otherwise
   def as_array_of_hashes(obj)
     if obj.respond_to?(:to_hash)
       [ obj.to_hash ]
@@ -80,7 +91,7 @@ module Ollama::DTO
   # @param obj [ Object ] the object to be converted to a hash
   #
   # @return [ Hash, nil ] the hash representation of the object or nil if the
-  # object does not respond to to_hash
+  #   object does not respond to to_hash
   def as_hash(obj)
     obj&.to_hash
   end
@@ -94,7 +105,7 @@ module Ollama::DTO
   # @param obj [ Object ] the object to be converted to an array
   #
   # @return [ Array, nil ] an array containing the object or its elements, or
-  # nil if the input is nil
+  #   nil if the input is nil
   def as_array(obj)
     if obj.nil?
       obj
@@ -126,7 +137,7 @@ module Ollama::DTO
   # @param other [ Object ] the object to compare against
   #
   # @return [ TrueClass, FalseClass ] true if both objects have identical JSON
-  # representations, false otherwise
+  #   representations, false otherwise
   def ==(other)
     as_json == other.as_json
   end
@@ -140,7 +151,7 @@ module Ollama::DTO
   # if an object, such as a DTO, has been initialized with any values.
   #
   # @return [ TrueClass, FalseClass ] true if the object has no attributes,
-  # false otherwise
+  #   false otherwise
   def empty?
     to_hash.empty?
   end

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '1.11.0'
+  VERSION         = '1.12.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.11.0 ruby lib
+# stub: ollama-ruby 1.12.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "1.11.0".freeze
+  s.version = "1.12.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Florian Frank