openai 0.14.0 → 0.16.0

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

@@ -123,6 +123,14 @@ module OpenAI
         #   @return [OpenAI::Models::Responses::ResponsePrompt, nil]
         optional :prompt, -> { OpenAI::Responses::ResponsePrompt }, nil?: true
 
+        # @!attribute prompt_cache_key
+        #   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).
+        #
+        #   @return [String, nil]
+        optional :prompt_cache_key, String
+
         # @!attribute reasoning
         #   **o-series models only**
         #
@@ -132,13 +140,23 @@ module OpenAI
         #   @return [OpenAI::Models::Reasoning, nil]
         optional :reasoning, -> { OpenAI::Reasoning }, nil?: true
 
+        # @!attribute safety_identifier
+        #   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).
+        #
+        #   @return [String, nil]
+        optional :safety_identifier, String
+
         # @!attribute service_tier
         #   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
@@ -242,14 +260,18 @@ module OpenAI
         optional :truncation, enum: -> { OpenAI::Responses::ResponseCreateParams::Truncation }, nil?: true
 
         # @!attribute user
-        #   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).
+        #   @deprecated
+        #
+        #   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).
         #
         #   @return [String, nil]
         optional :user, String
 
-        # @!method initialize(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
+        # @!method initialize(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseCreateParams} for more details.
         #
@@ -275,8 +297,12 @@ module OpenAI
         #
         #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
         #
+        #   @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+        #
         #   @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
         #
+        #   @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+        #
         #   @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
         #
         #   @param store [Boolean, nil] Whether to store the generated model response for later retrieval via
@@ -295,7 +321,7 @@ module OpenAI
         #
         #   @param truncation [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Truncation, nil] The truncation strategy to use for the model response.
         #
-        #   @param user [String] A stable identifier for your end-users.
+        #   @param user [String] This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -328,7 +354,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/lib/openai/models/responses/response_mcp_call_arguments_delta_event.rb

@@ -5,10 +5,11 @@ module OpenAI
     module Responses
       class ResponseMcpCallArgumentsDeltaEvent < OpenAI::Internal::Type::BaseModel
         # @!attribute delta
-        #   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.
         #
-        #   @return [Object]
-        required :delta, OpenAI::Internal::Type::Unknown
+        #   @return [String]
+        required :delta, String
 
         # @!attribute item_id
         #   The unique identifier of the MCP tool call item being processed.
@@ -35,10 +36,14 @@ module OpenAI
         required :type, const: :"response.mcp_call_arguments.delta"
 
         # @!method initialize(delta:, item_id:, output_index:, sequence_number:, type: :"response.mcp_call_arguments.delta")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent} for more
+        #   details.
+        #
         #   Emitted when there is a delta (partial update) to the arguments of an MCP tool
         #   call.
         #
-        #   @param delta [Object] The partial update to the arguments for the MCP tool call.
+        #   @param delta [String] A JSON string containing the partial update to the arguments for the MCP tool ca
         #
         #   @param item_id [String] The unique identifier of the MCP tool call item being processed.
         #

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

@@ -5,10 +5,10 @@ module OpenAI
     module Responses
       class ResponseMcpCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
         # @!attribute arguments
-        #   The finalized arguments for the MCP tool call.
+        #   A JSON string containing the finalized arguments for the MCP tool call.
         #
-        #   @return [Object]
-        required :arguments, OpenAI::Internal::Type::Unknown
+        #   @return [String]
+        required :arguments, String
 
         # @!attribute item_id
         #   The unique identifier of the MCP tool call item being processed.
@@ -35,9 +35,12 @@ module OpenAI
         required :type, const: :"response.mcp_call_arguments.done"
 
         # @!method initialize(arguments:, item_id:, output_index:, sequence_number:, type: :"response.mcp_call_arguments.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent} for more details.
+        #
         #   Emitted when the arguments for an MCP tool call are finalized.
         #
-        #   @param arguments [Object] The finalized arguments for the MCP tool call.
+        #   @param arguments [String] A JSON string containing the finalized arguments for the MCP tool call.
         #
         #   @param item_id [String] The unique identifier of the MCP tool call item being processed.
         #

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

@@ -4,6 +4,18 @@ module OpenAI
   module Models
     module Responses
       class ResponseMcpCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that completed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that completed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
         # @!attribute sequence_number
         #   The sequence number of this event.
         #
@@ -16,9 +28,13 @@ module OpenAI
         #   @return [Symbol, :"response.mcp_call.completed"]
         required :type, const: :"response.mcp_call.completed"
 
-        # @!method initialize(sequence_number:, type: :"response.mcp_call.completed")
+        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.mcp_call.completed")
         #   Emitted when an MCP tool call has completed successfully.
         #
