openai 0.87.0 → 0.89.0

data/rbi/openai/resources/responses.rbi

@@ -14,16 +14,16 @@ module OpenAI
       # See {OpenAI::Resources::Responses#stream_raw} for streaming counterpart.
       #
       # Creates a model response. Provide
-      # [text](https://platform.openai.com/docs/guides/text) or
-      # [image](https://platform.openai.com/docs/guides/images) inputs to generate
-      # [text](https://platform.openai.com/docs/guides/text) or
-      # [JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have
-      # the model call your own
-      # [custom code](https://platform.openai.com/docs/guides/function-calling) or use
-      # built-in [tools](https://platform.openai.com/docs/guides/tools) like
-      # [web search](https://platform.openai.com/docs/guides/tools-web-search) or
-      # [file search](https://platform.openai.com/docs/guides/tools-file-search) to use
-      # your own data as input for the model's response.
+      # [text](https://developers.openai.com/api/docs/guides/text) or
+      # [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
+      # generate [text](https://developers.openai.com/api/docs/guides/text) or
+      # [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
+      # outputs. Have the model call your own
+      # [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
+      # use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
+      # [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
+      # [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
+      # to use your own data as input for the model's response.
       sig do
         params(
           background: T.nilable(T::Boolean),
@@ -95,7 +95,7 @@ module OpenAI
       end
       def create(
         # Whether to run the model response in the background.
-        # [Learn more](https://platform.openai.com/docs/guides/background).
+        # [Learn more](https://developers.openai.com/api/docs/guides/background).
         background: nil,
         # Context management configuration for this request.
         context_management: nil,
@@ -127,11 +127,11 @@ module OpenAI
         #
         # Learn more:
         #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Image inputs](https://platform.openai.com/docs/guides/images)
-        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
-        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
-        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
+        # - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        # - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
+        # - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
+        # - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
+        # - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
         input: nil,
         # A system (or developer) message inserted into the model's context.
         #
@@ -141,7 +141,7 @@ module OpenAI
         instructions: nil,
         # An upper bound for the number of tokens that can be generated for a response,
         # including visible output tokens and
-        # [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
+        # [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
         max_output_tokens: nil,
         # The maximum number of total calls to built-in tools that can be processed in a
         # response. This maximum number applies across all built-in tool calls, not per
@@ -158,8 +158,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.
         model: nil,
         # Configuration for running moderation on the input and output of this response.
         moderation: nil,
@@ -167,15 +167,15 @@ module OpenAI
         parallel_tool_calls: nil,
         # 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`.
         previous_response_id: nil,
         # Reference to a prompt template and its variables.
-        # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        # [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
         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).
+        # [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
         prompt_cache_key: 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
@@ -184,7 +184,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.
         prompt_cache_options: nil,
         # Deprecated. Use `prompt_cache_options.ttl` instead.
@@ -192,7 +192,7 @@ module OpenAI
         # The retention policy for the prompt cache. Set to `24h` to enable extended
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
-        # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
         # This field expresses a maximum retention policy, while
         # `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
         # are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
@@ -206,14 +206,14 @@ module OpenAI
         #   `prompt_cache_retention` is not specified.
         prompt_cache_retention: nil,
         # Configuration options for
-        # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+        # [reasoning models](https://developers.openai.com/api/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, with a maximum length of 64 characters. 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).
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         safety_identifier: nil,
         # Specifies the processing type used for serving the request.
         #
@@ -222,13 +222,15 @@ module OpenAI
         #   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. The response will show `service_tier=priority`
-        #   regardless of if you specify `service_tier=fast` or `priority` in your
-        #   request.
+        # - 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. The response will show
+        #   `service_tier=priority` regardless of if you specify `service_tier=fast` or
+        #   `priority` in your request.
         # - If set to 'ultrafast', then the request will be processed with the
         #   access-controlled Ultrafast Processing service tier. This tier is currently
         #   available for `gpt-5.6-sol`; a response served through it will show
@@ -243,7 +245,7 @@ module OpenAI
         # Whether to store the generated model response for later retrieval via API.
         # Defaults to true when omitted. If set to true, response data will be stored for
         # at least 30 days, subject to the
-        # [data retention exceptions](/api/docs/guides/your-data#v1responses).
+        # [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
         store: nil,
         # Options for streaming responses. Only set this when you set `stream: true`.
         stream_options: nil,
@@ -255,8 +257,8 @@ module OpenAI
         # Configuration options for a text response from the model. Can be plain text or
         # structured JSON data. Learn more:
         #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+        # - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        # - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
         text: nil,
         # How the model should select which tool (or tools) to use when generating a
         # response. See the `tools` parameter to see how to specify which tools the model
@@ -269,17 +271,18 @@ module OpenAI
         #
         # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
         #   capabilities, like
-        #   [web search](https://platform.openai.com/docs/guides/tools-web-search) or
-        #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
+        #   [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
+        #   or
+        #   [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
         #   Learn more about
-        #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+        #   [built-in tools](https://developers.openai.com/api/docs/guides/tools).
         # - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
         #   predefined connectors such as Google Drive and SharePoint. Learn more about
-        #   [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp).
+        #   [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
         # - **Function calls (custom tools)**: Functions that are defined by you, enabling
         #   the model to call your own code with strongly typed arguments and outputs.
         #   Learn more about
-        #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+        #   [function calling](https://developers.openai.com/api/docs/guides/function-calling).
         #   You can also use custom tools to call your own code.
         tools: nil,
         # An integer between 0 and 20 specifying the maximum number of most likely tokens
@@ -304,7 +307,7 @@ module OpenAI
         # `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).
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         user: nil,
         # There is no need to provide `stream:`. Instead, use `#stream_raw` or `#create`
         # for streaming and non-streaming use cases, respectively.
@@ -316,16 +319,16 @@ module OpenAI
       # See {OpenAI::Resources::Responses#create} for non-streaming counterpart.
       #
       # Creates a model response. Provide
-      # [text](https://platform.openai.com/docs/guides/text) or
-      # [image](https://platform.openai.com/docs/guides/images) inputs to generate
-      # [text](https://platform.openai.com/docs/guides/text) or
-      # [JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have
-      # the model call your own
-      # [custom code](https://platform.openai.com/docs/guides/function-calling) or use
-      # built-in [tools](https://platform.openai.com/docs/guides/tools) like
-      # [web search](https://platform.openai.com/docs/guides/tools-web-search) or
-      # [file search](https://platform.openai.com/docs/guides/tools-file-search) to use
-      # your own data as input for the model's response.
+      # [text](https://developers.openai.com/api/docs/guides/text) or
+      # [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
+      # generate [text](https://developers.openai.com/api/docs/guides/text) or
+      # [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
+      # outputs. Have the model call your own
+      # [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
+      # use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
+      # [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
+      # [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
+      # to use your own data as input for the model's response.
       sig do
         params(
           background: T.nilable(T::Boolean),
@@ -403,7 +406,7 @@ module OpenAI
       end
       def stream_raw(
         # Whether to run the model response in the background.
-        # [Learn more](https://platform.openai.com/docs/guides/background).
+        # [Learn more](https://developers.openai.com/api/docs/guides/background).
         background: nil,
         # Context management configuration for this request.
         context_management: nil,
@@ -435,11 +438,11 @@ module OpenAI
         #
         # Learn more:
         #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Image inputs](https://platform.openai.com/docs/guides/images)
-        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
-        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
-        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
+        # - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        # - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
+        # - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
+        # - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
+        # - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
         input: nil,
         # A system (or developer) message inserted into the model's context.
         #
@@ -449,7 +452,7 @@ module OpenAI
         instructions: nil,
         # An upper bound for the number of tokens that can be generated for a response,
         # including visible output tokens and
-        # [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
+        # [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
         max_output_tokens: nil,
         # The maximum number of total calls to built-in tools that can be processed in a
         # response. This maximum number applies across all built-in tool calls, not per
@@ -466,8 +469,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.
         model: nil,
         # Configuration for running moderation on the input and output of this response.
         moderation: nil,
@@ -475,15 +478,15 @@ module OpenAI
         parallel_tool_calls: nil,
         # 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`.
         previous_response_id: nil,
         # Reference to a prompt template and its variables.
-        # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        # [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
         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).
+        # [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
         prompt_cache_key: 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
@@ -492,7 +495,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.
         prompt_cache_options: nil,
         # Deprecated. Use `prompt_cache_options.ttl` instead.
@@ -500,7 +503,7 @@ module OpenAI
         # The retention policy for the prompt cache. Set to `24h` to enable extended
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
-        # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
         # This field expresses a maximum retention policy, while
         # `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
         # are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
@@ -514,14 +517,14 @@ module OpenAI
         #   `prompt_cache_retention` is not specified.
         prompt_cache_retention: nil,
         # Configuration options for
-        # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+        # [reasoning models](https://developers.openai.com/api/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, with a maximum length of 64 characters. 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).
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         safety_identifier: nil,
         # Specifies the processing type used for serving the request.
         #
@@ -530,13 +533,15 @@ module OpenAI
         #   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. The response will show `service_tier=priority`
-        #   regardless of if you specify `service_tier=fast` or `priority` in your
-        #   request.
+        # - 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. The response will show
+        #   `service_tier=priority` regardless of if you specify `service_tier=fast` or
+        #   `priority` in your request.
         # - If set to 'ultrafast', then the request will be processed with the
         #   access-controlled Ultrafast Processing service tier. This tier is currently
         #   available for `gpt-5.6-sol`; a response served through it will show
@@ -551,7 +556,7 @@ module OpenAI
         # Whether to store the generated model response for later retrieval via API.
         # Defaults to true when omitted. If set to true, response data will be stored for
         # at least 30 days, subject to the
-        # [data retention exceptions](/api/docs/guides/your-data#v1responses).
+        # [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
         store: nil,
         # Options for streaming responses. Only set this when you set `stream: true`.
         stream_options: nil,
@@ -563,8 +568,8 @@ module OpenAI
         # Configuration options for a text response from the model. Can be plain text or
         # structured JSON data. Learn more:
         #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+        # - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        # - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
         text: nil,
         # How the model should select which tool (or tools) to use when generating a
         # response. See the `tools` parameter to see how to specify which tools the model
@@ -577,17 +582,18 @@ module OpenAI
         #
         # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
         #   capabilities, like
-        #   [web search](https://platform.openai.com/docs/guides/tools-web-search) or
-        #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
+        #   [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
+        #   or
+        #   [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
         #   Learn more about
-        #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+        #   [built-in tools](https://developers.openai.com/api/docs/guides/tools).
         # - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
         #   predefined connectors such as Google Drive and SharePoint. Learn more about
-        #   [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp).
+        #   [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
         # - **Function calls (custom tools)**: Functions that are defined by you, enabling
         #   the model to call your own code with strongly typed arguments and outputs.
         #   Learn more about
-        #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+        #   [function calling](https://developers.openai.com/api/docs/guides/function-calling).
         #   You can also use custom tools to call your own code.
         tools: nil,
         # An integer between 0 and 20 specifying the maximum number of most likely tokens
@@ -612,7 +618,7 @@ module OpenAI
         # `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).
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         user: nil,
         # There is no need to provide `stream:`. Instead, use `#stream_raw` or `#create`
         # for streaming and non-streaming use cases, respectively.
@@ -656,6 +662,8 @@ module OpenAI
           previous_response_id: T.nilable(String),
           prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
           prompt_cache_key: String,
+          prompt_cache_options: T.nilable(OpenAI::Responses::ResponseCreateParams::PromptCacheOptions::OrHash),
+          prompt_cache_retention: T.nilable(OpenAI::Responses::ResponseCreateParams::PromptCacheRetention::OrSymbol),
           reasoning: T.nilable(OpenAI::Reasoning::OrHash),
           response_id: T.nilable(String),
           safety_identifier: String,
@@ -705,7 +713,7 @@ module OpenAI
       end
       def stream(
         # Whether to run the model response in the background.
-        # [Learn more](https://platform.openai.com/docs/guides/background).
+        # [Learn more](https://developers.openai.com/api/docs/guides/background).
         background: nil,
         # Specify additional output data to include in the model response. Currently
         # supported values are:
@@ -728,11 +736,11 @@ module OpenAI
         #
         # Learn more:
         #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Image inputs](https://platform.openai.com/docs/guides/images)
-        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
-        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
-        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
+        # - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        # - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
+        # - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
+        # - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
+        # - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
         input: nil,
         # A system (or developer) message inserted into the model's context.
         #
@@ -742,7 +750,7 @@ module OpenAI
         instructions: nil,
         # An upper bound for the number of tokens that can be generated for a response,
         # including visible output tokens and
-        # [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
+        # [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
         max_output_tokens: nil,
         # The maximum number of total calls to built-in tools that can be processed in a
         # response. This maximum number applies across all built-in tool calls, not per
@@ -756,37 +764,65 @@ module OpenAI
         # Keys are strings with a maximum length of 64 characters. Values are strings with
         # a maximum length of 512 characters.
         metadata: nil,
-        # Model ID used to generate the response, like `gpt-4o` or `o3`. 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 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.
         model: nil,
         # Whether to allow the model to run tool calls in parallel.
         parallel_tool_calls: nil,
         # 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`.
         previous_response_id: nil,
         # Reference to a prompt template and its variables.
-        # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        # [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
         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).
+        # [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
         prompt_cache_key: nil,
-        # **o-series models only**
+        # 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.
+        prompt_cache_options: nil,
+        # Deprecated. Use `prompt_cache_options.ttl` instead.
+        #
+        # The retention policy for the prompt cache. Set to `24h` to enable extended
+        # prompt caching, which keeps cached prefixes active for longer, up to a maximum
+        # of 24 hours.
+        # [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
+        # This field expresses a maximum retention policy, while
+        # `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
+        # are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
+        # models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
         #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
+        prompt_cache_retention: nil,
         # Configuration options for
-        # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+        # [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
         reasoning: nil,
         # The ID of the response whose stream to resume.
         response_id: 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).
+        # identifies each user, with a maximum length of 64 characters. We recommend
+        # hashing their username or email address, in order to avoid sending us any
+        # identifying information.
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         safety_identifier: nil,
         # Specifies the processing type used for serving the request.
         #
@@ -795,10 +831,19 @@ module OpenAI
         #   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)' or
-        #   'priority', then the request will be processed with the corresponding service
-        #   tier. [Contact sales](https://openai.com/contact-sales) to learn more about
-        #   Priority processing.
+        # - 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. The response will show
+        #   `service_tier=priority` regardless of if you specify `service_tier=fast` or
+        #   `priority` in your request.
+        # - If set to 'ultrafast', then the request will be processed with the
+        #   access-controlled Ultrafast Processing service tier. This tier is currently
+        #   available for `gpt-5.6-sol`; a response served through it will show
+        #   `service_tier=ultrafast`.
         # - When not set, the default behavior is 'auto'.
         #
         # When the `service_tier` parameter is set, the response body will include the
@@ -819,9 +864,8 @@ module OpenAI
         # Configuration options for a text response from the model. Can be plain text,
         # structured JSON data, or text that conforms to a custom grammar. Learn more:
         #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
-        # - [Custom grammars](https://platform.openai.com/docs/guides/custom-grammars)
+        # - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        # - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
         text: nil,
         # How the model should select which tool (or tools) to use when generating a
         # response. See the `tools` parameter to see how to specify which tools the model
@@ -834,20 +878,19 @@ module OpenAI
         #
         # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
         #   capabilities, like
-        #   [web search](https://platform.openai.com/docs/guides/tools-web-search) or
-        #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
+        #   [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
+        #   or
+        #   [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
         #   Learn more about
-        #   [built-in tools](https://platform.openai.com/docs/guides/tools).
-        # - **Custom tools**: Free form tools which the model can call with flexible
-        #   inputs and outputs. Learn more about
-        #   [custom tools](https://platform.openai.com/docs/guides/custom-tools).
+        #   [built-in tools](https://developers.openai.com/api/docs/guides/tools).
+        # - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
+        #   predefined connectors such as Google Drive and SharePoint. Learn more about
+        #   [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
         # - **Function calls (custom tools)**: Functions that are defined by you, enabling
         #   the model to call your own code with strongly typed arguments and outputs.
         #   Learn more about
-        #   [function calling](https://platform.openai.com/docs/guides/function-calling).
-        #   You can also use
-        #   [custom tools](https://platform.openai.com/docs/guides/custom-tools) to call
-        #   your own code.
+        #   [function calling](https://developers.openai.com/api/docs/guides/function-calling).
+        #   You can also use custom tools to call your own code.
         tools: nil,
         # An integer between 0 and 20 specifying the number of most likely tokens to
         # return at each token position, each with an associated log probability.
@@ -870,7 +913,7 @@ module OpenAI
         # `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).
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         user: nil,
         request_options: {}
       )
@@ -983,7 +1026,7 @@ module OpenAI
 
       # Cancels a model response with the given ID. Only responses created with the
       # `background` parameter set to `true` can be cancelled.
-      # [Learn more](https://platform.openai.com/docs/guides/background).
+      # [Learn more](https://developers.openai.com/api/docs/guides/background).
       sig do
         params(
           response_id: String,
@@ -1001,9 +1044,9 @@ module OpenAI
       # Compact a conversation. Returns a compacted response object.
       #
       # Learn when and how to compact long-running conversations in the
-      # [conversation state guide](https://platform.openai.com/docs/guides/conversation-state#managing-the-context-window).
+      # [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
       # For ZDR-compatible compaction details, see
-      # [Compaction (advanced)](https://platform.openai.com/docs/guides/conversation-state#compaction-advanced).
+      # [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
       sig do
         params(
           model: T.nilable(T.any(OpenAI::Responses::ResponseCompactParams::Model::OrSymbol, String)),
@@ -1022,8 +1065,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.
         model:,
         # Text, image, or file inputs to the model, used to generate a response
         input: nil,
@@ -1034,7 +1077,7 @@ module OpenAI
         instructions: nil,
         # 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`.
         previous_response_id: nil,
         # A key to use when reading from or writing to the prompt cache.
@@ -1046,7 +1089,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.
         prompt_cache_options: nil,
         # How long to retain a prompt cache entry created by this request.
@@ -1056,17 +1099,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.
         service_tier: nil,
         request_options: {}
       )