openai 0.98.0 → 0.100.0

data/lib/openai/resources/images.rb

@@ -4,7 +4,11 @@ module OpenAI
   module Resources
     # Given a prompt and/or an input image, the model will generate a new image.
     class Images
-      # Creates a variation of a given image. This endpoint only supports `dall-e-2`.
+      # @deprecated
+      #
+      # This endpoint is retired and no longer available. Use the image edits endpoint
+      # with a GPT Image model and a prompt to create a variation of an image. The
+      # request and response schemas below describe the legacy contract.
       #
       # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -21,8 +25,8 @@ module OpenAI
       #   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.
+      #   The legacy model used by the retired image variations endpoint. This endpoint no
+      #   longer accepts requests.
       #
       # @param n [Integer, nil]
       #   The number of images to generate. Must be between 1 and 10.
@@ -62,7 +66,7 @@ module OpenAI
       # See {OpenAI::Resources::Images#edit_stream_raw} for streaming counterpart.
       #
       # Creates an edited or extended image given one or more source images and a
-      # prompt. This endpoint supports GPT Image models and `dall-e-2`.
+      # prompt. This endpoint supports GPT Image models.
       #
       # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -80,16 +84,13 @@ module OpenAI
       #   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.
+      #   A text description of the desired image(s). The maximum length is 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
@@ -103,9 +104,10 @@ module OpenAI
       #   set the output format to `png` or `webp`.
       #
       # @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
-      #   Controls fidelity to the original input image(s). This parameter is supported
-      #   for GPT image models that support input fidelity. `gpt-image-2` and
-      #   `gpt-image-2-2026-04-21` ignore this parameter.
+      #   Control how much effort the model will exert to match the style and features,
+      #   especially facial features, of input images. Supports `high` and `low` on
+      #   `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
+      #   `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
       #
       # @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart]
       #   An additional image whose fully transparent areas (e.g. where alpha is zero)
@@ -118,12 +120,11 @@ module OpenAI
       #   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`.
+      #   The GPT image model to use for image editing (`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`).
       #
       # @param n [Integer, nil]
       #   The number of images to generate. Must be between 1 and 10.
@@ -153,24 +154,21 @@ module OpenAI
       #   `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.
+      #   Legacy response format parameter for retired image models. Unsupported for GPT
+      #   image models, which 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`.
+      #   The size of the generated images. Defaults to `auto`. 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.
       #
       # @param user [String]
       #   A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -203,7 +201,7 @@ module OpenAI
       # See {OpenAI::Resources::Images#edit} for non-streaming counterpart.
       #
       # Creates an edited or extended image given one or more source images and a
-      # prompt. This endpoint supports GPT Image models and `dall-e-2`.
+      # prompt. This endpoint supports GPT Image models.
       #
       # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -221,16 +219,13 @@ module OpenAI
       #   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.
+      #   A text description of the desired image(s). The maximum length is 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
@@ -244,9 +239,10 @@ module OpenAI
       #   set the output format to `png` or `webp`.
       #
       # @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
-      #   Controls fidelity to the original input image(s). This parameter is supported
-      #   for GPT image models that support input fidelity. `gpt-image-2` and
-      #   `gpt-image-2-2026-04-21` ignore this parameter.
+      #   Control how much effort the model will exert to match the style and features,
+      #   especially facial features, of input images. Supports `high` and `low` on
+      #   `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
+      #   `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
       #
       # @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart]
       #   An additional image whose fully transparent areas (e.g. where alpha is zero)
@@ -259,12 +255,11 @@ module OpenAI
       #   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`.
+      #   The GPT image model to use for image editing (`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`).
       #
       # @param n [Integer, nil]
       #   The number of images to generate. Must be between 1 and 10.
@@ -294,24 +289,21 @@ module OpenAI
       #   `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.
+      #   Legacy response format parameter for retired image models. Unsupported for GPT
+      #   image models, which 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`.
+      #   The size of the generated images. Defaults to `auto`. 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.
       #
       # @param user [String]
       #   A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -349,15 +341,14 @@ module OpenAI
 
       # See {OpenAI::Resources::Images#generate_stream_raw} for streaming counterpart.
       #
-      # Creates an image given a prompt.
+      # Creates an image given a prompt using a GPT Image model.
       # [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
       #
       # @overload generate(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
       #
       # @param prompt [String]
       #   A text description of the desired image(s). The maximum length is 32000
-      #   characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
-      #   characters for `dall-e-3`.
+      #   characters.
       #
       # @param background [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil]
       #   Allows to set transparency for the background of the generated image(s). Must be
@@ -371,12 +362,11 @@ module OpenAI
       #   set the output format to `png` or `webp`.
       #
       # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
-      #   The model to use for image generation. One of `dall-e-2`, `dall-e-3`, 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`,
+      #   The GPT image model to use for image generation. Specify a model explicitly.
+      #   Supported models include `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`). Defaults to `dall-e-2` unless a parameter
-      #   specific to the GPT image models is used.
+      #   `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
       #
       # @param moderation [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil]
       #   Control the content-moderation level for images generated by the GPT image
