raix 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77197d6de1d77373260029d955fd0110990b7c562a279d887130ee4f95909377
-  data.tar.gz: d811d21316bba7c92797dff98c044871ec4382998b77090f29348217156698df
+  metadata.gz: 71867dc17116a9f05ab15218ca05c1e76ab95a815e1613ba851ef71155f970c1
+  data.tar.gz: 56987389b0e8e1282603bc08f2fba90b4fe444e2bc43d56a94edd1f7535d03dd
 SHA512:
-  metadata.gz: 9a513c9c82ef57ba4beb9681a02111a5207c9418b6f0b26015e9ad299d889b8a65644d594c11246ff7c70a5354419fc3932a8a776072757e615b8afbfc48ca98
-  data.tar.gz: ab0743ed3d99efd20886053b2d7648fc6dec7b551d48c5f86fee9689441dfbda0280e0c693766fa8f03c944f7dbfc459c8301f2b3bb969de47e3f4bbfbf23d0b
+  metadata.gz: 18f6a6ab84d743cd04621c39f30563692d048635496a3acfb3f5a20a27fb481cdfc90b116055516430213880c569c413a45752c6e9bdf841026e3311b8c49e9a
+  data.tar.gz: 6c1ad1ec56508974471a24816ae460e0158f605e98d1725f6cef2069749c3d04e5199a5e2f403ad8133e4002ae34e8578abfc74818c30f2d991f0b651573d098

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [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)
+
+## [0.8.4] - 2025-05-07
+- Calls strip instead of squish on response of chat_completion in order to not clobber linebreaks
+
 ## [0.8.3] - 2025-04-30
 - Adds optional ActiveSupport Cache parameter to `dispatch_tool_function` for caching tool calls
 

data/Gemfile.lock

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

data/README.md

@@ -136,7 +136,7 @@ Note that for security reasons, dispatching functions only works with functions
 
 #### Tool Filtering
 
-You can control which tools are available to the AI on a given chat completion request using the `tools` parameter in the `chat_completion` method:
+You can control which tool functions are exposed to the AI per request using the `available_tools` parameter of the `chat_completion` method:
 
 ```ruby
 class WeatherAndTime
@@ -155,19 +155,19 @@ end
 weather = WeatherAndTime.new
 
 # Don't pass any tools to the LLM
-weather.chat_completion(tools: false)
+weather.chat_completion(available_tools: false)
 
 # Only pass specific tools to the LLM
-weather.chat_completion(tools: [:check_weather])
+weather.chat_completion(available_tools: [:check_weather])
 
 # Pass all declared tools (default behavior)
 weather.chat_completion
 ```
 
-The `tools` parameter accepts three types of values:
+The `available_tools` parameter accepts three types of values:
+- `nil`: All declared tool functions are passed (default behavior)
 - `false`: No tools are passed to the LLM
-- An array of symbols: Only the specified tools are passed (raises `Raix::UndeclaredToolError` if any tool is not declared)
-- Not provided: All declared tools are passed (default behavior)
+- An array of symbols: Only the specified tools are passed (raises `Raix::UndeclaredToolError` if a specified tool function is not declared)
 
 #### Multiple Tool Calls
 

data/lib/raix/chat_completion.rb

@@ -36,7 +36,7 @@ module Raix
 
     attr_accessor :cache_at, :frequency_penalty, :logit_bias, :logprobs, :loop, :min_p, :model, :presence_penalty,
                   :prediction, :repetition_penalty, :response_format, :stream, :temperature, :max_completion_tokens,
-                  :max_tokens, :seed, :stop, :top_a, :top_k, :top_logprobs, :top_p, :tools, :tool_choice, :provider
+                  :max_tokens, :seed, :stop, :top_a, :top_k, :top_logprobs, :top_p, :tools, :available_tools, :tool_choice, :provider
 
     # This method performs chat completion based on the provided transcript and parameters.
     #
@@ -46,9 +46,9 @@ module Raix
     # @option params [Boolean] :openai (false) Whether to use OpenAI's API instead of OpenRouter's.
     # @option params [Boolean] :raw (false) Whether to return the raw response or dig the text content.
     # @option params [Array] :messages (nil) An array of messages to use instead of the transcript.
-    # @option tools [Array|false] :tools (nil) Tools to pass to the LLM. If false, no tools are passed. If an array, only declared tools in the array are passed.
+    # @option tools [Array|false] :available_tools (nil) Tools to pass to the LLM. Ignored if nil (default). If false, no tools are passed. If an array, only declared tools in the array are passed.
     # @return [String|Hash] The completed chat response.
-    def chat_completion(params: {}, loop: false, json: false, raw: false, openai: false, save_response: true, messages: nil, tools: nil)
+    def chat_completion(params: {}, loop: false, json: false, raw: false, openai: false, save_response: true, messages: nil, available_tools: nil)
       # set params to default values if not provided
       params[:cache_at] ||= cache_at.presence
       params[:frequency_penalty] ||= frequency_penalty.presence
@@ -66,12 +66,12 @@ module Raix
       params[:stop] ||= stop.presence
       params[:temperature] ||= temperature.presence || Raix.configuration.temperature
       params[:tool_choice] ||= tool_choice.presence
-      params[:tools] = if tools == false
+      params[:tools] = if available_tools == false
                          nil
-                       elsif tools.is_a?(Array)
-                         filtered_tools(tools)
+                       elsif available_tools.is_a?(Array)
+                         filtered_tools(available_tools)
                        else
-                         self.tools.presence
+                         tools.presence
                        end
       params[:top_a] ||= top_a.presence
       params[:top_k] ||= top_k.presence

data/lib/raix/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: raix
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Obie Fernandez
 bindir: exe
 cert_chain: []
-date: 2025-05-07 00:00:00.000000000 Z
+date: 2025-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport