openai 0.70.0 → 0.71.0

data/rbi/openai/models/admin/organization/projects/service_accounts/api_key_create_response.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module ServiceAccounts
+            class APIKeyCreateResponse < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Models::Admin::Organization::Projects::ServiceAccounts::APIKeyCreateResponse,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # The identifier of the API key.
+              sig { returns(String) }
+              attr_accessor :id
+
+              # The Unix timestamp (in seconds) when the API key was created.
+              sig { returns(Integer) }
+              attr_accessor :created_at
+
+              # The name of the API key.
+              sig { returns(String) }
+              attr_accessor :name
+
+              # The object type, which is always `organization.project.service_account.api_key`
+              sig { returns(Symbol) }
+              attr_accessor :object
+
+              # The unredacted API key value.
+              sig { returns(String) }
+              attr_accessor :value
+
+              sig do
+                params(
+                  id: String,
+                  created_at: Integer,
+                  name: String,
+                  value: String,
+                  object: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The identifier of the API key.
+                id:,
+                # The Unix timestamp (in seconds) when the API key was created.
+                created_at:,
+                # The name of the API key.
+                name:,
+                # The unredacted API key value.
+                value:,
+                # The object type, which is always `organization.project.service_account.api_key`
+                object: :"organization.project.service_account.api_key"
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    id: String,
+                    created_at: Integer,
+                    name: String,
+                    object: Symbol,
+                    value: String
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi

@@ -160,8 +160,9 @@ module OpenAI
                     )
                   end
 
-                # The aggregated number of text input tokens used, including cached tokens. For
-                # customers subscribe to scale tier, this includes scale tier tokens.
+                # The aggregated number of input tokens used, including cached and cache-write
+                # tokens. This includes text, audio, and image tokens. For customers subscribed to
+                # Scale Tier, this includes Scale Tier tokens.
                 sig { returns(Integer) }
                 attr_accessor :input_tokens
 
@@ -172,8 +173,9 @@ module OpenAI
                 sig { returns(Symbol) }
                 attr_accessor :object
 
-                # The aggregated number of text output tokens used. For customers subscribe to
-                # scale tier, this includes scale tier tokens.
+                # The aggregated number of output tokens used across text, audio, and image
+                # outputs. For customers subscribed to Scale Tier, this includes Scale Tier
+                # tokens.
                 sig { returns(Integer) }
                 attr_accessor :output_tokens
 
@@ -187,22 +189,72 @@ module OpenAI
                 sig { returns(T.nilable(T::Boolean)) }
                 attr_accessor :batch
 
-                # The aggregated number of audio input tokens used, including cached tokens.
+                # The aggregated number of uncached audio input tokens used.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_audio_tokens
 
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of text input tokens that has been cached from previous
-                # requests. For customers subscribe to scale tier, this includes scale tier
-                # tokens.
+                # The aggregated number of input tokens written to the cache.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_tokens
+
+                sig { params(input_cache_write_tokens: Integer).void }
+                attr_writer :input_cache_write_tokens
+
+                # The aggregated number of cached audio input tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cached_audio_tokens
+
+                sig { params(input_cached_audio_tokens: Integer).void }
+                attr_writer :input_cached_audio_tokens
+
+                # The aggregated number of cached image input tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cached_image_tokens
+
+                sig { params(input_cached_image_tokens: Integer).void }
+                attr_writer :input_cached_image_tokens
+
+                # The aggregated number of cached text input tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cached_text_tokens
+
+                sig { params(input_cached_text_tokens: Integer).void }
+                attr_writer :input_cached_text_tokens
+
+                # The aggregated number of cached input tokens used across text, audio, and image
+                # inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cached_tokens
 
                 sig { params(input_cached_tokens: Integer).void }
                 attr_writer :input_cached_tokens
 
+                # The aggregated number of uncached image input tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_image_tokens
+
+                sig { params(input_image_tokens: Integer).void }
+                attr_writer :input_image_tokens
+
+                # The aggregated number of uncached text input tokens used, excluding cache-write
+                # tokens.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_text_tokens
+
+                sig { params(input_text_tokens: Integer).void }
+                attr_writer :input_text_tokens
+
+                # The aggregated number of uncached input tokens used across text, audio, and
+                # image inputs, excluding cache-write tokens.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_uncached_tokens
+
+                sig { params(input_uncached_tokens: Integer).void }
+                attr_writer :input_uncached_tokens
+
                 # When `group_by=model`, this field provides the model name of the grouped usage
                 # result.
                 sig { returns(T.nilable(String)) }
@@ -215,6 +267,20 @@ module OpenAI
                 sig { params(output_audio_tokens: Integer).void }
                 attr_writer :output_audio_tokens
 
+                # The aggregated number of image output tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :output_image_tokens
+
+                sig { params(output_image_tokens: Integer).void }
+                attr_writer :output_image_tokens
+
+                # The aggregated number of text output tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :output_text_tokens
+
+                sig { params(output_text_tokens: Integer).void }
+                attr_writer :output_text_tokens
+
                 # When `group_by=project_id`, this field provides the project ID of the grouped
                 # usage result.
                 sig { returns(T.nilable(String)) }
@@ -239,9 +305,18 @@ module OpenAI
                     api_key_id: T.nilable(String),
                     batch: T.nilable(T::Boolean),
                     input_audio_tokens: Integer,
+                    input_cache_write_tokens: Integer,
+                    input_cached_audio_tokens: Integer,
+                    input_cached_image_tokens: Integer,
+                    input_cached_text_tokens: Integer,
                     input_cached_tokens: Integer,
+                    input_image_tokens: Integer,
+                    input_text_tokens: Integer,
+                    input_uncached_tokens: Integer,
                     model: T.nilable(String),
                     output_audio_tokens: Integer,
+                    output_image_tokens: Integer,
+                    output_text_tokens: Integer,
                     project_id: T.nilable(String),
                     service_tier: T.nilable(String),
                     user_id: T.nilable(String),
@@ -249,13 +324,15 @@ module OpenAI
                   ).returns(T.attached_class)
                 end
                 def self.new(
-                  # The aggregated number of text input tokens used, including cached tokens. For
-                  # customers subscribe to scale tier, this includes scale tier tokens.
+                  # The aggregated number of input tokens used, including cached and cache-write
+                  # tokens. This includes text, audio, and image tokens. For customers subscribed to
+                  # Scale Tier, this includes Scale Tier tokens.
                   input_tokens:,
                   # The count of requests made to the model.
                   num_model_requests:,
-                  # The aggregated number of text output tokens used. For customers subscribe to
-                  # scale tier, this includes scale tier tokens.
+                  # The aggregated number of output tokens used across text, audio, and image
+                  # outputs. For customers subscribed to Scale Tier, this includes Scale Tier
+                  # tokens.
                   output_tokens:,
                   # When `group_by=api_key_id`, this field provides the API key ID of the grouped
                   # usage result.
@@ -263,17 +340,36 @@ module OpenAI
                   # When `group_by=batch`, this field tells whether the grouped usage result is
                   # batch or not.
                   batch: nil,
-                  # The aggregated number of audio input tokens used, including cached tokens.
+                  # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
-                  # The aggregated number of text input tokens that has been cached from previous
-                  # requests. For customers subscribe to scale tier, this includes scale tier
-                  # tokens.
+                  # The aggregated number of input tokens written to the cache.
+                  input_cache_write_tokens: nil,
+                  # The aggregated number of cached audio input tokens used.
+                  input_cached_audio_tokens: nil,
+                  # The aggregated number of cached image input tokens used.
+                  input_cached_image_tokens: nil,
+                  # The aggregated number of cached text input tokens used.
+                  input_cached_text_tokens: nil,
+                  # The aggregated number of cached input tokens used across text, audio, and image
+                  # inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
                   input_cached_tokens: nil,
+                  # The aggregated number of uncached image input tokens used.
+                  input_image_tokens: nil,
+                  # The aggregated number of uncached text input tokens used, excluding cache-write
+                  # tokens.
+                  input_text_tokens: nil,
+                  # The aggregated number of uncached input tokens used across text, audio, and
+                  # image inputs, excluding cache-write tokens.
+                  input_uncached_tokens: nil,
                   # When `group_by=model`, this field provides the model name of the grouped usage
                   # result.
                   model: nil,
                   # The aggregated number of audio output tokens used.
                   output_audio_tokens: nil,
+                  # The aggregated number of image output tokens used.
+                  output_image_tokens: nil,
+                  # The aggregated number of text output tokens used.
+                  output_text_tokens: nil,
                   # When `group_by=project_id`, this field provides the project ID of the grouped
                   # usage result.
                   project_id: nil,
@@ -297,9 +393,18 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_tokens: Integer,
+                      input_cached_audio_tokens: Integer,
+                      input_cached_image_tokens: Integer,
+                      input_cached_text_tokens: Integer,
                       input_cached_tokens: Integer,
+                      input_image_tokens: Integer,
+                      input_text_tokens: Integer,
+                      input_uncached_tokens: Integer,
                       model: T.nilable(String),
                       output_audio_tokens: Integer,
+                      output_image_tokens: Integer,
+                      output_text_tokens: Integer,
                       project_id: T.nilable(String),
                       service_tier: T.nilable(String),
                       user_id: T.nilable(String)

data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi

@@ -160,8 +160,9 @@ module OpenAI
                     )
                   end
 
