openai 0.80.0 → 0.82.0

data/lib/openai/resources/images.rb

@@ -99,6 +99,7 @@ module OpenAI
           message = "Please use `#edit_stream_raw` for the streaming use case."
           raise ArgumentError.new(message)
         end
+
         @client.request(
           method: :post,
           path: "images/edits",
@@ -164,6 +165,7 @@ module OpenAI
           message = "Please use `#edit` for the non-streaming use case."
           raise ArgumentError.new(message)
         end
+
         parsed.store(:stream, true)
         @client.request(
           method: :post,
@@ -228,6 +230,7 @@ module OpenAI
           message = "Please use `#generate_stream_raw` for the streaming use case."
           raise ArgumentError.new(message)
         end
+
         @client.request(
           method: :post,
           path: "images/generations",
@@ -285,6 +288,7 @@ module OpenAI
           message = "Please use `#generate` for the non-streaming use case."
           raise ArgumentError.new(message)
         end
+
         parsed.store(:stream, true)
         @client.request(
           method: :post,

data/lib/openai/resources/realtime/calls.rb

@@ -4,6 +4,60 @@ module OpenAI
   module Resources
     class Realtime
       class Calls
+        # Create a new Realtime API call over WebRTC and receive the SDP answer needed to
+        # complete the peer connection.
+        #
+        # @overload create(sdp:, session: nil, request_options: {})
+        #
+        # @param sdp [String] WebRTC Session Description Protocol (SDP) offer generated by the caller.
+        #
+        # @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest] Realtime session object configuration.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::HTTPClient::Response]
+        #
+        # @see OpenAI::Models::Realtime::CallCreateParams
+        def create(params)
+          parsed, options = OpenAI::Realtime::CallCreateParams.dump_request(params)
+          normalize_keys = lambda do |value|
+            case value
+            when Hash
+              value.to_h { |key, child| [key.to_s, normalize_keys.call(child)] }
+            when Array
+              value.map { |child| normalize_keys.call(child) }
+            else
+              value
+            end
+          end
+
+          multipart_body = OpenAI::Internal::Util.deep_merge(
+            normalize_keys.call(parsed),
+            normalize_keys.call(options[:extra_body] || {})
+          )
+          options = options.except(:extra_body)
+          if multipart_body.key?("sdp")
+            multipart_body["sdp"] = OpenAI::FilePart.new(multipart_body["sdp"], content_type: "application/sdp")
+          end
+
+          if multipart_body.key?("session")
+            multipart_body["session"] = OpenAI::FilePart.new(
+              JSON.generate(multipart_body["session"]),
+              content_type: "application/json"
+            )
+          end
+
+          @client.request(
+            method: :post,
+            path: "realtime/calls",
+            headers: {"content-type" => "multipart/form-data", "accept" => "application/sdp"},
+            body: multipart_body,
+            model: OpenAI::HTTPClient::Response,
+            security: {bearer_auth: true},
+            options: {**options, max_retries: options[:max_retries] || 0}
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Realtime::CallAcceptParams} for more details.
         #

data/lib/openai/resources/responses.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../helpers/structured_output/response_parser"
+
 module OpenAI
   module Resources
     class Responses
@@ -102,7 +104,7 @@ module OpenAI
 
         model, tool_models = get_structured_output_models(parsed)
 
-        unwrap = ->(raw) do
+        unwrap = -> (raw) do
           parse_structured_outputs!(raw, model, tool_models)
         end
 
@@ -196,7 +198,7 @@ module OpenAI
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @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::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent>]
+      # @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::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
       #
       # @see OpenAI::Models::Responses::ResponseCreateParams
       def stream(params)
@@ -206,12 +208,14 @@ module OpenAI
         if starting_after && !response_id
           raise ArgumentError, "starting_after can only be used with response_id"
         end
+
         model, tool_models = get_structured_output_models(parsed)
 
-        unwrap = ->(raw) do
+        unwrap = -> (raw) do
           if raw[:type] == "response.completed" && raw[:response]
             parse_structured_outputs!(raw[:response], model, tool_models)
           end
+
           raw
         end
 
@@ -321,7 +325,7 @@ module OpenAI
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @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::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, 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::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent>]
+      # @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::ResponseShellCallCommandAddedEvent, OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent, OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent, 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::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, 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::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
       #
       # @see OpenAI::Models::Responses::ResponseCreateParams
       def stream_raw(params = {})
@@ -330,8 +334,8 @@ module OpenAI
           message = "Please use `#create` for the non-streaming use case."
           raise ArgumentError.new(message)
         end
-        parsed.store(:stream, true)
 
+        parsed.store(:stream, true)
         @client.request(
           method: :post,
           path: "responses",
@@ -373,6 +377,7 @@ module OpenAI
           message = "Please use `#retrieve_streaming` for the streaming use case."
           raise ArgumentError.new(message)
         end
+
         @client.request(
           method: :get,
           path: ["responses/%1$s", response_id],
@@ -402,7 +407,7 @@ module OpenAI
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @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::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, 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::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent>]
+      # @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::ResponseShellCallCommandAddedEvent, OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent, OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent, 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::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, 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::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
       #
       # @see OpenAI::Models::Responses::ResponseRetrieveParams
       def retrieve_streaming(response_id, params = {})
@@ -411,6 +416,7 @@ module OpenAI
           message = "Please use `#retrieve` for the non-streaming use case."
           raise ArgumentError.new(message)
         end
+
         parsed.store(:stream, true)
         query = OpenAI::Internal::Util.encode_query_params(parsed)
         @client.request(
@@ -541,144 +547,12 @@ module OpenAI
 
       private
 
-      # Post-processes raw API responses to parse and coerce structured outputs into typed Ruby objects.
-      #
-      # This method enhances the raw API response by parsing JSON content in structured outputs
-      # (both text outputs and function/tool calls) and converting them to their corresponding
-      # Ruby types using the JsonSchemaConverter models identified during request preparation.
-      #
-      # @param raw [Hash] The raw API response hash that will be mutated with parsed data
-      # @param model [JsonSchemaConverter|nil] The converter for structured text output, if specified
-      # @param tool_models [Hash<String, JsonSchemaConverter>] Hash mapping tool names to their converters
-      # @return [Hash] The mutated raw response with added :parsed fields containing typed Ruby objects
-      #
-      # The method performs two main transformations:
-      # 1. For structured text outputs: Finds output_text content, parses the JSON, and coerces it
-      #    to the model type, adding the result as content[:parsed]
-      # 2. For function/tool calls: Looks up the tool's converter by name, parses the arguments JSON,
-      #    and coerces it to the appropriate type, adding the result as output[:parsed]
       def parse_structured_outputs!(raw, model, tool_models)
-        if model.is_a?(OpenAI::StructuredOutput::JsonSchemaConverter)
-          raw[:output]
-            &.flat_map do |output|
-              next [] unless output[:type] == "message"
-              output[:content].to_a
-            end
-            &.each do |content|
-              next unless content[:type] == "output_text"
-              begin
-                parsed = JSON.parse(content.fetch(:text), symbolize_names: true)
-              rescue JSON::ParserError => e
-                parsed = e
-              end
-              coerced = OpenAI::Internal::Type::Converter.coerce(model, parsed)
-              content.store(:parsed, coerced)
-            end
-        end
-        raw[:output]&.each do |output|
-          next unless output[:type] == "function_call"
-          next if (model = tool_models[output.fetch(:name)]).nil?
-          begin
-            parsed = JSON.parse(output.fetch(:arguments), symbolize_names: true)
-          rescue JSON::ParserError => e
-            parsed = e
-          end
-          coerced = OpenAI::Internal::Type::Converter.coerce(model, parsed)
-          output.store(:parsed, coerced)
-        end
-
-        raw
+        OpenAI::Helpers::StructuredOutput::ResponseParser.parse!(raw, model, tool_models)
       end
 
-      # Extracts structured output models from request parameters and converts them to JSON Schema format.
-      #
-      # This method processes the parsed request parameters to identify any JsonSchemaConverter instances
-      # that define expected output schemas. It transforms these Ruby schema definitions into the JSON
-      # Schema format required by the OpenAI API, enabling type-safe structured outputs.
-      #
-      # @param parsed [Hash] The parsed request parameters that may contain structured output definitions
-      # @return [Array<(JsonSchemaConverter|nil, Hash)>] A tuple containing:
-      #   - model: The JsonSchemaConverter for structured text output (or nil if not specified)
-      #   - tool_models: Hash mapping tool names to their JsonSchemaConverter models
-      #
-      # The method handles multiple ways structured outputs can be specified:
-      # - Direct text format: { text: JsonSchemaConverter }
-      # - Nested text format: { text: { format: JsonSchemaConverter } }
-      # - Deep nested format: { text: { format: { type: :json_schema, schema: JsonSchemaConverter } } }
-      # - Tool parameters: { tools: [JsonSchemaConverter, ...] } or tools with parameters as converters
       def get_structured_output_models(parsed)
-        model = nil
-        tool_models = {}
-
-        case parsed
-        in {text: OpenAI::StructuredOutput::JsonSchemaConverter => model}
-          parsed.update(
-            text: {
-              format: {
-                type: :json_schema,
-                strict: true,
-                name: model.name.split("::").last,
-                schema: model.to_json_schema
-              }
-            }
-          )
-        in {text: {format: OpenAI::StructuredOutput::JsonSchemaConverter => model}}
-          parsed.fetch(:text).update(
-            format: {
-              type: :json_schema,
-              strict: true,
-              name: model.name.split("::").last,
-              schema: model.to_json_schema
-            }
-          )
-        in {text: {format: {type: :json_schema,
-                            schema: OpenAI::StructuredOutput::JsonSchemaConverter => model}}}
-          parsed.dig(:text, :format).store(:schema, model.to_json_schema)
-        else
-        end
-
-        case parsed
-        in {tools: Array => tools}
-          # rubocop:disable Metrics/BlockLength
-          mapped = tools.map do |tool|
-            case tool
-            in OpenAI::StructuredOutput::JsonSchemaConverter
-              name = tool.name.split("::").last
-              tool_models.store(name, tool)
-              {
-                type: :function,
-                strict: true,
-                name: name,
-                parameters: tool.to_json_schema
-              }
-            in {type: :function, parameters: OpenAI::StructuredOutput::JsonSchemaConverter => params}
-              func = tool.fetch(:function)
-              name = func[:name] ||= params.name.split("::").last
-              tool_models.store(name, params)
-              func.update(parameters: params.to_json_schema)
-              tool
-            in {type: _, function: {parameters: OpenAI::StructuredOutput::JsonSchemaConverter => params, **}}
-              name = tool[:function][:name] || params.name.split("::").last
-              tool_models.store(name, params)
-              tool[:function][:parameters] = params.to_json_schema
-              tool
-            in {type: _, function: Hash => func} if func[:parameters].is_a?(Class) &&
-              func[:parameters] < OpenAI::Internal::Type::BaseModel
-              params = func[:parameters]
-              name = func[:name] || params.name.split("::").last
-              tool_models.store(name, params)
-              func[:parameters] = params.to_json_schema
-              tool
-            else
-              tool
-            end
-          end
-          # rubocop:enable Metrics/BlockLength
-          tools.replace(mapped)
-        else
-        end
-
-        [model, tool_models]
+        OpenAI::Helpers::StructuredOutput::ResponseParser.get_models(parsed)
       end
     end
   end

data/lib/openai/resources/skills/versions/content.rb

@@ -20,10 +20,10 @@ module OpenAI
           # @see OpenAI::Models::Skills::Versions::ContentRetrieveParams
           def retrieve(version, params)
             parsed, options = OpenAI::Skills::Versions::ContentRetrieveParams.dump_request(params)
-            skill_id =
-              parsed.delete(:skill_id) do
-                raise ArgumentError.new("missing required path argument #{_1}")
-              end
+            skill_id = parsed.delete(:skill_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+
             @client.request(
               method: :get,
               path: ["skills/%1$s/versions/%2$s/content", skill_id, version],

data/lib/openai/resources/skills/versions.rb

@@ -54,10 +54,10 @@ module OpenAI
         # @see OpenAI::Models::Skills::VersionRetrieveParams
         def retrieve(version, params)
           parsed, options = OpenAI::Skills::VersionRetrieveParams.dump_request(params)
-          skill_id =
-            parsed.delete(:skill_id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
+          skill_id = parsed.delete(:skill_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+
           @client.request(
             method: :get,
             path: ["skills/%1$s/versions/%2$s", skill_id, version],
@@ -113,10 +113,10 @@ module OpenAI
         # @see OpenAI::Models::Skills::VersionDeleteParams
         def delete(version, params)
           parsed, options = OpenAI::Skills::VersionDeleteParams.dump_request(params)
-          skill_id =
-            parsed.delete(:skill_id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
+          skill_id = parsed.delete(:skill_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+
           @client.request(
             method: :delete,
             path: ["skills/%1$s/versions/%2$s", skill_id, version],

data/lib/openai/resources/vector_stores/file_batches.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../../helpers/resource_polling"
+
 module OpenAI
   module Resources
     class VectorStores
@@ -34,7 +36,70 @@ module OpenAI
             body: parsed,
             model: OpenAI::VectorStores::VectorStoreFileBatch,
             security: {bearer_auth: true},
-            options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
+            options: {
+              **options,
+              extra_headers: OpenAI::Internal::Util.normalized_headers(
+                {"OpenAI-Beta" => "assistants=v2"},
+                options[:extra_headers].to_h
+              )
+            }
+          )
+        end
+
+        # Create a vector store file batch and wait for processing to finish.
+        #
+        # The returned batch may have a `failed` or `cancelled` status; callers should
+        # inspect its status and file counts. Polling intervals and the overall timeout
+        # are in seconds. Finite timeouts include authentication and request replay
+        # time and disable transport retries so the deadline remains strict. Set
+        # `timeout` to `nil` to wait indefinitely and retain configured transport retries.
+        #
+        # @overload create_and_poll(vector_store_id, attributes: nil, chunking_strategy: nil, file_ids: nil, files: nil, poll_interval: nil, timeout: 1800.0, request_options: {})
+        #
+        # @param vector_store_id [String] The ID of the vector store for which to create a File Batch.
+        #
+        # @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Attributes to apply to each file in `file_ids`.
+        #
+        # @param chunking_strategy [OpenAI::Models::AutoFileChunkingStrategyParam, OpenAI::Models::StaticFileChunkingStrategyObjectParam] The chunking strategy used to chunk the files.
+        #
+        # @param file_ids [Array<String>] File IDs to add to the vector store.
+        #
+        # @param files [Array<OpenAI::Models::VectorStores::FileBatchCreateParams::File>] File IDs with per-file attributes or chunking strategies.
+        #
+        # @param poll_interval [Integer, Float, nil] How often to retrieve the batch. When omitted, the SDK honors the server's
+        #   polling hint and otherwise waits 5 seconds.
+        #
+        # @param timeout [Integer, Float, nil] Maximum total time to poll. Defaults to 30 minutes. Set to `nil` to wait
+        #   indefinitely.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @raise [ArgumentError, OpenAI::Errors::PollingError]
+        # @return [OpenAI::Models::VectorStores::VectorStoreFileBatch]
+        def create_and_poll(
+          vector_store_id,
+          attributes: nil,
+          chunking_strategy: nil,
+          file_ids: nil,
+          files: nil,
+          poll_interval: nil,
+          timeout: OpenAI::Internal::Poller::DEFAULT_TIMEOUT,
+          request_options: {}
+        )
+          OpenAI::Internal::Poller.validate!(poll_interval: poll_interval, timeout: timeout)
+
+          params = {request_options: request_options}
+          params[:attributes] = attributes unless attributes.nil?
+          params[:chunking_strategy] = chunking_strategy unless chunking_strategy.nil?
+          params[:file_ids] = file_ids unless file_ids.nil?
+          params[:files] = files unless files.nil?
+          batch = create(vector_store_id, params)
+          poll(
+            batch.id,
+            vector_store_id: vector_store_id,
+            poll_interval: poll_interval,
+            timeout: timeout,
+            request_options: request_options
           )
         end
 
@@ -53,10 +118,10 @@ module OpenAI
         # @see OpenAI::Models::VectorStores::FileBatchRetrieveParams
         def retrieve(batch_id, params)
           parsed, options = OpenAI::VectorStores::FileBatchRetrieveParams.dump_request(params)
-          vector_store_id =
-            parsed.delete(:vector_store_id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
+          vector_store_id = parsed.delete(:vector_store_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+
           @client.request(
             method: :get,
             path: ["vector_stores/%1$s/file_batches/%2$s", vector_store_id, batch_id],
@@ -82,10 +147,10 @@ module OpenAI
         # @see OpenAI::Models::VectorStores::FileBatchCancelParams
         def cancel(batch_id, params)
           parsed, options = OpenAI::VectorStores::FileBatchCancelParams.dump_request(params)
-          vector_store_id =
-            parsed.delete(:vector_store_id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
+          vector_store_id = parsed.delete(:vector_store_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+
           @client.request(
             method: :post,
             path: ["vector_stores/%1$s/file_batches/%2$s/cancel", vector_store_id, batch_id],
@@ -123,10 +188,10 @@ module OpenAI
         # @see OpenAI::Models::VectorStores::FileBatchListFilesParams
         def list_files(batch_id, params)
           parsed, options = OpenAI::VectorStores::FileBatchListFilesParams.dump_request(params)
-          vector_store_id =
-            parsed.delete(:vector_store_id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
+          vector_store_id = parsed.delete(:vector_store_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+
           query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
@@ -139,6 +204,125 @@ module OpenAI
           )
         end
 
+        # Wait for a vector store file batch to finish processing.
+        #
+        # The returned batch may have a `failed` or `cancelled` status; callers should
+        # inspect its status and file counts. Polling intervals and the overall timeout
+        # are in seconds. Set `timeout` to `nil` to wait indefinitely.
+        #
+        # @overload poll(batch_id, vector_store_id:, poll_interval: nil, timeout: 1800.0, request_options: {})
+        #
+        # @param batch_id [String] The ID of the file batch being retrieved.
+        #
+        # @param vector_store_id [String] The ID of the vector store that the file batch belongs to.
+        #
+        # @param poll_interval [Integer, Float, nil] How often to retrieve the batch. When omitted, the SDK honors the server's
+        #   polling hint and otherwise waits 5 seconds.
+        #
+        # @param timeout [Integer, Float, nil] Maximum total time to poll. Defaults to 30 minutes. Set to `nil` to wait
+        #   indefinitely.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @raise [ArgumentError, OpenAI::Errors::PollingError]
+        # @return [OpenAI::Models::VectorStores::VectorStoreFileBatch]
+        def poll(
+          batch_id,
+          vector_store_id:,
+          poll_interval: nil,
+          timeout: OpenAI::Internal::Poller::DEFAULT_TIMEOUT,
+          request_options: {}
+        )
+          OpenAI::Helpers::ResourcePolling.poll_vector_store_file_batch(
+            self,
+            batch_id,
+            vector_store_id: vector_store_id,
+            poll_interval: poll_interval,
+            timeout: timeout,
+            request_options: request_options
+          )
+        end
+
+        # Upload files concurrently, create a vector store file batch, and wait for
+        # processing to finish.
+        #
+        # Existing file IDs can be included alongside new uploads. Upload concurrency is
+        # bounded and defaults to 5. Set `max_concurrency` to 1 for sequential uploads.
+        # Inputs are enumerated before requests begin so the 2,000-file API limit can be
+        # checked without orphaning uploads. Stream-backed inputs are safely spooled during
+        # enumeration, including IO objects yielded from block-scoped enumerators.
+        #
+        # @overload upload_and_poll(vector_store_id, files:, file_ids: [], max_concurrency: 5, attributes: nil, chunking_strategy: nil, poll_interval: nil, timeout: 1800.0, request_options: {})
+        #
+        # @param vector_store_id [String] The ID of the vector store for which to create a File Batch.
+        #
+        # @param files [Enumerable<Pathname, StringIO, IO, String, OpenAI::FilePart>] Files to upload.
+        #
+        # @param file_ids [Array<String>] IDs of files that have already been uploaded.
+        #
+        # @param max_concurrency [Integer] Maximum number of simultaneous file uploads.
+        #
+        # @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Attributes to apply to every file.
+        #
+        # @param chunking_strategy [OpenAI::Models::AutoFileChunkingStrategyParam, OpenAI::Models::StaticFileChunkingStrategyObjectParam] The chunking strategy used to chunk the files.
+        #
+        # @param poll_interval [Integer, Float, nil] How often to retrieve the batch. When omitted, the SDK honors the server's
+        #   polling hint and otherwise waits 5 seconds.
+        #
+        # @param timeout [Integer, Float, nil] Maximum total time to poll. Defaults to 30 minutes. Set to `nil` to wait
+        #   indefinitely.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] Applied to every upload and to the
+        #   batch creation and polling requests. Idempotency keys are scoped to each
+        #   upload and the batch creation.
+        #
+        # @raise [ArgumentError, OpenAI::Errors::PollingError]
+        # @return [OpenAI::Models::VectorStores::VectorStoreFileBatch]
+        def upload_and_poll(
+          vector_store_id,
+          files:,
+          file_ids: [],
+          max_concurrency: 5,
+          attributes: nil,
+          chunking_strategy: nil,
+          poll_interval: nil,
+          timeout: OpenAI::Internal::Poller::DEFAULT_TIMEOUT,
+          request_options: {}
+        )
+          OpenAI::Internal::Poller.validate!(poll_interval: poll_interval, timeout: timeout)
+          request_options_scope = OpenAI::Internal::RequestOptionsScope.new(request_options)
+
+          max_files = OpenAI::Internal::VectorStoreFileUploader::MAX_FILES_PER_BATCH
+          if file_ids.length > max_files
+            raise ArgumentError, "`file_ids` cannot contain more than #{max_files} entries"
+          end
+
+          uploaded = OpenAI::Internal::VectorStoreFileUploader
+            .new(
+              client: @client,
+              max_concurrency: max_concurrency,
+              request_options: request_options
+            )
+            .upload(files, max_files: max_files - file_ids.length)
+
+          if uploaded.empty?
+            raise(
+              ArgumentError,
+              "No `files` provided. Use `create_and_poll` when all files are already uploaded."
+            )
+          end
+
+          create_and_poll(
+            vector_store_id,
+            file_ids: [*file_ids, *uploaded.map(&:id)],
+            attributes: attributes,
+            chunking_strategy: chunking_strategy,
+            poll_interval: poll_interval,
+            timeout: timeout,
+            request_options: request_options_scope.child("file-batch")
+          )
+        end
+
         # @api private
         #
         # @param client [OpenAI::Client]