ollama-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f88e75feb900230387f4b960f5762daa8622af0f9562c0145d6b22c4a01fb3d
-  data.tar.gz: 4c6fea6ddc54c83ac6d003d4e5f3ccb6b90195b79a97aea6d98a95e32db36f99
+  metadata.gz: 1f80ae8ee6e8acbbedfff8b56923b25b583fc60b96c733985e32908874d542bb
+  data.tar.gz: 80834beb676929f08f4216e373e56cadd12d16c0b50e95b1a599bdd48bf29c86
 SHA512:
-  metadata.gz: 9002b36cd15680f89c50d6f3ee34b3a4e5d77362cd4982d4ca41fc9abbd0bcd1d44483579686f3bf9f20f9e10b1309c28ae8da789ba8ada66c7b5f6384643f87
-  data.tar.gz: e2566f950aea15cf47d60381340db2b0e7a8e3a2fd79aaa8ee421f6cbd367baeae0f64b24e5d9baa801bd715695edf80c5a88d0ba41867c9358bc3076d1ed112
+  metadata.gz: 94823ec618f940056bcee6ac7d706c633087404efcb49122cdccc89a4596b4a5f14a0d1c1d60fd7bb13a28e10f3ba4dc2027cd96cfe384169b25acaf75f532b7
+  data.tar.gz: ef8d4a7001c5502bc787f074f10dfaf16692b8fa90c4a6e32ae3c0c75b94da45b4691094229106cec72438837eef57b933cd5e5c9b28e63d0d4a598c152a9c32

data/CHANGES.md

@@ -0,0 +1,78 @@
+# Changes
+
+## 2024-09-03 v0.2.0
+
+### Changes
+
+* **Added Web Search Functionality to `ollama_chat`**
+	+ Added `/web` command to fetch search results from DuckDuckGo
+	+ Updated `/summarize` command to handle cases where summarization fails
+	+ Fix bug in parsing content type of source document
+* **Refactored Options Class and Usage**
+	+ Renamed `options` variable to use `Options[]` method in ollama_chat script
+	+ Added `[](value)` method to Ollama::Options class for casting hashes
+	+ Updated options_spec.rb with tests for casting hashes and error handling
+* **Refactored Web Search Command**
+	+ Added support for specifying a page number in `/web` command
+	+ Updated regular expression to match new format
+	+ Passed page number as an argument to `search_web` method
+	+ Updated content string to reference the query and sources correctly
+* **DTO Class Changes**
+	+ Renamed `json_create` method to `from_hash` in Ollama::DTO class
+	+ Updated `as_json` method to remove now unnecessary hash creation
+* **Message and Tool Spec Changes**
+	+ Removed `json_class` from JSON serialization in message_spec
+	+ Removed `json_class` from JSON serialization in tool_spec
+* **Command Spec Changes**
+	+ Removed `json_class` from JSON serialization in various command specs (e.g. generate_spec, pull_spec, etc.)
+* **Miscellaneous Changes**
+	+ Improved width calculation for text truncation
+	+ Updated FollowChat class to display evaluation statistics
+	+ Update OllamaChatConfig to use EOT instead of end for heredoc syntax
+	+ Add .keep file to tmp directory
+
+## 2024-08-30 v0.1.0
+
+### Change Log for New Version
+
+#### Significant Changes
+
+* **Document Splitting and Embedding Functionality**: Added `Ollama::Documents` class with methods for adding documents, checking existence, deleting documents, and finding similar documents.
+	+ Introduced two types of caches: `MemoryCache` and `RedisCache`
+	+ Implemented `SemanticSplitter` class to split text into sentences based on semantic similarity
+* **Improved Ollama Chat Client**: Added support for document embeddings and web/file RAG
+	+ Allowed configuration per yaml file
+	+ Parse user input for URLs or files to send images to multimodal models
+* **Redis Docker Service**: Set `REDIS_URL` environment variable to `redis://localhost:9736`
+	+ Added Redis service to `docker-compose.yml`
+* **Status Display and Progress Updates**: Added infobar.label = response.status when available
+	+ Updated infobar with progress message on each call if total and completed are set
+	+ Display error message from response.error if present
+* **Refactored Chat Commands**: Simplified regular expression patterns for `/pop`, `/save`, `/load`, and `/image` commands
+	+ Added whitespace to some command patterns for better readability
+
+#### Other Changes
+
+* Added `Character` and `RecursiveCharacter` splitter classes to split text into chunks based on character separators
+* Added RSpec tests for the Ollama::Documents class(es)
+* Updated dependencies and added new methods for calculating breakpoint thresholds and sentence embeddings
+* Added 'ollama_update' to executables in Rakefile
+* Started using webmock
+* Refactored chooser and add fetcher specs
+* Added tests for Ollama::Utils::Fetcher
+* Update README.md
+
+## 2024-08-16 v0.0.1
+
+* **New Features**
+	+ Added missing options parameter to Embed command
+	+ Documented new `/api/embed` endpoint
+* **Improvements**
+	+ Improved example in README.md
+* **Code Refactoring**
+	+ Renamed `client` to `ollama` in client and command specs
+	+ Updated expectations to use `ollama` instead of `client`
+
+## 2024-08-12 v0.0.0
+
+  * Start

