openai-toolable 0.1.1 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c41c79bec1d11195ab214396b4b9d1f011585f3d8e27e093ee0e28d149630fb
-  data.tar.gz: bd0b91cdc281a50b2c5b2805d715f318eb0b7e58ca733d83c2093f5f26ef9bc4
+  metadata.gz: 1d3bbdddbe89db30b52f4fa021dd6b7ddbf38049e985d8a5ec57dd28bfed4f9d
+  data.tar.gz: cb046b9026c87e727b4bb6231eef4e288c574f625cf57ea9646839599e353772
 SHA512:
-  metadata.gz: 2ebb21547acbd24b2212db7a0942cc2be6c142a707a7e3bc60fc27075c0873c57ed8b48bb758282ba875a6ac86bd7dbc8e914d0514e058ddfc64cb9cef5a6984
-  data.tar.gz: 8b09995ec0e4d5ee9037d75478be3b170ea441c4b9f9bd01882e2e4de42ffbe81cf9e93ce598d01a907cbd05d6e514c1d4992ab370e64508af46004a410d5746
+  metadata.gz: c9ac230933b242f446fd2227b1746c86039e75cbc492b2812d89ee92c931c1b5f30daead64afb9f0c14f6411758a48bb11bb9255d871f8590c60dae384336767
+  data.tar.gz: 2d669d7c49966e3c2c0d5ec7744b83bd059d1e1a885a66e87e512ba2cf6391f9618e15747d3b2b4dd362f4a86e7ccff000210a76e6bdf3ed147293295c40ffa3

data/README.md

@@ -4,6 +4,14 @@
 
 This gem is built on top of the `openai-ruby` gem and is designed to be a lightweight and intuitive extension for developers who want to leverage function calling in their Ruby applications.
 
+## Features
+
+- **Easy tool definition**: Define tools with parameters, types, and descriptions
+- **Automatic parameter validation**: Mark parameters as required to ensure they're included
+- **Response handling**: Automatically parse and execute tool calls from OpenAI responses
+- **Backward compatibility**: Works with both hash responses and OpenAI client response objects
+- **Type safety**: Proper parameter type conversion and validation
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,14 +34,19 @@ Here's a simple example of how to use `openai-toolable` to define a tool and use
 
 ```ruby
 require "openai/toolable"
+require "openai"
+
+# Set your API key
+OPENAI_API_KEY = ENV["OPENAI_API_KEY"]
 
-# Define a tool
+# Define a tool with required parameters
 weather_tool = Openai::Toolable::ToolFactory.build(
   name: "get_weather",
+  type: "function",
   description: "Get the current weather in a given location",
   parameters: [
-    { name: "location", type: :string, description: "The city and state, e.g. San Francisco, CA" },
-    { name: "unit", type: :string, description: "The unit of temperature, e.g. celsius or fahrenheit" }
+    { name: "location", type: :string, description: "The city and state, e.g. San Francisco, CA", required: true },
+    { name: "unit", type: :string, description: "The unit of temperature, e.g. celsius or fahrenheit", required: true }
   ]
 )
 
@@ -45,19 +58,48 @@ tool_handler.register(
 )
 
 # Create a client
-client = OpenAI::Client.new
+client = OpenAI::Client.new(api_key: OPENAI_API_KEY)
 
-# Create a chat completion
-response = client.chat(
-  parameters: {
-    model: "gpt-3.5-turbo",
+begin
+  # Create a chat completion
+  response = client.chat.completions.create(
+    model: "gpt-4o-mini",
     messages: [{ role: "user", content: "What's the weather like in Boston?" }],
-    tools: [weather_tool.to_json]
-  }
-)
+    tools: [weather_tool.to_json],
+    tool_choice: "auto"
+  )
+
+  # Handle the response
+  tool_handler.handle(response: response)
+rescue StandardError => e
+  puts "An error occurred: #{e.message}"
+end
+```
 
-# Handle the response
-tool_handler.handle(response: response)
+## Parameter Configuration
+
+Parameters can be configured with the following options:
+
+- `name`: The parameter name (required)
+- `type`: The parameter type (`:string`, `:number`, `:boolean`, etc.)
+- `description`: A description of what the parameter is for
+- `required`: Whether the parameter is required (default: `false`)
+
+```ruby
+parameters: [
+  { 
+    name: "location", 
+    type: :string, 
+    description: "The city and state, e.g. San Francisco, CA", 
+    required: true 
+  },
+  { 
+    name: "unit", 
+    type: :string, 
+    description: "celsius or fahrenheit", 
+    required: false 
+  }
+]
 ```
 
 ## Development

data/examples/simple.rb

