ruby_llm 1.6.2 → 1.6.4

data/lib/ruby_llm/providers/ollama/chat.rb

@@ -19,7 +19,6 @@ module RubyLLM
         end
 
         def format_role(role)
-          # Ollama doesn't use the new OpenAI convention for system prompts
           role.to_s
         end
       end

data/lib/ruby_llm/providers/ollama/media.rb

@@ -10,7 +10,6 @@ module RubyLLM
         module_function
 
         def format_content(content)
-          # Convert Hash/Array back to JSON string for API
           return content.to_json if content.is_a?(Hash) || content.is_a?(Array)
           return content unless content.is_a?(Content)
 

data/lib/ruby_llm/providers/openai/capabilities.rb

@@ -235,20 +235,11 @@ module RubyLLM
 
           # Vision support
           modalities[:input] << 'image' if supports_vision?(model_id)
-
-          # Audio support
           modalities[:input] << 'audio' if model_id.match?(/whisper|audio|tts|transcribe/)
-
-          # PDF support
           modalities[:input] << 'pdf' if supports_vision?(model_id)
-
-          # Output modalities
           modalities[:output] << 'audio' if model_id.match?(/tts|audio/)
-
           modalities[:output] << 'image' if model_id.match?(/dall-e|image/)
-
           modalities[:output] << 'embeddings' if model_id.match?(/embedding/)
-
           modalities[:output] << 'moderation' if model_id.match?(/moderation/)
 
           modalities
@@ -257,13 +248,10 @@ module RubyLLM
         def capabilities_for(model_id) # rubocop:disable Metrics/PerceivedComplexity
           capabilities = []
 
-          # Common capabilities
           capabilities << 'streaming' unless model_id.match?(/moderation|embedding/)
           capabilities << 'function_calling' if supports_functions?(model_id)
           capabilities << 'structured_output' if supports_json_mode?(model_id)
           capabilities << 'batch' if model_id.match?(/embedding|batch/)
-
-          # Advanced capabilities
           capabilities << 'reasoning' if model_id.match?(/o\d|gpt-5|codex/)
 
           if model_id.match?(/gpt-4-turbo|gpt-4o/)
@@ -281,16 +269,13 @@ module RubyLLM
             output_per_million: output_price_for(model_id)
           }
 
-          # Add cached pricing if available
           if respond_to?(:cached_input_price_for)
             cached_price = cached_input_price_for(model_id)
             standard_pricing[:cached_input_per_million] = cached_price if cached_price
           end
 
-          # Pricing structure
           pricing = { text_tokens: { standard: standard_pricing } }
 
-          # Add batch pricing if applicable
           if model_id.match?(/embedding|batch/)
             pricing[:text_tokens][:batch] = {
               input_per_million: standard_pricing[:input_per_million] * 0.5,

data/lib/ruby_llm/providers/openai/chat.rb

@@ -18,13 +18,10 @@ module RubyLLM
             stream: stream
           }
 
-          # Only include temperature if it's not nil (some models don't accept it)
           payload[:temperature] = temperature unless temperature.nil?
-
           payload[:tools] = tools.map { |_, tool| tool_for(tool) } if tools.any?
 
           if schema
