openai 0.13.1 → 0.15.0

data/rbi/openai/models/image_gen_partial_image_event.rbi

@@ -0,0 +1,243 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class ImageGenPartialImageEvent < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::ImageGenPartialImageEvent, OpenAI::Internal::AnyHash)
+        end
+
+      # Base64-encoded partial image data, suitable for rendering as an image.
+      sig { returns(String) }
+      attr_accessor :b64_json
+
+      # The background setting for the requested image.
+      sig do
+        returns(OpenAI::ImageGenPartialImageEvent::Background::TaggedSymbol)
+      end
+      attr_accessor :background
+
+      # The Unix timestamp when the event was created.
+      sig { returns(Integer) }
+      attr_accessor :created_at
+
+      # The output format for the requested image.
+      sig do
+        returns(OpenAI::ImageGenPartialImageEvent::OutputFormat::TaggedSymbol)
+      end
+      attr_accessor :output_format
+
+      # 0-based index for the partial image (streaming).
+      sig { returns(Integer) }
+      attr_accessor :partial_image_index
+
+      # The quality setting for the requested image.
+      sig { returns(OpenAI::ImageGenPartialImageEvent::Quality::TaggedSymbol) }
+      attr_accessor :quality
+
+      # The size of the requested image.
+      sig { returns(OpenAI::ImageGenPartialImageEvent::Size::TaggedSymbol) }
+      attr_accessor :size
+
+      # The type of the event. Always `image_generation.partial_image`.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Emitted when a partial image is available during image generation streaming.
+      sig do
+        params(
+          b64_json: String,
+          background: OpenAI::ImageGenPartialImageEvent::Background::OrSymbol,
+          created_at: Integer,
+          output_format:
+            OpenAI::ImageGenPartialImageEvent::OutputFormat::OrSymbol,
+          partial_image_index: Integer,
+          quality: OpenAI::ImageGenPartialImageEvent::Quality::OrSymbol,
+          size: OpenAI::ImageGenPartialImageEvent::Size::OrSymbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Base64-encoded partial image data, suitable for rendering as an image.
+        b64_json:,
+        # The background setting for the requested image.
+        background:,
+        # The Unix timestamp when the event was created.
+        created_at:,
+        # The output format for the requested image.
+        output_format:,
+        # 0-based index for the partial image (streaming).
+        partial_image_index:,
+        # The quality setting for the requested image.
+        quality:,
+        # The size of the requested image.
+        size:,
+        # The type of the event. Always `image_generation.partial_image`.
+        type: :"image_generation.partial_image"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            b64_json: String,
+            background:
+              OpenAI::ImageGenPartialImageEvent::Background::TaggedSymbol,
+            created_at: Integer,
+            output_format:
+              OpenAI::ImageGenPartialImageEvent::OutputFormat::TaggedSymbol,
+            partial_image_index: Integer,
+            quality: OpenAI::ImageGenPartialImageEvent::Quality::TaggedSymbol,
+            size: OpenAI::ImageGenPartialImageEvent::Size::TaggedSymbol,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The background setting for the requested image.
+      module Background
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, OpenAI::ImageGenPartialImageEvent::Background)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRANSPARENT =
+          T.let(
+            :transparent,
+            OpenAI::ImageGenPartialImageEvent::Background::TaggedSymbol
+          )
+        OPAQUE =
+          T.let(
+            :opaque,
+            OpenAI::ImageGenPartialImageEvent::Background::TaggedSymbol
+          )
+        AUTO =
+          T.let(
+            :auto,
+            OpenAI::ImageGenPartialImageEvent::Background::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              OpenAI::ImageGenPartialImageEvent::Background::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The output format for the requested image.
+      module OutputFormat
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, OpenAI::ImageGenPartialImageEvent::OutputFormat)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PNG =
+          T.let(
+            :png,
+            OpenAI::ImageGenPartialImageEvent::OutputFormat::TaggedSymbol
+          )
+        WEBP =
+          T.let(
+            :webp,
+            OpenAI::ImageGenPartialImageEvent::OutputFormat::TaggedSymbol
+          )
+        JPEG =
+          T.let(
+            :jpeg,
+            OpenAI::ImageGenPartialImageEvent::OutputFormat::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              OpenAI::ImageGenPartialImageEvent::OutputFormat::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The quality setting for the requested image.
+      module Quality
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, OpenAI::ImageGenPartialImageEvent::Quality)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOW =
+          T.let(:low, OpenAI::ImageGenPartialImageEvent::Quality::TaggedSymbol)
+        MEDIUM =
+          T.let(
+            :medium,
+            OpenAI::ImageGenPartialImageEvent::Quality::TaggedSymbol
+          )
+        HIGH =
+          T.let(:high, OpenAI::ImageGenPartialImageEvent::Quality::TaggedSymbol)
+        AUTO =
+          T.let(:auto, OpenAI::ImageGenPartialImageEvent::Quality::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImageGenPartialImageEvent::Quality::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The size of the requested image.
+      module Size
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, OpenAI::ImageGenPartialImageEvent::Size)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SIZE_1024X1024 =
+          T.let(
+            :"1024x1024",
+            OpenAI::ImageGenPartialImageEvent::Size::TaggedSymbol
+          )
+        SIZE_1024X1536 =
+          T.let(
+            :"1024x1536",
+            OpenAI::ImageGenPartialImageEvent::Size::TaggedSymbol
+          )
+        SIZE_1536X1024 =
+          T.let(
+            :"1536x1024",
+            OpenAI::ImageGenPartialImageEvent::Size::TaggedSymbol
+          )
+        AUTO =
+          T.let(:auto, OpenAI::ImageGenPartialImageEvent::Size::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImageGenPartialImageEvent::Size::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/image_gen_stream_event.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    # Emitted when a partial image is available during image generation streaming.
+    module ImageGenStreamEvent
+      extend OpenAI::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            OpenAI::ImageGenPartialImageEvent,
+            OpenAI::ImageGenCompletedEvent
+          )
+        end
+
+      sig { override.returns(T::Array[OpenAI::ImageGenStreamEvent::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/openai/models/image_generate_params.rbi

@@ -60,6 +60,15 @@ module OpenAI
       end
       attr_accessor :output_format
 
+      # 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
+
       # The quality of the image that will be generated.
       #
       # - `auto` (default value) will automatically select the best quality for the
@@ -116,6 +125,7 @@ module OpenAI
           output_compression: T.nilable(Integer),
           output_format:
             T.nilable(OpenAI::ImageGenerateParams::OutputFormat::OrSymbol),
+          partial_images: T.nilable(Integer),
           quality: T.nilable(OpenAI::ImageGenerateParams::Quality::OrSymbol),
           response_format:
             T.nilable(OpenAI::ImageGenerateParams::ResponseFormat::OrSymbol),
@@ -155,6 +165,13 @@ module OpenAI
         # The format in which the generated images are returned. This parameter is only
         # supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`.
         output_format: nil,
+        # 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.
         #
         # - `auto` (default value) will automatically select the best quality for the
@@ -199,6 +216,7 @@ module OpenAI
             output_compression: T.nilable(Integer),
             output_format:
               T.nilable(OpenAI::ImageGenerateParams::OutputFormat::OrSymbol),
+            partial_images: T.nilable(Integer),
             quality: T.nilable(OpenAI::ImageGenerateParams::Quality::OrSymbol),
             response_format:
               T.nilable(OpenAI::ImageGenerateParams::ResponseFormat::OrSymbol),

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,

data/rbi/openai/models/responses/response_mcp_call_arguments_done_event.rbi

@@ -12,8 +12,8 @@ module OpenAI
             )
           end
 
-        # The finalized arguments for the MCP tool call.
-        sig { returns(T.anything) }
+        # A JSON string containing the finalized arguments for the MCP tool call.
+        sig { returns(String) }
         attr_accessor :arguments
 
         # The unique identifier of the MCP tool call item being processed.
@@ -35,7 +35,7 @@ module OpenAI
         # Emitted when the arguments for an MCP tool call are finalized.
         sig do
           params(
-            arguments: T.anything,
+            arguments: String,
             item_id: String,
             output_index: Integer,
             sequence_number: Integer,
@@ -43,7 +43,7 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The finalized arguments for the MCP tool call.
+          # A JSON string containing the finalized arguments for the MCP tool call.
           arguments:,
           # The unique identifier of the MCP tool call item being processed.
           item_id:,
@@ -59,7 +59,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              arguments: T.anything,
+              arguments: String,
               item_id: String,
               output_index: Integer,
               sequence_number: Integer,

data/rbi/openai/models/responses/response_mcp_call_completed_event.rbi

@@ -12,6 +12,14 @@ module OpenAI
             )
           end
 
+        # The ID of the MCP tool call item that completed.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that completed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
         # The sequence number of this event.
         sig { returns(Integer) }
         attr_accessor :sequence_number
@@ -22,11 +30,18 @@ module OpenAI
 
         # Emitted when an MCP tool call has completed successfully.
         sig do
-          params(sequence_number: Integer, type: Symbol).returns(
-            T.attached_class
-          )
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
+          # The ID of the MCP tool call item that completed.
+          item_id:,
+          # The index of the output item that completed.
+          output_index:,
           # The sequence number of this event.
           sequence_number:,
           # The type of the event. Always 'response.mcp_call.completed'.
@@ -34,7 +49,16 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ sequence_number: Integer, type: Symbol }) }
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/responses/response_mcp_call_failed_event.rbi

