ollama-ruby 1.5.0 → 1.6.0

data/lib/ollama/commands/embed.rb

@@ -1,20 +1,101 @@
+# A command class that represents the embed API endpoint for Ollama.
+#
+# This class is used to interact with the Ollama API's embed endpoint, which
+# generates embeddings for text input using a specified model. It inherits from
+# the base command structure and provides the necessary functionality to execute
+# embedding requests for generating vector representations of text.
+#
+# @example Generating embeddings for a single text
+#   embed = ollama.embed(model: 'all-minilm', input: 'Why is the sky blue?')
+#
+# @example Generating embeddings for multiple texts
+#   embed = ollama.embed(model: 'all-minilm', input: ['Why is the sky blue?', 'Why is the grass green?'])
 class Ollama::Commands::Embed
   include Ollama::DTO
 
+  # The path method returns the API endpoint path for embed requests.
+  #
+  # This class method provides the specific URL path used to interact with the
+  # Ollama API's embed endpoint. It is utilized internally by the command
+  # structure to determine the correct API route for generating embeddings.
+  #
+  # @return [ String ] the API endpoint path '/api/embed' for embed requests
   def self.path
     '/api/embed'
   end
 
+  # The initialize method sets up a new instance with streaming disabled.
+  #
+  # This method is responsible for initializing a new object instance and
+  # configuring it with parameters required for embedding operations. It sets
+  # up the model, input text(s), and optional parameters while explicitly
+  # disabling streaming since embedding operations are typically non-streaming.
+  #
+  # @param model [ String ] the name of the model to use for generating embeddings
+  # @param input [ String, Array<String> ] the text input(s) to generate embeddings for
+  # @param options [ Ollama::Options, nil ] optional configuration parameters for the model
+  # @param truncate [ Boolean, nil ] whether to truncate the input if it exceeds context length
+  # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
   def initialize(model:, input:, options: nil, truncate: nil, keep_alive: nil)
     @model, @input, @options, @truncate, @keep_alive =
       model, input, options, truncate, keep_alive
     @stream = false
   end
 
-  attr_reader :model, :input, :options, :truncate, :keep_alive, :stream
+  # The model attribute reader returns the model name associated with the object.
+  #
+  # @return [ String ] the name of the model used by the command instance
+  attr_reader :model
 
+  # The input attribute reader returns the text input(s) associated with the object.
+  #
+  # @return [ String, Array<String> ] the text input(s) to generate embeddings for
+  attr_reader :input
+
+  # The options attribute reader returns the model configuration options associated with the object.
+  #
+  # @return [ Ollama::Options, nil ] optional configuration parameters for the model
+  attr_reader :options
+
+  # The truncate attribute reader returns the truncate setting associated with the object.
+  #
+  # @return [ Boolean, nil ] whether to truncate the input if it exceeds context length
+  attr_reader :truncate
+
+  # The keep_alive attribute reader returns the keep-alive duration associated with the object.
+  #
+  # @return [ String, nil ] duration to keep the model loaded in memory
+  attr_reader :keep_alive
+
+  # The stream attribute reader returns the streaming behavior setting
+  # associated with the object.
+  #
+  # @return [ FalseClass ] the streaming behavior flag, indicating whether
+  #         streaming is enabled for the command execution (always false for embed commands)
+  attr_reader :stream
+
+
+  # The client attribute writer allows setting the client instance associated
+  # with the object.
+  #
+  # This method assigns the client that will be used to perform requests and
+  # handle responses for this command. It is typically called internally when a
+  # command is executed through a client instance.
+  #
+  # @attr_writer [ Ollama::Client ] the assigned client instance
   attr_writer :client
 
+  # The perform method executes a command request using the specified handler.
+  #
+  # This method initiates a POST request to the Ollama API's embed endpoint,
+  # utilizing the client instance to send the request and process responses
+  # through the provided handler. It handles non-streaming scenarios since
+  # embedding commands do not support streaming.
+  #
+  # @param handler [ Ollama::Handler ] the handler object responsible for processing API
+  # responses
+  #
+  # @return [ self ] returns the current instance after initiating the request
   def perform(handler)
     @client.request(method: :post, path: self.class.path, body: to_json, stream:, handler:)
   end

data/lib/ollama/commands/embeddings.rb

@@ -1,19 +1,90 @@
+# A command class that represents the embeddings API endpoint for Ollama.
+#
+# This class is used to interact with the Ollama API's embeddings endpoint, which
+# generates embeddings for text input using a specified model. It inherits from
+# the base command structure and provides the necessary functionality to execute
+# embedding requests for generating vector representations of text.
+#
+# @example Generating embeddings for a prompt
+#   embeddings = ollama.embeddings(model: 'mxbai-embed-large', prompt: 'The sky is blue because of rayleigh scattering')
 class Ollama::Commands::Embeddings
   include Ollama::DTO
 
+  # The path method returns the API endpoint path for embeddings requests.
+  #
+  # This class method provides the specific URL path used to interact with the
+  # Ollama API's embeddings endpoint. It is utilized internally by the command
+  # structure to determine the correct API route for generating embeddings.
+  #
+  # @return [ String ] the API endpoint path '/api/embeddings' for embeddings requests
   def self.path
     '/api/embeddings'
   end
 
+  # The initialize method sets up a new instance with streaming disabled.
+  #
+  # This method is responsible for initializing a new object instance and
+  # configuring it with parameters required for embedding operations. It sets
+  # up the model, prompt text, and optional parameters while explicitly
+  # disabling streaming since embedding operations are typically non-streaming.
+  #
+  # @param model [ String ] the name of the model to use for generating embeddings
+  # @param prompt [ String ] the text prompt to generate embeddings for
+  # @param options [ Ollama::Options, nil ] optional configuration parameters for the model
+  # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
   def initialize(model:, prompt:, options: nil, keep_alive: nil)
     @model, @prompt, @options, @keep_alive, @stream =
       model, prompt, options, keep_alive, false
   end
 
-  attr_reader :model, :prompt, :options, :keep_alive, :stream
+  # The model attribute reader returns the model name associated with the object.
+  #
+  # @return [ String ] the name of the model used by the command instance
+  attr_reader :model
 
+  # The prompt attribute reader returns the text prompt associated with the object.
+  #
+  # @return [ String ] the text prompt to generate embeddings for
+  attr_reader :prompt
+
+  # The options attribute reader returns the model configuration options associated with the object.
+  #
+  # @return [ Ollama::Options, nil ] optional configuration parameters for the model
+  attr_reader :options
+
+  # The keep_alive attribute reader returns the keep-alive duration associated with the object.
+  #
+  # @return [ String, nil ] duration to keep the model loaded in memory
+  attr_reader :keep_alive
+
+  # The stream attribute reader returns the streaming behavior setting
+  # associated with the object.
+  #
+  # @return [ FalseClass ] the streaming behavior flag, indicating whether
+  #         streaming is enabled for the command execution (always false for embeddings commands)
+  attr_reader :stream
+
+  # The client attribute writer allows setting the client instance associated
+  # with the object.
+  #
+  # This method assigns the client that will be used to perform requests and
+  # handle responses for this command. It is typically called internally when a
+  # command is executed through a client instance.
+  #
+  # @attr_writer [ Ollama::Client ] the assigned client instance
   attr_writer :client
 
+  # The perform method executes a command request using the specified handler.
+  #
+  # This method initiates a POST request to the Ollama API's embeddings endpoint,
+  # utilizing the client instance to send the request and process responses
+  # through the provided handler. It handles non-streaming scenarios since
+  # embeddings commands do not support streaming.
+  #
+  # @param handler [ Ollama::Handler ] the handler object responsible for processing API
+  # responses
+  #
+  # @return [ self ] returns the current instance after initiating the request
   def perform(handler)
     @client.request(method: :post, path: self.class.path, body: to_json, stream:, handler:)
   end

data/lib/ollama/commands/generate.rb

@@ -1,20 +1,136 @@
+# A command class that represents the generate API endpoint for Ollama.
+#
+# This class is used to interact with the Ollama API's generate endpoint, which
+# generates text completions using a specified model. It inherits from the base
+# command structure and provides the necessary functionality to execute
+# generation requests for text completion tasks.
+#
+# @example Generating a text completion
+#   generate = ollama.generate(model: 'llama3.1', prompt: 'Why is the sky blue?')
+#
+# @example Generating with streaming enabled
+#   generate = ollama.generate(model: 'llama3.1', prompt: 'Why is the sky blue?', stream: true)
 class Ollama::Commands::Generate
   include Ollama::DTO
 
