RubyGems - openai - Versions diffs - 0.98.0 → 0.99.0 - Mend

openai 0.98.0 → 0.99.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (138) hide show

data/lib/openai/models/chat/chat_completion_audio_param.rb CHANGED Viewed

@@ -15,7 +15,8 @@ module OpenAI
         #   The voice the model uses to respond. Supported built-in voices are `alloy`,
         #   `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         #   `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-        #   for example `{ "id": "voice_1234" }`.
+        #   for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+        #   samples. Voices created from text prompts are supported only in Live.
         #
         #   @return [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ID, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice]
         required :voice, union: -> { OpenAI::Chat::ChatCompletionAudioParam::Voice }
@@ -33,7 +34,8 @@ module OpenAI
         #     The voice the model uses to respond. Supported built-in voices are `alloy`,
         #     `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         #     `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-        #     for example `{ "id": "voice_1234" }`.
+        #     for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+        #     samples. Voices created from text prompts are supported only in Live.
         # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
         # or `pcm16`.
@@ -56,7 +58,8 @@ module OpenAI
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-        # for example `{ "id": "voice_1234" }`.
+        # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+        # samples. Voices created from text prompts are supported only in Live.
         #
         # @see OpenAI::Models::Chat::ChatCompletionAudioParam#voice
         module Voice

data/lib/openai/models/chat_model.rb CHANGED Viewed

@@ -19,80 +19,258 @@ module OpenAI
       GPT_5_4_NANO = :"gpt-5.4-nano"
       GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
       GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
+      # @deprecated Announced shutdown date: 2026-08-10. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_3_CHAT_LATEST = :"gpt-5.3-chat-latest"
       GPT_5_2 = :"gpt-5.2"
       GPT_5_2_2025_12_11 = :"gpt-5.2-2025-12-11"
+      # @deprecated Announced shutdown date: 2026-08-10. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
       GPT_5_2_PRO = :"gpt-5.2-pro"
       GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
       GPT_5_1 = :"gpt-5.1"
       GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_1_CODEX = :"gpt-5.1-codex"
+      # @deprecated Not a supported model ID. Retained for SDK compatibility.
       GPT_5_1_MINI = :"gpt-5.1-mini"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5 = :"gpt-5"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_MINI = :"gpt-5-mini"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_NANO = :"gpt-5-nano"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_2025_08_07 = :"gpt-5-2025-08-07"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_MINI_2025_08_07 = :"gpt-5-mini-2025-08-07"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_NANO_2025_08_07 = :"gpt-5-nano-2025-08-07"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_CHAT_LATEST = :"gpt-5-chat-latest"
       GPT_4_1 = :"gpt-4.1"
       GPT_4_1_MINI = :"gpt-4.1-mini"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_1_NANO = :"gpt-4.1-nano"
       GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
       GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_1_NANO_2025_04_14 = :"gpt-4.1-nano-2025-04-14"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O4_MINI = :"o4-mini"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O4_MINI_2025_04_16 = :"o4-mini-2025-04-16"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O3 = :o3
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O3_2025_04_16 = :"o3-2025-04-16"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O3_MINI = :"o3-mini"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O3_MINI_2025_01_31 = :"o3-mini-2025-01-31"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1 = :o1
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_2024_12_17 = :"o1-2024-12-17"
+      # @deprecated Announced shutdown date: 2025-07-28. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_PREVIEW = :"o1-preview"
+      # @deprecated Announced shutdown date: 2025-07-28. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_PREVIEW_2024_09_12 = :"o1-preview-2024-09-12"
+      # @deprecated Announced shutdown date: 2025-10-27. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_MINI = :"o1-mini"
+      # @deprecated Announced shutdown date: 2025-10-27. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
       GPT_4O = :"gpt-4o"
       GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
       GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
+      # @deprecated Announced shutdown date: 2027-01-20. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_AUDIO_MINI = :"gpt-audio-mini"
+      # @deprecated Announced shutdown date: 2027-01-20. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
+      # @deprecated Announced shutdown date: 2025-10-10. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_AUDIO_PREVIEW_2025_06_03 = :"gpt-4o-audio-preview-2025-06-03"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_AUDIO_PREVIEW = :"gpt-4o-mini-audio-preview"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-mini-audio-preview-2024-12-17"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_SEARCH_PREVIEW = :"gpt-4o-search-preview"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_SEARCH_PREVIEW = :"gpt-4o-mini-search-preview"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-search-preview-2025-03-11"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-mini-search-preview-2025-03-11"
+      # @deprecated Announced shutdown date: 2026-02-17. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       CHATGPT_4O_LATEST = :"chatgpt-4o-latest"
+      # @deprecated Announced shutdown date: 2026-02-12. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       CODEX_MINI_LATEST = :"codex-mini-latest"
       GPT_4O_MINI = :"gpt-4o-mini"
       GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_TURBO = :"gpt-4-turbo"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_TURBO_2024_04_09 = :"gpt-4-turbo-2024-04-09"
+      # @deprecated Announced shutdown date: 2026-03-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_0125_PREVIEW = :"gpt-4-0125-preview"
+      # @deprecated Announced shutdown date: 2026-03-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_TURBO_PREVIEW = :"gpt-4-turbo-preview"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
+      # @deprecated Announced shutdown date: 2024-12-06. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4 = :"gpt-4"
+      # @deprecated Announced shutdown date: 2026-03-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_0314 = :"gpt-4-0314"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_0613 = :"gpt-4-0613"
+      # @deprecated Announced shutdown date: 2025-06-06. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_32K = :"gpt-4-32k"
+      # @deprecated Announced shutdown date: 2025-06-06. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_32K_0314 = :"gpt-4-32k-0314"
+      # @deprecated Announced shutdown date: 2025-06-06. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_32K_0613 = :"gpt-4-32k-0613"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO = :"gpt-3.5-turbo"
+      # @deprecated Announced shutdown date: 2024-09-13. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_16K = :"gpt-3.5-turbo-16k"
+      # @deprecated Announced shutdown date: 2024-09-13. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
+      # @deprecated Announced shutdown date: 2024-09-13. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
+      # @deprecated Announced shutdown date: 2026-09-28. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
+      # @deprecated Announced shutdown date: 2024-09-13. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
       # @!method self.values

data/lib/openai/models/image.rb CHANGED Viewed

@@ -4,23 +4,23 @@ module OpenAI
   module Models
     class Image < OpenAI::Internal::Type::BaseModel
       # @!attribute b64_json
-      #   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`.
+      #   The base64-encoded JSON of the generated image. Returned by default for GPT
+      #   image models, or when `response_format` is set to `b64_json` for models that
+      #   support that parameter.
       #
       #   @return [String, nil]
       optional :b64_json, String
       # @!attribute revised_prompt
-      #   For `dall-e-3` only, the revised prompt that was used to generate the image.
+      #   The revised prompt used to generate the image, for models that support prompt
+      #   revision. Not returned by GPT image models.
       #
       #   @return [String, nil]
       optional :revised_prompt, String
       # @!attribute url
-      #   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.
+      #   The URL of the generated image when `response_format` is set to `url` for models
+      #   that support that parameter. Unsupported for GPT image models.
       #
       #   @return [String, nil]
       optional :url, String
@@ -29,17 +29,17 @@ module OpenAI
       #   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
-      #     image models, 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 GPT
+      #     image models, or when `response_format` is set to `b64_json` for models that
+      #     support that parameter.
       #
       #   @param revised_prompt [String]
-      #     For `dall-e-3` only, the revised prompt that was used to generate the image.
+      #     The revised prompt used to generate the image, for models that support prompt
+      #     revision. Not returned by GPT image models.
       #
       #   @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.
+      #     The URL of the generated image when `response_format` is set to `url` for models
+      #     that support that parameter. Unsupported for GPT image models.
     end
   end
 end

data/lib/openai/models/image_create_variation_params.rb CHANGED Viewed

@@ -19,8 +19,8 @@ module OpenAI
       required :image, OpenAI::Internal::Type::FileInput
       # @!attribute model
-      #   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.
       #
       #   @return [String, Symbol, OpenAI::Models::ImageModel, nil]
       optional :model, union: -> { OpenAI::ImageCreateVariationParams::Model }, nil?: true
@@ -64,8 +64,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.
@@ -86,14 +86,14 @@ module OpenAI
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
-      # 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.
       module Model
         extend OpenAI::Internal::Type::Union
         variant String
-        # 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.
         variant enum: -> { OpenAI::ImageModel }
         # @!method self.variants