openai 0.9.0 → 0.11.0

data/lib/openai/resources/responses.rb

@@ -23,22 +23,24 @@ module OpenAI
       # [file search](https://platform.openai.com/docs/guides/tools-file-search) to use
       # your own data as input for the model's response.
       #
-      # @overload create(input:, model:, background: nil, include: nil, instructions: nil, max_output_tokens: nil, metadata: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
-      #
-      # @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
-      #
-      # @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
+      # @overload create(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
       #
       # @param background [Boolean, nil] Whether to run the model response in the background.
       #
       # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
       #
+      # @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
+      #
       # @param instructions [String, nil] A system (or developer) message inserted into the model's context.
       #
       # @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
       #
+      # @param max_tool_calls [Integer, nil] The maximum number of total calls to built-in tools that can be processed in a r
+      #
       # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
       #
+      # @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
+      #
       # @param parallel_tool_calls [Boolean, nil] Whether to allow the model to run tool calls in parallel.
       #
       # @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to
@@ -47,7 +49,7 @@ module OpenAI
       #
       # @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
       #
-      # @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
+      # @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
       #
       # @param store [Boolean, nil] Whether to store the generated model response for later retrieval via
       #
@@ -55,10 +57,12 @@ module OpenAI
       #
       # @param text [OpenAI::Models::Responses::ResponseTextConfig] Configuration options for a text response from the model. Can be plain
       #
-      # @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction] How the model should select which tool (or tools) to use when generating
+      # @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp] How the model should select which tool (or tools) to use when generating
       #
       # @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
       #
+      # @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
+      #
       # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
       #
       # @param truncation [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Truncation, nil] The truncation strategy to use for the model response.
@@ -70,7 +74,7 @@ module OpenAI
       # @return [OpenAI::Models::Responses::Response]
       #
       # @see OpenAI::Models::Responses::ResponseCreateParams
-      def create(params)
+      def create(params = {})
         parsed, options = OpenAI::Responses::ResponseCreateParams.dump_request(params)
         if parsed[:stream]
           message = "Please use `#stream_raw` for the streaming use case."
@@ -183,22 +187,24 @@ module OpenAI
       # [file search](https://platform.openai.com/docs/guides/tools-file-search) to use
       # your own data as input for the model's response.
       #
-      # @overload stream_raw(input:, model:, background: nil, include: nil, instructions: nil, max_output_tokens: nil, metadata: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
-      #
-      # @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
-      #
-      # @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
+      # @overload stream_raw(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
       #
       # @param background [Boolean, nil] Whether to run the model response in the background.
       #
       # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
       #
+      # @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
+      #
       # @param instructions [String, nil] A system (or developer) message inserted into the model's context.
       #
       # @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
       #
+      # @param max_tool_calls [Integer, nil] The maximum number of total calls to built-in tools that can be processed in a r
+      #
       # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
       #
+      # @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
+      #
       # @param parallel_tool_calls [Boolean, nil] Whether to allow the model to run tool calls in parallel.
       #
       # @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to
@@ -207,7 +213,7 @@ module OpenAI
       #
       # @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
       #
-      # @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
+      # @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
       #
       # @param store [Boolean, nil] Whether to store the generated model response for later retrieval via
       #
@@ -215,10 +221,12 @@ module OpenAI
       #
       # @param text [OpenAI::Models::Responses::ResponseTextConfig] Configuration options for a text response from the model. Can be plain
       #
-      # @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction] How the model should select which tool (or tools) to use when generating
+      # @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp] How the model should select which tool (or tools) to use when generating
       #
       # @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
       #
+      # @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
+      #
       # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
       #
       # @param truncation [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Truncation, nil] The truncation strategy to use for the model response.
@@ -230,7 +238,7 @@ module OpenAI
       # @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseReasoningDeltaEvent, OpenAI::Models::Responses::ResponseReasoningDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent>]
       #
       # @see OpenAI::Models::Responses::ResponseCreateParams
-      def stream_raw(params)
+      def stream_raw(params = {})
         parsed, options = OpenAI::Responses::ResponseCreateParams.dump_request(params)
         unless parsed.fetch(:stream, true)
           message = "Please use `#create` for the non-streaming use case."

