autoflux-openai 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e645074c500ce6b5ad07961575ac7dbbdb7ef71e7aa2ab43cf4e64c2bf7e1803
-  data.tar.gz: 4f490577cce14147d94dc9da67f8daeb21d73331c719495f581a6ce21427f320
+  metadata.gz: 9f6a06620fc9aaad94651a79c50f43e0e6620c0170195e3f6e0e7b37e7e1a5bc
+  data.tar.gz: cf620fa918dcbb690a78c09ac53b9f77d2e4a76db0c9703d0563743e2ad6fc01
 SHA512:
-  metadata.gz: e33369742bb10fc82baa2a0b64cac4a631f231143412ac7f87e55beeab4e6cc8d8b9d4449f756bafaa1f9facec416726d5113d42132b6498cd5eee068a2d3f90
-  data.tar.gz: e837e78f01bbd99dc26ab5c93cd4f269ed0dcf507de5c1062cefc9516b2aacb0362f94d56b44a1a4c510f1cfeee636e6e6272b15ca75fac147605f4ca0c0fb56
+  metadata.gz: b9873032436f3cbb76471d7de41fe03b25580e7b5a850bbc11660c51ab30c9be69ed65379deb1937a8e38bbf0cc4230daed0ef092430ffbdf8c288e2d09b52c1
+  data.tar.gz: 5fd593e5c8cf1c4ae12b14fdd2e8bafb1d853f06195d4ca00d9bf800de6e4fbadf471133fa7e58ef1e5b6aeb9aafbac5bd09ca46b47956a7b0617a70aa892d83

data/README.md

@@ -37,6 +37,20 @@ res = agent.call("Hello, world!")
 # => "Hello, world!" from OpenAI
 ```
 
+The agent use same parameters to call the OpenAI API. You can customize it when creating the agent.
+
+```ruby
+agent = Autoflux::OpenAI::Agent.new(
+    model: "gpt-4o-mini", # Required
+    # Extra parameters
+    temperature: 0.5,
+)
+res = agent.call("Hello, world!")
+# => "Hello, world!" from OpenAI
+```
+
+> The `model`, `messages`, and `tools` will be override by the agent. The stream mode is not supported.
+
 ### Tool
 
 You can attach tool to the agent to give it more capabilities.

data/lib/autoflux/openai/agent.rb

@@ -8,12 +8,13 @@ module Autoflux
 
       attr_reader :name, :model, :memory
 
-      def initialize(model:, name: DEFAULT_NAME, client: Client.new, tools: [], memory: [])
+      def initialize(model:, name: DEFAULT_NAME, client: Client.new, tools: [], memory: [], **options) # rubocop:disable Metrics/ParameterLists
         @client = client
         @model = model
         @name = name
         @memory = memory
         @_tools = tools
+        @options = options
       end
 
       def call(prompt, **context)
@@ -62,9 +63,11 @@ module Autoflux
 
       def complete
         @client.call(
-          model: @model,
-          messages: @memory.to_a,
-          tools: tools
+          @options.merge(
+            model: @model,
+            messages: @memory.to_a,
+            tools: tools
+          )
         ).dig(:choices, 0, :message)
       end
     end

data/lib/autoflux/openai/version.rb

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

data/sig/autoflux/openai/agent.rbs

@@ -2,6 +2,7 @@ module Autoflux
   module OpenAI
     type agentResponse = Hash[Symbol, untyped] & _ToJson
     type toolCall = Hash[Symbol, untyped]
+    type prompt = String | Array[{ type: String } & Hash[Symbol, untyped]]
 
     # The agent is design to use OpenAI as an agent
     class Agent
@@ -12,9 +13,10 @@ module Autoflux
       @name: String
       @memory: _Memory
       @_tools: Array[_Tool]
+      @options: Hash[Symbol, untyped]
 
-      def initialize: (model: String, ?name: String, ?client: Client, ?memory: _Memory) -> void
-      def call: (String prompt, **untyped context) -> _ToS
+      def initialize: (model: String, ?name: String, ?client: Client, ?memory: _Memory, **untyped options) -> void
+      def call: (prompt prompt, **untyped context) -> _ToS
       def use: (toolCall call, **untyped context) -> _ToJson
       def complete: () -> agentResponse
       def tools: () -> Array[_ToJson]?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoflux-openai
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aotokitsuruya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-11 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies: []
 description: The OpenAI agent for Autoflux
 email: