ollama_chat 0.0.19 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56f1fbbeb7e84fe906636ac0e16d5223f4968a063ee73c862398bdd575b8409b
-  data.tar.gz: f9ffc5725d73ad54efbd55239c55a615f0cd630c682d293c11fa461b72be17d9
+  metadata.gz: 91a8452d2970be06a595b83e8dfdc4ee8be0388b37171967ef884139ad97b492
+  data.tar.gz: 116ca9055525145d36a65abc5d38341a603fbc62ccf4d52257876ddaa3a3f0d9
 SHA512:
-  metadata.gz: b331c3ca96198b45e8cf6531a1e7e0f7542607a13512d516767180ae7a21c4cc6ba3eda280a24ee0472a9bf24a45a2acaba586f635dc8e1fe3f6e459b567f574
-  data.tar.gz: 0f2da5cc8c319d414d812af7067701567f463c8b9db6507f1cdb34eec880bb05204ddd1111a448bad289e8299858a59534315da2091287b5b033e0a85d28c7f1
+  metadata.gz: 710139d1db7d25ed49218eaf6c22f61cea64352bbd2d8d1c418ccaba67f190c6157b14d8c5ec41da18e83669177310143b0e3683d5df7b2d7e9c68e3edf72df7
+  data.tar.gz: ef6f2705cfacb4c4523ead9e3361ce980aef227e06b6bc3a7a639d6e492d82cbd03f6c1ca4b82383b29cb95d740d9b815fff3d5c57336baf5f885e1e43e81277

data/CHANGES.md

@@ -1,5 +1,17 @@
 # Changes
 
+## 2025-08-11 v0.0.20
+
+### Documentation
+
+- Added more YARD-style documentation to all public methods throughout the codebase.
+
+### Fixed
+
+- **Message Output**:
+  - Corrected `output(filename)` method to pass the message object to
+    `write_file_unless_exist` for proper content writing.
+
 ## 2025-08-11 v0.0.19
 
 * Added `/last` command to show last assistant message:

data/VERSION

@@ -1 +1 @@
-0.0.19
+0.0.21

data/lib/ollama_chat/chat.rb

@@ -34,6 +34,33 @@ class OllamaChat::Chat
   include OllamaChat::History
   include OllamaChat::ServerSocket
 
+  # Initializes a new OllamaChat::Chat instance with the given command-line
+  # arguments.
+  #
+  # Sets up the chat environment including configuration parsing, Ollama client
+  # initialization, model selection, system prompt handling, document
+  # processing setup, and history management. This method handles all the
+  # bootstrapping necessary to create a functional chat session that can
+  # communicate with an Ollama server and process various input types including
+  # text, documents, web content, and images.
+  #
+  # The initialization process includes parsing command-line options using
+  # Tins::GO for robust argument handling, setting up the Ollama client with
+  # configurable timeouts (connect, read, write), validating Ollama API version
+  # compatibility (requires >= 0.9.0 for features used), configuring model
+  # selection based on command-line or configuration defaults, initializing
+  # system prompts from files or inline content, setting up document processing
+  # pipeline with embedding capabilities through Documentrix::Documents,
+  # creating message history management through OllamaChat::MessageList,
+  # initializing cache systems for document embeddings, setting up
+  # voice support and image handling for multimodal interactions, enabling
+  # optional server socket functionality for remote input, and handling
+  # configuration errors with interactive recovery mechanisms.
+  #
+  # @param argv [Array<String>] Command-line arguments to parse (defaults to ARGV.dup)
+  #
+  # @raise [ArgumentError] If the Ollama API version is less than 0.9.0, indicating
+  #   incompatibility with required API features
   def initialize(argv: ARGV.dup)
     @opts               = go 'f:u:m:s:c:C:D:MESVh', argv
     @opts[?h] and exit usage
@@ -80,28 +107,66 @@ class OllamaChat::Chat
     fix_config(e)
   end
 
+  # The ollama reader returns the Ollama API client instance.
+  #
+  # @return [Ollama::Client] the configured Ollama API client
   attr_reader :ollama
 
+
+  # Returns the documents set for this object, initializing it lazily if needed.
+  #
+  # The documents set is memoized, meaning it will only be created once per
+  # object instance and subsequent calls will return the same
+  # Documentrix::Documents instance.
+  #
+  # @return [Documentrix::Documents] A Documentrix::Documents object containing
+  # all documents associated with this instance
   attr_reader :documents
 
+  # Returns the messages set for this object, initializing it lazily if needed.
+  #
+  # The messages set is memoized, meaning it will only be created once per
+  # object instance and subsequent calls will return the same
+  # OllamaChat::MessageList instance.
+  #
+  # @return [OllamaChat::MessageList] A MessageList object containing all
+  # messages associated with this instance
   attr_reader :messages
 
+  # Returns the links set for this object, initializing it lazily if needed.
+  #
+  # The links set is memoized, meaning it will only be created once per object
+  # instance and subsequent calls will return the same Set instance.
+  #
+  # @return [Set] A Set object containing all links associated with this instance
   def links
     @links ||= Set.new
   end
 
   class << self
+    # The config attribute accessor provides read and write access to the
+    # configuration object associated with this instance.
     attr_accessor :config
   end
 
+  # The config= method assigns a new configuration object to the class.
+  #
+  # @param config [ ComplexConfig::Settings ] the configuration object to be set
   def config=(config)
     self.class.config = config
   end
 
+  # The config method returns the configuration object associated with the
+  # class.
+  #
+  # @return [ ComplexConfig::Settings ] the configuration instance
   def config
     self.class.config
   end
 
+  # The start method initializes the chat session by displaying information and
+  # conversation history, then prompts the user for input to begin interacting
+  # with the chat.
   def start
     info
     if messages.size > 1
@@ -235,7 +300,7 @@ class OllamaChat::Chat
       if messages.save_conversation(filename)
         STDOUT.puts "Saved conversation to #{filename.inspect}."
       else
-        STDOUT.puts "Saving conversation to #{filename.inspect} failed."
+        STDERR.puts "Saving conversation to #{filename.inspect} failed."
       end
       :next
     when %r(^/links(?:\s+(clear))?$)
@@ -250,7 +315,7 @@ class OllamaChat::Chat
       if success
         STDOUT.puts "Loaded conversation from #{filename.inspect}."
       else
-        STDOUT.puts "Loading conversation from #{filename.inspect} failed."
+        STDERR.puts "Loading conversation from #{filename.inspect} failed."
       end
       :next
     when %r(^/pipe\s+(.+)$)
@@ -259,6 +324,13 @@ class OllamaChat::Chat
     when %r(^/output\s+(.+)$)
       output($1)
       :next
+    when %r(^/vim(?:\s+(.+))?$)
+      if message = messages.last
+        OllamaChat::Vim.new($1).insert message.content
+      else
+        STDERR.puts "Warning: No message found to insert into Vim"
+      end
+      :next
     when %r(^/config$)
       display_config
       :next
@@ -274,6 +346,14 @@ class OllamaChat::Chat
     end
   end
 
+  # The web method searches for URLs based on a query and processes them by
+  # fetching, embedding, and summarizing their content, then formats the
+  # results into a prompt string.
+  #
+  # @param count [ String ] the number of URLs to search for
+  # @param query [ String ] the search query string
+  #
+  # @return [ String ] the formatted prompt string containing the query and summarized results
   def web(count, query)
     urls            = search_web(query, count.to_i) or return :next
     urls.each do |url|
@@ -285,6 +365,16 @@ class OllamaChat::Chat
     config.prompts.web % { query:, results: }
   end
 
+  # The manage_links method handles operations on a collection of links, such
+  # as displaying them or clearing specific entries.
+  #
+  # It supports two main commands: 'clear' and nil (default).
+  # When the command is 'clear', it presents an interactive menu to either
+  # clear all links or individual links.
+  # When the command is nil, it displays the current list of links with
+  # hyperlinks.
+  #
+  # @param command [ String, nil ] the operation to perform on the links
   def manage_links(command)
     case command
     when 'clear'
@@ -322,10 +412,14 @@ class OllamaChat::Chat
     end
   end
 
+  # The clean method clears various parts of the chat session based on the
+  # specified parameter.
+  #
+  # @param what [ String, nil ] the type of data to clear, defaults to
+  # 'messages' if nil
   def clean(what)
-    what = 'messages' if what.nil?
     case what
-    when 'messages'
+    when 'messages', nil
       messages.clear
       STDOUT.puts "Cleared messages."
     when 'links'
@@ -350,6 +444,11 @@ class OllamaChat::Chat
     end
   end
 
+  # The display_config method renders the configuration and displays it using a
+  # pager.
+  # It determines an appropriate pager command based on environment variables
+  # and available system commands, then uses Kramdown::ANSI::Pager to show the
+  # formatted configuration output.
   def display_config
     default_pager = ENV['PAGER'].full?
     if fallback_pager = `which less`.chomp.full? || `which more`.chomp.full?
@@ -365,6 +464,18 @@ class OllamaChat::Chat
     end
   end
 
+  # The interact_with_user method manages the interactive loop for user input
+  # and chat processing.
+  # It handles reading user input, processing commands, managing messages, and
+  # communicating with the Ollama server.
+  # The method supports command completion, prefilling prompts, socket input
+  # handling, and various chat features including embedding context and voice
+  # support.
+  # It processes user input through command handling, content parsing, and
+  # message formatting before sending requests to the Ollama server.
+  # The method also handles server socket messages, manages chat history, and
+  # ensures proper cleanup and configuration handling throughout the
+  # interaction.
   def interact_with_user
     loop do
       @parse_content = true
@@ -479,6 +590,13 @@ class OllamaChat::Chat
 
   private
 
+  # The setup_documents method initializes the document processing pipeline by
+  # configuring the embedding model and database connection.
+  # It then loads specified documents into the system and returns the
+  # configured document collection.
+  #
+  # @return [ Documentrix::Documents, NULL ] the initialized document
+  # collection if embedding is enabled, otherwise NULL
   def setup_documents
     if embedding.on?
       @embedding_model         = config.embedding.model.name
@@ -501,10 +619,35 @@ class OllamaChat::Chat
       add_documents_from_argv(document_list)
       @documents
     else
-      Tins::NULL
+      NULL
     end
   end
 
+  # Adds documents from command line arguments to the document collection
+  #
+  # Processes a list of document paths or URLs, handling both local files and
+  # remote resources.
+  #
+  # @param document_list [Array<String>] List of document paths or URLs to process
+  #
+  # @return [void]
+  #
+  # @example Adding local files
+  #   add_documents_from_argv(['/path/to/file1.txt', '/path/to/file2.pdf'])
+  #
+  # @example Adding remote URLs
+  #   add_documents_from_argv(['https://example.com/page1', 'http://example.com/page2'])
+  #
+  # @example Mixed local and remote
+  #   add_documents_from_argv(['/local/file.txt', 'https://remote.com/document'])
+  #
+  # @note Empty entries in the document list will trigger a collection clear operation
+  # @note Documents are processed in batches of 25 to manage memory usage
+  # @note Progress is reported to STDOUT during processing
+  #
+  # @see fetch_source
+  # @see embed_source
+  # @see documents.clear
   def add_documents_from_argv(document_list)
     if document_list.any?(&:empty?)
       STDOUT.puts "Clearing collection #{bold{documents.collection}}."
@@ -532,6 +675,11 @@ class OllamaChat::Chat
     end
   end
 
+  # The setup_cache method initializes and returns a Redis cache instance with
+  # expiring keys if a Redis URL is configured.
+  #
+  # @return [ Documentrix::Documents::RedisCache, nil ] the configured Redis
+  # cache instance or nil if no URL is set.
   def setup_cache
     if url = config.redis.expiring.url?
       ex = config.redis.expiring.ex?.to_i
@@ -543,6 +691,14 @@ class OllamaChat::Chat
     end
   end
 
+  # The fix_config method handles configuration file errors by informing the
+  # user about the exception and prompting them to fix it.
+  # It then executes a diff tool to compare the current config file with the
+  # default one.
+  # This method exits the program after handling the configuration error
+  #
+  # @param exception [ Exception ] the exception that occurred while reading
+  # the config file
   def fix_config(exception)
     STDOUT.puts "When reading the config file, a #{exception.class} "\
       "exception was caught: #{exception.message.inspect}"
@@ -558,6 +714,17 @@ class OllamaChat::Chat
     end
   end
 
+  # Enables tab completion for chat commands within the interactive session
+  #
+  # Temporarily replaces the current Reline completion procedure with a custom
+  # one that provides command completion based on the chat help message.
+  #
+  # @param block [Proc] The block to execute with enhanced tab completion enabled
+  #
+  # @return [Object] The return value of the executed block
+  #
+  # @see display_chat_help_message
+  # @see Reline.completion_proc
   def enable_command_completion(&block)
     old = Reline.completion_proc
     commands = display_chat_help_message.scan(/^\s*(\S+)/).inject(&:concat)

data/lib/ollama_chat/clipboard.rb

@@ -1,5 +1,4 @@
 module OllamaChat::Clipboard
-
   # Copy the last assistant's message to the system clipboard.
   #
   # This method checks if there is a last message from an assistant in the `@messages`

data/lib/ollama_chat/dialog.rb

@@ -1,4 +1,12 @@
 module OllamaChat::Dialog
+  # The model_with_size method formats a model's size for display
+  # by creating a formatted string that includes the model name and its size
+  # in a human-readable format with appropriate units.
+  #
+  # @param model [ Object ] the model object that has name and size attributes
+  #
+  # @return [ Object ] a result object with an overridden to_s method
+  #                     that combines the model name and formatted size
   private def model_with_size(model)
     result = model.name
     formatted_size = Term::ANSIColor.bold {
@@ -10,6 +18,13 @@ module OllamaChat::Dialog
     result
   end
 
+  # The choose_model method selects a model from the available list based on
+  # CLI input or user interaction.
+  # It processes the provided CLI model parameter to determine if a regex
+  # selector is used, filters the models accordingly, and prompts the user to
+  # choose from the filtered list if needed.
+  # The method ensures that a model is selected and displays a connection
+  # message with the chosen model and base URL.
   def choose_model(cli_model, current_model)
     selector = if cli_model =~ /\A\?+(.*)\z/
                  cli_model = ''
@@ -17,20 +32,35 @@ module OllamaChat::Dialog
                end
     models = ollama.tags.models.sort_by(&:name).map { |m| model_with_size(m) }
     selector and models = models.grep(selector)
-    model = if cli_model == ''
-              OllamaChat::Utils::Chooser.choose(models) || current_model
-            else
-              cli_model || current_model
-            end
+    model =
+      if models.size == 1
+        models.first
+      elsif cli_model == ''
+        OllamaChat::Utils::Chooser.choose(models) || current_model
+      else
+        cli_model || current_model
+      end
   ensure
     STDOUT.puts green { "Connecting to #{model}@#{ollama.base_url} now…" }
   end
 
+  # The ask? method prompts the user with a question and returns their input.
+  #
+  # @param prompt [ String ] the message to display to the user
+  #
+  # @return [ String ] the user's response with trailing newline removed
   def ask?(prompt:)
     print prompt
     STDIN.gets.chomp
   end
 
+  # The choose_collection method presents a menu to select or create a document
+  # collection. It displays existing collections along with options to create a
+  # new one or exit.
+  # The method prompts the user for input and updates the document collection
+  # accordingly.
+  #
+  # @param current_collection [ String, nil ] the name of the currently active collection
   def choose_collection(current_collection)
     collections = [ current_collection ] + @documents.collections
     collections = collections.compact.map(&:to_s).uniq.sort
@@ -49,8 +79,19 @@ module OllamaChat::Dialog
     info
   end
 
+  # The document_policy method sets the policy for handling document imports.
+  #
+  # @param value [ String ] the document policy to be set
   attr_writer :document_policy
 
+  # The choose_document_policy method presents a menu to select a document policy.
+  # It allows the user to choose from importing, embedding, summarizing, or
+  # ignoring documents.
+  # The method displays available policies and sets the selected policy as the
+  # current document policy.
+  # If no valid policy is found, it defaults to the first option.
+  # After selection, it outputs the chosen policy and displays the current
+  # configuration information.
   def choose_document_policy
     policies = %w[ importing embedding summarizing ignoring ].sort
     current  = if policies.index(@document_policy)
@@ -73,6 +114,15 @@ module OllamaChat::Dialog
     info
   end
 
+  # The change_system_prompt method allows the user to select or enter a new
+  # system prompt for the chat session.
+  # It provides an interactive chooser when multiple prompts match the given
+  # selector, and sets the selected prompt as the current system prompt for the
+  # messages.
+  #
+  # @param default [ String ] the default system prompt to fall back to
+  # @param system [ String ] the system prompt identifier or pattern to
+  # search for
   def change_system_prompt(default, system: nil)
     selector = if system =~ /\A\?(.+)\z/
                  Regexp.new($1)
@@ -103,6 +153,11 @@ module OllamaChat::Dialog
     @messages.set_system_prompt(system)
   end
 
+  # The choose_prompt method presents a menu of available prompts for selection.
+  # It retrieves the list of prompt attributes from the configuration,
+  # adds an '[EXIT]' option to the list, and displays it to the user.
+  # After the user makes a choice, the method either exits the chooser
+  # or applies the selected prompt configuration.
   def choose_prompt
     prompts = config.prompts.attribute_names.sort
     prompts.unshift('[EXIT]')
@@ -115,11 +170,20 @@ module OllamaChat::Dialog
     end
   end
 
+  # The change_voice method allows the user to select a voice from a list of
+  # available options. It uses the chooser to present the options and sets the
+  # selected voice as the current voice.
+  #
+  # @return [ String ] the full name of the chosen voice
   def change_voice
     chosen  = OllamaChat::Utils::Chooser.choose(config.voice.list)
     @current_voice = chosen.full? || config.voice.default
   end
 
+  # The message_list method creates and returns a new MessageList instance
+  # initialized with the current object as its argument.
+  #
+  # @return [ MessageList ] a new MessageList object
   def message_list
     MessageList.new(self)
   end

data/lib/ollama_chat/document_cache.rb

@@ -1,8 +1,20 @@
 module OllamaChat::DocumentCache
+  # The document_cache_class method returns the cache class specified in the
+  # configuration.
+  #
+  # @return [ Class ] the cache class defined by the config.cache setting
   def document_cache_class
     Object.const_get(config.cache)
   end
 
+  # The configure_cache method determines the appropriate cache class to use
+  # for document storage.
+  # It checks if the -M option was specified to use MemoryCache, otherwise it
+  # attempts to use the configured cache class.
+  # If an error occurs during this process, it falls back to using MemoryCache
+  # and reports the error.
+  #
+  # @return [ Class ] the selected cache class to be used for document caching
   def configure_cache
     if @opts[?M]
       Documentrix::Documents::MemoryCache

data/lib/ollama_chat/follow_chat.rb

@@ -4,7 +4,6 @@ class OllamaChat::FollowChat
   include Term::ANSIColor
   include OllamaChat::MessageFormat
 
-
   # Initializes a new instance of OllamaChat::FollowChat.
   #
   # @param [OllamaChat::Chat] chat The chat object, which represents the conversation context.
@@ -61,6 +60,13 @@ class OllamaChat::FollowChat
 
   private
 
+  # The ensure_assistant_response_exists method ensures that the last message
+  # in the conversation is from the assistant role.
+  #
+  # If the last message is not from an assistant, it adds a new assistant
+  # message with empty content and optionally includes thinking content if the
+  # chat's think mode is enabled. It also updates the user display variable to
+  # reflect the assistant's message type and styling.
   def ensure_assistant_response_exists
     if @messages&.last&.role != 'assistant'
       @messages << Message.new(
@@ -73,6 +79,12 @@ class OllamaChat::FollowChat
     end
   end
 
+  # The update_last_message method appends the content of a response to the
+  # last message in the conversation. It also appends thinking content to the
+  # last message if thinking is enabled and thinking content is present.
+  #
+  # @param response [ Object ] the response object containing message content
+  # and thinking
   def update_last_message(response)
     @messages.last.content << response.message&.content
     if @chat.think.on? and response_thinking = response.message&.thinking.full?
@@ -80,6 +92,13 @@ class OllamaChat::FollowChat
     end
   end
 
+  # The display_formatted_terminal_output method formats and outputs the
+  # terminal content by processing the last message's content and thinking,
+  # then prints it to the output. It handles markdown parsing and annotation
+  # based on chat settings, and ensures proper formatting with clear screen and
+  # move home commands. The method takes into account whether markdown and
+  # thinking modes are enabled to determine how to process and display the
+  # content.
   def display_formatted_terminal_output
     content, thinking = @messages.last.content, @messages.last.thinking
     if @chat.markdown.on?
@@ -96,6 +115,14 @@ class OllamaChat::FollowChat
     ].compact))
   end
 
