autoflux-openai 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f6a06620fc9aaad94651a79c50f43e0e6620c0170195e3f6e0e7b37e7e1a5bc
-  data.tar.gz: cf620fa918dcbb690a78c09ac53b9f77d2e4a76db0c9703d0563743e2ad6fc01
+  metadata.gz: b9c7f1d47432e8221ec33239f799ebeb0f4ed37026d01b4479b0bda40bfd207a
+  data.tar.gz: 5a16cb407af4dfc3fe49b76a526343bc2497520bb079e1ae46a2a5bda7158ae9
 SHA512:
-  metadata.gz: b9873032436f3cbb76471d7de41fe03b25580e7b5a850bbc11660c51ab30c9be69ed65379deb1937a8e38bbf0cc4230daed0ef092430ffbdf8c288e2d09b52c1
-  data.tar.gz: 5fd593e5c8cf1c4ae12b14fdd2e8bafb1d853f06195d4ca00d9bf800de6e4fbadf471133fa7e58ef1e5b6aeb9aafbac5bd09ca46b47956a7b0617a70aa892d83
+  metadata.gz: 28e472dc22a1ae7406ee6d614770dd3089db0ac3aec1a3e91caa75f83e7e34646b41f2334416ceefefac1901b828ab0073115451fa9ad98c2e9fe4011ae51cb3
+  data.tar.gz: 7145feb76a8d631ebfca05481ace81046d23776048bda5fe5d0f4460fa703a29dd29812983f6e4d5bd19c8b997d2ad89f3f2702829f95b713daafd9789cb5ace

data/README.md

@@ -1,6 +1,8 @@
 Autoflux::OpenAI
 ===
 
+[![Ruby](https://github.com/elct9620/autoflux-openai/actions/workflows/main.yml/badge.svg)](https://github.com/elct9620/autoflux-openai/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/elct9620/autoflux-openai/graph/badge.svg?token=VW9V0FU009)](https://codecov.io/gh/elct9620/autoflux-openai)
+
 This gem implements [autoflux](https://github.com/elct9620/autoflux) agent to use OpenAI as the backend.
 
 ## Installation
@@ -41,9 +43,9 @@ The agent use same parameters to call the OpenAI API. You can customize it when
 
 ```ruby
 agent = Autoflux::OpenAI::Agent.new(
-    model: "gpt-4o-mini", # Required
-    # Extra parameters
-    temperature: 0.5,
+  model: "gpt-4o-mini", # Required
+  # Extra parameters
+  temperature: 0.5,
 )
 res = agent.call("Hello, world!")
 # => "Hello, world!" from OpenAI
@@ -57,31 +59,56 @@ You can attach tool to the agent to give it more capabilities.
 
 ```ruby
 uppercase = Autoflux::OpenAI::Tool.new(
-    name: "uppercase",
-    description: "Convert the content to uppercase",
-    parameters: {
-        type: "object",
-        properties: {
-            text: {
-                type: "string"
-            }
-        }
+  name: "uppercase",
+  description: "Convert the content to uppercase",
+  parameters: {
+    type: "object",
+    properties: {
+      text: {
+        type: "string"
+      }
     }
+  }
 ) do |params|
-    { text: params[:text].upcase }
+  { text: params[:text].upcase }
 end
 
 agent = Autoflux::OpenAI::Agent.new(
-    model: "gpt-4o-mini",
-    tools: [uppercase],
-    memory: [
-        { role: "system", content: "Always transform the user input and don't do anything else." }
-    ]
+  model: "gpt-4o-mini",
+  tools: [uppercase],
+  memory: [
+    { role: "system", content: "Always transform the user input and don't do anything else." }
+  ]
 )
 res = agent.call("Hello, world!")
 # => "HELLO, WORLD!" from OpenAI
 ```
 
+The tool is an object has a `name`, `description`, `parameters`, and a `#call` method. The `#call` method will be called with the parameters from the agent.
+
+```ruby
+class MyTool
+  attr_reader :name, :description, :parameters
+
+  def initialize
+    @name = "my-tool" # Must be string which can be lookup by the agent
+    @description = "My tool"
+    @parameters = {
+      type: "object",
+      properties: {
+        text: {
+          type: "string"
+        }
+      }
+    }
+  end
+
+  def call(params, **context)
+    { text: params[:text].upcase }
+  end
+end
+```
+
 ### Client
 
 This gem embeds a lightweight client to interact with OpenAI API. The client can be used to interact with OpenAI API directly.
@@ -89,8 +116,8 @@ This gem embeds a lightweight client to interact with OpenAI API. The client can
 ```ruby
 client = Autoflux::OpenAI::Client.new(api_key: "your-api-key")
 res = client.call(
-    model: "gpt-4o-mini",
-    messages: [{ role: "user", content: "Hello, world!" }]
+  model: "gpt-4o-mini",
+  messages: [{ role: "user", content: "Hello, world!" }]
 )
 # => { choices: [{ message: { role: "assistant", content: "Hello World!" }}] }
 ```
@@ -99,12 +126,12 @@ If your api key or endpoint is not default, you can specify them in the client.
 
 ```ruby
 client = Autoflux::OpenAI::Client.new(
-    api_key: "your-api-key",
-    endpoint: URI("https://gateway.ai.cloudflare.com/v1/{account_id}/{gateway_id}/openai")
+  api_key: "your-api-key",
+  endpoint: URI("https://gateway.ai.cloudflare.com/v1/{account_id}/{gateway_id}/openai")
 )
 client.call(
-    model: "gpt-4o-mini",
-    messages: [{ role: "user", content: "Hello, world!" }]
+  model: "gpt-4o-mini",
+  messages: [{ role: "user", content: "Hello, world!" }]
 )
 ```
 
@@ -114,21 +141,21 @@ The agent default use a Ruby array to store the conversation history. If you wan
 
 ```ruby
 class MyMemory
-    def initialize
-        @store = []
-    end
+  def initialize
+    @store = []
+  end
 
-    def push(message)
-        @store.push(message)
-    end
+  def push(message)
+    @store.push(message)
+  end
 
-    def <<(message)
-        push(message)
-    end
+  def <<(message)
+    push(message)
+  end
 
-    def to_a
-        @store.last(100)
-    end
+  def to_a
+    @store.last(100)
+  end
 end
 ```
 

data/lib/autoflux/openai/client.rb

@@ -16,7 +16,7 @@ module Autoflux
 
       def call(payload)
         res = http.post(@endpoint.path || "", payload.to_json, headers)
-        raise Error, res.body unless res.is_a?(Net::HTTPSuccess)
+        raise error_of(res), res.body unless res.is_a?(Net::HTTPSuccess)
 
         JSON.parse(res.body, symbolize_names: true)
       rescue JSON::ParserError
@@ -32,6 +32,15 @@ module Autoflux
         }
       end
 
+      def error_of(res)
+        case res
+        when Net::HTTPUnauthorized then AuthoriztionError
+        when Net::HTTPBadRequest then BadRequestError
+        when Net::HTTPTooManyRequests then RateLimitError
+        else Error
+        end
+      end
+
       def http
         @http ||= Net::HTTP.new(@endpoint.host || "", @endpoint.port).tap do |http|
           http.use_ssl = @endpoint.scheme == "https"

data/lib/autoflux/openai/version.rb

@@ -2,6 +2,6 @@
 
 module Autoflux
   module OpenAI
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/autoflux/openai.rb

@@ -6,6 +6,9 @@ module Autoflux
   # The lightweight OpenAI agent for Autoflux
   module OpenAI
     class Error < StandardError; end
+    class AuthoriztionError < Error; end
+    class BadRequestError < Error; end
+    class RateLimitError < Error; end
 
     require_relative "openai/client"
     require_relative "openai/agent"

data/sig/autoflux/openai/client.rbs

@@ -13,6 +13,7 @@ module Autoflux
       def call: (::_ToJson payload) -> Hash[Symbol, untyped]
       def headers: () -> Hash[String, String]
       def http: () -> Net::HTTP
+      def error_of: (Net::HTTPResponse res) -> _Exception
     end
   end
 end

data/sig/autoflux/openai.rbs

@@ -4,5 +4,14 @@ module Autoflux
 
     class Error < StandardError
     end
+
+    class AuthoriztionError < Error
+    end
+
+    class BadRequestError < Error
+    end
+
+    class RateLimitError < Error
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoflux-openai
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Aotokitsuruya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-12 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies: []
 description: The OpenAI agent for Autoflux
 email:
@@ -17,8 +17,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".husky/commit-msg"
-- ".husky/pre-commit"
 - ".rspec"
 - ".rubocop.yml"
 - LICENSE.txt
@@ -31,8 +29,6 @@ files:
 - lib/autoflux/openai/client.rb
 - lib/autoflux/openai/tool.rb
 - lib/autoflux/openai/version.rb
-- package-lock.json
-- package.json
 - sig/autoflux/openai.rbs
 - sig/autoflux/openai/agent.rbs
 - sig/autoflux/openai/client.rbs

data/.husky/commit-msg

@@ -1 +0,0 @@
-npx --no -- commitlint --verbose --edit $1

data/.husky/pre-commit

@@ -1 +0,0 @@
-bundle exec rake