ruby_llm 1.6.2 → 1.6.3

data/lib/ruby_llm/models.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # Registry of available AI models and their capabilities. Provides a clean interface
-  # to discover and work with models from different providers.
-  #
-  # Example:
-  #   RubyLLM.models.all                                  # All available models
-  #   RubyLLM.models.chat_models                          # Models that support chat
-  #   RubyLLM.models.by_provider('openai').chat_models    # OpenAI chat models
-  #   RubyLLM.models.find('claude-3')                     # Get info about a specific model
+  # Registry of available AI models and their capabilities.
   class Models
     include Enumerable
 
@@ -25,14 +18,14 @@ module RubyLLM
         File.expand_path('models.json', __dir__)
       end
 
+      def schema_file
+        File.expand_path('models_schema.json', __dir__)
+      end
+
       def refresh!
-        # Collect models from both sources
         provider_models = fetch_from_providers
         parsera_models = fetch_from_parsera
-
-        # Merge with parsera data taking precedence
         merged_models = merge_models(provider_models, parsera_models)
-
         @instance = new(merged_models)
       end
 
@@ -50,7 +43,6 @@ module RubyLLM
         config ||= RubyLLM.config
         provider_class = provider ? Provider.providers[provider.to_sym] : nil
 
-        # Check if provider is local
         if provider_class
           temp_instance = provider_class.new(config)
           assume_exists = true if temp_instance.local?

data/lib/ruby_llm/provider.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # Base class for LLM providers like OpenAI and Anthropic.
-  # Handles the complexities of API communication, streaming responses,
-  # and error handling so individual providers can focus on their unique features.
-  # Encapsulates configuration and connection to eliminate parameter threading.
+  # Base class for LLM providers.
   class Provider
     include Streaming
 
@@ -210,7 +207,6 @@ module RubyLLM
 
     def sync_response(connection, payload, additional_headers = {})
       response = connection.post completion_url, payload do |req|
-        # Merge additional headers, with existing headers taking precedence
         req.headers = additional_headers.merge(req.headers) unless additional_headers.empty?
       end
       parse_completion_response response

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

@@ -7,17 +7,10 @@ module RubyLLM
       module Capabilities
         module_function
 
-        # Determines the context window size for a given model
-        # @param model_id [String] the model identifier
-        # @return [Integer] the context window size in tokens
         def determine_context_window(_model_id)
-          # All Claude 3 and 3.5 and 3.7 models have 200K token context windows
           200_000
         end
 
-        # Determines the maximum output tokens for a given model
-        # @param model_id [String] the model identifier
-        # @return [Integer] the maximum output tokens
         def determine_max_tokens(model_id)
           case model_id
           when /claude-3-7-sonnet/, /claude-3-5/ then 8_192
@@ -25,52 +18,30 @@ module RubyLLM
           end
         end
 
-        # Gets the input price per million tokens for a given model
-        # @param model_id [String] the model identifier
-        # @return [Float] the price per million tokens for input
         def get_input_price(model_id)
           PRICES.dig(model_family(model_id), :input) || default_input_price
         end
 
-        # Gets the output price per million tokens for a given model
-        # @param model_id [String] the model identifier
-        # @return [Float] the price per million tokens for output
         def get_output_price(model_id)
           PRICES.dig(model_family(model_id), :output) || default_output_price
         end
 
-        # Determines if a model supports vision capabilities
-        # @param model_id [String] the model identifier
-        # @return [Boolean] true if the model supports vision
         def supports_vision?(model_id)
-          # All Claude 3, 3.5, and 3.7 models support vision
           !model_id.match?(/claude-[12]/)
         end
 
-        # Determines if a model supports function calling
-        # @param model_id [String] the model identifier
-        # @return [Boolean] true if the model supports functions
         def supports_functions?(model_id)
           model_id.match?(/claude-3/)
         end
 
-        # Determines if a model supports JSON mode
-        # @param model_id [String] the model identifier
-        # @return [Boolean] true if the model supports JSON mode
         def supports_json_mode?(model_id)
           model_id.match?(/claude-3/)
         end
 
-        # Determines if a model supports extended thinking
-        # @param model_id [String] the model identifier
-        # @return [Boolean] true if the model supports extended thinking
         def supports_extended_thinking?(model_id)
           model_id.match?(/claude-3-7-sonnet/)
         end
 
-        # Determines the model family for a given model ID
-        # @param model_id [String] the model identifier
-        # @return [Symbol] the model family identifier
         def model_family(model_id)
           case model_id
           when /claude-3-7-sonnet/  then 'claude-3-7-sonnet'
@@ -83,14 +54,10 @@ module RubyLLM
           end
         end
 
-        # Returns the model type
-        # @param model_id [String] the model identifier (unused but kept for API consistency)
-        # @return [String] the model type, always 'chat' for Anthropic models
         def model_type(_)
           'chat'
         end
 
