ollama_chat 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c75809ec83f12f9b70645f426774dec435a2510db811fa861e9c862a1e5c71
-  data.tar.gz: bca4f2fcf8e5e77ccc922858e4fe25db8933e5b09a9b264b94648a39feabc0c2
+  metadata.gz: 5e53e7c97f1d4cb21ae23b70b3dc14f3dfcb183978f3e3f5ebf44fa392d60c7d
+  data.tar.gz: 5b249fdd1c0a3acfc132fd4388608f12a64f4528ca280cb7feb427bc3ebd7c2e
 SHA512:
-  metadata.gz: a8e9c93775bfd1629a743436a7fd85b7b7801d7a69221a423b5abbe0a44d98afccc7f9c8eb5182fdfacd848b0d1b27140fb599c3794f77bd4fa2cec7a012a9fb
-  data.tar.gz: 4f0460bb249fcd988a3425bdedc377ceaf5052f90c12563ef5fa01b72100857e30484622ed840b11147aed9cdc9e8a9c5cf4f9979c96fa317c8c27780d9fa990
+  metadata.gz: aaaf8a6011430a7bba371ef08059d3abd6493e7c43e766068942aefed893ed2378b9e5193a9a43233579c49e35db88520f62083c936ca4bd8528d0cb84d81b84
+  data.tar.gz: 6bb078ad3be012d0936a72303df5a44186fc0c7a95fc335124a6b37eb5affbb4e64bb26ccf8127268c6410ef4eff15e53405652934f388a581d0bfea82c0c1d3

data/CHANGES.md

@@ -1,5 +1,19 @@
 # Changes
 
+## 2025-02-11 v0.0.2
+
+* Improved handling of location in MessageList class:
+  * Use assistant system prompt (`assistant_system_prompt`) for adding location
+    to message list, if no system prompt was defined.
+  * Updated spec to cover new behavior.
+* Simplified configuration defaults to be stored in `default_config.yml`:
+  - Replaced `DEFAULT_CONFIG` hash with a single line of code that reads from
+    `default_config.yml`
+  - Created new file `default_config.yml` in the same directory, containing the
+    old `DEFAULT_CONFIG` hash values
+  - Updated `initialize` method to use the new `default_config.yml` file if no
+    filename is provided
+
 ## 2025-02-02 v0.0.1
 
 * Renamed `documents` variable to `@documents` in `OllamaChat::Chat`

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/ollama_chat/message_list.rb

@@ -182,14 +182,23 @@ class OllamaChat::MessageList
   # messages in the list.
   def to_ary
     location = at_location.full?
-    @messages.map do |message|
+    add_system = !!location
+    result = @messages.map do |message|
       if message.role == 'system' && location
+        add_system = false
         content = message.content + "\n\n#{location}"
         Ollama::Message.new(role: message.role, content:)
       else
         message
       end
     end
+    if add_system
+      prompt = @chat.config.system_prompts.assistant?
+      content = [ prompt, location ].compact * "\n\n"
+      message = Ollama::Message.new(role: 'system', content:)
+      result.unshift message
+    end
+    result
   end
 
   # The at_location method returns the location/time/units information as a

data/lib/ollama_chat/ollama_chat_config/default_config.yml

@@ -0,0 +1,60 @@
+---
+url: <%= ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST') %>
+proxy: null # http://localhost:8080
+model:
+  name: <%= ENV.fetch('OLLAMA_CHAT_MODEL', 'llama3.1') %>
+  options:
+    num_ctx: 8192
+location:
+  enabled: false
+  name: Berlin
+  decimal_degrees: [ 52.514127, 13.475211 ]
+  units: SI (International System of Units) # or USCS (United States Customary System)
+prompts:
+  embed: "This source was now embedded: %{source}"
+  summarize: |
+    Generate an abstract summary of the content in this document using
+    %{words} words:
+
+    %{source_content}
+  web: |
+    Answer the the query %{query} using these sources and summaries:
+
+    %{results}
+  location: You are at %{location_name} (%{location_decimal_degrees}), on %{localtime}, preferring %{units}
+system_prompts:
+  default: <%= ENV.fetch('OLLAMA_CHAT_SYSTEM', 'null') %>
+  assistant: You are a helpful assistant.
+voice:
+  enabled: false
+  default: Samantha
+  list: <%= `say -v ? 2>/dev/null`.lines.map { _1[/^(.+?)\s+[a-z]{2}_[a-zA-Z0-9]{2,}/, 1] }.uniq.sort.to_s.force_encoding('ASCII-8BIT') %>
+markdown: true
+stream: true
+document_policy: importing
+embedding:
+  enabled: true
+  model:
+    name: mxbai-embed-large
+    embedding_length: 1024
+    options: {}
+    # Retrieval prompt template:
+    prompt: 'Represent this sentence for searching relevant passages: %s'
+  batch_size: 10
+  database_filename: null # ':memory:'
+  collection: <%= ENV['OLLAMA_CHAT_COLLECTION'] %>
+  found_texts_size: 4096
+  found_texts_count: 10
+  splitter:
+    name: RecursiveCharacter
+    chunk_size: 1024
+cache: Documentrix::Documents::SQLiteCache
+redis:
+  documents:
+    url: <%= ENV.fetch('REDIS_URL', 'null') %>
+  expiring:
+    url: <%= ENV.fetch('REDIS_EXPIRING_URL', 'null') %>
+    ex: 86400
+debug: <%= ENV['OLLAMA_CHAT_DEBUG'].to_i == 1 ? true : false %>
+ssl_no_verify: []
+copy: pbcopy

