openai 0.87.0 → 0.88.0

data/lib/openai/models/graders/multi_grader.rb

@@ -30,19 +30,21 @@ module OpenAI
         required :type, const: :multi
 
         # @!method initialize(calculate_output:, graders:, name:, type: :multi)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Graders::MultiGrader} for more details.
-        #
         #   A MultiGrader object combines the output of multiple graders to produce a single
         #   score.
         #
-        #   @param calculate_output [String] A formula to calculate the output based on grader results.
+        #   @param calculate_output [String]
+        #     A formula to calculate the output based on grader results.
         #
-        #   @param graders [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::LabelModelGrader] A StringCheckGrader object that performs a string comparison between input and r
+        #   @param graders [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::LabelModelGrader]
+        #     A StringCheckGrader object that performs a string comparison between input and
+        #     reference using a specified operation.
         #
-        #   @param name [String] The name of the grader.
+        #   @param name [String]
+        #     The name of the grader.
         #
-        #   @param type [Symbol, :multi] The object type, which is always `multi`.
+        #   @param type [Symbol, :multi]
+        #     The object type, which is always `multi`.
 
         # A StringCheckGrader object that performs a string comparison between input and
         # reference using a specified operation.

data/lib/openai/models/graders/python_grader.rb

@@ -31,13 +31,17 @@ module OpenAI
         # @!method initialize(name:, source:, image_tag: nil, type: :python)
         #   A PythonGrader object that runs a python script on the input.
         #
-        #   @param name [String] The name of the grader.
+        #   @param name [String]
+        #     The name of the grader.
         #
-        #   @param source [String] The source code of the python script.
+        #   @param source [String]
+        #     The source code of the python script.
         #
-        #   @param image_tag [String] The image tag to use for the python script.
+        #   @param image_tag [String]
+        #     The image tag to use for the python script.
         #
-        #   @param type [Symbol, :python] The object type, which is always `python`.
+        #   @param type [Symbol, :python]
+        #     The object type, which is always `python`.
       end
     end
 

data/lib/openai/models/graders/score_model_grader.rb

@@ -42,23 +42,26 @@ module OpenAI
         optional :sampling_params, -> { OpenAI::Graders::ScoreModelGrader::SamplingParams }
 
         # @!method initialize(input:, model:, name:, range: nil, sampling_params: nil, type: :score_model)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Graders::ScoreModelGrader} for more details.
-        #
         #   A ScoreModelGrader object that uses a model to assign a score to the input.
         #
-        #   @param input [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>] The input messages evaluated by the grader. Supports text, output text, input im
+        #   @param input [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>]
+        #     The input messages evaluated by the grader. Supports text, output text, input
+        #     image, and input audio content blocks, and may include template strings.
         #
-        #   @param model [String] The model to use for the evaluation.
+        #   @param model [String]
+        #     The model to use for the evaluation.
         #
-        #   @param name [String] The name of the grader.
+        #   @param name [String]
+        #     The name of the grader.
         #
-        #   @param range [Array<Float>] The range of the score. Defaults to `[0, 1]`.
+        #   @param range [Array<Float>]
+        #     The range of the score. Defaults to `[0, 1]`.
         #
-        #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams] The sampling parameters for the model.
+        #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams]
+        #     The sampling parameters for the model.
         #
-        #   @param type [Symbol, :score_model] The object type, which is always `score_model`.
-
+        #   @param type [Symbol, :score_model]
+        #     The object type, which is always `score_model`.
         class Input < OpenAI::Internal::Type::BaseModel
           # @!attribute content
           #   Inputs to the model - can contain template strings. Supports text, output text,
@@ -81,20 +84,22 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Graders::ScoreModelGrader::Input::Type }
 
           # @!method initialize(content:, role:, type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Graders::ScoreModelGrader::Input} for more details.
-          #
           #   A message input to the model with a role indicating instruction following
           #   hierarchy. Instructions given with the `developer` or `system` role take
           #   precedence over instructions given with the `user` role. Messages with the
           #   `assistant` role are presumed to have been generated by the model in previous
           #   interactions.
           #
-          #   @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>] Inputs to the model - can contain template strings. Supports text, output text,
+          #   @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>]
+          #     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.
           #
-          #   @param role [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Role] The role of the message input. One of `user`, `assistant`, `system`, or
+          #   @param role [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Role]
+          #     The role of the message input. One of `user`, `assistant`, `system`, or
+          #     `developer`.
           #
-          #   @param type [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Type] The type of the message input. Always `message`.
+          #   @param type [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Type]
+          #     The type of the message input. Always `message`.
 
           # 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.
@@ -136,15 +141,13 @@ module OpenAI
               required :type, const: :output_text
 
               # @!method initialize(text:, type: :output_text)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText} for more
-              #   details.
-              #
               #   A text output from the model.
               #
-              #   @param text [String] The text output from the model.
+              #   @param text [String]
+              #     The text output from the model.
               #
-              #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
+              #   @param type [Symbol, :output_text]
+              #     The type of the output text. Always `output_text`.
             end
 
             class InputImage < OpenAI::Internal::Type::BaseModel
@@ -168,17 +171,17 @@ module OpenAI
               optional :detail, String
 
               # @!method initialize(image_url:, detail: nil, type: :input_image)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage} for more
-              #   details.
-              #
               #   An image input block used within EvalItem content arrays.
               #
-              #   @param image_url [String] The URL of the image input.
+              #   @param image_url [String]
+              #     The URL of the image input.
               #
-              #   @param detail [String] The detail level of the image to be sent to the model. One of `high`, `low`, or
+              #   @param detail [String]
+              #     The detail level of the image to be sent to the model. One of `high`, `low`, or
+              #     `auto`. Defaults to `auto`.
               #
-              #   @param type [Symbol, :input_image] The type of the image input. Always `input_image`.
+              #   @param type [Symbol, :input_image]
+              #     The type of the image input. Always `input_image`.
             end
 
             # @!method self.variants
@@ -227,7 +230,7 @@ module OpenAI
           #   are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
           #   reasoning effort can result in faster responses and fewer tokens used on
           #   reasoning in a response. Not all reasoning models support every value. See the
-          #   [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+          #   [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
           #   model-specific support.
           #
           #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
@@ -252,20 +255,27 @@ module OpenAI
           optional :top_p, Float, nil?: true
 
           # @!method initialize(max_completions_tokens: nil, reasoning_effort: nil, seed: nil, temperature: nil, top_p: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Graders::ScoreModelGrader::SamplingParams} for more details.
-          #
           #   The sampling parameters for the model.
           #
-          #   @param max_completions_tokens [Integer, nil] The maximum number of tokens the grader model may generate in its response.
+          #   @param max_completions_tokens [Integer, nil]
+          #     The maximum number of tokens the grader model may generate in its response.
           #
-          #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
+          #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil]
+          #     Constrains effort on reasoning for reasoning models. Currently supported values
+          #     are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+          #     reasoning effort can result in faster responses and fewer tokens used on
+          #     reasoning in a response. Not all reasoning models support every value. See the
+          #     [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
+          #     model-specific support.
           #
-          #   @param seed [Integer, nil] A seed value to initialize the randomness, during sampling.
+          #   @param seed [Integer, nil]
+          #     A seed value to initialize the randomness, during sampling.
           #
-          #   @param temperature [Float, nil] A higher temperature increases randomness in the outputs.
+          #   @param temperature [Float, nil]
+          #     A higher temperature increases randomness in the outputs.
           #
-          #   @param top_p [Float, nil] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
+          #   @param top_p [Float, nil]
+          #     An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
         end
       end
     end

data/lib/openai/models/graders/string_check_grader.rb

@@ -38,15 +38,20 @@ module OpenAI
         #   A StringCheckGrader object that performs a string comparison between input and
         #   reference using a specified operation.
         #
-        #   @param input [String] The input text. This may include template strings.
+        #   @param input [String]
+        #     The input text. This may include template strings.
         #
-        #   @param name [String] The name of the grader.
+        #   @param name [String]
+        #     The name of the grader.
         #
-        #   @param operation [Symbol, OpenAI::Models::Graders::StringCheckGrader::Operation] The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
+        #   @param operation [Symbol, OpenAI::Models::Graders::StringCheckGrader::Operation]
+        #     The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
         #
-        #   @param reference [String] The reference text. This may include template strings.
+        #   @param reference [String]
+        #     The reference text. This may include template strings.
         #
-        #   @param type [Symbol, :string_check] The object type, which is always `string_check`.
+        #   @param type [Symbol, :string_check]
+        #     The object type, which is always `string_check`.
 
         # The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
         #

data/lib/openai/models/graders/text_similarity_grader.rb

@@ -36,20 +36,23 @@ module OpenAI
         required :type, const: :text_similarity
 
         # @!method initialize(evaluation_metric:, input:, name:, reference:, type: :text_similarity)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Graders::TextSimilarityGrader} for more details.
-        #
         #   A TextSimilarityGrader object which grades text based on similarity metrics.
         #
-        #   @param evaluation_metric [Symbol, OpenAI::Models::Graders::TextSimilarityGrader::EvaluationMetric] The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`,
+        #   @param evaluation_metric [Symbol, OpenAI::Models::Graders::TextSimilarityGrader::EvaluationMetric]
+        #     The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, `gleu`,
+        #     `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.
         #
-        #   @param input [String] The text being graded.
+        #   @param input [String]
+        #     The text being graded.
         #
-        #   @param name [String] The name of the grader.
+        #   @param name [String]
+        #     The name of the grader.
         #
-        #   @param reference [String] The text being graded against.
+        #   @param reference [String]
+        #     The text being graded against.
         #
-        #   @param type [Symbol, :text_similarity] The type of grader.
+        #   @param type [Symbol, :text_similarity]
+        #     The type of grader.
 
         # The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, `gleu`,
         # `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.

data/lib/openai/models/image.rb

@@ -26,16 +26,20 @@ module OpenAI
       optional :url, String
 
       # @!method initialize(b64_json: nil, revised_prompt: nil, url: nil)
-      #   Some parameter documentations has been truncated, see {OpenAI::Models::Image}
-      #   for more details.
-      #
       #   Represents the content or the URL of an image generated by the OpenAI API.
       #
-      #   @param b64_json [String] The base64-encoded JSON of the generated image. Returned by default for the GPT
+      #   @param b64_json [String]
+      #     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`.
       #
-      #   @param revised_prompt [String] For `dall-e-3` only, the revised prompt that was used to generate the image.
+      #   @param revised_prompt [String]
+      #     For `dall-e-3` only, the revised prompt that was used to generate the image.
       #
-      #   @param url [String] When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response
+      #   @param url [String]
+      #     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 the GPT image
+      #     models.
     end
   end
 end

data/lib/openai/models/image_create_variation_params.rb

@@ -49,26 +49,40 @@ module OpenAI
       # @!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).
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @return [String, nil]
       optional :user, String
 
       # @!method initialize(image:, model: nil, n: nil, response_format: nil, size: nil, user: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ImageCreateVariationParams} for more details.
+      #   @param image [Pathname, StringIO, IO, String, OpenAI::FilePart]
+      #     The image to use as the basis for the variation(s). Must be a valid PNG file,
+      #     less than 4MB, and square.
       #
-      #   @param image [Pathname, StringIO, IO, String, OpenAI::FilePart] The image to use as the basis for the variation(s). Must be a valid PNG file, le
+      #     `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #     metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #     content type.
       #
-      #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil] The model to use for image generation. Only `dall-e-2` is supported at this time
+      #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
+      #     The model to use for image generation. Only `dall-e-2` is supported at this
+      #     time.
       #
-      #   @param n [Integer, nil] The number of images to generate. Must be between 1 and 10.
+      #   @param n [Integer, nil]
+      #     The number of images to generate. Must be between 1 and 10.
       #
-      #   @param response_format [Symbol, OpenAI::Models::ImageCreateVariationParams::ResponseFormat, nil] The format in which the generated images are returned. Must be one of `url` or `
+      #   @param response_format [Symbol, OpenAI::Models::ImageCreateVariationParams::ResponseFormat, 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.
       #
-      #   @param size [Symbol, OpenAI::Models::ImageCreateVariationParams::Size, nil] The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x
+      #   @param size [Symbol, OpenAI::Models::ImageCreateVariationParams::Size, nil]
+      #     The size of the generated images. Must be one of `256x256`, `512x512`, or
+      #     `1024x1024`.
       #
-      #   @param user [String] A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   @param user [String]
+      #     A unique identifier representing your end-user, which can help OpenAI to monitor
+      #     and detect abuse.
+      #     [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/openai/models/image_edit_completed_event.rb

@@ -53,26 +53,32 @@ module OpenAI
       required :usage, -> { OpenAI::ImageEditCompletedEvent::Usage }
 
       # @!method initialize(b64_json:, background:, created_at:, output_format:, quality:, size:, usage:, type: :"image_edit.completed")
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ImageEditCompletedEvent} for more details.
-      #
       #   Emitted when image editing has completed and the final image is available.
       #
-      #   @param b64_json [String] Base64-encoded final edited image data, suitable for rendering as an image.
+      #   @param b64_json [String]
+      #     Base64-encoded final edited image data, suitable for rendering as an image.
       #
-      #   @param background [Symbol, OpenAI::Models::ImageEditCompletedEvent::Background] The background setting for the edited image.
+      #   @param background [Symbol, OpenAI::Models::ImageEditCompletedEvent::Background]
+      #     The background setting for the edited image.
       #
-      #   @param created_at [Integer] The Unix timestamp when the event was created.
+      #   @param created_at [Integer]
+      #     The Unix timestamp when the event was created.
       #
-      #   @param output_format [Symbol, OpenAI::Models::ImageEditCompletedEvent::OutputFormat] The output format for the edited image.
+      #   @param output_format [Symbol, OpenAI::Models::ImageEditCompletedEvent::OutputFormat]
+      #     The output format for the edited image.
       #
-      #   @param quality [Symbol, OpenAI::Models::ImageEditCompletedEvent::Quality] The quality setting for the edited image.
+      #   @param quality [Symbol, OpenAI::Models::ImageEditCompletedEvent::Quality]
+      #     The quality setting for the edited image.
       #
-      #   @param size [String, Symbol, OpenAI::Models::ImageEditCompletedEvent::Size] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      #   @param size [String, Symbol, OpenAI::Models::ImageEditCompletedEvent::Size]
+      #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       #
-      #   @param usage [OpenAI::Models::ImageEditCompletedEvent::Usage] For the GPT image models only, the token usage information for the image generat
+      #   @param usage [OpenAI::Models::ImageEditCompletedEvent::Usage]
+      #     For the GPT image models only, the token usage information for the image
+      #     generation.
       #
-      #   @param type [Symbol, :"image_edit.completed"] The type of the event. Always `image_edit.completed`.
+      #   @param type [Symbol, :"image_edit.completed"]
+      #     The type of the event. Always `image_edit.completed`.
 
       # The background setting for the edited image.
       #
@@ -185,19 +191,20 @@ module OpenAI
         required :total_tokens, Integer
 
         # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::ImageEditCompletedEvent::Usage} for more details.
-        #
         #   For the GPT image models 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 [Integer]
+        #     The number of tokens (images and text) in the input prompt.
         #
-        #   @param input_tokens_details [OpenAI::Models::ImageEditCompletedEvent::Usage::InputTokensDetails] The input tokens detailed information for the image generation.
+        #   @param input_tokens_details [OpenAI::Models::ImageEditCompletedEvent::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 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.
+        #   @param total_tokens [Integer]
+        #     The total number of tokens (images and text) used for the image generation.
 
         # @see OpenAI::Models::ImageEditCompletedEvent::Usage#input_tokens_details
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel
@@ -216,9 +223,11 @@ module OpenAI
           # @!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 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.
+          #   @param text_tokens [Integer]
+          #     The number of text tokens in the input prompt.
         end
       end
     end

data/lib/openai/models/image_edit_params.rb

@@ -154,42 +154,119 @@ module OpenAI
       # @!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).
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @return [String, nil]
       optional :user, String
 
       # @!method initialize(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
