raix 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50d0de4d7ec7fdd83776e539dbed2cc73ba3097c96752050eb768163dd5f510a
-  data.tar.gz: c82955632f789a0683e30553ecc8aef8b2f96aa4bc003e0b2e12953e6698adf9
+  metadata.gz: 27b3ab0bd21ca08ecf0b23985b1e04b1787cfdb60e534744ff32234869930989
+  data.tar.gz: 822f7fe8ac7c76ce77aefff637b9d5e3163b904073329bcfb99e6d3661d38c48
 SHA512:
-  metadata.gz: 48977e0c2265105f22da2c1508a1aced37337ab1a914c7297bca4995cc94d6839708a51edb9f63222e4531bc0dccce305448ad70f78a858f30d7f581ae289114
-  data.tar.gz: c52f4078787b2570a6a11eb92e0a0f6172a09e083219d0b8562349fee4efc14012674e25591ef2839e41fd2675bfc834361bf1a64d3b74614854ce944b6cf8ab
+  metadata.gz: 2d469ff07f10f1085c40f4bc456c91f753e65b09304757eb95e77fe73df13c5ba334bdfa22f3649160c863e6ff268cde4e595f92221556a7d2761667e2a35d3c
+  data.tar.gz: a8e367b6e85adee53056ead496c97806deaba156dcab82634763c773f52e8d4e5c60c213669bdc3d8620c301e22b24862ec7f01fe77ee7c880b633b3d919b30c

data/CHANGELOG.md

@@ -21,3 +21,10 @@
 
 ## [0.4.3] - 2024-11-11
 - adds support for `Predicate` module
+
+## [0.4.4] - 2024-11-11
+- adds support for multiple tool calls in a single response
+
+## [0.4.5] - 2024-11-11
+- adds support for `ResponseFormat`
+- added some missing requires to support String#squish

data/Gemfile.lock

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

data/README.md

@@ -101,6 +101,30 @@ RSpec.describe WhatIsTheWeather do
 end
 ```
 
+#### 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:
+
+```ruby
+class MultipleToolExample
+  include Raix::ChatCompletion
+  include Raix::FunctionDispatch
+
+  function :first_tool do |arguments|
+    "Result from first tool"
+  end
+
+  function :second_tool do |arguments|
+    "Result from second tool"
+  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"]
+```
+
 #### Manually Stopping a Loop
 
 To loop AI components that don't interact with end users, at least one function block should invoke `stop_looping!` whenever you're ready to stop processing.
@@ -309,6 +333,97 @@ question.ask("Any question")
 # => RuntimeError: Please define a yes and/or no block
 ```
 
+## Response Format (Experimental)
+
+The `ResponseFormat` class provides a way to declare a JSON schema for the response format of an AI chat completion. It's particularly useful when you need structured responses from AI models, ensuring the output conforms to your application's requirements.
+
+### Features
+
+- Converts Ruby hashes and arrays into JSON schema format
+- Supports nested structures and arrays
+- Enforces strict validation with `additionalProperties: false`
+- Automatically marks all top-level properties as required
+- Handles both simple type definitions and complex nested schemas
+
+### Basic Usage
+
+```ruby
+# Simple schema with basic types
+format = Raix::ResponseFormat.new("PersonInfo", {
+  name: { type: "string" },
+  age: { type: "integer" }
+})
+
+# Use in chat completion
+my_ai.chat_completion(response_format: format)
+```
+
+### Complex Structures
+
+```ruby
+# Nested structure with arrays
+format = Raix::ResponseFormat.new("CompanyInfo", {
+  company: {
+    name: { type: "string" },
+    employees: [
+      {
+        name: { type: "string" },
+        role: { type: "string" },
+        skills: ["string"]
+      }
+    ],
+    locations: ["string"]
+  }
+})
+```
+
+### Generated Schema
+
+The ResponseFormat class generates a schema that follows this structure:
+
+```json
+{
+  "type": "json_schema",
+  "json_schema": {
+    "name": "SchemaName",
+    "schema": {
+      "type": "object",
+      "properties": {
+        "property1": { "type": "string" },
+        "property2": { "type": "integer" }
+      },
+      "required": ["property1", "property2"],
+      "additionalProperties": false
+    },
+    "strict": true
+  }
+}
+```
+
+### Using with Chat Completion
+
+When used with chat completion, the AI model will format its response according to your schema:
+
+```ruby
+class StructuredResponse
+  include Raix::ChatCompletion
+
+  def analyze_person(name)
+    format = Raix::ResponseFormat.new("PersonAnalysis", {
+      full_name: { type: "string" },
+      age_estimate: { type: "integer" },
+      personality_traits: ["string"]
+    })
+
+    transcript << { user: "Analyze the person named #{name}" }
+    chat_completion(response_format: format)
+  end
+end
+
+response = StructuredResponse.new.analyze_person("Alice")
+# Returns a hash matching the defined schema
+```
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/raix/chat_completion.rb

@@ -2,6 +2,7 @@
 
 require "active_support/concern"
 require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/filters"
 require "open_router"
 require "openai"
 

data/lib/raix/prompt_declarations.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "ostruct"
+require "active_support/core_ext/string/filters"
 
 module Raix
   # The PromptDeclarations module provides a way to chain prompts and handle

data/lib/raix/response_format.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/object/deep_dup"
+require "active_support/core_ext/string/filters"
 
 module Raix
   # Handles the formatting of responses for AI interactions.

data/lib/raix/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raix
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Obie Fernandez