data/lib/ollama_chat/ollama_chat_config.rb

@@ -1,67 +1,12 @@
+require 'pathname'
+
 class OllamaChat::OllamaChatConfig
   include ComplexConfig
   include FileUtils
 
-  DEFAULT_CONFIG = <<~EOT
-      ---
-      url: <%= ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST') %>
-      proxy: null # http://localhost:8080
-      model:
-        name: <%= ENV.fetch('OLLAMA_CHAT_MODEL', 'llama3.1') %>
-        options:
-          num_ctx: 8192
-      location:
-        enabled: false
-        name: Berlin
-        decimal_degrees: [ 52.514127, 13.475211 ]
-        units: SI (International System of Units) # or USCS (United States Customary System)
-      prompts:
-        embed: "This source was now embedded: %{source}"
-        summarize: |
-          Generate an abstract summary of the content in this document using
-          %{words} words:
-
-          %{source_content}
-        web: |
-          Answer the the query %{query} using these sources and summaries:
-
-          %{results}
-      system_prompts:
-        default: <%= ENV.fetch('OLLAMA_CHAT_SYSTEM', 'null') %>
-      voice:
-        enabled: false
-        default: Samantha
-        list: <%= `say -v ? 2>/dev/null`.lines.map { _1[/^(.+?)\s+[a-z]{2}_[a-zA-Z0-9]{2,}/, 1] }.uniq.sort.to_s.force_encoding('ASCII-8BIT') %>
-      markdown: true
-      stream: true
-      document_policy: importing
-      embedding:
-        enabled: true
-        model:
-          name: mxbai-embed-large
-          embedding_length: 1024
-          options: {}
-          # Retrieval prompt template:
-          prompt: 'Represent this sentence for searching relevant passages: %s'
-        batch_size: 10
-        database_filename: null # ':memory:'
-        collection: <%= ENV['OLLAMA_CHAT_COLLECTION'] %>
-        found_texts_size: 4096
-        found_texts_count: 10
-        splitter:
-          name: RecursiveCharacter
-          chunk_size: 1024
-      cache: Documentrix::Documents::SQLiteCache
-      redis:
-        documents:
-          url: <%= ENV.fetch('REDIS_URL', 'null') %>
-        expiring:
-          url: <%= ENV.fetch('REDIS_EXPIRING_URL', 'null') %>
-          ex: 86400
-      debug: <%= ENV['OLLAMA_CHAT_DEBUG'].to_i == 1 ? true : false %>
-      ssl_no_verify: []
-      copy: pbcopy
-  EOT
+  DEFAULT_CONFIG = File.read(
+    Pathname.new(__FILE__).dirname.join('ollama_chat_config/default_config.yml')
+  )
 
   def initialize(filename = nil)
     @filename = filename || default_path

data/lib/ollama_chat/version.rb

@@ -1,6 +1,6 @@
 module OllamaChat
   # OllamaChat version
-  VERSION         = '0.0.1'
+  VERSION         = '0.0.2'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/ollama_chat.gemspec

