ruby_llm 0.1.0.pre11 → 0.1.0.pre12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed2ff977d45e5ac9a14d93b81740516f14f6c4ef33140e0163f6011efa14d697
-  data.tar.gz: a51b24bd4e88512d9abb3d4db33551bd391da97fa8161f8f6d1b23e415f427d1
+  metadata.gz: 70c8538fcfbdaba0d5bbb502affe66acfc38c5f67318ee69fe9dc203dbc4e7f7
+  data.tar.gz: 51a0759de14ee600876471dd034e0ff99b3763d765fd3b81eadfe4dacbd3f7e5
 SHA512:
-  metadata.gz: ff245f6f9378b51481a096b63a4c5cb688cf80e3b5d218a9e0ff5ca74a0ac09c720a8647df8f8fe9603ee10d9b3b61e4704638d81051c1378694bff47f272e7f
-  data.tar.gz: 8fae7e20c68130cabc9d769a82b5b3a94d765b2cb53804a2df7833c402da37c6c781bcaaf477cb41a0b610026bfa57fee2670029793526c4375dee3731bc4bf3
+  metadata.gz: 3b5a3362b20ffb9153f9668612a0b6fde3fdf040d7234baee08978cdcc60717fce0cf8a0950929e0ab384db0fe9cfd82456e0a3c4f6eaba566999c80f32fc941
+  data.tar.gz: 6f12660ca79c9d00196003c15bc866b831e47bbce52fc6d6f2ad731655b8e6243388ad4637d7b3c45cb1076c489fa6a8ca9973da20230cbc16b756782917056c

data/README.md

@@ -79,7 +79,7 @@ puts "Conversation used #{last_message.input_tokens} input tokens and #{last_mes
 
 ## Using Tools
 
-Give Claude some Ruby superpowers by letting it call your code. Simply create a tool class:
+Give Claude some Ruby superpowers by letting it call your code. Simply create tool classes that do one thing well:
 
 ```ruby
 class CalculatorTool < RubyLLM::Tool
@@ -94,22 +94,44 @@ class CalculatorTool < RubyLLM::Tool
     eval(expression).to_s
   end
 end
+
+class DocumentSearchTool < RubyLLM::Tool
+  description "Searches documents by similarity"
+
+  param :query,
+    type: :string,
+    desc: "The search query"
+
+  param :limit,
+    type: :integer,
+    desc: "Number of results to return",
+    required: false
+
+  def initialize(document_class:)
+    @document_class = document_class
+  end
+
+  def execute(query:, limit: 5)
+    @document_class.similarity_search(query:, k: limit)
+  end
+end
 ```
 
-Then use it in your conversations:
+Then use them in your conversations:
 
 ```ruby
-chat = RubyLLM.chat.with_tool(CalculatorTool)
+# Simple tools just work
+chat = RubyLLM.chat.with_tool(CalculatorTool.new)
+
+# Tools with dependencies are just regular Ruby objects
+search = DocumentSearchTool.new(document_class: Document)
+chat.with_tools(search, CalculatorTool.new)
 
-# Claude will automatically use the calculator when appropriate
 chat.ask "What's 2+2?"
 # => "Let me calculate that for you. The result is 4."
 
-chat.ask "If I have 3 apples and multiply them by 5, how many do I have?"
-# => "Let me help you calculate that. 3 × 5 = 15, so you would have 15 apples."
-
-# Add multiple tools
-chat.with_tools(CalculatorTool, WeatherTool, DatabaseTool)
+chat.ask "Find documents about Ruby performance"
+# => "I found these relevant documents about Ruby performance..."
 ```
 
 Tools let you seamlessly integrate your Ruby code with AI capabilities. The model will automatically decide when to use your tools and handle the results appropriately.

data/lib/ruby_llm/tool.rb

@@ -1,7 +1,17 @@
 # frozen_string_literal: true
 
-# lib/ruby_llm/tool.rb
 module RubyLLM
+  class Parameter
+    attr_reader :name, :type, :description, :required
+
+    def initialize(name, type: 'string', desc: nil, required: true)
+      @name = name
+      @type = type
+      @description = desc
+      @required = required
+    end
+  end
+
   class Tool
     class << self
       def description(text = nil)
@@ -10,51 +20,34 @@ module RubyLLM
         @description = text
       end
 
-      def param(name, type:, desc: nil, required: true)
-        param = Parameter.new(
-          name,
-          type: type.to_s,
-          description: desc,
-          required: required
-        )
-        parameters[name] = param
+      def param(name, **options)
+        parameters[name] = Parameter.new(name, **options)
       end
 
       def parameters
         @parameters ||= {}
       end
+    end
 
-      def name
-        super
+    def name
+      self.class.name
           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
           .downcase
           .delete_suffix('_tool')
-      end
-
-      def to_tool
-        tool_instance = new
-
-        def tool_instance.name
-          self.class.name
-        end
-
-        def tool_instance.description
-          self.class.description
-        end
+    end
 
-        def tool_instance.parameters
-          self.class.parameters
-        end
+    def description
+      self.class.description
+    end
 
-        tool_instance
-      end
+    def parameters
+      self.class.parameters
     end
 
     def call(args)
       RubyLLM.logger.debug "Tool #{name} called with: #{args.inspect}"
-      symbolized_args = args.transform_keys(&:to_sym)
-      result = execute(**symbolized_args)
+      result = execute(**args.transform_keys(&:to_sym))
       RubyLLM.logger.debug "Tool #{name} returned: #{result.inspect}"
       result
     rescue StandardError => e
@@ -62,28 +55,8 @@ module RubyLLM
       { error: e.message }
     end
 
-    def execute(args)
+    def execute(...)
       raise NotImplementedError, 'Subclasses must implement #execute'
     end
   end
-
-  # Using the existing Parameter class from Tool.rb
-  class Parameter
-    attr_reader :name, :type, :description, :required
-
-    def initialize(name, type: 'string', description: nil, required: true)
-      @name = name
-      @type = type
-      @description = description
-      @required = required
-    end
-
-    def to_h
-      {
-        type: type,
-        description: description,
-        required: required
-      }.compact
-    end
-  end
 end

data/lib/ruby_llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  VERSION = '0.1.0.pre11'
+  VERSION = '0.1.0.pre12'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre11
+  version: 0.1.0.pre12
 platform: ruby
 authors:
 - Carmine Paolino