openai 0.78.0 → 0.80.0

data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi

@@ -15,8 +15,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::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::Variants
+            )
+          )
+        end
         attr_accessor :annotation
 
         # The index of the annotation within the content part.
@@ -66,7 +72,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::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation::OrHash,
+                  OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation::OrHash,
+                  OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation::OrHash,
+                  OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath::OrHash
+                )
+              ),
             annotation_index: Integer,
             content_index: Integer,
             item_id: String,
@@ -80,7 +94,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:,
@@ -102,7 +116,10 @@ module OpenAI
         sig do
           override.returns(
             {
-              annotation: T.anything,
+              annotation:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::Variants
+                ),
               annotation_index: Integer,
               content_index: Integer,
               item_id: String,
@@ -119,6 +136,281 @@ module OpenAI
         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::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation,
+                OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation,
+                OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation,
+                OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath
+              )
+            end
+
+          class FileCitation < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::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::Beta::BetaResponseOutputTextAnnotationAddedEvent::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::Beta::BetaResponseOutputTextAnnotationAddedEvent::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::Beta::BetaResponseOutputTextAnnotationAddedEvent::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::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
         class Agent < OpenAI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/openai/models/beta/beta_response_reasoning_item.rbi

@@ -63,6 +63,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
 
@@ -116,6 +121,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/beta/beta_response_stream_event.rbi

@@ -5,7 +5,7 @@ module OpenAI
     BetaResponseStreamEvent = Beta::BetaResponseStreamEvent
 
     module Beta
-      # Emitted when there is a partial audio response.
+      # Event emitted while a response is streamed.
       module BetaResponseStreamEvent
         extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/beta/beta_responses_client_event.rbi

@@ -338,6 +338,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
@@ -366,6 +370,17 @@ module OpenAI
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :stream
 
+          # The WebSocket lane for this response. Requests with the same `stream_id` are
+          # processed FIFO, and events for the response echo the same `stream_id`.
+          #
+          # `stream_id` controls routing; `previous_response_id` controls conversation
+          # lineage, so a new lane can fork from a response created on another lane.
+          sig { returns(T.nilable(String)) }
+          attr_reader :stream_id
+
+          sig { params(stream_id: String).void }
+          attr_writer :stream_id
+
           # Options for streaming responses. Only set this when you set `stream: true`.
           sig do
             returns(
@@ -562,12 +577,14 @@ module OpenAI
           attr_writer :user
 
           # Client event for creating a response over a persistent WebSocket connection.
-          # This payload uses the same top-level fields as `POST /v1/responses`.
+          # This payload uses the same top-level fields as `POST /v1/responses`, plus
+          # WebSocket-only envelope metadata.
           #
           # Notes:
           #
           # - `stream` is implicit over WebSocket and should not be sent.
           # - `background` is not supported over WebSocket.
+          # - `stream_id` is WebSocket-only and is not part of `POST /v1/responses`.
           sig do
             params(
               background: T.nilable(T::Boolean),
@@ -628,6 +645,7 @@ module OpenAI
                 ),
               store: T.nilable(T::Boolean),
               stream: T.nilable(T::Boolean),
+              stream_id: String,
               stream_options:
                 T.nilable(
                   OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::StreamOptions::OrHash
@@ -817,6 +835,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
@@ -833,6 +855,12 @@ module OpenAI
             # [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)
             # for more information.
             stream: nil,
+            # The WebSocket lane for this response. Requests with the same `stream_id` are
+            # processed FIFO, and events for the response echo the same `stream_id`.
+            #
+            # `stream_id` controls routing; `previous_response_id` controls conversation
+            # lineage, so a new lane can fork from a response created on another lane.
+            stream_id: nil,
             # Options for streaming responses. Only set this when you set `stream: true`.
             stream_options: nil,
             # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
@@ -958,6 +986,7 @@ module OpenAI
                   ),
                 store: T.nilable(T::Boolean),
                 stream: T.nilable(T::Boolean),
+                stream_id: String,
                 stream_options:
                   T.nilable(
                     OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::StreamOptions
@@ -1159,6 +1188,11 @@ module OpenAI
                 :"gpt-5.5",
                 OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
               )
+            GPT_5_5_2026_04_23 =
+              T.let(
+                :"gpt-5.5-2026-04-23",
+                OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
+              )
             GPT_5_4 =
               T.let(
                 :"gpt-5.4",
@@ -1599,6 +1633,16 @@ module OpenAI
                 :"computer-use-preview-2025-03-11",
                 OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
               )
+            GPT_5_5_PRO =
+              T.let(
+                :"gpt-5.5-pro",
+                OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
+              )
+            GPT_5_5_PRO_2026_04_23 =
+              T.let(
+                :"gpt-5.5-pro-2026-04-23",
+                OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
+              )
             GPT_5_CODEX =
               T.let(
                 :"gpt-5-codex",
@@ -1619,6 +1663,21 @@ module OpenAI
                 :"gpt-5.1-codex-max",
                 OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
               )
+            GPT_DAYBREAK_BLUE_LATEST =
+              T.let(
+                :"gpt-daybreak-blue-latest",
+                OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
+              )
+            GPT_DAYBREAK_RED_LATEST =
+              T.let(
+                :"gpt-daybreak-red-latest",
+                OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
+              )
+            GPT_5_6_CYBER =
+              T.let(
+                :"gpt-5.6-cyber",
+                OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Model::TaggedSymbol
+              )
           end
 
           class Moderation < OpenAI::Internal::Type::BaseModel
@@ -2643,6 +2702,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
@@ -2691,6 +2754,11 @@ module OpenAI
                 :fast,
                 OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::ServiceTier::TaggedSymbol
               )
+            ULTRAFAST =
+              T.let(
+                :ultrafast,
+                OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::ServiceTier::TaggedSymbol
+              )
 
             sig do
               override.returns(