+  # The path method returns the API endpoint path for generate requests.
+  #
+  # This class method provides the specific URL path used to interact with the
+  # Ollama API's generate endpoint. It is utilized internally by the command
+  # structure to determine the correct API route for text generation operations.
+  #
+  # @return [ String ] the API endpoint path '/api/generate' for generate requests
   def self.path
     '/api/generate'
   end
 
+  # The initialize method sets up a new instance with default streaming behavior.
+  #
+  # This method is responsible for initializing a Generate command object with
+  # all the necessary parameters for text generation. It handles optional
+  # parameters and ensures proper data types (e.g., converting images to arrays).
+  #
+  # @param model [ String ] the name of the model to use for generation
+  # @param prompt [ String ] the text prompt to generate completions for
+  # @param suffix [ String, nil ] optional suffix to append to the generated text
+  # @param images [ Ollama::Image, Array<Ollama::Image>, nil ] optional image(s) to include in the request
+  # @param format [ String, nil ] optional format specification for the response
+  # @param options [ Ollama::Options, nil ] optional configuration parameters for the model
+  # @param system [ String, nil ] optional system message to set context for generation
+  # @param template [ String, nil ] optional template to use for formatting the prompt
+  # @param context [ Array<Integer>, nil ] optional context vector for continuation
+  # @param stream [ Boolean, nil ] whether to stream responses (default: false)
+  # @param raw [ Boolean, nil ] whether to return raw output without formatting
+  # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
+  # @param think [ Boolean, nil ] whether to enable thinking mode for generation
   def initialize(model:, prompt:, suffix: nil, images: nil, format: nil, options: nil, system: nil, template: nil, context: nil, stream: nil, raw: nil, keep_alive: nil, think: nil)
     @model, @prompt, @suffix, @images, @format, @options, @system, @template, @context, @stream, @raw, @keep_alive, @think =
       model, prompt, suffix, (Array(images) if images), format, options, system, template, context, stream, raw, keep_alive, think
   end
 
-  attr_reader :model, :prompt, :suffix, :images, :format, :options, :system,
-    :template, :context, :stream, :raw, :keep_alive, :think
+  # The model attribute reader returns the model name associated with the generate command.
+  #
+  # @return [ String ] the name of the model used for generation
+  attr_reader :model
 
+  # The prompt attribute reader returns the text prompt used for generation.
+  #
+  # @return [ String ] the text prompt to generate completions for
+  attr_reader :prompt
+
+  # The suffix attribute reader returns any suffix that was appended to the generated text.
+  #
+  # @return [ String, nil ] optional suffix to append to the generated text
+  attr_reader :suffix
+
+  # The images attribute reader returns image objects associated with the generate command.
+  #
+  # @return [ Array<Ollama::Image>, nil ] array of image objects, or nil if none provided
+  attr_reader :images
+
+  # The format attribute reader returns the format specification for the response.
+  #
+  # @return [ String, nil ] optional format specification for the response
+  attr_reader :format
+
+  # The options attribute reader returns configuration parameters for the model.
+  #
+  # @return [ Ollama::Options, nil ] optional configuration parameters for the model
+  attr_reader :options
+
+  # The system attribute reader returns the system message that sets context for generation.
+  #
+  # @return [ String, nil ] optional system message to set context for generation
+  attr_reader :system
+
+  # The template attribute reader returns the template used for formatting the prompt.
+  #
+  # @return [ String, nil ] optional template to use for formatting the prompt
+  attr_reader :template
+
+  # The context attribute reader returns the context vector for continuation.
+  #
+  # @return [ Array<Integer>, nil ] optional context vector for continuation
+  attr_reader :context
+
+  # The stream attribute reader returns whether responses will be streamed.
+  #
+  # @return [ Boolean, nil ] whether to stream responses (default: false)
+  attr_reader :stream
+
+  # The raw attribute reader returns whether raw output without formatting should be returned.
+  #
+  # @return [ Boolean, nil ] whether to return raw output without formatting
+  attr_reader :raw
+
+  # The keep_alive attribute reader returns the duration to keep the model loaded in memory.
+  #
+  # @return [ String, nil ] duration to keep the model loaded in memory
+  attr_reader :keep_alive
+
+  # The think attribute reader returns whether thinking mode is enabled for generation.
+  #
+  # @return [ Boolean, nil ] whether to enable thinking mode for generation
+  attr_reader :think
+
+  # The client attribute writer allows setting the client instance associated
+  # with the object.
+  #
+  # This method assigns the client that will be used to perform requests and
+  # handle responses for this command. It is typically called internally when a
+  # command is executed through a client instance.
+  #
+  # @attr_writer [ Ollama::Client ] the assigned client instance
   attr_writer :client
 
