openai 0.70.0 → 0.72.0

data/lib/openai/models/admin/organization/projects/spend_limit_update_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::SpendLimit#update
+          class SpendLimitUpdateParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute project_id
+            #
+            #   @return [String]
+            required :project_id, String
+
+            # @!attribute currency
+            #   The currency for the threshold amount. Currently, only `USD` is supported.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::SpendLimitUpdateParams::Currency]
+            required :currency, enum: -> { OpenAI::Admin::Organization::Projects::SpendLimitUpdateParams::Currency }
+
+            # @!attribute interval
+            #   The time interval for evaluating spend against the threshold. Currently, only
+            #   `month` is supported.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::SpendLimitUpdateParams::Interval]
+            required :interval, enum: -> { OpenAI::Admin::Organization::Projects::SpendLimitUpdateParams::Interval }
+
+            # @!attribute threshold_amount
+            #   The hard spend limit amount, in cents.
+            #
+            #   @return [Integer]
+            required :threshold_amount, Integer
+
+            # @!method initialize(project_id:, currency:, interval:, threshold_amount:, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Admin::Organization::Projects::SpendLimitUpdateParams} for more
+            #   details.
+            #
+            #   @param project_id [String]
+            #
+            #   @param currency [Symbol, OpenAI::Models::Admin::Organization::Projects::SpendLimitUpdateParams::Currency] The currency for the threshold amount. Currently, only `USD` is supported.
+            #
+            #   @param interval [Symbol, OpenAI::Models::Admin::Organization::Projects::SpendLimitUpdateParams::Interval] The time interval for evaluating spend against the threshold. Currently, only `m
+            #
+            #   @param threshold_amount [Integer] The hard spend limit amount, in cents.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The currency for the threshold amount. Currently, only `USD` is supported.
+            module Currency
+              extend OpenAI::Internal::Type::Enum
+
+              USD = :USD
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The time interval for evaluating spend against the threshold. Currently, only
+            # `month` is supported.
+            module Interval
+              extend OpenAI::Internal::Type::Enum
+
+              MONTH = :month
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/spend_limit_delete_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::SpendLimit#delete
+        class SpendLimitDeleteParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/spend_limit_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::SpendLimit#retrieve
+        class SpendLimitRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/spend_limit_update_params.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::SpendLimit#update
+        class SpendLimitUpdateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute currency
+          #   The currency for the threshold amount. Currently, only `USD` is supported.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Currency]
+          required :currency, enum: -> { OpenAI::Admin::Organization::SpendLimitUpdateParams::Currency }
+
+          # @!attribute interval
+          #   The time interval for evaluating spend against the threshold. Currently, only
+          #   `month` is supported.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Interval]
+          required :interval, enum: -> { OpenAI::Admin::Organization::SpendLimitUpdateParams::Interval }
+
+          # @!attribute threshold_amount
+          #   The hard spend limit amount, in cents.
+          #
+          #   @return [Integer]
+          required :threshold_amount, Integer
+
+          # @!method initialize(currency:, interval:, threshold_amount:, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::SpendLimitUpdateParams} for more details.
+          #
+          #   @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Currency] The currency for the threshold amount. Currently, only `USD` is supported.
+          #
+          #   @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Interval] The time interval for evaluating spend against the threshold. Currently, only `m
+          #
+          #   @param threshold_amount [Integer] The hard spend limit amount, in cents.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # The currency for the threshold amount. Currently, only `USD` is supported.
+          module Currency
+            extend OpenAI::Internal::Type::Enum
+
+            USD = :USD
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The time interval for evaluating spend against the threshold. Currently, only
+          # `month` is supported.
+          module Interval
+            extend OpenAI::Internal::Type::Enum
+
+            MONTH = :month
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb

@@ -113,8 +113,9 @@ module OpenAI
 
               class OrganizationUsageCompletionsResult < OpenAI::Internal::Type::BaseModel
                 # @!attribute input_tokens
-                #   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.
                 #
                 #   @return [Integer]
                 required :input_tokens, Integer
@@ -131,8 +132,9 @@ module OpenAI
                 required :object, const: :"organization.usage.completions.result"
 
                 # @!attribute output_tokens
-                #   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.
                 #
                 #   @return [Integer]
                 required :output_tokens, Integer
@@ -152,19 +154,62 @@ module OpenAI
                 optional :batch, OpenAI::Internal::Type::Boolean, nil?: true
 
                 # @!attribute input_audio_tokens
-                #   The aggregated number of audio input tokens used, including cached tokens.
+                #   The aggregated number of uncached audio input tokens used.
                 #
                 #   @return [Integer, nil]
                 optional :input_audio_tokens, Integer
 
+                # @!attribute input_cache_write_tokens
+                #   The aggregated number of input tokens written to the cache.
+                #
+                #   @return [Integer, nil]
+                optional :input_cache_write_tokens, Integer
+
+                # @!attribute input_cached_audio_tokens
+                #   The aggregated number of cached audio input tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :input_cached_audio_tokens, Integer
+
+                # @!attribute input_cached_image_tokens
+                #   The aggregated number of cached image input tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :input_cached_image_tokens, Integer
+
+                # @!attribute input_cached_text_tokens
+                #   The aggregated number of cached text input tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :input_cached_text_tokens, Integer
+
                 # @!attribute input_cached_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 cached input tokens used across text, audio, and image
+                #   inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
                 #
                 #   @return [Integer, nil]
                 optional :input_cached_tokens, Integer
 
+                # @!attribute input_image_tokens
+                #   The aggregated number of uncached image input tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :input_image_tokens, Integer
+
+                # @!attribute input_text_tokens
+                #   The aggregated number of uncached text input tokens used, excluding cache-write
+                #   tokens.
+                #
+                #   @return [Integer, nil]
+                optional :input_text_tokens, Integer
+
+                # @!attribute input_uncached_tokens
+                #   The aggregated number of uncached input tokens used across text, audio, and
+                #   image inputs, excluding cache-write tokens.
+                #
+                #   @return [Integer, nil]
+                optional :input_uncached_tokens, Integer
+
                 # @!attribute model
                 #   When `group_by=model`, this field provides the model name of the grouped usage
                 #   result.
@@ -178,6 +223,18 @@ module OpenAI
                 #   @return [Integer, nil]
                 optional :output_audio_tokens, Integer
 
+                # @!attribute output_image_tokens
+                #   The aggregated number of image output tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :output_image_tokens, Integer
+
+                # @!attribute output_text_tokens
+                #   The aggregated number of text output tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :output_text_tokens, Integer
+
                 # @!attribute project_id
                 #   When `group_by=project_id`, this field provides the project ID of the grouped
                 #   usage result.
@@ -199,31 +256,49 @@ module OpenAI
                 #   @return [String, nil]
                 optional :user_id, String, nil?: true
 
-                # @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cached_tokens: nil, model: nil, output_audio_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
+                # @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
                 #   Some parameter documentations has been truncated, see
                 #   {OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageCompletionsResult}
                 #   for more details.
                 #
                 #   The aggregated completions usage details of the specific time bucket.
                 #
-                #   @param input_tokens [Integer] The aggregated number of text input tokens used, including cached tokens. For cu
+                #   @param input_tokens [Integer] The aggregated number of input tokens used, including cached and cache-write tok
                 #
                 #   @param num_model_requests [Integer] The count of requests made to the model.
                 #
-                #   @param output_tokens [Integer] The aggregated number of text output tokens used. For customers subscribe to sca
+                #   @param output_tokens [Integer] The aggregated number of output tokens used across text, audio, and image output
                 #
                 #   @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
                 #
                 #   @param batch [Boolean, nil] When `group_by=batch`, this field tells whether the grouped usage result is batc
                 #
-                #   @param input_audio_tokens [Integer] The aggregated number of audio input tokens used, including cached tokens.
+                #   @param input_audio_tokens [Integer] The aggregated number of uncached audio input tokens used.
                 #
-                #   @param input_cached_tokens [Integer] The aggregated number of text input tokens that has been cached from previous re
+                #   @param input_cache_write_tokens [Integer] The aggregated number of input tokens written to the cache.
+                #
+                #   @param input_cached_audio_tokens [Integer] The aggregated number of cached audio input tokens used.
+                #
+                #   @param input_cached_image_tokens [Integer] The aggregated number of cached image input tokens used.
+                #
+                #   @param input_cached_text_tokens [Integer] The aggregated number of cached text input tokens used.
+                #
+                #   @param input_cached_tokens [Integer] The aggregated number of cached input tokens used across text, audio, and image
+                #
+                #   @param input_image_tokens [Integer] The aggregated number of uncached image input tokens used.
+                #
+                #   @param input_text_tokens [Integer] The aggregated number of uncached text input tokens used, excluding cache-write
+                #
+                #   @param input_uncached_tokens [Integer] The aggregated number of uncached input tokens used across text, audio, and imag
                 #
                 #   @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
                 #
                 #   @param output_audio_tokens [Integer] The aggregated number of audio output tokens used.
                 #
+                #   @param output_image_tokens [Integer] The aggregated number of image output tokens used.
+                #
+                #   @param output_text_tokens [Integer] The aggregated number of text output tokens used.
+                #
                 #   @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
                 #
                 #   @param service_tier [String, nil] When `group_by=service_tier`, this field provides the service tier of the groupe

data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb

@@ -113,8 +113,9 @@ module OpenAI
 
               class OrganizationUsageCompletionsResult < OpenAI::Internal::Type::BaseModel
                 # @!attribute input_tokens
-                #   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.
                 #
                 #   @return [Integer]
                 required :input_tokens, Integer
@@ -131,8 +132,9 @@ module OpenAI
                 required :object, const: :"organization.usage.completions.result"
 
                 # @!attribute output_tokens
-                #   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.
                 #
                 #   @return [Integer]
                 required :output_tokens, Integer
@@ -152,19 +154,62 @@ module OpenAI
                 optional :batch, OpenAI::Internal::Type::Boolean, nil?: true
 
                 # @!attribute input_audio_tokens
-                #   The aggregated number of audio input tokens used, including cached tokens.
+                #   The aggregated number of uncached audio input tokens used.
                 #
                 #   @return [Integer, nil]
                 optional :input_audio_tokens, Integer
 
+                # @!attribute input_cache_write_tokens
+                #   The aggregated number of input tokens written to the cache.
+                #
+                #   @return [Integer, nil]
+                optional :input_cache_write_tokens, Integer
+
+                # @!attribute input_cached_audio_tokens
+                #   The aggregated number of cached audio input tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :input_cached_audio_tokens, Integer
+
+                # @!attribute input_cached_image_tokens
+                #   The aggregated number of cached image input tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :input_cached_image_tokens, Integer
+
+                # @!attribute input_cached_text_tokens
+                #   The aggregated number of cached text input tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :input_cached_text_tokens, Integer
+
                 # @!attribute input_cached_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 cached input tokens used across text, audio, and image
+                #   inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
                 #
                 #   @return [Integer, nil]
                 optional :input_cached_tokens, Integer
 
+                # @!attribute input_image_tokens
+                #   The aggregated number of uncached image input tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :input_image_tokens, Integer
+
+                # @!attribute input_text_tokens
+                #   The aggregated number of uncached text input tokens used, excluding cache-write
+                #   tokens.
+                #
+                #   @return [Integer, nil]
+                optional :input_text_tokens, Integer
+
+                # @!attribute input_uncached_tokens
+                #   The aggregated number of uncached input tokens used across text, audio, and
+                #   image inputs, excluding cache-write tokens.
+                #
+                #   @return [Integer, nil]
+                optional :input_uncached_tokens, Integer
+
                 # @!attribute model
                 #   When `group_by=model`, this field provides the model name of the grouped usage
                 #   result.
@@ -178,6 +223,18 @@ module OpenAI
                 #   @return [Integer, nil]
                 optional :output_audio_tokens, Integer
 
+                # @!attribute output_image_tokens
+                #   The aggregated number of image output tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :output_image_tokens, Integer
+
+                # @!attribute output_text_tokens
+                #   The aggregated number of text output tokens used.
+                #
+                #   @return [Integer, nil]
+                optional :output_text_tokens, Integer
+
                 # @!attribute project_id
                 #   When `group_by=project_id`, this field provides the project ID of the grouped
                 #   usage result.
@@ -199,31 +256,49 @@ module OpenAI
                 #   @return [String, nil]
                 optional :user_id, String, nil?: true
 
-                # @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cached_tokens: nil, model: nil, output_audio_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
+                # @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
                 #   Some parameter documentations has been truncated, see
                 #   {OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageCompletionsResult}
                 #   for more details.
                 #
                 #   The aggregated completions usage details of the specific time bucket.
                 #
-                #   @param input_tokens [Integer] The aggregated number of text input tokens used, including cached tokens. For cu
+                #   @param input_tokens [Integer] The aggregated number of input tokens used, including cached and cache-write tok
                 #
                 #   @param num_model_requests [Integer] The count of requests made to the model.
                 #
-                #   @param output_tokens [Integer] The aggregated number of text output tokens used. For customers subscribe to sca
+                #   @param output_tokens [Integer] The aggregated number of output tokens used across text, audio, and image output
                 #
                 #   @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
                 #
                 #   @param batch [Boolean, nil] When `group_by=batch`, this field tells whether the grouped usage result is batc
                 #
-                #   @param input_audio_tokens [Integer] The aggregated number of audio input tokens used, including cached tokens.
+                #   @param input_audio_tokens [Integer] The aggregated number of uncached audio input tokens used.
                 #
-                #   @param input_cached_tokens [Integer] The aggregated number of text input tokens that has been cached from previous re
+                #   @param input_cache_write_tokens [Integer] The aggregated number of input tokens written to the cache.
+                #
+                #   @param input_cached_audio_tokens [Integer] The aggregated number of cached audio input tokens used.
+                #
+                #   @param input_cached_image_tokens [Integer] The aggregated number of cached image input tokens used.
+                #
+                #   @param input_cached_text_tokens [Integer] The aggregated number of cached text input tokens used.
+                #
+                #   @param input_cached_tokens [Integer] The aggregated number of cached input tokens used across text, audio, and image
+                #
+                #   @param input_image_tokens [Integer] The aggregated number of uncached image input tokens used.
+                #
+                #   @param input_text_tokens [Integer] The aggregated number of uncached text input tokens used, excluding cache-write
+                #
+                #   @param input_uncached_tokens [Integer] The aggregated number of uncached input tokens used across text, audio, and imag
                 #
                 #   @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
                 #
                 #   @param output_audio_tokens [Integer] The aggregated number of audio output tokens used.
                 #
+                #   @param output_image_tokens [Integer] The aggregated number of image output tokens used.
+                #
+                #   @param output_text_tokens [Integer] The aggregated number of text output tokens used.
+                #
                 #   @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
                 #
                 #   @param service_tier [String, nil] When `group_by=service_tier`, this field provides the service tier of the groupe