data/README.md

@@ -43,7 +43,6 @@ ollama_chat [OPTIONS]
   -c CHAT        a saved chat conversation to load
   -C COLLECTION  name of the collection used in this conversation
   -D DOCUMENT    load document and add to collection (multiple)
-  -d             use markdown to display the chat messages
   -v             use voice output
   -h             this help
 ```

data/bin/ollama_chat

@@ -4,18 +4,20 @@ require 'ollama'
 include Ollama
 require 'term/ansicolor'
 include Term::ANSIColor
-require 'tins/go'
+require 'tins'
 include Tins::GO
 require 'reline'
 require 'reverse_markdown'
 require 'complex_config'
 require 'fileutils'
+require 'uri'
+require 'nokogiri'
 
 class OllamaChatConfig
   include ComplexConfig
   include FileUtils
 
-  DEFAULT_CONFIG = <<~end
+  DEFAULT_CONFIG = <<~EOT
     ---
     url: <%= ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST') %>
     model:
@@ -41,7 +43,7 @@ class OllamaChatConfig
     redis:
       url: <%= ENV.fetch('REDIS_URL', 'null') %>
     debug: <%= ENV['OLLAMA_CHAT_DEBUG'].to_i == 1 ? true : false %>
-  end
+  EOT
 
   def initialize(filename = nil)
     @filename = filename || default_path
@@ -109,11 +111,46 @@ class FollowChat
       end
       @say.call(response)
     end
-    response.done and @output.puts
+    if response.done
+      @output.puts
+      eval_stats = {
+        eval_duration:        Tins::Duration.new(response.eval_duration / 1e9),
+        eval_count:           response.eval_count,
+        prompt_eval_duration: Tins::Duration.new(response.prompt_eval_duration / 1e9),
+        prompt_eval_count:    response.prompt_eval_count,
+        total_duration:       Tins::Duration.new(response.total_duration / 1e9),
+        load_duration:        Tins::Duration.new(response.load_duration / 1e9),
+      }.map { _1 * '=' } * ' '
+      @output.puts '📊 ' + color(111) { Utils::Width.wrap(eval_stats, percentage: 90) }
+    end
     self
   end
 end
 
+def search_web(query, n = 5)
+  query = URI.encode_uri_component(query)
+  url = "https://www.duckduckgo.com/html/?q=#{query}"
+  Ollama::Utils::Fetcher.new.get(url) do |tmp|
+    result = []
+    doc = Nokogiri::HTML(tmp)
+    doc.css('.results_links').each do |link|
+      if n > 0
+        url = link.css('.result__a').first&.[]('href')
+        url.sub!(%r(\A/l/\?uddg=), '')
+        url.sub!(%r(&rut=.*), '')
+        url = URI.decode_uri_component(url)
+        url = URI.parse(url)
+        url.host =~ /duckduckgo\.com/ and next
+        result << url
+        n -= 1
+      else
+        break
+      end
+    end
+    result
+  end
+end
+
 def pull_model_unless_present(model, options, retried = false)
   ollama.show(name: model) { |response|
     puts "Model #{bold{model}} with architecture #{response.model_info['general.architecture']} found."
@@ -144,7 +181,7 @@ def load_conversation(filename)
     return
   end
   File.open(filename, 'r') do |output|
-    return JSON(output.read, create_additions: true)
+    return JSON(output.read).map { Ollama::Message.from_hash(_1) }
   end
 end
 
@@ -201,7 +238,7 @@ def parse_source(source_io)
   when 'plain', 'csv', 'xml'
     source_io.read
   else
-    STDERR.puts "Cannot import #{source_io.content_type} document."
+    STDERR.puts "Cannot import #{source_io&.content_type} document."
     return
   end
 end
@@ -211,7 +248,7 @@ def import_document(source_io, source)
     STDOUT.puts "Embedding disabled, I won't import any documents, try: /summarize"
     return
   end
-  STDOUT.puts "Importing #{source_io.content_type} document #{source.to_s.inspect}."
+  infobar.puts "Importing #{italic { source_io.content_type }} document #{source.to_s.inspect}."
   text = parse_source(source_io) or return
   text.downcase!
   splitter_config = $config.embedding.splitter
@@ -381,7 +418,6 @@ def usage
       -c CHAT        a saved chat conversation to load
       -C COLLECTION  name of the collection used in this conversation
       -D DOCUMENT    load document and add to collection (multiple)
-      -d             use markdown to display the chat messages
       -v             use voice output
       -h             this help
 
@@ -393,7 +429,7 @@ def ollama
   $ollama
 end
 
-opts = go 'f:u:m:s:c:C:D:dvh'
+opts = go 'f:u:m:s:c:C:D:vh'
 
 config = OllamaChatConfig.new(opts[?f])
 $config = config.config
@@ -407,13 +443,13 @@ base_url = opts[?u] || $config.url
 $ollama      = Client.new(base_url:, debug: $config.debug)
 
 model        = choose_model(opts[?m], $config.model.name)
-options      = $config.model.options
+options      = Options[$config.model.options]
 model_system = pull_model_unless_present(model, options)
 messages     = []
 
 if $config.embedding.enabled
   embedding_model         = $config.embedding.model.name
-  embedding_model_options = $config.embedding.model.options
+  embedding_model_options = Options[$config.embedding.model.options]
   pull_model_unless_present(embedding_model, embedding_model_options)
   collection = opts[?C] || $config.embedding.collection
   $documents = Documents.new(
@@ -456,8 +492,7 @@ end
 if voice = ($config.voice if opts[?v])
   puts "Using voice #{bold{voice}} to speak."
 end
-
-markdown = set_markdown(opts[?d] || $config.markdown)
+markdown = set_markdown($config.markdown)
 
 if opts[?c]
   messages.concat load_conversation(opts[?c])
@@ -478,12 +513,13 @@ end
 
 puts "\nType /help to display the chat help."
 
-images = []
+images           = []
 loop do
   parse_content = true
-
   input_prompt = bold { color(172) { message_type(images) + " user" } } + bold { "> " }
-  case content = Reline.readline(input_prompt, true)&.chomp
+  content = Reline.readline(input_prompt, true)&.chomp
+
+  case content
   when %r(^/paste$)
     puts bold { "Paste your content and then press C-d!" }
     content = STDIN.read
@@ -518,7 +554,7 @@ loop do
   when %r(^/pop?(?:\s+(\d*))?$)
     n = $1.to_i.clamp(1, Float::INFINITY)
     r =  messages.pop(2 * n)
-    m = r.size
+    m = r.size / 2
     puts "Popped the last #{m} exchanges."
     next
   when %r(^/model$)
@@ -534,7 +570,15 @@ loop do
     end
   when %r(^/summarize\s+(.+))
     parse_content = false
-    content       = summarize($1)
+    content       = summarize($1) or next
+  when %r(^/web\s+(?:(\d+)\s+)(.+)$)
+    parse_content = true
+    urls = search_web($2, $1.to_i)
+    content = <<~end
+      Answer the the query #{$2.inspect} using these sources:
+
+      #{urls * ?\n}
+    end
   when %r(^/save\s+(.+)$)
     save_conversation($1, messages)
     puts "Saved conversation to #$1."
@@ -557,7 +601,7 @@ loop do
                     [ content, Utils::Tags.new ]
                   end
 
-  if $config.embedding.enabled
+  if $config.embedding.enabled && content
     records = $documents.find(
       content.downcase,
       tags:,
@@ -569,7 +613,8 @@ loop do
     }
     found_texts = records.map(&:text)
     unless found_texts.empty?
-      content += "\nConsider these chunks for your answer:\n#{found_texts.join("\n\n---\n\n")}"
+      content += "\nConsider these chunks for your answer:\n"\
+        "#{found_texts.join("\n\n---\n\n")}"
     end
   end
 
@@ -577,15 +622,17 @@ loop do
   handler = FollowChat.new(messages:, markdown:, voice:)
   ollama.chat(model:, messages:, options:, stream: true, &handler)
 
-  puts records.map { |record|
-    link = if record.source =~ %r(\Ahttps?://)
-             record.source
-           else
-             'file://%s' % File.expand_path(record.source)
-           end
-    [ link, record.tags.first ]
-  }.uniq.map { |l, t| hyperlink(l, t) }.join(' ')
-  $config.debug and jj messages
+  if records
+    puts records.map { |record|
+      link = if record.source =~ %r(\Ahttps?://)
+               record.source
+             else
+               'file://%s' % File.expand_path(record.source)
+             end
+      [ link, record.tags.first ]
+    }.uniq.map { |l, t| hyperlink(l, t) }.join(' ')
+    $config.debug and jj messages
+  end
 rescue Interrupt
   puts "Type /quit to quit."
 end

data/lib/ollama/dto.rb

@@ -8,8 +8,8 @@ module Ollama::DTO
   module ClassMethods
     attr_accessor :attributes
 
-    def json_create(object)
-      new(**object.transform_keys(&:to_sym))
+    def from_hash(hash)
+      new(**hash.transform_keys(&:to_sym))
     end
 
     def attr_reader(*names)
@@ -27,11 +27,8 @@ module Ollama::DTO
   end
 
   def as_json(*)
-    {
-      json_class: self.class.name
-    }.merge(
-      self.class.attributes.each_with_object({}) { |a, h| h[a] = send(a) }
-    ).reject { _2.nil? || _2.ask_and_send(:size) == 0 }
+    self.class.attributes.each_with_object({}) { |a, h| h[a] = send(a) }.
+      reject { _2.nil? || _2.ask_and_send(:size) == 0 }
   end
 
   alias to_hash as_json

data/lib/ollama/options.rb

@@ -65,4 +65,8 @@ class Ollama::Options
       #{@@types.keys.map { "self.#{_1} = #{_1}" }.join(?\n)}
     end
   }
+
+  def self.[](value)
+    new(**value.to_h)
+  end
 end

data/lib/ollama/utils/width.rb

@@ -12,7 +12,7 @@ module Ollama::Utils::Width
       raise ArgumentError, "either pass percentage or length argument"
     percentage and length ||= width(percentage:)
     text.gsub(/(?<!\n)\n(?!\n)/, ' ').lines.map do |line|
-      if line.length > length
+      if length >= 1 && line.length > length
         line.gsub(/(.{1,#{length}})(\s+|$)/, "\\1\n").strip
       else
         line.strip

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '0.1.0'
+  VERSION         = '0.2.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,24 +1,24 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 0.1.0 ruby lib
+# stub: ollama-ruby 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "0.1.0".freeze
+  s.version = "0.2.0".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-30"
+  s.date = "2024-09-03"
   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, "ollama_update".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/ollama.rb".freeze, "lib/ollama/client.rb".freeze, "lib/ollama/client/command.rb".freeze, "lib/ollama/client/doc.rb".freeze, "lib/ollama/commands/chat.rb".freeze, "lib/ollama/commands/copy.rb".freeze, "lib/ollama/commands/create.rb".freeze, "lib/ollama/commands/delete.rb".freeze, "lib/ollama/commands/embed.rb".freeze, "lib/ollama/commands/embeddings.rb".freeze, "lib/ollama/commands/generate.rb".freeze, "lib/ollama/commands/ps.rb".freeze, "lib/ollama/commands/pull.rb".freeze, "lib/ollama/commands/push.rb".freeze, "lib/ollama/commands/show.rb".freeze, "lib/ollama/commands/tags.rb".freeze, "lib/ollama/documents.rb".freeze, "lib/ollama/documents/memory_cache.rb".freeze, "lib/ollama/documents/redis_cache.rb".freeze, "lib/ollama/documents/splitters/character.rb".freeze, "lib/ollama/documents/splitters/semantic.rb".freeze, "lib/ollama/dto.rb".freeze, "lib/ollama/errors.rb".freeze, "lib/ollama/handlers.rb".freeze, "lib/ollama/handlers/collector.rb".freeze, "lib/ollama/handlers/concern.rb".freeze, "lib/ollama/handlers/dump_json.rb".freeze, "lib/ollama/handlers/dump_yaml.rb".freeze, "lib/ollama/handlers/markdown.rb".freeze, "lib/ollama/handlers/nop.rb".freeze, "lib/ollama/handlers/print.rb".freeze, "lib/ollama/handlers/progress.rb".freeze, "lib/ollama/handlers/say.rb".freeze, "lib/ollama/handlers/single.rb".freeze, "lib/ollama/image.rb".freeze, "lib/ollama/message.rb".freeze, "lib/ollama/options.rb".freeze, "lib/ollama/response.rb".freeze, "lib/ollama/tool.rb".freeze, "lib/ollama/tool/function.rb".freeze, "lib/ollama/tool/function/parameters.rb".freeze, "lib/ollama/tool/function/parameters/property.rb".freeze, "lib/ollama/utils/ansi_markdown.rb".freeze, "lib/ollama/utils/chooser.rb".freeze, "lib/ollama/utils/colorize_texts.rb".freeze, "lib/ollama/utils/fetcher.rb".freeze, "lib/ollama/utils/math.rb".freeze, "lib/ollama/utils/tags.rb".freeze, "lib/ollama/utils/width.rb".freeze, "lib/ollama/version.rb".freeze]
-  s.files = [".envrc".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ollama_chat".freeze, "bin/ollama_console".freeze, "bin/ollama_update".freeze, "config/redis.conf".freeze, "docker-compose.yml".freeze, "lib/ollama.rb".freeze, "lib/ollama/client.rb".freeze, "lib/ollama/client/command.rb".freeze, "lib/ollama/client/doc.rb".freeze, "lib/ollama/commands/chat.rb".freeze, "lib/ollama/commands/copy.rb".freeze, "lib/ollama/commands/create.rb".freeze, "lib/ollama/commands/delete.rb".freeze, "lib/ollama/commands/embed.rb".freeze, "lib/ollama/commands/embeddings.rb".freeze, "lib/ollama/commands/generate.rb".freeze, "lib/ollama/commands/ps.rb".freeze, "lib/ollama/commands/pull.rb".freeze, "lib/ollama/commands/push.rb".freeze, "lib/ollama/commands/show.rb".freeze, "lib/ollama/commands/tags.rb".freeze, "lib/ollama/documents.rb".freeze, "lib/ollama/documents/memory_cache.rb".freeze, "lib/ollama/documents/redis_cache.rb".freeze, "lib/ollama/documents/splitters/character.rb".freeze, "lib/ollama/documents/splitters/semantic.rb".freeze, "lib/ollama/dto.rb".freeze, "lib/ollama/errors.rb".freeze, "lib/ollama/handlers.rb".freeze, "lib/ollama/handlers/collector.rb".freeze, "lib/ollama/handlers/concern.rb".freeze, "lib/ollama/handlers/dump_json.rb".freeze, "lib/ollama/handlers/dump_yaml.rb".freeze, "lib/ollama/handlers/markdown.rb".freeze, "lib/ollama/handlers/nop.rb".freeze, "lib/ollama/handlers/print.rb".freeze, "lib/ollama/handlers/progress.rb".freeze, "lib/ollama/handlers/say.rb".freeze, "lib/ollama/handlers/single.rb".freeze, "lib/ollama/image.rb".freeze, "lib/ollama/message.rb".freeze, "lib/ollama/options.rb".freeze, "lib/ollama/response.rb".freeze, "lib/ollama/tool.rb".freeze, "lib/ollama/tool/function.rb".freeze, "lib/ollama/tool/function/parameters.rb".freeze, "lib/ollama/tool/function/parameters/property.rb".freeze, "lib/ollama/utils/ansi_markdown.rb".freeze, "lib/ollama/utils/chooser.rb".freeze, "lib/ollama/utils/colorize_texts.rb".freeze, "lib/ollama/utils/fetcher.rb".freeze, "lib/ollama/utils/math.rb".freeze, "lib/ollama/utils/tags.rb".freeze, "lib/ollama/utils/width.rb".freeze, "lib/ollama/version.rb".freeze, "ollama-ruby.gemspec".freeze, "spec/assets/embeddings.json".freeze, "spec/assets/kitten.jpg".freeze, "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/documents/memory_cache_spec.rb".freeze, "spec/ollama/documents/redis_cache_spec.rb".freeze, "spec/ollama/documents/splitters/character_spec.rb".freeze, "spec/ollama/documents/splitters/semantic_spec.rb".freeze, "spec/ollama/documents_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/ollama/utils/ansi_markdown_spec.rb".freeze, "spec/ollama/utils/fetcher_spec.rb".freeze, "spec/ollama/utils/tags_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.files = [".envrc".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ollama_chat".freeze, "bin/ollama_console".freeze, "bin/ollama_update".freeze, "config/redis.conf".freeze, "docker-compose.yml".freeze, "lib/ollama.rb".freeze, "lib/ollama/client.rb".freeze, "lib/ollama/client/command.rb".freeze, "lib/ollama/client/doc.rb".freeze, "lib/ollama/commands/chat.rb".freeze, "lib/ollama/commands/copy.rb".freeze, "lib/ollama/commands/create.rb".freeze, "lib/ollama/commands/delete.rb".freeze, "lib/ollama/commands/embed.rb".freeze, "lib/ollama/commands/embeddings.rb".freeze, "lib/ollama/commands/generate.rb".freeze, "lib/ollama/commands/ps.rb".freeze, "lib/ollama/commands/pull.rb".freeze, "lib/ollama/commands/push.rb".freeze, "lib/ollama/commands/show.rb".freeze, "lib/ollama/commands/tags.rb".freeze, "lib/ollama/documents.rb".freeze, "lib/ollama/documents/memory_cache.rb".freeze, "lib/ollama/documents/redis_cache.rb".freeze, "lib/ollama/documents/splitters/character.rb".freeze, "lib/ollama/documents/splitters/semantic.rb".freeze, "lib/ollama/dto.rb".freeze, "lib/ollama/errors.rb".freeze, "lib/ollama/handlers.rb".freeze, "lib/ollama/handlers/collector.rb".freeze, "lib/ollama/handlers/concern.rb".freeze, "lib/ollama/handlers/dump_json.rb".freeze, "lib/ollama/handlers/dump_yaml.rb".freeze, "lib/ollama/handlers/markdown.rb".freeze, "lib/ollama/handlers/nop.rb".freeze, "lib/ollama/handlers/print.rb".freeze, "lib/ollama/handlers/progress.rb".freeze, "lib/ollama/handlers/say.rb".freeze, "lib/ollama/handlers/single.rb".freeze, "lib/ollama/image.rb".freeze, "lib/ollama/message.rb".freeze, "lib/ollama/options.rb".freeze, "lib/ollama/response.rb".freeze, "lib/ollama/tool.rb".freeze, "lib/ollama/tool/function.rb".freeze, "lib/ollama/tool/function/parameters.rb".freeze, "lib/ollama/tool/function/parameters/property.rb".freeze, "lib/ollama/utils/ansi_markdown.rb".freeze, "lib/ollama/utils/chooser.rb".freeze, "lib/ollama/utils/colorize_texts.rb".freeze, "lib/ollama/utils/fetcher.rb".freeze, "lib/ollama/utils/math.rb".freeze, "lib/ollama/utils/tags.rb".freeze, "lib/ollama/utils/width.rb".freeze, "lib/ollama/version.rb".freeze, "ollama-ruby.gemspec".freeze, "spec/assets/embeddings.json".freeze, "spec/assets/kitten.jpg".freeze, "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/documents/memory_cache_spec.rb".freeze, "spec/ollama/documents/redis_cache_spec.rb".freeze, "spec/ollama/documents/splitters/character_spec.rb".freeze, "spec/ollama/documents/splitters/semantic_spec.rb".freeze, "spec/ollama/documents_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/ollama/utils/ansi_markdown_spec.rb".freeze, "spec/ollama/utils/fetcher_spec.rb".freeze, "spec/ollama/utils/tags_spec.rb".freeze, "spec/spec_helper.rb".freeze, "tmp/.keep".freeze]
   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.5.16".freeze
+  s.rubygems_version = "3.5.11".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/documents/memory_cache_spec.rb".freeze, "spec/ollama/documents/redis_cache_spec.rb".freeze, "spec/ollama/documents/splitters/character_spec.rb".freeze, "spec/ollama/documents/splitters/semantic_spec.rb".freeze, "spec/ollama/documents_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/ollama/utils/ansi_markdown_spec.rb".freeze, "spec/ollama/utils/fetcher_spec.rb".freeze, "spec/ollama/utils/tags_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 

data/spec/ollama/client_spec.rb

@@ -116,7 +116,7 @@ RSpec.describe Ollama::Client do
     it 'can generate without stream' do
       expect(excon).to receive(:send).with(
         :post,
-        body:  '{"json_class":"Ollama::Commands::Generate","model":"llama3.1","prompt":"Hello World"}',
+        body:  '{"model":"llama3.1","prompt":"Hello World"}',
         headers: hash_including(
           'Content-Type' => 'application/json; charset=utf-8',
         )
@@ -127,7 +127,7 @@ RSpec.describe Ollama::Client do
     it 'can generate with stream' do
       expect(excon).to receive(:send).with(
         :post,
-        body:  '{"json_class":"Ollama::Commands::Generate","model":"llama3.1","prompt":"Hello World","stream":true}',
+        body:  '{"model":"llama3.1","prompt":"Hello World","stream":true}',
         headers: hash_including(
           'Content-Type' => 'application/json; charset=utf-8',
         ),

data/spec/ollama/commands/chat_spec.rb

@@ -32,7 +32,7 @@ RSpec.describe Ollama::Commands::Chat do
       model: 'llama3.1', messages: messages.map(&:as_json), stream: true,
     )
     expect(chat.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Chat","model":"llama3.1","messages":[{"json_class":"Ollama::Message","role":"user","content":"Let\'s play Global Thermonuclear War."}],"stream":true}'
+      '{"model":"llama3.1","messages":[{"role":"user","content":"Let\'s play Global Thermonuclear War."}],"stream":true}'
     )
   end
 
@@ -45,7 +45,7 @@ RSpec.describe Ollama::Commands::Chat do
     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}'
+        body: '{"model":"llama3.1","messages":[{"role":"user","content":"Let\'s play Global Thermonuclear War."}],"stream":true}'
       )
     chat.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/copy_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Ollama::Commands::Copy do
       source: 'llama3.1', destination: 'camell3', stream: false
     )
     expect(copy.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Copy","source":"llama3.1","destination":"camell3","stream":false}'
+      '{"source":"llama3.1","destination":"camell3","stream":false}'
     )
   end
 
@@ -21,7 +21,7 @@ RSpec.describe Ollama::Commands::Copy do
     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}'
+      body: '{"source":"llama3.1","destination":"camell3","stream":false}'
     )
     copy.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/create_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Ollama::Commands::Create do
       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,
     )
     expect(create.to_json).to eq(
-      '{"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}'
+      '{"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}'
     )
   end
 
@@ -30,7 +30,7 @@ RSpec.describe Ollama::Commands::Create do
     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}'
+        body: '{"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}'
       )
     create.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/delete_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Ollama::Commands::Delete do
       name: 'llama3.1', stream: false
     )
     expect(delete.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Delete","name":"llama3.1","stream":false}'
+      '{"name":"llama3.1","stream":false}'
     )
   end
 
@@ -21,7 +21,7 @@ RSpec.describe Ollama::Commands::Delete do
     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}'
+      body: '{"name":"llama3.1","stream":false}'
     )
     delete.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/embed_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe Ollama::Commands::Embed do
       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?","options":{"json_class":"Ollama::Options","num_ctx":666},"stream":false}'
+      '{"model":"all-minilm","input":"Why is the sky blue?","options":{"num_ctx":666},"stream":false}'
     )
   end
 
@@ -32,7 +32,7 @@ RSpec.describe Ollama::Commands::Embed do
       model: 'all-minilm', input: [ 'Why is the sky blue?', 'Why is the grass green?' ],
     )
     expect(embed.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Embed","model":"all-minilm","input":["Why is the sky blue?","Why is the grass green?"],"stream":false}'
+      '{"model":"all-minilm","input":["Why is the sky blue?","Why is the grass green?"],"stream":false}'
     )
   end
 
@@ -46,7 +46,7 @@ RSpec.describe Ollama::Commands::Embed do
     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}'
+        body: '{"model":"all-minilm","input":"Why is the sky blue?","stream":false}'
       )
     embed.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/embeddings_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe Ollama::Commands::Embeddings do
       model: 'mxbai-embed-large', prompt: 'Here are the coordinates of all Soviet military installations: …',
     )
     expect(embeddings.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Embeddings","model":"mxbai-embed-large","prompt":"Here are the coordinates of all Soviet military installations: …","stream":false}'
+      '{"model":"mxbai-embed-large","prompt":"Here are the coordinates of all Soviet military installations: …","stream":false}'
     )
   end
 
@@ -31,7 +31,7 @@ RSpec.describe Ollama::Commands::Embeddings do
     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}'
+        body: '{"model":"mxbai-embed-large","prompt":"Here are the coordinates of all Soviet military installations: …","stream":false}'
       )
     embeddings.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/generate_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Ollama::Commands::Generate do
       model: 'llama3.1', prompt: 'Hello World'
     )
     expect(generate.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Generate","model":"llama3.1","prompt":"Hello World"}'
+      '{"model":"llama3.1","prompt":"Hello World"}'
     )
   end
 
@@ -22,7 +22,7 @@ RSpec.describe Ollama::Commands::Generate do
     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}'
+        body: '{"model":"llama3.1","prompt":"Hello World","stream":true}'
       )
     generate.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/pull_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Ollama::Commands::Pull do
       name: 'llama3.1', stream: true
     )
     expect(pull.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Pull","name":"llama3.1","stream":true}'
+      '{"name":"llama3.1","stream":true}'
     )
   end
 
@@ -21,7 +21,7 @@ RSpec.describe Ollama::Commands::Pull do
     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}'
+      body: '{"name":"llama3.1","stream":true}'
     )
     pull.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/push_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Ollama::Commands::Push do
       name: 'llama3.1', stream: true
     )
     expect(push.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Push","name":"llama3.1","stream":true}'
+      '{"name":"llama3.1","stream":true}'
     )
   end
 
@@ -21,7 +21,7 @@ RSpec.describe Ollama::Commands::Push do
     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}'
+      body: '{"name":"llama3.1","stream":true}'
     )
     push.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/commands/show_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Ollama::Commands::Show do
       name: 'llama3.1', stream: false
     )
     expect(show.to_json).to eq(
-      '{"json_class":"Ollama::Commands::Show","name":"llama3.1","stream":false}'
+      '{"name":"llama3.1","stream":false}'
     )
   end
 
@@ -21,7 +21,7 @@ RSpec.describe Ollama::Commands::Show do
     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}'
+      body: '{"name":"llama3.1","stream":false}'
     )
     show.perform(Ollama::Handlers::NOP)
   end

data/spec/ollama/message_spec.rb

@@ -19,19 +19,18 @@ RSpec.describe Ollama::Message do
 
   it 'can be converted to JSON' do
     expect(message.as_json).to eq(
-      json_class: described_class.name,
       role: 'user',
       content: 'hello world',
       images: [ image ],
     )
     expect(message.to_json).to eq(
-      '{"json_class":"Ollama::Message","role":"user","content":"hello world","images":["dGVzdA==\n"]}'
+      '{"role":"user","content":"hello world","images":["dGVzdA==\n"]}'
     )
   end
 
   it 'can be restored from JSON' do
-    expect(JSON(<<~'end', create_additions: true)).to be_a described_class
-      {"json_class":"Ollama::Message","role":"user","content":"hello world","images":["dGVzdA==\n"]}
+    expect(described_class.from_hash(JSON(<<~'end'))).to be_a described_class
+      {"role":"user","content":"hello world","images":["dGVzdA==\n"]}
     end
   end
 end

data/spec/ollama/options_spec.rb

@@ -13,6 +13,24 @@ RSpec.describe Ollama::Options do
     expect(options).to be_a described_class
   end
 
+  it 'can be used to cast hashes' do
+    expect(described_class[{
+      penalize_newline: true,
+      num_ctx: 8192,
+      temperature: 0.7,
+    }]).to be_a described_class
+  end
+
+  it 'raises errors when casting goes all wrong' do
+    expect {
+      described_class[{
+        penalize_newline: :tertium,
+        num_ctx: 8192,
+        temperature: 0.7,
+      }]
+    }.to raise_error(TypeError)
+  end
+
   it 'throws error for invalid types' do
     expect { described_class.new(temperature: Class.new) }.
       to raise_error(TypeError)

data/spec/ollama/tool_spec.rb

@@ -45,23 +45,18 @@ RSpec.describe Ollama::Tool do
 
   it 'cannot be converted to JSON' do
     expect(tool.as_json).to eq(
-      json_class: described_class.name,
       type: 'function',
       function: {
-        json_class: "Ollama::Tool::Function",
         name: 'get_current_weather',
         description: "Get the current weather for a location",
         parameters: {
-          json_class: "Ollama::Tool::Function::Parameters",
           type: "object",
           properties: {
             location: {
-              json_class: "Ollama::Tool::Function::Parameters::Property",
               type: "string",
               description: "The location to get the weather for, e.g. Berlin, Berlin"
             },
             format: {
-              json_class: "Ollama::Tool::Function::Parameters::Property",
               type: "string",
               description: "The format to return the weather in, e.g. 'celsius' or 'fahrenheit'",
               enum: ["celsius", "fahrenheit"]
@@ -72,7 +67,7 @@ RSpec.describe Ollama::Tool do
       }
     )
     expect(tool.to_json).to eq(
-      %{{"json_class":"Ollama::Tool","type":"function","function":{"json_class":"Ollama::Tool::Function","name":"get_current_weather","description":"Get the current weather for a location","parameters":{"json_class":"Ollama::Tool::Function::Parameters","type":"object","properties":{"location":{"json_class":"Ollama::Tool::Function::Parameters::Property","type":"string","description":"The location to get the weather for, e.g. Berlin, Berlin"},"format":{"json_class":"Ollama::Tool::Function::Parameters::Property","type":"string","description":"The format to return the weather in, e.g. 'celsius' or 'fahrenheit'","enum":["celsius","fahrenheit"]}},"required":["location","format"]}}}}
+      %{{"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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -337,6 +337,7 @@ extra_rdoc_files:
 - lib/ollama/version.rb
 files:
 - ".envrc"
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
@@ -435,6 +436,7 @@ files:
 - spec/ollama/utils/fetcher_spec.rb
 - spec/ollama/utils/tags_spec.rb
 - spec/spec_helper.rb
+- tmp/.keep
 homepage: https://github.com/flori/ollama-ruby
 licenses:
 - MIT
@@ -458,7 +460,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Interacting with the Ollama API