openai 0.13.1 → 0.14.0

data/rbi/openai/models/image_edit_stream_event.rbi

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

data/rbi/openai/models/image_gen_completed_event.rbi

@@ -0,0 +1,339 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class ImageGenCompletedEvent < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::ImageGenCompletedEvent, OpenAI::Internal::AnyHash)
+        end
+
+      # Base64-encoded image data, suitable for rendering as an image.
+      sig { returns(String) }
+      attr_accessor :b64_json
+
+      # The background setting for the generated image.
+      sig { returns(OpenAI::ImageGenCompletedEvent::Background::TaggedSymbol) }
+      attr_accessor :background
+
+      # The Unix timestamp when the event was created.
+      sig { returns(Integer) }
+      attr_accessor :created_at
+
+      # The output format for the generated image.
+      sig do
+        returns(OpenAI::ImageGenCompletedEvent::OutputFormat::TaggedSymbol)
+      end
+      attr_accessor :output_format
+
+      # The quality setting for the generated image.
+      sig { returns(OpenAI::ImageGenCompletedEvent::Quality::TaggedSymbol) }
+      attr_accessor :quality
+
+      # The size of the generated image.
+      sig { returns(OpenAI::ImageGenCompletedEvent::Size::TaggedSymbol) }
+      attr_accessor :size
+
+      # The type of the event. Always `image_generation.completed`.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # For `gpt-image-1` only, the token usage information for the image generation.
+      sig { returns(OpenAI::ImageGenCompletedEvent::Usage) }
+      attr_reader :usage
+
+      sig { params(usage: OpenAI::ImageGenCompletedEvent::Usage::OrHash).void }
+      attr_writer :usage
+
+      # Emitted when image generation has completed and the final image is available.
+      sig do
+        params(
+          b64_json: String,
+          background: OpenAI::ImageGenCompletedEvent::Background::OrSymbol,
+          created_at: Integer,
+          output_format: OpenAI::ImageGenCompletedEvent::OutputFormat::OrSymbol,
+          quality: OpenAI::ImageGenCompletedEvent::Quality::OrSymbol,
+          size: OpenAI::ImageGenCompletedEvent::Size::OrSymbol,
+          usage: OpenAI::ImageGenCompletedEvent::Usage::OrHash,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Base64-encoded image data, suitable for rendering as an image.
+        b64_json:,
+        # The background setting for the generated image.
+        background:,
+        # The Unix timestamp when the event was created.
+        created_at:,
+        # The output format for the generated image.
+        output_format:,
+        # The quality setting for the generated image.
+        quality:,
+        # The size of the generated image.
+        size:,
+        # For `gpt-image-1` only, the token usage information for the image generation.
+        usage:,
+        # The type of the event. Always `image_generation.completed`.
+        type: :"image_generation.completed"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            b64_json: String,
+            background:
+              OpenAI::ImageGenCompletedEvent::Background::TaggedSymbol,
+            created_at: Integer,
+            output_format:
+              OpenAI::ImageGenCompletedEvent::OutputFormat::TaggedSymbol,
+            quality: OpenAI::ImageGenCompletedEvent::Quality::TaggedSymbol,
+            size: OpenAI::ImageGenCompletedEvent::Size::TaggedSymbol,
+            type: Symbol,
+            usage: OpenAI::ImageGenCompletedEvent::Usage
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The background setting for the generated image.
+      module Background
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, OpenAI::ImageGenCompletedEvent::Background)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRANSPARENT =
+          T.let(
+            :transparent,
+            OpenAI::ImageGenCompletedEvent::Background::TaggedSymbol
+          )
+        OPAQUE =
+          T.let(
+            :opaque,
+            OpenAI::ImageGenCompletedEvent::Background::TaggedSymbol
+          )
+        AUTO =
+          T.let(:auto, OpenAI::ImageGenCompletedEvent::Background::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImageGenCompletedEvent::Background::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The output format for the generated image.
+      module OutputFormat
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, OpenAI::ImageGenCompletedEvent::OutputFormat)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PNG =
+          T.let(
+            :png,
+            OpenAI::ImageGenCompletedEvent::OutputFormat::TaggedSymbol
+          )
+        WEBP =
+          T.let(
+            :webp,
+            OpenAI::ImageGenCompletedEvent::OutputFormat::TaggedSymbol
+          )
+        JPEG =
+          T.let(
+            :jpeg,
+            OpenAI::ImageGenCompletedEvent::OutputFormat::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImageGenCompletedEvent::OutputFormat::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The quality setting for the generated image.
+      module Quality
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, OpenAI::ImageGenCompletedEvent::Quality)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOW = T.let(:low, OpenAI::ImageGenCompletedEvent::Quality::TaggedSymbol)
+        MEDIUM =
+          T.let(:medium, OpenAI::ImageGenCompletedEvent::Quality::TaggedSymbol)
+        HIGH =
+          T.let(:high, OpenAI::ImageGenCompletedEvent::Quality::TaggedSymbol)
+        AUTO =
+          T.let(:auto, OpenAI::ImageGenCompletedEvent::Quality::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImageGenCompletedEvent::Quality::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The size of the generated image.
+      module Size
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::ImageGenCompletedEvent::Size) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SIZE_1024X1024 =
+          T.let(
+            :"1024x1024",
+            OpenAI::ImageGenCompletedEvent::Size::TaggedSymbol
+          )
+        SIZE_1024X1536 =
+          T.let(
+            :"1024x1536",
+            OpenAI::ImageGenCompletedEvent::Size::TaggedSymbol
+          )
+        SIZE_1536X1024 =
+          T.let(
+            :"1536x1024",
+            OpenAI::ImageGenCompletedEvent::Size::TaggedSymbol
+          )
+        AUTO = T.let(:auto, OpenAI::ImageGenCompletedEvent::Size::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImageGenCompletedEvent::Size::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Usage < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::ImageGenCompletedEvent::Usage,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The number of tokens (images and text) in the input prompt.
+        sig { returns(Integer) }
+        attr_accessor :input_tokens
+
+        # The input tokens detailed information for the image generation.
+        sig do
+          returns(OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails)
+        end
+        attr_reader :input_tokens_details
+
+        sig do
+          params(
+            input_tokens_details:
+              OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails::OrHash
+          ).void
+        end
+        attr_writer :input_tokens_details
+
+        # The number of image tokens in the output image.
+        sig { returns(Integer) }
+        attr_accessor :output_tokens
+
+        # The total number of tokens (images and text) used for the image generation.
+        sig { returns(Integer) }
+        attr_accessor :total_tokens
+
+        # For `gpt-image-1` only, the token usage information for the image generation.
+        sig do
+          params(
+            input_tokens: Integer,
+            input_tokens_details:
+              OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails::OrHash,
+            output_tokens: Integer,
+            total_tokens: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The number of tokens (images and text) in the input prompt.
+          input_tokens:,
+          # The input tokens detailed information for the image generation.
+          input_tokens_details:,
+          # The number of image tokens in the output image.
+          output_tokens:,
+          # The total number of tokens (images and text) used for the image generation.
+          total_tokens:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              input_tokens: Integer,
+              input_tokens_details:
+                OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails,
+              output_tokens: Integer,
+              total_tokens: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The number of image tokens in the input prompt.
+          sig { returns(Integer) }
+          attr_accessor :image_tokens
+
+          # The number of text tokens in the input prompt.
+          sig { returns(Integer) }
+          attr_accessor :text_tokens
+
+          # The input tokens detailed information for the image generation.
+          sig do
+            params(image_tokens: Integer, text_tokens: Integer).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The number of image tokens in the input prompt.
+            image_tokens:,
+            # The number of text tokens in the input prompt.
+            text_tokens:
+          )
+          end
+
+          sig do
+            override.returns({ image_tokens: Integer, text_tokens: Integer })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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,12 @@ 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.
+      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 +122,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 +162,10 @@ 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.
+        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 +210,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/responses/response_output_refusal.rbi

@@ -12,7 +12,7 @@ module OpenAI
             )
           end
 
-        # The refusal explanationfrom the model.
+        # The refusal explanation from the model.
         sig { returns(String) }
         attr_accessor :refusal
 
@@ -23,7 +23,7 @@ module OpenAI
         # A refusal from the model.
         sig { params(refusal: String, type: Symbol).returns(T.attached_class) }
         def self.new(
-          # The refusal explanationfrom the model.
+          # The refusal explanation from the model.
           refusal:,
           # The type of the refusal. Always `refusal`.
           type: :refusal