ai-chat 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '080a6986c9471fac9120a46be24abb034238d88093c63ec700b9f3e9e3a6b4fd'
-  data.tar.gz: 2bd5ce414fb2323a897594810802e61bf4d0918de8d050210e643458bca8d83c
+  metadata.gz: 80aebb03e5962c921d6f5e47ee1521b760ffabe223869141eaa0b1d6b53514c0
+  data.tar.gz: 53fb9565b1e41a7bf5b93bd85cabe09af0be5028a163612bc440298aef4a01df
 SHA512:
-  metadata.gz: 3dfa680c1d64dfab65bdfa0470a0bb48fc7301645dc102723af40d562ba4b3707a65c9cd0fccd5db824a470bb801675dcef1957c541fdf43d651fbdafa793a45
-  data.tar.gz: ad1c8453fd0b15e7abca23082b14b224ec1a41d4708da43a3cd520208386c09df2d9e939b3031a111933b955382c392abd240ea93af9a942d456a9dc686c207b
+  metadata.gz: 1216d345bb460a00a9baf6555fc60d1337ee2ac73590fb6ec8d5a0af839a7eca664dfc83f94f5b7f1898217ad67d8ecd314c911874d4affbbcc3d5f1d8ab3f75
+  data.tar.gz: a8bcf3c0f3edadfc6ba9398220214fd9c90c0bfa2ec9a4ad5c3f54c957b0a30a5c5d6df4beb36cfd8df86e2defd4117acd827c52387710e9246e6e8649e1ccfa

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [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
+- Fixed image processing to work with the new API format
+- Improved error handling and response parsing
+
 ## [0.0.1] - 2025-02-27
 
 - Initial release

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.4"
+    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)
@@ -22,15 +42,13 @@ module AI
           if item.key?("image") || item.key?(:image)
             image_value = item.fetch("image") { item.fetch(:image) }
             {
-              type: "image_url",
-              image_url: {
-                url: process_image(image_value)
-              }
+              type: "input_image",
+              image_url: process_image(image_value)
             }
           elsif item.key?("text") || item.key?(:text)
             text_value = item.fetch("text") { item.fetch(:text) }
             {
-              type: "text",
+              type: "input_text",
               text: text_value
             }
           else
@@ -54,7 +72,7 @@ module AI
       else
         text_and_images_array = [
           {
-            type: "text",
+            type: "input_text",
             text: content
           }
         ]
@@ -62,10 +80,8 @@ module AI
         if images && !images.empty?
           images_array = images.map do |image|
             {
-              type: "image_url",
-              image_url: {
-                url: process_image(image)
-              }
+              type: "input_image",
+              image_url: process_image(image)
             }
           end
 
@@ -73,10 +89,8 @@ module AI
         else
           text_and_images_array.push(
             {
-              type: "image_url",
-              image_url: {
-                url: process_image(image)
-              }
+              type: "input_image",
+              image_url: process_image(image)
             }
           )
         end
@@ -100,35 +114,85 @@ module AI
         "content-type" => "application/json"
       }
 
