omniai 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444922e4ffb4b54da232b01faab2b171f39ec2547830a7c02a4dc607173acae9
-  data.tar.gz: 221d5e646b968f9cb422c64547966855518351038c9f1d7248961778785dd8fc
+  metadata.gz: 79d29d3011d03634e81f70e37b83af802c8881afb6920769a2b49e165f244735
+  data.tar.gz: 15b2e1cc6af34b9692f2d0628c8a94754f7d2dafc6b545bd739c2d4d88fe8141
 SHA512:
-  metadata.gz: 30da07946fab93796f28c4d831ef00f0b609051e664a1cdc01373af8e6079d857239bf26be88d5cbeb6e9d25c7c2bcc08588979e3393da661bc73057e4c34bcb
-  data.tar.gz: '09907c95ccd31c1f672f2fcc324a11a23b63799916db570a4a4fcaee4677249f430e15071a3f5e5ca34e72d867dedfc039a52527aa2dc9d6ffe7734b4f7d7dc7'
+  metadata.gz: d3d3636fc343966d21f40c7b09b566bcc3a3375e5d52e3b700f9d9db6e69194cb6d657cc25f721216ece7f8fa3d775216ca1baaaeb527b865d16be9398aaee47
+  data.tar.gz: bb45ac481dd2b27edf8e62ba66667ed1d17e77b4c44ab7505b17af0b78db4e8c7550d25fd67b8e5556b97e8455a8c65db443fcfb52abc3a2c3c4130904fafb65

data/README.md

@@ -545,6 +545,28 @@ end
 client.chat('What is the weather in "London" in Celsius and "Paris" in Fahrenheit?', tools: [WeatherTool.new])
 ```
 
+#### Per-Round Usage
+
+A tool-call chain makes one request per round, but only the final `Response` is returned. Pass `on_response:` to receive each round's `Response` as it completes, before that round's tool calls run. It fires for single-round chats too and is independent of `stream:`.
+
+Usage then survives an abort. When a stream block or a tool raises mid-chain, `process!` unwinds without returning a `Response`, but the rounds already handed over are still accounted for:
+
+```ruby
+rounds = []
+
+stream = proc do |chunk|
+  raise TooManyRounds if rounds.length >= 20
+
+  print(chunk.text)
+end
+
+begin
+  client.chat(prompt, tools:, stream:, on_response: proc { |round| rounds << round })
+rescue TooManyRounds
+  rounds.filter_map(&:usage).sum { |usage| usage.input_tokens.to_i + usage.output_tokens.to_i }
+end
+```
+
 #### Extended Thinking / Reasoning
 
 Some models support extended thinking or reasoning capabilities. OmniAI provides a unified `thinking:` option that works across all supported providers:

data/lib/omniai/chat.rb

@@ -66,6 +66,8 @@ module OmniAI
     # @param stream [Proc, IO, nil] optional
     # @param tools [Array<OmniAI::Tool>, nil] optional
     # @param format [:json, :text, OmniAI::Schema::Object, nil] optional
+    # @param on_response [Proc, nil] optional - called with each completed round's `Response` before its tool
+    #   calls run
     # @param options [Hash] optional (used for vendor specific options)
     #
     # @yield [prompt] optional
@@ -80,6 +82,7 @@ module OmniAI
       stream: nil,
       tools: nil,
       format: nil,
+      on_response: nil,
       **options,
       &block
     )
@@ -94,6 +97,7 @@ module OmniAI
       @stream = stream
       @tools = tools
       @format = format
+      @on_response = on_response
       @options = options || {}
     end
 
@@ -112,6 +116,8 @@ module OmniAI
         raise SSLError, e.message, cause: e
       end
 
+      @on_response&.call(completion)
+
       if tools? && completion.tool_call_list?
         next_completion = spawn!(
           @prompt.dup.tap do |prompt|
@@ -165,6 +171,7 @@ module OmniAI
         stream: @stream,
         tools: @tools,
         format: @format,
+        on_response: @on_response,
         **@options
       )
     end

data/lib/omniai/client.rb

@@ -191,13 +191,16 @@ module OmniAI
     # @param temperature [Float, nil] optional
     # @param stream [Proc, nil] optional
     # @param tools [Array<OmniAI::Tool>] optional
+    # @param on_response [Proc, nil] optional - called with each completed round's `Response` before its tool
+    #   calls run
     # @param options [Hash, nil] optional
     #
     # @yield [prompt] optional
     # @yieldparam prompt [OmniAI::Chat::Prompt]
     #
     # @return [OmniAI::Chat::Response]
-    def chat(prompt = nil, model:, temperature: nil, format: nil, stream: nil, tools: nil, options: {}, &)
+    def chat(prompt = nil, model:, temperature: nil, format: nil, stream: nil, tools: nil, on_response: nil,
+      options: {}, &)
       raise NotImplementedError, "#{self.class.name}#chat undefined"
     end
 

data/lib/omniai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniAI
-  VERSION = "3.8.0"
+  VERSION = "3.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Kevin Sylvestre