feat(api): add phase

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 147
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-a0aa54a302fbd7fff4ed7ad8a8547587d37b63324fc4af652bfa685ee9f8da44.yml
-openapi_spec_hash: e45c5af19307cfc8b9baa4b8f8e865a0
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-427cc4911647924492f14cecdb46eba053c132b1d216dc191d2e34f0be3ed3cf.yml
+openapi_spec_hash: 958b9c5c6a54682b5ffde920610cae9a
 config_hash: 7f49c38fa3abe9b7038ffe62262c4912

lib/openai/models/responses/easy_input_message.rb

@@ -18,13 +18,22 @@ class EasyInputMessage < OpenAI::Internal::Type::BaseModel
         #   @return [Symbol, OpenAI::Models::Responses::EasyInputMessage::Role]
         required :role, enum: -> { OpenAI::Responses::EasyInputMessage::Role }
 
+        # @!attribute phase
+        #   Labels an assistant message as intermediate commentary ("commentary") or the
+        #   final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+        #   sending follow-up requests, preserve and resend phase on all assistant messages
+        #   — dropping it can degrade performance. Not used for user messages.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::EasyInputMessage::Phase, nil]
+        optional :phase, enum: -> { OpenAI::Responses::EasyInputMessage::Phase }, nil?: true
+
         # @!attribute type
         #   The type of the message input. Always `message`.
         #
         #   @return [Symbol, OpenAI::Models::Responses::EasyInputMessage::Type, nil]
         optional :type, enum: -> { OpenAI::Responses::EasyInputMessage::Type }
 
-        # @!method initialize(content:, role:, type: nil)
+        # @!method initialize(content:, role:, phase: nil, type: nil)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::EasyInputMessage} for more details.
         #
@@ -38,6 +47,8 @@ class EasyInputMessage < OpenAI::Internal::Type::BaseModel
         #
         #   @param role [Symbol, OpenAI::Models::Responses::EasyInputMessage::Role] The role of the message input. One of `user`, `assistant`, `system`, or
         #
+        #   @param phase [Symbol, OpenAI::Models::Responses::EasyInputMessage::Phase, nil] Labels an assistant message as intermediate commentary ("commentary") or the fin
+        #
         #   @param type [Symbol, OpenAI::Models::Responses::EasyInputMessage::Type] The type of the message input. Always `message`.
 
         # Text, image, or audio input to the model, used to generate a response. Can also
@@ -74,6 +85,21 @@ module Role
           #   @return [Array<Symbol>]
         end
 
+        # Labels an assistant message as intermediate commentary ("commentary") or the
+        # final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        #
+        # @see OpenAI::Models::Responses::EasyInputMessage#phase
+        module Phase
+          extend OpenAI::Internal::Type::Enum
+
+          COMMENTARY = :commentary
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # The type of the message input. Always `message`.
         #
         # @see OpenAI::Models::Responses::EasyInputMessage#type

lib/openai/models/responses/response_compact_params.rb

@@ -42,7 +42,13 @@ class ResponseCompactParams < OpenAI::Internal::Type::BaseModel
         #   @return [String, nil]
         optional :previous_response_id, String, nil?: true
 
-        # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, request_options: {})
+        # @!attribute prompt_cache_key
+        #   A key to use when reading from or writing to the prompt cache.
+        #
+        #   @return [String, nil]
+        optional :prompt_cache_key, String, nil?: true
+
+        # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseCompactParams} for more details.
         #
@@ -54,6 +60,8 @@ class ResponseCompactParams < OpenAI::Internal::Type::BaseModel
         #
         #   @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to create multi-tu
         #
+        #   @param prompt_cache_key [String, nil] A key to use when reading from or writing to the prompt cache.
+        #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
         # Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a

lib/openai/models/responses/response_output_message.rb

@@ -36,7 +36,16 @@ class ResponseOutputMessage < OpenAI::Internal::Type::BaseModel
         #   @return [Symbol, :message]
         required :type, const: :message
 
