openai 0.78.0 → 0.80.0

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

@@ -5,10 +5,12 @@ module OpenAI
     module Responses
       class ResponseOutputTextAnnotationAddedEvent < OpenAI::Internal::Type::BaseModel
         # @!attribute annotation
-        #   The annotation object being added. (See annotation schema for details.)
+        #   An annotation that applies to a span of output text.
         #
-        #   @return [Object]
-        required :annotation, OpenAI::Internal::Type::Unknown
+        #   @return [OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil]
+        required :annotation,
+                 union: -> { OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation },
+                 nil?: true
 
         # @!attribute annotation_index
         #   The index of the annotation within the content part.
@@ -49,7 +51,7 @@ module OpenAI
         # @!method initialize(annotation:, annotation_index:, content_index:, item_id:, output_index:, sequence_number:, type: :"response.output_text.annotation.added")
         #   Emitted when an annotation is added to output text content.
         #
-        #   @param annotation [Object] The annotation object being added. (See annotation schema for details.)
+        #   @param annotation [OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil] An annotation that applies to a span of output text.
         #
         #   @param annotation_index [Integer] The index of the annotation within the content part.
         #
@@ -62,6 +64,201 @@ module OpenAI
         #   @param sequence_number [Integer] The sequence number of this event.
         #
         #   @param type [Symbol, :"response.output_text.annotation.added"] The type of the event. Always 'response.output_text.annotation.added'.
+
+        # An annotation that applies to a span of output text.
+        #
+        # @see OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent#annotation
+        module Annotation
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # A citation to a file.
+          variant :file_citation,
+                  -> { OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation }
+
+          # A citation for a web resource used to generate a model response.
+          variant :url_citation,
+                  -> { OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation }
+
+          # A citation for a container file used to generate a model response.
+          variant :container_file_citation,
+                  -> { OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation }
+
+          # A path to a file.
+          variant :file_path, -> { OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath }
+
+          class FileCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute filename
+            #   The filename of the file cited.
+            #
+            #   @return [String]
+            required :filename, String
+
+            # @!attribute index
+            #   The index of the file in the list of files.
+            #
+            #   @return [Integer]
+            required :index, Integer
+
+            # @!attribute type
+            #   The type of the file citation. Always `file_citation`.
+            #
+            #   @return [Symbol, :file_citation]
+            required :type, const: :file_citation
+
+            # @!method initialize(file_id:, filename:, index:, type: :file_citation)
+            #   A citation to a file.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param filename [String] The filename of the file cited.
+            #
+            #   @param index [Integer] The index of the file in the list of files.
+            #
+            #   @param type [Symbol, :file_citation] The type of the file citation. Always `file_citation`.
+          end
+
+          class URLCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute end_index
+            #   The index of the last character of the URL citation in the message.
+            #
+            #   @return [Integer]
+            required :end_index, Integer
+
+            # @!attribute start_index
+            #   The index of the first character of the URL citation in the message.
+            #
+            #   @return [Integer]
+            required :start_index, Integer
+
+            # @!attribute title
+            #   The title of the web resource.
+            #
+            #   @return [String]
+            required :title, String
+
+            # @!attribute type
+            #   The type of the URL citation. Always `url_citation`.
+            #
+            #   @return [Symbol, :url_citation]
+            required :type, const: :url_citation
+
+            # @!attribute url
+            #   The URL of the web resource.
+            #
+            #   @return [String]
+            required :url, String
+
+            # @!method initialize(end_index:, start_index:, title:, url:, type: :url_citation)
+            #   A citation for a web resource used to generate a model response.
+            #
+            #   @param end_index [Integer] The index of the last character of the URL citation in the message.
+            #
+            #   @param start_index [Integer] The index of the first character of the URL citation in the message.
+            #
+            #   @param title [String] The title of the web resource.
+            #
+            #   @param url [String] The URL of the web resource.
+            #
+            #   @param type [Symbol, :url_citation] The type of the URL citation. Always `url_citation`.
+          end
+
+          class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute container_id
+            #   The ID of the container file.
+            #
+            #   @return [String]
+            required :container_id, String
+
+            # @!attribute end_index
+            #   The index of the last character of the container file citation in the message.
+            #
+            #   @return [Integer]
+            required :end_index, Integer
+
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute filename
+            #   The filename of the container file cited.
+            #
+            #   @return [String]
+            required :filename, String
+
+            # @!attribute start_index
+            #   The index of the first character of the container file citation in the message.
+            #
+            #   @return [Integer]
+            required :start_index, Integer
+
+            # @!attribute type
+            #   The type of the container file citation. Always `container_file_citation`.
+            #
+            #   @return [Symbol, :container_file_citation]
+            required :type, const: :container_file_citation
+
+            # @!method initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation)
+            #   A citation for a container file used to generate a model response.
+            #
+            #   @param container_id [String] The ID of the container file.
+            #
+            #   @param end_index [Integer] The index of the last character of the container file citation in the message.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param filename [String] The filename of the container file cited.
+            #
+            #   @param start_index [Integer] The index of the first character of the container file citation in the message.
+            #
+            #   @param type [Symbol, :container_file_citation] The type of the container file citation. Always `container_file_citation`.
+          end
+
+          class FilePath < OpenAI::Internal::Type::BaseModel
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute index
+            #   The index of the file in the list of files.
+            #
+            #   @return [Integer]
+            required :index, Integer
+
+            # @!attribute type
+            #   The type of the file path. Always `file_path`.
+            #
+            #   @return [Symbol, :file_path]
+            required :type, const: :file_path
+
+            # @!method initialize(file_id:, index:, type: :file_path)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath}
+            #   for more details.
+            #
+            #   A path to a file.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param index [Integer] The index of the file in the list of files.
+            #
+            #   @param type [Symbol, :file_path] The type of the file path. Always `file_path`.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath)]
+        end
       end
     end
   end

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

@@ -35,6 +35,11 @@ module OpenAI
         #   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.
+        #
         #   @return [String, nil]
         optional :encrypted_content, String, nil?: true
 

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

@@ -3,7 +3,7 @@
 module OpenAI
   module Models
     module Responses
-      # Emitted when there is a partial audio response.
+      # Event emitted while a response is streamed.
       module ResponseStreamEvent
         extend OpenAI::Internal::Type::Union
 

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

@@ -238,6 +238,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
@@ -265,6 +269,16 @@ module OpenAI
         #   @return [Boolean, nil]
         optional :stream, OpenAI::Internal::Type::Boolean, nil?: true
 
+        # @!attribute stream_id
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :stream_id, String
+
         # @!attribute stream_options
         #   Options for streaming responses. Only set this when you set `stream: true`.
         #
@@ -366,7 +380,7 @@ module OpenAI
         #   @return [String, nil]
         optional :user, String
 
-        # @!method initialize(background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
+        # @!method initialize(background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponsesClientEvent} for more details.
         #
@@ -414,6 +428,8 @@ module OpenAI
         #
         #   @param stream [Boolean, nil] If set to true, the model response data will be streamed to the client
         #
+        #   @param stream_id [String] The WebSocket lane for this response. Requests with the same
+        #
         #   @param stream_options [OpenAI::Models::Responses::ResponsesClientEvent::StreamOptions, nil] Options for streaming responses. Only set this when you set `stream: true`.
         #
         #   @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
@@ -720,6 +736,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
@@ -737,6 +757,7 @@ module OpenAI
           SCALE = :scale
           PRIORITY = :priority
           FAST = :fast
+          ULTRAFAST = :ultrafast
 
           # @!method self.values
           #   @return [Array<Symbol>]