tool_tailor 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b242798d32a1e165bcfee93e5562b97015ad554acdd6837e3ee729b3b27e6ed
-  data.tar.gz: 3a9a097551149899b80e71b00dc936c6942dd213d66d97fb040485aeadd1408d
+  metadata.gz: 33d87f65353ea72f0715a86b7759529f68f6678eb6a24d47fac0547bade1b59e
+  data.tar.gz: 874c949f555e93aa445147d89981e1207e11fdc4520977a668e9724354ca7d95
 SHA512:
-  metadata.gz: 342c3b07cb9ee1b01ead72205ce15b7b1cde92f10b3ba3d16cdfc18114d76c04b6c4bdd64a3a8c10fa0c1c3927248d4b3d7e8586edaca1c0d7e13ac1f49b018e
-  data.tar.gz: 347ff4fe7ab0d29164d48e97a38400e4d8bb7816c81b791baab903ebdc764f8b4fcf97156dc256e56d66d6eddca92185c80740c488889342ffb9efaeabbd8aec
+  metadata.gz: 4500dc6778e3bb5373a4630160b22a2ad7f0669ddb097d221eb93b3f1c27a93b48310ef4fcc434ec2c154ea004beb84d157bd1550d4ada0eb1e8fe7b8daa83da
+  data.tar.gz: 036f48ffa4b31354b24c85392cf52520215afcb02afac201289e19e650f4491be5fa0122aca606fc6d421d833ee2b8a64533b53a5936ea90608d2197caecd2b2

data/Gemfile

@@ -5,3 +5,5 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+
+gem "super_diff", "~> 0.9.0", :group => :test

data/Gemfile.lock

@@ -1,13 +1,17 @@
 PATH
   remote: .
   specs:
-    tool_tailor (0.1.1)
+    tool_tailor (0.1.3)
       yard (~> 0.9.36)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    attr_extras (7.1.0)
     diff-lcs (1.5.1)
+    optimist (3.1.0)
+    patience_diff (1.2.0)
+      optimist (~> 3.0)
     rake (12.3.3)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -22,6 +26,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
+    super_diff (0.9.0)
+      attr_extras (>= 6.2.4)
+      diff-lcs
+      patience_diff
     yard (0.9.36)
 
 PLATFORMS
@@ -30,6 +38,7 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
+  super_diff (~> 0.9.0)
   tool_tailor!
 
 BUNDLED WITH

data/README.md

@@ -26,12 +26,15 @@ class TestClass
   #
   # @param location [String] The city and state, e.g., San Francisco, CA.
   # @param unit [String] The unit of temperature, either 'celsius' or 'fahrenheit'.
-  # @param api_key [Float] The API key for the weather service.
-  def get_current_weather(location, unit = 'celsius', api_key: nil)
+  def get_current_weather(location:, unit: 'celsius')
     # Function implementation goes here
   end
 end
 
+# Simple
+ToolTailor.convert(TestClass.instance_method(:get_current_weather))
+
+# Unbound method with to_json_schema
 TestClass.instance_method(:get_current_weather).to_json_schema # => {
 #   "type" => "function",
 #   "function" => {
@@ -56,6 +59,77 @@ TestClass.instance_method(:get_current_weather).to_json_schema # => {
 #       "required" => ["location", "unit", "api_key"]
 #     }
 #   }