-            # Use strict mode from schema if specified, default to true
             strict = schema[:strict] != false
 
             payload[:response_format] = {

data/lib/ruby_llm/providers/openai/embeddings.rb

@@ -23,9 +23,6 @@ module RubyLLM
           data = response.body
           input_tokens = data.dig('usage', 'prompt_tokens') || 0
           vectors = data['data'].map { |d| d['embedding'] }
-
-          # If we only got one embedding AND the input was a single string (not an array),
-          # return it as a single vector
           vectors = vectors.first if vectors.length == 1 && !text.is_a?(Array)
 
           Embedding.new(vectors:, model:, input_tokens:)

data/lib/ruby_llm/providers/openai/media.rb

@@ -8,7 +8,6 @@ module RubyLLM
         module_function
 
         def format_content(content)
-          # Convert Hash/Array back to JSON string for API
           return content.to_json if content.is_a?(Hash) || content.is_a?(Array)
           return content unless content.is_a?(Content)
 

data/lib/ruby_llm/providers/openai.rb

@@ -2,9 +2,7 @@
 
 module RubyLLM
   module Providers
-    # OpenAI API integration. Handles chat completion, function calling,
-    # and OpenAI's unique streaming format. Supports GPT-4, GPT-3.5,
-    # and other OpenAI models.
+    # OpenAI API integration.
     class OpenAI < Provider
       include OpenAI::Chat
       include OpenAI::Embeddings

data/lib/ruby_llm/providers/openrouter/models.rb

@@ -13,13 +13,11 @@ module RubyLLM
 
         def parse_list_models_response(response, slug, _capabilities)
           Array(response.body['data']).map do |model_data| # rubocop:disable Metrics/BlockLength
-            # Extract modalities directly from architecture
             modalities = {
               input: Array(model_data.dig('architecture', 'input_modalities')),
               output: Array(model_data.dig('architecture', 'output_modalities'))
             }
 
-            # Construct pricing from API data, only adding non-zero values
             pricing = { text_tokens: { standard: {} } }
 
             pricing_types = {
@@ -34,7 +32,6 @@ module RubyLLM
               pricing[:text_tokens][:standard][target_key] = value * 1_000_000 if value.positive?
             end
 
-            # Convert OpenRouter's supported parameters to our capability format
             capabilities = supported_parameters_to_capabilities(model_data['supported_parameters'])
 
             Model::Info.new(
@@ -63,23 +60,11 @@ module RubyLLM
           return [] unless params
 
           capabilities = []
-
-          # Standard capabilities mapping
-          capabilities << 'streaming' # Assume all OpenRouter models support streaming
-
-          # Function calling capability
+          capabilities << 'streaming'
           capabilities << 'function_calling' if params.include?('tools') || params.include?('tool_choice')
-
-          # Structured output capability
           capabilities << 'structured_output' if params.include?('response_format')
-
-          # Batch capability
           capabilities << 'batch' if params.include?('batch')
-
-          # Additional mappings based on params
-          # Handles advanced model capabilities that might be inferred from supported params
           capabilities << 'predicted_outputs' if params.include?('logit_bias') && params.include?('top_k')
-
           capabilities
         end
       end

data/lib/ruby_llm/providers/perplexity/capabilities.rb

@@ -106,7 +106,6 @@ module RubyLLM
           }
         end
 
-        # Pricing information for Perplexity models (USD per 1M tokens)
         PRICES = {
           sonar: {
             input: 1.0,

data/lib/ruby_llm/providers/perplexity/chat.rb

@@ -8,7 +8,6 @@ module RubyLLM
         module_function
 
         def format_role(role)
-          # Perplexity doesn't use the new OpenAI convention for system prompts
           role.to_s
         end
       end

data/lib/ruby_llm/providers/perplexity.rb

@@ -34,17 +34,13 @@ module RubyLLM
 
         # If response is HTML (Perplexity returns HTML for auth errors)
         if body.include?('<html>') && body.include?('<title>')
-          # Extract title content
           title_match = body.match(%r{<title>(.+?)</title>})
           if title_match
-            # Clean up the title - remove status code if present
             message = title_match[1]
-            message = message.sub(/^\d+\s+/, '') # Remove leading digits and space
+            message = message.sub(/^\d+\s+/, '')
             return message
           end
         end
-
-        # Fall back to parent's implementation
         super
       end
     end

data/lib/ruby_llm/railtie.rb

@@ -9,7 +9,6 @@ module RubyLLM
       end
     end
 
-    # Register generators
     generators do
       require 'generators/ruby_llm/install_generator'
     end

data/lib/ruby_llm/stream_accumulator.rb

@@ -2,8 +2,6 @@
 
 module RubyLLM
   # Assembles streaming responses from LLMs into complete messages.
-  # Handles the complexities of accumulating content and tool calls
-  # from partial chunks while tracking token usage.
   class StreamAccumulator
     attr_reader :content, :model_id, :tool_calls
 
@@ -48,7 +46,7 @@ module RubyLLM
         arguments = if tc.arguments.is_a?(String) && !tc.arguments.empty?
                       JSON.parse(tc.arguments)
                     elsif tc.arguments.is_a?(String)
-                      {} # Return empty hash for empty string arguments
+                      {}
                     else
                       tc.arguments
                     end

data/lib/ruby_llm/streaming.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # Handles streaming responses from AI providers. Provides a unified way to process
-  # chunked responses, accumulate content, and handle provider-specific streaming formats.
-  # Each provider implements provider-specific parsing while sharing common stream handling
-  # patterns.
+  # Handles streaming responses from AI providers.
   module Streaming
     module_function
 
@@ -12,17 +9,14 @@ module RubyLLM
       accumulator = StreamAccumulator.new
 
       response = connection.post stream_url, payload do |req|
-        # Merge additional headers, with existing headers taking precedence
         req.headers = additional_headers.merge(req.headers) unless additional_headers.empty?
-        if req.options.respond_to?(:on_data)
-          # Handle Faraday 2.x streaming with on_data method
-          req.options.on_data = handle_stream do |chunk|
+        if faraday_1?
+          req.options[:on_data] = handle_stream do |chunk|
             accumulator.add chunk
             block.call chunk
           end
         else
-          # Handle Faraday 1.x streaming with :on_data key
-          req.options[:on_data] = handle_stream do |chunk|
+          req.options.on_data = handle_stream do |chunk|
             accumulator.add chunk
             block.call chunk
           end
@@ -42,6 +36,10 @@ module RubyLLM
 
     private
 
+    def faraday_1?
+      Faraday::VERSION.start_with?('1')
+    end
+
     def to_json_stream(&)
       buffer = +''
       parser = EventStreamParser::Parser.new
@@ -50,11 +48,9 @@ module RubyLLM
     end
 
     def create_stream_processor(parser, buffer, &)
-      if Faraday::VERSION.start_with?('1')
-        # Faraday 1.x: on_data receives (chunk, size)
+      if faraday_1?
         legacy_stream_processor(parser, &)
       else
-        # Faraday 2.x: on_data receives (chunk, bytes, env)
         stream_processor(parser, buffer, &)
       end
     end
@@ -94,12 +90,10 @@ module RubyLLM
       status, _message = parse_streaming_error(error_data)
       parsed_data = JSON.parse(error_data)
 
-      # Create a response-like object that works for both Faraday v1 and v2
-      error_response = if env
-                         env.merge(body: parsed_data, status: status)
-                       else
-                         # For Faraday v1, create a simple object that responds to .status and .body
+      error_response = if faraday_1?
                          Struct.new(:body, :status).new(parsed_data, status)
+                       else
+                         env.merge(body: parsed_data, status: status)
                        end
 
       ErrorMiddleware.parse_error(provider: self, response: error_response)
@@ -137,12 +131,10 @@ module RubyLLM
       status, _message = parse_streaming_error(data)
       parsed_data = JSON.parse(data)
 
-      # Create a response-like object that works for both Faraday v1 and v2
-      error_response = if env
-                         env.merge(body: parsed_data, status: status)
-                       else
-                         # For Faraday v1, create a simple object that responds to .status and .body
+      error_response = if faraday_1?
                          Struct.new(:body, :status).new(parsed_data, status)
+                       else
+                         env.merge(body: parsed_data, status: status)
                        end
 
       ErrorMiddleware.parse_error(provider: self, response: error_response)
@@ -150,7 +142,6 @@ module RubyLLM
       RubyLLM.logger.debug "Failed to parse error event: #{e.message}"
     end
 
-    # Default implementation - providers should override this method
     def parse_streaming_error(data)
       error_data = JSON.parse(data)
       [500, error_data['message'] || 'Unknown streaming error']

data/lib/ruby_llm/tool.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # Parameter definition for Tool methods. Specifies type constraints,
-  # descriptions, and whether parameters are required.
+  # Parameter definition for Tool methods.
   class Parameter
     attr_reader :name, :type, :description, :required
 
@@ -14,23 +13,7 @@ module RubyLLM
     end
   end
 
-  # Base class for creating tools that AI models can use. Provides a simple
-  # interface for defining parameters and implementing tool behavior.
-  #
-  # Example:
-  #    require 'tzinfo'
-  #
-  #    class TimeInfo < RubyLLM::Tool
-  #      description 'Gets the current time in various timezones'
-  #      param :timezone, desc: "Timezone name (e.g., 'UTC', 'America/New_York')"
-  #
-  #      def execute(timezone:)
-  #        time = TZInfo::Timezone.get(timezone).now.strftime('%Y-%m-%d %H:%M:%S')
-  #        "Current time in #{timezone}: #{time}"
-  #       rescue StandardError => e
-  #          { error: e.message }
-  #       end
-  #    end
+  # Base class for creating tools that AI models can use
   class Tool
     # Stops conversation continuation after tool execution
     class Halt

data/lib/ruby_llm/tool_call.rb

@@ -2,15 +2,6 @@
 
 module RubyLLM
   # Represents a function call from an AI model to a Tool.
-  # Encapsulates the function name, arguments, and execution results
-  # in a clean Ruby interface.
-  #
-  # Example:
-  #   tool_call = ToolCall.new(
-  #     id: "call_123",
-  #     name: "calculator",
-  #     arguments: { expression: "2 + 2" }
-  #   )
   class ToolCall
     attr_reader :id, :name, :arguments
 

data/lib/ruby_llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  VERSION = '1.6.2'
+  VERSION = '1.6.4'
 end

data/lib/ruby_llm.rb

@@ -30,8 +30,6 @@ loader.ignore("#{__dir__}/generators")
 loader.setup
 
 # A delightful Ruby interface to modern AI language models.
-# Provides a unified way to interact with models from OpenAI, Anthropic and others
-# with a focus on developer happiness and convention over configuration.
 module RubyLLM
   class Error < StandardError; end