ai-chat 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2397a7d43d950bf70abd84c83d0e57b2cadb70fc127985fae4da4a9ecf142b8
-  data.tar.gz: d44a9d1999ce48cd0af92f367f5f0e2f586b8c19d1fc9e95ce8c7aa7e3fffa84
+  metadata.gz: 12727b49e500d9c3c117b0d8a4df291f0b050eae0b12c90d7cd992ac93881c42
+  data.tar.gz: 2ebf913f409bdfbebcc5cd12d8a4a87346be894564d75a6c7811157b9619ecce
 SHA512:
-  metadata.gz: fdb13f4e405f46a21591f71ae818544bc60f7bc083e4b3eb9a8a6d57b9eba03995fe8b75828f3972e564dfa3ed3ed09aed4a8b7ae2260b3602cbede9d80afd8e
-  data.tar.gz: 427b5db79e006d0f6f9b20b83472a78c3234118807e4d43d472304426ca2d80d5b189d029924cd548d7004206914a4e63fd52ca93b1944e55e81276309a501d9
+  metadata.gz: 3707fdf80a68ce541b0c4fb3ab362f2404e2b0e78a3e7bd86ec140702f4b2939a6c2740b12a58d39212aceb24607c87648948f5d93bb5fcacffbf7200e35e2e0
+  data.tar.gz: 9d3e23578c90251da1fb08351aafe48fa5c7a82ec330644a6cffbe156fd42d58bcfbebd42be93df5a7a680cddfe0855c8dc2770ef3c8a0a70f2c4d4e8fa894f8

data/README.md

@@ -82,7 +82,7 @@ pp a.messages
 # => [{:role=>"user", :content=>"If the Ruby community had an official motto, what might it be?"}]
 
 # Generate the next message using AI
-a.generate! # => "Matz is nice and so we are nice" (or similar)
+a.generate! # => { :role => "assistant", :content => "Matz is nice and so we are nice" (or similar) }
 
 # Your array now includes the assistant's response
 pp a.messages
@@ -93,7 +93,7 @@ pp a.messages
 
 # Continue the conversation
 a.add("What about Rails?")
-a.generate! # => "Convention over configuration."
+a.generate! # => { :role => "assistant", :content => "Convention over configuration."} 
 ```
 
 ## Understanding the Data Structure
@@ -135,7 +135,7 @@ pp b.messages
 #    ]
 
 # Generate a response
-b.generate! # => "Methinks 'tis 'Ruby doth bring joy to all who craft with care'"
+b.generate! # => { :role => "assistant", :content => "Methinks 'tis 'Ruby doth bring joy to all who craft with care'" }
 ```
 
 ### Convenience Methods
@@ -237,7 +237,7 @@ h.messages.last[:content]
 # => "Here's how to boil an egg..."
 
 # Or use the convenient shortcut
-h.last
+h.last[:content]
 # => "Here's how to boil an egg..."
 ```
 
@@ -277,10 +277,11 @@ i.schema = '{"name": "nutrition_values","strict": true,"schema": {"type": "objec
 i.user("1 slice of pizza")
 
 response = i.generate!
+data = response[:content]
 # => {:fat=>15, :protein=>12, :carbs=>35, :total_calories=>285}
 
 # The response is parsed JSON, not a string!
-response[:total_calories]  # => 285
+data[:total_calories]  # => 285
 ```
 
 ### Schema Formats
@@ -442,14 +443,14 @@ a = AI::Chat.new
 a.user("What color is the object in this photo?", image: "thing.png")
 a.generate! # => "Red"
 a.user("What is the object in the photo?")
-a.generate! # => "I don't see a photo"
+a.generate! # => { :content => "I don't see a photo", ... }
 
 b = AI::Chat.new
 b.user("What color is the object in this photo?", image: "thing.png")
 b.generate! # => "Red"
 b.user("What is the object in the photo?")
 b.previous_response_id = nil
-b.generate! # => "An apple"
+b.generate! # => { :content => "An apple", ... }
 ```
 
 If you don't set `previous_response_id` to `nil`, the model won't have the old image(s) to work with.
@@ -462,7 +463,7 @@ You can enable OpenAI's image generation tool:
 a = AI::Chat.new
 a.image_generation = true
 a.user("Draw a picture of a kitten")
-a.generate! # => "Here is your picture of a kitten:"
+a.generate! # => { :content => "Here is your picture of a kitten:", ... }
 ```
 
 By default, images are saved to `./images`. You can configure a different location:
@@ -472,7 +473,7 @@ a = AI::Chat.new
 a.image_generation = true
 a.image_folder = "./my_images"
 a.user("Draw a picture of a kitten")