-      response_format = if schema.nil?
-        {
-          "type" => "text"
-        }
-      else
-        {
-          "type" => "json_schema",
-          "json_schema" => JSON.parse(schema)
-        }
-      end
-
       request_body_hash = {
         "model" => model,
-        "response_format" => response_format,
-        "messages" => messages
+        "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)
+        schema_obj = JSON.parse(schema)
+        
+        # Extract schema name from the parsed schema, or use a default
+        schema_name = schema_obj["name"] || "output_object"
+        
+        # Responses API uses proper Structured Output with schema
+        request_body_hash["text"] = {
+          "format" => {
+            "type" => "json_schema",
+            "schema" => schema_obj["schema"] || schema_obj,
+            "name" => schema_name,
+            "strict" => true
+          }
+        }
+      end
+
       request_body_json = JSON.generate(request_body_hash)
 
-      uri = URI("https://api.openai.com/v1/chat/completions")
+      uri = URI("https://api.openai.com/v1/responses")
       raw_response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
         request = Net::HTTP::Post.new(uri, request_headers_hash)
         request.body = request_body_json
         http.request(request)
       end
 
-      parsed_response = JSON.parse(raw_response.body)
+      # Handle empty responses or HTTP errors
+      if raw_response.code.to_i >= 400
+        raise "HTTP Error #{raw_response.code}: #{raw_response.message}\n#{raw_response.body}"
+      end
+
+      if raw_response.body.nil? || raw_response.body.empty?
+        raise "Empty response received from OpenAI API"
+      end
 
-      content = parsed_response.fetch("choices").at(0).fetch("message").fetch("content")
+      parsed_response = JSON.parse(raw_response.body)
+      
+      # Check for API errors
+      if parsed_response.key?("error") && parsed_response["error"].is_a?(Hash)
+        error_message = parsed_response["error"]["message"] || parsed_response["error"].inspect
+        raise "OpenAI API Error: #{error_message}"
+      end
+      
+      # Extract the text content from the response
+      content = ""
+      
+      # Parse response according to the documented structure
+      if parsed_response.key?("output") && parsed_response["output"].is_a?(Array) && !parsed_response["output"].empty?
+        output_item = parsed_response["output"][0]
+        
+        if output_item["type"] == "message" && output_item.key?("content")
+          content_items = output_item["content"]
+          output_text_item = content_items.find { |item| item["type"] == "output_text" }
+          
+          if output_text_item && output_text_item.key?("text")
+            content = output_text_item["text"]
+          end
+        end
+      end
+      
+      # If no content is found, throw an error
+      if content.empty?
+        raise "Failed to extract content from response: #{parsed_response.inspect}"
+      end
 
       messages.push({role: "assistant", content: content})
 
@@ -136,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

@@ -56,11 +56,11 @@ z.user("1 slice of pizza")
 response = z.assistant!
 puts "Nutrition values: #{response.inspect}"
 
-# Test with an image (using the fixture image from the spec directory)
-puts "\nImage Support Test:"
-puts "------------------"
+# Test with a single image
+puts "\nSingle Image Support Test:"
+puts "------------------------"
 begin
-  img_path = File.expand_path("../../spec/fixtures/test_image.jpg", __FILE__)
+  img_path = File.expand_path("../../spec/fixtures/test1.jpg", __FILE__)
   if File.exist?(img_path)
     i = AI::Chat.new
     i.user("What's in this image?", image: img_path)
@@ -70,8 +70,27 @@ begin
     puts "Test image not found at #{img_path}"
   end
 rescue => e
-  puts "Image test error: #{e.message}"
-  puts "#{response}"
+  puts "Single image test error: #{e.message}"
+end
+
+# Test with multiple images
+puts "\nMultiple Images Support Test:"
+puts "--------------------------"
+begin
+  img_path1 = File.expand_path("../../spec/fixtures/test1.jpg", __FILE__)
+  img_path2 = File.expand_path("../../spec/fixtures/test2.jpg", __FILE__)
+  img_path3 = File.expand_path("../../spec/fixtures/test3.jpg", __FILE__)
+  
+  if File.exist?(img_path1) && File.exist?(img_path2) && File.exist?(img_path3)
+    i = AI::Chat.new
+    i.user("Compare these images and tell me what you see.", images: [img_path1, img_path2, img_path3])
+    response = i.assistant!
+    puts "Multiple images description: #{response}"
+  else
+    puts "One or more test images not found"
+  end
+rescue => e
+  puts "Multiple images test error: #{e.message}"
 end
 
 # Get messages example
@@ -93,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.4
+  version: 0.0.7
 platform: ruby
 authors:
 - Raghu Betina
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,8 +123,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.32'
 description: This gem provides a class called `AI::Chat` that is intended to make
-  it as easy as possible to use OpenAI's Chat Completions endpoint. Supports Structured
-  Output.
+  it as easy as possible to use OpenAI's Responses API. Supports Structured Output
+  and Image Processing.
 email:
 - raghu@firstdraft.com
 - jelani@firstdraft.com
@@ -120,7 +134,6 @@ extra_rdoc_files: []
 files:
 - ".config/rubocop/config.yml"
 - ".reek.yml"
-- ".rspec_status"
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -128,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
@@ -158,5 +170,5 @@ requirements: []
 rubygems_version: 3.6.5
 specification_version: 4
 summary: This gem provides a class called `AI::Chat` that is intended to make it as
-  easy as possible to use OpenAI's Chat Completions endpoint.
+  easy as possible to use OpenAI's Responses API.
 test_files: []

data/.rspec_status

@@ -1,16 +0,0 @@
-example_id                                    | status | run_time        |
---------------------------------------------- | ------ | --------------- |
-./spec/ai/chat/image_support_spec.rb[1:1:1:1] | passed | 0.00007 seconds |
-./spec/ai/chat/image_support_spec.rb[1:1:2:1] | passed | 0.0001 seconds  |
-./spec/ai/chat/image_support_spec.rb[1:1:3:1] | passed | 0.00012 seconds |
-./spec/ai/chat/image_support_spec.rb[1:1:3:2] | passed | 0.00018 seconds |
-./spec/ai/chat/image_support_spec.rb[1:2:1:1] | passed | 0.0016 seconds  |
-./spec/ai/chat/image_support_spec.rb[1:2:1:2] | passed | 0.0001 seconds  |
-./spec/ai/chat/image_support_spec.rb[1:2:2:1] | passed | 0.00011 seconds |
-./spec/ai/chat/image_support_spec.rb[1:2:3:1] | passed | 0.00007 seconds |
-./spec/ai/chat/image_support_spec.rb[1:2:3:2] | passed | 0.00013 seconds |
-./spec/ai/chat/image_support_spec.rb[1:3:1]   | passed | 0.00005 seconds |
-./spec/ai/chat/image_support_spec.rb[1:3:2]   | passed | 0.00006 seconds |
-./spec/ai/chat/image_support_spec.rb[1:3:3]   | passed | 0.00008 seconds |
-./spec/ai/chat/image_support_spec.rb[1:3:4]   | passed | 0.00017 seconds |
-./spec/ai/chat/image_support_spec.rb[1:3:5]   | passed | 0.00074 seconds |

data/ai_chat.gemspec

@@ -1,47 +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 Chat Completions endpoint."
-  spec.description = "This gem provides a class called `AI::Chat` that is intended to make it as easy as possible to use OpenAI's Chat Completions endpoint. Supports Structured Output."
-  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"
-
-  # 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