openai 0.117.0 → 0.118.0

data/lib/openai/models/responses/response_usage.rb

@@ -68,7 +68,15 @@ module OpenAI
           #   @return [Integer]
           required :cached_tokens, Integer
 
-          # @!method initialize(cache_write_tokens:, cached_tokens:)
+          # @!attribute cache_write_tokens_details
+          #
+          #   @return [OpenAI::Models::Responses::ResponseUsage::InputTokensDetails::CacheWriteTokensDetails, nil]
+          optional(
+            :cache_write_tokens_details,
+            -> { OpenAI::Responses::ResponseUsage::InputTokensDetails::CacheWriteTokensDetails }
+          )
+
+          # @!method initialize(cache_write_tokens:, cached_tokens:, cache_write_tokens_details: nil)
           #   A detailed breakdown of the input tokens.
           #
           #   @param cache_write_tokens [Integer]
@@ -77,6 +85,30 @@ module OpenAI
           #   @param cached_tokens [Integer]
           #     The number of tokens that were retrieved from the cache.
           #     [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
+          #
+          #   @param cache_write_tokens_details [OpenAI::Models::Responses::ResponseUsage::InputTokensDetails::CacheWriteTokensDetails]
+
+          # @see OpenAI::Models::Responses::ResponseUsage::InputTokensDetails#cache_write_tokens_details
+          class CacheWriteTokensDetails < OpenAI::Internal::Type::BaseModel
+            # @!attribute ttl_12h_tokens
+            #   The number of input tokens written with 12-hour retention.
+            #
+            #   @return [Integer]
+            required :ttl_12h_tokens, Integer
+
+            # @!attribute ttl_30m_tokens
+            #   The number of input tokens written with 30-minute retention.
+            #
+            #   @return [Integer]
+            required :ttl_30m_tokens, Integer
+
+            # @!method initialize(ttl_12h_tokens:, ttl_30m_tokens:)
+            #   @param ttl_12h_tokens [Integer]
+            #     The number of input tokens written with 12-hour retention.
+            #
+            #   @param ttl_30m_tokens [Integer]
+            #     The number of input tokens written with 30-minute retention.
+          end
         end
 
         # @see OpenAI::Models::Responses::ResponseUsage#output_tokens_details

data/lib/openai/models/responses/responses_client_event.rb

@@ -240,7 +240,7 @@ module OpenAI
           #   request can write up to four breakpoints. For cache matching, OpenAI considers
           #   up to the latest 80 breakpoints in the conversation, without a content-block
           #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
-          #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+          #   `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
           #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
           #   for current details.
           #
@@ -595,7 +595,7 @@ module OpenAI
           #     request can write up to four breakpoints. For cache matching, OpenAI considers
           #     up to the latest 80 breakpoints in the conversation, without a content-block
           #     lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
-          #     `ttl` defaults to `30m`, which is currently the only supported value. See the
+          #     `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
           #     [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
           #     for current details.
           #
@@ -1032,8 +1032,8 @@ module OpenAI
 
             # @!attribute ttl
             #   The minimum lifetime applied to every implicit and explicit cache breakpoint
-            #   written by the request. Defaults to `30m`, which is currently the only supported
-            #   value. The backend may retain cache entries for longer.
+            #   written by the request. Supported values are `30m` (the default) and `12h`. The
+            #   backend may retain cache entries for longer.
             #
             #   @return [Symbol, OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Ttl, nil]
             optional(
@@ -1048,7 +1048,7 @@ module OpenAI
             #   request can write up to four breakpoints. For cache matching, OpenAI considers
             #   up to the latest 80 breakpoints in the conversation, without a content-block
             #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
-            #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+            #   `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
             #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
             #   for current details.
             #
@@ -1070,8 +1070,8 @@ module OpenAI
             #
             #   @param ttl [Symbol, OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Ttl]
             #     The minimum lifetime applied to every implicit and explicit cache breakpoint
-            #     written by the request. Defaults to `30m`, which is currently the only supported
-            #     value. The backend may retain cache entries for longer.
+            #     written by the request. Supported values are `30m` (the default) and `12h`. The
+            #     backend may retain cache entries for longer.
 
             # Controls whether OpenAI automatically creates an implicit cache breakpoint.
             # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
@@ -1092,14 +1092,15 @@ module OpenAI
             end
 
             # The minimum lifetime applied to every implicit and explicit cache breakpoint
-            # written by the request. Defaults to `30m`, which is currently the only supported
-            # value. The backend may retain cache entries for longer.
+            # written by the request. Supported values are `30m` (the default) and `12h`. The
+            # backend may retain cache entries for longer.
             #
             # @see OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions#ttl
             module Ttl
               extend OpenAI::Internal::Type::Enum
 
               TTL_30M = :"30m"
+              TTL_12H = :"12h"
 
               # @!method self.values
               #   @return [Array<Symbol>]

data/lib/openai/resources/admin/organization/projects/service_tier_settings.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class ServiceTierSettings
+            # Retrieve the configured default and enabled service tiers for a project.
+            #
+            # @overload retrieve(project_id, request_options: {})
+            #
+            # @param project_id [String]
+            #   The ID of the project
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::ProjectServiceTierSettings]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ServiceTierSettingRetrieveParams
+            def retrieve(project_id, params = {})
+              @client.request(
+                method: :get,
+                path: ["organization/projects/%1$s/service_tier_settings", project_id],
+                model: OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings,
+                security: {admin_api_key_auth: true},
+                options: params[:request_options]
+              )
+            end
+
+            # Update the default or enabled service tiers atomically. Supply at least one
+            # field. Omitted fields keep their current values.
+            #
+            # @overload update(project_id, default: nil, enabled_tiers: nil, request_options: {})
+            #
+            # @param project_id [String]
+            #   The ID of the project
+            #
+            # @param default [Symbol, OpenAI::Models::Admin::Organization::Projects::ServiceTierSettingUpdateParams::Default]
+            #   Default tier for requests that omit service_tier or use auto.
+            #
+            # @param enabled_tiers [Symbol, :all, Array<Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectOptionalServiceTier>]
+            #   Additional service tiers enabled for this project. "all" includes future tiers.
+            #   An empty array allows only Standard. Organization policy and eligibility still
+            #   apply.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::ProjectServiceTierSettings]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ServiceTierSettingUpdateParams
+            def update(project_id, params = {})
+              parsed, options = OpenAI::Admin::Organization::Projects::ServiceTierSettingUpdateParams.dump_request(
+                params
+              )
+              @client.request(
+                method: :post,
+                path: ["organization/projects/%1$s/service_tier_settings", project_id],
+                body: parsed,
+                model: OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # @api private
+            #
+            # @param client [OpenAI::Client]
+            def initialize(client:)
+              @client = client
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/admin/organization/projects.rb

@@ -41,6 +41,9 @@ module OpenAI
           # @return [OpenAI::Resources::Admin::Organization::Projects::Certificates]
           attr_reader :certificates
 
+          # @return [OpenAI::Resources::Admin::Organization::Projects::ServiceTierSettings]
+          attr_reader :service_tier_settings
+
           # Create a new project in the organization. Projects can be created and archived,
           # but cannot be deleted.
           #
@@ -218,6 +221,9 @@ module OpenAI
             @spend_limit = OpenAI::Resources::Admin::Organization::Projects::SpendLimit.new(client: client)
             @spend_alerts = OpenAI::Resources::Admin::Organization::Projects::SpendAlerts.new(client: client)
             @certificates = OpenAI::Resources::Admin::Organization::Projects::Certificates.new(client: client)
+            @service_tier_settings = OpenAI::Resources::Admin::Organization::Projects::ServiceTierSettings.new(
+              client: client
+            )
           end
         end
       end

data/lib/openai/resources/beta/responses.rb

@@ -161,8 +161,8 @@ module OpenAI
         #   `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For
         #   cache matching, OpenAI considers up to the latest 80 breakpoints in the
         #   conversation, without a content-block lookback limit. Set `mode` to `explicit`
-        #   to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
-        #   currently the only supported value. See the
+        #   to disable the implicit breakpoint. The `ttl` defaults to `30m`. Supported
+        #   lifetimes depend on the API. See the
         #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
         #   for current details.
         #
@@ -462,8 +462,8 @@ module OpenAI
         #   `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For
         #   cache matching, OpenAI considers up to the latest 80 breakpoints in the
         #   conversation, without a content-block lookback limit. Set `mode` to `explicit`
-        #   to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
-        #   currently the only supported value. See the
+        #   to disable the implicit breakpoint. The `ttl` defaults to `30m`. Supported
+        #   lifetimes depend on the API. See the
         #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
         #   for current details.
         #
@@ -855,8 +855,8 @@ module OpenAI
         #   `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For
         #   cache matching, OpenAI considers up to the latest 80 breakpoints in the
         #   conversation, without a content-block lookback limit. Set `mode` to `explicit`
-        #   to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
-        #   currently the only supported value. See the
+        #   to disable the implicit breakpoint. The `ttl` defaults to `30m`. Supported
+        #   lifetimes depend on the API. See the
         #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
         #   for current details.
         #

data/lib/openai/resources/chat/completions.rb

@@ -171,7 +171,7 @@ module OpenAI
         #   request can write up to four breakpoints. For cache matching, OpenAI considers
         #   up to the latest 80 breakpoints in the conversation, without a content-block
         #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
-        #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+        #   `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
         #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
         #   for current details.
         #
@@ -508,7 +508,7 @@ module OpenAI
         #   request can write up to four breakpoints. For cache matching, OpenAI considers
         #   up to the latest 80 breakpoints in the conversation, without a content-block
         #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
-        #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+        #   `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
         #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
         #   for current details.
         #

data/lib/openai/resources/responses.rb

@@ -157,7 +157,7 @@ module OpenAI
       #   request can write up to four breakpoints. For cache matching, OpenAI considers
       #   up to the latest 80 breakpoints in the conversation, without a content-block
       #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
-      #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+      #   `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
       #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
       #   for current details.
       #
@@ -450,7 +450,7 @@ module OpenAI
       #   request can write up to four breakpoints. For cache matching, OpenAI considers
       #   up to the latest 80 breakpoints in the conversation, without a content-block
       #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
-      #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+      #   `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
       #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
       #   for current details.
       #
@@ -819,7 +819,7 @@ module OpenAI
       #   request can write up to four breakpoints. For cache matching, OpenAI considers
       #   up to the latest 80 breakpoints in the conversation, without a content-block
       #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
-      #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+      #   `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
       #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
       #   for current details.
       #

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.117.0"
+  VERSION = "0.118.0"
 end

data/lib/openai.rb

@@ -349,8 +349,10 @@ require_relative "openai/models/admin/organization/projects/project_group"
 require_relative "openai/models/admin/organization/projects/project_hosted_tool_permissions"
 require_relative "openai/models/admin/organization/projects/project_model_permissions"
 require_relative "openai/models/admin/organization/projects/project_model_permissions_deleted"
+require_relative "openai/models/admin/organization/projects/project_optional_service_tier"
 require_relative "openai/models/admin/organization/projects/project_rate_limit"
 require_relative "openai/models/admin/organization/projects/project_service_account"
+require_relative "openai/models/admin/organization/projects/project_service_tier_settings"
 require_relative "openai/models/admin/organization/projects/project_spend_alert"
 require_relative "openai/models/admin/organization/projects/project_spend_alert_deleted"
 require_relative "openai/models/admin/organization/projects/project_spend_limit"
@@ -373,6 +375,8 @@ require_relative "openai/models/admin/organization/projects/service_account_retr
 require_relative "openai/models/admin/organization/projects/service_accounts/api_key_create_params"
 require_relative "openai/models/admin/organization/projects/service_accounts/api_key_create_response"
 require_relative "openai/models/admin/organization/projects/service_account_update_params"
+require_relative "openai/models/admin/organization/projects/service_tier_setting_retrieve_params"
+require_relative "openai/models/admin/organization/projects/service_tier_setting_update_params"
 require_relative "openai/models/admin/organization/projects/spend_alert_create_params"
 require_relative "openai/models/admin/organization/projects/spend_alert_delete_params"
 require_relative "openai/models/admin/organization/projects/spend_alert_list_params"
@@ -1592,6 +1596,7 @@ require_relative "openai/resources/admin/organization/projects/rate_limits"
 require_relative "openai/resources/admin/organization/projects/roles"
 require_relative "openai/resources/admin/organization/projects/service_accounts"
 require_relative "openai/resources/admin/organization/projects/service_accounts/api_keys"
+require_relative "openai/resources/admin/organization/projects/service_tier_settings"
 require_relative "openai/resources/admin/organization/projects/spend_alerts"
 require_relative "openai/resources/admin/organization/projects/spend_limit"
 require_relative "openai/resources/admin/organization/projects/users"

data/rbi/openai/models/admin/organization/projects/project_optional_service_tier.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Admin
+
+      module Organization
+
+        ProjectOptionalServiceTier = Projects::ProjectOptionalServiceTier
+
+        module Projects
+
+          module ProjectOptionalServiceTier
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FLEX = T.let(:flex, OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol)
+            FAST = T.let(:fast, OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol)
+            ULTRAFAST = T.let(
+              :ultrafast,
+              OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol
+            )
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/admin/organization/projects/project_service_tier_settings.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Admin
+
+      module Organization
+
+        ProjectServiceTierSettings = Projects::ProjectServiceTierSettings
+
+        module Projects
+
+          class ProjectServiceTierSettings < OpenAI::Internal::Type::BaseModel
+
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # Default tier for requests that omit service_tier or use auto.
+            sig { returns(OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol) }
+            attr_accessor :default
+
+            # Additional service tiers enabled for this project. "all" includes future tiers.
+            # An empty array allows only Standard. Organization policy and eligibility still
+            # apply.
+            sig { returns(OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::EnabledTiers::Variants) }
+            attr_accessor :enabled_tiers
+
+            sig { returns(Symbol) }
+            attr_accessor :object
+
+            sig do
+              params(
+
+                default: OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::OrSymbol,
+
+                enabled_tiers: T.any(
+                  Symbol,
+                  T::Array[OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::OrSymbol]
+                ),
+
+                object: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # Default tier for requests that omit service_tier or use auto.
+              default:,
+
+              # Additional service tiers enabled for this project. "all" includes future tiers.
+              # An empty array allows only Standard. Organization policy and eligibility still
+              # apply.
+              enabled_tiers:,
+
+              object: :"project.service_tier_settings"
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  default: OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol,
+                  enabled_tiers: OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::EnabledTiers::Variants,
+                  object: Symbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Default tier for requests that omit service_tier or use auto.
+            module Default
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol = T.type_alias {
+                T.all(Symbol, OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default)
+              }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              STANDARD = T.let(
+                :standard,
+                OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol
+              )
+              FAST = T.let(
+                :fast,
+                OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol
+              )
+              SCALE = T.let(
+                :scale,
+                OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol
+              )
+
+              sig {
+                override.returns(
+                  T::Array[OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol]
+                )
+              }
+              def self.values
+              end
+            end
+
+            # Additional service tiers enabled for this project. "all" includes future tiers.
+            # An empty array allows only Standard. Organization policy and eligibility still
+            # apply.
+            module EnabledTiers
+              extend OpenAI::Internal::Type::Union
+
+              Variants = T.type_alias {
+                T.any(Symbol, T::Array[OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol])
+              }
+
+              sig {
+                override.returns(
+                  T::Array[OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::EnabledTiers::Variants]
+                )
+              }
+              def self.variants
+              end
+
+              ProjectOptionalServiceTierArray = T.let(
+                OpenAI::Internal::Type::ArrayOf[
+                  enum: -> { OpenAI::Models::Admin::Organization::Projects::ProjectOptionalServiceTier }
+                ],
+                OpenAI::Internal::Type::Converter
+              )
+
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/admin/organization/projects/service_tier_setting_retrieve_params.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Admin
+
+      module Organization
+
+        module Projects
+
+          class ServiceTierSettingRetrieveParams < OpenAI::Internal::Type::BaseModel
+
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::Projects::ServiceTierSettingRetrieveParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The ID of the project
+            sig { returns(String) }
+            attr_accessor :project_id
+
+            sig do
+              params(
+
+                project_id: String,
+
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The ID of the project
+              project_id:,
+
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {project_id: String, request_options: OpenAI::RequestOptions}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end