ollama-ruby 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a6a94882e3f76e84fbceadd80ec844f9a93febd18ed294b01f7874867c53e68
-  data.tar.gz: 47cda3eef10438ff1cd136ffcc4469d2275bc2e26cdab985c7a001e2d0178b7f
+  metadata.gz: 3976b4254bbedc3655a6a737000903217eff8b4b941971eb6ae4fda630ba40c3
+  data.tar.gz: 29187dded0f2748e8e684648ab374d027aaff18a6f85ede48df78dc34b705645
 SHA512:
-  metadata.gz: 5c42f47be513e41465693c47dee68447ac42a967f7ecaaf88ea51df6ea30eb9beb61b25595fc145909a0c9b8838d22756f47e71bc6acdd33bb47e4876545ccdc
-  data.tar.gz: b4ac6bf59882a23774fbfb3503607c1a22d200037b31613a8f9d565ebf174b99d66259cc62d99f0635e7ac99fd07cc51aec735dd7dbb31259dc767e403eaa5d7
+  metadata.gz: 69ad552c73c297d23db6a65681008c79329de3d4a02a07f28b027a94820f9505488870e4bce6b43c1ae6a6fb64c6107ce4cc3d28b307f07573987464e6eaed84
+  data.tar.gz: 79dd0a71d48726900ed7df4508f2031191f00f15b3713cc562aa29112c4942e72836c5d487c8883b173dc760d8e815461b66e3c4b0fbdccd1226e6019af2419a

data/CHANGES.md

@@ -1,5 +1,39 @@
 # Changes
 
+## 2024-10-19 v0.9.1
+
+* Fixing string interpolation in `import_source` method:
+  + Changed result to use `#{}` instead of `%{}` for string interpolation
+* Move `pull_model_unless_present` method:
+  + Moved the method before other methods
+* Moved Switch classes and `setup_switches` method into Switches module:
+  + Moved the classes and method into a new module
+* Utils::Fetcher: Normalize URL in fetcher utility:
+  + Added `normalize_url` method to class Ollama::Utils::Fetcher
+  + Normalizes URL by decoding URI components, removing anchors, and escaping special characters
+  + `excon` method now calls `normalize_url` on the provided URL
+  + Added specs for `normalize_url` in `fetcher_spec.rb`
+* Remove Ollama top level Namespace b/c we include it from `ollama_chat`: 
+  + Removed the top-level namespace
+
+## 2024-10-18 v0.9.0
+
+* Add document policy chooser and modify embedding/importing/summarizing
+  behavior:
+  + Add `/document_policy` command to choose a scan policy for document
+    references
+  + Modify `embed_source`, `import_source`, and `summarize_source` methods to
+    use the chosen document policy
+  + Update `choose_model` method to set `$document_policy` based on
+    configuration or chat command
+* Fix regular expression in `ollama_chat` script:
+  + Updated regular expression for `/info` to `/^/info$`
+* Improve ask prompt to ask about clearing messages and collection.
+* Update specs to use `expect` instead of `allow`
+* Fix library homepage URL in README.md
+* Refactor Markdown handler to remove unnecessary puts statement
+* Reorder chapters in README.md a bit
+
 ## 2024-10-07 v0.8.0
 
 * **Refactor source handling in Ollama chat**:

data/README.md

@@ -26,161 +26,23 @@ gem 'ollama-ruby'
 
 to your Gemfile and run `bundle install` in your terminal.
 
-## Executables
-
-### 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:
-
-```
-Usage: ollama_chat [OPTIONS]
-
-  -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 embeddings collection (multiple)
-  -M             use (empty) MemoryCache for this chat session
-  -E             disable embeddings for this chat session
-  -V             display the current version number and quit
-  -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.
-Connecting to llama3.1@http://ollama.local.net:11434 now…
-Configured system prompt is:
-You are Sherlock Holmes and the user is your new client, Dr. Watson is also in
-the room. You will talk and act in the typical manner of Sherlock Holmes do and
-try to solve the user's case using logic and deduction.
-
-Type /help to display the chat help.
-📨 user:
-Good morning.
-📨 assistant:
-Ah, good morning, my dear fellow! It is a pleasure to make your acquaintance. I
-am Sherlock Holmes, the renowned detective, and this is my trusty sidekick, Dr.
-Watson. Please, have a seat and tell us about the nature of your visit. What
-seems to be the problem that has brought you to our humble abode at 221B Baker
-Street?
-
-(Watson nods in encouragement as he takes notes)
-
-Now, pray tell, what is it that puzzles you, my dear client? A missing item,
-perhaps? Or a mysterious occurrence that requires clarification? The game, as
-they say, is afoot!
-```
-
-This example shows how an image like this can be sent to a vision model for
-analysis:
-
-![cat](spec/assets/kitten.jpg)
-
-```
-$ 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> 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,
-is the central figure in this scene. Its eyes, a striking shade of blue, are
-wide open and directed towards the camera, giving an impression of curiosity or
-alertness.
-
-The cat is comfortably nestled on a red blanket, which contrasts vividly with
-its fur. The blanket, soft and inviting, provides a sense of warmth to the
-image. In the background, partially obscured by the cat's head, is another
-blanket of similar red hue. The repetition of the color adds a sense of harmony
-to the composition.
-
-The cat's position on the right side of the photo creates an interesting
-asymmetry with the camera lens, which occupies the left side of the frame. This
-visual balance enhances the overall composition of the image.
+## Usage
 
-There are no discernible texts or other objects in the image. The focus is
-solely on the cat and its immediate surroundings. The image does not provide
-any information about the location or setting beyond what has been described.
-The simplicity of the scene allows the viewer to concentrate on the main
-subject - the young, blue-eyed cat.
-```
+In your own software the library can be used as shown in this example:
 
