llm.rb 1.0.1 → 2.0.0

data/lib/llm/providers/gemini/stream_parser.rb

@@ -40,47 +40,68 @@ class LLM::Gemini
       end
     end
 
-    def merge_candidates!(new_candidates_list)
-      new_candidates_list.each do |new_candidate_delta|
-        index = new_candidate_delta.index
+    def merge_candidates!(deltas)
+      deltas.each do |delta|
+        index = delta.index
         @body.candidates[index] ||= LLM::Object.from_hash({content: {parts: []}})
-        existing_candidate = @body.candidates[index]
-        new_candidate_delta.each do |key, value|
+        candidate = @body.candidates[index]
+        delta.each do |key, value|
           if key.to_s == "content"
-            merge_candidate_content!(existing_candidate.content, value) if value
+            merge_candidate_content!(candidate.content, value) if value
           else
-            existing_candidate[key] = value # Overwrite other fields
+            candidate[key] = value # Overwrite other fields
           end
         end
       end
     end
 
-    def merge_candidate_content!(existing_content, new_content_delta)
-      new_content_delta.each do |key, value|
+    def merge_candidate_content!(content, delta)
+      delta.each do |key, value|
         if key.to_s == "parts"
-          existing_content.parts ||= []
-          merge_content_parts!(existing_content.parts, value) if value
+          content.parts ||= []
+          merge_content_parts!(content.parts, value) if value
         else
-          existing_content[key] = value
+          content[key] = value
         end
       end
     end
 
-    def merge_content_parts!(existing_parts, new_parts_delta)
-      new_parts_delta.each do |new_part_delta|
-        if new_part_delta.text
-          last_existing_part = existing_parts.last
-          if last_existing_part&.text
-            last_existing_part.text << new_part_delta.text
-            @io << new_part_delta.text if @io.respond_to?(:<<)
-          else
-            existing_parts << new_part_delta
-            @io << new_part_delta.text if @io.respond_to?(:<<)
-          end
-        elsif new_part_delta.functionCall
-          existing_parts << new_part_delta
+    def merge_content_parts!(parts, deltas)
+      deltas.each do |delta|
+        if delta.text
+          merge_text!(parts, delta)
+        elsif delta.functionCall
+          merge_function_call!(parts, delta)
+        elsif delta.inlineData
+          parts << delta
+        elsif delta.functionResponse
+          parts << delta
+        elsif delta.fileData
+          parts << delta
         end
       end
     end
+
+    def merge_text!(parts, delta)
+      last_existing_part = parts.last
+      if last_existing_part&.text
+        last_existing_part.text << delta.text
+        @io << delta.text if @io.respond_to?(:<<)
+      else
+        parts << delta
+        @io << delta.text if @io.respond_to?(:<<)
+      end
+    end
+
+    def merge_function_call!(parts, delta)
+      last_existing_part = parts.last
+      if last_existing_part&.functionCall
+        last_existing_part.functionCall = LLM::Object.from_hash(
+          last_existing_part.functionCall.to_h.merge(delta.functionCall.to_h)
+        )
+      else
+        parts << delta
+      end
+    end
   end
 end

data/lib/llm/providers/ollama/format/completion_format.rb

@@ -12,7 +12,7 @@ module LLM::Ollama::Format
     end
 
     ##
-    # Returns the message for the Ollama chat completions API
+    # Formats the message for the Ollama chat completions API
     # @return [Hash]
     def format
       catch(:abort) do
@@ -28,26 +28,16 @@ module LLM::Ollama::Format
 
     def format_content(content)
       case content
-      when File
-        content.close unless content.closed?
-        format_content(LLM.File(content.path))
-      when LLM::File
-        if content.image?
-          {content: "This message has an image associated with it", images: [content.to_b64]}
-        else
-          raise LLM::PromptError, "The given object (an instance of #{content.class}) " \
-                                  "is not an image, and therefore not supported by the " \
-                                  "Ollama API"
-        end
       when String
         {content:}
       when LLM::Message
         format_content(content.content)
       when LLM::Function::Return
         throw(:abort, {role: "tool", tool_call_id: content.id, content: JSON.dump(content.value)})
+      when LLM::Object
+        format_object(content)
       else
-        raise LLM::PromptError, "The given object (an instance of #{content.class}) " \
-                                "is not supported by the Ollama API"
+        prompt_error!(content)
       end
     end
 
@@ -70,6 +60,35 @@ module LLM::Ollama::Format
       end
     end
 
+    def format_object(object)
+      case object.kind
+      when :local_file then format_local_file(object.value)
+      when :remote_file then prompt_error!(object)
+      when :image_url then prompt_error!(object)
+      else prompt_error!(object)
+      end
+    end
+
+    def format_local_file(file)
+      if file.image?
+        {content: "This message has an image associated with it", images: [file.to_b64]}
+      else
+        raise LLM::PromptError, "The given local file (an instance of #{file.class}) " \
+                                "is not an image, and therefore not supported by the " \
+                                "Ollama API"
+      end
+    end
+
+    def prompt_error!(object)
+      if LLM::Object === object
+        raise LLM::PromptError, "The given LLM::Object with kind '#{content.kind}' is not " \
+                                "supported by the Ollama API"
+      else
+        raise LLM::PromptError, "The given object (an instance of #{object.class}) " \
+                                "is not supported by the Ollama API"
+      end
+    end
+
     def message = @message
     def content = message.content
     def returns = content.grep(LLM::Function::Return)

data/lib/llm/providers/openai/format/completion_format.rb

@@ -28,19 +28,33 @@ module LLM::OpenAI::Format
 
     private
 
+    def format_message
+      case content
+      when Array
+        format_array
+      else
+        {role: message.role, content: format_content(content)}
+      end
+    end
+
+    def format_array
+      if content.empty?
+        nil
+      elsif returns.any?
+        returns.map { {role: "tool", tool_call_id: _1.id, content: JSON.dump(_1.value)} }
+      else
+        {role: message.role, content: content.flat_map { format_content(_1) }}
+      end
+    end
+
     def format_content(content)
       case content
-      when URI
-        [{type: :image_url, image_url: {url: content.to_s}}]
-      when File
-        content.close unless content.closed?
-        format_content(LLM.File(content.path))
-      when LLM::File
-        format_file(content)
-      when LLM::Response
-        content.file? ? [{type: :file, file: {file_id: content.id}}] : prompt_error!(content)
+      when LLM::Object
+        format_object(content)
       when String
         [{type: :text, text: content.to_s}]
+      when LLM::Response
+        format_remote_file(content)
       when LLM::Message
         format_content(content.content)
       when LLM::Function::Return
@@ -50,37 +64,43 @@ module LLM::OpenAI::Format
       end
     end
 
-    def format_file(content)
-      file = content
-      if file.image?
-        [{type: :image_url, image_url: {url: file.to_data_uri}}]
+    def format_object(object)
+      case object.kind
+      when :image_url
+        [{type: :image_url, image_url: {url: object.value}}]
+      when :local_file
+        format_local_file(object.value)
+      when :remote_file
+        format_remote_file(object.value)
       else
-        [{type: :file, file: {filename: file.basename, file_data: file.to_data_uri}}]
+        prompt_error!(object)
       end
     end
 
-    def format_message
-      case content
-      when Array
-        format_array
+    def format_local_file(file)
+      if file.image?
+        [{type: :image_url, image_url: {url: file.to_data_uri}}]
       else
-        {role: message.role, content: format_content(content)}
+        [{type: :file, file: {filename: file.basename, file_data: file.to_data_uri}}]
       end
     end
 
-    def format_array
-      if content.empty?
-        nil
-      elsif returns.any?
-        returns.map { {role: "tool", tool_call_id: _1.id, content: JSON.dump(_1.value)} }
+    def format_remote_file(file)
+      if file.file?
+        [{type: :file, file: {file_id: file.id}}]
       else
-        {role: message.role, content: content.flat_map { format_content(_1) }}
+        prompt_error!(file)
       end
     end
 
     def prompt_error!(content)
-      raise LLM::PromptError, "The given object (an instance of #{content.class}) " \
-                              "is not supported by the OpenAI chat completions API"
+      if LLM::Object === content
+        raise LLM::PromptError, "The given LLM::Object with kind '#{content.kind}' is not " \
+                                "supported by the OpenAI chat completions API."
+      else
+        raise LLM::PromptError, "The given object (an instance of #{content.class}) " \
+                                "is not supported by the OpenAI chat completions API."
+      end
     end
 
     def message = @message

data/lib/llm/providers/openai/format/respond_format.rb

@@ -4,6 +4,9 @@ module LLM::OpenAI::Format
   ##
   # @private
   class RespondFormat
+    ##
+    # @param [LLM::Message] message
+    #  The message to format
     def initialize(message)
       @message = message
     end
@@ -22,12 +25,17 @@ module LLM::OpenAI::Format
 
     def format_content(content)
       case content
-      when LLM::Response
-        content.file? ? format_file(content) : prompt_error!(content)
       when String
         [{type: :input_text, text: content.to_s}]
-      when LLM::Message
-        format_content(content.content)
+      when LLM::Response then format_remote_file(content)
+      when LLM::Message then format_content(content.content)
+      when LLM::Object
+        case content.kind
+        when :image_url then [{type: :image_url, image_url: {url: content.value.to_s}}]
+        when :remote_file then format_remote_file(content.value)
+        when :local_file then prompt_error!(content)
+        else prompt_error!(content)
+        end
       else
         prompt_error!(content)
       end
