openai 0.3.0 → 0.4.0.pre.beta.1

data/lib/openai/models/image_edit_params.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Images#edit
+    class ImageEditParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!attribute image
+      #   The image(s) to edit. Must be a supported image file or an array of images.
+      #
+      #   For `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less than
+      #   25MB. You can provide up to 16 images.
+      #
+      #   For `dall-e-2`, you can only provide one image, and it should be a square `png`
+      #   file less than 4MB.
+      #
+      #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
+      required :image, union: -> { OpenAI::ImageEditParams::Image }
+
+      # @!attribute prompt
+      #   A text description of the desired image(s). The maximum length is 1000
+      #   characters for `dall-e-2`, and 32000 characters for `gpt-image-1`.
+      #
+      #   @return [String]
+      required :prompt, String
+
+      # @!attribute background
+      #   Allows to set transparency for the background of the generated image(s). This
+      #   parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
+      #   `opaque` or `auto` (default value). When `auto` is used, the model will
+      #   automatically determine the best background for the image.
+      #
+      #   If `transparent`, the output format needs to support transparency, so it should
+      #   be set to either `png` (default value) or `webp`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditParams::Background, nil]
+      optional :background, enum: -> { OpenAI::ImageEditParams::Background }, nil?: true
+
+      # @!attribute mask
+      #   An additional image whose fully transparent areas (e.g. where alpha is zero)
+      #   indicate where `image` should be edited. If there are multiple images provided,
+      #   the mask will be applied on the first image. Must be a valid PNG file, less than
+      #   4MB, and have the same dimensions as `image`.
+      #
+      #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart, nil]
+      optional :mask, OpenAI::Internal::Type::FileInput
+
+      # @!attribute model
+      #   The model to use for image generation. Only `dall-e-2` and `gpt-image-1` are
+      #   supported. Defaults to `dall-e-2` unless a parameter specific to `gpt-image-1`
+      #   is used.
+      #
+      #   @return [String, Symbol, OpenAI::Models::ImageModel, nil]
+      optional :model, union: -> { OpenAI::ImageEditParams::Model }, nil?: true
+
+      # @!attribute n
+      #   The number of images to generate. Must be between 1 and 10.
+      #
+      #   @return [Integer, nil]
+      optional :n, Integer, nil?: true
+
+      # @!attribute quality
+      #   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.
+      #   Defaults to `auto`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditParams::Quality, nil]
+      optional :quality, enum: -> { OpenAI::ImageEditParams::Quality }, nil?: true
+
+      # @!attribute response_format
+      #   The format in which the generated images are returned. Must be one of `url` or
+      #   `b64_json`. URLs are only valid for 60 minutes after the image has been
+      #   generated. This parameter is only supported for `dall-e-2`, as `gpt-image-1`
+      #   will always return base64-encoded images.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil]
+      optional :response_format, enum: -> { OpenAI::ImageEditParams::ResponseFormat }, nil?: true
+
+      # @!attribute size
+      #   The size of the generated images. Must be one of `1024x1024`, `1536x1024`
+      #   (landscape), `1024x1536` (portrait), or `auto` (default value) for
+      #   `gpt-image-1`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditParams::Size, nil]
+      optional :size, enum: -> { OpenAI::ImageEditParams::Size }, nil?: true
+
+      # @!attribute user
+      #   A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   and detect abuse.
+      #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+      #
+      #   @return [String, nil]
+      optional :user, String
+
+      # @!method initialize(image:, prompt:, background: nil, mask: nil, model: nil, n: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::ImageEditParams} for more details.
+      #
+      #   @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.
+      #
+      #   @param prompt [String] A text description of the desired image(s). The maximum length is 1000 character
+      #
+      #   @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil] Allows to set transparency for the background of the generated image(s).
+      #
+      #   @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart] An additional image whose fully transparent areas (e.g. where alpha is zero) ind
+      #
+      #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil] The model to use for image generation. Only `dall-e-2` and `gpt-image-1` are sup
+      #
+      #   @param n [Integer, nil] The number of images to generate. Must be between 1 and 10.
+      #
+      #   @param quality [Symbol, OpenAI::Models::ImageEditParams::Quality, nil] The quality of the image that will be generated. `high`, `medium` and `low` are
+      #
+      #   @param response_format [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil] The format in which the generated images are returned. Must be one of `url` or `
+      #
+      #   @param size [Symbol, OpenAI::Models::ImageEditParams::Size, nil] The size of the generated images. Must be one of `1024x1024`, `1536x1024` (lands
+      #
+      #   @param user [String] A unique identifier representing your end-user, which can help OpenAI to monitor
+      #
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+      # The image(s) to edit. Must be a supported image file or an array of images.
+      #
+      # For `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less than
+      # 25MB. You can provide up to 16 images.
+      #
+      # For `dall-e-2`, you can only provide one image, and it should be a square `png`
+      # file less than 4MB.
+      module Image
+        extend OpenAI::Internal::Type::Union
+
+        variant OpenAI::Internal::Type::FileInput
+
+        variant -> { OpenAI::Models::ImageEditParams::Image::StringArray }
+
+        # @!method self.variants
+        #   @return [Array(StringIO, Array<StringIO>)]
+
+        # @type [OpenAI::Internal::Type::Converter]
+        StringArray = OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::FileInput]
+      end
+
+      # Allows to set transparency for the background of the generated image(s). This
+      # parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
+      # `opaque` or `auto` (default value). When `auto` is used, the model will
+      # automatically determine the best background for the image.
+      #
+      # If `transparent`, the output format needs to support transparency, so it should
+      # be set to either `png` (default value) or `webp`.
+      module Background
+        extend OpenAI::Internal::Type::Enum
+
+        TRANSPARENT = :transparent
+        OPAQUE = :opaque
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The model to use for image generation. Only `dall-e-2` and `gpt-image-1` are
+      # supported. Defaults to `dall-e-2` unless a parameter specific to `gpt-image-1`
+      # is used.
+      module Model
+        extend OpenAI::Internal::Type::Union
+
+        variant String
+
+        # The model to use for image generation. Only `dall-e-2` and `gpt-image-1` are supported. Defaults to `dall-e-2` unless a parameter specific to `gpt-image-1` is used.
+        variant enum: -> { OpenAI::ImageModel }
+
+        # @!method self.variants
+        #   @return [Array(String, Symbol, OpenAI::Models::ImageModel)]
+      end
+
+      # 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.
+      # Defaults to `auto`.
+      module Quality
+        extend OpenAI::Internal::Type::Enum
+
+        STANDARD = :standard
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The format in which the generated images are returned. Must be one of `url` or
+      # `b64_json`. URLs are only valid for 60 minutes after the image has been
+      # generated. This parameter is only supported for `dall-e-2`, as `gpt-image-1`
+      # will always return base64-encoded images.
+      module ResponseFormat
+        extend OpenAI::Internal::Type::Enum
+
+        URL = :url
+        B64_JSON = :b64_json
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The size of the generated images. Must be one of `1024x1024`, `1536x1024`
+      # (landscape), `1024x1536` (portrait), or `auto` (default value) for
+      # `gpt-image-1`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
+      module Size
+        extend OpenAI::Internal::Type::Enum
+
+        SIZE_256X256 = :"256x256"
+        SIZE_512X512 = :"512x512"
+        SIZE_1024X1024 = :"1024x1024"
+        SIZE_1536X1024 = :"1536x1024"
+        SIZE_1024X1536 = :"1024x1536"
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/openai/models/image_generate_params.rb

@@ -0,0 +1,272 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Images#generate
+    class ImageGenerateParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!attribute prompt
+      #   A text description of the desired image(s). The maximum length is 32000
+      #   characters for `gpt-image-1`, 1000 characters for `dall-e-2` and 4000 characters
+      #   for `dall-e-3`.
+      #
+      #   @return [String]
+      required :prompt, String
+
+      # @!attribute background
+      #   Allows to set transparency for the background of the generated image(s). This
+      #   parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
+      #   `opaque` or `auto` (default value). When `auto` is used, the model will
+      #   automatically determine the best background for the image.
+      #
+      #   If `transparent`, the output format needs to support transparency, so it should
+      #   be set to either `png` (default value) or `webp`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil]
+      optional :background, enum: -> { OpenAI::ImageGenerateParams::Background }, nil?: true
+
+      # @!attribute model
+      #   The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or
+      #   `gpt-image-1`. Defaults to `dall-e-2` unless a parameter specific to
+      #   `gpt-image-1` is used.
+      #
+      #   @return [String, Symbol, OpenAI::Models::ImageModel, nil]
+      optional :model, union: -> { OpenAI::ImageGenerateParams::Model }, nil?: true
+
+      # @!attribute moderation
+      #   Control the content-moderation level for images generated by `gpt-image-1`. Must
+      #   be either `low` for less restrictive filtering or `auto` (default value).
+      #
+      #   @return [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil]
+      optional :moderation, enum: -> { OpenAI::ImageGenerateParams::Moderation }, nil?: true
+
+      # @!attribute n
+      #   The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
+      #   `n=1` is supported.
+      #
+      #   @return [Integer, nil]
+      optional :n, Integer, nil?: true
+
+      # @!attribute output_compression
+      #   The compression level (0-100%) for the generated images. This parameter is only
+      #   supported for `gpt-image-1` with the `webp` or `jpeg` output formats, and
+      #   defaults to 100.
+      #
+      #   @return [Integer, nil]
+      optional :output_compression, Integer, nil?: true
+
+      # @!attribute output_format
+      #   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`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil]
+      optional :output_format, enum: -> { OpenAI::ImageGenerateParams::OutputFormat }, nil?: true
+
+      # @!attribute quality
+      #   The quality of the image that will be generated.
+      #
+      #   - `auto` (default value) will automatically select the best quality for the
+      #     given model.
+      #   - `high`, `medium` and `low` are supported for `gpt-image-1`.
+      #   - `hd` and `standard` are supported for `dall-e-3`.
+      #   - `standard` is the only option for `dall-e-2`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageGenerateParams::Quality, nil]
+      optional :quality, enum: -> { OpenAI::ImageGenerateParams::Quality }, nil?: true
+
+      # @!attribute response_format
+      #   The format in which generated images with `dall-e-2` and `dall-e-3` are
+      #   returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes
+      #   after the image has been generated. This parameter isn't supported for
+      #   `gpt-image-1` which will always return base64-encoded images.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil]
+      optional :response_format, enum: -> { OpenAI::ImageGenerateParams::ResponseFormat }, nil?: true
+
+      # @!attribute size
+      #   The size of the generated images. Must be one of `1024x1024`, `1536x1024`
+      #   (landscape), `1024x1536` (portrait), or `auto` (default value) for
+      #   `gpt-image-1`, one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`, and
+      #   one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
+      optional :size, enum: -> { OpenAI::ImageGenerateParams::Size }, nil?: true
+
+      # @!attribute style
+      #   The style of the generated images. This parameter is only supported for
+      #   `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
+      #   towards generating hyper-real and dramatic images. Natural causes the model to
+      #   produce more natural, less hyper-real looking images.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil]
+      optional :style, enum: -> { OpenAI::ImageGenerateParams::Style }, nil?: true
+
+      # @!attribute user
+      #   A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   and detect abuse.
+      #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+      #
+      #   @return [String, nil]
+      optional :user, String
+
+      # @!method initialize(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::ImageGenerateParams} for more details.
+      #
+      #   @param prompt [String] A text description of the desired image(s). The maximum length is 32000 characte
+      #
+      #   @param background [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil] Allows to set transparency for the background of the generated image(s).
+      #
+      #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil] The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or `gpt-im
+      #
+      #   @param moderation [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil] Control the content-moderation level for images generated by `gpt-image-1`. Must
+      #
+      #   @param n [Integer, nil] The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
+      #
+      #   @param output_compression [Integer, nil] The compression level (0-100%) for the generated images. This parameter is only
+      #
+      #   @param output_format [Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil] The format in which the generated images are returned. This parameter is only su
+      #
+      #   @param quality [Symbol, OpenAI::Models::ImageGenerateParams::Quality, nil] The quality of the image that will be generated.
+      #
+      #   @param response_format [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil] The format in which generated images with `dall-e-2` and `dall-e-3` are returned
+      #
+      #   @param size [Symbol, OpenAI::Models::ImageGenerateParams::Size, nil] The size of the generated images. Must be one of `1024x1024`, `1536x1024` (lands
+      #
+      #   @param style [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil] The style of the generated images. This parameter is only supported for `dall-e-
+      #
+      #   @param user [String] A unique identifier representing your end-user, which can help OpenAI to monitor
+      #
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+      # Allows to set transparency for the background of the generated image(s). This
+      # parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
+      # `opaque` or `auto` (default value). When `auto` is used, the model will
+      # automatically determine the best background for the image.
+      #
+      # If `transparent`, the output format needs to support transparency, so it should
+      # be set to either `png` (default value) or `webp`.
+      module Background
+        extend OpenAI::Internal::Type::Enum
+
+        TRANSPARENT = :transparent
+        OPAQUE = :opaque
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or
+      # `gpt-image-1`. Defaults to `dall-e-2` unless a parameter specific to
+      # `gpt-image-1` is used.
+      module Model
+        extend OpenAI::Internal::Type::Union
+
+        variant String
+
+        # The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or `gpt-image-1`. Defaults to `dall-e-2` unless a parameter specific to `gpt-image-1` is used.
+        variant enum: -> { OpenAI::ImageModel }
+
+        # @!method self.variants
+        #   @return [Array(String, Symbol, OpenAI::Models::ImageModel)]
+      end
+
+      # Control the content-moderation level for images generated by `gpt-image-1`. Must
+      # be either `low` for less restrictive filtering or `auto` (default value).
+      module Moderation
+        extend OpenAI::Internal::Type::Enum
+
+        LOW = :low
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # 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`.
+      module OutputFormat
+        extend OpenAI::Internal::Type::Enum
+
+        PNG = :png
+        JPEG = :jpeg
+        WEBP = :webp
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The quality of the image that will be generated.
+      #
+      # - `auto` (default value) will automatically select the best quality for the
+      #   given model.
+      # - `high`, `medium` and `low` are supported for `gpt-image-1`.
+      # - `hd` and `standard` are supported for `dall-e-3`.
+      # - `standard` is the only option for `dall-e-2`.
+      module Quality
+        extend OpenAI::Internal::Type::Enum
+
+        STANDARD = :standard
+        HD = :hd
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The format in which generated images with `dall-e-2` and `dall-e-3` are
+      # returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes
+      # after the image has been generated. This parameter isn't supported for
+      # `gpt-image-1` which will always return base64-encoded images.
+      module ResponseFormat
+        extend OpenAI::Internal::Type::Enum
+
+        URL = :url
+        B64_JSON = :b64_json
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The size of the generated images. Must be one of `1024x1024`, `1536x1024`
+      # (landscape), `1024x1536` (portrait), or `auto` (default value) for
+      # `gpt-image-1`, one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`, and
+      # one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.
+      module Size
+        extend OpenAI::Internal::Type::Enum
+
+        AUTO = :auto
+        SIZE_1024X1024 = :"1024x1024"
+        SIZE_1536X1024 = :"1536x1024"
+        SIZE_1024X1536 = :"1024x1536"
+        SIZE_256X256 = :"256x256"
+        SIZE_512X512 = :"512x512"
+        SIZE_1792X1024 = :"1792x1024"
+        SIZE_1024X1792 = :"1024x1792"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The style of the generated images. This parameter is only supported for
+      # `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
+      # towards generating hyper-real and dramatic images. Natural causes the model to
+      # produce more natural, less hyper-real looking images.
+      module Style
+        extend OpenAI::Internal::Type::Enum
+
+        VIVID = :vivid
+        NATURAL = :natural
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/openai/models/image_model.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module ImageModel
+      extend OpenAI::Internal::Type::Enum
+
+      DALL_E_2 = :"dall-e-2"
+      DALL_E_3 = :"dall-e-3"
+      GPT_IMAGE_1 = :"gpt-image-1"
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/openai/models/images_response.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Images#create_variation
+    class ImagesResponse < OpenAI::Internal::Type::BaseModel
+      # @!attribute created
+      #   The Unix timestamp (in seconds) of when the image was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute data
+      #   The list of generated images.
+      #
+      #   @return [Array<OpenAI::Models::Image>, nil]
+      optional :data, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Image] }
+
+      # @!attribute usage
+      #   For `gpt-image-1` only, the token usage information for the image generation.
+      #
+      #   @return [OpenAI::Models::ImagesResponse::Usage, nil]
+      optional :usage, -> { OpenAI::ImagesResponse::Usage }
+
+      # @!method initialize(created:, data: nil, usage: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::ImagesResponse} for more details.
+      #
+      #   The response from the image generation endpoint.
+      #
+      #   @param created [Integer] The Unix timestamp (in seconds) of when the image was created.
+      #
+      #   @param data [Array<OpenAI::Models::Image>] The list of generated images.
+      #
+      #   @param usage [OpenAI::Models::ImagesResponse::Usage] For `gpt-image-1` only, the token usage information for the image generation.
+
+      # @see OpenAI::Models::ImagesResponse#usage
+      class Usage < OpenAI::Internal::Type::BaseModel
+        # @!attribute input_tokens
+        #   The number of tokens (images and text) in the input prompt.
+        #
+        #   @return [Integer]
+        required :input_tokens, Integer
+
+        # @!attribute input_tokens_details
+        #   The input tokens detailed information for the image generation.
+        #
+        #   @return [OpenAI::Models::ImagesResponse::Usage::InputTokensDetails]
+        required :input_tokens_details, -> { OpenAI::ImagesResponse::Usage::InputTokensDetails }
+
+        # @!attribute output_tokens
+        #   The number of image tokens in the output image.
+        #
+        #   @return [Integer]
+        required :output_tokens, Integer
+
+        # @!attribute total_tokens
+        #   The total number of tokens (images and text) used for the image generation.
+        #
+        #   @return [Integer]
+        required :total_tokens, Integer
+
+        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:)
+        #   For `gpt-image-1` only, the token usage information for the image generation.
+        #
+        #   @param input_tokens [Integer] The number of tokens (images and text) in the input prompt.
+        #
+        #   @param input_tokens_details [OpenAI::Models::ImagesResponse::Usage::InputTokensDetails] The input tokens detailed information for the image generation.
+        #
+        #   @param output_tokens [Integer] The number of image tokens in the output image.
+        #
+        #   @param total_tokens [Integer] The total number of tokens (images and text) used for the image generation.
+
+        # @see OpenAI::Models::ImagesResponse::Usage#input_tokens_details
+        class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute image_tokens
+          #   The number of image tokens in the input prompt.
+          #
+          #   @return [Integer]
+          required :image_tokens, Integer
+
+          # @!attribute text_tokens
+          #   The number of text tokens in the input prompt.
+          #
+          #   @return [Integer]
+          required :text_tokens, Integer
+
+          # @!method initialize(image_tokens:, text_tokens:)
+          #   The input tokens detailed information for the image generation.
+          #
+          #   @param image_tokens [Integer] The number of image tokens in the input prompt.
+          #
+          #   @param text_tokens [Integer] The number of text tokens in the input prompt.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/metadata.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @type [OpenAI::Internal::Type::Converter]
+    Metadata = OpenAI::Internal::Type::HashOf[String]
+  end
+end

data/lib/openai/models/model.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Models#retrieve
+    class Model < OpenAI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The model identifier, which can be referenced in the API endpoints.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   The Unix timestamp (in seconds) when the model was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute object
+      #   The object type, which is always "model".
+      #
+      #   @return [Symbol, :model]
+      required :object, const: :model
+
+      # @!attribute owned_by
+      #   The organization that owns the model.
+      #
+      #   @return [String]
+      required :owned_by, String
+
+      # @!method initialize(id:, created:, owned_by:, object: :model)
+      #   Describes an OpenAI model offering that can be used with the API.
+      #
+      #   @param id [String] The model identifier, which can be referenced in the API endpoints.
+      #
+      #   @param created [Integer] The Unix timestamp (in seconds) when the model was created.
+      #
+      #   @param owned_by [String] The organization that owns the model.
+      #
+      #   @param object [Symbol, :model] The object type, which is always "model".
+    end
+  end
+end

data/lib/openai/models/model_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Models#delete
+    class ModelDeleteParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end