-a.generate! # => "Here is your picture of a kitten:"
+a.generate! # => { :content => "Here is your picture of a kitten:", ... }
 ```
 
 Images are saved in timestamped subfolders using ISO 8601 basic format. For example:
@@ -510,9 +511,18 @@ a = AI::Chat.new
 a.image_generation = true
 a.image_folder = "./images"
 a.user("Draw a picture of a kitten")
-a.generate! # => "Here is a picture of a kitten:"
+a.generate! # => { :content => "Here is a picture of a kitten:", ... }
 a.user("Make it even cuter")
-a.generate! # => "Here is the kitten, but even cuter:"
+a.generate! # => { :content => "Here is the kitten, but even cuter:", ... }
+```
+
+## Code Interpreter
+
+```ruby
+y = AI::Chat.new
+y.code_interpreter = true
+y.user("Plot y = 2x*3 when x is -5 to 5.")
+y.generate! # => {:content => "Here is the graph.", ... }
 ```
 
 ## Building Conversations Without API Calls

data/ai-chat.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "ai-chat"
-  spec.version = "0.2.3"
+  spec.version = "0.2.4"
   spec.authors = ["Raghu Betina"]
   spec.email = ["raghu@firstdraft.com"]
   spec.homepage = "https://github.com/firstdraft/ai-chat"
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "marcel", "~> 1.0"
   spec.add_runtime_dependency "base64", "> 0.1.1"
   spec.add_runtime_dependency "json", "~> 2.0"
+  spec.add_runtime_dependency "tty-spinner", "~> 0.9.3"
 
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "refinements", "~> 11.1"

data/lib/ai/amazing_print.rb

@@ -1,5 +1,5 @@
 require "amazing_print"
-
+# :reek:IrresponsibleModule
 module AmazingPrint
   module AI
     def self.included(base)
@@ -27,6 +27,10 @@ module AmazingPrint
       end
     end
 
+    # :reek:DuplicateMethodCall
+    # :reek:FeatureEnvy
+    # :reek:NilCheck
+    # :reek:TooManyStatements
     def format_ai_chat(chat)
       vars = []
       
@@ -53,6 +57,8 @@ module AmazingPrint
       format_object(chat, vars)
     end
 
+    # :reek:TooManyStatements
+    # :reek:DuplicateMethodCall
     def format_object(object, vars)
       data = vars.map do |(name, value)|
         name = colorize(name, :variable) unless @options[:plain]

data/lib/ai/chat.rb

@@ -7,6 +7,8 @@ require "openai"
 require "pathname"
 require "stringio"
 require "fileutils"
+require "tty-spinner"
+require "timeout"
 
 module AI
   # :reek:MissingSafeMethod { exclude: [ generate! ] }
@@ -16,7 +18,7 @@ module AI
   # :reek:IrresponsibleModule
   class Chat
     # :reek:Attribute
-    attr_accessor :messages, :model, :web_search, :previous_response_id, :image_generation, :image_folder
+    attr_accessor :background, :code_interpreter, :image_generation, :image_folder, :messages, :model, :previous_response_id, :web_search
     attr_reader :reasoning_effort, :client, :schema
 
     VALID_REASONING_EFFORTS = [:low, :medium, :high].freeze
@@ -34,16 +36,16 @@ module AI
 
     # :reek:TooManyStatements
     # :reek:NilCheck
-    def add(content, role: "user", response: nil, image: nil, images: nil, file: nil, files: nil)
+    def add(content, role: "user", response: nil, status: nil, image: nil, images: nil, file: nil, files: nil)
       if image.nil? && images.nil? && file.nil? && files.nil?
