openai 0.79.0 → 0.80.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c91ec0ec5334f72006f30c1c9287f4175038c146c2ae5361447e99159dd4940e
-  data.tar.gz: 9f34b2932f7aa72d19b1e313f1fc37941fd85aa00232a395362a738619e6d8c2
+  metadata.gz: 04e35fa6de9362524ec8eb2967901334c36bc49af09ac5e3b1a5ca2b7cac0a79
+  data.tar.gz: bc0d81dc930ca951a59c5470444728d9152abad4bc7ed86e22738819718d8115
 SHA512:
-  metadata.gz: e90ca693f7e19f02b668b5e35facaead8a83da5dd7cd9b14a527e613572241f3e5086b5e8d7f29bff089e1a6ce02ac5657c4181feb02c4374f8368b68d7325d6
-  data.tar.gz: 2ac6392091a4b4a46b07272a29e16fac51a7dca2f36d6bdf2be356d34e3424d2e49c0a922d72a9edf4badafaf6b2b04682d37e4e66f4e5dc197958a4f7191c58
+  metadata.gz: 72ee61370ccfd94c541c06726fc17fcf3a1626234a6fd10259f1a2a1fda4b56ccaf6bc02c3dfea7f5142cd568abf073c6382fd6878c0a6185c1f27e71eaee5df
+  data.tar.gz: 9258b2d20da4c2a5bd4c509bd5f55505921a96fc1db97a421f2679f5ae2316fd33729d3f6fcf1130f0964aec1e5a8334c07db38afd2a8443ce7cd2037e45b065

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [0.80.0](https://github.com/openai/openai-ruby/compare/v0.79.0...v0.80.0) (2026-08-17)
+
+
+### Features
+
+* add Amazon Bedrock Runtime support ([#424](https://github.com/openai/openai-ruby/issues/424)) ([cf48c01](https://github.com/openai/openai-ruby/commit/cf48c0157183797b5c4c66635ad4bfcb14fe2b3a))
+* **api:** Ultrafast tier, structured MCP and websocket errors, separate websocket events ([#414](https://github.com/openai/openai-ruby/issues/414)) ([c1f3525](https://github.com/openai/openai-ruby/commit/c1f35252bc042445ba419e413b744a2f55c514ce))
+
+
+### Bug Fixes
+
+* validate RuboCop directives without a Git checkout ([#425](https://github.com/openai/openai-ruby/issues/425)) ([a3cae51](https://github.com/openai/openai-ruby/commit/a3cae518dc18d1cc222558ed86332cc97f1316cc))
+
+
+### Chores
+
+* enforce heredoc method call position ([#431](https://github.com/openai/openai-ruby/issues/431)) ([70cebe3](https://github.com/openai/openai-ruby/commit/70cebe3c460a659c5d181b66f92d620d2f6654f5))
+* remove SDK namespace line-length exemption ([#419](https://github.com/openai/openai-ruby/issues/419)) ([a089ee1](https://github.com/openai/openai-ruby/commit/a089ee1788b9399fa0570896dc422ae375b6baf3))
+
 ## [0.79.0](https://github.com/openai/openai-ruby/compare/v0.78.0...v0.79.0) (2026-08-14)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.79.0"
+gem "openai", "~> 0.80.0"
 ```
 
 <!-- x-release-please-end -->

data/bedrock.md

@@ -19,15 +19,69 @@ puts(response.output_text)
 
 The provider uses `https://bedrock-mantle.<region>.api.aws/v1` by default and exposes the normal SDK resources. AWS controls which endpoints and features are supported; unsupported calls surface as normal API errors.
 
+## Bedrock Runtime
+
+Pass `endpoint: :runtime` to use the Bedrock Runtime OpenAI-compatible endpoint. The provider routes requests to `https://bedrock-runtime.<region>.amazonaws.com/openai/v1` and uses the AWS SigV4 signing service `bedrock` when AWS credentials are selected:
+
+```ruby
+require "openai"
+
+client = OpenAI::Client.new(
+  provider: OpenAI::Providers.bedrock(
+    endpoint: :runtime,
+    region: "us-east-1"
+  )
+)
+
+completion = client.chat.completions.create(
+  model: "us.openai.gpt-5.6-sol",
+  messages: [{role: :user, content: "Say hello!"}]
+)
+
+puts(completion.choices.first.message.content)
+```
+
+Use the inference profile configured for your AWS account, for example `us.openai.gpt-5.6-sol`, `us.openai.gpt-5.6-terra`, or `us.openai.gpt-5.6-luna`. Global inference profiles, such as `global.openai.gpt-5.6-sol`, require the appropriate AWS account and regional permissions. Set `BEDROCK_MODEL` to override the model used by [`examples/bedrock_runtime.rb`](examples/bedrock_runtime.rb). The example uses Chat Completions by default; set `BEDROCK_RESPONSES=1` to also use Responses or `BEDROCK_STREAM=1` to also stream Chat Completions. Set `BEDROCK_AUTH_MODE=sigv4` to explicitly select AWS authentication when a bearer credential is also present.
+
+The same client supports Responses and response streaming when AWS makes those APIs available for the selected model:
+
+```ruby
+response = client.responses.create(
+  model: "us.openai.gpt-5.6-sol",
+  input: "Say hello!"
+)
+
+stream = client.chat.completions.stream(
+  model: "us.openai.gpt-5.6-sol",
+  messages: [{role: :user, content: "Say hello!"}]
+)
+
+stream.text.each { |text| print(text) }
+```
+
+The existing Mantle endpoint remains the default. Pass `endpoint: :mantle` when you need to explicitly select it. Both endpoint symbols and the strings `"runtime"` and `"mantle"` are accepted.
+
+| Endpoint | Default URL | SigV4 signing service |
+| --- | --- | --- |
+| `:mantle` (default) | `https://bedrock-mantle.<region>.api.aws/v1` | `bedrock-mantle` |
+| `:runtime` | `https://bedrock-runtime.<region>.amazonaws.com/openai/v1` | `bedrock` |
+
+Runtime URLs automatically use the correct DNS suffix for AWS China, European Sovereign Cloud, and isolated partitions. Canonical Runtime, FIPS, and dual-stack `base_url` values automatically select Runtime when `endpoint` is omitted. Canonical AWS endpoint URLs must use HTTPS, match the selected endpoint family, and agree with the configured AWS region.
+
+## Endpoint configuration
+
 The region is resolved from the explicit `region` option, `AWS_REGION`, `AWS_DEFAULT_REGION`, or the selected AWS profile. Override the endpoint with `base_url` or `AWS_BEDROCK_BASE_URL`:
 
 ```ruby
 provider = OpenAI::Providers.bedrock(
+  endpoint: :runtime,
   region: "us-west-2",
-  base_url: "https://bedrock.example.com/v1"
+  base_url: "https://bedrock.example.com/openai/v1"
 )
 ```
 
+Custom endpoints using AWS credentials default to Mantle signing when `endpoint` is omitted; pass `endpoint: :runtime` to use Runtime signing. Local HTTP proxies remain supported when the endpoint is selected explicitly. Custom endpoints using bearer credentials can omit `endpoint`; in that case the default remains Mantle.
+
 ## Authentication
 
 The provider selects authentication in this order:
@@ -101,7 +155,7 @@ client = OpenAI::Client.new(
 )
 ```
 
-The provider signs each finalized attempt with AWS SigV4 service name `bedrock-mantle`. Standard JSON API requests have replayable bodies and work normally. SigV4 rejects one-shot request streams before sending, and signed requests do not automatically follow redirects because a new target requires a new signature. Response streaming is unaffected.
+The provider signs each finalized attempt with AWS SigV4 service name `bedrock-mantle` for Mantle or `bedrock` for Runtime. Standard JSON API requests have replayable bodies and work normally. SigV4 rejects one-shot request streams before sending, and signed requests do not automatically follow redirects because a new target requires a new signature. Response streaming is unaffected.
 
 ### Bearer authentication
 
@@ -127,6 +181,17 @@ client = OpenAI::Client.new(
 
 Bearer authentication does not load or require `aws-sdk-core`. Passing `api_key: nil` explicitly skips `AWS_BEARER_TOKEN_BEDROCK` and selects AWS authentication.
 
+## Live verification
+
+Real AWS requests are disabled in the test suite unless `BEDROCK_LIVE_TEST=1` is explicitly set. To exercise Runtime against all three default US inference profiles, run:
+
+```sh
+AWS_REGION=us-east-1 BEDROCK_LIVE_TEST=1 \
+  bundle exec ruby test/openai/providers/bedrock_live_test.rb
+```
+
+Set `BEDROCK_AUTH_MODE` to `auto`, `bearer`, `token-provider`, `sigv4`, `static`, or `profile` to select credentials. Use `BEDROCK_MODEL` for one inference profile or `BEDROCK_LIVE_MODELS` for a comma-separated list. Set `BEDROCK_LIVE_RESPONSES=1` to also verify Responses and `BEDROCK_LIVE_STREAM=1` to verify Chat Completions streaming.
+
 ## Security
 
 Use Bedrock from a server-side Ruby runtime. Prefer roles, profiles, SSO, and temporary credentials over long-lived static keys. Do not send AWS access keys, session tokens, bearer credentials, or signed authorization headers to browsers or application logs.

data/lib/openai/models/all_models.rb

@@ -24,6 +24,8 @@ module OpenAI
         O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
         COMPUTER_USE_PREVIEW = :"computer-use-preview"
         COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
+        GPT_5_5_PRO = :"gpt-5.5-pro"
+        GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
         GPT_5_CODEX = :"gpt-5-codex"
         GPT_5_PRO = :"gpt-5-pro"
         GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module BetaMcpToolCallError
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        variant :mcp_protocol_error, -> { OpenAI::Beta::BetaMcpToolCallError::McpProtocolError }
+
+        variant :mcp_tool_execution_error, -> { OpenAI::Beta::BetaMcpToolCallError::McpToolExecutionError }
+
+        variant :http_error, -> { OpenAI::Beta::BetaMcpToolCallError::HTTPError }
+
+        class McpProtocolError < OpenAI::Internal::Type::BaseModel
+          # @!attribute code
+          #
+          #   @return [Integer]
+          required :code, Integer
+
+          # @!attribute message
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :mcp_protocol_error]
+          required :type, const: :mcp_protocol_error
+
+          # @!method initialize(code:, message:, type: :mcp_protocol_error)
+          #   @param code [Integer]
+          #   @param message [String]
+          #   @param type [Symbol, :mcp_protocol_error]
+        end
+
+        class McpToolExecutionError < OpenAI::Internal::Type::BaseModel
+          # @!attribute content
+          #
+          #   @return [Object]
+          required :content, OpenAI::Internal::Type::Unknown
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :mcp_tool_execution_error]
+          required :type, const: :mcp_tool_execution_error
+
+          # @!method initialize(content:, type: :mcp_tool_execution_error)
+          #   @param content [Object]
+          #   @param type [Symbol, :mcp_tool_execution_error]
+        end
+
+        class HTTPError < OpenAI::Internal::Type::BaseModel
+          # @!attribute code
+          #
+          #   @return [Integer]
+          required :code, Integer
+
+          # @!attribute message
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :http_error]
+          required :type, const: :http_error
+
+          # @!method initialize(code:, message:, type: :http_error)
+          #   @param code [Integer]
+          #   @param message [String]
+          #   @param type [Symbol, :http_error]
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError)]
+      end
+    end
+
+    BetaMcpToolCallError = Beta::BetaMcpToolCallError
+  end
+end

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

@@ -274,6 +274,10 @@ module OpenAI
         #     Responses or Chat Completions. The response will show `service_tier=priority`
         #     regardless of if you specify `service_tier=fast` or `priority` in your
         #     request.
+        #   - If set to 'ultrafast', then the request will be processed with the
+        #     access-controlled Ultrafast Processing service tier. This tier is currently
+        #     available for `gpt-5.6-sol`; a response served through it will show
+        #     `service_tier=ultrafast`.
         #   - When not set, the default behavior is 'auto'.
         #
         #   When the `service_tier` parameter is set, the response body will include the
@@ -483,6 +487,8 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_5 }
 
+          variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_5_2026_04_23 }
+
           variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_4 }
 
           variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_4_MINI }
@@ -659,6 +665,10 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::COMPUTER_USE_PREVIEW_2025_03_11 }
 
+          variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_5_PRO }
+
+          variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_5_PRO_2026_04_23 }
+
           variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_CODEX }
 
           variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_PRO }
@@ -688,6 +698,7 @@ module OpenAI
           GPT_5_6_TERRA = :"gpt-5.6-terra"
           GPT_5_6_LUNA = :"gpt-5.6-luna"
           GPT_5_5 = :"gpt-5.5"
+          GPT_5_5_2026_04_23 = :"gpt-5.5-2026-04-23"
           GPT_5_4 = :"gpt-5.4"
           GPT_5_4_MINI = :"gpt-5.4-mini"
           GPT_5_4_NANO = :"gpt-5.4-nano"
@@ -776,6 +787,8 @@ module OpenAI
           O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
           COMPUTER_USE_PREVIEW = :"computer-use-preview"
           COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
+          GPT_5_5_PRO = :"gpt-5.5-pro"
+          GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
           GPT_5_CODEX = :"gpt-5-codex"
           GPT_5_PRO = :"gpt-5-pro"
           GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
@@ -1404,6 +1417,10 @@ module OpenAI
         #   Responses or Chat Completions. The response will show `service_tier=priority`
         #   regardless of if you specify `service_tier=fast` or `priority` in your
         #   request.
+        # - If set to 'ultrafast', then the request will be processed with the
+        #   access-controlled Ultrafast Processing service tier. This tier is currently
+        #   available for `gpt-5.6-sol`; a response served through it will show
+        #   `service_tier=ultrafast`.
         # - When not set, the default behavior is 'auto'.
         #
         # When the `service_tier` parameter is set, the response body will include the
@@ -1421,6 +1438,7 @@ module OpenAI
           SCALE = :scale
           PRIORITY = :priority
           FAST = :fast
+          ULTRAFAST = :ultrafast
 
           # @!method self.values
           #   @return [Array<Symbol>]

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

@@ -2502,8 +2502,8 @@ module OpenAI
           # @!attribute error
           #   The error from the tool call, if any.
           #
-          #   @return [String, nil]
-          optional :error, String, nil?: true
+          #   @return [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil]
+          optional :error, union: -> { OpenAI::Beta::BetaMcpToolCallError }, nil?: true
 
           # @!attribute output
           #   The output from the tool call.
@@ -2536,7 +2536,7 @@ module OpenAI
           #
           #   @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
           #
-          #   @param error [String, nil] The error from the tool call, if any.
+          #   @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil] The error from the tool call, if any.
           #
           #   @param output [String, nil] The output from the tool call.
           #

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

@@ -1354,8 +1354,8 @@ module OpenAI
           # @!attribute error
           #   The error from the tool call, if any.
           #
-          #   @return [String, nil]
-          optional :error, String, nil?: true
+          #   @return [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil]
+          optional :error, union: -> { OpenAI::Beta::BetaMcpToolCallError }, nil?: true
 
           # @!attribute output
           #   The output from the tool call.
@@ -1388,7 +1388,7 @@ module OpenAI
           #
           #   @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
           #
-          #   @param error [String, nil] The error from the tool call, if any.
+          #   @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil] The error from the tool call, if any.
           #
           #   @param output [String, nil] The output from the tool call.
           #

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

@@ -1106,8 +1106,8 @@ module OpenAI
           # @!attribute error
           #   The error from the tool call, if any.
           #
-          #   @return [String, nil]
-          optional :error, String, nil?: true
+          #   @return [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil]
+          optional :error, union: -> { OpenAI::Beta::BetaMcpToolCallError }, nil?: true
 
           # @!attribute output
           #   The output from the tool call.
@@ -1140,7 +1140,7 @@ module OpenAI
           #
           #   @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
           #
-          #   @param error [String, nil] The error from the tool call, if any.
+          #   @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil] The error from the tool call, if any.
           #
           #   @param output [String, nil] The output from the tool call.
           #

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

@@ -5,7 +5,10 @@ module OpenAI
     module Beta
       class BetaResponseOutputItemAddedEvent < OpenAI::Internal::Type::BaseModel
         # @!attribute item
-        #   The output item that was added.
+        #   The output item that was added. For reasoning items, `encrypted_content` may be
+        #   incomplete while the item is in progress. Use the reasoning item from the
+        #   corresponding `response.output_item.done` event when passing it as input to a
+        #   subsequent request.
         #
         #   @return [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem]
         required :item, union: -> { OpenAI::Beta::BetaResponseOutputItem }
@@ -40,7 +43,7 @@ module OpenAI
         #
         #   Emitted when a new output item is added.
         #
-        #   @param item [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem] The output item that was added.
+        #   @param item [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem] The output item that was added. For reasoning items, `encrypted_content`
         #
         #   @param output_index [Integer] The index of the output item that was added.
         #

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

@@ -5,10 +5,12 @@ module OpenAI
     module Beta
       class BetaResponseOutputTextAnnotationAddedEvent < OpenAI::Internal::Type::BaseModel
         # @!attribute annotation
-        #   The annotation object being added. (See annotation schema for details.)
+        #   An annotation that applies to a span of output text.
         #
-        #   @return [Object]
-        required :annotation, OpenAI::Internal::Type::Unknown
+        #   @return [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil]
+        required :annotation,
+                 union: -> { OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation },
+                 nil?: true
 
         # @!attribute annotation_index
         #   The index of the annotation within the content part.
@@ -55,7 +57,7 @@ module OpenAI
         # @!method initialize(annotation:, annotation_index:, content_index:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.output_text.annotation.added")
         #   Emitted when an annotation is added to output text content.
         #
-        #   @param annotation [Object] The annotation object being added. (See annotation schema for details.)
+        #   @param annotation [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil] An annotation that applies to a span of output text.
         #
         #   @param annotation_index [Integer] The index of the annotation within the content part.
         #
@@ -71,6 +73,201 @@ module OpenAI
         #
         #   @param type [Symbol, :"response.output_text.annotation.added"] The type of the event. Always 'response.output_text.annotation.added'.
 
+        # An annotation that applies to a span of output text.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent#annotation
+        module Annotation
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # A citation to a file.
+          variant :file_citation,
+                  -> { OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation }
+
+          # A citation for a web resource used to generate a model response.
+          variant :url_citation,
+                  -> { OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation }
+
+          # A citation for a container file used to generate a model response.
+          variant :container_file_citation,
+                  -> { OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation }
+
+          # A path to a file.
+          variant :file_path, -> { OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath }
+
+          class FileCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute filename
+            #   The filename of the file cited.
+            #
+            #   @return [String]
+            required :filename, String
+
+            # @!attribute index
+            #   The index of the file in the list of files.
+            #
+            #   @return [Integer]
+            required :index, Integer
+
+            # @!attribute type
+            #   The type of the file citation. Always `file_citation`.
+            #
+            #   @return [Symbol, :file_citation]
+            required :type, const: :file_citation
+
+            # @!method initialize(file_id:, filename:, index:, type: :file_citation)
+            #   A citation to a file.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param filename [String] The filename of the file cited.
+            #
+            #   @param index [Integer] The index of the file in the list of files.
+            #
+            #   @param type [Symbol, :file_citation] The type of the file citation. Always `file_citation`.
+          end
+
+          class URLCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute end_index
+            #   The index of the last character of the URL citation in the message.
+            #
+            #   @return [Integer]
+            required :end_index, Integer
+
+            # @!attribute start_index
+            #   The index of the first character of the URL citation in the message.
+            #
+            #   @return [Integer]
+            required :start_index, Integer
+
+            # @!attribute title
+            #   The title of the web resource.
+            #
+            #   @return [String]
+            required :title, String
+
+            # @!attribute type
+            #   The type of the URL citation. Always `url_citation`.
+            #
+            #   @return [Symbol, :url_citation]
+            required :type, const: :url_citation
+
+            # @!attribute url
+            #   The URL of the web resource.
+            #
+            #   @return [String]
+            required :url, String
+
+            # @!method initialize(end_index:, start_index:, title:, url:, type: :url_citation)
+            #   A citation for a web resource used to generate a model response.
+            #
+            #   @param end_index [Integer] The index of the last character of the URL citation in the message.
+            #
+            #   @param start_index [Integer] The index of the first character of the URL citation in the message.
+            #
+            #   @param title [String] The title of the web resource.
+            #
+            #   @param url [String] The URL of the web resource.
+            #
+            #   @param type [Symbol, :url_citation] The type of the URL citation. Always `url_citation`.
+          end
+
+          class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute container_id
+            #   The ID of the container file.
+            #
+            #   @return [String]
+            required :container_id, String
+
+            # @!attribute end_index
+            #   The index of the last character of the container file citation in the message.
+            #
+            #   @return [Integer]
+            required :end_index, Integer
+
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute filename
+            #   The filename of the container file cited.
+            #
+            #   @return [String]
+            required :filename, String
+
+            # @!attribute start_index
+            #   The index of the first character of the container file citation in the message.
+            #
+            #   @return [Integer]
+            required :start_index, Integer
+
+            # @!attribute type
+            #   The type of the container file citation. Always `container_file_citation`.
+            #
+            #   @return [Symbol, :container_file_citation]
+            required :type, const: :container_file_citation
+
+            # @!method initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation)
+            #   A citation for a container file used to generate a model response.
+            #
+            #   @param container_id [String] The ID of the container file.
+            #
+            #   @param end_index [Integer] The index of the last character of the container file citation in the message.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param filename [String] The filename of the container file cited.
+            #
+            #   @param start_index [Integer] The index of the first character of the container file citation in the message.
+            #
+            #   @param type [Symbol, :container_file_citation] The type of the container file citation. Always `container_file_citation`.
+          end
+
+          class FilePath < OpenAI::Internal::Type::BaseModel
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute index
+            #   The index of the file in the list of files.
+            #
+            #   @return [Integer]
+            required :index, Integer
+
+            # @!attribute type
+            #   The type of the file path. Always `file_path`.
+            #
+            #   @return [Symbol, :file_path]
+            required :type, const: :file_path
+
+            # @!method initialize(file_id:, index:, type: :file_path)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath}
+            #   for more details.
+            #
+            #   A path to a file.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param index [Integer] The index of the file in the list of files.
+            #
+            #   @param type [Symbol, :file_path] The type of the file path. Always `file_path`.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath)]
+        end
+
         # @see OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
           # @!attribute agent_name

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

@@ -41,6 +41,11 @@ module OpenAI
         #   reasoning items returned by `POST /v1/responses` and WebSocket `response.create`
         #   requests.
         #
+        #   When streaming, use the completed reasoning item and its `encrypted_content`
+        #   from the `response.output_item.done` event in subsequent requests. The
+        #   `encrypted_content` in `response.output_item.added` may be incomplete. This is
+        #   especially important when `store` is `false` or when using Zero Data Retention.
+        #
         #   @return [String, nil]
         optional :encrypted_content, String, nil?: true