-        # @!method initialize(id:, content:, status:, role: :assistant, type: :message)
+        # @!attribute phase
+        #   Labels an assistant message as intermediate commentary ("commentary") or the
+        #   final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+        #   sending follow-up requests, preserve and resend phase on all assistant messages
+        #   — dropping it can degrade performance. Not used for user messages.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Phase, nil]
+        optional :phase, enum: -> { OpenAI::Responses::ResponseOutputMessage::Phase }, nil?: true
+
+        # @!method initialize(id:, content:, status:, phase: nil, role: :assistant, type: :message)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseOutputMessage} for more details.
         #
@@ -48,6 +57,8 @@ class ResponseOutputMessage < OpenAI::Internal::Type::BaseModel
         #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Status] The status of the message input. One of `in_progress`, `completed`, or
         #
+        #   @param phase [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Phase, nil] Labels an assistant message as intermediate commentary ("commentary") or the fin
+        #
         #   @param role [Symbol, :assistant] The role of the output message. Always `assistant`.
         #
         #   @param type [Symbol, :message] The type of the output message. Always `message`.
@@ -82,6 +93,21 @@ module Status
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # Labels an assistant message as intermediate commentary ("commentary") or the
+        # final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        #
+        # @see OpenAI::Models::Responses::ResponseOutputMessage#phase
+        module Phase
+          extend OpenAI::Internal::Type::Enum
+
+          COMMENTARY = :commentary
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

lib/openai/resources/responses.rb

@@ -473,7 +473,7 @@ def cancel(response_id, params = {})
       # For ZDR-compatible compaction details, see
       # [Compaction (advanced)](https://platform.openai.com/docs/guides/conversation-state#compaction-advanced).
       #
-      # @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, request_options: {})
+      # @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, request_options: {})
       #
       # @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wi
       #
@@ -483,6 +483,8 @@ def cancel(response_id, params = {})
       #
       # @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to create multi-tu
       #
+      # @param prompt_cache_key [String, nil] A key to use when reading from or writing to the prompt cache.
+      #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OpenAI::Models::Responses::CompactedResponse]

rbi/openai/models/responses/easy_input_message.rbi

@@ -22,6 +22,17 @@ module OpenAI
         sig { returns(OpenAI::Responses::EasyInputMessage::Role::OrSymbol) }
         attr_accessor :role
 
+        # Labels an assistant message as intermediate commentary ("commentary") or the
+        # final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        sig do
+          returns(
+            T.nilable(OpenAI::Responses::EasyInputMessage::Phase::OrSymbol)
+          )
+        end
+        attr_accessor :phase
+
         # The type of the message input. Always `message`.
         sig do
           returns(
@@ -44,6 +55,8 @@ module OpenAI
           params(
             content: OpenAI::Responses::EasyInputMessage::Content::Variants,
             role: OpenAI::Responses::EasyInputMessage::Role::OrSymbol,
+            phase:
+              T.nilable(OpenAI::Responses::EasyInputMessage::Phase::OrSymbol),
             type: OpenAI::Responses::EasyInputMessage::Type::OrSymbol
           ).returns(T.attached_class)
         end
@@ -54,6 +67,11 @@ module OpenAI
           # The role of the message input. One of `user`, `assistant`, `system`, or
           # `developer`.
           role:,
+          # Labels an assistant message as intermediate commentary ("commentary") or the
+          # final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+          # sending follow-up requests, preserve and resend phase on all assistant messages
+          # — dropping it can degrade performance. Not used for user messages.
+          phase: nil,
           # The type of the message input. Always `message`.
           type: nil
         )
@@ -64,6 +82,8 @@ module OpenAI
             {
               content: OpenAI::Responses::EasyInputMessage::Content::Variants,
               role: OpenAI::Responses::EasyInputMessage::Role::OrSymbol,
+              phase:
+                T.nilable(OpenAI::Responses::EasyInputMessage::Phase::OrSymbol),
               type: OpenAI::Responses::EasyInputMessage::Type::OrSymbol
             }
           )
@@ -134,6 +154,34 @@ module OpenAI
           end
         end
 
+        # Labels an assistant message as intermediate commentary ("commentary") or the
+        # final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        module Phase
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Responses::EasyInputMessage::Phase)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          COMMENTARY =
+            T.let(
+              :commentary,
+              OpenAI::Responses::EasyInputMessage::Phase::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Responses::EasyInputMessage::Phase::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
         # The type of the message input. Always `message`.
         module Type
           extend OpenAI::Internal::Type::Enum

rbi/openai/models/responses/response_compact_params.rbi

@@ -54,6 +54,10 @@ module OpenAI
         sig { returns(T.nilable(String)) }
         attr_accessor :previous_response_id
 
+        # A key to use when reading from or writing to the prompt cache.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :prompt_cache_key
+
         sig do
           params(
             model:
@@ -69,6 +73,7 @@ module OpenAI
               ),
             instructions: T.nilable(String),
             previous_response_id: T.nilable(String),
+            prompt_cache_key: T.nilable(String),
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -91,6 +96,8 @@ module OpenAI
           # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
           # Cannot be used in conjunction with `conversation`.
           previous_response_id: nil,
+          # A key to use when reading from or writing to the prompt cache.
+          prompt_cache_key: nil,
           request_options: {}
         )
         end
@@ -111,6 +118,7 @@ module OpenAI
                 ),
               instructions: T.nilable(String),
               previous_response_id: T.nilable(String),
+              prompt_cache_key: T.nilable(String),
               request_options: OpenAI::RequestOptions
             }
           )

rbi/openai/models/responses/response_output_message.rbi

@@ -44,6 +44,17 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # Labels an assistant message as intermediate commentary ("commentary") or the
+        # final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        sig do
+          returns(
+            T.nilable(OpenAI::Responses::ResponseOutputMessage::Phase::OrSymbol)
+          )
+        end
+        attr_accessor :phase
+
         # An output message from the model.
         sig do
           params(
@@ -56,6 +67,10 @@ module OpenAI
                 )
               ],
             status: OpenAI::Responses::ResponseOutputMessage::Status::OrSymbol,
+            phase:
+              T.nilable(
+                OpenAI::Responses::ResponseOutputMessage::Phase::OrSymbol
+              ),
             role: Symbol,
             type: Symbol
           ).returns(T.attached_class)
@@ -68,6 +83,11 @@ module OpenAI
           # The status of the message input. One of `in_progress`, `completed`, or
           # `incomplete`. Populated when input items are returned via API.
           status:,
+          # Labels an assistant message as intermediate commentary ("commentary") or the
+          # final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+          # sending follow-up requests, preserve and resend phase on all assistant messages
+          # — dropping it can degrade performance. Not used for user messages.
+          phase: nil,
           # The role of the output message. Always `assistant`.
           role: :assistant,
           # The type of the output message. Always `message`.
@@ -89,7 +109,11 @@ module OpenAI
               role: Symbol,
               status:
                 OpenAI::Responses::ResponseOutputMessage::Status::OrSymbol,
-              type: Symbol
+              type: Symbol,
+              phase:
+                T.nilable(
+                  OpenAI::Responses::ResponseOutputMessage::Phase::OrSymbol
+                )
             }
           )
         end
@@ -156,6 +180,36 @@ module OpenAI
           def self.values
           end
         end
+
+        # Labels an assistant message as intermediate commentary ("commentary") or the
+        # final answer ("final_answer"). For models like gpt-5.3-codex and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        module Phase
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Responses::ResponseOutputMessage::Phase)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          COMMENTARY =
+            T.let(
+              :commentary,
+              OpenAI::Responses::ResponseOutputMessage::Phase::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseOutputMessage::Phase::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

rbi/openai/resources/responses.rbi

@@ -981,6 +981,7 @@ module OpenAI
             ),
           instructions: T.nilable(String),
           previous_response_id: T.nilable(String),
+          prompt_cache_key: T.nilable(String),
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Responses::CompactedResponse)
       end
@@ -1003,6 +1004,8 @@ module OpenAI
         # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
         # Cannot be used in conjunction with `conversation`.
         previous_response_id: nil,
+        # A key to use when reading from or writing to the prompt cache.
+        prompt_cache_key: nil,
         request_options: {}
       )
       end