@@ -52,7 +60,8 @@ module LLM::OpenAI::Format
       end
     end
 
-    def format_file(content)
+    def format_remote_file(content)
+      prompt_error!(content) unless content.file?
       file = LLM::File(content.filename)
       if file.image?
         [{type: :input_image, file_id: content.id}]
@@ -62,9 +71,15 @@ module LLM::OpenAI::Format
     end
 
     def prompt_error!(content)
-      raise LLM::PromptError, "The given object (an instance of #{content.class}) " \
-                              "is not supported by the OpenAI responses API"
+      if LLM::Object === content
+        raise LLM::PromptError, "The given LLM::Object with kind '#{content.kind}' is not " \
+                                "supported by the OpenAI responses API."
+      else
+        raise LLM::PromptError, "The given object (an instance of #{content.class}) " \
+                                "is not supported by the OpenAI responses API"
+      end
     end
+
     def message = @message
     def content = message.content
     def returns = content.grep(LLM::Function::Return)

data/lib/llm/schema/object.rb

@@ -7,22 +7,43 @@ class LLM::Schema
   # {LLM::Schema::Leaf LLM::Schema::Leaf} and provides methods that
   # can act as constraints.
   class Object < Leaf
+    ##
+    # @return [Hash]
+    attr_reader :properties
+
+    ##
+    # @param params [Hash]
+    #  A hash of properties
+    # @return [LLM::Schema::Object]
     def initialize(properties)
       @properties = properties
     end
 
+    ##
+    # @return [Hash]
     def to_h
       super.merge!({type: "object", properties:, required:})
     end
 
+    ##
+    # @raise [TypeError]
+    #  When given an object other than Object
+    # @return [LLM::Schema::Object]
+    #  Returns self
+    def merge!(other)
+      raise TypeError, "expected #{self.class} but got #{other.class}" unless self.class === other
+      @properties.merge!(other.properties)
+      self
+    end
+
+    ##
+    # @return [String]
     def to_json(options = {})
       to_h.to_json(options)
     end
 
     private
 
-    attr_reader :properties
-
     def required
       @properties.filter_map {  _2.required? ? _1 : nil }
     end

data/lib/llm/tool/param.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+class LLM::Tool
+  ##
+  # The {LLM::Tool::Param LLM::Tool::Param} module extends the
+  # {LLM::Tool LLM::Tool} class with a "param" method that can
+  # define a parameter for simple types. For complex types, use
+  # {LLM::Tool.params LLM::Tool.params} instead.
+  #
+  # @example
+  #   class Greeter < LLM::Tool
+  #     name "greeter"
+  #     description "Greets the user"
+  #     param :name, String, "The user's name", required: true
+  #
+  #     def call(name:)
+  #       puts "Hello, #{name}!"
+  #     end
+  #   end
+  module Param
+    ##
+    # @param name [Symbol]
+    #   The name of a parameter
+    # @param type [Class, Symbol]
+    #   The parameter type (eg String)
+    # @param description [String]
+    #   The description of a property
+    # @param options [Hash]
+    #   A hash of options for the parameter
+    # @option options [Boolean] :required
+    #   Whether or not the parameter is required
+    # @option options [Object] :default
+    #   The default value for a given property
+    # @option options [Array<String>] :enum
+    #   One or more possible values for a param
+    def param(name, type, description, options = {})
+      lock do
+        function.params do |schema|
+          leaf = schema.public_send(Utils.resolve(type))
+          leaf = Utils.setup(leaf, description, options)
+          schema.object(name => leaf)
+        end
+      end
+    end
+
+    ##
+    # @api private
+    module Utils
+      extend self
+
+      def resolve(type)
+        if type == String
+          :string
+        elsif type == Integer
+          :integer
+        elsif type == Float
+          :number
+        else
+          type
+        end
+      end
+
+      def setup(leaf, description, options)
+        required = options.fetch(:required, false)
+        default = options.fetch(:default, nil)
+        enum = options.fetch(:enum, nil)
+        leaf.required if required
+        leaf.description(description) if description
+        leaf.default(default) if default
+        leaf.enum(enum) if enum
+        leaf
+      end
+    end
+  end
+end

data/lib/llm/tool.rb

@@ -18,6 +18,9 @@
 #     end
 #   end
 class LLM::Tool
+  require_relative "tool/param"
+  extend LLM::Tool::Param
+
   ##
   # Registers the tool as a function when inherited
   # @param [Class] klass The subclass
