ai-chat 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4875edb9f6b70da87fbdabfc11fa25be2e76d51496a0ba369e2cf360511abd5
-  data.tar.gz: a062324e299eea25b68696d1d292f2f0b9fe217b3adaa7068020b6db7d198e53
+  metadata.gz: 80aebb03e5962c921d6f5e47ee1521b760ffabe223869141eaa0b1d6b53514c0
+  data.tar.gz: 53fb9565b1e41a7bf5b93bd85cabe09af0be5028a163612bc440298aef4a01df
 SHA512:
-  metadata.gz: fd196bf575fdb10389c93d52e29596bfe68c5a48c49e81b2f5efe377ab91c55b4a2533bb0d09912d06c2400bee688f98f76605161dca9fcf4cab34ebad3067e5
-  data.tar.gz: d973e4d78ef6fe30333f494d60cd590d523727bf1a175c6fb6ce1832c26dd03dd52bbff8681ad15aec4a19afda2b5616ac9fdda21499ec86e635a106381af9d1
+  metadata.gz: 1216d345bb460a00a9baf6555fc60d1337ee2ac73590fb6ec8d5a0af839a7eca664dfc83f94f5b7f1898217ad67d8ecd314c911874d4affbbcc3d5f1d8ab3f75
+  data.tar.gz: a8bcf3c0f3edadfc6ba9398220214fd9c90c0bfa2ec9a4ad5c3f54c957b0a30a5c5d6df4beb36cfd8df86e2defd4117acd827c52387710e9246e6e8649e1ccfa

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.0.7] - 2025-04-25
+
+- Added support for reasoning effort parameter (`reasoning_effort`) with the OpenAI Responses API
+- Support for reasoning models like o3, o4-mini
+- Updated documentation with examples
+
+## [0.0.6] - 2025-04-25
+
+- Fixed minor bugs
+- Improved error handling
+
 ## [0.0.5] - 2025-04-25
 
 - Updated to use OpenAI's Responses API instead of Chat Completions API

data/README.md

@@ -154,12 +154,45 @@ Useful if you are reconstructing a chat that has already happened.
 - You can call `.messages` to get an array containing the conversation so far.
 - TODO: Setting `.messages` will replace the conversation with the provided array.
 
+## Testing with Real API Calls
+
+While this gem includes specs, they use mocked API responses. To test with real API calls:
+
+1. Navigate to the test program directory: `cd test_program`
+2. Create a `.env` file in the test_program directory with your API credentials:
+```
+# Your OpenAI API key
+OPENAI_API_KEY=your_openai_api_key_here
+```
+3. Install dependencies: `bundle install`
+4. Run the test program: `ruby test_ai_chat.rb`
+
+This test program runs through all the major features of the gem, making real API calls to OpenAI.
+
+## Reasoning Effort
+
+When using reasoning models like `o3` or `o4-mini`, you can specify a reasoning effort level to control how much reasoning the model does before producing its final response:
+
+```ruby
+x = AI::Chat.new
+x.model = "o4-mini"
+x.reasoning_effort = "medium" # Can be "low", "medium", or "high"
+
+x.user("Write a bash script that transposes a matrix represented as '[1,2],[3,4],[5,6]'")
+x.assistant!
+```
+
+The `reasoning_effort` parameter guides the model on how many reasoning tokens to generate before creating a response to the prompt. Options are:
+- `"low"`: Favors speed and economical token usage
+- `"medium"`: (Default) Balances speed and reasoning accuracy
+- `"high"`: Favors more complete reasoning
+
+Setting to `nil` disables the reasoning parameter.
+
 ## TODOs
 
-- Add a `reasoning_effort` parameter.
 - Add the ability to set all messages at once, ideally with an ActiveRecord Relation.
 - Add a way to access the whole API response body (rather than just the message content).
-- Add specs.
 
 ## Contributing
 

data/lib/ai/chat/version.rb

@@ -2,6 +2,6 @@
 
 module AI
   class Chat
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/lib/ai/chat.rb

@@ -5,11 +5,31 @@
 module AI
   class Chat
     attr_accessor :messages, :schema, :model
+    attr_reader :reasoning_effort
+
+    VALID_REASONING_EFFORTS = [:low, :medium, :high].freeze
 
     def initialize(api_key: nil)
       @api_key = api_key || ENV.fetch("OPENAI_API_KEY")
       @messages = []
       @model = "gpt-4.1-mini"
+      @reasoning_effort = nil
+    end
+    
+    def reasoning_effort=(value)
+      if value.nil?
+        @reasoning_effort = nil
+      else
+        # Convert string to symbol if needed
+        symbol_value = value.is_a?(String) ? value.to_sym : value
+        
+        if VALID_REASONING_EFFORTS.include?(symbol_value)
+          @reasoning_effort = symbol_value
+        else
+          valid_values = VALID_REASONING_EFFORTS.map { |v| ":#{v} or \"#{v}\"" }.join(", ")
+          raise ArgumentError, "Invalid reasoning_effort value: '#{value}'. Must be one of: #{valid_values}"
+        end
+      end
     end
 
     def system(content)
@@ -99,6 +119,14 @@ module AI
         "input" => messages
       }
 
+      # Add reasoning parameter if specified
+      if !@reasoning_effort.nil?
+        # Convert symbol back to string for the API request
+        request_body_hash["reasoning"] = {
+          "effort" => @reasoning_effort.to_s
+        }
+      end
+
       # Handle structured output (JSON schema)
       if !schema.nil?
         # Parse the schema and use it with Structured Output (json_schema)
@@ -172,7 +200,7 @@ module AI
     end
 
     def inspect
-      "#<#{self.class.name} @messages=#{messages.inspect} @model=#{@model.inspect} @schema=#{@schema.inspect}>"
+      "#<#{self.class.name} @messages=#{messages.inspect} @model=#{@model.inspect} @schema=#{@schema.inspect} @reasoning_effort=#{@reasoning_effort.inspect}>"
     end
 
     private

data/test_program/test_ai_chat.rb

@@ -112,4 +112,46 @@ a.user("Tell me a joke.")
 response = a.assistant!
 puts "Assistant response after manual message: #{response}"
 
+# Reasoning Effort Test
+puts "\nReasoning Effort Test:"
+puts "---------------------"
+begin
+  r = AI::Chat.new
+  r.model = "o4-mini"  # Use a reasoning model
+  r.reasoning_effort = "medium"
+  r.user("Write a short bash script that counts the number of unique words in a text file.")
+  response = r.assistant!
+  puts "Response with reasoning effort 'medium': #{response}"
+rescue => e
+  puts "Reasoning effort test error: #{e.message}"
+end
+
+# Reasoning Effort Validation Test
+puts "\nReasoning Effort Validation Test:"
+puts "-------------------------------"
+begin
+  r = AI::Chat.new
+  puts "Setting valid reasoning effort string 'low'..."
+  r.reasoning_effort = "low"
+  puts "Success: reasoning_effort = #{r.reasoning_effort}"
+  
+  puts "Setting valid reasoning effort symbol :medium..."
+  r.reasoning_effort = :medium
+  puts "Success: reasoning_effort = #{r.reasoning_effort}"
+  
+  puts "Setting valid reasoning effort string 'high'..."
+  r.reasoning_effort = "high"
+  puts "Success: reasoning_effort = #{r.reasoning_effort}"
+  
+  puts "Setting nil reasoning effort..."
+  r.reasoning_effort = nil
+  puts "Success: reasoning_effort = #{r.reasoning_effort}"
+  
+  puts "Setting invalid reasoning effort 'extreme'..."
+  r.reasoning_effort = "extreme"
+  puts "This line should not be reached"
+rescue ArgumentError => e
+  puts "Expected error caught: #{e.message}"
+end
+
 puts "\nTests completed!"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ai-chat
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Raghu Betina
@@ -141,7 +141,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- ai_chat.gemspec
 - lib/ai-chat.rb
 - lib/ai/chat.rb
 - lib/ai/chat/version.rb

data/ai_chat.gemspec

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/ai/chat/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "ai-chat"
-  spec.version = AI::Chat::VERSION
-  spec.authors = ["Raghu Betina", "Jelani Woods"]
-  spec.email = ["raghu@firstdraft.com", "jelani@firstdraft.com"]
-
-  spec.summary = "This gem provides a class called `AI::Chat` that is intended to make it as easy as possible to use OpenAI's Responses API."
-  spec.description = "This gem provides a class called `AI::Chat` that is intended to make it as easy as possible to use OpenAI's Responses API. Supports Structured Output and Image Processing."
-  spec.homepage = "https://github.com/firstdraft/ai-chat"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.0.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/firstdraft/ai-chat"
-  spec.metadata["changelog_uri"] = "https://github.com/firstdraft/ai-chat/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Register dependencies of the gem
-  spec.add_runtime_dependency "mime-types", "~> 3.0"
-  spec.add_runtime_dependency "base64"  # Works for all Ruby versions
-
-  # Development dependencies
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.12"
-  spec.add_development_dependency "factory_bot", "~> 6.2"
-  spec.add_development_dependency "webmock", "~> 3.18"
-  spec.add_development_dependency "vcr", "~> 6.1"
-  spec.add_development_dependency "standard", "~> 1.32"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end