@@ -384,8 +374,7 @@ module OpenAI
       #   value).
       #
       # @param n [Integer, nil]
-      #   The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
-      #   `n=1` is supported.
+      #   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
@@ -412,13 +401,9 @@ module OpenAI
       #   - `high`, `medium` and `low` are supported for the GPT image models.
       #   - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
       #     `2026-09-08` snapshots, also support `xhigh` and `max`.
-      #   - `hd` and `standard` are supported for `dall-e-3`.
-      #   - `standard` is the only option for `dall-e-2`.
       #
       # @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. 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 the GPT
+      #   Legacy response format parameter for retired image models. Unsupported for GPT
       #   image models, which always return base64-encoded images.
       #
       # @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
@@ -431,15 +416,11 @@ module OpenAI
       #   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`.
+      #   `auto` is supported for models that allow automatic sizing.
       #
       # @param style [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil]
-      #   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.
+      #   Legacy style parameter for retired image models. Unsupported for GPT image
+      #   models; describe the desired style in the prompt instead.
       #
       # @param user [String]
       #   A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -470,15 +451,14 @@ module OpenAI
 
       # See {OpenAI::Resources::Images#generate} for non-streaming counterpart.
       #
-      # Creates an image given a prompt.
+      # Creates an image given a prompt using a GPT Image model.
       # [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
       #
       # @overload generate_stream_raw(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
       #
       # @param prompt [String]
       #   A text description of the desired image(s). The maximum length is 32000
-      #   characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
-      #   characters for `dall-e-3`.
+      #   characters.
       #
       # @param background [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil]
       #   Allows to set transparency for the background of the generated image(s). Must be
@@ -492,12 +472,11 @@ module OpenAI
       #   set the output format to `png` or `webp`.
       #
       # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
-      #   The model to use for image generation. One of `dall-e-2`, `dall-e-3`, 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`,
+      #   The GPT image model to use for image generation. Specify a model explicitly.
+      #   Supported models include `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`). Defaults to `dall-e-2` unless a parameter
-      #   specific to the GPT image models is used.
+      #   `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
       #
       # @param moderation [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil]
       #   Control the content-moderation level for images generated by the GPT image
@@ -505,8 +484,7 @@ module OpenAI
       #   value).
       #
       # @param n [Integer, nil]
-      #   The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
-      #   `n=1` is supported.
+      #   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
@@ -533,13 +511,9 @@ module OpenAI
       #   - `high`, `medium` and `low` are supported for the GPT image models.
       #   - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
       #     `2026-09-08` snapshots, also support `xhigh` and `max`.
-      #   - `hd` and `standard` are supported for `dall-e-3`.
-      #   - `standard` is the only option for `dall-e-2`.
       #
       # @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. 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 the GPT
+      #   Legacy response format parameter for retired image models. Unsupported for GPT
       #   image models, which always return base64-encoded images.
       #
       # @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
@@ -552,15 +526,11 @@ module OpenAI
       #   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`.
+      #   `auto` is supported for models that allow automatic sizing.
       #
       # @param style [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil]
-      #   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.
+      #   Legacy style parameter for retired image models. Unsupported for GPT image
+      #   models; describe the desired style in the prompt instead.
       #
       # @param user [String]
       #   A unique identifier representing your end-user, which can help OpenAI to monitor

data/lib/openai/resources/webhooks.rb

@@ -203,7 +203,7 @@ module OpenAI
       # @param headers [Hash] The webhook headers
       # @param webhook_secret [String, nil] The webhook secret (optional, will use client webhook secret or ENV["OPENAI_WEBHOOK_SECRET"] if not provided)
       #
