openai 0.68.0 → 0.69.0

data/rbi/openai/resources/beta/responses.rbi

@@ -0,0 +1,903 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Beta
+      class Responses
+        sig { returns(OpenAI::Resources::Beta::Responses::InputItems) }
+        attr_reader :input_items
+
+        sig { returns(OpenAI::Resources::Beta::Responses::InputTokens) }
+        attr_reader :input_tokens
+
+        # See {OpenAI::Resources::Beta::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.
+        sig do
+          params(
+            background: T.nilable(T::Boolean),
+            context_management:
+              T.nilable(
+                T::Array[
+                  OpenAI::Beta::ResponseCreateParams::ContextManagement::OrHash
+                ]
+              ),
+            conversation:
+              T.nilable(
+                T.any(
+                  String,
+                  OpenAI::Beta::BetaResponseConversationParam::OrHash
+                )
+              ),
+            include:
+              T.nilable(
+                T::Array[OpenAI::Beta::BetaResponseIncludable::OrSymbol]
+              ),
+            input: OpenAI::Beta::ResponseCreateParams::Input::Variants,
+            instructions: T.nilable(String),
+            max_output_tokens: T.nilable(Integer),
+            max_tool_calls: T.nilable(Integer),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            model:
+              T.any(
+                OpenAI::Beta::ResponseCreateParams::Model::OrSymbol,
+                String
+              ),
+            moderation:
+              T.nilable(OpenAI::Beta::ResponseCreateParams::Moderation::OrHash),
+            multi_agent:
+              T.nilable(OpenAI::Beta::ResponseCreateParams::MultiAgent::OrHash),
+            parallel_tool_calls: T.nilable(T::Boolean),
+            previous_response_id: T.nilable(String),
+            prompt: T.nilable(OpenAI::Beta::BetaResponsePrompt::OrHash),
+            prompt_cache_key: String,
+            prompt_cache_options:
+              OpenAI::Beta::ResponseCreateParams::PromptCacheOptions::OrHash,
+            prompt_cache_retention:
+              T.nilable(
+                OpenAI::Beta::ResponseCreateParams::PromptCacheRetention::OrSymbol
+              ),
+            reasoning:
+              T.nilable(OpenAI::Beta::ResponseCreateParams::Reasoning::OrHash),
+            safety_identifier: String,
+            service_tier:
+              T.nilable(
+                OpenAI::Beta::ResponseCreateParams::ServiceTier::OrSymbol
+              ),
+            store: T.nilable(T::Boolean),
+            stream_options:
+              T.nilable(
+                OpenAI::Beta::ResponseCreateParams::StreamOptions::OrHash
+              ),
+            temperature: T.nilable(Float),
+            text: OpenAI::Beta::BetaResponseTextConfig::OrHash,
+            tool_choice:
+              T.any(
+                OpenAI::Beta::BetaToolChoiceOptions::OrSymbol,
+                OpenAI::Beta::BetaToolChoiceAllowed::OrHash,
+                OpenAI::Beta::BetaToolChoiceTypes::OrHash,
+                OpenAI::Beta::BetaToolChoiceFunction::OrHash,
+                OpenAI::Beta::BetaToolChoiceMcp::OrHash,
+                OpenAI::Beta::BetaToolChoiceCustom::OrHash,
+                OpenAI::Beta::ResponseCreateParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam::OrHash,
+                OpenAI::Beta::BetaToolChoiceApplyPatch::OrHash,
+                OpenAI::Beta::BetaToolChoiceShell::OrHash
+              ),
+            tools:
+              T::Array[
+                T.any(
+                  OpenAI::Beta::BetaFunctionTool::OrHash,
+                  OpenAI::Beta::BetaFileSearchTool::OrHash,
+                  OpenAI::Beta::BetaComputerTool::OrHash,
+                  OpenAI::Beta::BetaComputerUsePreviewTool::OrHash,
+                  OpenAI::Beta::BetaTool::Mcp::OrHash,
+                  OpenAI::Beta::BetaTool::CodeInterpreter::OrHash,
+                  OpenAI::Beta::BetaTool::ProgrammaticToolCalling::OrHash,
+                  OpenAI::Beta::BetaTool::ImageGeneration::OrHash,
+                  OpenAI::Beta::BetaTool::LocalShell::OrHash,
+                  OpenAI::Beta::BetaFunctionShellTool::OrHash,
+                  OpenAI::Beta::BetaCustomTool::OrHash,
+                  OpenAI::Beta::BetaNamespaceTool::OrHash,
+                  OpenAI::Beta::BetaToolSearchTool::OrHash,
+                  OpenAI::Beta::BetaApplyPatchTool::OrHash,
+                  OpenAI::Beta::BetaWebSearchTool::OrHash,
+                  OpenAI::Beta::BetaWebSearchPreviewTool::OrHash
+                )
+              ],
+            top_logprobs: T.nilable(Integer),
+            top_p: T.nilable(Float),
+            truncation:
+              T.nilable(
+                OpenAI::Beta::ResponseCreateParams::Truncation::OrSymbol
+              ),
+            user: String,
+            betas: T::Array[OpenAI::Beta::ResponseCreateParams::Beta::OrSymbol],
+            stream: T.noreturn,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Beta::BetaResponse)
+        end
+        def create(
+          # Body param: Whether to run the model response in the background.
+          # [Learn more](https://platform.openai.com/docs/guides/background).
+          background: nil,
+          # Body param: Context management configuration for this request.
+          context_management: nil,
+          # Body param: The conversation that this response belongs to. Items from this
+          # conversation are prepended to `input_items` for this response request. Input
+          # items and output items from this response are automatically added to this
+          # conversation after this response completes.
+          conversation: nil,
+          # Body param: Specify additional output data to include in the model response.
+          # Currently supported values are:
+          #
+          # - `web_search_call.action.sources`: Include the sources of the web search tool
+          #   call.
+          # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+          #   in code interpreter tool call items.
+          # - `computer_call_output.output.image_url`: Include image urls from the computer
+          #   call output.
+          # - `file_search_call.results`: Include the search results of the file search tool
+          #   call.
+          # - `message.input_image.image_url`: Include image urls from the input message.
+          # - `message.output_text.logprobs`: Include logprobs with assistant messages.
+          # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+          #   tokens in reasoning item outputs. This enables reasoning items to be used in
+          #   multi-turn conversations when using the Responses API statelessly (like when
+          #   the `store` parameter is set to `false`, or when an organization is enrolled
+          #   in the zero data retention program).
+          include: nil,
+          # Body param: Text, image, or file inputs to the model, used to generate a
+          # response.
+          #
+          # 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)
+          input: nil,
+          # Body param: A system (or developer) message inserted into the model's context.
+          #
+          # When using 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.
+          instructions: nil,
+          # Body param: 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).
+          max_output_tokens: nil,
+          # Body param: 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 individual tool. Any further attempts to call a tool by the model
+          # will be ignored.
+          max_tool_calls: nil,
+          # Body param: Set of 16 key-value pairs that can be attached to an object. This
+          # can be useful for storing additional information about the object in a
+          # structured format, and querying for objects via API or the dashboard.
+          #
+          # Keys are strings with a maximum length of 64 characters. Values are strings with
+          # a maximum length of 512 characters.
+          metadata: nil,
+          # Body param: 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: nil,
+          # Body param: Configuration for running moderation on the input and output of this
+          # response.
+          moderation: nil,
+          # Body param: Configuration for server-hosted multi-agent execution.
+          multi_agent: nil,
+          # Body param: Whether to allow the model to run tool calls in parallel.
+          parallel_tool_calls: nil,
+          # Body param: 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).
+          # Cannot be used in conjunction with `conversation`.
+          previous_response_id: nil,
+          # Body param: Reference to a prompt template and its variables.
+          # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+          prompt: nil,
+          # Body param: Used by OpenAI to cache responses for similar requests to optimize
+          # your cache hit rates. Replaces the `user` field.
+          # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+          prompt_cache_key: nil,
+          # Body param: 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://platform.openai.com/docs/guides/prompt-caching)
+          # for current details.
+          prompt_cache_options: nil,
+          # Body param: 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://platform.openai.com/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,
+          # Body param: **gpt-5 and o-series models only**
+          #
+          # Configuration options for
+          # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+          reasoning: nil,
+          # Body param: 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).
+          safety_identifier: nil,
+          # Body param: 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://platform.openai.com/docs/guides/flex-processing)' or
+          #   '[priority](https://openai.com/api-priority-processing/)', then the request
+          #   will be processed with the corresponding service tier.
+          # - 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,
+          # Body param: Whether to store the generated model response for later retrieval
+          # via API.
+          store: nil,
+          # Body param: Options for streaming responses. Only set this when you set
+          # `stream: true`.
+          stream_options: nil,
+          # Body param: What sampling temperature to use, between 0 and 2. Higher values
+          # like 0.8 will make the output more random, while lower values like 0.2 will make
+          # it more focused and deterministic. We generally recommend altering this or
+          # `top_p` but not both.
+          temperature: nil,
+          # Body param: 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: nil,
+          # Body param: 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 can call.
+          tool_choice: nil,
+          # Body param: An array of tools the model may call while generating a response.
+          # You can specify which tool to use by setting the `tool_choice` parameter.
+          #
+          # We support the following categories of tools:
+          #
+          # - **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).
+          #   Learn more about
+          #   [built-in tools](https://platform.openai.com/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).
+          # - **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 to call your own code.
+          tools: nil,
+          # Body param: An integer between 0 and 20 specifying the maximum number of most
+          # likely tokens to return at each token position, each with an associated log
+          # probability. In some cases, the number of returned tokens may be fewer than
+          # requested.
+          top_logprobs: nil,
+          # Body param: An alternative to sampling with temperature, called nucleus
+          # sampling, where the model considers the results of the tokens with top_p
+          # probability mass. So 0.1 means only the tokens comprising the top 10%
+          # probability mass are considered.
+          #
+          # We generally recommend altering this or `temperature` but not both.
+          top_p: nil,
+          # Body param: The truncation strategy to use for the model response.
+          #
+          # - `auto`: If the input to this Response exceeds the model's context window size,
+          #   the model will truncate the response to fit the context window by dropping
+          #   items from the beginning of the conversation.
+          # - `disabled` (default): If the input size will exceed the context window size
+          #   for a model, the request will fail with a 400 error.
+          truncation: nil,
+          # Body param: This field is being replaced by `safety_identifier` and
+          # `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching
+          # optimizations. A stable identifier for your end-users. Used to boost cache hit
+          # rates by better bucketing similar requests and to help OpenAI detect and prevent
+          # abuse.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+          user: nil,
+          # Header param: Optional beta features to enable for this request.
+          betas: nil,
+          # There is no need to provide `stream:`. Instead, use `#stream_raw` or `#create`
+          # for streaming and non-streaming use cases, respectively.
+          stream: false,
+          request_options: {}
+        )
+        end
+
+        # See {OpenAI::Resources::Beta::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.
+        sig do
+          params(
+            background: T.nilable(T::Boolean),
+            context_management:
+              T.nilable(
+                T::Array[
+                  OpenAI::Beta::ResponseCreateParams::ContextManagement::OrHash
+                ]
+              ),
+            conversation:
+              T.nilable(
+                T.any(
+                  String,
+                  OpenAI::Beta::BetaResponseConversationParam::OrHash
+                )
+              ),
+            include:
+              T.nilable(
+                T::Array[OpenAI::Beta::BetaResponseIncludable::OrSymbol]
+              ),
+            input: OpenAI::Beta::ResponseCreateParams::Input::Variants,
+            instructions: T.nilable(String),
+            max_output_tokens: T.nilable(Integer),
+            max_tool_calls: T.nilable(Integer),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            model:
+              T.any(
+                OpenAI::Beta::ResponseCreateParams::Model::OrSymbol,
+                String
+              ),
+            moderation:
+              T.nilable(OpenAI::Beta::ResponseCreateParams::Moderation::OrHash),
+            multi_agent:
+              T.nilable(OpenAI::Beta::ResponseCreateParams::MultiAgent::OrHash),
+            parallel_tool_calls: T.nilable(T::Boolean),
+            previous_response_id: T.nilable(String),
+            prompt: T.nilable(OpenAI::Beta::BetaResponsePrompt::OrHash),
+            prompt_cache_key: String,
+            prompt_cache_options:
+              OpenAI::Beta::ResponseCreateParams::PromptCacheOptions::OrHash,
+            prompt_cache_retention:
+              T.nilable(
+                OpenAI::Beta::ResponseCreateParams::PromptCacheRetention::OrSymbol
+              ),
+            reasoning:
+              T.nilable(OpenAI::Beta::ResponseCreateParams::Reasoning::OrHash),
+            safety_identifier: String,
+            service_tier:
+              T.nilable(
+                OpenAI::Beta::ResponseCreateParams::ServiceTier::OrSymbol
+              ),
+            store: T.nilable(T::Boolean),
+            stream_options:
+              T.nilable(
+                OpenAI::Beta::ResponseCreateParams::StreamOptions::OrHash
+              ),
+            temperature: T.nilable(Float),
+            text: OpenAI::Beta::BetaResponseTextConfig::OrHash,
+            tool_choice:
+              T.any(
+                OpenAI::Beta::BetaToolChoiceOptions::OrSymbol,
+                OpenAI::Beta::BetaToolChoiceAllowed::OrHash,
+                OpenAI::Beta::BetaToolChoiceTypes::OrHash,
+                OpenAI::Beta::BetaToolChoiceFunction::OrHash,
+                OpenAI::Beta::BetaToolChoiceMcp::OrHash,
+                OpenAI::Beta::BetaToolChoiceCustom::OrHash,
+                OpenAI::Beta::ResponseCreateParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam::OrHash,
+                OpenAI::Beta::BetaToolChoiceApplyPatch::OrHash,
+                OpenAI::Beta::BetaToolChoiceShell::OrHash
+              ),
+            tools:
+              T::Array[
+                T.any(
+                  OpenAI::Beta::BetaFunctionTool::OrHash,
+                  OpenAI::Beta::BetaFileSearchTool::OrHash,
+                  OpenAI::Beta::BetaComputerTool::OrHash,
+                  OpenAI::Beta::BetaComputerUsePreviewTool::OrHash,
+                  OpenAI::Beta::BetaTool::Mcp::OrHash,
+                  OpenAI::Beta::BetaTool::CodeInterpreter::OrHash,
+                  OpenAI::Beta::BetaTool::ProgrammaticToolCalling::OrHash,
+                  OpenAI::Beta::BetaTool::ImageGeneration::OrHash,
+                  OpenAI::Beta::BetaTool::LocalShell::OrHash,
+                  OpenAI::Beta::BetaFunctionShellTool::OrHash,
+                  OpenAI::Beta::BetaCustomTool::OrHash,
+                  OpenAI::Beta::BetaNamespaceTool::OrHash,
+                  OpenAI::Beta::BetaToolSearchTool::OrHash,
+                  OpenAI::Beta::BetaApplyPatchTool::OrHash,
+                  OpenAI::Beta::BetaWebSearchTool::OrHash,
+                  OpenAI::Beta::BetaWebSearchPreviewTool::OrHash
+                )
+              ],
+            top_logprobs: T.nilable(Integer),
+            top_p: T.nilable(Float),
+            truncation:
+              T.nilable(
+                OpenAI::Beta::ResponseCreateParams::Truncation::OrSymbol
+              ),
+            user: String,
+            betas: T::Array[OpenAI::Beta::ResponseCreateParams::Beta::OrSymbol],
+            stream: T.noreturn,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(
+            OpenAI::Internal::Stream[
+              OpenAI::Beta::BetaResponseStreamEvent::Variants
+            ]
+          )
+        end
+        def stream_raw(
+          # Body param: Whether to run the model response in the background.
+          # [Learn more](https://platform.openai.com/docs/guides/background).
+          background: nil,
+          # Body param: Context management configuration for this request.
+          context_management: nil,
+          # Body param: The conversation that this response belongs to. Items from this
+          # conversation are prepended to `input_items` for this response request. Input
+          # items and output items from this response are automatically added to this
+          # conversation after this response completes.
+          conversation: nil,
+          # Body param: Specify additional output data to include in the model response.
+          # Currently supported values are:
+          #
+          # - `web_search_call.action.sources`: Include the sources of the web search tool
+          #   call.
+          # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+          #   in code interpreter tool call items.
+          # - `computer_call_output.output.image_url`: Include image urls from the computer
+          #   call output.
+          # - `file_search_call.results`: Include the search results of the file search tool
+          #   call.
+          # - `message.input_image.image_url`: Include image urls from the input message.
+          # - `message.output_text.logprobs`: Include logprobs with assistant messages.
+          # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+          #   tokens in reasoning item outputs. This enables reasoning items to be used in
+          #   multi-turn conversations when using the Responses API statelessly (like when
+          #   the `store` parameter is set to `false`, or when an organization is enrolled
+          #   in the zero data retention program).
+          include: nil,
+          # Body param: Text, image, or file inputs to the model, used to generate a
+          # response.
+          #
+          # 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)
+          input: nil,
+          # Body param: A system (or developer) message inserted into the model's context.
+          #
+          # When using 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.
+          instructions: nil,
+          # Body param: 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).
+          max_output_tokens: nil,
+          # Body param: 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 individual tool. Any further attempts to call a tool by the model
+          # will be ignored.
+          max_tool_calls: nil,
+          # Body param: Set of 16 key-value pairs that can be attached to an object. This
+          # can be useful for storing additional information about the object in a
+          # structured format, and querying for objects via API or the dashboard.
+          #
+          # Keys are strings with a maximum length of 64 characters. Values are strings with
+          # a maximum length of 512 characters.
+          metadata: nil,
+          # Body param: 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: nil,
+          # Body param: Configuration for running moderation on the input and output of this
+          # response.
+          moderation: nil,
+          # Body param: Configuration for server-hosted multi-agent execution.
+          multi_agent: nil,
+          # Body param: Whether to allow the model to run tool calls in parallel.
+          parallel_tool_calls: nil,
+          # Body param: 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).
+          # Cannot be used in conjunction with `conversation`.
+          previous_response_id: nil,
+          # Body param: Reference to a prompt template and its variables.
+          # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+          prompt: nil,
+          # Body param: Used by OpenAI to cache responses for similar requests to optimize
+          # your cache hit rates. Replaces the `user` field.
+          # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+          prompt_cache_key: nil,
+          # Body param: 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://platform.openai.com/docs/guides/prompt-caching)
+          # for current details.
+          prompt_cache_options: nil,
+          # Body param: 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://platform.openai.com/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,
+          # Body param: **gpt-5 and o-series models only**
+          #
+          # Configuration options for
+          # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+          reasoning: nil,
+          # Body param: 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).
+          safety_identifier: nil,
+          # Body param: 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://platform.openai.com/docs/guides/flex-processing)' or
+          #   '[priority](https://openai.com/api-priority-processing/)', then the request
+          #   will be processed with the corresponding service tier.
+          # - 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,
+          # Body param: Whether to store the generated model response for later retrieval
+          # via API.
+          store: nil,
+          # Body param: Options for streaming responses. Only set this when you set
+          # `stream: true`.
+          stream_options: nil,
+          # Body param: What sampling temperature to use, between 0 and 2. Higher values
+          # like 0.8 will make the output more random, while lower values like 0.2 will make
+          # it more focused and deterministic. We generally recommend altering this or
+          # `top_p` but not both.
+          temperature: nil,
+          # Body param: 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: nil,
+          # Body param: 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 can call.
+          tool_choice: nil,
+          # Body param: An array of tools the model may call while generating a response.
+          # You can specify which tool to use by setting the `tool_choice` parameter.
+          #
+          # We support the following categories of tools:
+          #
+          # - **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).
+          #   Learn more about
+          #   [built-in tools](https://platform.openai.com/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).
+          # - **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 to call your own code.
+          tools: nil,
+          # Body param: An integer between 0 and 20 specifying the maximum number of most
+          # likely tokens to return at each token position, each with an associated log
+          # probability. In some cases, the number of returned tokens may be fewer than
+          # requested.
+          top_logprobs: nil,
+          # Body param: An alternative to sampling with temperature, called nucleus
+          # sampling, where the model considers the results of the tokens with top_p
+          # probability mass. So 0.1 means only the tokens comprising the top 10%
+          # probability mass are considered.
+          #
+          # We generally recommend altering this or `temperature` but not both.
+          top_p: nil,
+          # Body param: The truncation strategy to use for the model response.
+          #
+          # - `auto`: If the input to this Response exceeds the model's context window size,
+          #   the model will truncate the response to fit the context window by dropping
+          #   items from the beginning of the conversation.
+          # - `disabled` (default): If the input size will exceed the context window size
+          #   for a model, the request will fail with a 400 error.
+          truncation: nil,
+          # Body param: This field is being replaced by `safety_identifier` and
+          # `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching
+          # optimizations. A stable identifier for your end-users. Used to boost cache hit
+          # rates by better bucketing similar requests and to help OpenAI detect and prevent
+          # abuse.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+          user: nil,
+          # Header param: Optional beta features to enable for this request.
+          betas: nil,
+          # There is no need to provide `stream:`. Instead, use `#stream_raw` or `#create`
+          # for streaming and non-streaming use cases, respectively.
+          stream: true,
+          request_options: {}
+        )
+        end
+
+        # See {OpenAI::Resources::Beta::Responses#retrieve_streaming} for streaming
+        # counterpart.
+        #
+        # Retrieves a model response with the given ID.
+        sig do
+          params(
+            response_id: String,
+            include: T::Array[OpenAI::Beta::BetaResponseIncludable::OrSymbol],
+            include_obfuscation: T::Boolean,
+            starting_after: Integer,
+            betas:
+              T::Array[OpenAI::Beta::ResponseRetrieveParams::Beta::OrSymbol],
+            stream: T.noreturn,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Beta::BetaResponse)
+        end
+        def retrieve(
+          # Path param: The ID of the response to retrieve.
+          response_id,
+          # Query param: Additional fields to include in the response. See the `include`
+          # parameter for Response creation above for more information.
+          include: nil,
+          # Query param: When true, stream obfuscation will be enabled. Stream obfuscation
+          # adds random characters to an `obfuscation` field on streaming delta events to
+          # normalize payload sizes as a mitigation to certain side-channel attacks. These
+          # obfuscation fields are included by default, but add a small amount of overhead
+          # to the data stream. You can set `include_obfuscation` to false to optimize for
+          # bandwidth if you trust the network links between your application and the OpenAI
+          # API.
+          include_obfuscation: nil,
+          # Query param: The sequence number of the event after which to start streaming.
+          starting_after: nil,
+          # Header param: Optional beta features to enable for this request.
+          betas: nil,
+          # There is no need to provide `stream:`. Instead, use `#retrieve_streaming` or
+          # `#retrieve` for streaming and non-streaming use cases, respectively.
+          stream: false,
+          request_options: {}
+        )
+        end
+
+        # See {OpenAI::Resources::Beta::Responses#retrieve} for non-streaming counterpart.
+        #
+        # Retrieves a model response with the given ID.
+        sig do
+          params(
+            response_id: String,
+            include: T::Array[OpenAI::Beta::BetaResponseIncludable::OrSymbol],
+            include_obfuscation: T::Boolean,
+            starting_after: Integer,
+            betas:
+              T::Array[OpenAI::Beta::ResponseRetrieveParams::Beta::OrSymbol],
+            stream: T.noreturn,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(
+            OpenAI::Internal::Stream[
+              OpenAI::Beta::BetaResponseStreamEvent::Variants
+            ]
+          )
+        end
+        def retrieve_streaming(
+          # Path param: The ID of the response to retrieve.
+          response_id,
+          # Query param: Additional fields to include in the response. See the `include`
+          # parameter for Response creation above for more information.
+          include: nil,
+          # Query param: When true, stream obfuscation will be enabled. Stream obfuscation
+          # adds random characters to an `obfuscation` field on streaming delta events to
+          # normalize payload sizes as a mitigation to certain side-channel attacks. These
+          # obfuscation fields are included by default, but add a small amount of overhead
+          # to the data stream. You can set `include_obfuscation` to false to optimize for
+          # bandwidth if you trust the network links between your application and the OpenAI
+          # API.
+          include_obfuscation: nil,
+          # Query param: The sequence number of the event after which to start streaming.
+          starting_after: nil,
+          # Header param: Optional beta features to enable for this request.
+          betas: nil,
+          # There is no need to provide `stream:`. Instead, use `#retrieve_streaming` or
+          # `#retrieve` for streaming and non-streaming use cases, respectively.
+          stream: true,
+          request_options: {}
+        )
+        end
+
+        # Deletes a model response with the given ID.
+        sig do
+          params(
+            response_id: String,
+            betas: T::Array[OpenAI::Beta::ResponseDeleteParams::Beta::OrSymbol],
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # The ID of the response to delete.
+          response_id,
+          # Optional beta features to enable for this request.
+          betas: nil,
+          request_options: {}
+        )
+        end
+
+        # 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).
+        sig do
+          params(
+            response_id: String,
+            betas: T::Array[OpenAI::Beta::ResponseCancelParams::Beta::OrSymbol],
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Beta::BetaResponse)
+        end
+        def cancel(
+          # The ID of the response to cancel.
+          response_id,
+          # Optional beta features to enable for this request.
+          betas: nil,
+          request_options: {}
+        )
+        end
+
+        # 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).
+        # For ZDR-compatible compaction details, see
+        # [Compaction (advanced)](https://platform.openai.com/docs/guides/conversation-state#compaction-advanced).
+        sig do
+          params(
+            model:
+              T.nilable(
+                T.any(
+                  OpenAI::Beta::ResponseCompactParams::Model::OrSymbol,
+                  String
+                )
+              ),
+            input:
+              T.nilable(OpenAI::Beta::ResponseCompactParams::Input::Variants),
+            instructions: T.nilable(String),
+            previous_response_id: T.nilable(String),
+            prompt_cache_key: T.nilable(String),
+            prompt_cache_options:
+              T.nilable(
+                OpenAI::Beta::ResponseCompactParams::PromptCacheOptions::OrHash
+              ),
+            prompt_cache_retention:
+              T.nilable(
+                OpenAI::Beta::ResponseCompactParams::PromptCacheRetention::OrSymbol
+              ),
+            service_tier:
+              T.nilable(
+                OpenAI::Beta::ResponseCompactParams::ServiceTier::OrSymbol
+              ),
+            betas:
+              T::Array[OpenAI::Beta::ResponseCompactParams::Beta::OrSymbol],
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Beta::BetaCompactedResponse)
+        end
+        def compact(
+          # Body param: Model ID used to generate the response, like `gpt-5` 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:,
+          # Body param: Text, image, or file inputs to the model, used to generate a
+          # response
+          input: nil,
+          # Body param: 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.
+          instructions: nil,
+          # Body param: 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).
+          # Cannot be used in conjunction with `conversation`.
+          previous_response_id: nil,
+          # Body param: A key to use when reading from or writing to the prompt cache.
+          prompt_cache_key: nil,
+          # Body param: 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://platform.openai.com/docs/guides/prompt-caching)
+          # for current details.
+          prompt_cache_options: nil,
+          # Body param: How long to retain a prompt cache entry created by this request.
+          prompt_cache_retention: nil,
+          # Body param: The service tier to use for this request.
+          service_tier: nil,
+          # Header param: Optional beta features to enable for this request.
+          betas: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end