ruby-openai 7.4.0 → 8.3.0

data/lib/openai/conversations.rb

@@ -0,0 +1,40 @@
+module OpenAI
+  class Conversations
+    def initialize(client:)
+      @client = client
+    end
+
+    def retrieve(id:)
+      @client.get(path: "/conversations/#{id}")
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/conversations", parameters: parameters)
+    end
+
+    def modify(id:, parameters: {})
+      @client.json_post(path: "/conversations/#{id}", parameters: parameters)
+    end
+
+    def delete(id:)
+      @client.delete(path: "/conversations/#{id}")
+    end
+
+    # Item operations within a conversation
+    def create_items(conversation_id:, parameters: {})
+      @client.json_post(path: "/conversations/#{conversation_id}/items", parameters: parameters)
+    end
+
+    def list_items(conversation_id:, parameters: {})
+      @client.get(path: "/conversations/#{conversation_id}/items", parameters: parameters)
+    end
+
+    def get_item(conversation_id:, item_id:)
+      @client.get(path: "/conversations/#{conversation_id}/items/#{item_id}")
+    end
+
+    def delete_item(conversation_id:, item_id:)
+      @client.delete(path: "/conversations/#{conversation_id}/items/#{item_id}")
+    end
+  end
+end

data/lib/openai/files.rb

@@ -5,6 +5,8 @@ module OpenAI
       batch
       fine-tune
       vision
+      user_data
+      evals
     ].freeze
 
     def initialize(client:)
@@ -18,9 +20,7 @@ module OpenAI
     def upload(parameters: {})
       file_input = parameters[:file]
       file = prepare_file_input(file_input: file_input)
-
       validate(file: file, purpose: parameters[:purpose], file_input: file_input)
-
       @client.multipart_post(
         path: "/files",
         parameters: parameters.merge(file: file)
@@ -29,12 +29,12 @@ module OpenAI
       file.close if file.is_a?(File)
     end
 
-    def retrieve(id:)
-      @client.get(path: "/files/#{id}")
+    def retrieve(id:, parameters: {})
+      @client.get(path: "/files/#{id}", parameters: parameters)
     end
 
-    def content(id:)
-      @client.get(path: "/files/#{id}/content")
+    def content(id:, parameters: {})
+      @client.get(path: "/files/#{id}/content", parameters: parameters)
     end
 
     def delete(id:)
@@ -55,8 +55,12 @@ module OpenAI
 
     def validate(file:, purpose:, file_input:)
       raise ArgumentError, "`file` is required" if file.nil?
+
       unless PURPOSES.include?(purpose)
-        raise ArgumentError, "`purpose` must be one of `#{PURPOSES.join(',')}`"
+        filename = file_input.is_a?(String) ? File.basename(file_input) : "uploaded file"
+        message = "The purpose '#{purpose}' for file '#{filename}' is not in the known purpose "
+        message += "list: #{PURPOSES.join(', ')}."
+        OpenAI.log_message("Warning", message, :warn)
       end
 
       validate_jsonl(file: file) if file_input.is_a?(String) && file_input.end_with?(".jsonl")

data/lib/openai/http.rb

@@ -7,68 +7,52 @@ module OpenAI
     include HTTPHeaders
 
     def get(path:, parameters: nil)
-      parse_jsonl(conn.get(uri(path: path), parameters) do |req|
+      parse_json(conn.get(uri(path: path), parameters) do |req|
         req.headers = headers
       end&.body)
     end
 
     def post(path:)
-      parse_jsonl(conn.post(uri(path: path)) do |req|
+      parse_json(conn.post(uri(path: path)) do |req|
         req.headers = headers
       end&.body)
     end
 
     def json_post(path:, parameters:, query_parameters: {})
-      conn.post(uri(path: path)) do |req|
+      parse_json(conn.post(uri(path: path)) do |req|
         configure_json_post_request(req, parameters)
         req.params = req.params.merge(query_parameters)
-      end&.body
+      end&.body)
     end
 
     def multipart_post(path:, parameters: nil)
-      conn(multipart: true).post(uri(path: path)) do |req|
+      parse_json(conn(multipart: true).post(uri(path: path)) do |req|
         req.headers = headers.merge({ "Content-Type" => "multipart/form-data" })
         req.body = multipart_parameters(parameters)
-      end&.body
+      end&.body)
     end
 
     def delete(path:)
-      conn.delete(uri(path: path)) do |req|
+      parse_json(conn.delete(uri(path: path)) do |req|
         req.headers = headers
-      end&.body
+      end&.body)
     end
 
     private
 
-    def parse_jsonl(response)
+    def parse_json(response)
       return unless response
       return response unless response.is_a?(String)
 
-      # Convert a multiline string of JSON objects to a JSON array.
-      response = response.gsub("}\n{", "},{").prepend("[").concat("]")
+      original_response = response.dup
+      if response.include?("}\n{")
+        # Attempt to convert what looks like a multiline string of JSON objects to a JSON array.
+        response = response.gsub("}\n{", "},{").prepend("[").concat("]")
+      end
 
       JSON.parse(response)
-    end
-
-    # Given a proc, returns an outer proc that can be used to iterate over a JSON stream of chunks.
-    # For each chunk, the inner user_proc is called giving it the JSON object. The JSON object could
-    # be a data object or an error object as described in the OpenAI API documentation.
-    #
-    # @param user_proc [Proc] The inner proc to call for each JSON object in the chunk.
-    # @return [Proc] An outer proc that iterates over a raw stream, converting it to JSON.
-    def to_json_stream(user_proc:)
-      parser = EventStreamParser::Parser.new
-
-      proc do |chunk, _bytes, env|
-        if env && env.status != 200
-          raise_error = Faraday::Response::RaiseError.new
-          raise_error.on_complete(env.merge(body: try_parse_json(chunk)))
-        end
-
-        parser.feed(chunk) do |_type, data|
-          user_proc.call(JSON.parse(data)) unless data == "[DONE]"
-        end
-      end
+    rescue JSON::ParserError
+      original_response
     end
 
     def conn(multipart: false)
@@ -115,7 +99,7 @@ module OpenAI
       req_parameters = parameters.dup
 
       if parameters[:stream].respond_to?(:call)
-        req.options.on_data = to_json_stream(user_proc: parameters[:stream])
+        req.options.on_data = Stream.new(user_proc: parameters[:stream]).to_proc
         req_parameters[:stream] = true # Necessary to tell OpenAI to stream.
       elsif parameters[:stream]
         raise ArgumentError, "The stream parameter must be a Proc or have a #call method"
@@ -124,11 +108,5 @@ module OpenAI
       req.headers = headers
       req.body = req_parameters.to_json
     end
-
-    def try_parse_json(maybe_json)
-      JSON.parse(maybe_json)
-    rescue JSON::ParserError
-      maybe_json
-    end
   end
 end

data/lib/openai/images.rb

@@ -19,9 +19,23 @@ module OpenAI
     private
 
     def open_files(parameters)
-      parameters = parameters.merge(image: File.open(parameters[:image]))
-      parameters = parameters.merge(mask: File.open(parameters[:mask])) if parameters[:mask]
-      parameters
+      params = parameters.dup
+
+      if params[:image].is_a?(Array)
+        process_image_array(params)
+      else
+        params[:image] = File.open(params[:image])
+      end
+
+      params[:mask] = File.open(params[:mask]) if params[:mask]
+      params
+    end
+
+    def process_image_array(params)
+      params[:image].each_with_index do |img_path, index|
+        params[:"image[#{index}]"] = File.open(img_path)
+      end
+      params.delete(:image)
     end
   end
 end

data/lib/openai/models.rb

@@ -11,5 +11,9 @@ module OpenAI
     def retrieve(id:)
       @client.get(path: "/models/#{id}")
     end
+
+    def delete(id:)
+      @client.delete(path: "/models/#{id}")
+    end
   end
 end

data/lib/openai/realtime.rb

@@ -0,0 +1,19 @@
+module OpenAI
+  class Realtime
+    def initialize(client:)
+      @client = client.beta(realtime: "v1")
+    end
+
+    # Create a new real-time session with OpenAI.
+    #
+    # This method sets up a new session for real-time voice interaction with an OpenAI model.
+    # It returns session details that can be used to establish a WebRTC connection.
+    #
+    # @param parameters [Hash] parameters for the session (see: https://platform.openai.com/docs/api-reference/realtime-sessions/create)
+    # @return [Hash] Session details including session ID, ICE servers, and other
+    # connection information
+    def create(parameters: {})
+      @client.json_post(path: "/realtime/sessions", parameters: parameters)
+    end
+  end
+end

data/lib/openai/responses.rb

@@ -0,0 +1,23 @@
+module OpenAI
+  class Responses
+    def initialize(client:)
+      @client = client
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/responses", parameters: parameters)
+    end
+
+    def retrieve(response_id:)
+      @client.get(path: "/responses/#{response_id}")
+    end
+
+    def delete(response_id:)
+      @client.delete(path: "/responses/#{response_id}")
+    end
+
+    def input_items(response_id:, parameters: {})
+      @client.get(path: "/responses/#{response_id}/input_items", parameters: parameters)
+    end
+  end
+end

data/lib/openai/stream.rb

@@ -0,0 +1,50 @@
+module OpenAI
+  class Stream
+    DONE = "[DONE]".freeze
+    private_constant :DONE
+
+    def initialize(user_proc:, parser: EventStreamParser::Parser.new)
+      @user_proc = user_proc
+      @parser = parser
+
+      # To be backwards compatible, we need to check how many arguments the user_proc takes.
+      @user_proc_arity =
+        case user_proc
+        when Proc
+          user_proc.arity.abs
+        else
+          user_proc.method(:call).arity.abs
+        end
+    end
+
+    def call(chunk, _bytes, env = nil)
+      handle_http_error(chunk: chunk, env: env) if env && env.status != 200
+
+      parser.feed(chunk) do |event, data|
+        next if data == DONE
+
+        args = [JSON.parse(data), event].first(user_proc_arity)
+        user_proc.call(*args)
+      end
+    end
+
+    def to_proc
+      method(:call).to_proc
+    end
+
+    private
+
+    attr_reader :user_proc, :parser, :user_proc_arity
+
+    def handle_http_error(chunk:, env:)
+      raise_error = Faraday::Response::RaiseError.new
+      raise_error.on_complete(env.merge(body: try_parse_json(chunk)))
+    end
+
+    def try_parse_json(maybe_json)
+      JSON.parse(maybe_json)
+    rescue JSON::ParserError
+      maybe_json
+    end
+  end
+end

data/lib/openai/vector_stores.rb

@@ -23,5 +23,9 @@ module OpenAI
     def delete(id:)
       @client.delete(path: "/vector_stores/#{id}")
     end
+
+    def search(id:, parameters: {})
+      @client.json_post(path: "/vector_stores/#{id}/search", parameters: parameters)
+    end
   end
 end

data/lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "7.4.0".freeze
+  VERSION = "8.3.0".freeze
 end

data/lib/openai.rb

@@ -1,17 +1,19 @@
 require "faraday"
-require "faraday/multipart"
-
+require "faraday/multipart" if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new("2.0")
 require_relative "openai/http"
 require_relative "openai/client"
 require_relative "openai/files"
 require_relative "openai/finetunes"
 require_relative "openai/images"
 require_relative "openai/models"
+require_relative "openai/responses"
 require_relative "openai/assistants"
 require_relative "openai/threads"
 require_relative "openai/messages"
+require_relative "openai/realtime"
 require_relative "openai/runs"
 require_relative "openai/run_steps"
+require_relative "openai/stream"
 require_relative "openai/vector_stores"
 require_relative "openai/vector_store_files"
 require_relative "openai/vector_store_file_batches"
@@ -19,6 +21,7 @@ require_relative "openai/audio"
 require_relative "openai/version"
 require_relative "openai/batches"
 require_relative "openai/usage"
+require_relative "openai/conversations"
 
 module OpenAI
   class Error < StandardError; end
@@ -31,12 +34,7 @@ module OpenAI
     rescue Faraday::Error => e
       raise e unless e.response.is_a?(Hash)
 
-      logger = Logger.new($stdout)
-      logger.formatter = proc do |_severity, _datetime, _progname, msg|
-        "\033[31mOpenAI HTTP Error (spotted in ruby-openai #{VERSION}): #{msg}\n\033[0m"
-      end
-      logger.error(e.response[:body])
-
+      OpenAI.log_message("OpenAI HTTP Error", e.response[:body], :error)
       raise e
     end
   end
@@ -72,25 +70,38 @@ module OpenAI
 
   class << self
     attr_writer :configuration
-  end
 
-  def self.configuration
-    @configuration ||= OpenAI::Configuration.new
-  end
+    def configuration
+      @configuration ||= OpenAI::Configuration.new
+    end
 
-  def self.configure
-    yield(configuration)
-  end
+    def configure
+      yield(configuration)
+    end
 
-  # Estimate the number of tokens in a string, using the rules of thumb from OpenAI:
-  # https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them
-  def self.rough_token_count(content = "")
-    raise ArgumentError, "rough_token_count requires a string" unless content.is_a? String
-    return 0 if content.empty?
+    # Estimate the number of tokens in a string, using the rules of thumb from OpenAI:
+    # https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them
+    def rough_token_count(content = "")
+      raise ArgumentError, "rough_token_count requires a string" unless content.is_a? String
+      return 0 if content.empty?
+
+      count_by_chars = content.size / 4.0
+      count_by_words = content.split.size * 4.0 / 3
+      estimate = ((count_by_chars + count_by_words) / 2.0).round
+      [1, estimate].max
+    end
 
-    count_by_chars = content.size / 4.0
-    count_by_words = content.split.size * 4.0 / 3
-    estimate = ((count_by_chars + count_by_words) / 2.0).round
-    [1, estimate].max
+    # Log a message with appropriate formatting
+    # @param prefix [String] Prefix to add to the message
+    # @param message [String] The message to log
+    # @param level [Symbol] The log level (:error, :warn, etc.)
+    def log_message(prefix, message, level = :warn)
+      color = level == :error ? "\033[31m" : "\033[33m"
+      logger = Logger.new($stdout)
+      logger.formatter = proc do |_severity, _datetime, _progname, msg|
+        "#{color}#{prefix} (spotted in ruby-openai #{VERSION}): #{msg}\n\033[0m"
+      end
+      logger.send(level, message)
+    end
   end
 end

data/lib/ruby/openai.rb

@@ -1,2 +1 @@
 require_relative "../openai"
-require_relative "../openai/compatibility"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 8.3.0
 platform: ruby
 authors:
 - Alex
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -58,7 +57,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-description:
 email:
 - alexrudall@users.noreply.github.com
 executables: []
@@ -84,6 +82,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - bin/console
 - bin/setup
 - lib/openai.rb
@@ -91,7 +90,7 @@ files:
 - lib/openai/audio.rb
 - lib/openai/batches.rb
 - lib/openai/client.rb
-- lib/openai/compatibility.rb
+- lib/openai/conversations.rb
 - lib/openai/files.rb
 - lib/openai/finetunes.rb
 - lib/openai/http.rb
@@ -99,8 +98,11 @@ files:
 - lib/openai/images.rb
 - lib/openai/messages.rb
 - lib/openai/models.rb
+- lib/openai/realtime.rb
+- lib/openai/responses.rb
 - lib/openai/run_steps.rb
 - lib/openai/runs.rb
+- lib/openai/stream.rb
 - lib/openai/threads.rb
 - lib/openai/usage.rb
 - lib/openai/vector_store_file_batches.rb
@@ -119,7 +121,6 @@ metadata:
   changelog_uri: https://github.com/alexrudall/ruby-openai/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
   funding_uri: https://github.com/sponsors/alexrudall
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: "OpenAI API + Ruby! \U0001F916❤️"
 test_files: []

data/lib/openai/compatibility.rb

@@ -1,11 +0,0 @@
-module Ruby
-  module OpenAI
-    VERSION = ::OpenAI::VERSION
-
-    Error = ::OpenAI::Error
-    AuthenticationError = ::OpenAI::AuthenticationError
-    ConfigurationError = ::OpenAI::ConfigurationError
-    Configuration = ::OpenAI::Configuration
-    MiddlewareErrors = ::OpenAI::MiddlewareErrors
-  end
-end