ruby_llm_community 0.0.5 → 1.0.0

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,21 @@
+# 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
+
+    def initialize(data:, mime_type:, model_id:, id: nil, reasoning_id: nil)
+      super(nil, filename: nil)
+      @image = Image.new(data:, mime_type:, model_id:)
+      @content = Base64.strict_decode64(data)
+      @mime_type = mime_type
+      @id = id
+      @reasoning_id = reasoning_id
+    end
+
+    def image?
+      true
+    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
@@ -56,7 +55,8 @@ module RubyLLM
         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