openai 0.86.0 → 0.88.0

data/rbi/openai/models/responses/responses_client_event.rbi

@@ -29,7 +29,7 @@ module OpenAI
           attr_accessor :type
 
           # 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).
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :background
 
@@ -71,11 +71,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)
           sig { returns(T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Input::Variants)) }
           attr_reader :input
 
@@ -92,7 +92,7 @@ module OpenAI
 
           # 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).
           sig { returns(T.nilable(Integer)) }
           attr_accessor :max_output_tokens
 
@@ -115,8 +115,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.
           sig {
             returns(
               T.nilable(
@@ -150,13 +150,13 @@ module OpenAI
 
           # 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`.
           sig { returns(T.nilable(String)) }
           attr_accessor :previous_response_id
 
           # 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).
           sig { returns(T.nilable(OpenAI::Responses::ResponsePrompt)) }
           attr_reader :prompt
 
@@ -165,7 +165,7 @@ module OpenAI
 
           # 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).
           sig { returns(T.nilable(String)) }
           attr_accessor :prompt_cache_key
 
@@ -176,7 +176,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.
           sig { returns(T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions)) }
           attr_reader :prompt_cache_options
@@ -194,7 +194,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
@@ -212,7 +212,7 @@ module OpenAI
           attr_accessor :prompt_cache_retention
 
           # Configuration options for
-          # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+          # [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
           sig { returns(T.nilable(OpenAI::Reasoning)) }
           attr_reader :reasoning
 
@@ -224,7 +224,7 @@ module OpenAI
           # 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).
           sig { returns(T.nilable(String)) }
           attr_accessor :safety_identifier
 
@@ -235,13 +235,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
@@ -256,6 +258,9 @@ module OpenAI
           attr_accessor :service_tier
 
           # 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](https://developers.openai.com/api/docs/guides/your-data#v1responses).
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :store
 
@@ -263,7 +268,7 @@ module OpenAI
           # generated using
           # [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
           # See the
-          # [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)
+          # [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
           # for more information.
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :stream
@@ -301,8 +306,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)
           sig { returns(T.nilable(OpenAI::Responses::ResponseTextConfig)) }
           attr_reader :text
 
@@ -356,17 +361,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.
           sig {
             returns(
@@ -451,7 +457,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).
           sig { returns(T.nilable(String)) }
           attr_reader :user
 
@@ -574,7 +580,7 @@ module OpenAI
           def self.new(
 
             # 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.
@@ -610,11 +616,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.
@@ -626,7 +632,7 @@ module OpenAI
 
             # 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
@@ -646,8 +652,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.
@@ -658,17 +664,17 @@ module OpenAI
 
             # 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
@@ -678,7 +684,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,
 
@@ -687,7 +693,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
@@ -702,7 +708,7 @@ module OpenAI
             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
@@ -710,7 +716,7 @@ module OpenAI
             # 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.
@@ -720,13 +726,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
@@ -740,13 +748,16 @@ module OpenAI
             service_tier: nil,
 
             # 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](https://developers.openai.com/api/docs/guides/your-data#v1responses).
             store: nil,
 
             # If set to true, the model response data will be streamed to the client as it is
             # generated using
             # [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
             # See the
-            # [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)
+            # [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
             # for more information.
             stream: nil,
 
@@ -769,8 +780,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
@@ -785,17 +796,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,
 
@@ -824,7 +836,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,
 
             # The type of the client event. Always `response.create`.
@@ -985,11 +997,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)
           module Input
             extend OpenAI::Internal::Type::Union
 
@@ -1338,7 +1350,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.
             sig do
               params(
@@ -1456,7 +1468,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
@@ -1501,13 +1513,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