+  # The perform method executes the generate command using the specified handler.
+  #
+  # This method sends a POST request to the Ollama API's generate endpoint with
+  # the command parameters serialized as JSON. It delegates to the client's request
+  # method for actual HTTP communication.
+  #
+  # @param handler [ Ollama::Handler ] the handler to process responses from the API
+  # @return [ void ]
   def perform(handler)
     @client.request(method: :post, path: self.class.path, body: to_json, stream:, handler:)
   end

data/lib/ollama/commands/ps.rb

@@ -1,18 +1,73 @@
+# A command class that represents the ps API endpoint for Ollama.
+#
+# This class is used to interact with the Ollama API's ps endpoint, which
+# retrieves information about running models. It inherits from the base command
+# structure and provides the necessary functionality to execute ps requests
+# for monitoring active model processes.
+#
+# @example Retrieving information about running models
+#   ps = ollama.ps
+#   ps.models # => array of running model information
 class Ollama::Commands::Ps
+  # The path method returns the API endpoint path for ps requests.
+  #
+  # This class method provides the specific URL path used to interact with the
+  # Ollama API's ps endpoint. It is utilized internally by the command
+  # structure to determine the correct API route for retrieving information
+  # about running models.
+  #
+  # @return [ String ] the API endpoint path '/api/ps' for ps requests
   def self.path
     '/api/ps'
   end
 
+  # The initialize method sets up a new instance with streaming disabled.
+  #
+  # This method is responsible for initializing a new object instance and
+  # configuring it with a default setting that disables streaming behavior.
+  # It is typically called during the object creation process to establish
+  # the initial state of the instance.
+  #
+  # @param parameters [ Hash ] a hash containing initialization parameters
+  #                           (must be empty for this command)
+  #
+  # @raise [ ArgumentError ] if any parameters are provided (ps endpoint
+  #                           does not accept parameters)
   def initialize(**parameters)
     parameters.empty? or raise ArgumentError,
       "Invalid parameters: #{parameters.keys * ' '}"
     @stream = false
   end
 
+  # The stream attribute reader returns the streaming behavior setting
+  # associated with the object.
+  #
+  # @return [ TrueClass, FalseClass ] the streaming behavior flag, indicating
+  #         whether streaming is enabled for the command execution
+  #         (always false for ps commands)
   attr_reader :stream
 
+  # The client attribute writer allows setting the client instance associated
+  # with the object.
+  #
+  # This method assigns the client that will be used to perform requests and
+  # handle responses for this command. It is typically called internally when a
+  # command is executed through a client instance.
+  #
+  # @attr_writer [ Ollama::Client ] the assigned client instance
   attr_writer :client
 
+  # The perform method executes a command request using the specified handler.
+  #
+  # This method initiates a GET request to the Ollama API's ps endpoint,
+  # utilizing the client instance to send the request and process responses
+  # through the provided handler. It handles non-streaming scenarios since
+  # ps commands do not support streaming.
+  #
+  # @param handler [ Ollama::Handler ] the handler object responsible for processing API
+  # responses
+  #
+  # @return [ self ] returns the current instance after initiating the request
   def perform(handler)
     @client.request(method: :get, path: self.class.path, stream:, handler:)
   end

data/lib/ollama/commands/pull.rb

@@ -1,18 +1,89 @@
+# The command method creates a command method for the Ollama client
+#
+# Defines a new command method that corresponds to an Ollama API endpoint. The
+# command method can be invoked with parameters and an optional handler to
+# process responses. It determines which handler to use based on whether the
+# command supports streaming and the presence of an explicit handler.
+#
+# @param name [ Symbol ] the name of the command to define
+# @param default_handler [ Class ] the default handler class to use when no explicit handler is provided
+# @param stream_handler [ Class, nil ] the handler class to use for streaming responses, if applicable
+#
+# @note Create Command `name`, if `stream` was true, set `stream_handler`
+# as default, otherwise `default_handler`.
+#
+# @return [ self ] returns the receiver after defining the command method
 class Ollama::Commands::Pull
   include Ollama::DTO
 
+  # The path method returns the API endpoint path for pull requests.
+  #
+  # This class method provides the specific URL path used to interact with the
+  # Ollama API's pull endpoint. It is utilized internally by the command
+  # structure to determine the correct API route for downloading models from a
+  # remote registry.
+  #
+  # @return [ String ] the API endpoint path '/api/pull' for pull requests
   def self.path
     '/api/pull'
   end
 
+  # The initialize method sets up a new instance with streaming enabled by default.
+  #
+  # This method is responsible for initializing a new object instance and
+  # configuring it with a default setting that enables streaming behavior.
+  # It is typically called during the object creation process to establish
+  # the initial state of the instance.
+  #
+  # @param model [ String ] the name of the model to be pushed
+  # @param insecure [ TrueClass, FalseClass, nil ] whether to allow insecure
+  #        connections, or nil to use default
+  # @param stream [ TrueClass, FalseClass ] whether to enable streaming for
+  #        the operation, defaults to true
   def initialize(model:, insecure: nil, stream: true)
     @model, @insecure, @stream = model, insecure, stream
   end
 
-  attr_reader :model, :insecure, :stream
+  # The model attribute reader returns the model name associated with the object.
+  #
+  # @return [ String ] the name of the model used by the command instance
+  attr_reader :model
 
+  # The insecure attribute reader returns the insecure connection setting
+  # associated with the object.
+  #
+  # @return [ TrueClass, FalseClass, nil ] the insecure flag indicating whether
+  #         insecure connections are allowed, or nil if not set
+  attr_reader :insecure
+
+  # The stream attribute reader returns the streaming behavior setting
+  # associated with the object.
+  #
+  # @return [ TrueClass, FalseClass ] the streaming behavior flag, indicating
+  #         whether streaming is enabled for the command execution
+  attr_reader :stream
+
+  # The client attribute writer allows setting the client instance associated
+  # with the object.
+  #
+  # This method assigns the client that will be used to perform requests and
+  # handle responses for this command. It is typically called internally when a
+  # command is executed through a client instance.
+  #
+  # @attr_writer [ Ollama::Client ] the assigned client instance
   attr_writer :client
 
+  # The perform method executes a command request using the specified handler.
+  #
+  # This method initiates a request to the Ollama API endpoint associated with
+  # the command, utilizing the client instance to send the request and process
+  # responses through the provided handler. It handles both streaming and
+  # non-streaming scenarios based on the command's configuration.
+  #
+  # @param handler [ Ollama::Handler ] the handler object responsible for processing API
+  # responses
+  #
+  # @return [ self ] returns the current instance after initiating the request
   def perform(handler)
     @client.request(method: :post, path: self.class.path, body: to_json, stream:, handler:)
   end

data/lib/ollama/commands/push.rb

@@ -1,18 +1,82 @@
+# A command class that represents the push API endpoint for Ollama.
+#
+# This class is used to interact with the Ollama API's push endpoint, which
+# uploads a model to a remote registry. It inherits from the base command
+# structure and provides the necessary functionality to execute push requests
+# for model deployment.
+#
+# @example Pushing a model to a remote registry
+#   push = ollama.push(model: 'user/llama3.1')
 class Ollama::Commands::Push
   include Ollama::DTO
 
+  # The path method returns the API endpoint path for push requests.
+  #
+  # This class method provides the specific URL path used to interact with the
+  # Ollama API's push endpoint. It is utilized internally by the command
+  # structure to determine the correct API route for uploading models to a
+  # remote registry.
+  #
+  # @return [ String ] the API endpoint path '/api/push' for push requests
   def self.path
     '/api/push'
   end
 
+  # The initialize method sets up a new instance with streaming enabled by default.
+  #
+  # This method is responsible for initializing a new object instance and
+  # configuring it with a default setting that enables streaming behavior.
+  # It is typically called during the object creation process to establish
+  # the initial state of the instance.
+  #
+  # @param model [ String ] the name of the model to be pushed
+  # @param insecure [ TrueClass, FalseClass, nil ] whether to allow insecure
+  #        connections, or nil to use default
+  # @param stream [ TrueClass, FalseClass ] whether to enable streaming for
+  #        the operation, defaults to true
   def initialize(model:, insecure: nil, stream: true)
     @model, @insecure, @stream = model, insecure, stream
   end
 
-  attr_reader :model, :insecure, :stream
+  # The model attribute reader returns the model name associated with the object.
+  #
+  # @return [ String ] the name of the model to be pushed
+  attr_reader :model
 
+  # The insecure attribute reader returns the insecure connection setting
+  # associated with the object.
+  #
+  # @return [ TrueClass, FalseClass, nil ] the insecure flag indicating whether
+  #         insecure connections are allowed, or nil if not set
+  attr_reader :insecure
+
+  # The stream attribute reader returns the streaming behavior setting
+  # associated with the object.
+  #
+  # @return [ TrueClass, FalseClass ] the streaming behavior flag, indicating
+  #         whether streaming is enabled for the command execution
+  attr_reader :stream
+
+  # The client attribute writer allows setting the client instance associated
+  # with the object.
+  #
+  # This method assigns the client that will be used to perform requests and
+  # handle responses for this command. It is typically called internally when a
+  # command is executed through a client instance.
+  #
+  # @attr_writer [ Ollama::Client ] the assigned client instance
   attr_writer :client
 
+  # The perform method executes a command request using the specified handler.
+  #
+  # This method initiates a request to the Ollama API endpoint associated with
+  # the command, utilizing the client instance to send the request and process
+  # responses through the provided handler. It handles both streaming and
+  # non-streaming scenarios based on the command's configuration.
+  #
+  # @param handler [ Ollama::Handler ] the handler object responsible for processing API responses
+  #
+  # @return [ self ] returns the current instance after initiating the request
   def perform(handler)
     @client.request(method: :post, path: self.class.path, body: to_json, stream:, handler:)
   end

data/lib/ollama/commands/show.rb

@@ -1,19 +1,82 @@
+# A command class that represents the show API endpoint for Ollama.
+#
+# This class is used to interact with the Ollama API's show endpoint, which
+# retrieves detailed information about a specific model. It inherits from the
+# base command structure and provides the necessary functionality to execute
+# show requests for model details.
+#
+# @example Retrieving detailed information about a model
+#   show = ollama.show(model: 'llama3.1')
+#   show.model_info # => hash containing model details
 class Ollama::Commands::Show
   include Ollama::DTO
 
+  # The path method returns the API endpoint path for show requests.
+  #
+  # This class method provides the specific URL path used to interact with the
+  # Ollama API's show endpoint. It is utilized internally by the command
+  # structure to determine the correct API route for retrieving detailed
+  # information about a specific model.
+  #
+  # @return [ String ] the API endpoint path '/api/show' for show requests
   def self.path
     '/api/show'
   end
 
+  # The initialize method sets up a new instance with streaming disabled.
+  #
+  # This method is responsible for initializing a new object instance and
+  # configuring it with a default setting that disables streaming behavior.
+  # It is typically called during the object creation process to establish
+  # the initial state of the instance.
+  #
+  # @param model [ String ] the name of the model to be used @param verbose [
+  # TrueClass, FalseClass, nil ] whether to enable verbose output, or nil to
+  # use default
   def initialize(model:, verbose: nil)
     @model, @verbose = model, verbose
     @stream = false
   end
 
-  attr_reader :model, :verbose, :stream
+  # The model attribute reader returns the model name associated with the object.
+  #
+  # @return [ String ] the name of the model used by the command instance
+  attr_reader :model
 
+  # The verbose attribute reader returns the verbose setting associated with
+  # the object.
+  #
+  # @return [ TrueClass, FalseClass, nil ] the verbose flag indicating whether
+  #         verbose output is enabled, or nil if not set
+  attr_reader :verbose
+
+  # The stream attribute reader returns the streaming behavior setting
+  # associated with the object.
+  #
+  # @return [ TrueClass, FalseClass ] the streaming behavior flag, indicating
+  #         whether streaming is enabled for the command execution
+  attr_reader :stream
+
+  # The client attribute writer allows setting the client instance associated
+  # with the object.
+  #
+  # This method assigns the client that will be used to perform requests and
+  # handle responses for this command. It is typically called internally when a
+  # command is executed through a client instance.
+  #
+  # @attr_writer [ Ollama::Client ] the assigned client instance
   attr_writer :client
 
+  # The perform method executes a command request using the specified handler.
+  #
+  # This method initiates a request to the Ollama API endpoint associated with
+  # the command, utilizing the client instance to send the request and process
+  # responses through the provided handler. It handles both streaming and
+  # non-streaming scenarios based on the command's configuration.
+  #
+  # @param handler [ Ollama::Handler ] the handler object responsible for processing API responses
+  #
+  # @return [ self ] returns the current instance after initiating the request
   def perform(handler)
     @client.request(method: :post, path: self.class.path, body: to_json, stream:, handler:)
   end