@@ -35,7 +38,7 @@ class LLM::Tool
   # @return [String]
   def self.name(name = nil)
     lock do
-      function.tap { _1.name(name) }
+      name ? function.name(name) : function.name
     end
   end
 
@@ -45,7 +48,7 @@ class LLM::Tool
   # @return [String]
   def self.description(desc = nil)
     lock do
-      function.tap { _1.description(desc) }
+      desc ? function.description(desc) : function.description
     end
   end
 

data/lib/llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LLM
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/lib/llm.rb

@@ -2,6 +2,7 @@
 
 module LLM
   require "stringio"
+  require_relative "llm/builder"
   require_relative "llm/schema"
   require_relative "llm/object"
   require_relative "llm/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Antar Azri
@@ -179,11 +179,8 @@ files:
 - README.md
 - lib/llm.rb
 - lib/llm/bot.rb
-- lib/llm/bot/builder.rb
-- lib/llm/bot/conversable.rb
-- lib/llm/bot/prompt/completion.rb
-- lib/llm/bot/prompt/respond.rb
 - lib/llm/buffer.rb
+- lib/llm/builder.rb
 - lib/llm/client.rb
 - lib/llm/error.rb
 - lib/llm/eventhandler.rb
@@ -278,6 +275,7 @@ files:
 - lib/llm/schema/version.rb
 - lib/llm/server_tool.rb
 - lib/llm/tool.rb
+- lib/llm/tool/param.rb
 - lib/llm/utils.rb
 - lib/llm/version.rb
 - llm.gemspec

data/lib/llm/bot/builder.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Bot
-  ##
-  # @private
-  module Builder
-    private
-
-    ##
-    # @param [String] prompt The prompt
-    # @param [Hash] params
-    # @return [LLM::Response]
-    def create_response!(prompt, params)
-      @provider.responses.create(
-        prompt,
-        @params.merge(params.merge(@response ? {previous_response_id: @response.id} : {}))
-      )
-    end
-
-    ##
-    # @param [String] prompt The prompt
-    # @param [Hash] params
-    # @return [LLM::Response]
-    def create_completion!(prompt, params)
-      @provider.complete(
-        prompt,
-        @params.merge(params.merge(messages:))
-      )
-    end
-  end
-end

data/lib/llm/bot/conversable.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Bot
-  ##
-  # @private
-  module Conversable
-    private
-
-    ##
-    # Queues a response to be sent to the provider.
-    # @param [String] prompt The prompt
-    # @param [Hash] params
-    # @return [void]
-    def async_response(prompt, params = {})
-      if Array === prompt and prompt.empty?
-        @messages
-      else
-        role = params.delete(:role)
-        @messages << [LLM::Message.new(role, prompt), @params.merge(params), :respond]
-      end
-    end
-
-    ##
-    # Queues a completion to be sent to the provider.
-    # @param [String] prompt The prompt
-    # @param [Hash] params
-    # @return [void]
-    def async_completion(prompt, params = {})
-      if Array === prompt and prompt.empty?
-        @messages
-      else
-        role = params.delete(:role)
-        @messages << [LLM::Message.new(role, prompt), @params.merge(params), :complete]
-      end
-    end
-  end
-end

data/lib/llm/bot/prompt/completion.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module LLM::Bot::Prompt
-  class Completion < Struct.new(:bot, :defaults)
-    ##
-    # @param [LLM::Bot] bot
-    # @param [Hash] defaults
-    # @return [LLM::Bot::Prompt::Completion]
-    def initialize(bot, defaults)
-      super(bot, defaults || {})
-    end
-
-    ##
-    # @param [String] prompt
-    # @param [Hash] params (see LLM::Provider#complete)
-    # @return [LLM::Bot]
-    def system(prompt, params = {})
-      params = defaults.merge(params)
-      bot.chat prompt, params.merge(role: :system)
-    end
-
-    ##
-    # @param [String] prompt
-    # @param [Hash] params (see LLM::Provider#complete)
-    # @return [LLM::Bot]
-    def user(prompt, params = {})
-      params = defaults.merge(params)
-      bot.chat prompt, params.merge(role: :user)
-    end
-
-    ##
-    # @param [String] prompt
-    # @param [Hash] params (see LLM::Provider#complete)
-    # @return [LLM::Bot]
-    def assistant(prompt, params = {})
-      params = defaults.merge(params)
-      bot.chat prompt, params.merge(role: :assistant)
-    end
-
-    ##
-    # @param [String] prompt
-    # @param [Hash] params (see LLM::Provider#complete)
-    # @return [LLM::Bot]
-    def model(prompt, params = {})
-      params = defaults.merge(params)
-      bot.chat prompt, params.merge(role: :model)
-    end
-  end
-end