ruby-openai 7.3.1 → 8.0.0

data/lib/openai/batches.rb

@@ -1,7 +1,7 @@
 module OpenAI
   class Batches
     def initialize(client:)
-      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
+      @client = client
     end
 
     def list(parameters: {})

data/lib/openai/client.rb

@@ -2,18 +2,11 @@ module OpenAI
   class Client
     include OpenAI::HTTP
 
-    SENSITIVE_ATTRIBUTES = %i[@access_token @organization_id @extra_headers].freeze
-    CONFIG_KEYS = %i[
-      api_type
-      api_version
-      access_token
-      log_errors
-      organization_id
-      uri_base
-      request_timeout
-      extra_headers
-    ].freeze
-    attr_reader *CONFIG_KEYS, :faraday_middleware
+    SENSITIVE_ATTRIBUTES = %i[@access_token @admin_token @organization_id @extra_headers].freeze
+    CONFIG_KEYS = %i[access_token admin_token api_type api_version extra_headers
+                     log_errors organization_id request_timeout uri_base].freeze
+    attr_reader(*CONFIG_KEYS, :faraday_middleware)
+    attr_writer :access_token
 
     def initialize(config = {}, &faraday_middleware)
       CONFIG_KEYS.each do |key|
@@ -59,6 +52,10 @@ module OpenAI
       @models ||= OpenAI::Models.new(client: self)
     end
 
+    def responses
+      @responses ||= OpenAI::Responses.new(client: self)
+    end
+
     def assistants
       @assistants ||= OpenAI::Assistants.new(client: self)
     end
@@ -99,10 +96,25 @@ module OpenAI
       json_post(path: "/moderations", parameters: parameters)
     end
 
+    def usage
+      @usage ||= OpenAI::Usage.new(client: self)
+    end
+
     def azure?
       @api_type&.to_sym == :azure
     end
 
+    def admin
+      unless admin_token
+        e = "You must set an OPENAI_ADMIN_TOKEN= to use administrative endpoints:\n\n  https://platform.openai.com/settings/organization/admin-keys"
+        raise AuthenticationError, e
+      end
+
+      dup.tap do |client|
+        client.access_token = client.admin_token
+      end
+    end
+
     def beta(apis)
       dup.tap do |client|
         client.add_headers("OpenAI-Beta": apis.map { |k, v| "#{k}=#{v}" }.join(";"))

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)
@@ -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,47 +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)
+    rescue JSON::ParserError
+      original_response
     end
 
     # Given a proc, returns an outer proc that can be used to iterate over a JSON stream of chunks.

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/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/usage.rb

@@ -0,0 +1,70 @@
+module OpenAI
+  class Usage
+    def initialize(client:)
+      @client = client
+    end
+
+    def completions(parameters: {})
+      @client.admin.get(
+        path: "/organization/usage/completions",
+        parameters: parameters
+      )
+    end
+
+    def embeddings(parameters: {})
+      @client.admin.get(
+        path: "/organization/usage/embeddings",
+        parameters: parameters
+      )
+    end
+
+    def moderations(parameters: {})
+      @client.admin.get(
+        path: "/organization/usage/moderations",
+        parameters: parameters
+      )
+    end
+
+    def images(parameters: {})
+      @client.admin.get(
+        path: "/organization/usage/images",
+        parameters: parameters
+      )
+    end
+
+    def audio_speeches(parameters: {})
+      @client.admin.get(
+        path: "/organization/usage/audio_speeches",
+        parameters: parameters
+      )
+    end
+
+    def audio_transcriptions(parameters: {})
+      @client.admin.get(
+        path: "/organization/usage/audio_transcriptions",
+        parameters: parameters
+      )
+    end
+
+    def vector_stores(parameters: {})
+      @client.admin.get(
+        path: "/organization/usage/vector_stores",
+        parameters: parameters
+      )
+    end
+
+    def code_interpreter_sessions(parameters: {})
+      @client.admin.get(
+        path: "/organization/usage/code_interpreter_sessions",
+        parameters: parameters
+      )
+    end
+
+    def costs(parameters: {})
+      @client.admin.get(
+        path: "/organization/costs",
+        parameters: parameters
+      )
+    end
+  end
+end

data/lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "7.3.1".freeze
+  VERSION = "8.0.0".freeze
 end

data/lib/openai.rb

@@ -1,12 +1,12 @@
 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"
@@ -18,10 +18,12 @@ require_relative "openai/vector_store_file_batches"
 require_relative "openai/audio"
 require_relative "openai/version"
 require_relative "openai/batches"
+require_relative "openai/usage"
 
 module OpenAI
   class Error < StandardError; end
   class ConfigurationError < Error; end
+  class AuthenticationError < Error; end
 
   class MiddlewareErrors < Faraday::Middleware
     def call(env)
@@ -29,18 +31,14 @@ 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
 
   class Configuration
     attr_accessor :access_token,
+                  :admin_token,
                   :api_type,
                   :api_version,
                   :log_errors,
@@ -56,6 +54,7 @@ module OpenAI
 
     def initialize
       @access_token = nil
+      @admin_token = nil
       @api_type = nil
       @api_version = DEFAULT_API_VERSION
       @log_errors = DEFAULT_LOG_ERRORS
@@ -68,25 +67,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,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 7.3.1
+  version: 8.0.0
 platform: ruby
 authors:
 - Alex
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -91,7 +91,6 @@ files:
 - lib/openai/audio.rb
 - lib/openai/batches.rb
 - lib/openai/client.rb
-- lib/openai/compatibility.rb
 - lib/openai/files.rb
 - lib/openai/finetunes.rb
 - lib/openai/http.rb
@@ -99,9 +98,11 @@ files:
 - lib/openai/images.rb
 - lib/openai/messages.rb
 - lib/openai/models.rb
+- lib/openai/responses.rb
 - lib/openai/run_steps.rb
 - lib/openai/runs.rb
 - lib/openai/threads.rb
+- lib/openai/usage.rb
 - lib/openai/vector_store_file_batches.rb
 - lib/openai/vector_store_files.rb
 - lib/openai/vector_stores.rb

data/lib/openai/compatibility.rb

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