data/lib/openai/resources/webhooks.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "base64"
+
+module OpenAI
+  module Resources
+    class Webhooks
+      # Validates that the given payload was sent by OpenAI and parses the payload.
+      #
+      # @param payload [String] The raw webhook payload as a string
+      # @param headers [Hash] The webhook headers
+      # @param webhook_secret [String, nil] The webhook secret (optional, will use client webhook secret or ENV["OPENAI_WEBHOOK_SECRET"] if not provided)
+      #
+      # @return [OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseCreatedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent]
+      #
+      # @raise [ArgumentError] if signature verification fails
+      def unwrap(
+        payload,
+        headers = {},
+        webhook_secret = @client.webhook_secret || ENV["OPENAI_WEBHOOK_SECRET"]
+      )
+        verify_signature(payload, headers, webhook_secret)
+
+        parsed = JSON.parse(payload, symbolize_names: true)
+        OpenAI::Internal::Type::Converter.coerce(OpenAI::Models::Webhooks::UnwrapWebhookEvent, parsed)
+      end
+
+      # Validates whether or not the webhook payload was sent by OpenAI.
+      #
+      # @param payload [String] The webhook payload as a string
+      # @param headers [Hash] The webhook headers
+      # @param webhook_secret [String, nil] The webhook secret (optional, will use client webhook secret or ENV["OPENAI_WEBHOOK_SECRET"] if not provided)
+      # @param tolerance [Integer] Maximum age of the webhook in seconds (default: 300 = 5 minutes)
+      #
+      # @raise [ArgumentError] if the signature is invalid
+      def verify_signature(
+        payload,
+        headers,
+        webhook_secret = @client.webhook_secret || ENV["OPENAI_WEBHOOK_SECRET"],
+        tolerance = 300
+      )
+        if webhook_secret.nil?
+          raise ArgumentError,
+                "The webhook secret must either be set using the env var, OPENAI_WEBHOOK_SECRET, " \
+                "or passed to this function"
+        end
+
+        # Extract required headers
+        signature_header = headers["webhook-signature"] || headers[:webhook_signature]
+        timestamp_header = headers["webhook-timestamp"] || headers[:webhook_timestamp]
+        webhook_id = headers["webhook-id"] || headers[:webhook_id]
+
+        if signature_header.nil?
+          raise ArgumentError, "Missing required webhook-signature header"
+        end
+
+        if timestamp_header.nil?
+          raise ArgumentError, "Missing required webhook-timestamp header"
+        end
+
+        if webhook_id.nil?
+          raise ArgumentError, "Missing required webhook-id header"
+        end
+
+        # Validate timestamp to prevent replay attacks
+        begin
+          timestamp_seconds = timestamp_header.to_i
+        rescue ArgumentError
+          raise ArgumentError, "Invalid webhook timestamp format"
+        end
+
+        now = Time.now.to_i
+
+        if now - timestamp_seconds > tolerance
+          raise OpenAI::Errors::InvalidWebhookSignatureError, "Webhook timestamp is too old"
+        end
+
+        if timestamp_seconds > now + tolerance
+          raise OpenAI::Errors::InvalidWebhookSignatureError, "Webhook timestamp is too new"
+        end
+
+        # Extract signatures from v1,<base64> format
+        # The signature header can have multiple values, separated by spaces.
+        # Each value is in the format v1,<base64>. We should accept if any match.
+        signatures = signature_header.split.map do |part|
+          if part.start_with?("v1,")
+            part[3..]
+          else
+            part
+          end
+        end
+
+        # Decode the secret if it starts with whsec_
+        decoded_secret = if webhook_secret.start_with?("whsec_")
+          Base64.decode64(webhook_secret[6..])
+        else
+          webhook_secret
+        end
+
+        # Create the signed payload: {webhook_id}.{timestamp}.{payload}
+        signed_payload = "#{webhook_id}.#{timestamp_header}.#{payload}"
+
+        # Compute HMAC-SHA256 signature
+        expected_signature = Base64.encode64(
+          OpenSSL::HMAC.digest("sha256", decoded_secret, signed_payload)
+        ).strip
+
+        # Accept if any signature matches using timing-safe comparison
+        return if signatures.any? { |signature| OpenSSL.secure_compare(expected_signature, signature) }
+
+        raise OpenAI::Errors::InvalidWebhookSignatureError,
+              "The given webhook signature does not match the expected signature"
+      end
+
+      # @api private
+      #
+      # @param client [OpenAI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.9.0"
+  VERSION = "0.11.0"
 end

data/lib/openai.rb

@@ -441,6 +441,7 @@ require_relative "openai/models/responses/response_web_search_call_in_progress_e
 require_relative "openai/models/responses/response_web_search_call_searching_event"
 require_relative "openai/models/responses/tool"
 require_relative "openai/models/responses/tool_choice_function"
+require_relative "openai/models/responses/tool_choice_mcp"
 require_relative "openai/models/responses/tool_choice_options"
 require_relative "openai/models/responses/tool_choice_types"
 require_relative "openai/models/responses/web_search_tool"
@@ -477,6 +478,22 @@ require_relative "openai/models/vector_stores/vector_store_file_deleted"
 require_relative "openai/models/vector_store_search_params"
 require_relative "openai/models/vector_store_search_response"
 require_relative "openai/models/vector_store_update_params"
+require_relative "openai/models/webhooks/batch_cancelled_webhook_event"
+require_relative "openai/models/webhooks/batch_completed_webhook_event"
+require_relative "openai/models/webhooks/batch_expired_webhook_event"
+require_relative "openai/models/webhooks/batch_failed_webhook_event"
+require_relative "openai/models/webhooks/eval_run_canceled_webhook_event"
+require_relative "openai/models/webhooks/eval_run_failed_webhook_event"
+require_relative "openai/models/webhooks/eval_run_succeeded_webhook_event"
+require_relative "openai/models/webhooks/fine_tuning_job_cancelled_webhook_event"
+require_relative "openai/models/webhooks/fine_tuning_job_failed_webhook_event"
+require_relative "openai/models/webhooks/fine_tuning_job_succeeded_webhook_event"
+require_relative "openai/models/webhooks/response_cancelled_webhook_event"
+require_relative "openai/models/webhooks/response_completed_webhook_event"
+require_relative "openai/models/webhooks/response_failed_webhook_event"
+require_relative "openai/models/webhooks/response_incomplete_webhook_event"
+require_relative "openai/models/webhooks/unwrap_webhook_event"
+require_relative "openai/models/webhooks/webhook_unwrap_params"
 require_relative "openai/models"
 require_relative "openai/resources/audio"
 require_relative "openai/resources/audio/speech"
@@ -521,3 +538,4 @@ require_relative "openai/resources/uploads/parts"
 require_relative "openai/resources/vector_stores"
 require_relative "openai/resources/vector_stores/file_batches"
 require_relative "openai/resources/vector_stores/files"
+require_relative "openai/resources/webhooks"

data/rbi/openai/client.rbi

@@ -52,6 +52,9 @@ module OpenAI
     sig { returns(OpenAI::Resources::VectorStores) }
     attr_reader :vector_stores
 
+    sig { returns(OpenAI::Resources::Webhooks) }
+    attr_reader :webhooks
+
     sig { returns(OpenAI::Resources::Beta) }
     attr_reader :beta
 

data/rbi/openai/errors.rbi

@@ -8,6 +8,22 @@ module OpenAI
     end
 
     class ConversionError < OpenAI::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
     end
 
     class APIError < OpenAI::Errors::Error

data/rbi/openai/internal/type/boolean.rbi

@@ -22,6 +22,8 @@ module OpenAI
 
         class << self
           # @api private
+          #
+          # Coerce value to Boolean if possible, otherwise return the original value.
           sig do
             override
               .params(

data/rbi/openai/internal/type/converter.rbi

@@ -15,12 +15,14 @@ module OpenAI
         CoerceState =
           T.type_alias do
             {
-              strictness: T.any(T::Boolean, Symbol),
+              translate_names: T::Boolean,
+              strictness: T::Boolean,
               exactness: {
                 yes: Integer,
                 no: Integer,
                 maybe: Integer
               },
+              error: T::Class[StandardError],
               branched: Integer
             }
           end
@@ -84,6 +86,15 @@ module OpenAI
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(translate_names: T::Boolean).returns(
+              OpenAI::Internal::Type::Converter::CoerceState
+            )
+          end
+          def self.new_coerce_state(translate_names: true)
+          end
+
           # @api private
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
@@ -105,14 +116,11 @@ module OpenAI
           def self.coerce(
             target,
             value,
-            # The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-            # coercion strategy when we have to decide between multiple possible conversion
-            # targets:
+            # The `strictness` is one of `true`, `false`. This informs the coercion strategy
+            # when we have to decide between multiple possible conversion targets:
             #
             # - `true`: the conversion must be exact, with minimum coercion.
             # - `false`: the conversion can be approximate, with some coercion.
-            # - `:strong`: the conversion must be exact, with no coercion, and raise an error
-            #   if not possible.
             #
             # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
             # any given conversion attempt, the exactness will be updated based on how closely
@@ -124,15 +132,7 @@ module OpenAI
             # - `no`: the value cannot be converted to the target type.
             #
             # See implementation below for more details.
-            state: {
-              strictness: true,
-              exactness: {
-                yes: 0,
-                no: 0,
-                maybe: 0
-              },
-              branched: 0
-            }
+            state: OpenAI::Internal::Type::Converter.new_coerce_state
           )
           end
 

data/rbi/openai/internal/type/union.rbi

@@ -78,6 +78,11 @@ module OpenAI
         end
 
         # @api private
+        #
+        # Tries to efficiently coerce the given value to one of the known variants.
+        #
+        # If the value cannot match any of the known variants, the coercion is considered
+        # non-viable and returns the original value.
         sig do
           override
             .params(

data/rbi/openai/internal/type/unknown.rbi

@@ -22,6 +22,8 @@ module OpenAI
 
         class << self
           # @api private
+          #
+          # No coercion needed for Unknown type.
           sig do
             override
               .params(

data/rbi/openai/models/all_models.rbi

@@ -35,6 +35,26 @@ module OpenAI
             :"o3-pro-2025-06-10",
             OpenAI::AllModels::ResponsesOnlyModel::TaggedSymbol
           )
+        O3_DEEP_RESEARCH =
+          T.let(
+            :"o3-deep-research",
+            OpenAI::AllModels::ResponsesOnlyModel::TaggedSymbol
+          )
+        O3_DEEP_RESEARCH_2025_06_26 =
+          T.let(
+            :"o3-deep-research-2025-06-26",
+            OpenAI::AllModels::ResponsesOnlyModel::TaggedSymbol
+          )
+        O4_MINI_DEEP_RESEARCH =
+          T.let(
+            :"o4-mini-deep-research",
+            OpenAI::AllModels::ResponsesOnlyModel::TaggedSymbol
+          )
+        O4_MINI_DEEP_RESEARCH_2025_06_26 =
+          T.let(
+            :"o4-mini-deep-research-2025-06-26",
+            OpenAI::AllModels::ResponsesOnlyModel::TaggedSymbol
+          )
         COMPUTER_USE_PREVIEW =
           T.let(
             :"computer-use-preview",

data/rbi/openai/models/audio/speech_create_params.rbi

@@ -60,13 +60,30 @@ module OpenAI
         attr_writer :response_format
 
         # The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
-        # the default. Does not work with `gpt-4o-mini-tts`.
+        # the default.
         sig { returns(T.nilable(Float)) }
         attr_reader :speed
 
         sig { params(speed: Float).void }
         attr_writer :speed
 
+        # The format to stream the audio in. Supported formats are `sse` and `audio`.
+        # `sse` is not supported for `tts-1` or `tts-1-hd`.
+        sig do
+          returns(
+            T.nilable(OpenAI::Audio::SpeechCreateParams::StreamFormat::OrSymbol)
+          )
+        end
+        attr_reader :stream_format
+
+        sig do
+          params(
+            stream_format:
+              OpenAI::Audio::SpeechCreateParams::StreamFormat::OrSymbol
+          ).void
+        end
+        attr_writer :stream_format
+
         sig do
           params(
             input: String,
@@ -77,6 +94,8 @@ module OpenAI
             response_format:
               OpenAI::Audio::SpeechCreateParams::ResponseFormat::OrSymbol,
             speed: Float,
+            stream_format:
+              OpenAI::Audio::SpeechCreateParams::StreamFormat::OrSymbol,
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -98,8 +117,11 @@ module OpenAI
           # `wav`, and `pcm`.
           response_format: nil,
           # The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
-          # the default. Does not work with `gpt-4o-mini-tts`.
+          # the default.
           speed: nil,
+          # The format to stream the audio in. Supported formats are `sse` and `audio`.
+          # `sse` is not supported for `tts-1` or `tts-1-hd`.
+          stream_format: nil,
           request_options: {}
         )
         end
@@ -118,6 +140,8 @@ module OpenAI
               response_format:
                 OpenAI::Audio::SpeechCreateParams::ResponseFormat::OrSymbol,
               speed: Float,
+              stream_format:
+                OpenAI::Audio::SpeechCreateParams::StreamFormat::OrSymbol,
               request_options: OpenAI::RequestOptions
             }
           )
@@ -267,6 +291,39 @@ module OpenAI
           def self.values
           end
         end
+
+        # The format to stream the audio in. Supported formats are `sse` and `audio`.
+        # `sse` is not supported for `tts-1` or `tts-1-hd`.
+        module StreamFormat
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Audio::SpeechCreateParams::StreamFormat)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SSE =
+            T.let(
+              :sse,
+              OpenAI::Audio::SpeechCreateParams::StreamFormat::TaggedSymbol
+            )
+          AUDIO =
+            T.let(
+              :audio,
+              OpenAI::Audio::SpeechCreateParams::StreamFormat::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Audio::SpeechCreateParams::StreamFormat::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end