openai 0.84.0 → 0.86.0

data/rbi/openai/models/realtime/input_audio_buffer_clear_event.rbi

@@ -49,7 +49,7 @@ module OpenAI
 
         sig do
           override.returns(
-            {type: Symbol, event_id: String}
+            {type: Symbol, event_id: T.nilable(String)}
           )
         end
         def to_hash

data/rbi/openai/models/realtime/input_audio_buffer_commit_event.rbi

@@ -55,7 +55,7 @@ module OpenAI
 
         sig do
           override.returns(
-            {type: Symbol, event_id: String}
+            {type: Symbol, event_id: T.nilable(String)}
           )
         end
         def to_hash

data/rbi/openai/models/realtime/output_audio_buffer_clear_event.rbi

@@ -52,7 +52,7 @@ module OpenAI
 
         sig do
           override.returns(
-            {type: Symbol, event_id: String}
+            {type: Symbol, event_id: T.nilable(String)}
           )
         end
         def to_hash

data/rbi/openai/models/realtime/rate_limits_updated_event.rbi

@@ -132,10 +132,10 @@ module OpenAI
           sig do
             override.returns(
               {
-                limit: Integer,
-                name: OpenAI::Realtime::RateLimitsUpdatedEvent::RateLimit::Name::OrSymbol,
-                remaining: Integer,
-                reset_seconds: Float
+                limit: T.nilable(Integer),
+                name: T.nilable(OpenAI::Realtime::RateLimitsUpdatedEvent::RateLimit::Name::OrSymbol),
+                remaining: T.nilable(Integer),
+                reset_seconds: T.nilable(Float)
               }
             )
           end

data/rbi/openai/models/realtime/response_cancel_event.rbi

@@ -66,7 +66,7 @@ module OpenAI
 
         sig do
           override.returns(
-            {type: Symbol, event_id: String, response_id: String}
+            {type: Symbol, event_id: T.nilable(String), response_id: T.nilable(String)}
           )
         end
         def to_hash

data/rbi/openai/models/realtime/response_content_part_added_event.rbi

@@ -178,10 +178,10 @@ module OpenAI
           sig do
             override.returns(
               {
-                audio: String,
-                text: String,
-                transcript: String,
-                type: OpenAI::Realtime::ResponseContentPartAddedEvent::Part::Type::OrSymbol
+                audio: T.nilable(String),
+                text: T.nilable(String),
+                transcript: T.nilable(String),
+                type: T.nilable(OpenAI::Realtime::ResponseContentPartAddedEvent::Part::Type::OrSymbol)
               }
             )
           end

data/rbi/openai/models/realtime/response_content_part_done_event.rbi

@@ -178,10 +178,10 @@ module OpenAI
           sig do
             override.returns(
               {
-                audio: String,
-                text: String,
-                transcript: String,
-                type: OpenAI::Realtime::ResponseContentPartDoneEvent::Part::Type::OrSymbol
+                audio: T.nilable(String),
+                text: T.nilable(String),
+                transcript: T.nilable(String),
+                type: T.nilable(OpenAI::Realtime::ResponseContentPartDoneEvent::Part::Type::OrSymbol)
               }
             )
           end

data/rbi/openai/models/realtime/response_create_event.rbi

@@ -85,7 +85,11 @@ module OpenAI
 
         sig do
           override.returns(
-            {type: Symbol, event_id: String, response: OpenAI::Realtime::RealtimeResponseCreateParams}
+            {
+              type: Symbol,
+              event_id: T.nilable(String),
+              response: T.nilable(OpenAI::Realtime::RealtimeResponseCreateParams)
+            }
           )
         end
         def to_hash

data/rbi/openai/models/realtime/session_update_event.rbi

@@ -89,7 +89,7 @@ module OpenAI
                 OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
               ),
               type: Symbol,
-              event_id: String
+              event_id: T.nilable(String)
             }
           )
         end

data/rbi/openai/models/responses/custom_tool.rbi

@@ -26,6 +26,14 @@ module OpenAI
         sig { returns(T.nilable(T::Array[OpenAI::Responses::CustomTool::AllowedCaller::OrSymbol])) }
         attr_accessor :allowed_callers
 
+        # Whether the tool response can be returned asynchronously versus immediately
+        # returned on next response creation.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :async
+
+        sig { params(async: T::Boolean).void }
+        attr_writer :async
+
         # Whether this tool should be deferred and discovered via tool search.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :defer_loading
@@ -61,6 +69,8 @@ module OpenAI
 
             allowed_callers: T.nilable(T::Array[OpenAI::Responses::CustomTool::AllowedCaller::OrSymbol]),
 
+            async: T::Boolean,
+
             defer_loading: T::Boolean,
 
             description: String,
@@ -79,6 +89,10 @@ module OpenAI
           # The tool invocation context(s).
           allowed_callers: nil,
 
+          # Whether the tool response can be returned asynchronously versus immediately
+          # returned on next response creation.
+          async: nil,
+
           # Whether this tool should be deferred and discovered via tool search.
           defer_loading: nil,
 
@@ -100,6 +114,7 @@ module OpenAI
               name: String,
               type: Symbol,
               allowed_callers: T.nilable(T::Array[OpenAI::Responses::CustomTool::AllowedCaller::OrSymbol]),
+              async: T::Boolean,
               defer_loading: T::Boolean,
               description: String,
               format_: T.any(OpenAI::CustomToolInputFormat::Text, OpenAI::CustomToolInputFormat::Grammar)

data/rbi/openai/models/responses/function_tool.rbi

@@ -34,6 +34,12 @@ module OpenAI
         sig { returns(T.nilable(T::Array[OpenAI::Responses::FunctionTool::AllowedCaller::OrSymbol])) }
         attr_accessor :allowed_callers
 
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :async
+
+        sig { params(async: T::Boolean).void }
+        attr_writer :async
+
         # Whether this function is deferred and loaded via tool search.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :defer_loading
@@ -65,6 +71,8 @@ module OpenAI
 
             allowed_callers: T.nilable(T::Array[OpenAI::Responses::FunctionTool::AllowedCaller::OrSymbol]),
 
+            async: T::Boolean,
+
             defer_loading: T::Boolean,
 
             description: T.nilable(String),
@@ -89,6 +97,8 @@ module OpenAI
           # The tool invocation context(s).
           allowed_callers: nil,
 
+          async: nil,
+
           # Whether this function is deferred and loaded via tool search.
           defer_loading: nil,
 
@@ -114,6 +124,7 @@ module OpenAI
               strict: T.nilable(T::Boolean),
               type: Symbol,
               allowed_callers: T.nilable(T::Array[OpenAI::Responses::FunctionTool::AllowedCaller::OrSymbol]),
+              async: T::Boolean,
               defer_loading: T::Boolean,
               description: T.nilable(String),
               output_schema: T.nilable(T::Hash[Symbol, T.anything])

data/rbi/openai/models/responses/namespace_tool.rbi

@@ -106,6 +106,14 @@ module OpenAI
             }
             attr_accessor :allowed_callers
 
+            # Whether the tool response can be returned asynchronously versus immediately
+            # returned on next response creation.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :async
+
+            sig { params(async: T::Boolean).void }
+            attr_writer :async
+
             # Whether this function should be deferred and discovered via tool search.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :defer_loading
@@ -139,6 +147,8 @@ module OpenAI
                   T::Array[OpenAI::Responses::NamespaceTool::Tool::Function::AllowedCaller::OrSymbol]
                 ),
 
+                async: T::Boolean,
+
                 defer_loading: T::Boolean,
 
                 description: T.nilable(String),
@@ -160,6 +170,10 @@ module OpenAI
               # The tool invocation context(s).
               allowed_callers: nil,
 
+              # Whether the tool response can be returned asynchronously versus immediately
+              # returned on next response creation.
+              async: nil,
+
               # Whether this function should be deferred and discovered via tool search.
               defer_loading: nil,
 
@@ -188,6 +202,7 @@ module OpenAI
                   allowed_callers: T.nilable(
                     T::Array[OpenAI::Responses::NamespaceTool::Tool::Function::AllowedCaller::OrSymbol]
                   ),
+                  async: T::Boolean,
                   defer_loading: T::Boolean,
                   description: T.nilable(String),
                   output_schema: T.nilable(T::Hash[Symbol, T.anything]),

data/rbi/openai/models/responses/response.rbi

@@ -53,7 +53,7 @@ module OpenAI
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_accessor :metadata
 
-        # Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
+        # Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
         # range of models with different capabilities, performance characteristics, and
         # price points. Refer to the
         # [model guide](https://platform.openai.com/docs/models) to browse and compare
@@ -181,6 +181,23 @@ module OpenAI
         sig { params(prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash)).void }
         attr_writer :prompt
 
+        # Prompt cache diagnostics requested for this response.
+        sig { returns(T.nilable(OpenAI::Responses::Response::PromptCacheDiagnostics::Variants)) }
+        attr_reader :prompt_cache_diagnostics
+
+        sig {
+          params(
+            prompt_cache_diagnostics: T.any(
+              OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::OrHash,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::CacheHit::OrHash,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::ComparisonResponseNotFound::OrHash,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::Unavailable::OrHash
+            )
+          )
+            .void
+        }
+        attr_writer :prompt_cache_diagnostics
+
         # Used by OpenAI to cache responses for similar requests to optimize your cache
         # hit rates. Replaces the `user` field.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
@@ -418,6 +435,13 @@ module OpenAI
 
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
 
+            prompt_cache_diagnostics: T.any(
+              OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::OrHash,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::CacheHit::OrHash,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::ComparisonResponseNotFound::OrHash,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::Unavailable::OrHash
+            ),
+
             prompt_cache_key: T.nilable(String),
 
             prompt_cache_options: OpenAI::Responses::Response::PromptCacheOptions::OrHash,
@@ -475,7 +499,7 @@ module OpenAI
           # a maximum length of 512 characters.
           metadata:,
 
-          # Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
+          # Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
           # range of models with different capabilities, performance characteristics, and
           # price points. Refer to the
           # [model guide](https://platform.openai.com/docs/models) to browse and compare
@@ -570,6 +594,9 @@ module OpenAI
           # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
           prompt: nil,
 
+          # Prompt cache diagnostics requested for this response.
+          prompt_cache_diagnostics: nil,
+
           # Used by OpenAI to cache responses for similar requests to optimize your cache
           # hit rates. Replaces the `user` field.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
@@ -703,6 +730,7 @@ module OpenAI
               moderation: T.nilable(OpenAI::Responses::Response::Moderation),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
+              prompt_cache_diagnostics: OpenAI::Responses::Response::PromptCacheDiagnostics::Variants,
               prompt_cache_key: T.nilable(String),
               prompt_cache_options: OpenAI::Responses::Response::PromptCacheOptions,
               prompt_cache_retention: T.nilable(OpenAI::Responses::Response::PromptCacheRetention::TaggedSymbol),
@@ -729,7 +757,9 @@ module OpenAI
             )
           end
 
-          # The reason why the response is incomplete.
+          # The reason why the response is incomplete. `steered` means the response stopped
+          # at a safe output boundary after a WebSocket `response.steer` event. The server
+          # can then create a successor response automatically with the queued input.
           sig { returns(T.nilable(OpenAI::Responses::Response::IncompleteDetails::Reason::TaggedSymbol)) }
           attr_reader :reason
 
@@ -746,7 +776,9 @@ module OpenAI
           end
           def self.new(
 
-            # The reason why the response is incomplete.
+            # The reason why the response is incomplete. `steered` means the response stopped
+            # at a safe output boundary after a WebSocket `response.steer` event. The server
+            # can then create a successor response automatically with the queued input.
 
             reason: nil
           )
@@ -760,7 +792,9 @@ module OpenAI
           def to_hash
           end
 
-          # The reason why the response is incomplete.
+          # The reason why the response is incomplete. `steered` means the response stopped
+          # at a safe output boundary after a WebSocket `response.steer` event. The server
+          # can then create a successor response automatically with the queued input.
           module Reason
             extend OpenAI::Internal::Type::Enum
 
@@ -776,6 +810,7 @@ module OpenAI
               :content_filter,
               OpenAI::Responses::Response::IncompleteDetails::Reason::TaggedSymbol
             )
+            STEERED = T.let(:steered, OpenAI::Responses::Response::IncompleteDetails::Reason::TaggedSymbol)
 
             sig { override.returns(T::Array[OpenAI::Responses::Response::IncompleteDetails::Reason::TaggedSymbol]) }
             def self.values
@@ -1394,6 +1429,252 @@ module OpenAI
           end
         end
 
+        # Prompt cache diagnostics requested for this response.
+        module PromptCacheDiagnostics
+          extend OpenAI::Internal::Type::Union
+
+          Variants = T.type_alias {
+            T.any(
+              OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::CacheHit,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::ComparisonResponseNotFound,
+              OpenAI::Responses::Response::PromptCacheDiagnostics::Unavailable
+            )
+          }
+
+          class CacheMiss < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The estimated number of input tokens affected after the first detected
+            # divergence.
+            sig { returns(Integer) }
+            attr_accessor :cache_missed_tokens
+
+            # The reason prompt cache reuse did not occur.
+            sig { returns(OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol) }
+            attr_accessor :reason
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # The raw token count of the reusable prefix in the compared response.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :comparison_reusable_tokens
+
+            sig { params(comparison_reusable_tokens: Integer).void }
+            attr_writer :comparison_reusable_tokens
+
+            sig do
+              params(
+
+                cache_missed_tokens: Integer,
+
+                reason: OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::OrSymbol,
+
+                comparison_reusable_tokens: Integer,
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The estimated number of input tokens affected after the first detected
+              # divergence.
+              cache_missed_tokens:,
+
+              # The reason prompt cache reuse did not occur.
+              reason:,
+
+              # The raw token count of the reusable prefix in the compared response.
+              comparison_reusable_tokens: nil,
+
+              type: :cache_miss
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  cache_missed_tokens: Integer,
+                  reason: OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol,
+                  type: Symbol,
+                  comparison_reusable_tokens: Integer
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The reason prompt cache reuse did not occur.
+            module Reason
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol = T.type_alias {
+                T.all(Symbol, OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason)
+              }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MODEL_CHANGED = T.let(
+                :model_changed,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+              PROMPT_CACHE_KEY_CHANGED = T.let(
+                :prompt_cache_key_changed,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+              TOOLS_CHANGED = T.let(
+                :tools_changed,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+              TEXT_FORMAT_CHANGED = T.let(
+                :text_format_changed,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+              REASONING_EFFORT_CHANGED = T.let(
+                :reasoning_effort_changed,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+              VERBOSITY_CHANGED = T.let(
+                :verbosity_changed,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+              CONTEXT_COMPACTED = T.let(
+                :context_compacted,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+              INPUT_CHANGED = T.let(
+                :input_changed,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+              SERVICE_TIER_CHANGED = T.let(
+                :service_tier_changed,
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol
+              )
+
+              sig {
+                override.returns(
+                  T::Array[OpenAI::Responses::Response::PromptCacheDiagnostics::CacheMiss::Reason::TaggedSymbol]
+                )
+              }
+              def self.values
+              end
+            end
+          end
+
+          class CacheHit < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Responses::Response::PromptCacheDiagnostics::CacheHit,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              type: :cache_hit
+            )
+            end
+
+            sig do
+              override.returns(
+                {type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          class ComparisonResponseNotFound < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Responses::Response::PromptCacheDiagnostics::ComparisonResponseNotFound,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              type: :comparison_response_not_found
+            )
+            end
+
+            sig do
+              override.returns(
+                {type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          class Unavailable < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Responses::Response::PromptCacheDiagnostics::Unavailable,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              type: :unavailable
+            )
+            end
+
+            sig do
+              override.returns(
+                {type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          sig { override.returns(T::Array[OpenAI::Responses::Response::PromptCacheDiagnostics::Variants]) }
+          def self.variants
+          end
+
+        end
+
         class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
           OrHash = T.type_alias do
             T.any(
@@ -1410,6 +1691,10 @@ module OpenAI
           sig { returns(OpenAI::Responses::Response::PromptCacheOptions::Ttl::TaggedSymbol) }
           attr_accessor :ttl
 
+          # The response ID supplied as the prompt cache diagnostics comparison.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :comparison_response_id
+
           # The prompt-caching options that were applied to the response. Supported for
           # `gpt-5.6` and later models.
           sig do
@@ -1417,7 +1702,9 @@ module OpenAI
 
               mode: OpenAI::Responses::Response::PromptCacheOptions::Mode::OrSymbol,
 
-              ttl: OpenAI::Responses::Response::PromptCacheOptions::Ttl::OrSymbol
+              ttl: OpenAI::Responses::Response::PromptCacheOptions::Ttl::OrSymbol,
+
+              comparison_response_id: T.nilable(String)
             )
               .returns(T.attached_class)
           end
@@ -1427,8 +1714,11 @@ module OpenAI
             mode:,
 
             # The minimum lifetime applied to each cache breakpoint.
+            ttl:,
+
+            # The response ID supplied as the prompt cache diagnostics comparison.
 
-            ttl:
+            comparison_response_id: nil
           )
           end
 
@@ -1436,7 +1726,8 @@ module OpenAI
             override.returns(
               {
                 mode: OpenAI::Responses::Response::PromptCacheOptions::Mode::TaggedSymbol,
-                ttl: OpenAI::Responses::Response::PromptCacheOptions::Ttl::TaggedSymbol
+                ttl: OpenAI::Responses::Response::PromptCacheOptions::Ttl::TaggedSymbol,
+                comparison_response_id: T.nilable(String)
               }
             )
           end