raix 0.7 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6783ed9671864edec5d734f8003822accee2dd7b89d0453a2c6973d35ecf2bf
-  data.tar.gz: 90eac19ba012daaeed4ce898a2be3476d1dac9c6df2cbb66fbe88a5620b971c6
+  metadata.gz: 9a2990e8225edcfbcc5007aae41a0dd69987bff18bd085bb9c486561e5597044
+  data.tar.gz: 60ef3efa8eb6cbe1b445afd09fc65a4b1d6fc62c872588956baee46b511d79d3
 SHA512:
-  metadata.gz: 6753d494dd65e960373308189d7324e973c347f627ed82463b9ae3d7079446a87b7e012949c5a69adf734a1e9f37e8684b51a04f3a7b39b6b9772b501908949a
-  data.tar.gz: 07f8d142ca423979013c17da2f8758a7113fc583fc2ee47b10cf64072a7be12aa7b53447821340239033866e8c108b1bea76ffc202fcd24e02cf814607df5989
+  metadata.gz: dfa0a7dfed2782d49c95f749c847b024ef41097b4ab318b34f9eabbfd9f754cf49c6eb859c1b14534332efea930d707df457e2d24a4c1f30f043d7dacb3c801c
+  data.tar.gz: 2e291a98b2ed5e25c2381a30d609e4277cb94458531c03e77b79fc95e70ee92e40c0d9cacb31809a1f7acca860550e4d02698856321869144dc56a4d794ea3d8

data/CHANGELOG.md

@@ -16,7 +16,6 @@
 - adds support for `execute_ai_request` in `PromptDeclarations` to handle API calls
 - adds support for `chat_completion_from_superclass` in `PromptDeclarations` to handle superclass calls
 - adds support for `model`, `temperature`, and `max_tokens` in `PromptDeclarations` to access prompt parameters
-- fixes function return values in `FunctionDispatch` to properly return results from tool calls (thanks @ttilberg)
 - Make automatic JSON parsing available to non-OpenAI providers that don't support the response_format parameter by scanning for json XML tags
 
 ## [0.6.0] - 2024-11-12

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    raix (0.7)
+    raix (0.7.1)
       activesupport (>= 6.0)
       open_router (~> 0.2)
       ruby-openai (~> 7.0)

data/README.md

@@ -78,6 +78,26 @@ Note that there is a limit of four breakpoints, and the cache will expire within
     },
 ```
 
+### JSON Mode
+
+Raix supports JSON mode for chat completions, which ensures that the AI model's response is valid JSON. This is particularly useful when you need structured data from the model.
+
+When using JSON mode with OpenAI models, Raix will automatically set the `response_format` parameter on requests accordingly, and attempt to parse the entire response body as JSON.
+When using JSON mode with other models (e.g. Anthropic) that don't support `response_format`, Raix will look for JSON content inside of <json> XML tags in the response, before
+falling back to parsing the entire response body. Make sure you tell the AI to reply with JSON inside of XML tags.
+
+```ruby
+>> my_class.chat_completion(json: true)
+=> { "key": "value" }
+```
+
+When using JSON mode with non-OpenAI providers, Raix automatically sets the `require_parameters` flag to ensure proper JSON formatting. You can also combine JSON mode with other parameters:
+
+```ruby
+>> my_class.chat_completion(json: true, openai: "gpt-4o")
+=> { "key": "value" }
+```
+
 ### Use of Tools/Functions
 
 The second (optional) module that you can add to your Ruby classes after `ChatCompletion` is `FunctionDispatch`. It lets you declare and implement functions to be called at the AI's discretion as part of a chat completion "loop" in a declarative, Rails-like "DSL" fashion.
@@ -109,44 +129,39 @@ Note that for security reasons, dispatching functions only works with functions
 
 #### Multiple Tool Calls
 
-Some AI models (like GPT-4) can make multiple tool calls in a single response. When this happens, Raix will automatically handle all the function calls sequentially and return an array of their results. Here's an example:
+Some AI models (like GPT-4) can make multiple tool calls in a single response. When this happens, Raix will automatically handle all the function calls sequentially.
+If you need to capture the arguments to the function calls, do so in the block passed to `function`. The response from `chat_completion` is always the final text
+response from the assistant, and is not affected by function calls.
 
 ```ruby
 class MultipleToolExample
   include Raix::ChatCompletion
   include Raix::FunctionDispatch
 
+  attr_reader :invocations
+
   function :first_tool do |arguments|
+    @invocations << :first
     "Result from first tool"
   end
 
   function :second_tool do |arguments|
+    @invocations << :second
     "Result from second tool"
   end
+
+  def initialize
+    @invocations = []
+  end
 end
 
 example = MultipleToolExample.new
 example.transcript << { user: "Please use both tools" }
-results = example.chat_completion(openai: "gpt-4o")
-# => ["Result from first tool", "Result from second tool"]
-```
-
-Note that as of version 0.6.1, function return values are properly returned from tool calls, whether in single or multiple tool call scenarios. This means you can use the return values from your functions in your application logic.
-
-```ruby
-class DiceRoller
-  include Raix::ChatCompletion
-  include Raix::FunctionDispatch
-
-  function :roll_dice, "Roll a die with specified number of faces", faces: { type: :integer } do |arguments|
-    rand(1..arguments[:faces])
-  end
-end
+example.chat_completion(openai: "gpt-4o")
+# => "I used both tools, as requested"
 
-roller = DiceRoller.new
-roller.transcript << { user: "Roll a d20 twice" }
-results = roller.chat_completion(openai: "gpt-4o")
-# => [15, 7] # Actual random dice roll results
+example.invocations
+# => [:first, :second]
 ```
 
 #### Manually Stopping a Loop

data/lib/raix/function_dispatch.rb

@@ -70,7 +70,7 @@ module Raix
               }
             ]
           }
-          result = instance_exec(arguments, &block).tap do |content|
+          instance_exec(arguments, &block).tap do |content|
             transcript << {
               role: "tool",
               tool_call_id: id,
@@ -81,10 +81,6 @@ module Raix
           end
 
           chat_completion(**chat_completion_args) if loop
-
-          # Return the result of the function call in case that's what the caller wants
-          # https://github.com/OlympiaAI/raix/issues/16
-          result
         end
       end
     end

data/lib/raix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raix
-  VERSION = "0.7"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raix
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.7.1
 platform: ruby
 authors:
 - Obie Fernandez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-13 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport