tool_tailor 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d87f65353ea72f0715a86b7759529f68f6678eb6a24d47fac0547bade1b59e
-  data.tar.gz: 874c949f555e93aa445147d89981e1207e11fdc4520977a668e9724354ca7d95
+  metadata.gz: 840fcc0f9e8a7f5ccd4db0d8f4a8d88f2f344225d8f759442dc11f625d243300
+  data.tar.gz: 53289290ee809ea4e18acf08de8115d4c259b337823fd9ad506de6c335eb12db
 SHA512:
-  metadata.gz: 4500dc6778e3bb5373a4630160b22a2ad7f0669ddb097d221eb93b3f1c27a93b48310ef4fcc434ec2c154ea004beb84d157bd1550d4ada0eb1e8fe7b8daa83da
-  data.tar.gz: 036f48ffa4b31354b24c85392cf52520215afcb02afac201289e19e650f4491be5fa0122aca606fc6d421d833ee2b8a64533b53a5936ea90608d2197caecd2b2
+  metadata.gz: 682eea6fb802c1a1444cafbe077577594cd682c7e02071313b56c7e737c738575b82098cbc6a4a63287edf449a0cd0aed9c4dcb225386350e4b2653270dac585
+  data.tar.gz: 8606a2abd5309a6ab9f7d7fdfa1910c953d674708aa9dce5c2e9fee29168f979632b3f4b8567dd2c5aba68d6fdfc18a2aebc000f464d63f20cc005c7c0452925

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tool_tailor (0.1.3)
+    tool_tailor (0.2.0)
       yard (~> 0.9.36)
 
 GEM

data/README.md

@@ -1,6 +1,6 @@
 # ToolTailor
 
-ToolTailor is a Ruby gem that converts methods to OpenAI JSON schemas for use with tools, making it easier to integrate with OpenAI's API.
+ToolTailor is a Ruby gem that converts methods and classes to OpenAI JSON schemas for use with tools, making it easier to integrate with OpenAI's API.
 
 ## Installation
 
@@ -20,8 +20,12 @@ Or install it yourself as:
 
 ## Usage
 
-```rb
-class TestClass
+ToolTailor can convert both methods and classes to JSON schemas:
+
+### Converting Methods
+
+```ruby
+class WeatherService
   # Get the current weather in a given location.
   #
   # @param location [String] The city and state, e.g., San Francisco, CA.
@@ -31,105 +35,100 @@ class TestClass
   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" => {
-#     "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"]
-#     }
-#   }
-
-# 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"]
-#     }
-#   }
-# }
+# Convert an instance method
+schema = ToolTailor.convert(WeatherService.instance_method(:get_current_weather))
+
+# Using to_json_schema on an unbound method
+schema = WeatherService.instance_method(:get_current_weather).to_json_schema
+
+# Using to_json_schema on a bound method
+weather_service = WeatherService.new
+schema = weather_service.method(:get_current_weather).to_json_schema
+```
+
+### Converting Classes
+
+When passing a class, ToolTailor assumes you want to use the `new` method and generates the schema based on the `initialize` method:
+
+```ruby
+class User
+  # Create a new user
+  #
+  # @param name [String] The user's name
+  # @param age [Integer] The user's age
+  def initialize(name:, age:)
+    @name = name
+    @age = age
+  end
+end
+
+# Convert a class
+schema = ToolTailor.convert(User)
+
+# or
+schema = User.to_json_schema
+
+# This is equivalent to:
+schema = ToolTailor.convert(User.instance_method(:initialize))
 ```
 
-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?",
+The resulting schema will look like this:
+
+```ruby
+{
+  "type" => "function",
+  "function" => {
+    "name" => "User",
+    "description" => "Create a new user",
+    "parameters" => {
+      "type" => "object",
+      "properties" => {
+        "name" => {
+          "type" => "string",
+          "description" => "The user's name"
         },
-      ],
-      tools: [
-        TestClass.instance_method(:get_current_weather).to_json_schema
-      ],
-      tool_choice: {
-        type: "function",
-        function: {
-          name: "get_current_weather"
+        "age" => {
+          "type" => "integer",
+          "description" => "The user's age"
         }
-      }
-    },
-  )
+      },
+      "required" => ["name", "age"]
+    }
+  }
+}
+```
+
+### Using with ruby-openai
+
+Here's an example of how to use ToolTailor with the [ruby-openai](https://github.com/alexrudall/ruby-openai) gem:
+
+```ruby
+response = client.chat(
+  parameters: {
+    model: "gpt-4",
+    messages: [
+      { role: "user", content: "Create a user named Alice who is 30 years old" }
+    ],
+    tools: [ToolTailor.convert(User)],
+    tool_choice: { type: "function", function: { name: "User" } }
+  }
+)
 
 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 },
