openai 0.14.0 → 0.15.0

data/lib/openai/models/responses/response_text_delta_event.rb

@@ -22,6 +22,13 @@ module OpenAI
         #   @return [String]
         required :item_id, String
 
+        # @!attribute logprobs
+        #   The log probabilities of the tokens in the delta.
+        #
+        #   @return [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob>]
+        required :logprobs,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDeltaEvent::Logprob] }
+
         # @!attribute output_index
         #   The index of the output item that the text delta was added to.
         #
@@ -40,7 +47,7 @@ module OpenAI
         #   @return [Symbol, :"response.output_text.delta"]
         required :type, const: :"response.output_text.delta"
 
-        # @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, type: :"response.output_text.delta")
+        # @!method initialize(content_index:, delta:, item_id:, logprobs:, output_index:, sequence_number:, type: :"response.output_text.delta")
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseTextDeltaEvent} for more details.
         #
@@ -52,11 +59,69 @@ module OpenAI
         #
         #   @param item_id [String] The ID of the output item that the text delta was added to.
         #
+        #   @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob>] The log probabilities of the tokens in the delta.
+        #
         #   @param output_index [Integer] The index of the output item that the text delta was added to.
         #
         #   @param sequence_number [Integer] The sequence number for this event.
         #
         #   @param type [Symbol, :"response.output_text.delta"] The type of the event. Always `response.output_text.delta`.
+
+        class Logprob < OpenAI::Internal::Type::BaseModel
+          # @!attribute token
+          #   A possible text token.
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute logprob
+          #   The log probability of this token.
+          #
+          #   @return [Float]
+          required :logprob, Float
+
+          # @!attribute top_logprobs
+          #   The log probability of the top 20 most likely tokens.
+          #
+          #   @return [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob>, nil]
+          optional :top_logprobs,
+                   -> {
+                     OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob]
+                   }
+
+          # @!method initialize(token:, logprob:, top_logprobs: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob} for more details.
+          #
+          #   A logprob is the logarithmic probability that the model assigns to producing a
+          #   particular token at a given position in the sequence. Less-negative (higher)
+          #   logprob values indicate greater model confidence in that token choice.
+          #
+          #   @param token [String] A possible text token.
+          #
+          #   @param logprob [Float] The log probability of this token.
+          #
+          #   @param top_logprobs [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob>] The log probability of the top 20 most likely tokens.
+
+          class TopLogprob < OpenAI::Internal::Type::BaseModel
+            # @!attribute token
+            #   A possible text token.
+            #
+            #   @return [String, nil]
+            optional :token, String
+
+            # @!attribute logprob
+            #   The log probability of this token.
+            #
+            #   @return [Float, nil]
+            optional :logprob, Float
+
+            # @!method initialize(token: nil, logprob: nil)
+            #   @param token [String] A possible text token.
+            #
+            #   @param logprob [Float] The log probability of this token.
+          end
+        end
       end
     end
   end

data/lib/openai/models/responses/response_text_done_event.rb

@@ -16,6 +16,13 @@ module OpenAI
         #   @return [String]
         required :item_id, String
 
+        # @!attribute logprobs
+        #   The log probabilities of the tokens in the delta.
+        #
+        #   @return [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>]
+        required :logprobs,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDoneEvent::Logprob] }
+
         # @!attribute output_index
         #   The index of the output item that the text content is finalized.
         #
@@ -40,7 +47,7 @@ module OpenAI
         #   @return [Symbol, :"response.output_text.done"]
         required :type, const: :"response.output_text.done"
 
-        # @!method initialize(content_index:, item_id:, output_index:, sequence_number:, text:, type: :"response.output_text.done")
+        # @!method initialize(content_index:, item_id:, logprobs:, output_index:, sequence_number:, text:, type: :"response.output_text.done")
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseTextDoneEvent} for more details.
         #
@@ -50,6 +57,8 @@ module OpenAI
         #
         #   @param item_id [String] The ID of the output item that the text content is finalized.
         #
+        #   @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>] The log probabilities of the tokens in the delta.
+        #
         #   @param output_index [Integer] The index of the output item that the text content is finalized.
         #
         #   @param sequence_number [Integer] The sequence number for this event.
@@ -57,6 +66,62 @@ module OpenAI
         #   @param text [String] The text content that is finalized.
         #
         #   @param type [Symbol, :"response.output_text.done"] The type of the event. Always `response.output_text.done`.
