ollama-ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 510c31683b2251118a7c3b469620400016b29fd1ea6f17cc86e4f99f62ecea2f
-  data.tar.gz: a00c4275e42002a01a99f874a855386c83e502551360c1f4146eee0b74f2fd08
+  metadata.gz: c0e3428486bf4d60d1e4a64574a9c04bb41da5a5fe76b5f4bc37c5f089221cf3
+  data.tar.gz: 0a2f6f5269c97b22493400448204116aebef642273c024aee474a38741dfdce5
 SHA512:
-  metadata.gz: 17e50d40e4c24b56b5c2923f0b73f3e4294587b61a302fbaf4cd8f891e879eb435541e1f7e195a4f88352fd99aa80ff44c8577b8c195d7ef31af1c33229018b7
-  data.tar.gz: a18bcef82e9481b75fee4a4c88598a7a374c48f841e9870b39174c0d1f5f235f1173bdbff939182481d431e4e9c8c85501be4f5ef917ca02865692cfc39fde5a
+  metadata.gz: 3fd8db76a1cad30ba41af287e1abb77a102913f09f1648c9fbaf89f5e3bf4f3dace4a39cc6b72da456b633eb42d331b356134aecc196b112c7f94215177b4023
+  data.tar.gz: 4541a1e93c2714b786cb21b5e401ffc48a08e05c39bfac860e8cdd275a447bbc7db0b6cf80fee5f459f86734320a90362418a50f4174d53ece4e1a9d2f1dc647

data/CHANGES.md

@@ -1,5 +1,44 @@
 # Changes
 
+## 2024-09-12 v0.3.1
+
+* Update dependencies and date in gemspec files:
+  - Updated `complex_config` dependency to '~> 0.22'
+* Refactor FollowChat#eval_stats to add bold eval rates
+  * Improve formatting in eval_stats using bold and color for better
+    readability.
+  * Update import_document and add_image methods to handle nil values
+    correctly.
+  * Update width method in utils/width.rb to use uncolor when checking line
+    length.
+* Refactor eval stats output in FollowChat class
+  - Add indentation to eval stats output for better readability
+* FollowChat evaluation stats refactored
+  - Removed hardcoded eval_stats hash and replaced with method call
+    `eval_stats(response)`
+  - Added new method `eval_stats(response)` to calculate evaluation statistics
+    - Calculates eval duration, prompt eval duration, total duration, and load
+      duration
+    - Adds eval count, prompt eval count, eval rate, and prompt eval rate
+* Use default to_s tree representation of config.
+  * Update complex_config dependency to ~> 0.21, >= 0.21.1 in Rakefile
+  * Update complex_config dependency to ~> 0.21, >= 0.21.1 in
+    ollama-ruby.gemspec
+* Update dependencies and configuration display
+  * Update 'complex_config' dependency to '~> 0.21'
+  * Change OllamaChatConfig to display configuration as a tree instead of yaml
+* Improve /web search command
+  * Update infobar dependency to ~> 0.8
+  * Update /web command to summarize web sources as well as importing them
+    directly
+  * Add /clobber command to clear conversation messages and collection
+* Refactor Ollama chat configuration and summary generation.
+  * Update `OllamaChatConfig` to use `prompts.system` instead of `system`.
+  * Introduce `prompts.summarize` config as template for generating abstract
+    summaries.
+  * Replace hardcoded summary generation with call to `prompts.summarize`.
+  * Display /help for all unknown chat commands starting wit `/`
+
 ## 2024-09-05 v0.3.0
 
 * **New Features**

data/README.md

@@ -156,6 +156,7 @@ The following commands can be given inside the chat, if prefixed by a `/`:
 /markdown                                toggle markdown output
 /list                                    list the messages of the conversation
 /clear                                   clear the conversation messages
+/clobber                                 clear conversation messages and collection
 /pop [n]                                 pop the last n exchanges, defaults to 1
 /model                                   change the model
 /regenerate                              the last answer message

data/Rakefile

@@ -24,7 +24,7 @@ GemHadar do
   required_ruby_version  '~> 3.1'
 
   dependency             'excon',                 '~> 0.111'
-  dependency             'infobar',               '~> 0.7'
+  dependency             'infobar',               '~> 0.8'
   dependency             'term-ansicolor',        '~> 1.11'
   dependency             'kramdown-parser-gfm',   '~> 1.1'
   dependency             'terminal-table',        '~> 3.0'
@@ -34,7 +34,7 @@ GemHadar do
   dependency             'sorted_set',            '~> 1.0'
   dependency             'mime-types',            '~> 3.0'
   dependency             'reverse_markdown',      '~> 2.0'
