ruby_llm_community 0.0.6 → 1.1.0

data/lib/ruby_llm/aliases.rb

@@ -1,53 +1,35 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # Manages model aliases, allowing users to reference models by simpler names
-  # that map to specific model versions across different providers.
-  #
-  # Aliases are defined in aliases.json and follow the format:
-  #   {
-  #     "simple-name": {
-  #       "provider1": "specific-version-for-provider1",
-  #       "provider2": "specific-version-for-provider2"
-  #     }
-  #   }
+  # Manages model aliases for provider-specific versions
   class Aliases
     class << self
-      # Resolves a model ID to its provider-specific version
-      #
-      # @param model_id [String] the model identifier or alias
-      # @param provider_slug [String, Symbol, nil] optional provider to resolve for
-      # @return [String] the resolved model ID or the original if no alias exists
       def resolve(model_id, provider = nil)
         return model_id unless aliases[model_id]
 
         if provider
           aliases[model_id][provider.to_s] || model_id
         else
-          # Get native provider's version
           aliases[model_id].values.first || model_id
         end
       end
 
-      # Returns the loaded aliases mapping
-      # @return [Hash] the aliases mapping
       def aliases
         @aliases ||= load_aliases
       end
 
-      # Loads aliases from the JSON file
-      # @return [Hash] the loaded aliases
+      def aliases_file
+        File.expand_path('aliases.json', __dir__)
+      end
+
       def load_aliases
-        file_path = File.expand_path('aliases.json', __dir__)
-        if File.exist?(file_path)
-          JSON.parse(File.read(file_path))
+        if File.exist?(aliases_file)
+          JSON.parse(File.read(aliases_file))
         else
           {}
         end
       end
 
-      # Reloads aliases from disk
-      # @return [Hash] the reloaded aliases
       def reload!
         @aliases = load_aliases
       end

data/lib/ruby_llm/attachment.rb

@@ -62,9 +62,20 @@ module RubyLLM
     end
 
     def encoded
+      return nil if content.nil?
+
       Base64.strict_encode64(content)
     end
 
+    def for_llm
+      case type
+      when :text
+        "<file name='#{filename}' mime_type='#{mime_type}'>#{content}</file>"
+      else
+        "data:#{mime_type};base64,#{encoded}"
+      end
+    end
+
     def type
       return :image if image?
       return :audio if audio?
@@ -82,6 +93,17 @@ module RubyLLM
       RubyLLM::MimeType.audio? mime_type
     end
 
+    def format
+      case mime_type
+      when 'audio/mpeg'
+        'mp3'
+      when 'audio/wav', 'audio/wave', 'audio/x-wav'
+        'wav'
+      else
+        mime_type.split('/').last
+      end
+    end
+
     def pdf?
       RubyLLM::MimeType.pdf? mime_type
     end

data/lib/ruby_llm/chat.rb

@@ -1,13 +1,7 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # Represents a conversation with an AI model. Handles message history,
-  # streaming responses, and tool integration with a simple, conversational API.
-  #
-  # Example:
-  #   chat = RubyLLM.chat
-  #   chat.ask "What's the best way to learn Ruby?"
-  #   chat.ask "Can you elaborate on that?"
+  # Represents a conversation with an AI model
   class Chat
     include Enumerable
 
@@ -22,7 +16,7 @@ module RubyLLM
       @config = context&.config || RubyLLM.config
       model_id = model || @config.default_model
       with_model(model_id, provider: provider, assume_exists: assume_model_exists)
-      @temperature = 0.7
+      @temperature = nil
       @messages = []
       @tools = {}
       @cache_prompts = { system: false, user: false, tools: false }
@@ -138,8 +132,8 @@ module RubyLLM
         messages,
         tools: @tools,
         temperature: @temperature,
-        model: @model.id,
         cache_prompts: @cache_prompts.dup,
+        model: @model,
         params: @params,
         headers: @headers,
         schema: @schema,
@@ -148,7 +142,6 @@ module RubyLLM
 
       @on[:new_message]&.call unless block_given?
 
-      # Parse JSON if schema was set
       if @schema && response.content.is_a?(String)
         begin
           response.content = JSON.parse(response.content)
@@ -177,6 +170,10 @@ module RubyLLM
       @messages.clear
     end
 
+    def instance_variables
+      super - %i[@connection @config]
+    end
+
     private
 
     def wrap_streaming_block(&block)
@@ -191,12 +188,11 @@ module RubyLLM
           @on[:new_message]&.call
         end
 
-        # Pass chunk to user's block
         block.call chunk
       end
     end
 
-    def handle_tool_calls(response, &)
+    def handle_tool_calls(response, &) # rubocop:disable Metrics/PerceivedComplexity
       halt_result = nil
 
       response.tool_calls.each_value do |tool_call|