+
+        class Logprob < OpenAI::Internal::Type::BaseModel
+          # @!attribute token
+          #   A possible text token.
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute logprob
+          #   The log probability of this token.
+          #
+          #   @return [Float]
+          required :logprob, Float
+
+          # @!attribute top_logprobs
+          #   The log probability of the top 20 most likely tokens.
+          #
+          #   @return [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob::TopLogprob>, nil]
+          optional :top_logprobs,
+                   -> {
+                     OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDoneEvent::Logprob::TopLogprob]
+                   }
+
+          # @!method initialize(token:, logprob:, top_logprobs: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob} for more details.
+          #
+          #   A logprob is the logarithmic probability that the model assigns to producing a
+          #   particular token at a given position in the sequence. Less-negative (higher)
+          #   logprob values indicate greater model confidence in that token choice.
+          #
+          #   @param token [String] A possible text token.
+          #
+          #   @param logprob [Float] The log probability of this token.
+          #
+          #   @param top_logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob::TopLogprob>] The log probability of the top 20 most likely tokens.
+
+          class TopLogprob < OpenAI::Internal::Type::BaseModel
+            # @!attribute token
+            #   A possible text token.
+            #
+            #   @return [String, nil]
+            optional :token, String
+
+            # @!attribute logprob
+            #   The log probability of this token.
+            #
+            #   @return [Float, nil]
+            optional :logprob, Float
+
+            # @!method initialize(token: nil, logprob: nil)
+            #   @param token [String] A possible text token.
+            #
+            #   @param logprob [Float] The log probability of this token.
+          end
+        end
       end
     end
   end

data/lib/openai/resources/images.rb

@@ -39,7 +39,7 @@ module OpenAI
         )
       end
 
-      # See {OpenAI::Resources::Images#stream_raw} for streaming counterpart.
+      # See {OpenAI::Resources::Images#edit_stream_raw} for streaming counterpart.
       #
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::ImageEditParams} for more details.
@@ -85,7 +85,7 @@ module OpenAI
       def edit(params)
         parsed, options = OpenAI::ImageEditParams.dump_request(params)
         if parsed[:stream]
-          message = "Please use `#stream_raw` for the streaming use case."
+          message = "Please use `#edit_stream_raw` for the streaming use case."
           raise ArgumentError.new(message)
         end
         @client.request(
@@ -106,7 +106,7 @@ module OpenAI
       # Creates an edited or extended image given one or more source images and a
       # prompt. This endpoint only supports `gpt-image-1` and `dall-e-2`.
       #
-      # @overload stream_raw(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
+      # @overload edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>] The image(s) to edit. Must be a supported image file or an array of images.
       #
@@ -159,7 +159,7 @@ module OpenAI
         )
       end
 
-      # See {OpenAI::Resources::Images#stream_raw} for streaming counterpart.
+      # See {OpenAI::Resources::Images#generate_stream_raw} for streaming counterpart.
       #
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::ImageGenerateParams} for more details.
@@ -203,7 +203,7 @@ module OpenAI
       def generate(params)
         parsed, options = OpenAI::ImageGenerateParams.dump_request(params)
         if parsed[:stream]
-          message = "Please use `#stream_raw` for the streaming use case."
+          message = "Please use `#generate_stream_raw` for the streaming use case."
           raise ArgumentError.new(message)
         end
         @client.request(
@@ -223,7 +223,7 @@ module OpenAI
       # Creates an image given a prompt.
       # [Learn more](https://platform.openai.com/docs/guides/images).
       #
-      # @overload stream_raw(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
+      # @overload generate_stream_raw(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
       #
       # @param prompt [String] A text description of the desired image(s). The maximum length is 32000 characte
       #

data/lib/openai/resources/responses.rb

@@ -270,7 +270,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::ResponseReasoningDeltaEvent, OpenAI::Models::Responses::ResponseReasoningDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent>]
+      # @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::ResponseReasoningSummaryDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent>]
       #
       # @see OpenAI::Models::Responses::ResponseCreateParams
       def stream_raw(params = {})
@@ -344,7 +344,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::ResponseReasoningDeltaEvent, OpenAI::Models::Responses::ResponseReasoningDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent>]
+      # @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::ResponseReasoningSummaryDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent>]
       #
       # @see OpenAI::Models::Responses::ResponseRetrieveParams
       def retrieve_streaming(response_id, params = {})

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -425,8 +425,6 @@ require_relative "openai/models/responses/response_output_text"
 require_relative "openai/models/responses/response_output_text_annotation_added_event"
 require_relative "openai/models/responses/response_prompt"
 require_relative "openai/models/responses/response_queued_event"