-      #   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). Must
-      #
-      #   @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil] Control how much effort the model will exert to match the style and features, es
-      #
-      #   @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. One of `dall-e-2` or a GPT image model (`
-      #
-      #   @param n [Integer, nil] The number of images to generate. Must be between 1 and 10.
-      #
-      #   @param output_compression [Integer, nil] The compression level (0-100%) for the generated images. This parameter
-      #
-      #   @param output_format [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil] The format in which the generated images are returned. This parameter is
-      #
-      #   @param partial_images [Integer, nil] The number of partial images to generate. This parameter is used for
-      #
-      #   @param quality [Symbol, OpenAI::Models::ImageEditParams::Quality, nil] The quality of the image that will be generated for GPT image models. The GPT im
-      #
-      #   @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 [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil] The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`, `
-      #
-      #   @param user [String] A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   @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.
+      #
+      #     For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+      #     `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #     `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
+      #     `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`), 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.
+      #
+      #     `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #     metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #     content type.
+      #
+      #   @param prompt [String]
+      #     A text description of the desired image(s). The maximum length is 1000
+      #     characters for `dall-e-2`, and 32000 characters for the GPT image models.
+      #
+      #   @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil]
+      #     Allows to set transparency for the background of the generated image(s). 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.
+      #
+      #     `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their `2026-09-08`
+      #     snapshots, support `opaque` and `transparent` backgrounds. Transparent
+      #     backgrounds are available for supported GPT Image models. For `gpt-image-2` and
+      #     `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
+      #     set the output format to `png` or `webp`.
+      #
+      #   @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
+      #     Control how much effort the model will exert to match the style and features,
+      #     especially facial features, of input images. This parameter is only supported
+      #     for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for
+      #     `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
+      #
+      #   @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart]
+      #     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`.
+      #
+      #     `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #     metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #     content type.
+      #
+      #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
+      #     The model to use for image generation. One of `dall-e-2` or a GPT image model
+      #     (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+      #     `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #     `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
+      #     `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
+      #     `gpt-image-1.5`.
+      #
+      #   @param n [Integer, nil]
+      #     The number of images to generate. Must be between 1 and 10.
+      #
+      #   @param output_compression [Integer, nil]
+      #     The compression level (0-100%) for the generated images. This parameter is only
+      #     supported for the GPT image models with the `webp` or `jpeg` output formats, and
+      #     defaults to 100.
+      #
+      #   @param output_format [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil]
+      #     The format in which the generated images are returned. This parameter is only
+      #     supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`. The
+      #     default value is `png`.
+      #
+      #   @param partial_images [Integer, 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.
+      #
+      #   @param quality [Symbol, OpenAI::Models::ImageEditParams::Quality, nil]
+      #     The quality of the image that will be generated for GPT image models. The GPT
+      #     image models support `low`, `medium`, and `high`. `gpt-image-2.5-sunburst` and
+      #     `gpt-image-2.5-flare`, including their `2026-09-08` snapshots, also support
+      #     `xhigh` and `max`. Defaults to `auto`.
+      #
+      #   @param response_format [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, 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` (default is `url` for
+      #     `dall-e-2`), as GPT image models always return base64-encoded images.
+      #
+      #   @param size [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil]
+      #     The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
+      #     `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
+      #     `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
+      #     resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
+      #     Width and height must both be divisible by 16 and the requested aspect ratio
+      #     must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
+      #     the maximum supported resolution is `3840x2160`. The requested size must also
+      #     satisfy the model's current pixel and edge limits. The standard sizes
+      #     `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
+      #     `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
+      #     one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
+      #     `1024x1024`, `1792x1024`, or `1024x1792`.
+      #
+      #   @param user [String]
+      #     A unique identifier representing your end-user, which can help OpenAI to monitor
+      #     and detect abuse.
+      #     [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/openai/models/image_edit_partial_image_event.rb

@@ -52,26 +52,31 @@ module OpenAI
       required :type, const: :"image_edit.partial_image"
 
       # @!method initialize(b64_json:, background:, created_at:, output_format:, partial_image_index:, quality:, size:, type: :"image_edit.partial_image")
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ImageEditPartialImageEvent} for more details.
-      #
       #   Emitted when a partial image is available during image editing streaming.
       #
-      #   @param b64_json [String] Base64-encoded partial image data, suitable for rendering as an image.
+      #   @param b64_json [String]
+      #     Base64-encoded partial image data, suitable for rendering as an image.
       #
-      #   @param background [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Background] The background setting for the requested edited image.
+      #   @param background [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Background]
+      #     The background setting for the requested edited image.
       #
-      #   @param created_at [Integer] The Unix timestamp when the event was created.
+      #   @param created_at [Integer]
+      #     The Unix timestamp when the event was created.
       #
-      #   @param output_format [Symbol, OpenAI::Models::ImageEditPartialImageEvent::OutputFormat] The output format for the requested edited image.
+      #   @param output_format [Symbol, OpenAI::Models::ImageEditPartialImageEvent::OutputFormat]
+      #     The output format for the requested edited image.
       #
-      #   @param partial_image_index [Integer] 0-based index for the partial image (streaming).
+      #   @param partial_image_index [Integer]
+      #     0-based index for the partial image (streaming).
       #
-      #   @param quality [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Quality] The quality setting for the requested edited image.
+      #   @param quality [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Quality]
+      #     The quality setting for the requested edited image.
       #
-      #   @param size [String, Symbol, OpenAI::Models::ImageEditPartialImageEvent::Size] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      #   @param size [String, Symbol, OpenAI::Models::ImageEditPartialImageEvent::Size]
+      #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       #
-      #   @param type [Symbol, :"image_edit.partial_image"] The type of the event. Always `image_edit.partial_image`.
+      #   @param type [Symbol, :"image_edit.partial_image"]
+      #     The type of the event. Always `image_edit.partial_image`.
 
       # The background setting for the requested edited image.
       #