openai 0.79.0 → 0.80.0

data/rbi/openai/models/responses/response_output_text_annotation_added_event.rbi

@@ -12,8 +12,14 @@ module OpenAI
             )
           end
 
-        # The annotation object being added. (See annotation schema for details.)
-        sig { returns(T.anything) }
+        # An annotation that applies to a span of output text.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::Variants
+            )
+          )
+        end
         attr_accessor :annotation
 
         # The index of the annotation within the content part.
@@ -43,7 +49,15 @@ module OpenAI
         # Emitted when an annotation is added to output text content.
         sig do
           params(
-            annotation: T.anything,
+            annotation:
+              T.nilable(
+                T.any(
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation::OrHash,
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation::OrHash,
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation::OrHash,
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath::OrHash
+                )
+              ),
             annotation_index: Integer,
             content_index: Integer,
             item_id: String,
@@ -53,7 +67,7 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The annotation object being added. (See annotation schema for details.)
+          # An annotation that applies to a span of output text.
           annotation:,
           # The index of the annotation within the content part.
           annotation_index:,
@@ -73,7 +87,10 @@ module OpenAI
         sig do
           override.returns(
             {
-              annotation: T.anything,
+              annotation:
+                T.nilable(
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::Variants
+                ),
               annotation_index: Integer,
               content_index: Integer,
               item_id: String,
@@ -85,6 +102,281 @@ module OpenAI
         end
         def to_hash
         end
+
+        # An annotation that applies to a span of output text.
+        module Annotation
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation,
+                OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation,
+                OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation,
+                OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath
+              )
+            end
+
+          class FileCitation < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The ID of the file.
+            sig { returns(String) }
+            attr_accessor :file_id
+
+            # The filename of the file cited.
+            sig { returns(String) }
+            attr_accessor :filename
+
+            # The index of the file in the list of files.
+            sig { returns(Integer) }
+            attr_accessor :index
+
+            # The type of the file citation. Always `file_citation`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # A citation to a file.
+            sig do
+              params(
+                file_id: String,
+                filename: String,
+                index: Integer,
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The ID of the file.
+              file_id:,
+              # The filename of the file cited.
+              filename:,
+              # The index of the file in the list of files.
+              index:,
+              # The type of the file citation. Always `file_citation`.
+              type: :file_citation
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  file_id: String,
+                  filename: String,
+                  index: Integer,
+                  type: Symbol
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class URLCitation < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The index of the last character of the URL citation in the message.
+            sig { returns(Integer) }
+            attr_accessor :end_index
+
+            # The index of the first character of the URL citation in the message.
+            sig { returns(Integer) }
+            attr_accessor :start_index
+
+            # The title of the web resource.
+            sig { returns(String) }
+            attr_accessor :title
+
+            # The type of the URL citation. Always `url_citation`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # The URL of the web resource.
+            sig { returns(String) }
+            attr_accessor :url
+
+            # A citation for a web resource used to generate a model response.
+            sig do
+              params(
+                end_index: Integer,
+                start_index: Integer,
+                title: String,
+                url: String,
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The index of the last character of the URL citation in the message.
+              end_index:,
+              # The index of the first character of the URL citation in the message.
+              start_index:,
+              # The title of the web resource.
+              title:,
+              # The URL of the web resource.
+              url:,
+              # The type of the URL citation. Always `url_citation`.
+              type: :url_citation
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  end_index: Integer,
+                  start_index: Integer,
+                  title: String,
+                  type: Symbol,
+                  url: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The ID of the container file.
+            sig { returns(String) }
+            attr_accessor :container_id
+
+            # The index of the last character of the container file citation in the message.
+            sig { returns(Integer) }
+            attr_accessor :end_index
+
+            # The ID of the file.
+            sig { returns(String) }
+            attr_accessor :file_id
+
+            # The filename of the container file cited.
+            sig { returns(String) }
+            attr_accessor :filename
+
+            # The index of the first character of the container file citation in the message.
+            sig { returns(Integer) }
+            attr_accessor :start_index
+
+            # The type of the container file citation. Always `container_file_citation`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # A citation for a container file used to generate a model response.
+            sig do
+              params(
+                container_id: String,
+                end_index: Integer,
+                file_id: String,
+                filename: String,
+                start_index: Integer,
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The ID of the container file.
+              container_id:,
+              # The index of the last character of the container file citation in the message.
+              end_index:,
+              # The ID of the file.
+              file_id:,
+              # The filename of the container file cited.
+              filename:,
+              # The index of the first character of the container file citation in the message.
+              start_index:,
+              # The type of the container file citation. Always `container_file_citation`.
+              type: :container_file_citation
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  container_id: String,
+                  end_index: Integer,
+                  file_id: String,
+                  filename: String,
+                  start_index: Integer,
+                  type: Symbol
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class FilePath < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The ID of the file.
+            sig { returns(String) }
+            attr_accessor :file_id
+
+            # The index of the file in the list of files.
+            sig { returns(Integer) }
+            attr_accessor :index
+
+            # The type of the file path. Always `file_path`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # A path to a file.
+            sig do
+              params(file_id: String, index: Integer, type: Symbol).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The ID of the file.
+              file_id:,
+              # The index of the file in the list of files.
+              index:,
+              # The type of the file path. Always `file_path`.
+              type: :file_path
+            )
+            end
+
+            sig do
+              override.returns(
+                { file_id: String, index: Integer, type: Symbol }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
       end
     end
   end

data/rbi/openai/models/responses/response_reasoning_item.rbi

@@ -49,6 +49,11 @@ module OpenAI
         # The encrypted content of the reasoning item. This is populated by default for
         # reasoning items returned by `POST /v1/responses` and WebSocket `response.create`
         # requests.
+        #
+        # When streaming, use the completed reasoning item and its `encrypted_content`
+        # from the `response.output_item.done` event in subsequent requests. The
+        # `encrypted_content` in `response.output_item.added` may be incomplete. This is
+        # especially important when `store` is `false` or when using Zero Data Retention.
         sig { returns(T.nilable(String)) }
         attr_accessor :encrypted_content
 
@@ -100,6 +105,11 @@ module OpenAI
           # The encrypted content of the reasoning item. This is populated by default for
           # reasoning items returned by `POST /v1/responses` and WebSocket `response.create`
           # requests.
+          #
+          # When streaming, use the completed reasoning item and its `encrypted_content`
+          # from the `response.output_item.done` event in subsequent requests. The
+          # `encrypted_content` in `response.output_item.added` may be incomplete. This is
+          # especially important when `store` is `false` or when using Zero Data Retention.
           encrypted_content: nil,
           # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
           # Populated when items are returned via API.

data/rbi/openai/models/responses/responses_client_event.rbi

@@ -286,6 +286,10 @@ module OpenAI
         #   Responses or Chat Completions. The response will show `service_tier=priority`
         #   regardless of if you specify `service_tier=fast` or `priority` in your
         #   request.
+        # - If set to 'ultrafast', then the request will be processed with the
+        #   access-controlled Ultrafast Processing service tier. This tier is currently
+        #   available for `gpt-5.6-sol`; a response served through it will show
+        #   `service_tier=ultrafast`.
         # - When not set, the default behavior is 'auto'.
         #
         # When the `service_tier` parameter is set, the response body will include the
@@ -757,6 +761,10 @@ module OpenAI
           #   Responses or Chat Completions. The response will show `service_tier=priority`
           #   regardless of if you specify `service_tier=fast` or `priority` in your
           #   request.
+          # - If set to 'ultrafast', then the request will be processed with the
+          #   access-controlled Ultrafast Processing service tier. This tier is currently
+          #   available for `gpt-5.6-sol`; a response served through it will show
+          #   `service_tier=ultrafast`.
           # - When not set, the default behavior is 'auto'.
           #
           # When the `service_tier` parameter is set, the response body will include the
@@ -1574,6 +1582,10 @@ module OpenAI
         #   Responses or Chat Completions. The response will show `service_tier=priority`
         #   regardless of if you specify `service_tier=fast` or `priority` in your
         #   request.
+        # - If set to 'ultrafast', then the request will be processed with the
+        #   access-controlled Ultrafast Processing service tier. This tier is currently
+        #   available for `gpt-5.6-sol`; a response served through it will show
+        #   `service_tier=ultrafast`.
         # - When not set, the default behavior is 'auto'.
         #
         # When the `service_tier` parameter is set, the response body will include the
@@ -1622,6 +1634,11 @@ module OpenAI
               :fast,
               OpenAI::Responses::ResponsesClientEvent::ServiceTier::TaggedSymbol
             )
+          ULTRAFAST =
+            T.let(
+              :ultrafast,
+              OpenAI::Responses::ResponsesClientEvent::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/responses/responses_server_event.rbi

@@ -10,6 +10,7 @@ module OpenAI
         Variants =
           T.type_alias do
             T.any(
+              OpenAI::Responses::ResponsesServerEvent::ResponseWsError,
               OpenAI::Responses::ResponsesServerEvent::ResponseAudioWsDelta,
               OpenAI::Responses::ResponsesServerEvent::ResponseAudioWsDone,
               OpenAI::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDelta,
@@ -23,7 +24,6 @@ module OpenAI
               OpenAI::Responses::ResponsesServerEvent::ResponseContentPartWsAdded,
               OpenAI::Responses::ResponsesServerEvent::ResponseContentPartWsDone,
               OpenAI::Responses::ResponsesServerEvent::ResponseWsCreated,
-              OpenAI::Responses::ResponsesServerEvent::ResponseWsError,
               OpenAI::Responses::ResponsesServerEvent::ResponseFileSearchCallWsCompleted,
               OpenAI::Responses::ResponsesServerEvent::ResponseFileSearchCallInWsProgress,
               OpenAI::Responses::ResponsesServerEvent::ResponseFileSearchCallWsSearching,
@@ -807,67 +807,6 @@ module OpenAI
           end
         end
 
-        class ResponseWsError < OpenAI::Models::Responses::ResponseErrorEvent
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Responses::ResponsesServerEvent::ResponseWsError,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The WebSocket lane that emitted this event. This field is present when the
-          # originating `response.create` event supplied a `stream_id`.
-          sig { returns(T.nilable(String)) }
-          attr_reader :stream_id
-
-          sig { params(stream_id: String).void }
-          attr_writer :stream_id
-
-          # Emitted when an error occurs.
-          sig do
-            params(
-              code: T.nilable(String),
-              message: String,
-              param: T.nilable(String),
-              sequence_number: Integer,
-              type: Symbol,
-              stream_id: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The error code.
-            code:,
-            # The error message.
-            message:,
-            # The error parameter.
-            param:,
-            # The sequence number of this event.
-            sequence_number:,
-            # The type of the event. Always `error`.
-            type: :error,
-            # The WebSocket lane that emitted this event.
-            # This field is present when the originating response.create supplied a stream_id.
-            stream_id: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                code: T.nilable(String),
-                message: String,
-                param: T.nilable(String),
-                sequence_number: Integer,
-                type: Symbol,
-                stream_id: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
         class ResponseFileSearchCallWsCompleted < OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent
           OrHash =
             T.type_alias do
@@ -3295,6 +3234,170 @@ module OpenAI
           end
         end
 
+        class ResponseWsError < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponsesServerEvent::ResponseWsError,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Details about the error.
+          sig do
+            returns(
+              OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error
+            )
+          end
+          attr_reader :error
+
+          sig do
+            params(
+              error:
+                OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::OrHash
+            ).void
+          end
+          attr_writer :error
+
+          # The type of the event. Always `error`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # The sequence number of an error emitted by the response stream.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :sequence_number
+
+          sig { params(sequence_number: Integer).void }
+          attr_writer :sequence_number
+
+          # The HTTP status code associated with a WebSocket protocol error.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :status
+
+          sig { params(status: Integer).void }
+          attr_writer :status
+
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :stream_id
+
+          sig { params(stream_id: String).void }
+          attr_writer :stream_id
+
+          # Emitted when an error occurs while processing a Responses WebSocket request.
+          sig do
+            params(
+              error:
+                OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::OrHash,
+              sequence_number: Integer,
+              status: Integer,
+              stream_id: String,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Details about the error.
+            error:,
+            # The sequence number of an error emitted by the response stream.
+            sequence_number: nil,
+            # The HTTP status code associated with a WebSocket protocol error.
+            status: nil,
+            # The WebSocket lane that emitted this event. This field is present when the
+            # originating `response.create` event supplied a `stream_id`.
+            stream_id: nil,
+            # The type of the event. Always `error`.
+            type: :error
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                error:
+                  OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error,
+                type: Symbol,
+                sequence_number: Integer,
+                status: Integer,
+                stream_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Error < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The error code that was emitted, if any.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :code
+
+            # The human-readable error message that was emitted.
+            sig { returns(String) }
+            attr_accessor :message
+
+            # The parameter name that was associated with the error, if any.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :param
+
+            # The error type that was emitted.
+            sig { returns(String) }
+            attr_accessor :type
+
+            # The response headers that were emitted with the error, if any.
+            sig { returns(T.nilable(T::Hash[Symbol, String])) }
+            attr_reader :headers
+
+            sig { params(headers: T::Hash[Symbol, String]).void }
+            attr_writer :headers
+
+            # Details about the error.
+            sig do
+              params(
+                code: T.nilable(String),
+                message: String,
+                param: T.nilable(String),
+                type: String,
+                headers: T::Hash[Symbol, String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The error code that was emitted, if any.
+              code:,
+              # The human-readable error message that was emitted.
+              message:,
+              # The parameter name that was associated with the error, if any.
+              param:,
+              # The error type that was emitted.
+              type:,
+              # The response headers that were emitted with the error, if any.
+              headers: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  code: T.nilable(String),
+                  message: String,
+                  param: T.nilable(String),
+                  type: String,
+                  headers: T::Hash[Symbol, String]
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
         sig do
           override.returns(
             T::Array[OpenAI::Responses::ResponsesServerEvent::Variants]

data/rbi/openai/models/responses/web_search_tool.rbi

@@ -13,6 +13,15 @@ module OpenAI
         sig { returns(OpenAI::Responses::WebSearchTool::Type::OrSymbol) }
         attr_accessor :type
 
+        # Allow live internet access for web search. Defaults to true when omitted. When
+        # false, the web search tool runs in offline/cache-only mode and will not fetch
+        # new external content.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :external_web_access
+
+        sig { params(external_web_access: T::Boolean).void }
+        attr_writer :external_web_access
+
         # Filters for the search.
         sig { returns(T.nilable(OpenAI::Responses::WebSearchTool::Filters)) }
         attr_reader :filters
@@ -63,6 +72,7 @@ module OpenAI
         sig do
           params(
             type: OpenAI::Responses::WebSearchTool::Type::OrSymbol,
+            external_web_access: T::Boolean,
             filters:
               T.nilable(OpenAI::Responses::WebSearchTool::Filters::OrHash),
             search_context_size:
@@ -74,6 +84,10 @@ module OpenAI
         def self.new(
           # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
           type:,
+          # Allow live internet access for web search. Defaults to true when omitted. When
+          # false, the web search tool runs in offline/cache-only mode and will not fetch
+          # new external content.
+          external_web_access: nil,
           # Filters for the search.
           filters: nil,
           # High level guidance for the amount of context window space to use for the
@@ -88,6 +102,7 @@ module OpenAI
           override.returns(
             {
               type: OpenAI::Responses::WebSearchTool::Type::OrSymbol,
+              external_web_access: T::Boolean,
               filters: T.nilable(OpenAI::Responses::WebSearchTool::Filters),
               search_context_size:
                 OpenAI::Responses::WebSearchTool::SearchContextSize::OrSymbol,