@@ -204,7 +200,8 @@ module RubyLLM
         @on[:tool_call]&.call(tool_call)
         result = execute_tool tool_call
         @on[:tool_result]&.call(result)
-        message = add_message role: :tool, content: result.to_s, tool_call_id: tool_call.id
+        content = result.is_a?(Content) ? result : result.to_s
+        message = add_message role: :tool, content:, tool_call_id: tool_call.id
         @on[:end_message]&.call(message)
 
         halt_result = result if result.is_a?(Tool::Halt)
@@ -218,9 +215,5 @@ module RubyLLM
       args = tool_call.arguments
       tool.call(args)
     end
-
-    def instance_variables
-      super - %i[@connection @config]
-    end
   end
 end

data/lib/ruby_llm/configuration.rb

@@ -1,16 +1,8 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # Global configuration for RubyLLM. Manages API keys, default models,
-  # and provider-specific settings.
-  #
-  # Configure via:
-  #   RubyLLM.configure do |config|
-  #     config.openai_api_key = ENV['OPENAI_API_KEY']
-  #     config.anthropic_api_key = ENV['ANTHROPIC_API_KEY']
-  #   end
+  # Global configuration for RubyLLM
   class Configuration
-    # Provider-specific configuration
     attr_accessor :openai_api_key,
                   :openai_api_base,
                   :openai_organization_id,
@@ -18,8 +10,11 @@ module RubyLLM
                   :openai_use_system_role,
                   :anthropic_api_key,
                   :gemini_api_key,
+                  :vertexai_project_id,
+                  :vertexai_location,
                   :deepseek_api_key,
                   :perplexity_api_key,
+                  :xai_api_key,
                   :bedrock_api_key,
                   :bedrock_secret_key,
                   :bedrock_region,
@@ -33,6 +28,10 @@ module RubyLLM
                   :default_model,
                   :default_embedding_model,
                   :default_image_model,
+                  # Model registry
+                  :model_registry_class,
+                  # Rails integration
+                  :use_new_acts_as,
                   # Connection configuration
                   :request_timeout,
                   :max_retries,
@@ -47,7 +46,6 @@ module RubyLLM
                   :log_stream_debug
 
     def initialize
-      # Connection configuration
       @request_timeout = 120
       @max_retries = 3
       @retry_interval = 0.1
@@ -55,12 +53,13 @@ module RubyLLM
       @retry_interval_randomness = 0.5
       @http_proxy = nil
 
-      # Default models
       @default_model = 'gpt-4.1-nano'
       @default_embedding_model = 'text-embedding-3-small'
       @default_image_model = 'gpt-image-1'
 
-      # Logging configuration
+      @model_registry_class = 'Model'
+      @use_new_acts_as = false
+
       @log_file = $stdout
       @log_level = ENV['RUBYLLM_DEBUG'] ? Logger::DEBUG : Logger::INFO
       @log_stream_debug = ENV['RUBYLLM_STREAM_DEBUG'] == 'true'

data/lib/ruby_llm/connection.rb

@@ -48,6 +48,10 @@ module RubyLLM
       end
     end
 
+    def instance_variables
+      super - %i[@config @connection]
+    end
+
     private
 
     def setup_timeout(faraday)
@@ -118,9 +122,5 @@ module RubyLLM
       raise ConfigurationError,
             "#{@provider.name} provider is not configured. Add this to your initialization:\n\n#{config_block}"
     end
-
-    def instance_variables
-      super - %i[@config @connection]
-    end
   end
 end

data/lib/ruby_llm/connection_multipart.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  # A connection that uses multipart/form-data for file uploads
+  class ConnectionMultipart < Connection
+    def post(url, payload, &)
+      @connection.post url, payload do |req|
+        req.headers.merge! @provider.headers if @provider.respond_to?(:headers)
+        req.headers['Content-Type'] = 'multipart/form-data'
+        yield req if block_given?
+      end
+    end
+
+    def setup_middleware(faraday)
+      super
+      faraday.request :multipart, content_type: 'multipart/form-data'
+    end
+  end
+end

data/lib/ruby_llm/content.rb

@@ -2,7 +2,6 @@
 
 module RubyLLM
   # Represents the content sent to or received from an LLM.
-  # Selects the appropriate attachment class based on the content type.
   class Content
     attr_reader :text, :attachments
 
@@ -19,6 +18,11 @@ module RubyLLM
       self
     end
 
+    def attach(attachment)
+      @attachments << attachment
+      self
+    end
+
     def format
       if @text && @attachments.empty?
         @text