-                # The aggregated number of text input tokens used, including cached tokens. For
-                # customers subscribe to scale tier, this includes scale tier tokens.
+                # The aggregated number of input tokens used, including cached and cache-write
+                # tokens. This includes text, audio, and image tokens. For customers subscribed to
+                # Scale Tier, this includes Scale Tier tokens.
                 sig { returns(Integer) }
                 attr_accessor :input_tokens
 
@@ -172,8 +173,9 @@ module OpenAI
                 sig { returns(Symbol) }
                 attr_accessor :object
 
-                # The aggregated number of text output tokens used. For customers subscribe to
-                # scale tier, this includes scale tier tokens.
+                # The aggregated number of output tokens used across text, audio, and image
+                # outputs. For customers subscribed to Scale Tier, this includes Scale Tier
+                # tokens.
                 sig { returns(Integer) }
                 attr_accessor :output_tokens
 
@@ -187,22 +189,72 @@ module OpenAI
                 sig { returns(T.nilable(T::Boolean)) }
                 attr_accessor :batch
 
-                # The aggregated number of audio input tokens used, including cached tokens.
+                # The aggregated number of uncached audio input tokens used.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_audio_tokens
 
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of text input tokens that has been cached from previous
-                # requests. For customers subscribe to scale tier, this includes scale tier
-                # tokens.
+                # The aggregated number of input tokens written to the cache.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_tokens
+
+                sig { params(input_cache_write_tokens: Integer).void }
+                attr_writer :input_cache_write_tokens
+
+                # The aggregated number of cached audio input tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cached_audio_tokens
+
+                sig { params(input_cached_audio_tokens: Integer).void }
+                attr_writer :input_cached_audio_tokens
+
+                # The aggregated number of cached image input tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cached_image_tokens
+
+                sig { params(input_cached_image_tokens: Integer).void }
+                attr_writer :input_cached_image_tokens
+
+                # The aggregated number of cached text input tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cached_text_tokens
+
+                sig { params(input_cached_text_tokens: Integer).void }
+                attr_writer :input_cached_text_tokens
+
+                # The aggregated number of cached input tokens used across text, audio, and image
+                # inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cached_tokens
 
                 sig { params(input_cached_tokens: Integer).void }
                 attr_writer :input_cached_tokens
 
+                # The aggregated number of uncached image input tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_image_tokens
+
+                sig { params(input_image_tokens: Integer).void }
+                attr_writer :input_image_tokens
+
+                # The aggregated number of uncached text input tokens used, excluding cache-write
+                # tokens.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_text_tokens
+
+                sig { params(input_text_tokens: Integer).void }
+                attr_writer :input_text_tokens
+
+                # The aggregated number of uncached input tokens used across text, audio, and
+                # image inputs, excluding cache-write tokens.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_uncached_tokens
+
+                sig { params(input_uncached_tokens: Integer).void }
+                attr_writer :input_uncached_tokens
+
                 # When `group_by=model`, this field provides the model name of the grouped usage
                 # result.
                 sig { returns(T.nilable(String)) }
@@ -215,6 +267,20 @@ module OpenAI
                 sig { params(output_audio_tokens: Integer).void }
                 attr_writer :output_audio_tokens
 
+                # The aggregated number of image output tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :output_image_tokens
+
+                sig { params(output_image_tokens: Integer).void }
+                attr_writer :output_image_tokens
+
+                # The aggregated number of text output tokens used.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :output_text_tokens
+
+                sig { params(output_text_tokens: Integer).void }
+                attr_writer :output_text_tokens
+
                 # When `group_by=project_id`, this field provides the project ID of the grouped
                 # usage result.
                 sig { returns(T.nilable(String)) }
