openai 0.15.0 → 0.17.0

data/rbi/openai/resources/responses.rbi

@@ -40,12 +40,18 @@ module OpenAI
           parallel_tool_calls: T.nilable(T::Boolean),
           previous_response_id: T.nilable(String),
           prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+          prompt_cache_key: String,
           reasoning: T.nilable(OpenAI::Reasoning::OrHash),
+          safety_identifier: String,
           service_tier:
             T.nilable(
               OpenAI::Responses::ResponseCreateParams::ServiceTier::OrSymbol
             ),
           store: T.nilable(T::Boolean),
+          stream_options:
+            T.nilable(
+              OpenAI::Responses::ResponseCreateParams::StreamOptions::OrHash
+            ),
           temperature: T.nilable(Float),
           text:
             T.any(
@@ -55,9 +61,11 @@ module OpenAI
           tool_choice:
             T.any(
               OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+              OpenAI::Responses::ToolChoiceAllowed::OrHash,
               OpenAI::Responses::ToolChoiceTypes::OrHash,
               OpenAI::Responses::ToolChoiceFunction::OrHash,
-              OpenAI::Responses::ToolChoiceMcp::OrHash
+              OpenAI::Responses::ToolChoiceMcp::OrHash,
+              OpenAI::Responses::ToolChoiceCustom::OrHash
             ),
           tools:
             T::Array[
@@ -69,6 +77,7 @@ module OpenAI
                 OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                 OpenAI::Responses::Tool::ImageGeneration::OrHash,
                 OpenAI::Responses::Tool::LocalShell::OrHash,
+                OpenAI::Responses::CustomTool::OrHash,
                 OpenAI::Responses::WebSearchTool::OrHash
               )
             ],
@@ -151,11 +160,21 @@ module OpenAI
         # Reference to a prompt template and its variables.
         # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
         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).
+        prompt_cache_key: nil,
         # **o-series models only**
         #
         # Configuration options for
         # [reasoning models](https://platform.openai.com/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. 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,
         # Specifies the processing type used for serving the request.
         #
         # - If set to 'auto', then the request will be processed with the service tier
@@ -176,6 +195,8 @@ module OpenAI
         service_tier: nil,
         # Whether to store the generated model response for later retrieval via API.
         store: nil,
+        # Options for streaming responses. Only set this when you set `stream: true`.
+        stream_options: nil,
         # 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
@@ -203,8 +224,10 @@ module OpenAI
         #   Learn more about
         #   [built-in tools](https://platform.openai.com/docs/guides/tools).
         # - **Function calls (custom tools)**: Functions that are defined by you, enabling
-        #   the model to call your own code. Learn more about
+        #   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,
         # 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.
@@ -223,9 +246,11 @@ module OpenAI
         # - `disabled` (default): If a model response will exceed the context window size
         #   for a model, the request will fail with a 400 error.
         truncation: nil,
-        # A stable identifier for your end-users. Used to boost cache hit rates by better
-        # bucketing similar requests and to help OpenAI detect and prevent abuse.
-        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+        # 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,
         # There is no need to provide `stream:`. Instead, use `#stream_raw` or `#create`
         # for streaming and non-streaming use cases, respectively.
@@ -268,12 +293,18 @@ module OpenAI
           parallel_tool_calls: T.nilable(T::Boolean),
           previous_response_id: T.nilable(String),
           prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+          prompt_cache_key: String,
           reasoning: T.nilable(OpenAI::Reasoning::OrHash),
+          safety_identifier: String,
           service_tier:
             T.nilable(
               OpenAI::Responses::ResponseCreateParams::ServiceTier::OrSymbol
             ),
           store: T.nilable(T::Boolean),
+          stream_options:
+            T.nilable(
+              OpenAI::Responses::ResponseCreateParams::StreamOptions::OrHash
+            ),
           temperature: T.nilable(Float),
           text:
             T.nilable(
@@ -285,9 +316,11 @@ module OpenAI
           tool_choice:
             T.any(
               OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+              OpenAI::Responses::ToolChoiceAllowed::OrHash,
               OpenAI::Responses::ToolChoiceTypes::OrHash,
               OpenAI::Responses::ToolChoiceFunction::OrHash,
-              OpenAI::Responses::ToolChoiceMcp::OrHash
+              OpenAI::Responses::ToolChoiceMcp::OrHash,
+              OpenAI::Responses::ToolChoiceCustom::OrHash
             ),
           tools:
             T::Array[
@@ -299,6 +332,7 @@ module OpenAI
                 OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                 OpenAI::Responses::Tool::ImageGeneration::OrHash,
                 OpenAI::Responses::Tool::LocalShell::OrHash,
+                OpenAI::Responses::CustomTool::OrHash,
                 OpenAI::Responses::WebSearchTool::OrHash
               )
             ],