@@ -42,7 +46,6 @@ module RubyLLM
 
     def process_attachments(attachments)
       if attachments.is_a?(Hash)
-        # Ignores types (like :image, :audio, :text, :pdf) since we have robust MIME type detection
         attachments.each_value { |attachment| process_attachments_array_or_string(attachment) }
       else
         process_attachments_array_or_string attachments

data/lib/ruby_llm/embedding.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # Core embedding interface. Provides a clean way to generate embeddings
-  # from text using various provider models.
+  # Core embedding interface.
   class Embedding
     attr_reader :vectors, :model, :input_tokens
 

data/lib/ruby_llm/error.rb

@@ -3,13 +3,6 @@
 module RubyLLM
   # Custom error class that wraps API errors from different providers
   # into a consistent format with helpful error messages.
-  #
-  # Example:
-  #   begin
-  #     chat.ask "What's 2+2?"
-  #   rescue RubyLLM::Error => e
-  #     puts "Couldn't chat with AI: #{e.message}"
-  #   end
   class Error < StandardError
     attr_reader :response
 
@@ -36,7 +29,6 @@ module RubyLLM
   class UnauthorizedError < Error; end
 
   # Faraday middleware that maps provider-specific API errors to RubyLLM errors.
-  # Uses provider's parse_error method to extract meaningful error messages.
   class ErrorMiddleware < Faraday::Middleware
     def initialize(app, options = {})
       super(app)

data/lib/ruby_llm/image.rb

@@ -2,24 +2,22 @@
 
 module RubyLLM
   # Represents a generated image from an AI model.
-  # Provides an interface to image generation capabilities
-  # from providers like DALL-E and Gemini's Imagen.
   class Image
-    attr_reader :url, :data, :mime_type, :revised_prompt, :model_id
+    attr_reader :url, :data, :mime_type, :revised_prompt, :model_id, :usage
 
-    def initialize(url: nil, data: nil, mime_type: nil, revised_prompt: nil, model_id: nil)
+    def initialize(url: nil, data: nil, mime_type: nil, revised_prompt: nil, model_id: nil, usage: {}) # rubocop:disable Metrics/ParameterLists
       @url = url
       @data = data
       @mime_type = mime_type
       @revised_prompt = revised_prompt
       @model_id = model_id
+      @usage = usage
     end
 
     def base64?
       !@data.nil?
     end
 
-    # Returns the raw binary image data regardless of source
     def to_blob
       if base64?
         Base64.decode64 @data
@@ -29,7 +27,6 @@ module RubyLLM
       end
     end
 
-    # Saves the image to a file path
     def save(path)
       File.binwrite(File.expand_path(path), to_blob)
       path
@@ -40,14 +37,32 @@ module RubyLLM
                    provider: nil,
                    assume_model_exists: false,
                    size: '1024x1024',
-                   context: nil)
+                   context: nil,
+                   with: nil,
+                   params: {})
       config = context&.config || RubyLLM.config
       model ||= config.default_image_model
       model, provider_instance = Models.resolve(model, provider: provider, assume_exists: assume_model_exists,
                                                        config: config)
       model_id = model.id
 
-      provider_instance.paint(prompt, model: model_id, size:)
+      provider_instance.paint(prompt, model: model_id, size:, with:, params:)
+    end
+
+    def total_cost
+      input_cost + output_cost
+    end
+
+    def model_info
+      @model_info ||= RubyLLM.models.find(model_id)
+    end
+
+    def input_cost
+      usage['input_tokens'] * model_info.input_price_per_million / 1_000_000
+    end
+
+    def output_cost
+      usage['output_tokens'] * model_info.output_price_per_million / 1_000_000
     end
   end
 end

data/lib/ruby_llm/image_attachment.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  # A class representing a file attachment that is an image generated by an LLM.
+  class ImageAttachment < Attachment
+    attr_reader :image, :content, :id, :reasoning_id, :revised_prompt, :partial
+
+    def initialize(data:, mime_type:, model_id:, id: nil, reasoning_id: nil, revised_prompt: nil, partial: false) # rubocop:disable Metrics/ParameterLists
+      super(nil, filename: nil)
+      @image = Image.new(data:, mime_type:, model_id:)
+      @mime_type = mime_type
+      @id = id
+      @reasoning_id = reasoning_id
+      @revised_prompt = revised_prompt
+      @partial = partial || false
+    end
+
+    def image?
+      true
+    end
+
+    def encoded
+      image.data
+    end
+
+    def to_h
+      { type: :image, source: "data:#{image.mime_type};base64,#{encoded}" }
+    end
+  end
+end