+
+# Bound method with to_json_schema
+example_instance = TestClass.new
+example_instance.method(:get_current_weather).to_json_schema # => {
+#   "type" => "function",
+#   "function" => {
+#     "name" => "get_current_weather",
+#     "description" => "Get the current weather in a given location.",
+#     "parameters" => {
+#       "type" => "object",
+#       "properties" => {
+#         "location" => {
+#           "type" => "string",
+#           "description" => "The city and state, e.g., San Francisco, CA."
+#         },
+#         "unit" => {
+#           "type" => "string",
+#           "description" => "The unit of temperature, either 'celsius' or 'fahrenheit'."
+#         },
+#         "api_key" => {
+#           "type" => "number",
+#           "description" => "The API key for the weather service."
+#         }
+#       },
+#       "required" => ["location", "unit", "api_key"]
+#     }
+#   }
+# }
+```
+
+And with [ruby-openai](https://github.com/alexrudall/ruby-openai):
+
+```rb
+response =
+  client.chat(
+    parameters: {
+      model: "gpt-4o",
+      messages: [
+        {
+          "role": "user",
+          "content": "What is the weather like in San Francisco?",
+        },
+      ],
+      tools: [
+        TestClass.instance_method(:get_current_weather).to_json_schema
+      ],
+      tool_choice: {
+        type: "function",
+        function: {
+          name: "get_current_weather"
+        }
+      }
+    },
+  )
+
+message = response.dig("choices", 0, "message")
+
+if message["role"] == "assistant" && message["tool_calls"]
+  function_name = message.dig("tool_calls", 0, "function", "name")
+  args =
+    JSON.parse(
+      message.dig("tool_calls", 0, "function", "arguments"),
+      { symbolize_names: true },
+    )
+
+  case function_name
+  when "get_current_weather"
+    TestClass.get_current_weather(**args)
+  end
+end
+# => "The weather is nice 🌞"
 ```
 
 ## Development

data/lib/tool_tailor/version.rb

@@ -1,3 +1,3 @@
 module ToolTailor
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/tool_tailor.rb

@@ -1,38 +1,62 @@
 require "tool_tailor/version"
-require 'json'
-require 'yard'
+require "json"
+require "yard"
 
 module ToolTailor
   class Error < StandardError; end
 
   # Converts a function to a JSON schema representation.
   #
-  # @param function [Method] The function to convert.
+  # @param function [Method, UnboundMethod] The function to convert.
   # @return [String] The JSON schema representation of the function.
   # @raise [ArgumentError] If the provided object is not a Method or UnboundMethod.
+  #
+  # @example
+  #   def example_method(param1, param2)
+  #     # method implementation
+  #   end
+  #
+  #   ToolTailor.convert(method(:example_method))
   def self.convert(function)
     unless function.is_a?(Method) || function.is_a?(UnboundMethod)
       raise ArgumentError, "Unsupported object type: #{function.class}"
     end
 
+    # Ensure only named arguments are allowed
+    unless function.parameters.all? { |type, _| type == :keyreq || type == :key }
+      raise ArgumentError, "Only named arguments are supported"
+    end
+
     file_path, line_number = function.source_location
     YARD.parse(file_path)
 
-    # Construct the correct identifier for the YARD object
     method_path = "#{function.owner}##{function.name}"
     yard_object = YARD::Registry.at(method_path)
-    raise "Documentation for #{method_path} not found." if yard_object.nil?
-
-    function_description = yard_object.docstring
 
-    parameters = yard_object.tags('param').map do |tag|
+    # Extract parameters from the function definition
+    parameters = function.parameters.map do |_, name|
       {
-        name: tag.name,
-        type: type_mapping(tag.types.first),
-        description: tag.text
+        name: name.to_s,
+        type: "string",
+        description: ""
       }
     end
 
+    function_description = ""
+
+    if yard_object
+      function_description = yard_object.docstring
+
+      yard_object.tags("param").each do |tag|
+        param_name = tag.name.chomp(':')
+        param = parameters.find { |p| p[:name] == param_name }
+        if param
+          param[:type] = type_mapping(tag.types.first)
+          param[:description] = tag.text
+        end
+      end
+    end
+
     {
       type: "function",
       function: {
@@ -49,7 +73,7 @@ module ToolTailor
               }
             ]
           end.to_h,
-          required: parameters.map { |param| param[:name].to_s }
+          required: function.parameters.select { |type, _| type == :keyreq }.map { |_, name| name.to_s }
         }
       }
     }.to_json
@@ -57,33 +81,101 @@ module ToolTailor
 
   # Maps Ruby types to JSON schema types.
   #
-  # @param type [Class] The Ruby type to map.
+  # @param type [String] The Ruby type to map.
   # @return [String] The corresponding JSON schema type.
   # @raise [ArgumentError] If the provided type is not supported.
   def self.type_mapping(type)
     case type
-    when "String"
-      'string'
-    when "Integer"
-      'integer'
-    when "Float"
-      'number'
-    when "TrueClass", "FalseClass"
-      'boolean'
-    when "Array"
-      'array'
-    when "Hash"
-      'object'
-    when "NilClass"
-      'null'
+    when "String"    then "string"
+    when "Integer"   then "integer"
+    when "Float"     then "number"
+    when "TrueClass", "FalseClass" then "boolean"
+    when "Array"     then "array"
+    when "Hash"      then "object"
+    when "NilClass"  then "null"
     else
-      # raise ArgumentError, "Unsupported type: #{type} #{type.class}"
-      'string'
+      raise ArgumentError, "Unsupported type: #{type} #{type.class}"
     end
   end
 end
 
 class UnboundMethod
+  # Converts an UnboundMethod to a JSON schema.
+  #
+  # @example
+  #   class ExampleClass
+  #     # @param name [String] The name of the person.
+  #     # @param age [Integer] The age of the person.
+  #     def greet(name, age)
+  #       puts "Hello, #{name}! You are #{age} years old."
+  #     end
+  #   end
+  #
+  #   ExampleClass.instance_method(:greet).to_json_schema
+  #   # => {
+  #   #   "type" => "function",
+  #   #   "function" => {
+  #   #     "name" => "greet",
+  #   #     "description" => "",
+  #   #     "parameters" => {
+  #   #       "type" => "object",
+  #   #       "properties" => {
+  #   #         "name" => {
+  #   #           "type" => "string",
+  #   #           "description" => "The name of the person."
+  #   #         },
+  #   #         "age" => {
+  #   #           "type" => "integer",
+  #   #           "description" => "The age of the person."
+  #   #         }
+  #   #       },
+  #   #       "required" => ["name", "age"]
+  #   #     }
+  #   #   }
+  #   # }
+  #
+  # @return [String] The JSON schema representation of the method.
+  def to_json_schema
+    ToolTailor.convert(self)
+  end
+end
+
+class Method
+  # Converts a Method to a JSON schema.
+  #
+  # @example
+  #   class ExampleClass
+  #     # @param name [String] The name of the person.
+  #     # @param age [Integer] The age of the person.
+  #     def greet(name, age)
+  #       puts "Hello, #{name}! You are #{age} years old."
+  #     end
+  #   end
+  #
+  #   ExampleClass.new.method(:greet).to_json_schema
+  #   # => {
+  #   #   "type" => "function",
+  #   #   "function" => {
+  #   #     "name" => "greet",
+  #   #     "description" => "",
+  #   #     "parameters" => {
+  #   #       "type" => "object",
+  #   #       "properties" => {
+  #   #         "name" => {
+  #   #           "type" => "string",
+  #   #           "description" => "The name of the person."
+  #   #         },
+  #   #         "age" => {
+  #   #           "type" => "integer",
+  #   #           "description" => "The age of the person."
+  #   #         }
+  #   #       },
+  #   #       "required" => ["name", "age"]
+  #   #     }
+  #   #   }
+  #   # }
+  #
+  # @return [String] The JSON schema representation of the method.
   def to_json_schema
     ToolTailor.convert(self)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tool_tailor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Kieran Klaassen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard