Add OPENAI_ADMIN_TOKEN and Usage endpoints

Author: alexrudall

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.4.0] - 2024-02-07
+
+### Added
+
+- Add support for OPENAI_ADMIN_TOKEN to allow for administrative endpoints to be called.
+- Add support for Usage endpoints.
+
 ## [7.3.1] - 2024-10-15
 
 ### Fixed

lib/openai.rb

@@ -18,10 +18,12 @@
 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)
@@ -41,6 +43,7 @@ def call(env)
 
   class Configuration
     attr_accessor :access_token,
+                  :admin_token,
                   :api_type,
                   :api_version,
                   :log_errors,
@@ -56,6 +59,7 @@ class Configuration
 
     def initialize
       @access_token = nil
+      @admin_token = nil
       @api_type = nil
       @api_version = DEFAULT_API_VERSION
       @log_errors = DEFAULT_LOG_ERRORS

lib/openai/client.rb

@@ -2,18 +2,20 @@ module OpenAI
   class Client
     include OpenAI::HTTP
 
-    SENSITIVE_ATTRIBUTES = %i[@access_token @organization_id @extra_headers].freeze
+    SENSITIVE_ATTRIBUTES = %i[@access_token @admin_token @organization_id @extra_headers].freeze
     CONFIG_KEYS = %i[
+      access_token
+      admin_token
       api_type
       api_version
-      access_token
+      extra_headers
       log_errors
       organization_id
-      uri_base
       request_timeout
-      extra_headers
+      uri_base
     ].freeze
     attr_reader *CONFIG_KEYS, :faraday_middleware
+    attr_writer :access_token
 
     def initialize(config = {}, &faraday_middleware)
       CONFIG_KEYS.each do |key|
@@ -99,10 +101,25 @@ def moderations(parameters: {})
       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(";"))

lib/openai/compatibility.rb

@@ -3,6 +3,7 @@ module OpenAI
     VERSION = ::OpenAI::VERSION
 
     Error = ::OpenAI::Error
+    AuthenticationError = ::OpenAI::AuthenticationError
     ConfigurationError = ::OpenAI::ConfigurationError
     Configuration = ::OpenAI::Configuration
     MiddlewareErrors = ::OpenAI::MiddlewareErrors

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