openai 0.14.0 → 0.16.0

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

@@ -165,6 +165,15 @@ module OpenAI
         end
         attr_writer :prompt
 
+        # 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).
+        sig { returns(T.nilable(String)) }
+        attr_reader :prompt_cache_key
+
+        sig { params(prompt_cache_key: String).void }
+        attr_writer :prompt_cache_key
+
         # **o-series models only**
         #
         # Configuration options for
@@ -175,12 +184,23 @@ module OpenAI
         sig { params(reasoning: T.nilable(OpenAI::Reasoning::OrHash)).void }
         attr_writer :reasoning
 
+        # A stable identifier used to help detect users of your application that may be
+        # violating OpenAI's usage policies. The IDs should be a string that uniquely
+        # identifies each user. We recommend hashing their username or email address, in
+        # order to avoid sending us any identifying information.
+        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+        sig { returns(T.nilable(String)) }
+        attr_reader :safety_identifier
+
+        sig { params(safety_identifier: String).void }
+        attr_writer :safety_identifier
+
         # Specifies the processing type used for serving the request.
         #
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service
@@ -247,9 +267,11 @@ module OpenAI
         sig { params(usage: OpenAI::Responses::ResponseUsage::OrHash).void }
         attr_writer :usage
 
-        # A stable identifier for your end-users. Used to boost cache hit rates by better
-        # bucketing similar requests and to help OpenAI detect and prevent abuse.
-        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+        # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+        # `prompt_cache_key` instead to maintain caching optimizations. A stable
+        # identifier for your end-users. Used to boost cache hit rates by better bucketing
+        # similar requests and to help OpenAI detect and prevent abuse.
+        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
         sig { returns(T.nilable(String)) }
         attr_reader :user
 
@@ -317,7 +339,9 @@ module OpenAI
             max_tool_calls: T.nilable(Integer),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+            prompt_cache_key: String,
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
+            safety_identifier: String,
             service_tier:
               T.nilable(OpenAI::Responses::Response::ServiceTier::OrSymbol),
             status: OpenAI::Responses::ResponseStatus::OrSymbol,
@@ -417,17 +441,27 @@ module OpenAI
           # Reference to a prompt template and its variables.
           # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
           prompt: 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).
+          prompt_cache_key: nil,
           # **o-series models only**
           #
           # Configuration options for
           # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
           reasoning: nil,
+          # A stable identifier used to help detect users of your application that may be
+          # violating OpenAI's usage policies. The IDs should be a string that uniquely
+          # identifies each user. We recommend hashing their username or email address, in
+          # order to avoid sending us any identifying information.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+          safety_identifier: nil,
           # Specifies the processing type used for serving the request.
           #
           # - If set to 'auto', then the request will be processed with the service tier
           #   configured in the Project settings. Unless otherwise configured, the Project
           #   will use 'default'.
-          # - If set to 'default', then the requset will be processed with the standard
+          # - If set to 'default', then the request will be processed with the standard
           #   pricing and performance for the selected model.
           # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
           #   'priority', then the request will be processed with the corresponding service
@@ -463,9 +497,11 @@ module OpenAI
           # Represents token usage details including input tokens, output tokens, a
           # breakdown of output tokens, and the total tokens used.
           usage: nil,
-          # A stable identifier for your end-users. Used to boost cache hit rates by better
-          # bucketing similar requests and to help OpenAI detect and prevent abuse.
-          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+          # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+          # `prompt_cache_key` instead to maintain caching optimizations. A stable
+          # identifier for your end-users. Used to boost cache hit rates by better bucketing
+          # similar requests and to help OpenAI detect and prevent abuse.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
           user: nil,
           # The object type of this resource - always set to `response`.
           object: :response
@@ -496,7 +532,9 @@ module OpenAI
               max_tool_calls: T.nilable(Integer),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
+              prompt_cache_key: String,
               reasoning: T.nilable(OpenAI::Reasoning),
+              safety_identifier: String,
               service_tier:
                 T.nilable(
                   OpenAI::Responses::Response::ServiceTier::TaggedSymbol
@@ -666,7 +704,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/rbi/openai/models/responses/response_code_interpreter_tool_call.rbi

@@ -40,7 +40,8 @@ module OpenAI
         end
         attr_accessor :outputs
 
-        # The status of the code interpreter tool call.
+        # The status of the code interpreter tool call. Valid values are `in_progress`,
+        # `completed`, `incomplete`, `interpreting`, and `failed`.
         sig do
           returns(
             OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::OrSymbol
@@ -82,7 +83,8 @@ module OpenAI
           # The outputs generated by the code interpreter, such as logs or images. Can be
           # null if no outputs are available.
           outputs:,
-          # The status of the code interpreter tool call.
+          # The status of the code interpreter tool call. Valid values are `in_progress`,
+          # `completed`, `incomplete`, `interpreting`, and `failed`.
           status:,
           # The type of the code interpreter tool call. Always `code_interpreter_call`.
           type: :code_interpreter_call
@@ -200,7 +202,8 @@ module OpenAI
           end
         end
 
-        # The status of the code interpreter tool call.
+        # The status of the code interpreter tool call. Valid values are `in_progress`,
+        # `completed`, `incomplete`, `interpreting`, and `failed`.
         module Status
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/responses/response_create_params.rbi

@@ -148,6 +148,15 @@ module OpenAI
         end
         attr_writer :prompt
 
+        # 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).
+        sig { returns(T.nilable(String)) }
+        attr_reader :prompt_cache_key
+
+        sig { params(prompt_cache_key: String).void }
+        attr_writer :prompt_cache_key
+
         # **o-series models only**
         #
         # Configuration options for
@@ -158,12 +167,23 @@ module OpenAI
         sig { params(reasoning: T.nilable(OpenAI::Reasoning::OrHash)).void }
         attr_writer :reasoning
 
+        # A stable identifier used to help detect users of your application that may be
+        # violating OpenAI's usage policies. The IDs should be a string that uniquely
+        # identifies each user. We recommend hashing their username or email address, in
+        # order to avoid sending us any identifying information.
+        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+        sig { returns(T.nilable(String)) }
+        attr_reader :safety_identifier
+
+        sig { params(safety_identifier: String).void }
+        attr_writer :safety_identifier
+
         # Specifies the processing type used for serving the request.
         #
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service
@@ -326,9 +346,11 @@ module OpenAI
         end
         attr_accessor :truncation
 
-        # A stable identifier for your end-users. Used to boost cache hit rates by better
-        # bucketing similar requests and to help OpenAI detect and prevent abuse.
-        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+        # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+        # `prompt_cache_key` instead to maintain caching optimizations. A stable
+        # identifier for your end-users. Used to boost cache hit rates by better bucketing
+        # similar requests and to help OpenAI detect and prevent abuse.
+        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
         sig { returns(T.nilable(String)) }
         attr_reader :user
 
@@ -356,7 +378,9 @@ module OpenAI
             parallel_tool_calls: T.nilable(T::Boolean),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+            prompt_cache_key: String,
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
+            safety_identifier: String,
             service_tier:
               T.nilable(
                 OpenAI::Responses::ResponseCreateParams::ServiceTier::OrSymbol
@@ -462,17 +486,27 @@ module OpenAI
           # Reference to a prompt template and its variables.
           # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
           prompt: 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).
+          prompt_cache_key: nil,
           # **o-series models only**
           #
           # Configuration options for
           # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
           reasoning: nil,
+          # A stable identifier used to help detect users of your application that may be
+          # violating OpenAI's usage policies. The IDs should be a string that uniquely
+          # identifies each user. We recommend hashing their username or email address, in
+          # order to avoid sending us any identifying information.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+          safety_identifier: nil,
           # Specifies the processing type used for serving the request.
           #
           # - If set to 'auto', then the request will be processed with the service tier
           #   configured in the Project settings. Unless otherwise configured, the Project
           #   will use 'default'.
-          # - If set to 'default', then the requset will be processed with the standard
+          # - If set to 'default', then the request will be processed with the standard
           #   pricing and performance for the selected model.
           # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
           #   'priority', then the request will be processed with the corresponding service
@@ -534,9 +568,11 @@ module OpenAI
           # - `disabled` (default): If a model response will exceed the context window size
           #   for a model, the request will fail with a 400 error.
           truncation: nil,
-          # A stable identifier for your end-users. Used to boost cache hit rates by better
-          # bucketing similar requests and to help OpenAI detect and prevent abuse.
-          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+          # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+          # `prompt_cache_key` instead to maintain caching optimizations. A stable
+          # identifier for your end-users. Used to boost cache hit rates by better bucketing
+          # similar requests and to help OpenAI detect and prevent abuse.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
           user: nil,
           request_options: {}
         )
@@ -564,7 +600,9 @@ module OpenAI
               parallel_tool_calls: T.nilable(T::Boolean),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
+              prompt_cache_key: String,
               reasoning: T.nilable(OpenAI::Reasoning),
+              safety_identifier: String,
               service_tier:
                 T.nilable(
                   OpenAI::Responses::ResponseCreateParams::ServiceTier::OrSymbol
@@ -640,7 +678,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/rbi/openai/models/responses/response_mcp_call_arguments_delta_event.rbi

@@ -12,8 +12,9 @@ module OpenAI
             )
           end
 
-        # The partial update to the arguments for the MCP tool call.
-        sig { returns(T.anything) }
+        # A JSON string containing the partial update to the arguments for the MCP tool
+        # call.
+        sig { returns(String) }
         attr_accessor :delta
 
         # The unique identifier of the MCP tool call item being processed.
@@ -36,7 +37,7 @@ module OpenAI
         # call.
         sig do
           params(
-            delta: T.anything,
+            delta: String,
             item_id: String,
             output_index: Integer,
             sequence_number: Integer,
@@ -44,7 +45,8 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The partial update to the arguments for the MCP tool call.
+          # A JSON string containing the partial update to the arguments for the MCP tool
+          # call.
           delta:,
           # The unique identifier of the MCP tool call item being processed.
           item_id:,
@@ -60,7 +62,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              delta: T.anything,
+              delta: String,
               item_id: String,
               output_index: Integer,
               sequence_number: Integer,

data/rbi/openai/models/responses/response_mcp_call_arguments_done_event.rbi

@@ -12,8 +12,8 @@ module OpenAI
             )
           end
 
-        # The finalized arguments for the MCP tool call.
-        sig { returns(T.anything) }
+        # A JSON string containing the finalized arguments for the MCP tool call.
+        sig { returns(String) }
         attr_accessor :arguments
 
         # The unique identifier of the MCP tool call item being processed.
@@ -35,7 +35,7 @@ module OpenAI
         # Emitted when the arguments for an MCP tool call are finalized.
         sig do
           params(
-            arguments: T.anything,
+            arguments: String,
             item_id: String,
             output_index: Integer,
             sequence_number: Integer,
@@ -43,7 +43,7 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The finalized arguments for the MCP tool call.
+          # A JSON string containing the finalized arguments for the MCP tool call.
           arguments:,
           # The unique identifier of the MCP tool call item being processed.
           item_id:,
@@ -59,7 +59,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              arguments: T.anything,
+              arguments: String,
               item_id: String,
               output_index: Integer,
               sequence_number: Integer,

data/rbi/openai/models/responses/response_mcp_call_completed_event.rbi

@@ -12,6 +12,14 @@ module OpenAI
             )
           end
 
+        # The ID of the MCP tool call item that completed.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that completed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
         # The sequence number of this event.
         sig { returns(Integer) }
         attr_accessor :sequence_number
@@ -22,11 +30,18 @@ module OpenAI
 
         # Emitted when an MCP tool call has completed successfully.
         sig do
-          params(sequence_number: Integer, type: Symbol).returns(
-            T.attached_class
-          )
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
+          # The ID of the MCP tool call item that completed.
+          item_id:,
+          # The index of the output item that completed.
+          output_index:,
           # The sequence number of this event.
           sequence_number:,
           # The type of the event. Always 'response.mcp_call.completed'.
@@ -34,7 +49,16 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ sequence_number: Integer, type: Symbol }) }
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/responses/response_mcp_call_failed_event.rbi

@@ -12,6 +12,14 @@ module OpenAI
             )
           end
 
+        # The ID of the MCP tool call item that failed.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that failed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
         # The sequence number of this event.
         sig { returns(Integer) }
         attr_accessor :sequence_number
@@ -22,11 +30,18 @@ module OpenAI
 
         # Emitted when an MCP tool call has failed.
         sig do
-          params(sequence_number: Integer, type: Symbol).returns(
-            T.attached_class
-          )
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
+          # The ID of the MCP tool call item that failed.
+          item_id:,
+          # The index of the output item that failed.
+          output_index:,
           # The sequence number of this event.
           sequence_number:,
           # The type of the event. Always 'response.mcp_call.failed'.
@@ -34,7 +49,16 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ sequence_number: Integer, type: Symbol }) }
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/responses/response_mcp_list_tools_completed_event.rbi

@@ -12,6 +12,14 @@ module OpenAI
             )
           end
 
+        # The ID of the MCP tool call item that produced this output.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that was processed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
         # The sequence number of this event.
         sig { returns(Integer) }
         attr_accessor :sequence_number
@@ -22,11 +30,18 @@ module OpenAI
 
         # Emitted when the list of available MCP tools has been successfully retrieved.
         sig do
-          params(sequence_number: Integer, type: Symbol).returns(
-            T.attached_class
-          )
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
+          # The ID of the MCP tool call item that produced this output.
+          item_id:,
+          # The index of the output item that was processed.
+          output_index:,
           # The sequence number of this event.
           sequence_number:,
           # The type of the event. Always 'response.mcp_list_tools.completed'.