@@ -1,19 +1,19 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama_chat 0.0.1 ruby lib
+# stub: ollama_chat 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama_chat".freeze
-  s.version = "0.0.1".freeze
+  s.version = "0.0.2".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 = "2025-02-02"
+  s.date = "2025-02-12"
   s.description = "The app provides a command-line interface (CLI) to an Ollama AI model,\nallowing users to engage in text-based conversations and generate\nhuman-like responses. Users can import data from local files or web pages,\nwhich are then processed through three different modes: fully importing the\ncontent into the conversation context, summarizing the information for\nconcise reference, or storing it in an embedding vector database for later\nretrieval based on the conversation.\n".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["ollama_chat".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/ollama_chat.rb".freeze, "lib/ollama_chat/chat.rb".freeze, "lib/ollama_chat/clipboard.rb".freeze, "lib/ollama_chat/dialog.rb".freeze, "lib/ollama_chat/document_cache.rb".freeze, "lib/ollama_chat/follow_chat.rb".freeze, "lib/ollama_chat/information.rb".freeze, "lib/ollama_chat/message_list.rb".freeze, "lib/ollama_chat/message_type.rb".freeze, "lib/ollama_chat/model_handling.rb".freeze, "lib/ollama_chat/ollama_chat_config.rb".freeze, "lib/ollama_chat/parsing.rb".freeze, "lib/ollama_chat/source_fetching.rb".freeze, "lib/ollama_chat/switches.rb".freeze, "lib/ollama_chat/utils.rb".freeze, "lib/ollama_chat/utils/cache_fetcher.rb".freeze, "lib/ollama_chat/utils/chooser.rb".freeze, "lib/ollama_chat/utils/fetcher.rb".freeze, "lib/ollama_chat/utils/file_argument.rb".freeze, "lib/ollama_chat/version.rb".freeze]
-  s.files = [".all_images.yml".freeze, ".envrc".freeze, ".gitignore".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/ollama_chat".freeze, "docker-compose.yml".freeze, "lib/ollama_chat.rb".freeze, "lib/ollama_chat/chat.rb".freeze, "lib/ollama_chat/clipboard.rb".freeze, "lib/ollama_chat/dialog.rb".freeze, "lib/ollama_chat/document_cache.rb".freeze, "lib/ollama_chat/follow_chat.rb".freeze, "lib/ollama_chat/information.rb".freeze, "lib/ollama_chat/message_list.rb".freeze, "lib/ollama_chat/message_type.rb".freeze, "lib/ollama_chat/model_handling.rb".freeze, "lib/ollama_chat/ollama_chat_config.rb".freeze, "lib/ollama_chat/parsing.rb".freeze, "lib/ollama_chat/source_fetching.rb".freeze, "lib/ollama_chat/switches.rb".freeze, "lib/ollama_chat/utils.rb".freeze, "lib/ollama_chat/utils/cache_fetcher.rb".freeze, "lib/ollama_chat/utils/chooser.rb".freeze, "lib/ollama_chat/utils/fetcher.rb".freeze, "lib/ollama_chat/utils/file_argument.rb".freeze, "lib/ollama_chat/version.rb".freeze, "ollama_chat.gemspec".freeze, "redis/redis.conf".freeze, "spec/assets/api_show.json".freeze, "spec/assets/api_tags.json".freeze, "spec/assets/conversation.json".freeze, "spec/assets/duckduckgo.html".freeze, "spec/assets/example.atom".freeze, "spec/assets/example.csv".freeze, "spec/assets/example.html".freeze, "spec/assets/example.pdf".freeze, "spec/assets/example.ps".freeze, "spec/assets/example.rb".freeze, "spec/assets/example.rss".freeze, "spec/assets/example.xml".freeze, "spec/assets/kitten.jpg".freeze, "spec/assets/prompt.txt".freeze, "spec/ollama_chat/chat_spec.rb".freeze, "spec/ollama_chat/clipboard_spec.rb".freeze, "spec/ollama_chat/follow_chat_spec.rb".freeze, "spec/ollama_chat/information_spec.rb".freeze, "spec/ollama_chat/message_list_spec.rb".freeze, "spec/ollama_chat/model_handling_spec.rb".freeze, "spec/ollama_chat/parsing_spec.rb".freeze, "spec/ollama_chat/source_fetching_spec.rb".freeze, "spec/ollama_chat/switches_spec.rb".freeze, "spec/ollama_chat/utils/cache_fetcher_spec.rb".freeze, "spec/ollama_chat/utils/fetcher_spec.rb".freeze, "spec/ollama_chat/utils/file_argument_spec.rb".freeze, "spec/spec_helper.rb".freeze, "tmp/.keep".freeze]
+  s.files = [".all_images.yml".freeze, ".envrc".freeze, ".gitignore".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/ollama_chat".freeze, "docker-compose.yml".freeze, "lib/ollama_chat.rb".freeze, "lib/ollama_chat/chat.rb".freeze, "lib/ollama_chat/clipboard.rb".freeze, "lib/ollama_chat/dialog.rb".freeze, "lib/ollama_chat/document_cache.rb".freeze, "lib/ollama_chat/follow_chat.rb".freeze, "lib/ollama_chat/information.rb".freeze, "lib/ollama_chat/message_list.rb".freeze, "lib/ollama_chat/message_type.rb".freeze, "lib/ollama_chat/model_handling.rb".freeze, "lib/ollama_chat/ollama_chat_config.rb".freeze, "lib/ollama_chat/ollama_chat_config/default_config.yml".freeze, "lib/ollama_chat/parsing.rb".freeze, "lib/ollama_chat/source_fetching.rb".freeze, "lib/ollama_chat/switches.rb".freeze, "lib/ollama_chat/utils.rb".freeze, "lib/ollama_chat/utils/cache_fetcher.rb".freeze, "lib/ollama_chat/utils/chooser.rb".freeze, "lib/ollama_chat/utils/fetcher.rb".freeze, "lib/ollama_chat/utils/file_argument.rb".freeze, "lib/ollama_chat/version.rb".freeze, "ollama_chat.gemspec".freeze, "redis/redis.conf".freeze, "spec/assets/api_show.json".freeze, "spec/assets/api_tags.json".freeze, "spec/assets/conversation.json".freeze, "spec/assets/duckduckgo.html".freeze, "spec/assets/example.atom".freeze, "spec/assets/example.csv".freeze, "spec/assets/example.html".freeze, "spec/assets/example.pdf".freeze, "spec/assets/example.ps".freeze, "spec/assets/example.rb".freeze, "spec/assets/example.rss".freeze, "spec/assets/example.xml".freeze, "spec/assets/kitten.jpg".freeze, "spec/assets/prompt.txt".freeze, "spec/ollama_chat/chat_spec.rb".freeze, "spec/ollama_chat/clipboard_spec.rb".freeze, "spec/ollama_chat/follow_chat_spec.rb".freeze, "spec/ollama_chat/information_spec.rb".freeze, "spec/ollama_chat/message_list_spec.rb".freeze, "spec/ollama_chat/model_handling_spec.rb".freeze, "spec/ollama_chat/parsing_spec.rb".freeze, "spec/ollama_chat/source_fetching_spec.rb".freeze, "spec/ollama_chat/switches_spec.rb".freeze, "spec/ollama_chat/utils/cache_fetcher_spec.rb".freeze, "spec/ollama_chat/utils/fetcher_spec.rb".freeze, "spec/ollama_chat/utils/file_argument_spec.rb".freeze, "spec/spec_helper.rb".freeze, "tmp/.keep".freeze]
   s.homepage = "https://github.com/flori/ollama_chat".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "OllamaChat - A command-line interface (CLI) for interacting with an Ollama AI model.".freeze, "--main".freeze, "README.md".freeze]

data/spec/ollama_chat/message_list_spec.rb

@@ -11,6 +11,9 @@ RSpec.describe OllamaChat::MessageList do
       ),
       prompts: double(
         location: 'You are at %{location_name} (%{location_decimal_degrees}), on %{localtime}, preferring %{units}'
+      ),
+      system_prompts: double(
+        assistant?: 'You are a helpful assistant.'
       )
     )
   end
@@ -122,6 +125,19 @@ RSpec.describe OllamaChat::MessageList do
       %r(You are at Berlin \(52.514127, 13.475211\), on))
   end
 
+  it 'can be converted int an Ollama::Message array with location without a system prompt' do
+    expect(chat).to receive(:location).and_return(double(on?: true))
+    list = described_class.new(chat).tap do |list|
+      list <<  Ollama::Message.new(role: 'user', content: 'hello')
+      list << Ollama::Message.new(role: 'assistant', content: 'world')
+    end
+    first = list.to_ary.first
+    expect(first.role).to eq 'system'
+    expect(first.content).to match(
+      %r(You are a helpful assistant.\n\nYou are at Berlin \(52.514127, 13.475211\), on))
+  end
+
+
   it 'can display messages with images' do
     expect(list.message_type([])).to eq ?📨
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ollama_chat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Florian Frank
 bindir: bin
 cert_chain: []
-date: 2025-02-02 00:00:00.000000000 Z
+date: 2025-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -399,6 +399,7 @@ files:
 - lib/ollama_chat/message_type.rb
 - lib/ollama_chat/model_handling.rb
 - lib/ollama_chat/ollama_chat_config.rb
+- lib/ollama_chat/ollama_chat_config/default_config.yml
 - lib/ollama_chat/parsing.rb
 - lib/ollama_chat/source_fetching.rb
 - lib/ollama_chat/switches.rb