@@ -239,9 +305,18 @@ module OpenAI
                     api_key_id: T.nilable(String),
                     batch: T.nilable(T::Boolean),
                     input_audio_tokens: Integer,
+                    input_cache_write_tokens: Integer,
+                    input_cached_audio_tokens: Integer,
+                    input_cached_image_tokens: Integer,
+                    input_cached_text_tokens: Integer,
                     input_cached_tokens: Integer,
+                    input_image_tokens: Integer,
+                    input_text_tokens: Integer,
+                    input_uncached_tokens: Integer,
                     model: T.nilable(String),
                     output_audio_tokens: Integer,
+                    output_image_tokens: Integer,
+                    output_text_tokens: Integer,
                     project_id: T.nilable(String),
                     service_tier: T.nilable(String),
                     user_id: T.nilable(String),
@@ -249,13 +324,15 @@ module OpenAI
                   ).returns(T.attached_class)
                 end
                 def self.new(
-                  # The aggregated number of text input tokens used, including cached tokens. For
-                  # customers subscribe to scale tier, this includes scale tier tokens.
+                  # The aggregated number of input tokens used, including cached and cache-write
+                  # tokens. This includes text, audio, and image tokens. For customers subscribed to
+                  # Scale Tier, this includes Scale Tier tokens.
                   input_tokens:,
                   # The count of requests made to the model.
                   num_model_requests:,
-                  # The aggregated number of text output tokens used. For customers subscribe to
-                  # scale tier, this includes scale tier tokens.
+                  # The aggregated number of output tokens used across text, audio, and image
+                  # outputs. For customers subscribed to Scale Tier, this includes Scale Tier
+                  # tokens.
                   output_tokens:,
                   # When `group_by=api_key_id`, this field provides the API key ID of the grouped
                   # usage result.
@@ -263,17 +340,36 @@ module OpenAI
                   # When `group_by=batch`, this field tells whether the grouped usage result is
                   # batch or not.
                   batch: nil,
-                  # The aggregated number of audio input tokens used, including cached tokens.
+                  # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
-                  # The aggregated number of text input tokens that has been cached from previous
-                  # requests. For customers subscribe to scale tier, this includes scale tier
-                  # tokens.
+                  # The aggregated number of input tokens written to the cache.
+                  input_cache_write_tokens: nil,
+                  # The aggregated number of cached audio input tokens used.
+                  input_cached_audio_tokens: nil,
+                  # The aggregated number of cached image input tokens used.
+                  input_cached_image_tokens: nil,
+                  # The aggregated number of cached text input tokens used.
+                  input_cached_text_tokens: nil,
+                  # The aggregated number of cached input tokens used across text, audio, and image
+                  # inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
                   input_cached_tokens: nil,
+                  # The aggregated number of uncached image input tokens used.
+                  input_image_tokens: nil,
+                  # The aggregated number of uncached text input tokens used, excluding cache-write
+                  # tokens.
+                  input_text_tokens: nil,
+                  # The aggregated number of uncached input tokens used across text, audio, and
+                  # image inputs, excluding cache-write tokens.
+                  input_uncached_tokens: nil,
                   # When `group_by=model`, this field provides the model name of the grouped usage
                   # result.
                   model: nil,
                   # The aggregated number of audio output tokens used.
                   output_audio_tokens: nil,
+                  # The aggregated number of image output tokens used.
+                  output_image_tokens: nil,
+                  # The aggregated number of text output tokens used.
+                  output_text_tokens: nil,
                   # When `group_by=project_id`, this field provides the project ID of the grouped
                   # usage result.
                   project_id: nil,
@@ -297,9 +393,18 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_tokens: Integer,
+                      input_cached_audio_tokens: Integer,
+                      input_cached_image_tokens: Integer,
+                      input_cached_text_tokens: Integer,
                       input_cached_tokens: Integer,
+                      input_image_tokens: Integer,
+                      input_text_tokens: Integer,
+                      input_uncached_tokens: Integer,
                       model: T.nilable(String),
                       output_audio_tokens: Integer,
+                      output_image_tokens: Integer,
+                      output_text_tokens: Integer,
                       project_id: T.nilable(String),
                       service_tier: T.nilable(String),
                       user_id: T.nilable(String)