-        messages.push(
-          {
-            role: role,
-            content: content,
-            response: response
-          }.compact
-        )
-
+        message = {
+          role: role,
+          content: content,
+          response: response
+        }
+        message[:content] = content if content
+        message[:status] = status if status
+        messages.push(message)
       else
         text_and_files_array = [
           {
@@ -76,7 +78,8 @@ module AI
         messages.push(
           {
             role: role,
-            content: text_and_files_array
+            content: text_and_files_array,
+            status: status
           }
         )
       end
@@ -90,53 +93,31 @@ module AI
       add(message, role: "user", image: image, images: images, file: file, files: files)
     end
 
-    def assistant(message, response: nil)
-      add(message, role: "assistant", response: response)
+    def assistant(message, response: nil, status: nil)
+      add(message, role: "assistant", response: response, status: status)
     end
 
     # :reek:NilCheck
     # :reek:TooManyStatements
     def generate!
       response = create_response
+      parse_response(response)
 
-      text_response = extract_text_from_response(response)
-
-      image_filenames = extract_and_save_images(response)
-      response_usage = response.usage.to_h.slice(:input_tokens, :output_tokens, :total_tokens)
-
-      chat_response = {
-        id: response.id,
-        model: response.model,
-        usage: response_usage,
-        total_tokens: response_usage[:total_tokens],
-        images: image_filenames
-      }
-
-      message = if schema
-        if text_response.nil? || text_response.empty?
-          raise ArgumentError, "No text content in response to parse as JSON for schema: #{schema.inspect}"
-        end
-        JSON.parse(text_response, symbolize_names: true)
-      else
-        text_response
-      end
+      self.previous_response_id = last.dig(:response, :id)
+      last
+    end
 
-      if image_filenames.empty?
-        assistant(message, response: chat_response)
+    # :reek:BooleanParameter
+    # :reek:ControlParameter
+    # :reek:DuplicateMethodCall
+    # :reek:TooManyStatements
+    def get_response(wait: false, timeout: 600)
+      response = if wait
+        wait_for_response(timeout)
       else
-        messages.push(
-          {
-            role: "assistant",
-            content: message,
-            images: image_filenames,
-            response: chat_response
-          }.compact
-        )
+        client.responses.retrieve(previous_response_id)
       end
-
-      self.previous_response_id = chat_response[:id]
-
-      message
+      parse_response(response)
     end
 
     # :reek:NilCheck
@@ -177,6 +158,11 @@ module AI
     end
 
     # Support for Ruby's pp (pretty print)
+    # :reek:TooManyStatements
+    # :reek:NilCheck
+    # :reek:FeatureEnvy
+    # :reek:DuplicateMethodCall
+    # :reek:UncommunicativeParameterName
     def pretty_print(q)
       q.group(1, "#<#{self.class}", '>') do
         q.breakable
@@ -207,7 +193,6 @@ module AI
       end
     end
 
-
     private
 
     class InputClassificationError < StandardError; end
@@ -231,6 +216,7 @@ module AI
         model: model
       }
 
+      parameters[:background] = background if background
       parameters[:tools] = tools unless tools.empty?
       parameters[:text] = schema if schema
       parameters[:reasoning] = {effort: reasoning_effort} if reasoning_effort
@@ -242,6 +228,56 @@ module AI
       client.responses.create(**parameters)
     end
 
+    # :reek:NilCheck
+    # :reek:TooManyStatements
+    def parse_response(response)
+      text_response = response.output_text
+      image_filenames = extract_and_save_images(response)
+      response_id = response.id
+      response_usage = response.usage.to_h.slice(:input_tokens, :output_tokens, :total_tokens)
+
+      chat_response = {
+        id: response_id,
+        model: response.model,
+        usage: response_usage,
+        total_tokens: response_usage[:total_tokens],
+        images: image_filenames
+      }.compact
+
+      response_content = if schema
+        if text_response.nil? || text_response.empty?
+          raise ArgumentError, "No text content in response to parse as JSON for schema: #{schema.inspect}"
+        end
+        JSON.parse(text_response, symbolize_names: true)
+      else
+        text_response
+      end
+
+      existing_message_position = messages.find_index do |message|
+        message.dig(:response, :id) == response_id
+      end
+
+      message = {
+        role: "assistant",
+        content: response_content,
+        response: chat_response,
+        status: response.status
+      }
+
+      message.store(:images, image_filenames) unless image_filenames.empty?
+
+      if existing_message_position
+        messages[existing_message_position] = message
+      else
+        messages.push(message)
+        message
+      end
+    end
+
+    def cancel_request
+      client.responses.cancel(previous_response_id)
+    end
+
     def prepare_messages_for_api
       return messages unless previous_response_id
 
@@ -389,19 +425,12 @@ module AI
       if image_generation
         tools_list << {type: "image_generation"}
       end
+      if code_interpreter
+        tools_list << {type: "code_interpreter", container: {type: "auto"}}
+      end
       tools_list
     end
 
-    # :reek:UtilityFunction
-    # :reek:ManualDispatch
-    def extract_text_from_response(response)
-      response.output.flat_map { |output|
-        output.respond_to?(:content) ? output.content : []
-      }.compact.find { |content|
-        content.is_a?(OpenAI::Models::Responses::ResponseOutputText)
-      }&.text
-    end
-
     # :reek:FeatureEnvy
     # :reek:UtilityFunction
     def wrap_schema_if_needed(schema)
@@ -438,31 +467,129 @@ module AI
 
       return image_filenames if image_outputs.empty?
 
-      # ISO 8601 basic format with centisecond precision
-      timestamp = Time.now.strftime("%Y%m%dT%H%M%S%2N")
-
-      subfolder_name = "#{timestamp}_#{response.id}"
-      subfolder_path = File.join(image_folder || "./images", subfolder_name)
-      FileUtils.mkdir_p(subfolder_path)
+      subfolder_path = create_images_folder(response.id)
 
       image_outputs.each_with_index do |output, index|
         next unless output.respond_to?(:result) && output.result
 
-        begin
+        warn_if_file_fails_to_save do
           image_data = Base64.strict_decode64(output.result)
 
           filename = "#{(index + 1).to_s.rjust(3, "0")}.png"
-          filepath = File.join(subfolder_path, filename)
+          file_path = File.join(subfolder_path, filename)
 
-          File.binwrite(filepath, image_data)
+          File.binwrite(file_path, image_data)
 
-          image_filenames << filepath
-        rescue => error
-          warn "Failed to save image: #{error.message}"
+          image_filenames << file_path
         end
       end
 
       image_filenames
     end
+
+    def create_images_folder(response_id)
+      # ISO 8601 basic format with centisecond precision
+      timestamp = Time.now.strftime("%Y%m%dT%H%M%S%2N")
+
+      subfolder_name = "#{timestamp}_#{response_id}"
+      subfolder_path = File.join(image_folder || "./images", subfolder_name)
+      FileUtils.mkdir_p(subfolder_path)
+      subfolder_path
+    end
+
+    def warn_if_file_fails_to_save
+      begin
+        yield
+      rescue => error
+        warn "Failed to save image: #{error.message}"
+      end
+    end
+
+    # :reek:FeatureEnvy
+    # :reek:ManualDispatch
+    # :reek:NestedIterators
+    # :reek:TooManyStatements
+    def extract_and_save_files(response)
+      filenames = []
+
+      message_outputs = response.output.select do |output|
+        output.respond_to?(:type) && output.type == :message
+      end
+
+      outputs_with_annotations = message_outputs.map do |message|
+        message.content.find do |content|
+          content.respond_to?(:annotations) && content.annotations.length.positive?
+        end
+      end.compact
+
+      return filenames if outputs_with_annotations.empty?
+
+      subfolder_path = create_images_folder(response.id)
+      annotations = outputs_with_annotations.map do |output|
+        output.annotations.find do |annotation|
+          annotation.respond_to?(:filename)
+        end
+      end.compact
+
+      annotations.each do |annotation|
+        container_id = annotation.container_id
+        file_id = annotation.file_id
+        filename = annotation.filename
+
+        warn_if_file_fails_to_save do
+          container_content = client.containers.files.content
+          file_content = container_content.retrieve(file_id, container_id: container_id)
+          file_path = File.join(subfolder_path, filename)
+          File.open(file_path, "wb") do |file|
+            file.write(file_content.read)
+          end
+          filenames << file_path
+        end
+      end
+
+      filenames
+    end
+
+    # This is similar to ActiveJob's :polynomially_longer retry option
+    # :reek:DuplicateMethodCall
+    # :reek:UtilityFunction
+    def calculate_wait(executions)
+      # cap the maximum wait time to ~110 seconds
+      executions = executions.clamp(1..10)
+      jitter = 0.15
+      ((executions**2) + (Kernel.rand * (executions**2) * jitter)) + 2
+    end
+
+    def timeout_request(duration)
+      begin
+        Timeout.timeout(duration) do
+          yield
+        end
+      rescue Timeout::Error
+        client.responses.cancel(previous_response_id)
+      end
+    end
+
+    # :reek:DuplicateMethodCall
+    # :reek:TooManyStatements
+    def wait_for_response(timeout)
+        spinner = TTY::Spinner.new("[:spinner] Thinking ...", format: :dots)
+        spinner.auto_spin
+        api_response = client.responses.retrieve(previous_response_id)
+        number_of_times_polled = 0
+        response = timeout_request(timeout) do
+          while api_response.status != :completed
+            some_amount_of_seconds = calculate_wait(number_of_times_polled)
+            sleep some_amount_of_seconds
+            number_of_times_polled += 1
+            api_response = client.responses.retrieve(previous_response_id)
+          end
+          api_response
+        end
+
+        exit_message = response.status == :cancelled ? "request timed out" : "done!"
+        spinner.stop(exit_message)
+        response
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai-chat
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Raghu Betina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-08-18 00:00:00.000000000 Z
+date: 2025-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openai
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement