openai 0.86.0 → 0.88.0

data/lib/openai/models/beta/file_search_tool.rb

@@ -17,9 +17,11 @@ module OpenAI
         optional :file_search, -> { OpenAI::Beta::FileSearchTool::FileSearch }
 
         # @!method initialize(file_search: nil, type: :file_search)
-        #   @param file_search [OpenAI::Models::Beta::FileSearchTool::FileSearch] Overrides for the file search tool.
+        #   @param file_search [OpenAI::Models::Beta::FileSearchTool::FileSearch]
+        #     Overrides for the file search tool.
         #
-        #   @param type [Symbol, :file_search] The type of tool being defined: `file_search`
+        #   @param type [Symbol, :file_search]
+        #     The type of tool being defined: `file_search`
 
         # @see OpenAI::Models::Beta::FileSearchTool#file_search
         class FileSearch < OpenAI::Internal::Type::BaseModel
@@ -30,7 +32,7 @@ module OpenAI
           #
           #   Note that the file search tool may output fewer than `max_num_results` results.
           #   See the
-          #   [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
+          #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
           #   for more information.
           #
           #   @return [Integer, nil]
@@ -41,21 +43,32 @@ module OpenAI
           #   will use the `auto` ranker and a score_threshold of 0.
           #
           #   See the
-          #   [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
+          #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
           #   for more information.
           #
           #   @return [OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions, nil]
           optional :ranking_options, -> { OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions }
 
           # @!method initialize(max_num_results: nil, ranking_options: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::FileSearchTool::FileSearch} for more details.
-          #
           #   Overrides for the file search tool.
           #
-          #   @param max_num_results [Integer] The maximum number of results the file search tool should output. The default is
+          #   @param max_num_results [Integer]
+          #     The maximum number of results the file search tool should output. The default is
+          #     20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between
+          #     1 and 50 inclusive.
+          #
+          #     Note that the file search tool may output fewer than `max_num_results` results.
+          #     See the
+          #     [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          #     for more information.
           #
-          #   @param ranking_options [OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions] The ranking options for the file search. If not specified, the file search tool
+          #   @param ranking_options [OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions]
+          #     The ranking options for the file search. If not specified, the file search tool
+          #     will use the `auto` ranker and a score_threshold of 0.
+          #
+          #     See the
+          #     [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          #     for more information.
 
           # @see OpenAI::Models::Beta::FileSearchTool::FileSearch#ranking_options
           class RankingOptions < OpenAI::Internal::Type::BaseModel
@@ -74,20 +87,20 @@ module OpenAI
             optional :ranker, enum: -> { OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions::Ranker }
 
             # @!method initialize(score_threshold:, ranker: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions} for more
-            #   details.
-            #
             #   The ranking options for the file search. If not specified, the file search tool
             #   will use the `auto` ranker and a score_threshold of 0.
             #
             #   See the
-            #   [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
+            #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
             #   for more information.
             #
-            #   @param score_threshold [Float] The score threshold for the file search. All values must be a floating point num
+            #   @param score_threshold [Float]
+            #     The score threshold for the file search. All values must be a floating point
+            #     number between 0 and 1.
             #
-            #   @param ranker [Symbol, OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions::Ranker] The ranker to use for the file search. If not specified will use the `auto` rank
+            #   @param ranker [Symbol, OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions::Ranker]
+            #     The ranker to use for the file search. If not specified will use the `auto`
+            #     ranker.
 
             # The ranker to use for the file search. If not specified will use the `auto`
             # ranker.

data/lib/openai/models/beta/function_tool.rb

@@ -18,7 +18,8 @@ module OpenAI
         # @!method initialize(function:, type: :function)
         #   @param function [OpenAI::Models::FunctionDefinition]
         #
-        #   @param type [Symbol, :function] The type of tool being defined: `function`
+        #   @param type [Symbol, :function]
+        #     The type of tool being defined: `function`
       end
     end
   end

data/lib/openai/models/beta/message_stream_event.rb

@@ -4,32 +4,32 @@ module OpenAI
   module Models
     module Beta
       # Occurs when a
-      # [message](https://platform.openai.com/docs/api-reference/messages/object) is
+      # [message](https://developers.openai.com/api/docs/assistants/migration) is
       # created.
       module MessageStreamEvent
         extend OpenAI::Internal::Type::Union
 
         discriminator :event
 
-        # Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is created.
+        # Occurs when a [message](https://developers.openai.com/api/docs/assistants/migration) is created.
         variant :"thread.message.created", -> { OpenAI::Beta::MessageStreamEvent::ThreadMessageCreated }
 
-        # Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) moves to an `in_progress` state.
+        # Occurs when a [message](https://developers.openai.com/api/docs/assistants/migration) moves to an `in_progress` state.
         variant :"thread.message.in_progress", -> { OpenAI::Beta::MessageStreamEvent::ThreadMessageInProgress }
 
-        # Occurs when parts of a [Message](https://platform.openai.com/docs/api-reference/messages/object) are being streamed.
+        # Occurs when parts of a [Message](https://developers.openai.com/api/docs/assistants/migration) are being streamed.
         variant :"thread.message.delta", -> { OpenAI::Beta::MessageStreamEvent::ThreadMessageDelta }
 
-        # Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is completed.
+        # Occurs when a [message](https://developers.openai.com/api/docs/assistants/migration) is completed.
         variant :"thread.message.completed", -> { OpenAI::Beta::MessageStreamEvent::ThreadMessageCompleted }
 
-        # Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) ends before it is completed.
+        # Occurs when a [message](https://developers.openai.com/api/docs/assistants/migration) ends before it is completed.
         variant :"thread.message.incomplete", -> { OpenAI::Beta::MessageStreamEvent::ThreadMessageIncomplete }
 
         class ThreadMessageCreated < OpenAI::Internal::Type::BaseModel
           # @!attribute data
           #   Represents a message within a
-          #   [thread](https://platform.openai.com/docs/api-reference/threads).
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           #
           #   @return [OpenAI::Models::Beta::Threads::Message]
           required :data, -> { OpenAI::Beta::Threads::Message }
@@ -40,15 +40,13 @@ module OpenAI
           required :event, const: :"thread.message.created"
 
           # @!method initialize(data:, event: :"thread.message.created")
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageCreated} for more
-          #   details.
-          #
           #   Occurs when a
-          #   [message](https://platform.openai.com/docs/api-reference/messages/object) is
+          #   [message](https://developers.openai.com/api/docs/assistants/migration) is
           #   created.
           #
-          #   @param data [OpenAI::Models::Beta::Threads::Message] Represents a message within a [thread](https://platform.openai.com/docs/api-refe
+          #   @param data [OpenAI::Models::Beta::Threads::Message]
+          #     Represents a message within a
+          #     [thread](https://developers.openai.com/api/docs/assistants/migration).
           #
           #   @param event [Symbol, :"thread.message.created"]
         end
@@ -56,7 +54,7 @@ module OpenAI
         class ThreadMessageInProgress < OpenAI::Internal::Type::BaseModel
           # @!attribute data
           #   Represents a message within a
-          #   [thread](https://platform.openai.com/docs/api-reference/threads).
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           #
           #   @return [OpenAI::Models::Beta::Threads::Message]
           required :data, -> { OpenAI::Beta::Threads::Message }
@@ -67,15 +65,13 @@ module OpenAI
           required :event, const: :"thread.message.in_progress"
 
           # @!method initialize(data:, event: :"thread.message.in_progress")
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageInProgress} for more
-          #   details.
-          #
           #   Occurs when a
-          #   [message](https://platform.openai.com/docs/api-reference/messages/object) moves
-          #   to an `in_progress` state.
+          #   [message](https://developers.openai.com/api/docs/assistants/migration) moves to
+          #   an `in_progress` state.
           #
-          #   @param data [OpenAI::Models::Beta::Threads::Message] Represents a message within a [thread](https://platform.openai.com/docs/api-refe
+          #   @param data [OpenAI::Models::Beta::Threads::Message]
+          #     Represents a message within a
+          #     [thread](https://developers.openai.com/api/docs/assistants/migration).
           #
           #   @param event [Symbol, :"thread.message.in_progress"]
         end
@@ -94,14 +90,13 @@ module OpenAI
           required :event, const: :"thread.message.delta"
 
           # @!method initialize(data:, event: :"thread.message.delta")
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageDelta} for more details.
-          #
           #   Occurs when parts of a
-          #   [Message](https://platform.openai.com/docs/api-reference/messages/object) are
-          #   being streamed.
+          #   [Message](https://developers.openai.com/api/docs/assistants/migration) are being
+          #   streamed.
           #
-          #   @param data [OpenAI::Models::Beta::Threads::MessageDeltaEvent] Represents a message delta i.e. any changed fields on a message during streaming
+          #   @param data [OpenAI::Models::Beta::Threads::MessageDeltaEvent]
+          #     Represents a message delta i.e. any changed fields on a message during
+          #     streaming.
           #
           #   @param event [Symbol, :"thread.message.delta"]
         end
@@ -109,7 +104,7 @@ module OpenAI
         class ThreadMessageCompleted < OpenAI::Internal::Type::BaseModel
           # @!attribute data
           #   Represents a message within a
-          #   [thread](https://platform.openai.com/docs/api-reference/threads).
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           #
           #   @return [OpenAI::Models::Beta::Threads::Message]
           required :data, -> { OpenAI::Beta::Threads::Message }
@@ -120,15 +115,13 @@ module OpenAI
           required :event, const: :"thread.message.completed"
 
           # @!method initialize(data:, event: :"thread.message.completed")
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageCompleted} for more
-          #   details.
-          #
           #   Occurs when a
-          #   [message](https://platform.openai.com/docs/api-reference/messages/object) is
+          #   [message](https://developers.openai.com/api/docs/assistants/migration) is
           #   completed.
           #
-          #   @param data [OpenAI::Models::Beta::Threads::Message] Represents a message within a [thread](https://platform.openai.com/docs/api-refe
+          #   @param data [OpenAI::Models::Beta::Threads::Message]
+          #     Represents a message within a
+          #     [thread](https://developers.openai.com/api/docs/assistants/migration).
           #
           #   @param event [Symbol, :"thread.message.completed"]
         end
@@ -136,7 +129,7 @@ module OpenAI
         class ThreadMessageIncomplete < OpenAI::Internal::Type::BaseModel
           # @!attribute data
           #   Represents a message within a
-          #   [thread](https://platform.openai.com/docs/api-reference/threads).
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           #
           #   @return [OpenAI::Models::Beta::Threads::Message]
           required :data, -> { OpenAI::Beta::Threads::Message }
@@ -147,15 +140,13 @@ module OpenAI
           required :event, const: :"thread.message.incomplete"
 
           # @!method initialize(data:, event: :"thread.message.incomplete")
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageIncomplete} for more
-          #   details.
-          #
           #   Occurs when a
-          #   [message](https://platform.openai.com/docs/api-reference/messages/object) ends
+          #   [message](https://developers.openai.com/api/docs/assistants/migration) ends
           #   before it is completed.
           #
-          #   @param data [OpenAI::Models::Beta::Threads::Message] Represents a message within a [thread](https://platform.openai.com/docs/api-refe
+          #   @param data [OpenAI::Models::Beta::Threads::Message]
+          #     Represents a message within a
+          #     [thread](https://developers.openai.com/api/docs/assistants/migration).
           #
           #   @param event [Symbol, :"thread.message.incomplete"]
         end

data/lib/openai/models/beta/response_compact_params.rb

@@ -12,8 +12,8 @@ module OpenAI
         #   Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
         #   range of models with different capabilities, performance characteristics, and
         #   price points. Refer to the
-        #   [model guide](https://platform.openai.com/docs/models) to browse and compare
-        #   available models.
+        #   [model guide](https://developers.openai.com/api/docs/models) to browse and
+        #   compare available models.
         #
         #   @return [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil]
         required :model, union: -> { OpenAI::Beta::ResponseCompactParams::Model }, nil?: true
@@ -36,7 +36,7 @@ module OpenAI
         # @!attribute previous_response_id
         #   The unique ID of the previous response to the model. Use this to create
         #   multi-turn conversations. Learn more about
-        #   [conversation state](https://platform.openai.com/docs/guides/conversation-state).
+        #   [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
         #   Cannot be used in conjunction with `conversation`.
         #
         #   @return [String, nil]
@@ -56,7 +56,7 @@ module OpenAI
         #   up to the latest 80 breakpoints in the conversation, without a content-block
         #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
         #   `ttl` defaults to `30m`, which is currently the only supported value. See the
-        #   [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching)
+        #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
         #   for current details.
         #
         #   @return [OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions, nil]
@@ -86,17 +86,17 @@ module OpenAI
         #   Project settings. Unless otherwise configured, the Project will use 'default'. -
         #   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)', then the
-        #   request will be processed with the Flex Processing service tier. - To opt-in to
-        #   [Fast mode](/api/docs/guides/fast-mode) at the request level, include the
-        #   `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat
-        #   Completions. For models with a dedicated Fast tier, either value resolves to
-        #   `service_tier=fast`; for other models, either value resolves to
-        #   `service_tier=priority`. - When not set, the default behavior is 'auto'. When
-        #   the `service_tier` parameter is set, the response body will include the
-        #   `service_tier` value based on the processing mode actually used to serve the
-        #   request. This response value may be different from the value set in the
-        #   parameter.
+        #   '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        #   the request will be processed with the Flex Processing service tier. - To opt-in
+        #   to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        #   request level, include the `service_tier=fast` or `service_tier=priority`
+        #   parameter for Responses or Chat Completions. For models with a dedicated Fast
+        #   tier, either value resolves to `service_tier=fast`; for other models, either
+        #   value resolves to `service_tier=priority`. - When not set, the default behavior
+        #   is 'auto'. When the `service_tier` parameter is set, the response body will
+        #   include the `service_tier` value based on the processing mode actually used to
+        #   serve the request. This response value may be different from the value set in
+        #   the parameter.
         #
         #   @return [Symbol, OpenAI::Models::Beta::ResponseCompactParams::ServiceTier, nil]
         optional :service_tier, enum: -> { OpenAI::Beta::ResponseCompactParams::ServiceTier }, nil?: true
@@ -107,24 +107,62 @@ module OpenAI
         optional :betas, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::ResponseCompactParams::Beta] }
 
         # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, service_tier: nil, betas: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::ResponseCompactParams} for more details.
+        #   @param model [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil]
+        #     Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
+        #     range of models with different capabilities, performance characteristics, and
+        #     price points. Refer to the
+        #     [model guide](https://developers.openai.com/api/docs/models) to browse and
+        #     compare available models.
         #
-        #   @param model [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
+        #   @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil]
+        #     Text, image, or file inputs to the model, used to generate a response
         #
-        #   @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] Text, image, or file inputs to the model, used to generate a response
+        #   @param instructions [String, nil]
+        #     A system (or developer) message inserted into the model's context. When used
+        #     along with `previous_response_id`, the instructions from a previous response
+        #     will not be carried over to the next response. This makes it simple to swap out
+        #     system (or developer) messages in new responses.
         #
-        #   @param instructions [String, nil] A system (or developer) message inserted into the model's context.
+        #   @param previous_response_id [String, nil]
+        #     The unique ID of the previous response to the model. Use this to create
+        #     multi-turn conversations. Learn more about
+        #     [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
+        #     Cannot be used in conjunction with `conversation`.
         #
-        #   @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 prompt_cache_key [String, nil] A key to use when reading from or writing to the prompt cache.
+        #   @param prompt_cache_options [OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions, nil]
+        #     Options for prompt caching. Supported for `gpt-5.6` and later models. By
+        #     default, OpenAI automatically chooses one implicit cache breakpoint. You can add
+        #     explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
+        #     request can write up to four breakpoints. For cache matching, OpenAI considers
+        #     up to the latest 80 breakpoints in the conversation, without a content-block
+        #     lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
+        #     `ttl` defaults to `30m`, which is currently the only supported value. See the
+        #     [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
+        #     for current details.
         #
-        #   @param prompt_cache_options [OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions, nil] Options for prompt caching. Supported for `gpt-5.6` and later models. By default
+        #   @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheRetention, nil]
+        #     How long to retain a prompt cache entry created by this request.
         #
-        #   @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheRetention, nil] How long to retain a prompt cache entry created by this request.
-        #
-        #   @param service_tier [Symbol, OpenAI::Models::Beta::ResponseCompactParams::ServiceTier, nil] Specifies the processing type used for serving the request. - If set to 'auto'
+        #   @param service_tier [Symbol, OpenAI::Models::Beta::ResponseCompactParams::ServiceTier, 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 request will be processed with the standard
+        #     pricing and performance for the selected model. - If set to
+        #     '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        #     the request will be processed with the Flex Processing service tier. - To opt-in
+        #     to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        #     request level, include the `service_tier=fast` or `service_tier=priority`
+        #     parameter for Responses or Chat Completions. For models with a dedicated Fast
+        #     tier, either value resolves to `service_tier=fast`; for other models, either
+        #     value resolves to `service_tier=priority`. - When not set, the default behavior
+        #     is 'auto'. When the `service_tier` parameter is set, the response body will
+        #     include the `service_tier` value based on the processing mode actually used to
+        #     serve the request. This response value may be different from the value set in
+        #     the parameter.
         #
         #   @param betas [Array<Symbol, OpenAI::Models::Beta::ResponseCompactParams::Beta>]
         #
@@ -133,8 +171,8 @@ module OpenAI
         # Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
         # range of models with different capabilities, performance characteristics, and
         # price points. Refer to the
-        # [model guide](https://platform.openai.com/docs/models) to browse and compare
-        # available models.
+        # [model guide](https://developers.openai.com/api/docs/models) to browse and
+        # compare available models.
         module Model
           extend OpenAI::Internal::Type::Union
 
@@ -506,10 +544,6 @@ module OpenAI
           optional :ttl, enum: -> { OpenAI::Beta::ResponseCompactParams::PromptCacheOptions::Ttl }
 
           # @!method initialize(mode: nil, ttl: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions} for more
-          #   details.
-          #
           #   Options for prompt caching. Supported for `gpt-5.6` and later models. By
           #   default, OpenAI automatically chooses one implicit cache breakpoint. You can add
           #   explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
@@ -517,12 +551,21 @@ module OpenAI
           #   up to the latest 80 breakpoints in the conversation, without a content-block
           #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
           #   `ttl` defaults to `30m`, which is currently the only supported value. See the
-          #   [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching)
+          #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
           #   for current details.
           #
-          #   @param mode [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::Mode] Controls whether OpenAI automatically creates an implicit cache breakpoint. Defa
+          #   @param mode [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::Mode]
+          #     Controls whether OpenAI automatically creates an implicit cache breakpoint.
+          #     Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
+          #     and writes up to the latest three explicit breakpoints in the request. With
+          #     `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
+          #     latest four explicit breakpoints. If there are no explicit breakpoints, the
+          #     request does not use prompt caching.
           #
-          #   @param ttl [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::Ttl] The minimum lifetime applied to every implicit and explicit cache breakpoint wri
+          #   @param ttl [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::Ttl]
+          #     The minimum lifetime applied to every implicit and explicit cache breakpoint
+          #     written by the request. Defaults to `30m`, which is currently the only supported
+          #     value. The backend may retain cache entries for longer.
 
           # Controls whether OpenAI automatically creates an implicit cache breakpoint.
           # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
@@ -575,17 +618,17 @@ module OpenAI
         # Project settings. Unless otherwise configured, the Project will use 'default'. -
         # 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)', then the
-        # request will be processed with the Flex Processing service tier. - To opt-in to
-        # [Fast mode](/api/docs/guides/fast-mode) at the request level, include the
-        # `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat
-        # Completions. For models with a dedicated Fast tier, either value resolves to
-        # `service_tier=fast`; for other models, either value resolves to
-        # `service_tier=priority`. - When not set, the default behavior is 'auto'. When
-        # the `service_tier` parameter is set, the response body will include the
-        # `service_tier` value based on the processing mode actually used to serve the
-        # request. This response value may be different from the value set in the
-        # parameter.
+        # '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        # the request will be processed with the Flex Processing service tier. - To opt-in
+        # to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        # request level, include the `service_tier=fast` or `service_tier=priority`
+        # parameter for Responses or Chat Completions. For models with a dedicated Fast
+        # tier, either value resolves to `service_tier=fast`; for other models, either
+        # value resolves to `service_tier=priority`. - When not set, the default behavior
+        # is 'auto'. When the `service_tier` parameter is set, the response body will
+        # include the `service_tier` value based on the processing mode actually used to
+        # serve the request. This response value may be different from the value set in
+        # the parameter.
         module ServiceTier
           extend OpenAI::Internal::Type::Enum