openai 0.39.0 → 0.41.0

data/rbi/openai/models/graders/score_model_grader.rbi

@@ -102,7 +102,8 @@ module OpenAI
               )
             end
 
-          # Inputs to the model - can contain template strings.
+          # Inputs to the model - can contain template strings. Supports text, output text,
+          # input images, and input audio, either as a single item or an array of items.
           sig do
             returns(
               T.any(
@@ -111,7 +112,15 @@ module OpenAI
                 OpenAI::Graders::ScoreModelGrader::Input::Content::OutputText,
                 OpenAI::Graders::ScoreModelGrader::Input::Content::InputImage,
                 OpenAI::Responses::ResponseInputAudio,
-                T::Array[T.anything]
+                T::Array[
+                  T.any(
+                    String,
+                    OpenAI::Responses::ResponseInputText,
+                    OpenAI::Graders::GraderInputItem::OutputText,
+                    OpenAI::Graders::GraderInputItem::InputImage,
+                    OpenAI::Responses::ResponseInputAudio
+                  )
+                ]
               )
             )
           end
@@ -155,14 +164,23 @@ module OpenAI
                   OpenAI::Graders::ScoreModelGrader::Input::Content::OutputText::OrHash,
                   OpenAI::Graders::ScoreModelGrader::Input::Content::InputImage::OrHash,
                   OpenAI::Responses::ResponseInputAudio::OrHash,
-                  T::Array[T.anything]
+                  T::Array[
+                    T.any(
+                      String,
+                      OpenAI::Responses::ResponseInputText::OrHash,
+                      OpenAI::Graders::GraderInputItem::OutputText::OrHash,
+                      OpenAI::Graders::GraderInputItem::InputImage::OrHash,
+                      OpenAI::Responses::ResponseInputAudio::OrHash
+                    )
+                  ]
                 ),
               role: OpenAI::Graders::ScoreModelGrader::Input::Role::OrSymbol,
               type: OpenAI::Graders::ScoreModelGrader::Input::Type::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
-            # Inputs to the model - can contain template strings.
+            # Inputs to the model - can contain template strings. Supports text, output text,
+            # input images, and input audio, either as a single item or an array of items.
             content:,
             # The role of the message input. One of `user`, `assistant`, `system`, or
             # `developer`.
@@ -182,7 +200,15 @@ module OpenAI
                     OpenAI::Graders::ScoreModelGrader::Input::Content::OutputText,
                     OpenAI::Graders::ScoreModelGrader::Input::Content::InputImage,
                     OpenAI::Responses::ResponseInputAudio,
-                    T::Array[T.anything]
+                    T::Array[
+                      T.any(
+                        String,
+                        OpenAI::Responses::ResponseInputText,
+                        OpenAI::Graders::GraderInputItem::OutputText,
+                        OpenAI::Graders::GraderInputItem::InputImage,
+                        OpenAI::Responses::ResponseInputAudio
+                      )
+                    ]
                   ),
                 role: OpenAI::Graders::ScoreModelGrader::Input::Role::OrSymbol,
                 type: OpenAI::Graders::ScoreModelGrader::Input::Type::OrSymbol
@@ -192,7 +218,8 @@ module OpenAI
           def to_hash
           end
 
-          # Inputs to the model - can contain template strings.
+          # Inputs to the model - can contain template strings. Supports text, output text,
+          # input images, and input audio, either as a single item or an array of items.
           module Content
             extend OpenAI::Internal::Type::Union
 
@@ -204,7 +231,7 @@ module OpenAI
                   OpenAI::Graders::ScoreModelGrader::Input::Content::OutputText,
                   OpenAI::Graders::ScoreModelGrader::Input::Content::InputImage,
                   OpenAI::Responses::ResponseInputAudio,
-                  T::Array[T.anything]
+                  T::Array[OpenAI::Graders::GraderInputItem::Variants]
                 )
               end
 
@@ -267,7 +294,7 @@ module OpenAI
               sig { params(detail: String).void }
               attr_writer :detail
 
-              # An image input to the model.
+              # An image input block used within EvalItem content arrays.
               sig do
                 params(image_url: String, detail: String, type: Symbol).returns(
                   T.attached_class
@@ -302,14 +329,6 @@ module OpenAI
             end
             def self.variants
             end
-
-            AnArrayOfInputTextInputImageAndInputAudioArray =
-              T.let(
-                OpenAI::Internal::Type::ArrayOf[
-                  OpenAI::Internal::Type::Unknown
-                ],
-                OpenAI::Internal::Type::Converter
-              )
           end
 
           # The role of the message input. One of `user`, `assistant`, `system`, or

data/rbi/openai/models/image.rbi

@@ -5,9 +5,9 @@ module OpenAI
     class Image < OpenAI::Internal::Type::BaseModel
       OrHash = T.type_alias { T.any(OpenAI::Image, OpenAI::Internal::AnyHash) }
 
-      # The base64-encoded JSON of the generated image. Default value for `gpt-image-1`,
-      # and only present if `response_format` is set to `b64_json` for `dall-e-2` and
-      # `dall-e-3`.
+      # The base64-encoded JSON of the generated image. Returned by default for the GPT
+      # image models, and only present if `response_format` is set to `b64_json` for
+      # `dall-e-2` and `dall-e-3`.
       sig { returns(T.nilable(String)) }
       attr_reader :b64_json
 
@@ -22,8 +22,8 @@ module OpenAI
       attr_writer :revised_prompt
 
       # When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
-      # `response_format` is set to `url` (default value). Unsupported for
-      # `gpt-image-1`.
+      # `response_format` is set to `url` (default value). Unsupported for the GPT image
+      # models.
       sig { returns(T.nilable(String)) }
       attr_reader :url
 
@@ -37,15 +37,15 @@ module OpenAI
         )
       end
       def self.new(
-        # The base64-encoded JSON of the generated image. Default value for `gpt-image-1`,
-        # and only present if `response_format` is set to `b64_json` for `dall-e-2` and
-        # `dall-e-3`.
+        # The base64-encoded JSON of the generated image. Returned by default for the GPT
+        # image models, and only present if `response_format` is set to `b64_json` for
+        # `dall-e-2` and `dall-e-3`.
         b64_json: nil,
         # For `dall-e-3` only, the revised prompt that was used to generate the image.
         revised_prompt: nil,
         # When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
-        # `response_format` is set to `url` (default value). Unsupported for
-        # `gpt-image-1`.
+        # `response_format` is set to `url` (default value). Unsupported for the GPT image
+        # models.
         url: nil
       )
       end

data/rbi/openai/models/image_edit_completed_event.rbi

@@ -38,7 +38,8 @@ module OpenAI
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # For `gpt-image-1` only, the token usage information for the image generation.
+      # For the GPT image models only, the token usage information for the image
+      # generation.
       sig { returns(OpenAI::ImageEditCompletedEvent::Usage) }
       attr_reader :usage
 
@@ -72,7 +73,8 @@ module OpenAI
         quality:,
         # The size of the edited image.
         size:,
-        # For `gpt-image-1` only, the token usage information for the image generation.
+        # For the GPT image models only, the token usage information for the image
+        # generation.
         usage:,
         # The type of the event. Always `image_edit.completed`.
         type: :"image_edit.completed"
@@ -267,7 +269,8 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :total_tokens
 
-        # For `gpt-image-1` only, the token usage information for the image generation.
+        # For the GPT image models only, the token usage information for the image
+        # generation.
         sig do
           params(
             input_tokens: Integer,

data/rbi/openai/models/image_edit_params.rbi

@@ -13,7 +13,8 @@ module OpenAI
 
       # 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
+      # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
+      # `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
       # 50MB. You can provide up to 16 images.
       #
       # For `dall-e-2`, you can only provide one image, and it should be a square `png`
@@ -22,14 +23,14 @@ module OpenAI
       attr_accessor :image
 
       # 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`.
+      # characters for `dall-e-2`, and 32000 characters for the GPT image models.
       sig { returns(String) }
       attr_accessor :prompt
 
       # 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.
+      # parameter is only supported for the GPT image models. 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`.
@@ -55,9 +56,9 @@ module OpenAI
       sig { params(mask: OpenAI::Internal::FileInput).void }
       attr_writer :mask
 
-      # 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.
+      # The model to use for image generation. Only `dall-e-2` and the GPT image models
+      # are supported. Defaults to `dall-e-2` unless a parameter specific to the GPT
+      # image models is used.
       sig { returns(T.nilable(T.any(String, OpenAI::ImageModel::OrSymbol))) }
       attr_accessor :model
 
@@ -66,13 +67,13 @@ module OpenAI
       attr_accessor :n
 
       # 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
+      # supported for the GPT image models with the `webp` or `jpeg` output formats, and
       # defaults to 100.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :output_compression
 
       # 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`. The
+      # supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`. The
       # default value is `png`.
       sig do
         returns(T.nilable(OpenAI::ImageEditParams::OutputFormat::OrSymbol))
@@ -89,23 +90,23 @@ module OpenAI
       attr_accessor :partial_images
 
       # 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`.
+      # only supported for the GPT image models. `dall-e-2` only supports `standard`
+      # quality. Defaults to `auto`.
       sig { returns(T.nilable(OpenAI::ImageEditParams::Quality::OrSymbol)) }
       attr_accessor :quality
 
       # 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.
+      # generated. This parameter is only supported for `dall-e-2`, as the GPT image
+      # models always return base64-encoded images.
       sig do
         returns(T.nilable(OpenAI::ImageEditParams::ResponseFormat::OrSymbol))
       end
       attr_accessor :response_format
 
       # 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`.
+      # (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
+      # models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
       sig { returns(T.nilable(OpenAI::ImageEditParams::Size::OrSymbol)) }
       attr_accessor :size
 
@@ -143,19 +144,20 @@ module OpenAI
       def self.new(
         # 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
+        # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
+        # `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
         # 50MB. 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.
         image:,
         # 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`.
+        # characters for `dall-e-2`, and 32000 characters for the GPT image models.
         prompt:,
         # 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.
+        # parameter is only supported for the GPT image models. 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`.
@@ -170,18 +172,18 @@ module OpenAI
         # 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`.
         mask: nil,
-        # 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.
+        # The model to use for image generation. Only `dall-e-2` and the GPT image models
+        # are supported. Defaults to `dall-e-2` unless a parameter specific to the GPT
+        # image models is used.
         model: nil,
         # The number of images to generate. Must be between 1 and 10.
         n: nil,
         # 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
+        # supported for the GPT image models with the `webp` or `jpeg` output formats, and
         # defaults to 100.
         output_compression: nil,
         # 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`. The
+        # supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`. The
         # default value is `png`.
         output_format: nil,
         # The number of partial images to generate. This parameter is used for streaming
@@ -192,17 +194,17 @@ module OpenAI
         # 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.
-        # Defaults to `auto`.
+        # only supported for the GPT image models. `dall-e-2` only supports `standard`
+        # quality. Defaults to `auto`.
         quality: nil,
         # 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.
+        # generated. This parameter is only supported for `dall-e-2`, as the GPT image
+        # models always return base64-encoded images.
         response_format: nil,
         # 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`.
+        # (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
+        # models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
         size: nil,
         # A unique identifier representing your end-user, which can help OpenAI to monitor
         # and detect abuse.
@@ -242,7 +244,8 @@ module OpenAI
 
       # 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
+      # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
+      # `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
       # 50MB. You can provide up to 16 images.
       #
       # For `dall-e-2`, you can only provide one image, and it should be a square `png`
@@ -266,9 +269,9 @@ module OpenAI
       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.
+      # parameter is only supported for the GPT image models. 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`.
@@ -318,9 +321,9 @@ module OpenAI
         end
       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.
+      # The model to use for image generation. Only `dall-e-2` and the GPT image models
+      # are supported. Defaults to `dall-e-2` unless a parameter specific to the GPT
+      # image models is used.
       module Model
         extend OpenAI::Internal::Type::Union
 
@@ -335,7 +338,7 @@ module OpenAI
       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`. The
+      # supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`. The
       # default value is `png`.
       module OutputFormat
         extend OpenAI::Internal::Type::Enum
@@ -358,8 +361,8 @@ module OpenAI
       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`.
+      # only supported for the GPT image models. `dall-e-2` only supports `standard`
+      # quality. Defaults to `auto`.
       module Quality
         extend OpenAI::Internal::Type::Enum
 
@@ -385,8 +388,8 @@ module OpenAI
 
       # 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.
+      # generated. This parameter is only supported for `dall-e-2`, as the GPT image
+      # models always return base64-encoded images.
       module ResponseFormat
         extend OpenAI::Internal::Type::Enum
 
@@ -413,8 +416,8 @@ module OpenAI
       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`.
+      # (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
+      # models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
       module Size
         extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/image_gen_completed_event.rbi

@@ -38,7 +38,8 @@ module OpenAI
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # For `gpt-image-1` only, the token usage information for the image generation.
+      # For the GPT image models only, the token usage information for the image
+      # generation.
       sig { returns(OpenAI::ImageGenCompletedEvent::Usage) }
       attr_reader :usage
 
@@ -71,7 +72,8 @@ module OpenAI
         quality:,
         # The size of the generated image.
         size:,
-        # For `gpt-image-1` only, the token usage information for the image generation.
+        # For the GPT image models only, the token usage information for the image
+        # generation.
         usage:,
         # The type of the event. Always `image_generation.completed`.
         type: :"image_generation.completed"
@@ -260,7 +262,8 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :total_tokens
 
-        # For `gpt-image-1` only, the token usage information for the image generation.
+        # For the GPT image models only, the token usage information for the image
+        # generation.
         sig do
           params(
             input_tokens: Integer,