@@ -385,11 +419,21 @@ module OpenAI
         # Reference to a prompt template and its variables.
         # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
         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).
+        prompt_cache_key: nil,
         # **o-series models only**
         #
         # Configuration options for
         # [reasoning models](https://platform.openai.com/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. 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,
         # Specifies the processing type used for serving the request.
         #
         # - If set to 'auto', then the request will be processed with the service tier
@@ -410,6 +454,8 @@ module OpenAI
         service_tier: nil,
         # Whether to store the generated model response for later retrieval via API.
         store: nil,
+        # Options for streaming responses. Only set this when you set `stream: true`.
+        stream_options: nil,
         # 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
@@ -437,8 +483,10 @@ module OpenAI
         #   Learn more about
         #   [built-in tools](https://platform.openai.com/docs/guides/tools).
         # - **Function calls (custom tools)**: Functions that are defined by you, enabling
-        #   the model to call your own code. Learn more about
+        #   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,
         # 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.
@@ -457,9 +505,11 @@ module OpenAI
         # - `disabled` (default): If a model response will exceed the context window size
         #   for a model, the request will fail with a 400 error.
         truncation: nil,
-        # A stable identifier for your end-users. Used to boost cache hit rates by better
-        # bucketing similar requests and to help OpenAI detect and prevent abuse.
-        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+        # 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,
         # There is no need to provide `stream:`. Instead, use `#stream_raw` or `#create`
         # for streaming and non-streaming use cases, respectively.
@@ -470,12 +520,30 @@ module OpenAI
 
       # See {OpenAI::Resources::Responses#create} for non-streaming counterpart.
       #
-      # Creates a model response with a higher-level streaming interface that provides
-      # helper methods for processing events and aggregating stream outputs.
+      # 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),
+          include:
+            T.nilable(
+              T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
+            ),
           input:
             T.nilable(OpenAI::Responses::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.nilable(
               T.any(
@@ -484,18 +552,12 @@ module OpenAI
                 OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
               )
             ),
-          background: T.nilable(T::Boolean),
-          include:
-            T.nilable(
-              T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
-            ),
-          instructions: T.nilable(String),
-          max_output_tokens: T.nilable(Integer),
-          metadata: T.nilable(T::Hash[Symbol, String]),
           parallel_tool_calls: T.nilable(T::Boolean),
           previous_response_id: T.nilable(String),
           prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+          prompt_cache_key: String,
           reasoning: T.nilable(OpenAI::Reasoning::OrHash),
+          safety_identifier: String,
           service_tier:
             T.nilable(
               OpenAI::Responses::ResponseCreateParams::ServiceTier::OrSymbol
@@ -503,20 +565,25 @@ module OpenAI
           store: T.nilable(T::Boolean),
           temperature: T.nilable(Float),
           text:
-            T.any(
-              OpenAI::Responses::ResponseTextConfig::OrHash,
-              OpenAI::StructuredOutput::JsonSchemaConverter
+            T.nilable(
+              T.any(
+                OpenAI::Responses::ResponseTextConfig::OrHash,
+                OpenAI::StructuredOutput::JsonSchemaConverter
+              )
             ),
           tool_choice:
             T.any(
               OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+              OpenAI::Responses::ToolChoiceAllowed::OrHash,
               OpenAI::Responses::ToolChoiceTypes::OrHash,
-              OpenAI::Responses::ToolChoiceFunction::OrHash
+              OpenAI::Responses::ToolChoiceFunction::OrHash,
+              OpenAI::Responses::ToolChoiceMcp::OrHash
             ),
           tools:
             T.nilable(
               T::Array[
                 T.any(
+                  OpenAI::StructuredOutput::JsonSchemaConverter,
                   OpenAI::Responses::FunctionTool::OrHash,
                   OpenAI::Responses::FileSearchTool::OrHash,
                   OpenAI::Responses::ComputerTool::OrHash,
@@ -524,65 +591,184 @@ module OpenAI
                   OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                   OpenAI::Responses::Tool::ImageGeneration::OrHash,
                   OpenAI::Responses::Tool::LocalShell::OrHash,
-                  OpenAI::Responses::WebSearchTool::OrHash,
-                  OpenAI::StructuredOutput::JsonSchemaConverter
+                  OpenAI::Responses::WebSearchTool::OrHash
                 )
               ]
             ),
+          top_logprobs: T.nilable(Integer),
           top_p: T.nilable(Float),
           truncation:
             T.nilable(
               OpenAI::Responses::ResponseCreateParams::Truncation::OrSymbol
             ),
-          user: T.nilable(String),
-          starting_after: T.nilable(Integer),
-          request_options: T.nilable(OpenAI::RequestOptions::OrHash)
+          user: String,
+          request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Streaming::ResponseStream)
       end
       def stream(
-        # Text, image, or file inputs to the model, used to generate a response.
-        input: nil,
-        # Model ID used to generate the response, like `gpt-4o` or `o3`.
-        model: nil,
         # Whether to run the model response in the background.
+        # [Learn more](https://platform.openai.com/docs/guides/background).
         background: nil,
-        # Specify additional output data to include in the model response.
+        # Specify additional output data to include in the model response. Currently
+        # supported values are:
+        #
+        # - `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,
+        # 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,
         # 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,
-        # An upper bound for the number of tokens that can be generated for a response.
+        # 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,
-        # Set of 16 key-value pairs that can be attached to an object.
+        # 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,
+        # 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,
+        # 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,
         # 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.
+        # multi-turn conversations. Learn more about
+        # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
         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).
         prompt: nil,
-        # Configuration options for reasoning models.
+        # 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,
+        # **o-series models only**
+        #
+        # Configuration options for
+        # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
         reasoning: nil,
-        # Specifies the latency tier to use for processing the request.
+        # 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).
+        safety_identifier: nil,
+        # Specifies the processing type used for serving the request.
+        #
+        # - If set to 'auto', then the request will be processed with the service tier
+        #   configured in the Project settings. Unless otherwise configured, the Project
+        #   will use 'default'.
+        # - If set to 'default', then the request will be processed with the standard
+        #   pricing and performance for the selected model.
+        # - If set to '[flex](https://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.
+        # - 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,
         # Whether to store the generated model response for later retrieval via API.
         store: nil,
-        # What sampling temperature to use, between 0 and 2.
+        # 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,
-        # Configuration options for a text response from the model.
+        # 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: nil,
-        # How the model should select which tool (or tools) to use when generating a response.
+        # 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,
-        # An array of tools the model may call while generating a response.
+        # 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.
+        #
+        # The two categories of tools you can provide the model are:
+        #
+        # - **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).
+        # - **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).
+        # - **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.
         tools: nil,
-        # An alternative to sampling with temperature, called nucleus sampling.
+        # 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.
+        top_logprobs: nil,
+        # 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,
         # The truncation strategy to use for the model response.
+        #
+        # - `auto`: If the context of this response and previous ones exceeds the model's
+        #   context window size, the model will truncate the response to fit the context
+        #   window by dropping input items in the middle of the conversation.
+        # - `disabled` (default): If a model response will exceed the context window size
+        #   for a model, the request will fail with a 400 error.
         truncation: nil,
-        # A stable identifier for your end-users.
+        # 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,
-        # The sequence number of the event after which to start streaming (for resuming streams).
-        starting_after: nil,
         request_options: {}
       )
       end
@@ -594,6 +780,7 @@ module OpenAI
         params(
           response_id: String,
           include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+          include_obfuscation: T::Boolean,
           starting_after: Integer,
           stream: T.noreturn,
           request_options: OpenAI::RequestOptions::OrHash
@@ -605,6 +792,13 @@ module OpenAI
         # Additional fields to include in the response. See the `include` parameter for
         # Response creation above for more information.
         include: nil,
+        # 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,
         # The sequence number of the event after which to start streaming.
         starting_after: nil,
         # There is no need to provide `stream:`. Instead, use `#retrieve_streaming` or
@@ -621,6 +815,7 @@ module OpenAI
         params(
           response_id: String,
           include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+          include_obfuscation: T::Boolean,
           starting_after: Integer,
           stream: T.noreturn,
           request_options: OpenAI::RequestOptions::OrHash
@@ -636,6 +831,13 @@ module OpenAI
         # Additional fields to include in the response. See the `include` parameter for
         # Response creation above for more information.
         include: nil,
+        # 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,
         # The sequence number of the event after which to start streaming.
         starting_after: nil,
         # There is no need to provide `stream:`. Instead, use `#retrieve_streaming` or

data/sig/openai/internal/transport/base_client.rbs

@@ -99,7 +99,7 @@ module OpenAI
           retry_count: Integer
         ) -> Float
 
-        private def send_request: (
+        def send_request: (
           OpenAI::Internal::Transport::BaseClient::request_input request,
           redirect_count: Integer,
           retry_count: Integer,

data/sig/openai/models/beta/assistant_update_params.rbs

@@ -83,6 +83,12 @@ module OpenAI
 
         type model =
           String
+          | :"gpt-5"
+          | :"gpt-5-mini"
+          | :"gpt-5-nano"
+          | :"gpt-5-2025-08-07"
+          | :"gpt-5-mini-2025-08-07"
+          | :"gpt-5-nano-2025-08-07"
           | :"gpt-4.1"
           | :"gpt-4.1-mini"
           | :"gpt-4.1-nano"
@@ -125,6 +131,12 @@ module OpenAI
 
           def self?.variants: -> ::Array[OpenAI::Models::Beta::AssistantUpdateParams::model]
 
+          GPT_5: :"gpt-5"
+          GPT_5_MINI: :"gpt-5-mini"
+          GPT_5_NANO: :"gpt-5-nano"
+          GPT_5_2025_08_07: :"gpt-5-2025-08-07"
+          GPT_5_MINI_2025_08_07: :"gpt-5-mini-2025-08-07"
+          GPT_5_NANO_2025_08_07: :"gpt-5-nano-2025-08-07"
           GPT_4_1: :"gpt-4.1"
           GPT_4_1_MINI: :"gpt-4.1-mini"
           GPT_4_1_NANO: :"gpt-4.1-nano"

data/sig/openai/models/chat/chat_completion_allowed_tool_choice.rbs

@@ -0,0 +1,29 @@
+module OpenAI
+  module Models
+    class ChatCompletionAllowedToolChoice = Chat::ChatCompletionAllowedToolChoice
+
+    module Chat
+      type chat_completion_allowed_tool_choice =
+        {
+          allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools,
+          type: :allowed_tools
+        }
+
+      class ChatCompletionAllowedToolChoice < OpenAI::Internal::Type::BaseModel
+        attr_accessor allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools
+
+        attr_accessor type: :allowed_tools
+
+        def initialize: (
+          allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools,
+          ?type: :allowed_tools
+        ) -> void
+
+        def to_hash: -> {
+          allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools,
+          type: :allowed_tools
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/chat/chat_completion_allowed_tools.rbs

@@ -0,0 +1,38 @@
+module OpenAI
+  module Models
+    module Chat
+      type chat_completion_allowed_tools =
+        {
+          mode: OpenAI::Models::Chat::ChatCompletionAllowedTools::mode,
+          tools: ::Array[::Hash[Symbol, top]]
+        }
+
+      class ChatCompletionAllowedTools < OpenAI::Internal::Type::BaseModel
+        attr_accessor mode: OpenAI::Models::Chat::ChatCompletionAllowedTools::mode
+
+        attr_accessor tools: ::Array[::Hash[Symbol, top]]
+
+        def initialize: (
+          mode: OpenAI::Models::Chat::ChatCompletionAllowedTools::mode,
+          tools: ::Array[::Hash[Symbol, top]]
+        ) -> void
+
+        def to_hash: -> {
+          mode: OpenAI::Models::Chat::ChatCompletionAllowedTools::mode,
+          tools: ::Array[::Hash[Symbol, top]]
+        }
+
+        type mode = :auto | :required
+
+        module Mode
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO: :auto
+          REQUIRED: :required
+
+          def self?.values: -> ::Array[OpenAI::Models::Chat::ChatCompletionAllowedTools::mode]
+        end
+      end
+    end
+  end
+end