+        #   @param item_id [String] The ID of the MCP tool call item that completed.
+        #
+        #   @param output_index [Integer] The index of the output item that completed.
+        #
         #   @param sequence_number [Integer] The sequence number of this event.
         #
         #   @param type [Symbol, :"response.mcp_call.completed"] The type of the event. Always 'response.mcp_call.completed'.

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

@@ -4,6 +4,18 @@ module OpenAI
   module Models
     module Responses
       class ResponseMcpCallFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that failed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that failed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
         # @!attribute sequence_number
         #   The sequence number of this event.
         #
@@ -16,9 +28,13 @@ module OpenAI
         #   @return [Symbol, :"response.mcp_call.failed"]
         required :type, const: :"response.mcp_call.failed"
 
-        # @!method initialize(sequence_number:, type: :"response.mcp_call.failed")
+        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.mcp_call.failed")
         #   Emitted when an MCP tool call has failed.
         #
+        #   @param item_id [String] The ID of the MCP tool call item that failed.
+        #
+        #   @param output_index [Integer] The index of the output item that failed.
+        #
         #   @param sequence_number [Integer] The sequence number of this event.
         #
         #   @param type [Symbol, :"response.mcp_call.failed"] The type of the event. Always 'response.mcp_call.failed'.

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

@@ -4,6 +4,18 @@ module OpenAI
   module Models
     module Responses
       class ResponseMcpListToolsCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that produced this output.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that was processed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
         # @!attribute sequence_number
         #   The sequence number of this event.
         #
@@ -16,9 +28,13 @@ module OpenAI
         #   @return [Symbol, :"response.mcp_list_tools.completed"]
         required :type, const: :"response.mcp_list_tools.completed"
 
-        # @!method initialize(sequence_number:, type: :"response.mcp_list_tools.completed")
+        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.mcp_list_tools.completed")
         #   Emitted when the list of available MCP tools has been successfully retrieved.
         #
+        #   @param item_id [String] The ID of the MCP tool call item that produced this output.
+        #
+        #   @param output_index [Integer] The index of the output item that was processed.
+        #
         #   @param sequence_number [Integer] The sequence number of this event.
         #
         #   @param type [Symbol, :"response.mcp_list_tools.completed"] The type of the event. Always 'response.mcp_list_tools.completed'.

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

@@ -4,6 +4,18 @@ module OpenAI
   module Models
     module Responses
       class ResponseMcpListToolsFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that failed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that failed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
         # @!attribute sequence_number
         #   The sequence number of this event.
         #
@@ -16,9 +28,13 @@ module OpenAI
         #   @return [Symbol, :"response.mcp_list_tools.failed"]
         required :type, const: :"response.mcp_list_tools.failed"
 
-        # @!method initialize(sequence_number:, type: :"response.mcp_list_tools.failed")
+        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.mcp_list_tools.failed")
         #   Emitted when the attempt to list available MCP tools has failed.
         #
+        #   @param item_id [String] The ID of the MCP tool call item that failed.
+        #
+        #   @param output_index [Integer] The index of the output item that failed.
+        #
         #   @param sequence_number [Integer] The sequence number of this event.
         #
         #   @param type [Symbol, :"response.mcp_list_tools.failed"] The type of the event. Always 'response.mcp_list_tools.failed'.

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

@@ -4,6 +4,18 @@ module OpenAI
   module Models
     module Responses
       class ResponseMcpListToolsInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that is being processed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that is being processed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
         # @!attribute sequence_number
         #   The sequence number of this event.
         #
@@ -16,10 +28,14 @@ module OpenAI
         #   @return [Symbol, :"response.mcp_list_tools.in_progress"]
         required :type, const: :"response.mcp_list_tools.in_progress"
 
-        # @!method initialize(sequence_number:, type: :"response.mcp_list_tools.in_progress")
+        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.mcp_list_tools.in_progress")
         #   Emitted when the system is in the process of retrieving the list of available
         #   MCP tools.
         #
+        #   @param item_id [String] The ID of the MCP tool call item that is being processed.
+        #
+        #   @param output_index [Integer] The index of the output item that is being processed.
+        #
         #   @param sequence_number [Integer] The sequence number of this event.
         #
         #   @param type [Symbol, :"response.mcp_list_tools.in_progress"] The type of the event. Always 'response.mcp_list_tools.in_progress'.

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

@@ -191,12 +191,6 @@ module OpenAI
         # Emitted when a response is queued and waiting to be processed.
         variant :"response.queued", -> { OpenAI::Responses::ResponseQueuedEvent }
 
-        # Emitted when there is a delta (partial update) to the reasoning content.
-        variant :"response.reasoning.delta", -> { OpenAI::Responses::ResponseReasoningDeltaEvent }
-
-        # Emitted when the reasoning content is finalized for an item.
-        variant :"response.reasoning.done", -> { OpenAI::Responses::ResponseReasoningDoneEvent }
-
         # Emitted when there is a delta (partial update) to the reasoning summary content.
         variant :"response.reasoning_summary.delta",
                 -> {
@@ -210,7 +204,7 @@ module OpenAI
                 }
 
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseReasoningDeltaEvent, OpenAI::Models::Responses::ResponseReasoningDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent)]
+        #   @return [Array(OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent)]
       end
     end
   end

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

@@ -22,6 +22,13 @@ module OpenAI
         #   @return [String]
         required :item_id, String
 
+        # @!attribute logprobs
+        #   The log probabilities of the tokens in the delta.
+        #
+        #   @return [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob>]
+        required :logprobs,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDeltaEvent::Logprob] }
+
         # @!attribute output_index
         #   The index of the output item that the text delta was added to.
         #
@@ -40,7 +47,7 @@ module OpenAI
         #   @return [Symbol, :"response.output_text.delta"]
         required :type, const: :"response.output_text.delta"
 
-        # @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, type: :"response.output_text.delta")
+        # @!method initialize(content_index:, delta:, item_id:, logprobs:, output_index:, sequence_number:, type: :"response.output_text.delta")
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseTextDeltaEvent} for more details.
         #
@@ -52,11 +59,69 @@ module OpenAI
         #
         #   @param item_id [String] The ID of the output item that the text delta was added to.
         #
+        #   @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob>] The log probabilities of the tokens in the delta.
+        #
         #   @param output_index [Integer] The index of the output item that the text delta was added to.
         #
         #   @param sequence_number [Integer] The sequence number for this event.
         #
         #   @param type [Symbol, :"response.output_text.delta"] The type of the event. Always `response.output_text.delta`.
+
+        class Logprob < OpenAI::Internal::Type::BaseModel
+          # @!attribute token
+          #   A possible text token.
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute logprob
+          #   The log probability of this token.
+          #
+          #   @return [Float]
+          required :logprob, Float
+
+          # @!attribute top_logprobs
+          #   The log probability of the top 20 most likely tokens.
+          #
+          #   @return [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob>, nil]
+          optional :top_logprobs,
+                   -> {
+                     OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob]
+                   }
+
+          # @!method initialize(token:, logprob:, top_logprobs: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob} for more details.
+          #
+          #   A logprob is the logarithmic probability that the model assigns to producing a
+          #   particular token at a given position in the sequence. Less-negative (higher)
+          #   logprob values indicate greater model confidence in that token choice.
+          #
+          #   @param token [String] A possible text token.
+          #
+          #   @param logprob [Float] The log probability of this token.
+          #
+          #   @param top_logprobs [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob>] The log probability of the top 20 most likely tokens.
+
+          class TopLogprob < OpenAI::Internal::Type::BaseModel
+            # @!attribute token
+            #   A possible text token.
+            #
+            #   @return [String, nil]
+            optional :token, String
+
+            # @!attribute logprob
+            #   The log probability of this token.
+            #
+            #   @return [Float, nil]
+            optional :logprob, Float
+
+            # @!method initialize(token: nil, logprob: nil)
+            #   @param token [String] A possible text token.
+            #
+            #   @param logprob [Float] The log probability of this token.
+          end
+        end
       end
     end
   end

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

@@ -16,6 +16,13 @@ module OpenAI
         #   @return [String]
         required :item_id, String
 
+        # @!attribute logprobs
+        #   The log probabilities of the tokens in the delta.
+        #
+        #   @return [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>]
+        required :logprobs,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDoneEvent::Logprob] }
+
         # @!attribute output_index
         #   The index of the output item that the text content is finalized.
         #
@@ -40,7 +47,7 @@ module OpenAI
         #   @return [Symbol, :"response.output_text.done"]
         required :type, const: :"response.output_text.done"
 
-        # @!method initialize(content_index:, item_id:, output_index:, sequence_number:, text:, type: :"response.output_text.done")
+        # @!method initialize(content_index:, item_id:, logprobs:, output_index:, sequence_number:, text:, type: :"response.output_text.done")
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseTextDoneEvent} for more details.
         #
@@ -50,6 +57,8 @@ module OpenAI
         #
         #   @param item_id [String] The ID of the output item that the text content is finalized.
         #
+        #   @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>] The log probabilities of the tokens in the delta.
+        #
         #   @param output_index [Integer] The index of the output item that the text content is finalized.
         #
         #   @param sequence_number [Integer] The sequence number for this event.
@@ -57,6 +66,62 @@ module OpenAI
         #   @param text [String] The text content that is finalized.
         #
         #   @param type [Symbol, :"response.output_text.done"] The type of the event. Always `response.output_text.done`.
+
+        class Logprob < OpenAI::Internal::Type::BaseModel
+          # @!attribute token
+          #   A possible text token.
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute logprob
+          #   The log probability of this token.
+          #
+          #   @return [Float]
+          required :logprob, Float
+
+          # @!attribute top_logprobs
+          #   The log probability of the top 20 most likely tokens.
+          #
+          #   @return [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob::TopLogprob>, nil]
+          optional :top_logprobs,
+                   -> {
+                     OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDoneEvent::Logprob::TopLogprob]
+                   }
+
+          # @!method initialize(token:, logprob:, top_logprobs: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob} for more details.
+          #
+          #   A logprob is the logarithmic probability that the model assigns to producing a
+          #   particular token at a given position in the sequence. Less-negative (higher)
+          #   logprob values indicate greater model confidence in that token choice.
+          #
+          #   @param token [String] A possible text token.
+          #
+          #   @param logprob [Float] The log probability of this token.
+          #
+          #   @param top_logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob::TopLogprob>] The log probability of the top 20 most likely tokens.
+
+          class TopLogprob < OpenAI::Internal::Type::BaseModel
+            # @!attribute token
+            #   A possible text token.
+            #
+            #   @return [String, nil]
+            optional :token, String
+
+            # @!attribute logprob
+            #   The log probability of this token.
+            #
+            #   @return [Float, nil]
+            optional :logprob, Float
+
+            # @!method initialize(token: nil, logprob: nil)
+            #   @param token [String] A possible text token.
+            #
+            #   @param logprob [Float] The log probability of this token.
+          end
+        end
       end
     end
   end

data/lib/openai/resources/chat/completions.rb

@@ -30,7 +30,7 @@ module OpenAI
         # unsupported parameters in reasoning models,
         # [refer to the reasoning guide](https://platform.openai.com/docs/guides/reasoning).
         #
-        # @overload create(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, reasoning_effort: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, web_search_options: nil, request_options: {})
+        # @overload create(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, prompt_cache_key: nil, reasoning_effort: nil, response_format: nil, safety_identifier: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, web_search_options: nil, request_options: {})
         #
         # @param messages [Array<OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam, OpenAI::Models::Chat::ChatCompletionSystemMessageParam, OpenAI::Models::Chat::ChatCompletionUserMessageParam, OpenAI::Models::Chat::ChatCompletionAssistantMessageParam, OpenAI::Models::Chat::ChatCompletionToolMessageParam, OpenAI::Models::Chat::ChatCompletionFunctionMessageParam>] A list of messages comprising the conversation so far. Depending on the
         #
@@ -64,10 +64,14 @@ module OpenAI
         #
         # @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on
         #
+        # @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+        #
         # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] **o-series models only**
         #
         # @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject] An object specifying the format that the model must output.
         #
+        # @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+        #
         # @param seed [Integer, nil] This feature is in Beta.
         #
         # @param service_tier [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
@@ -88,7 +92,7 @@ module OpenAI
         #
         # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
         #
-        # @param user [String] A stable identifier for your end-users.
+        # @param user [String] This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
         #
         # @param web_search_options [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions] This tool searches the web for relevant results to use in a response.
         #
@@ -226,7 +230,7 @@ module OpenAI
         # unsupported parameters in reasoning models,
         # [refer to the reasoning guide](https://platform.openai.com/docs/guides/reasoning).
         #
-        # @overload stream_raw(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, reasoning_effort: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, web_search_options: nil, request_options: {})
+        # @overload stream_raw(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, prompt_cache_key: nil, reasoning_effort: nil, response_format: nil, safety_identifier: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, web_search_options: nil, request_options: {})
         #
         # @param messages [Array<OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam, OpenAI::Models::Chat::ChatCompletionSystemMessageParam, OpenAI::Models::Chat::ChatCompletionUserMessageParam, OpenAI::Models::Chat::ChatCompletionAssistantMessageParam, OpenAI::Models::Chat::ChatCompletionToolMessageParam, OpenAI::Models::Chat::ChatCompletionFunctionMessageParam>] A list of messages comprising the conversation so far. Depending on the
         #
@@ -260,10 +264,14 @@ module OpenAI
         #
         # @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on
         #
+        # @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+        #
         # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] **o-series models only**
         #
         # @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject] An object specifying the format that the model must output.
         #
+        # @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+        #
         # @param seed [Integer, nil] This feature is in Beta.
         #
         # @param service_tier [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
@@ -284,7 +292,7 @@ module OpenAI
         #
         # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
         #
-        # @param user [String] A stable identifier for your end-users.
+        # @param user [String] This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
         #
         # @param web_search_options [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions] This tool searches the web for relevant results to use in a response.
         #