-require_relative "openai/models/responses/response_reasoning_delta_event"
-require_relative "openai/models/responses/response_reasoning_done_event"
 require_relative "openai/models/responses/response_reasoning_item"
 require_relative "openai/models/responses/response_reasoning_summary_delta_event"
 require_relative "openai/models/responses/response_reasoning_summary_done_event"

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

@@ -216,15 +216,6 @@ module OpenAI
             )
           ECHO =
             T.let(:echo, OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol)
-          FABLE =
-            T.let(
-              :fable,
-              OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol
-            )
-          ONYX =
-            T.let(:onyx, OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol)
-          NOVA =
-            T.let(:nova, OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol)
           SAGE =
             T.let(:sage, OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol)
           SHIMMER =

data/rbi/openai/models/chat/chat_completion.rbi

@@ -37,7 +37,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service
@@ -103,7 +103,7 @@ module OpenAI
           # - If set to 'auto', then the request will be processed with the service tier
           #   configured in the Project settings. Unless otherwise configured, the Project
           #   will use 'default'.
-          # - If set to 'default', then the requset will be processed with the standard
+          # - If set to 'default', then the request will be processed with the standard
           #   pricing and performance for the selected model.
           # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
           #   'priority', then the request will be processed with the corresponding service
@@ -368,7 +368,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/rbi/openai/models/chat/chat_completion_audio_param.rbi

@@ -176,21 +176,6 @@ module OpenAI
               :echo,
               OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
             )
-          FABLE =
-            T.let(
-              :fable,
-              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
-            )
-          ONYX =
-            T.let(
-              :onyx,
-              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
-            )
-          NOVA =
-            T.let(
-              :nova,
-              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
-            )
           SAGE =
             T.let(
               :sage,

data/rbi/openai/models/chat/chat_completion_chunk.rbi

@@ -39,7 +39,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service
@@ -118,7 +118,7 @@ module OpenAI
           # - If set to 'auto', then the request will be processed with the service tier
           #   configured in the Project settings. Unless otherwise configured, the Project
           #   will use 'default'.
-          # - If set to 'default', then the requset will be processed with the standard
+          # - If set to 'default', then the request will be processed with the standard
           #   pricing and performance for the selected model.
           # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
           #   'priority', then the request will be processed with the corresponding service
@@ -788,7 +788,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/rbi/openai/models/chat/completion_create_params.rbi

@@ -275,7 +275,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service
@@ -632,7 +632,7 @@ module OpenAI
           # - If set to 'auto', then the request will be processed with the service tier
           #   configured in the Project settings. Unless otherwise configured, the Project
           #   will use 'default'.
-          # - If set to 'default', then the requset will be processed with the standard
+          # - If set to 'default', then the request will be processed with the standard
           #   pricing and performance for the selected model.
           # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
           #   'priority', then the request will be processed with the corresponding service
@@ -1017,7 +1017,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/rbi/openai/models/function_definition.rbi

@@ -38,7 +38,7 @@ module OpenAI
       # set to true, the model will follow the exact schema defined in the `parameters`
       # field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
       # more about Structured Outputs in the
-      # [function calling guide](docs/guides/function-calling).
+      # [function calling guide](https://platform.openai.com/docs/guides/function-calling).
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :strict
 
@@ -69,7 +69,7 @@ module OpenAI
         # set to true, the model will follow the exact schema defined in the `parameters`
         # field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
         # more about Structured Outputs in the
-        # [function calling guide](docs/guides/function-calling).
+        # [function calling guide](https://platform.openai.com/docs/guides/function-calling).
         strict: nil
       )
       end

data/rbi/openai/models/image_edit_params.rbi

@@ -81,6 +81,9 @@ module OpenAI
       # The number of partial images to generate. This parameter is used for streaming
       # responses that return partial images. Value must be between 0 and 3. When set to
       # 0, the response will be a single image sent in one streaming event.
+      #
+      # Note that the final image may be sent before the full number of partial images
+      # are generated if the full image is generated more quickly.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :partial_images
 
@@ -182,6 +185,9 @@ module OpenAI
         # The number of partial images to generate. This parameter is used for streaming
         # responses that return partial images. Value must be between 0 and 3. When set to
         # 0, the response will be a single image sent in one streaming event.
+        #
+        # Note that the final image may be sent before the full number of partial images
+        # are generated if the full image is generated more quickly.
         partial_images: nil,
         # The quality of the image that will be generated. `high`, `medium` and `low` are
         # only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality.

data/rbi/openai/models/image_generate_params.rbi

@@ -63,6 +63,9 @@ module OpenAI
       # The number of partial images to generate. This parameter is used for streaming
       # responses that return partial images. Value must be between 0 and 3. When set to
       # 0, the response will be a single image sent in one streaming event.