data/lib/ruby_llm/message.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  # A single message in a chat conversation. Can represent user input,
-  # AI responses, or tool interactions. Tracks token usage and handles
-  # the complexities of tool calls and responses.
+  # A single message in a chat conversation.
   class Message
     ROLES = %i[system user assistant tool].freeze
 
     attr_reader :role, :tool_calls, :tool_call_id, :input_tokens, :output_tokens, :model_id, :raw,
-                :cached_tokens, :cache_creation_tokens
+                :cached_tokens, :cache_creation_tokens, :reasoning_id
     attr_writer :content
 
     def initialize(options = {})
@@ -21,6 +19,7 @@ module RubyLLM
       @tool_call_id = options[:tool_call_id]
       @cached_tokens = options[:cached_tokens]
       @cache_creation_tokens = options[:cache_creation_tokens]
+      @reasoning_id = options[:reasoning_id]
       @raw = options[:raw]
 
       ensure_valid_role
@@ -49,14 +48,15 @@ module RubyLLM
     def to_h
       {
         role: role,
-        content: content,
+        content: content.is_a?(Content) ? content.to_h : content,
         tool_calls: tool_calls,
         tool_call_id: tool_call_id,
         input_tokens: input_tokens,
         output_tokens: output_tokens,
         model_id: model_id,
         cache_creation_tokens: cache_creation_tokens,
-        cached_tokens: cached_tokens
+        cached_tokens: cached_tokens,
+        reasoning_id: reasoning_id
       }.compact
     end
 
@@ -70,7 +70,7 @@ module RubyLLM
       case content
       when String then Content.new(content)
       when Hash then Content.new(content[:text], content)
-      else content # Pass through nil, Content, or other types
+      else content
       end
     end
 

data/lib/ruby_llm/model/info.rb

@@ -3,18 +3,22 @@
 module RubyLLM
   module Model
     # Information about an AI model's capabilities, pricing, and metadata.
-    # Used by the Models registry to help developers choose the right model
-    # for their needs.
-    #
-    # Example:
-    #   model = RubyLLM.models.find('gpt-4')
-    #   model.supports_vision?          # => true
-    #   model.supports_functions?       # => true
-    #   model.input_price_per_million   # => 30.0
     class Info
       attr_reader :id, :name, :provider, :family, :created_at, :context_window, :max_output_tokens, :knowledge_cutoff,
                   :modalities, :capabilities, :pricing, :metadata
 
+      # Create a default model with assumed capabilities
+      def self.default(model_id, provider)
+        new(
+          id: model_id,
+          name: model_id.tr('-', ' ').capitalize,
+          provider: provider,
+          capabilities: %w[function_calling streaming vision structured_output],
+          modalities: { input: %w[text image], output: %w[text] },
+          metadata: { warning: 'Assuming model exists, capabilities may not be accurate' }
+        )
+      end
+
       def initialize(data)
         @id = data[:id]
         @name = data[:name]
@@ -30,7 +34,6 @@ module RubyLLM
         @metadata = data[:metadata] || {}
       end
 
-      # Capability methods
       def supports?(capability)
         capabilities.include?(capability.to_s)
       end
@@ -41,7 +44,6 @@ module RubyLLM
         end
       end
 
-      # Backward compatibility methods
       def display_name
         name
       end

data/lib/ruby_llm/model/pricing.rb

@@ -3,12 +3,10 @@
 module RubyLLM
   module Model
     # A collection that manages and provides access to different categories of pricing information
-    # (text tokens, images, audio tokens, embeddings)
     class Pricing
       def initialize(data)
         @data = {}
 
-        # Initialize pricing categories
         %i[text_tokens images audio_tokens embeddings].each do |category|
           @data[category] = PricingCategory.new(data[category]) if data[category] && !empty_pricing?(data[category])
         end
@@ -33,7 +31,6 @@ module RubyLLM
       private
 
       def empty_pricing?(data)
-        # Check if all pricing values in this category are zero or nil
         return true unless data
 
         %i[standard batch].each do |tier|

data/lib/ruby_llm/model/pricing_category.rb

@@ -11,7 +11,6 @@ module RubyLLM
         @batch = PricingTier.new(data[:batch] || {}) unless empty_tier?(data[:batch])
       end
 
-      # Shorthand methods that default to standard tier
       def input
         standard&.input_per_million
       end
@@ -24,7 +23,6 @@ module RubyLLM
         standard&.cached_input_per_million
       end
 
-      # Get value for a specific tier
       def [](key)
         key == :batch ? batch : standard
       end

data/lib/ruby_llm/model/pricing_tier.rb

@@ -7,7 +7,6 @@ module RubyLLM
       def initialize(data = {})
         @values = {}
 
-        # Only store non-zero values
         data.each do |key, value|
           @values[key.to_sym] = value if value && value != 0.0
         end