+  # The eval_stats method processes response statistics and formats them into a
+  # colored, readable string output.
+  #
+  # @param response [ Object ] the response object containing evaluation metrics
+  #
+  # @return [ String ] a formatted string with statistical information about
+  # the evaluation process including durations, counts, and rates, styled with
+  # colors and formatting
   def eval_stats(response)
     eval_duration        = response.eval_duration / 1e9
     prompt_eval_duration = response.prompt_eval_duration / 1e9
@@ -114,11 +141,19 @@ class OllamaChat::FollowChat
     }
   end
 
+  # The output_eval_stats method outputs evaluation statistics to the specified
+  # output stream.
+  #
+  # @param response [ Object ] the response object containing evaluation data
   def output_eval_stats(response)
     response.done or return
     @output.puts "", eval_stats(response)
   end
 
+  # The debug_output method conditionally outputs the response object using jj
+  # when debugging is enabled.
+  #
+  # @param response [ Object ] the response object to be outputted
   def debug_output(response)
     OllamaChat::Chat.config.debug and jj response
   end

data/lib/ollama_chat/information.rb

@@ -7,15 +7,31 @@ module OllamaChat::Information
   end
 
   module UserAgent
+    # The progname method returns the name of the application.
+    #
+    # @return [ String ] the application name "ollama_chat"
     def progname
       'ollama_chat'
     end
 
+    # The user_agent method constructs and returns a user agent string
+    # that combines the program name and the OllamaChat version
+    # separated by a forward slash.
+    #
+    # @return [ String ] the formatted user agent string
     def user_agent
       [ progname, OllamaChat::VERSION ] * ?/
     end
   end
 
+  # The collection_stats method displays statistics about the current document
+  # collection.
+  #
+  # This method outputs information regarding the active document collection,
+  # including the collection name, total number of embeddings, and a list of
+  # tags.
+  #
+  # @return [ nil ] This method always returns nil.
   def collection_stats
     STDOUT.puts <<~EOT
       Current Collection
@@ -27,6 +43,13 @@ module OllamaChat::Information
     nil
   end
 
+  # The info method displays comprehensive information about the current state
+  # of the ollama_chat instance.
+  # This includes version details, server connection status, model
+  # configurations, embedding settings, and various operational switches.
+  #
+  # @return [ nil ] This method does not return a value; it outputs information
+  # directly to standard output.
   def info
     STDOUT.puts "Running ollama_chat version: #{bold(OllamaChat::VERSION)}"
     STDOUT.puts "Connected to ollama server version: #{bold(server_version)} on: #{bold(server_url)}"
@@ -58,6 +81,9 @@ module OllamaChat::Information
     nil
   end
 
+  # The display_chat_help_message method returns a formatted string containing
+  # all available command-line options and their descriptions for the chat
+  # interface.
   private def display_chat_help_message
     <<~EOT
       /copy                           to copy last response to clipboard
@@ -90,16 +116,24 @@ module OllamaChat::Information
       /load filename                  load conversation messages
       /output filename                save last response to filename
       /pipe command                   write last response to command's stdin
+      /vim                            insert the last message into a vim server
       /quit                           to quit
       /help                           to view this help
     EOT
   end
 
+  # The display_chat_help method outputs the chat help message to standard output.
+  #
+  # @return [ nil ] This method always returns nil after printing the help message.
   def display_chat_help
     STDOUT.puts display_chat_help_message
     nil
   end
 
+  # The usage method displays the command-line interface help text
+  # and returns an exit code of 0.
+  #
+  # @return [ Integer ] always returns 0 indicating successful help display
   def usage
     STDOUT.puts <<~EOT
       Usage: #{progname} [OPTIONS]
@@ -123,15 +157,25 @@ module OllamaChat::Information
     0
   end
 
+  # The version method outputs the program name and its version number to
+  # standard output.
+  #
+  # @return [ Integer ] returns 0 indicating successful execution
   def version
     STDOUT.puts "%s %s" % [ progname, OllamaChat::VERSION ]
     0
   end
 
+  # The server_version method retrieves the version of the Ollama server.
+  #
+  # @return [ String ] the version string of the connected Ollama server
   def server_version
     @server_version ||= ollama.version.version
   end
 
+  # The server_url method returns the base URL of the Ollama server connection.
+  #
+  # @return [ String ] the base URL used for communicating with the Ollama API
   def server_url
     @server_url ||= ollama.base_url
   end