+      #
+      # Note that the final image may be sent before the full number of partial images
+      # are generated if the full image is generated more quickly.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :partial_images
 
@@ -165,6 +168,9 @@ module OpenAI
         # The number of partial images to generate. This parameter is used for streaming
         # responses that return partial images. Value must be between 0 and 3. When set to
         # 0, the response will be a single image sent in one streaming event.
+        #
+        # Note that the final image may be sent before the full number of partial images
+        # are generated if the full image is generated more quickly.
         partial_images: nil,
         # The quality of the image that will be generated.
         #

data/rbi/openai/models/images_response.rbi

@@ -224,7 +224,7 @@ module OpenAI
         end
         attr_writer :input_tokens_details
 
-        # The number of image tokens in the output image.
+        # The number of output tokens generated by the model.
         sig { returns(Integer) }
         attr_accessor :output_tokens
 
@@ -247,7 +247,7 @@ module OpenAI
           input_tokens:,
           # The input tokens detailed information for the image generation.
           input_tokens_details:,
-          # The number of image tokens in the output image.
+          # The number of output tokens generated by the model.
           output_tokens:,
           # The total number of tokens (images and text) used for the image generation.
           total_tokens:

data/rbi/openai/models/responses/response.rbi

@@ -180,7 +180,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service
@@ -427,7 +427,7 @@ module OpenAI
           # - If set to 'auto', then the request will be processed with the service tier
           #   configured in the Project settings. Unless otherwise configured, the Project
           #   will use 'default'.
-          # - If set to 'default', then the requset will be processed with the standard
+          # - If set to 'default', then the request will be processed with the standard
           #   pricing and performance for the selected model.
           # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
           #   'priority', then the request will be processed with the corresponding service
@@ -666,7 +666,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/rbi/openai/models/responses/response_code_interpreter_tool_call.rbi

@@ -40,7 +40,8 @@ module OpenAI
         end
         attr_accessor :outputs
 
-        # The status of the code interpreter tool call.
+        # The status of the code interpreter tool call. Valid values are `in_progress`,
+        # `completed`, `incomplete`, `interpreting`, and `failed`.
         sig do
           returns(
             OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::OrSymbol
@@ -82,7 +83,8 @@ module OpenAI
           # The outputs generated by the code interpreter, such as logs or images. Can be
           # null if no outputs are available.
           outputs:,
-          # The status of the code interpreter tool call.
+          # The status of the code interpreter tool call. Valid values are `in_progress`,
+          # `completed`, `incomplete`, `interpreting`, and `failed`.
           status:,
           # The type of the code interpreter tool call. Always `code_interpreter_call`.
           type: :code_interpreter_call
@@ -200,7 +202,8 @@ module OpenAI
           end
         end
 
-        # The status of the code interpreter tool call.
+        # The status of the code interpreter tool call. Valid values are `in_progress`,
+        # `completed`, `incomplete`, `interpreting`, and `failed`.
         module Status
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/responses/response_create_params.rbi

@@ -163,7 +163,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service
@@ -472,7 +472,7 @@ module OpenAI
           # - If set to 'auto', then the request will be processed with the service tier
           #   configured in the Project settings. Unless otherwise configured, the Project
           #   will use 'default'.
-          # - If set to 'default', then the requset will be processed with the standard
+          # - If set to 'default', then the request will be processed with the standard
           #   pricing and performance for the selected model.
           # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
           #   'priority', then the request will be processed with the corresponding service
@@ -640,7 +640,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/rbi/openai/models/responses/response_mcp_call_arguments_delta_event.rbi

@@ -12,8 +12,9 @@ module OpenAI
             )
           end
 
-        # The partial update to the arguments for the MCP tool call.
-        sig { returns(T.anything) }
+        # A JSON string containing the partial update to the arguments for the MCP tool
+        # call.
+        sig { returns(String) }
         attr_accessor :delta
 
         # The unique identifier of the MCP tool call item being processed.
@@ -36,7 +37,7 @@ module OpenAI
         # call.
         sig do
           params(
-            delta: T.anything,
+            delta: String,
             item_id: String,
             output_index: Integer,
             sequence_number: Integer,
@@ -44,7 +45,8 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The partial update to the arguments for the MCP tool call.
+          # A JSON string containing the partial update to the arguments for the MCP tool
+          # call.
           delta:,
           # The unique identifier of the MCP tool call item being processed.
           item_id:,
@@ -60,7 +62,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              delta: T.anything,
+              delta: String,
               item_id: String,
               output_index: Integer,
               sequence_number: Integer,