raix 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00be6de8258fbe226ea622d4d0e591fa6035ddd8d5ad627dd316291561317355
-  data.tar.gz: 2749f23745e8385a770d1214c131c3babd2b48e2c983c10eaa1775ae85151879
+  metadata.gz: 65adb56d006baa2b25193eaa5f87f52b24366876139d1e023c9031e7707f62ea
+  data.tar.gz: 545da8c28e699f87e53547b53d07fb934727948945f45998f3af5d34752a2854
 SHA512:
-  metadata.gz: 561520feed1ab27d400e1482ecc3a3740fdb3d21b0ac09603f59b1b798facf9d6bb83f910c4f77b66ce7b5a60d6278bbe174429853e74aa5e5ccda771603566e
-  data.tar.gz: 537a7d27ad0d9a717f52bdb7a0aaa0d6f8479f0261f9730f18d0e93255c734e027d577d9284425a213d151fb08dd95c2f988a21015cd7746706e989dedb91cd0
+  metadata.gz: 71a14254199a7e0eeb8195b842fe212516091743ab4799f349caadfeffa654eede58dc066813e4d1360c24b2384406f934086d9b167b45db70a618470c94df84
+  data.tar.gz: 3d5a8033107bc8037862d11cd88fb3cd7a67a6884b4f7d2d8756244ac676e938094a6580bd55275b353c0b12389f292cbe958138d8d13f2d1001c5befb81662d

data/CHANGELOG.md

@@ -15,3 +15,9 @@
 ## [0.4.0] - 2024-10-18
 - adds support for Anthropic-style prompt caching
 - defaults to `max_completion_tokens` when using OpenAI directly
+
+## [0.4.2] - 2024-11-05
+- adds support for [Predicted Outputs](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs) with the `prediction` option for OpenAI
+
+## [0.4.3] - 2024-11-11
+- adds support for `Predicate` module

data/Gemfile

@@ -22,3 +22,8 @@ group :development do
   gem "sorbet"
   gem "tapioca", require: false
 end
+
+group :test do
+  gem "vcr"
+  gem "webmock"
+end

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    raix (0.4.1)
+    raix (0.4.3)
       activesupport (>= 6.0)
       open_router (~> 0.2)
+      ruby-openai (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,6 +19,8 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     backport (1.2.0)
     base64 (0.2.0)
@@ -26,6 +29,8 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.1)
     dotenv (3.1.2)
     drb (2.2.1)
@@ -57,6 +62,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.6.0)
@@ -98,6 +104,7 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (5.0.5)
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.2.0)
@@ -191,6 +198,11 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
+    vcr (6.2.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.36)
     yard-sorbet (0.8.1)
       sorbet-runtime (>= 0.5)
@@ -217,6 +229,8 @@ DEPENDENCIES
   solargraph-rails (~> 0.2.0.pre)
   sorbet
   tapioca
+  vcr
+  webmock
 
 BUNDLED WITH
    2.4.12

data/Guardfile

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -42,6 +42,14 @@ transcript << { role: "user", content: "What is the meaning of life?" }
 
 One of the advantages of OpenRouter and the reason that it is used by default by this library is that it handles mapping message formats from the OpenAI standard to whatever other model you're wanting to use (Anthropic, Cohere, etc.)
 
+### Predicted Outputs
+
+Raix supports [Predicted Outputs](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs) with the `prediction` parameter for OpenAI.
+
+```ruby
+>> ai.chat_completion(openai: "gpt-4o", params: { prediction: })
+```
+
 ### Prompt Caching
 
 Raix supports [Anthropic-style prompt caching](https://openrouter.ai/docs/prompt-caching#anthropic-claude) when using Anthropic's Claud family of models. You can specify a `cache_at` parameter when doing a chat completion. If the character count for the content of a particular message is longer than the cache_at parameter, it will be sent to Anthropic as a multipart message with a cache control "breakpoint" set to "ephemeral".
@@ -230,6 +238,77 @@ Notably, Olympia does not use the `FunctionDispatch` module in its primary conve
 
 Streaming of the AI's response to the end user is handled by the `ReplyStream` class, passed to the final prompt declaration as its `stream` parameter. [Patterns of Application Development Using AI](https://leanpub.com/patterns-of-application-development-using-ai) devotes a whole chapter to describing how to write your own `ReplyStream` class.
 
+## Predicate Module
+
+The `Raix::Predicate` module provides a simple way to handle yes/no/maybe questions using AI chat completion. It allows you to define blocks that handle different types of responses with their explanations. It is one of the concrete patterns described in the "Discrete Components" chapter of [Patterns of Application Development Using AI](https://leanpub.com/patterns-of-application-development-using-ai).
+
+### Usage
+
+Include the `Raix::Predicate` module in your class and define handlers using block syntax:
+
+```ruby
+class Question
+  include Raix::Predicate
+
+  yes? do |explanation|
+    puts "Affirmative: #{explanation}"
+  end
+
+  no? do |explanation|
+    puts "Negative: #{explanation}"
+  end
+
+  maybe? do |explanation|
+    puts "Uncertain: #{explanation}"
+  end
+end
+
+question = Question.new
+question.ask("Is Ruby a programming language?")
+# => Affirmative: Yes, Ruby is a dynamic, object-oriented programming language...
+```
+
+### Features
+
+- Define handlers for yes, no, and/or maybe responses using the declarative class level block syntax.
+- At least one handler (yes, no, or maybe) must be defined.
+- Handlers receive the full AI response including explanation as an argument.
+- Responses always start with "Yes, ", "No, ", or "Maybe, " followed by an explanation.
+- Make sure to ask a question that can be answered with yes, no, or maybe (otherwise the results are indeterminate).
+
+### Example with Single Handler
+
+You can define only the handlers you need:
+
+```ruby
+class SimpleQuestion
+  include Raix::Predicate
+
+  # Only handle positive responses
+  yes? do |explanation|
+    puts "✅ #{explanation}"
+  end
+end
+
+question = SimpleQuestion.new
+question.ask("Is 2 + 2 = 4?")
+# => ✅ Yes, 2 + 2 equals 4, this is a fundamental mathematical fact.
+```
+
+### Error Handling
+
+The module will raise a RuntimeError if you attempt to ask a question without defining any response handlers:
+
+```ruby
+class InvalidQuestion
+  include Raix::Predicate
+end
+
+question = InvalidQuestion.new
+question.ask("Any question")
+# => RuntimeError: Please define a yes and/or no block
+```
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/raix/chat_completion.rb

@@ -20,7 +20,7 @@ module Raix
     extend ActiveSupport::Concern
 
     attr_accessor :cache_at, :frequency_penalty, :logit_bias, :logprobs, :loop, :min_p, :model, :presence_penalty,
-                  :repetition_penalty, :response_format, :stream, :temperature, :max_completion_tokens,
+                  :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
 
     # This method performs chat completion based on the provided transcript and parameters.
@@ -40,6 +40,7 @@ module Raix
       params[:max_completion_tokens] ||= max_completion_tokens.presence || Raix.configuration.max_completion_tokens
       params[:max_tokens] ||= max_tokens.presence || Raix.configuration.max_tokens
       params[:min_p] ||= min_p.presence
+      params[:prediction] = { type: "content", content: params[:prediction] || prediction } if params[:prediction] || prediction.present?
       params[:presence_penalty] ||= presence_penalty.presence
       params[:provider] ||= provider.presence
       params[:repetition_penalty] ||= repetition_penalty.presence
@@ -150,8 +151,12 @@ module Raix
     private
 
     def openai_request(params:, model:, messages:)
-      # deprecated in favor of max_completion_tokens
-      params.delete(:max_tokens)
+      if params[:prediction]
+        params.delete(:max_completion_tokens)
+      else
+        params[:max_completion_tokens] ||= params[:max_tokens]
+        params.delete(:max_tokens)
+      end
 
       params[:stream] ||= stream.presence
       params[:stream_options] = { include_usage: true } if params[:stream]

data/lib/raix/predicate.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Raix
+  # A module for handling yes/no questions using AI chat completion.
+  # When included in a class, it provides methods to define handlers for
+  # yes and no responses.
+  #
+  # @example
+  #   class Question
+  #     include Raix::Predicate
+  #
+  #     yes do |explanation|
+  #       puts "Yes: #{explanation}"
+  #     end
+  #
+  #     no do |explanation|
+  #       puts "No: #{explanation}"
+  #     end
+  #   end
+  #
+  #   question = Question.new
+  #   question.ask("Is Ruby a programming language?")
+  module Predicate
+    include ChatCompletion
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def ask(question)
+      raise "Please define a yes and/or no block" if self.class.yes_block.nil? && self.class.no_block.nil?
+
+      transcript << { system: "Always answer 'Yes, ', 'No, ', or 'Maybe, ' followed by a concise explanation!" }
+      transcript << { user: question }
+
+      chat_completion.tap do |response|
+        if response.downcase.start_with?("yes,")
+          instance_exec(response, &self.class.yes_block) if self.class.yes_block
+        elsif response.downcase.start_with?("no,")
+          instance_exec(response, &self.class.no_block) if self.class.no_block
+        elsif response.downcase.start_with?("maybe,")
+          instance_exec(response, &self.class.maybe_block) if self.class.maybe_block
+        end
+      end
+    end
+
+    # Class methods added to the including class
+    module ClassMethods
+      attr_reader :yes_block, :no_block, :maybe_block
+
+      def yes?(&block)
+        @yes_block = block
+      end
+
+      def no?(&block)
+        @no_block = block
+      end
+
+      def maybe?(&block)
+        @maybe_block = block
+      end
+    end
+  end
+end

data/lib/raix/version.rb

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

data/raix.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport", ">= 6.0"
   spec.add_dependency "open_router", "~> 0.2"
+  spec.add_dependency "ruby-openai", "~> 7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raix
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Obie Fernandez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description:
 email:
 - obiefernandez@gmail.com
@@ -52,6 +66,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -59,6 +74,7 @@ files:
 - lib/raix/chat_completion.rb
 - lib/raix/function_dispatch.rb
 - lib/raix/message_adapters/base.rb
+- lib/raix/predicate.rb
 - lib/raix/prompt_declarations.rb
 - lib/raix/response_format.rb
 - lib/raix/version.rb
@@ -86,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Ruby AI eXtensions