-        # Pricing information for Anthropic models (per million tokens)
         PRICES = {
           'claude-3-7-sonnet': { input: 3.0, output: 15.0 },
           'claude-3-5-sonnet': { input: 3.0, output: 15.0 },
@@ -100,14 +67,10 @@ module RubyLLM
           'claude-2': { input: 3.0, output: 15.0 }
         }.freeze
 
-        # Default input price if model not found in PRICES
-        # @return [Float] default price per million tokens for input
         def default_input_price
           3.0
         end
 
-        # Default output price if model not found in PRICES
-        # @return [Float] default price per million tokens for output
         def default_output_price
           15.0
         end
@@ -118,7 +81,6 @@ module RubyLLM
             output: ['text']
           }
 
-          # All Claude 3+ models support vision
           unless model_id.match?(/claude-[12]/)
             modalities[:input] << 'image'
             modalities[:input] << 'pdf'
@@ -130,18 +92,13 @@ module RubyLLM
         def capabilities_for(model_id)
           capabilities = ['streaming']
 
-          # Function calling for Claude 3+
           if model_id.match?(/claude-3/)
             capabilities << 'function_calling'
             capabilities << 'batch'
           end
 
-          # Extended thinking (reasoning) for Claude 3.7
-          capabilities << 'reasoning' if model_id.match?(/claude-3-7/)
-
-          # Citations
+          capabilities << 'reasoning' if model_id.match?(/claude-3-7|-4/)
           capabilities << 'citations' if model_id.match?(/claude-3\.5|claude-3-7/)
-
           capabilities
         end
 
@@ -154,13 +111,11 @@ module RubyLLM
             output_per_million: prices[:output]
           }
 
-          # Batch is typically half the price
           batch_pricing = {
             input_per_million: prices[:input] * 0.5,
             output_per_million: prices[:output] * 0.5
           }
 
-          # Add reasoning output pricing for 3.7 models
           if model_id.match?(/claude-3-7/)
             standard_pricing[:reasoning_output_per_million] = prices[:output] * 2.5
             batch_pricing[:reasoning_output_per_million] = prices[:output] * 1.25

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

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

data/lib/ruby_llm/providers/anthropic/tools.rb

@@ -73,7 +73,6 @@ module RubyLLM
         def parse_tool_calls(content_blocks)
           return nil if content_blocks.nil?
 
-          # Handle single content block (backward compatibility)
           content_blocks = [content_blocks] unless content_blocks.is_a?(Array)
 
           tool_calls = {}

data/lib/ruby_llm/providers/anthropic.rb

@@ -2,8 +2,7 @@
 
 module RubyLLM
   module Providers
-    # Anthropic Claude API integration. Handles the complexities of
-    # Claude's unique message format and tool calling conventions.
+    # Anthropic Claude API integration.
     class Anthropic < Provider
       include Anthropic::Chat
       include Anthropic::Embeddings

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

@@ -11,7 +11,6 @@ module RubyLLM
           signature = sign_request("#{connection.connection.url_prefix}#{completion_url}", payload:)
           response = connection.post completion_url, payload do |req|
             req.headers.merge! build_headers(signature.headers, streaming: block_given?)
-            # Merge additional headers, with existing headers taking precedence
             req.headers = additional_headers.merge(req.headers) unless additional_headers.empty?
           end
           Anthropic::Chat.parse_completion_response response
@@ -41,7 +40,6 @@ module RubyLLM
         end
 
         def render_payload(messages, tools:, temperature:, model:, stream: false, schema: nil) # rubocop:disable Lint/UnusedMethodArgument,Metrics/ParameterLists
-          # Hold model_id in instance variable for use in completion_url and stream_url
           @model_id = model
 
           system_messages, chat_messages = Anthropic::Chat.separate_messages(messages)

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

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

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

@@ -25,7 +25,6 @@ module RubyLLM
         def parse_list_models_response(response, slug, capabilities)
           models = Array(response.body['modelSummaries'])
 
-          # Filter to include only models we care about
           models.select { |m| m['modelId'].include?('claude') }.map do |model_data|
             model_id = model_data['modelId']
 
@@ -51,7 +50,6 @@ module RubyLLM
           end
         end
 
-        # Simple test-friendly method that only sets the ID
         def create_model_info(model_data, slug, _capabilities)
           model_id = model_data['modelId']
 

data/lib/ruby_llm/providers/bedrock/streaming/base.rb

@@ -5,18 +5,6 @@ module RubyLLM
     class Bedrock
       module Streaming
         # Base module for AWS Bedrock streaming functionality.
-        # Serves as the core module that includes all other streaming-related modules
-        # and provides fundamental streaming operations.
-        #
-        # Responsibilities:
-        # - Stream URL management
-        # - Stream handling and error processing
-        # - Coordinating the functionality of other streaming modules
-        #
-        # @example
-        #   module MyStreamingImplementation
-        #     include RubyLLM::Providers::Bedrock::Streaming::Base
-        #   end
         module Base
           def self.included(base)
             base.include ContentExtraction

data/lib/ruby_llm/providers/bedrock/streaming/content_extraction.rb

@@ -5,13 +5,6 @@ module RubyLLM
     class Bedrock
       module Streaming
         # Module for handling content extraction from AWS Bedrock streaming responses.
-        # Provides methods to extract and process various types of content from the response data.
-        #
-        # Responsibilities:
-        # - Extracting content from different response formats
-        # - Processing JSON deltas and content blocks
-        # - Extracting metadata (tokens, model IDs, tool calls)
-        # - Handling different content structures (arrays, blocks, completions)
         module ContentExtraction
           def json_delta?(data)
             data['type'] == 'content_block_delta' && data.dig('delta', 'type') == 'input_json_delta'

data/lib/ruby_llm/providers/bedrock/streaming/message_processing.rb

@@ -5,18 +5,6 @@ module RubyLLM
     class Bedrock
       module Streaming
         # Module for processing streaming messages from AWS Bedrock.
-        # Handles the core message processing logic, including validation and chunking.
-        #
-        # Responsibilities:
-        # - Processing incoming message chunks
-        # - Validating message structure and content
-        # - Managing message offsets and boundaries
-        # - Error handling during message processing
-        #
-        # @example Processing a message chunk
-        #   offset = process_message(chunk, current_offset) do |processed_chunk|
-        #     handle_processed_chunk(processed_chunk)
-        #   end
         module MessageProcessing
           def process_chunk(chunk, &)
             offset = 0

data/lib/ruby_llm/providers/bedrock/streaming/payload_processing.rb

@@ -7,18 +7,6 @@ module RubyLLM
     class Bedrock
       module Streaming
         # Module for processing payloads from AWS Bedrock streaming responses.
-        # Handles JSON payload extraction, decoding, and chunk creation.
-        #
-        # Responsibilities:
-        # - Extracting and validating JSON payloads
-        # - Decoding Base64-encoded response data
-        # - Creating response chunks from processed data
-        # - Error handling for JSON parsing and processing
-        #
-        # @example Processing a payload
-        #   process_payload(raw_payload) do |chunk|
-        #     yield_chunk_to_client(chunk)
-        #   end
         module PayloadProcessing
           def process_payload(payload, &)
             json_payload = extract_json_payload(payload)

data/lib/ruby_llm/providers/bedrock/streaming/prelude_handling.rb

@@ -5,19 +5,6 @@ module RubyLLM
     class Bedrock
       module Streaming
         # Module for handling message preludes in AWS Bedrock streaming responses.
-        # Manages the parsing and validation of message headers and prelude data.
-        #
-        # Responsibilities:
-        # - Reading and validating message preludes
-        # - Calculating message positions and boundaries
-        # - Finding and validating prelude positions in chunks
-        # - Ensuring message integrity through length validation
-        #
-        # @example Reading a prelude
-        #   if can_read_prelude?(chunk, offset)
-        #     total_length, headers_length = read_prelude(chunk, offset)
-        #     process_message_with_lengths(total_length, headers_length)
-        #   end
         module PreludeHandling
           def can_read_prelude?(chunk, offset)
             chunk.bytesize - offset >= 12

data/lib/ruby_llm/providers/bedrock/streaming.rb

@@ -10,24 +10,6 @@ module RubyLLM
   module Providers
     class Bedrock
       # Streaming implementation for the AWS Bedrock API.
-      # This module provides functionality for handling streaming responses from AWS Bedrock,
-      # including message processing, content extraction, and error handling.
-      #
-      # The implementation is split into several focused modules:
-      # - Base: Core streaming functionality and module coordination
-      # - ContentExtraction: Extracting content from response data
-      # - MessageProcessing: Processing streaming message chunks
-      # - PayloadProcessing: Handling JSON payloads and chunk creation
-      # - PreludeHandling: Managing message preludes and headers
-      #
-      # @example Using the streaming module
-      #   class BedrockClient
-      #     include RubyLLM::Providers::Bedrock::Streaming
-      #
-      #     def stream_response(&block)
-      #       handle_stream(&block)
-      #     end
-      #   end
       module Streaming
         include Base
       end

data/lib/ruby_llm/providers/bedrock.rb

@@ -5,8 +5,7 @@ require 'time'
 
 module RubyLLM
   module Providers
-    # AWS Bedrock API integration. Handles chat completion and streaming
-    # for Claude models.
+    # AWS Bedrock API integration.
     class Bedrock < Provider
       include Bedrock::Chat
       include Bedrock::Streaming

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

@@ -10,7 +10,7 @@ module RubyLLM
         def context_window_for(model_id)
           case model_id
           when /deepseek-(?:chat|reasoner)/ then 64_000
-          else 32_768 # Sensible default
+          else 32_768
           end
         end
 
@@ -67,7 +67,6 @@ module RubyLLM
           end
         end
 
-        # Pricing information for DeepSeek models (USD per 1M tokens)
         PRICES = {
           chat: {
             input_hit: 0.07,

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

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