-      # @return [OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent]
+      # @return [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent, OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent, OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent, OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent]
       #
       # @raise [ArgumentError] if signature verification fails
       def unwrap(

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.98.0"
+  VERSION = "0.100.0"
 end

data/lib/openai.rb

@@ -454,6 +454,8 @@ require_relative "openai/models/audio/translation"
 require_relative "openai/models/audio/translation_create_params"
 require_relative "openai/models/audio/translation_create_response"
 require_relative "openai/models/audio/translation_verbose"
+require_relative "openai/models/audio/voice"
+require_relative "openai/models/audio/voice_create_params"
 require_relative "openai/models/audio_model"
 require_relative "openai/models/audio_response_format"
 require_relative "openai/models/auto_file_chunking_strategy_param"
@@ -527,6 +529,7 @@ require_relative "openai/models/beta/agents/sessions/trace_list_params"
 require_relative "openai/models/beta/agents/sessions/turn"
 require_relative "openai/models/beta/agents/sessions/turn_list_params"
 require_relative "openai/models/beta/agents/sessions/turn_retrieve_params"
+require_relative "openai/models/beta/agents/sessions/turns/item_list_params"
 require_relative "openai/models/beta/agents/session_update_params"
 require_relative "openai/models/beta/agents/vault"
 require_relative "openai/models/beta/agents/vault_create_params"
@@ -1435,6 +1438,11 @@ require_relative "openai/models/video_remix_params"
 require_relative "openai/models/video_retrieve_params"
 require_relative "openai/models/video_seconds"
 require_relative "openai/models/video_size"
+require_relative "openai/models/webhooks/agent_session_action_required_webhook_event"
+require_relative "openai/models/webhooks/agent_session_created_webhook_event"
+require_relative "openai/models/webhooks/agent_session_failed_webhook_event"
+require_relative "openai/models/webhooks/agent_session_idle_webhook_event"
+require_relative "openai/models/webhooks/agent_session_in_progress_webhook_event"
 require_relative "openai/models/webhooks/batch_cancelled_webhook_event"
 require_relative "openai/models/webhooks/batch_completed_webhook_event"
 require_relative "openai/models/webhooks/batch_expired_webhook_event"
@@ -1510,6 +1518,7 @@ require_relative "openai/resources/audio"
 require_relative "openai/resources/audio/speech"
 require_relative "openai/resources/audio/transcriptions"
 require_relative "openai/resources/audio/translations"
+require_relative "openai/resources/audio/voices"
 require_relative "openai/resources/batches"
 require_relative "openai/resources/beta"
 require_relative "openai/resources/beta/agents"
@@ -1526,6 +1535,7 @@ require_relative "openai/resources/beta/agents/sessions/subagents/turns"
 require_relative "openai/resources/beta/agents/sessions/subagents/turns/items"
 require_relative "openai/resources/beta/agents/sessions/traces"
 require_relative "openai/resources/beta/agents/sessions/turns"
+require_relative "openai/resources/beta/agents/sessions/turns/items"
 require_relative "openai/resources/beta/agents/vaults"
 require_relative "openai/resources/beta/agents/vaults/credentials"
 require_relative "openai/resources/beta/assistants"

data/rbi/openai/helpers/agents.rbi

@@ -56,6 +56,7 @@ module OpenAI
               session_id: String,
               input: T.any(String, T::Array[OpenAI::Models::Beta::AgentSessionInputMessageParam::OrHash]),
               tool_handlers: T::Hash[String, OpenAI::Helpers::Agents::ToolHandler],
+              on_tool_error: T.nilable(T.proc.params(failure: OpenAI::Helpers::Beta::Agents::ToolError).void),
               idempotency_key: T.nilable(String),
               output_type: T.nilable(T.class_of(OpenAI::Helpers::StructuredOutput::BaseModel)),
               request_options: T.nilable(OpenAI::RequestOptions::OrHash),
@@ -67,6 +68,7 @@ module OpenAI
             session_id,
             input:,
             tool_handlers: {},
+            on_tool_error: nil,
             idempotency_key: nil,
             output_type: nil,
             request_options: {},

data/rbi/openai/helpers/beta/agents/function_tool.rbi

@@ -13,11 +13,12 @@ module OpenAI
               name: String,
               arguments: T.class_of(OpenAI::BaseModel),
               description: String,
+              defer_loading: T.nilable(T::Boolean),
               handler: T.proc.params(arguments: T.untyped).returns(OpenAI::Helpers::Agents::ToolOutput)
             )
               .void
           end
-          def initialize(name:, arguments:, description: "", &handler)
+          def initialize(name:, arguments:, description: "", defer_loading: nil, &handler)
           end
 
           sig { returns(OpenAI::Internal::AnyHash) }
@@ -29,9 +30,13 @@ module OpenAI
           end
 
           sig {
-            params(arguments: T.any(String, OpenAI::Internal::AnyHash)).returns(OpenAI::Helpers::Agents::ToolOutput)
+            params(
+              arguments: T.any(String, OpenAI::Internal::AnyHash),
+              report_stage: T.nilable(T.proc.params(stage: Symbol).void)
+            )
+              .returns(OpenAI::Helpers::Agents::ToolOutput)
           }
-          def call(arguments)
+          def call(arguments, &report_stage)
           end
         end
       end

data/rbi/openai/helpers/beta/agents/tool_error.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module OpenAI
+  module Helpers
+    module Beta
+      module Agents
+        # Beta, local-only tool failure diagnostic.
+        class ToolError
+          sig { returns(StandardError) }
+          attr_reader :error
+          sig { returns(String) }
+          attr_reader :tool_name, :session_id, :turn_id, :call_id
+          sig { returns(Symbol) }
+          attr_reader :stage
+        end
+      end
+    end
+  end
+end

data/rbi/openai/helpers/beta/agents.rbi

@@ -139,6 +139,18 @@ module OpenAI
           sig { params(parser: T.nilable(OutputParser)).returns(T.self_type) }
           def configure_output_parser(parser)
           end
+
+          # @api private
+          sig do
+            params(
+              sessions: OpenAI::Resources::Beta::Agents::Sessions,
+              tool_handlers: T::Hash[String, OpenAI::Helpers::Agents::ToolHandler],
+              request_options: T.untyped
+            )
+              .returns(T.self_type)
+          end
+          def configure_tool_handlers(sessions:, tool_handlers:, request_options:)
+          end
         end
       end
     end