@@ -12,6 +12,14 @@ module OpenAI
             )
           end
 
+        # The ID of the MCP tool call item that failed.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that failed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
         # The sequence number of this event.
         sig { returns(Integer) }
         attr_accessor :sequence_number
@@ -22,11 +30,18 @@ module OpenAI
 
         # Emitted when an MCP tool call has failed.
         sig do
-          params(sequence_number: Integer, type: Symbol).returns(
-            T.attached_class
-          )
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
+          # The ID of the MCP tool call item that failed.
+          item_id:,
+          # The index of the output item that failed.
+          output_index:,
           # The sequence number of this event.
           sequence_number:,
           # The type of the event. Always 'response.mcp_call.failed'.
@@ -34,7 +49,16 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ sequence_number: Integer, type: Symbol }) }
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/responses/response_mcp_list_tools_completed_event.rbi

@@ -12,6 +12,14 @@ module OpenAI
             )
           end
 
+        # The ID of the MCP tool call item that produced this output.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that was processed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
         # The sequence number of this event.
         sig { returns(Integer) }
         attr_accessor :sequence_number
@@ -22,11 +30,18 @@ module OpenAI
 
         # Emitted when the list of available MCP tools has been successfully retrieved.
         sig do
-          params(sequence_number: Integer, type: Symbol).returns(
-            T.attached_class
-          )
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
+          # The ID of the MCP tool call item that produced this output.
+          item_id:,
+          # The index of the output item that was processed.
+          output_index:,
           # The sequence number of this event.
           sequence_number:,
           # The type of the event. Always 'response.mcp_list_tools.completed'.
@@ -34,7 +49,16 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ sequence_number: Integer, type: Symbol }) }
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol
+            }
+          )
+        end
         def to_hash
         end
       end