openai 0.70.0 → 0.72.0

data/lib/openai/models/admin/organization/usage_moderations_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::UsageModerationsResponse::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_vector_stores_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::UsageVectorStoresResponse::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_web_search_calls_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::UsageWebSearchCallsResponse::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/beta/beta_response.rb

@@ -204,7 +204,7 @@ module OpenAI
         #   [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
         #
         #   @return [String, nil]
-        optional :prompt_cache_key, String
+        optional :prompt_cache_key, String, nil?: true
 
         # @!attribute prompt_cache_options
         #   The prompt-caching options that were applied to the response. Supported for
@@ -257,7 +257,7 @@ module OpenAI
         #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
         #
         #   @return [String, nil]
-        optional :safety_identifier, String
+        optional :safety_identifier, String, nil?: true
 
         # @!attribute service_tier
         #   Specifies the processing type used for serving the request.
@@ -382,7 +382,7 @@ module OpenAI
         #
         #   @param prompt [OpenAI::Models::Beta::BetaResponsePrompt, nil] Reference to a prompt template and its variables.
         #
-        #   @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+        #   @param prompt_cache_key [String, nil] Used by OpenAI to cache responses for similar requests to optimize your cache hi
         #
         #   @param prompt_cache_options [OpenAI::Models::Beta::BetaResponse::PromptCacheOptions] The prompt-caching options that were applied to the response. Supported for `gpt
         #
@@ -390,7 +390,7 @@ module OpenAI
         #
         #   @param reasoning [OpenAI::Models::Beta::BetaResponse::Reasoning, nil] **gpt-5 and o-series models only**
         #
-        #   @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+        #   @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
         #
         #   @param service_tier [Symbol, OpenAI::Models::Beta::BetaResponse::ServiceTier, nil] Specifies the processing type used for serving the request.
         #
@@ -1190,7 +1190,10 @@ module OpenAI
         # @see OpenAI::Models::Beta::BetaResponse#reasoning
         class Reasoning < OpenAI::Internal::Type::BaseModel
           # @!attribute context
-          #   Controls which reasoning items are rendered back to the model on later turns.
+          #   Controls which reasoning items are rendered back to the model on later turns. If
+          #   omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+          #   model family defaults to `all_turns`; earlier models default to `current_turn`.
+          #
           #   When returned on a response, this is the effective reasoning context mode used
           #   for the response.
           #
@@ -1260,7 +1263,10 @@ module OpenAI
           #
           #   @param summary [Symbol, OpenAI::Models::Beta::BetaResponse::Reasoning::Summary, nil] A summary of the reasoning performed by the model. This can be
 
-          # Controls which reasoning items are rendered back to the model on later turns.
+          # Controls which reasoning items are rendered back to the model on later turns. If
+          # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+          # model family defaults to `all_turns`; earlier models default to `current_turn`.
+          #
           # When returned on a response, this is the effective reasoning context mode used
           # for the response.
           #

data/lib/openai/models/beta/beta_response_error.rb

@@ -35,6 +35,7 @@ module OpenAI
           SERVER_ERROR = :server_error
           RATE_LIMIT_EXCEEDED = :rate_limit_exceeded
           INVALID_PROMPT = :invalid_prompt
+          DATA_RESIDENCY_MISMATCH = :data_residency_mismatch
           BIO_POLICY = :bio_policy
           VECTOR_STORE_TIMEOUT = :vector_store_timeout
           INVALID_IMAGE = :invalid_image