-    )
+  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)
+  when "User"
+    user = User.new(**args)
+    puts "Created user: #{user.name}, age #{user.age}"
   end
 end
-# => "The weather is nice 🌞"
 ```
 
 ## Development
@@ -140,10 +139,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tool_tailor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tool_tailor/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/kieranklaassen/tool_tailor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kieranklaassen/tool_tailor/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
+
+Everyone interacting in the ToolTailor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kieranklaassen/tool_tailor/blob/master/CODE_OF_CONDUCT.md).

data/lib/tool_tailor/version.rb

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

data/lib/tool_tailor.rb

@@ -5,36 +5,56 @@ require "yard"
 module ToolTailor
   class Error < StandardError; end
 
-  # Converts a function to a JSON schema representation.
+  # Converts a function or class to a JSON schema representation.
   #
-  # @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.
+  # @param object [Method, UnboundMethod, Class] The function or class to convert.
+  # @return [String] The JSON schema representation of the function or class.
+  # @raise [ArgumentError] If the provided object is not a Method, UnboundMethod, or Class.
   #
   # @example
-  #   def example_method(param1, param2)
+  #   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}"
+  #
+  # @example
+  #   class ExampleClass
+  #     def initialize(param1:, param2:)
+  #       # initialization
+  #     end
+  #   end
+  #
+  #   ToolTailor.convert(ExampleClass)
+  def self.convert(object)
+    case object
+    when Method, UnboundMethod
+      convert_method(object)
+    when Class
+      convert_class(object)
+    else
+      raise ArgumentError, "Unsupported object type: #{object.class}"
     end
+  end
 
+  # Converts a method to a JSON schema representation.
+  #
+  # @param method [Method, UnboundMethod] The method to convert.
+  # @return [String] The JSON schema representation of the method.
+  def self.convert_method(method)
     # Ensure only named arguments are allowed
-    unless function.parameters.all? { |type, _| type == :keyreq || type == :key }
+    unless method.parameters.all? { |type, _| type == :keyreq || type == :key }
       raise ArgumentError, "Only named arguments are supported"
     end
 
-    file_path, line_number = function.source_location
+    file_path, line_number = method.source_location
     YARD.parse(file_path)
 
-    method_path = "#{function.owner}##{function.name}"
+    method_path = "#{method.owner}##{method.name}"
     yard_object = YARD::Registry.at(method_path)
 
-    # Extract parameters from the function definition
-    parameters = function.parameters.map do |_, name|
+    # Extract parameters from the method definition
+    parameters = method.parameters.map do |_, name|
       {
         name: name.to_s,
         type: "string",
@@ -42,10 +62,10 @@ module ToolTailor
       }
     end
 
-    function_description = ""
+    method_description = ""
 
     if yard_object
-      function_description = yard_object.docstring
+      method_description = yard_object.docstring
 
       yard_object.tags("param").each do |tag|
         param_name = tag.name.chomp(':')
@@ -60,8 +80,8 @@ module ToolTailor
     {
       type: "function",
       function: {
-        name: function.name.to_s,
-        description: function_description,
+        name: method.name.to_s,
+        description: method_description,
         parameters: {
           type: "object",
           properties: parameters.map do |param|
@@ -73,12 +93,29 @@ module ToolTailor
               }
             ]
           end.to_h,
-          required: function.parameters.select { |type, _| type == :keyreq }.map { |_, name| name.to_s }
+          required: method.parameters.select { |type, _| type == :keyreq }.map { |_, name| name.to_s }
         }
       }
     }.to_json
   end
 
+  def self.convert_class(klass)
+    initialize_method = klass.instance_method(:initialize)
+    schema = JSON.parse(convert_method(initialize_method))
+    schema["function"]["name"] = klass.name
+
+    # Re-parse YARD documentation for the class
+    file_path, _ = initialize_method.source_location
+    YARD.parse(file_path)
+    class_object = YARD::Registry.at(klass.name)
+
+    if class_object
+      schema["function"]["description"] = class_object.docstring.to_s
+    end
+
+    schema.to_json
+  end
+
   # Maps Ruby types to JSON schema types.
   #
   # @param type [String] The Ruby type to map.
@@ -102,38 +139,6 @@ 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)
@@ -143,40 +148,17 @@ 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
 end
+
+class Class
+  # Converts a Class to a JSON schema.
+  #
+  # @return [String] The JSON schema representation of the class's initialize method.
+  def to_json_schema
+    ToolTailor.convert(self)
+  end
+end

metadata

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