@@ -34,7 +49,16 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ sequence_number: Integer, type: Symbol }) }
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/responses/response_mcp_list_tools_failed_event.rbi

@@ -12,6 +12,14 @@ module OpenAI
             )
           end
 
+        # The ID of the MCP tool call item that failed.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that failed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
         # The sequence number of this event.
         sig { returns(Integer) }
         attr_accessor :sequence_number
@@ -22,11 +30,18 @@ module OpenAI
 
         # Emitted when the attempt to list available MCP tools has failed.
         sig do
-          params(sequence_number: Integer, type: Symbol).returns(
-            T.attached_class
-          )
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
+          # The ID of the MCP tool call item that failed.
+          item_id:,
+          # The index of the output item that failed.
+          output_index:,
           # The sequence number of this event.
           sequence_number:,
           # The type of the event. Always 'response.mcp_list_tools.failed'.
@@ -34,7 +49,16 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ sequence_number: Integer, type: Symbol }) }
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/responses/response_mcp_list_tools_in_progress_event.rbi

@@ -12,6 +12,14 @@ module OpenAI
             )
           end
 
+        # The ID of the MCP tool call item that is being processed.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that is being processed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
         # The sequence number of this event.
         sig { returns(Integer) }
         attr_accessor :sequence_number
@@ -23,11 +31,18 @@ module OpenAI
         # Emitted when the system is in the process of retrieving the list of available
         # MCP tools.
         sig do
-          params(sequence_number: Integer, type: Symbol).returns(
-            T.attached_class
-          )
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
+          # The ID of the MCP tool call item that is being processed.
+          item_id:,
+          # The index of the output item that is being processed.
+          output_index:,
           # The sequence number of this event.
           sequence_number:,
           # The type of the event. Always 'response.mcp_list_tools.in_progress'.
@@ -35,7 +50,16 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ sequence_number: Integer, type: Symbol }) }
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/responses/response_stream_event.rbi

@@ -59,8 +59,6 @@ module OpenAI
               OpenAI::Responses::ResponseMcpListToolsInProgressEvent,
               OpenAI::Responses::ResponseOutputTextAnnotationAddedEvent,
               OpenAI::Responses::ResponseQueuedEvent,
-              OpenAI::Responses::ResponseReasoningDeltaEvent,
-              OpenAI::Responses::ResponseReasoningDoneEvent,
               OpenAI::Responses::ResponseReasoningSummaryDeltaEvent,
               OpenAI::Responses::ResponseReasoningSummaryDoneEvent
             )