raix 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71867dc17116a9f05ab15218ca05c1e76ab95a815e1613ba851ef71155f970c1
-  data.tar.gz: 56987389b0e8e1282603bc08f2fba90b4fe444e2bc43d56a94edd1f7535d03dd
+  metadata.gz: f28d49373248dcc8209a5c4c3678c632953aab2282f3f71a887ee1e2b3e7d249
+  data.tar.gz: bacd7d9ef9b7aff8ab6b998d1ddb2efe3fd3dfa5855d8d5851161a271b056963
 SHA512:
-  metadata.gz: 18f6a6ab84d743cd04621c39f30563692d048635496a3acfb3f5a20a27fb481cdfc90b116055516430213880c569c413a45752c6e9bdf841026e3311b8c49e9a
-  data.tar.gz: 6c1ad1ec56508974471a24816ae460e0158f605e98d1725f6cef2069749c3d04e5199a5e2f403ad8133e4002ae34e8578abfc74818c30f2d991f0b651573d098
+  metadata.gz: a7a75b0c7c8f9ecfcbae002e6b5dfea7cee17be8d3d8825dacf2276f200f9bb542e0ccc4f7bb402b03b57d0240d84431bba3d749657a51ef4a90e937fd096633
+  data.tar.gz: b367bdd61f7c7fb269232387c0d31af1cb2315d9bed8abc16758931851dab4b849139cb23e1c2c4236f8e8ced55368726db8c2a308efa3b6db503290d07165c2

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.8.6] - 2025-05-19
+- add `required` and `optional` flags for parameters in `function` declarations
+
 ## [0.8.5] - 2025-05-08
 - renamed `tools` argument to `chat_completion` to `available_tools` to prevent shadowing the existing tool attribute (potentially breaking change to enhancement introduced in 0.8.1)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    raix (0.8.5)
+    raix (0.8.6)
       activesupport (>= 6.0)
       faraday-retry (~> 2.0)
       open_router (~> 0.2)

data/README.md

@@ -116,7 +116,9 @@ class WhatIsTheWeather
   include Raix::ChatCompletion
   include Raix::FunctionDispatch
 
-  function :check_weather, "Check the weather for a location", location: { type: "string" } do |arguments|
+  function :check_weather,
+           "Check the weather for a location",
+           location: { type: "string", required: true } do |arguments|
     "The weather in #{arguments[:location]} is hot and sunny"
   end
 end
@@ -132,6 +134,8 @@ RSpec.describe WhatIsTheWeather do
 end
 ```
 
+Parameters are optional by default. Mark them as required with `required: true` or explicitly optional with `optional: true`.
+
 Note that for security reasons, dispatching functions only works with functions implemented using `Raix::FunctionDispatch#function` or directly on the class.
 
 #### Tool Filtering

data/lib/raix/function_dispatch.rb

@@ -46,11 +46,21 @@ module Raix
       def function(name, description = nil, **parameters, &block)
         @functions ||= []
         @functions << begin
-          { name:, parameters: { type: "object", properties: {} } }.tap do |definition|
+          {
+            name:,
+            parameters: { type: "object", properties: {}, required: [] }
+          }.tap do |definition|
             definition[:description] = description if description.present?
-            parameters.map do |key, value|
+            parameters.each do |key, value|
+              value = value.dup
+              required = value.delete(:required)
+              optional = value.delete(:optional)
               definition[:parameters][:properties][key] = value
+              if required || optional == false
+                definition[:parameters][:required] << key
+              end
             end
+            definition[:parameters].delete(:required) if definition[:parameters][:required].empty?
           end
         end
 

data/lib/raix/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: raix
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Obie Fernandez
 bindir: exe
 cert_chain: []
-date: 2025-05-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Ruby AI eXtensions
 test_files: []