-  dependency             'complex_config',        '~> 0.20'
+  dependency             'complex_config',        '~> 0.22'
   dependency             'search_ui',             '~> 0.0'
   dependency             'amatch',                '~> 0.4.1'
   dependency             'pdf-reader',            '~> 2.0'

data/bin/ollama_chat

@@ -26,7 +26,12 @@ class OllamaChatConfig
       name: <%= ENV.fetch('OLLAMA_CHAT_MODEL', 'llama3.1') %>
       options:
         num_ctx: 8192
-    system: <%= ENV.fetch('OLLAMA_CHAT_SYSTEM', 'null') %>
+    prompts:
+      system: <%= ENV.fetch('OLLAMA_CHAT_SYSTEM', 'null') %>
+      summarize: |
+        Generate an abstract summary of the content in this document:
+
+        %s
     voice: Samantha
     markdown: true
     embedding:
@@ -50,7 +55,7 @@ class OllamaChatConfig
 
   def initialize(filename = nil)
     @filename = filename || default_path
-    @config = Provider.config(@filename)
+    @config = Provider.config(@filename, '⚙️')
     retried = false
   rescue ConfigurationFileMissing
     if @filename == default_path && !retried
@@ -115,19 +120,28 @@ class FollowChat
       @say.call(response)
     end
     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) }
+      @output.puts "", eval_stats(response)
     end
     self
   end
+
+  def eval_stats(response)
+    eval_duration = response.eval_duration / 1e9
+    prompt_eval_duration = response.prompt_eval_duration / 1e9
+    stats_text = {
+      eval_duration:        Tins::Duration.new(eval_duration),
+      eval_count:           response.eval_count,
+      eval_rate:            bold { "%.2f c/s" % (response.eval_count / eval_duration) } + color(111),
+      prompt_eval_duration: Tins::Duration.new(prompt_eval_duration),
+      prompt_eval_count:    response.prompt_eval_count,
+      prompt_eval_rate:     bold { "%.2f c/s" % (response.prompt_eval_count / prompt_eval_duration) } + color(111),
+      total_duration:       Tins::Duration.new(response.total_duration / 1e9),
+      load_duration:        Tins::Duration.new(response.load_duration / 1e9),
+    }.map { _1 * '=' } * ' '
+    '📊 ' + color(111) {
+      Utils::Width.wrap(stats_text, percentage: 90).gsub(/(?<!\A)^/, '   ')
+    }
+  end
 end
 
 def search_web(query, n = 5)
@@ -312,7 +326,7 @@ def import_document(source_io, source)
     STDOUT.puts "Embedding disabled, I won't import any documents, try: /summarize"
     return
   end
-  infobar.puts "Importing #{italic { source_io.content_type }} document #{source.to_s.inspect}."
+  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
@@ -340,7 +354,7 @@ def import_document(source_io, source)
 end
 
 def add_image(images, source_io, source)
-  STDERR.puts "Adding #{source_io.content_type} image #{source.to_s.inspect}."
+  STDERR.puts "Adding #{source_io&.content_type} image #{source.to_s.inspect}."
   image = Image.for_io(source_io, path: source.to_s)
   (images << image).uniq!
 end
@@ -365,16 +379,12 @@ rescue => e
 end
 
 def summarize(source)
-  puts  "Now summarizing #{source.inspect}."
+  puts "Now summarizing #{source.to_s.inspect}."
   source_content =
     fetch_source(source) do |source_io|
       parse_source(source_io) or return
     end
-  <<~end
-    # Generate an abstract summary of the content in this document:
-
-    #{source_content}
-  end
+  $config.prompts.summarize % source_content
 end
 
 def parse_content(content, images)
@@ -459,6 +469,7 @@ def display_chat_help
     /markdown                                toggle markdown output
     /list                                    list the messages of the conversation
     /clear                                   clear the conversation messages
+    /clobber                                 clear conversation messages and collection
     /pop [n]                                 pop the last n exchanges, defaults to 1
     /model                                   change the model
     /regenerate                              the last answer message
@@ -501,8 +512,7 @@ $config = config.config
 
 opts[?h] and usage
 
-puts "Configuration read from #{config.filename.inspect} is:"
-y $config.to_h
+puts "Configuration read from #{config.filename.inspect} is:", $config
 
 base_url = opts[?u] || $config.url
 $ollama      = Client.new(base_url:, debug: $config.debug)
@@ -540,7 +550,7 @@ if $config.embedding.enabled
         File.expand_path(doc)
       end
     end
-    infobar.puts "Collection #{bold{collection}}: Adding #{document_list.size} documents…"
+    puts "Collection #{bold{collection}}: Adding #{document_list.size} documents…"
     document_list.each_slice(25) do |docs|
       docs.each do |doc|
         fetch_source(doc) do |doc_io|
@@ -563,7 +573,7 @@ if opts[?c]
   messages.concat load_conversation(opts[?c])
 else
   if system = Ollama::Utils::FileArgument.
-      get_file_argument(opts[?s], default: $config.system? || model_system)
+      get_file_argument(opts[?s], default: $config.prompts.system? || model_system)
     messages << Message.new(role: 'system', content: system)
     puts "Configured system prompt is:\n#{italic { system }}"
   end
@@ -584,7 +594,7 @@ loop do
   when %r(^/quit$)
     puts "Goodbye."
     exit 0
-  when %r(^/markdown)
+  when %r(^/markdown$)
     markdown = set_markdown(!markdown)
     next
   when %r(^/list$)
@@ -594,6 +604,11 @@ loop do
     messages.clear
     puts "Cleared messages."
     next
+  when %r(^/clobber$)
+    messages.clear
+    $documents.clear
+    puts "Cleared messages and collection."
+    next
   when %r(^/collection\s+(clear|stats|change|new)(?:\s+(.+))?$)
     command, arg = $1, $2
     case command
@@ -636,13 +651,19 @@ loop do
   when %r(^/summarize\s+(.+))
     parse_content = false
     content       = summarize($1) or next
-  when %r(^/web\s+(?:(\d+)\s+)?(.+)$)
-    parse_content = true
-    urls = search_web($2, $1.to_i)
+  when %r(^/web\s+(?:(\d+)\s+)?(.+))
+    parse_content   = false
+    urls            = search_web($2, $1.to_i)
+    urls.each do |url|
+      fetch_source(url) do |url_io|
+        import_document(url_io, url)
+      end
+    end
+    urls_summarized = urls.map { summarize(_1) }
     content = <<~end
-      Answer the the query #{$2.inspect} using these sources:
+      Answer the the query #{$2.inspect} using these sources and summaries:
 
-      #{urls * ?\n}
+      #{urls.zip(urls_summarized).map { |u, s| "%s as \n:%s" % [ u, s ] } * "\n\n"}
     end
   when %r(^/save\s+(.+)$)
     save_conversation($1, messages)
@@ -652,7 +673,7 @@ loop do
     messages = load_conversation($1)
     puts "Loaded conversation from #$1."
     next
-  when %r(^/help$)
+  when %r(^/)
     display_chat_help
     next
   when nil, ''

data/lib/ollama/utils/width.rb

@@ -1,6 +1,8 @@
 require 'tins/terminal'
 
 module Ollama::Utils::Width
+  include Term::ANSIColor
+
   module_function
 
   def width(percentage: 100.0)
@@ -12,7 +14,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 length >= 1 && line.length > length
+      if length >= 1 && uncolor { 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.3.0'
+  VERSION         = '0.3.1'
   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,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 0.3.0 ruby lib
+# stub: ollama-ruby 0.3.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "0.3.0".freeze
+  s.version = "0.3.1".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-09-06"
+  s.date = "2024-09-12"
   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, "ollama_cli".freeze]
@@ -24,13 +24,13 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.17.0".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.17.1".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.4".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<utils>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<webmock>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<excon>.freeze, ["~> 0.111".freeze])
-  s.add_runtime_dependency(%q<infobar>.freeze, ["~> 0.7".freeze])
+  s.add_runtime_dependency(%q<infobar>.freeze, ["~> 0.8".freeze])
   s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.11".freeze])
   s.add_runtime_dependency(%q<kramdown-parser-gfm>.freeze, ["~> 1.1".freeze])
   s.add_runtime_dependency(%q<terminal-table>.freeze, ["~> 3.0".freeze])
@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<sorted_set>.freeze, ["~> 1.0".freeze])
   s.add_runtime_dependency(%q<mime-types>.freeze, ["~> 3.0".freeze])
   s.add_runtime_dependency(%q<reverse_markdown>.freeze, ["~> 2.0".freeze])
-  s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.20".freeze])
+  s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.22".freeze])
   s.add_runtime_dependency(%q<search_ui>.freeze, ["~> 0.0".freeze])
   s.add_runtime_dependency(%q<amatch>.freeze, ["~> 0.4.1".freeze])
   s.add_runtime_dependency(%q<pdf-reader>.freeze, ["~> 2.0".freeze])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-06 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.17.1
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -240,14 +240,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: search_ui
   requirement: !ruby/object:Gem::Requirement