ollama-ruby 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327051092cef37a7fd95d6a5c3a5a13aa6e52df2314da5f4cfd28f2890ffa820
-  data.tar.gz: 86da0d23497f9717239abaa1830ac687562c8e9827a097781f0404e6b65e1e35
+  metadata.gz: 1f80ae8ee6e8acbbedfff8b56923b25b583fc60b96c733985e32908874d542bb
+  data.tar.gz: 80834beb676929f08f4216e373e56cadd12d16c0b50e95b1a599bdd48bf29c86
 SHA512:
-  metadata.gz: f3a9324f11877b0772d1f4bcb1902ea905e7132d94d73fe8b6b7e11a567c2aea04431838fa2b534557e4e1e76ae1ee47b13832aebb71e144ac329b13d15ea111
-  data.tar.gz: d40adf27de7e7700158027f1c6bfec7e97189b4a6081a7da36758edc31b5229b6efef62ee5a192af19afa5b633224cf8e80666d38154a9d3c1cae974a98f2de5
+  metadata.gz: 94823ec618f940056bcee6ac7d706c633087404efcb49122cdccc89a4596b4a5f14a0d1c1d60fd7bb13a28e10f3ba4dc2027cd96cfe384169b25acaf75f532b7
+  data.tar.gz: ef8d4a7001c5502bc787f074f10dfaf16692b8fa90c4a6e32ae3c0c75b94da45b4691094229106cec72438837eef57b933cd5e5c9b28e63d0d4a598c152a9c32

data/.envrc

@@ -0,0 +1 @@
+export REDIS_URL=redis://localhost:9736

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

@@ -28,7 +28,7 @@ to your Gemfile and run `bundle install` in your terminal.
 
 ## Executables
 
-### ollama_chat
+### ollama\_chat
 
 This a chat client, that can be used to connect to an ollama server and enter a
 chat converstation with a LLM. It can be called with the following arguments:
@@ -36,20 +36,58 @@ chat converstation with a LLM. It can be called with the following arguments:
 ```
 ollama_chat [OPTIONS]
 
-  -u URL     the ollama base url, OLLAMA_URL
-  -m MODEL   the ollama model to chat with, OLLAMA_MODEL
-  -M OPTIONS the model options as JSON file, see Ollama::Options
-  -s SYSTEM  the system prompt to use as a file
-  -c CHAT    a saved chat conversation to load
-  -v VOICE   use VOICE (e. g. Samantha) to speak with say command
-  -d         use markdown to display the chat messages
-  -h         this help
+  -f CONFIG      config file to read
+  -u URL         the ollama base url, OLLAMA_URL
+  -m MODEL       the ollama model to chat with, OLLAMA_CHAT_MODEL
+  -s SYSTEM      the system prompt to use as a file, OLLAMA_CHAT_SYSTEM
+  -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)
+  -v             use voice output
+  -h             this help
 ```
 
 The base URL can be either set by the environment variable `OLLAMA_URL` or it
 is derived from the environment variable `OLLAMA_HOST`. The default model to
 connect can be configured in the environment variable `OLLAMA_MODEL`.
 
+The YAML config file in `$XDG_CONFIG_HOME/ollama_chat/config.yml`, that you can
+use for more complex settings, it looks like this:
+
+```
+---
+url: <%= ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST') %>
+model:
+  name: <%= ENV.fetch('OLLAMA_CHAT_MODEL', 'llama3.1') %>
+  options:
+    num_ctx: 8192
+system: <%= ENV.fetch('OLLAMA_CHAT_SYSTEM', 'null') %>
+voice: Samantha
+markdown: true
+embedding:
+  enabled: true
+  model:
+    name: mxbai-embed-large
+    options: {}
+  collection: <%= ENV.fetch('OLLAMA_CHAT_COLLECTION', 'ollama_chat') %>
+  found_texts_size: 4096
+  splitter:
+    name: RecursiveCharacter
+    chunk_size: 1024
+cache: Ollama::Documents::RedisCache
+redis:
+  url: <%= ENV.fetch('REDIS_URL', 'null') %>
+debug: <%= ENV['OLLAMA_CHAT_DEBUG'].to_i == 1 ? true : false %>
+```
+
+If you want to store embeddings persistently, set an environment variable
+`REDIS_URL` or update the `redis.url` setting in your `config.yml` file to
+connect to a Redis server. Without this setup, embeddings will only be stored
+in process memory, which is less durable.
+
+Some settings can be passed as arguments as well, e. g. if you want to choose a
+specific system prompt:
+
 ```
 $ ollama_chat -s sherlock.txt
 Model with architecture llama found.
@@ -86,9 +124,7 @@ $ ollama_chat -m llava-llama3
 Model with architecture llama found.
 Connecting to llava-llama3@http://localhost:11434 now…
 Type /help to display the chat help.
-📨 user> /image spec/assets/kitten.jpg
-Attached image spec/assets/kitten.jpg to the next message.
-📸 user> What's on this image?
+📸 user> What's on this image? ./spec/assets/kitten.jpg
 📨 assistant:
 The image captures a moment of tranquility featuring a young cat. The cat,
 adorned with gray and white fur marked by black stripes on its face and legs,
@@ -116,19 +152,22 @@ subject - the young, blue-eyed cat.
 The following commands can be given inside the chat, if prefixed by a `/`:
 
 ```
-/paste          to paste content
-/list           list the messages of the conversation
-/clear          clear the conversation messages
-/pop n          pop the last n message, defaults to 1
-/regenerate     the last answer message
-/save filename  store conversation messages
-/load filename  load conversation messages
-/image filename attach image to the next message
-/quit           to quit.
-/help           to view this help.
+/paste                             to paste content
+/markdown                          toggle markdown output
+/list                              list the messages of the conversation
+/clear                             clear the conversation messages
+/pop [n]                           pop the last n exchanges, defaults to 1
+/model                             change the model
+/regenerate                        the last answer message
+/collection clear|stats|change|new clear or show stats of current collection
+/summarize source                  summarize the URL/file source's content
+/save filename                     store conversation messages
+/load filename                     load conversation messages
+/quit                              to quit
+/help                              to view this help
 ```
 
-### ollama_console
+### ollama\_console
 
 This is an interactive console, that can be used to try the different commands
 provided by an `Ollama::Client` instance. For example this command generate a

data/Rakefile

@@ -13,12 +13,12 @@ GemHadar do
   description 'Library that allows interacting with the Ollama API'
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle',
-    '.yardoc', 'tags', 'errors.lst', 'cscope.out', 'coverage', 'tmp'
+    '.yardoc', 'tags', 'errors.lst', 'cscope.out', 'coverage', 'tmp', 'corpus'
   package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
      '.utilsrc', '.rspec', *Dir.glob('.github/**/*', File::FNM_DOTMATCH)
   readme      'README.md'
 
-  executables << 'ollama_console' << 'ollama_chat'
+  executables << 'ollama_console' << 'ollama_chat' << 'ollama_update'
 
   required_ruby_version  '~> 3.1'
 
@@ -27,9 +27,21 @@ GemHadar do
   dependency             'term-ansicolor',        '~> 1.11'
   dependency             'kramdown-parser-gfm',   '~> 1.1'
   dependency             'terminal-table',        '~> 3.0'
-  development_dependency 'all_images',            '~>0.4'
-  development_dependency 'rspec',                 '~>3.2'
+  dependency             'redis',                 '~> 5.0'
+  dependency             'numo-narray',           '~> 0.9'
+  dependency             'more_math',             '~> 1.1'
+  dependency             'sorted_set',            '~> 1.0'
+  dependency             'mime-types',            '~> 3.0'
+  dependency             'reverse_markdown',      '~> 2.0'
+  dependency             'complex_config',        '~> 0.20'
+  dependency             'search_ui',             '~> 0.0'
+  dependency             'amatch',                '~> 0.4.1'
+  development_dependency 'all_images',            '~> 0.4'
+  development_dependency 'rspec',                 '~> 3.2'
   development_dependency 'utils'
+  development_dependency 'webmock'
 
   licenses << 'MIT'
+
+  clobber 'coverage'
 end