-The following commands can be given inside the chat, if prefixed by a `/`:
+```ruby
+require "ollama"
+include Ollama
 
-```
-/copy                           to copy last response to clipboard
-/paste                          to paste content
-/markdown                       toggle markdown output
-/stream                         toggle stream output
-/location                       toggle location submission
-/voice( change)                 toggle voice output or change the voice
-/list [n]                       list the last n / all conversation exchanges
-/clear                          clear the whole conversation
-/clobber                        clear the conversation and collection
-/pop [n]                        pop the last n exchanges, defaults to 1
-/model                          change the model
-/system                         change system prompt (clears conversation)
-/regenerate                     the last answer message
-/collection( clear|change)      change (default) collection or clear
-/info                           show information for current session
-/import source                  import the source's content
-/summarize [n] source           summarize the source's content in n words
-/embedding                      toggle embedding paused or not
-/embed source                   embed the source's content
-/web [n] query                  query web search & return n or 1 results
-/save filename                  store conversation messages
-/load filename                  load conversation messages
-/quit                           to quit
-/help                           to view this help
+ollama = Client.new(base_url: 'http://localhost:11434')
+messages = Message.new(role: 'user', content: 'Why is the sky blue?')
+ollama.chat(model: 'llama3.1', stream: true, messages:, &Print) # or
+print ollama.chat(model: 'llama3.1', stream: true, messages:).lazy.map { |response|
+  response.message.content
+}
 ```
 
-### ollama\_console
+## Try out things in 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
@@ -197,21 +59,6 @@ Commands: chat,copy,create,delete,embeddings,generate,help,ps,pull,push,show,tag
 > In a small village nestled between two great palm trees 🌳, there lived a
 > brave adventurer named Alex 👦. […]
 
-## Usage
-
-In your own software the library can be used as shown in this example:
-
-```ruby
-require "ollama"
-include Ollama
-
-ollama = Client.new(base_url: 'http://localhost:11434')
-messages = Message.new(role: 'user', content: 'Why is the sky blue?')
-ollama.chat(model: 'llama3.1', stream: true, messages:, &Print) # or
-print ollama.chat(model: 'llama3.1', stream: true, messages:).lazy.map { |response|
-	response.message.content
-}
-```
 
 ## API
 
@@ -463,11 +310,166 @@ If `Ollama::Errors::TimeoutError` is raised, it might help to increase the
 
 For more generic errors an `Ollama::Errors::Error` is raised.
 
+## Other executables
+
+### 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:
+
+```
+Usage: ollama_chat [OPTIONS]
+
+  -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 embeddings collection (multiple)
+  -M             use (empty) MemoryCache for this chat session
+  -E             disable embeddings for this chat session
+  -V             display the current version number and quit
+  -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.
+Connecting to llama3.1@http://ollama.local.net:11434 now…
+Configured system prompt is:
+You are Sherlock Holmes and the user is your new client, Dr. Watson is also in
+the room. You will talk and act in the typical manner of Sherlock Holmes do and
+try to solve the user's case using logic and deduction.
+
+Type /help to display the chat help.
+📨 user:
+Good morning.
+📨 assistant:
+Ah, good morning, my dear fellow! It is a pleasure to make your acquaintance. I
+am Sherlock Holmes, the renowned detective, and this is my trusty sidekick, Dr.
+Watson. Please, have a seat and tell us about the nature of your visit. What
+seems to be the problem that has brought you to our humble abode at 221B Baker
+Street?
+
+(Watson nods in encouragement as he takes notes)
+
+Now, pray tell, what is it that puzzles you, my dear client? A missing item,
+perhaps? Or a mysterious occurrence that requires clarification? The game, as
+they say, is afoot!
+```
+
+This example shows how an image like this can be sent to a vision model for
+analysis:
+
+![cat](spec/assets/kitten.jpg)
+
+```
+$ 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> 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,
+is the central figure in this scene. Its eyes, a striking shade of blue, are
+wide open and directed towards the camera, giving an impression of curiosity or
+alertness.
+
+The cat is comfortably nestled on a red blanket, which contrasts vividly with
+its fur. The blanket, soft and inviting, provides a sense of warmth to the
+image. In the background, partially obscured by the cat's head, is another
+blanket of similar red hue. The repetition of the color adds a sense of harmony
+to the composition.
+
+The cat's position on the right side of the photo creates an interesting
+asymmetry with the camera lens, which occupies the left side of the frame. This
+visual balance enhances the overall composition of the image.
+
+There are no discernible texts or other objects in the image. The focus is
+solely on the cat and its immediate surroundings. The image does not provide
+any information about the location or setting beyond what has been described.
+The simplicity of the scene allows the viewer to concentrate on the main
+subject - the young, blue-eyed cat.
+```
+
+The following commands can be given inside the chat, if prefixed by a `/`:
+
+```
+/copy                           to copy last response to clipboard
+/paste                          to paste content
+/markdown                       toggle markdown output
+/stream                         toggle stream output
+/location                       toggle location submission
+/voice( change)                 toggle voice output or change the voice
+/list [n]                       list the last n / all conversation exchanges
+/clear                          clear the whole conversation
+/clobber                        clear the conversation and collection
+/pop [n]                        pop the last n exchanges, defaults to 1
+/model                          change the model
+/system                         change system prompt (clears conversation)
+/regenerate                     the last answer message
+/collection( clear|change)      change (default) collection or clear
+/info                           show information for current session
+/document_policy                pick a scan policy for document references
+/import source                  import the source's content
+/summarize [n] source           summarize the source's content in n words
+/embedding                      toggle embedding paused or not
+/embed source                   embed the source's content
+/web [n] query                  query web search & return n or 1 results
+/save filename                  store conversation messages
+/load filename                  load conversation messages
+/quit                           to quit
+/help                           to view this help
+```
+
 ## Download
 
 The homepage of this library is located at
 
-* https://github.com/flori/ollama
+* https://github.com/flori/ollama-ruby
 
 ## Author