@@ -1,9 +1,10 @@
+require "bundler/setup"
+require "openai"
 require "openai/toolable"
 
 # Define a tool
 weather_tool = Openai::Toolable::ToolFactory.build(
   name: "get_weather",
-  type: "function",
   description: "Get the current weather in a given location",
   parameters: [
     { name: "location", type: :string, description: "The city and state, e.g. San Francisco, CA" },
@@ -15,17 +16,17 @@ weather_tool = Openai::Toolable::ToolFactory.build(
 tool_handler = Openai::Toolable::ToolHandler.new
 tool_handler.register(
   name: "get_weather",
-  lambda: ->(location:, unit:) { puts "Getting the weather in #{location} (#{unit})..." }
+  lambda: ->(location:, unit: "celsius") { puts "Getting the weather in #{location} (#{unit})..." }
 )
 
 # Create a client
-client = OpenAI::Client.new(api_key: OPENAI_API_KEY)
+client = OpenAI::Client.new
 
 # Create a chat completion
 response = client.chat.completions.create(
-    model: "gpt-3.5-turbo",
-    messages: [{ role: "user", content: "What's the weather like in Boston?" }],
-    tools: [weather_tool.to_json]
+  model: "gpt-3.5-turbo",
+  messages: [{ role: "user", content: "What's the weather like in Boston?" }],
+  tools: [weather_tool.to_json]
 )
 
 # Handle the response

data/lib/openai/toolable/tool_handler.rb

@@ -12,11 +12,23 @@ module Openai
       end
 
       def handle(response:)
-        tool_call = response.dig("choices", 0, "message", "tool_calls", 0)
-        return unless tool_call
+        # Handle both hash responses and OpenAI client response objects
+        if response.respond_to?(:choices)
+          # OpenAI client response object
+          tool_calls = response.choices[0]&.message&.tool_calls
+          return unless tool_calls && !tool_calls.empty?
+          
+          tool_call = tool_calls[0]
+          function_name = tool_call.function.name
+          arguments = JSON.parse(tool_call.function.arguments)
+        else
+          # Hash response (backward compatibility)
+          tool_call = response.dig("choices", 0, "message", "tool_calls", 0)
+          return unless tool_call
 
-        function_name = tool_call.dig("function", "name")
-        arguments = JSON.parse(tool_call.dig("function", "arguments"))
+          function_name = tool_call.dig("function", "name")
+          arguments = JSON.parse(tool_call.dig("function", "arguments"))
+        end
 
         @tools[function_name]&.call(**arguments.transform_keys(&:to_sym))
       end

data/lib/openai/toolable/version.rb

@@ -2,6 +2,6 @@
 
 module Openai
   module Toolable
-    VERSION = "0.1.1"
+    VERSION = "0.1.7"
   end
 end

data/lib/openai/toolable.rb

@@ -7,9 +7,9 @@ module Openai
     class Error < StandardError; end
     
     class Tool
-      attr_reader :name, :type, :description, :parameters
+      attr_reader :name, :description, :parameters, :type
 
-      def initialize(name:, type:, description:, parameters: [])
+      def initialize(name:, description:, parameters: [], type: "function")
         @name = name
         @type = type
         @description = description
@@ -25,23 +25,25 @@ module Openai
 
       def to_json
         {
-          name: name,
-          type: type,
-          description: description,
-          parameters: {
-            type: :object,
-            properties: parameters.each_with_object({}) do |param, hash|
-            hash[param.name] = { type: param.type, description: param.description }
-          end,
-          required: parameters.select(&:required).map(&:name)
+          "type" => @type,
+          "function" => {
+            "name" => @name,
+            "description" => @description,
+            "parameters" => {
+              "type" => "object",
+              "properties" => @parameters.each_with_object({}) do |param, hash|
+                hash[param.name.to_s] = { "type" => param.type.to_s, "description" => param.description }
+              end,
+              "required" => @parameters.select(&:required).map { |p| p.name.to_s }
+            }
           }
         }
       end
     end
 
     class ToolFactory
-      def self.build(name:, type:, description:, parameters: [])
-        Tool.new(name: name, type: type, description: description, parameters: parameters)
+      def self.build(name:, description:, parameters: [], type: "function")
+        Tool.new(name: name, description: description, parameters: parameters, type: type)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai-toolable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.7
 platform: ruby
 authors:
 - Russell Van Curen
@@ -33,7 +33,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,25 +0,0 @@
-PATH
-  remote: .
-  specs:
-    openai-toolable (0.1.1)
-      openai (~> 0.16.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    connection_pool (2.5.3)
-    minitest (5.25.5)
-    openai (0.16.0)
-      connection_pool
-    rake (13.3.0)
-
-PLATFORMS
-  arm64-darwin-23
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  openai-toolable!
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.4.1