openai 0.98.0 → 0.99.0

data/lib/openai/models/audio/voice.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::Voices#create
+      class Voice < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The voice identifier, which can be referenced in API endpoints.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) for when the voice was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute name
+        #   The name of the voice.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute object
+        #   The object type, which is always `audio.voice`.
+        #
+        #   @return [Symbol, :"audio.voice"]
+        required :object, const: :"audio.voice"
+
+        # @!attribute type
+        #   How the voice was created. Voices created from text prompts are supported only
+        #   in Live.
+        #
+        #   @return [Symbol, OpenAI::Models::Audio::Voice::Type]
+        required :type, enum: -> { OpenAI::Audio::Voice::Type }
+
+        # @!method initialize(id:, created_at:, name:, type:, object: :"audio.voice")
+        #   A custom voice that can be used for audio output. Voices created from text
+        #   prompts are supported only in Live.
+        #
+        #   @param id [String]
+        #     The voice identifier, which can be referenced in API endpoints.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp (in seconds) for when the voice was created.
+        #
+        #   @param name [String]
+        #     The name of the voice.
+        #
+        #   @param type [Symbol, OpenAI::Models::Audio::Voice::Type]
+        #     How the voice was created. Voices created from text prompts are supported only
+        #     in Live.
+        #
+        #   @param object [Symbol, :"audio.voice"]
+        #     The object type, which is always `audio.voice`.
+
+        # How the voice was created. Voices created from text prompts are supported only
+        # in Live.
+        #
+        # @see OpenAI::Models::Audio::Voice#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          AUDIO_SAMPLE = :audio_sample
+          PROMPT = :prompt
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/audio/voice_create_params.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::Voices#create
+      class VoiceCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute body
+        #   Creates a voice from a consent recording and an audio sample. Requires
+        #   multipart/form-data.
+        #
+        #   @return [OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt]
+        required :body, union: -> { OpenAI::Audio::VoiceCreateParams::Body }
+
+        # @!method initialize(body:, request_options: {})
+        #   @param body [OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt]
+        #     Creates a voice from a consent recording and an audio sample. Requires
+        #     multipart/form-data.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        # Creates a voice from a consent recording and an audio sample. Requires
+        # multipart/form-data.
+        module Body
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # @api private
+          def self.resolve_variant(value, state: nil)
+            if value.is_a?(Hash) && !value.key?(:type) && !value.key?("type")
+              OpenAI::Audio::VoiceCreateParams::Body::AudioSample
+            else
+              super
+            end
+          end
+
+          private_class_method :resolve_variant
+
+          # Creates a voice from a consent recording and an audio sample. Requires multipart/form-data.
+          variant :audio_sample, -> { OpenAI::Audio::VoiceCreateParams::Body::AudioSample }
+
+          # Creates a synthetic voice from a text description. Supports application/json or multipart/form-data.
+          variant :prompt, -> { OpenAI::Audio::VoiceCreateParams::Body::Prompt }
+
+          class AudioSample < OpenAI::Internal::Type::BaseModel
+            # @!attribute audio_sample
+            #   The sample audio recording file. Maximum size is 10 MiB.
+            #
+            #   Supported MIME types: `audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`,
+            #   `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.
+            #
+            #   `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.
+            #
+            #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
+            required :audio_sample, OpenAI::Internal::Type::FileInput
+
+            # @!attribute consent
+            #   The consent recording ID (for example, `cons_1234`).
+            #
+            #   @return [String]
+            required :consent, String
+
+            # @!attribute name
+            #   The name of the new voice.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute type
+            #   The voice creation method. Defaults to `audio_sample` when omitted.
+            #
+            #   @return [Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::Type, nil]
+            optional :type, enum: -> { OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type }
+
+            # @!method initialize(audio_sample:, consent:, name:, type: nil)
+            #   Creates a voice from a consent recording and an audio sample. Requires
+            #   multipart/form-data.
+            #
+            #   @param audio_sample [Pathname, StringIO, IO, String, OpenAI::FilePart]
+            #     The sample audio recording file. Maximum size is 10 MiB.
+            #
+            #     Supported MIME types: `audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`,
+            #     `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.
+            #
+            #     `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 consent [String]
+            #     The consent recording ID (for example, `cons_1234`).
+            #
+            #   @param name [String]
+            #     The name of the new voice.
+            #
+            #   @param type [Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::Type]
+            #     The voice creation method. Defaults to `audio_sample` when omitted.
+
+            # The voice creation method. Defaults to `audio_sample` when omitted.
+            #
+            # @see OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample#type
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              AUDIO_SAMPLE = :audio_sample
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Prompt < OpenAI::Internal::Type::BaseModel
+            # @!attribute name
+            #   The name of the new voice.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute prompt
+            #   A description of the desired voice. Must not contain only whitespace.
+            #
+            #   @return [String]
+            required :prompt, String
+
+            # @!attribute type
+            #   Set to `prompt` to create a voice from a text description.
+            #
+            #   @return [Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Type]
+            required :type, enum: -> { OpenAI::Audio::VoiceCreateParams::Body::Prompt::Type }
+
+            # @!attribute model
+            #   The voice creation model to use. Defaults to `auto`.
+            #
+            #   @return [String, Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Model, nil]
+            optional :model, union: -> { OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model }
+
+            # @!attribute script_hint
+            #   Optional text for the voice to speak during creation. If omitted, a script is
+            #   generated from the prompt. Must not be blank after trimming whitespace; scripts
+            #   that are too short are rejected.
+            #
+            #   @return [String, nil]
+            optional :script_hint, String
+
+            # @!method initialize(name:, prompt:, type:, model: nil, script_hint: nil)
+            #   Creates a synthetic voice from a text description. Supports application/json or
+            #   multipart/form-data.
+            #
+            #   @param name [String]
+            #     The name of the new voice.
+            #
+            #   @param prompt [String]
+            #     A description of the desired voice. Must not contain only whitespace.
+            #
+            #   @param type [Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Type]
+            #     Set to `prompt` to create a voice from a text description.
+            #
+            #   @param model [String, Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Model]
+            #     The voice creation model to use. Defaults to `auto`.
+            #
+            #   @param script_hint [String]
+            #     Optional text for the voice to speak during creation. If omitted, a script is
+            #     generated from the prompt. Must not be blank after trimming whitespace; scripts
+            #     that are too short are rejected.
+
+            # Set to `prompt` to create a voice from a text description.
+            #
+            # @see OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt#type
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              PROMPT = :prompt
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The voice creation model to use. Defaults to `auto`.
+            #
+            # @see OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt#model
+            module Model
+              extend OpenAI::Internal::Type::Union
+
+              variant String
+
+              variant const: -> { OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Model::AUTO }
+
+              variant const: -> { OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Model::MODEL_2026_10_01 }
+
+              # @!method self.variants
+              #   @return [Array(String, Symbol)]
+
+              define_sorbet_constant!(:Variants) do
+                T.type_alias { T.any(String, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::TaggedSymbol) }
+              end
+
+              # @!group
+
+              AUTO = :auto
+              MODEL_2026_10_01 = :"2026-10-01"
+
+              # @!endgroup
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt)]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_create_params.rb

@@ -123,9 +123,6 @@ module OpenAI
           # Uses the fast service tier.
           FAST = :fast
 
-          # Uses the ultrafast service tier.
-          ULTRAFAST = :ultrafast
-
           # @!method self.values
           #   @return [Array<Symbol>]
         end

data/lib/openai/models/beta/agent_update_params.rb

@@ -130,9 +130,6 @@ module OpenAI
           # Uses the fast service tier.
           FAST = :fast
 
-          # Uses the ultrafast service tier.
-          ULTRAFAST = :ultrafast
-
           # @!method self.values
           #   @return [Array<Symbol>]
         end

data/lib/openai/models/beta/agents/session_create_params.rb

@@ -183,9 +183,6 @@ module OpenAI
               # Uses the fast service tier.
               FAST = :fast
 
-              # Uses the ultrafast service tier.
-              ULTRAFAST = :ultrafast
-
               # @!method self.values
               #   @return [Array<Symbol>]
             end

data/lib/openai/models/beta/agents/session_update_params.rb

@@ -134,9 +134,6 @@ module OpenAI
               # Uses the fast service tier.
               FAST = :fast
 
-              # Uses the ultrafast service tier.
-              ULTRAFAST = :ultrafast
-
               # @!method self.values
               #   @return [Array<Symbol>]
             end

data/lib/openai/models/beta/beta_response.rb

@@ -937,96 +937,316 @@ 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"
+          # @deprecated Announced shutdown date: 2026-10-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           O1_PRO = :"o1-pro"
+          # @deprecated Announced shutdown date: 2026-10-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
+          # @deprecated Announced shutdown date: 2026-12-11. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           O3_PRO = :"o3-pro"
+          # @deprecated Announced shutdown date: 2026-12-11. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
+          # @deprecated Announced shutdown date: 2026-07-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           O3_DEEP_RESEARCH = :"o3-deep-research"
+          # @deprecated Announced shutdown date: 2026-07-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
+          # @deprecated Announced shutdown date: 2026-07-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
+          # @deprecated Announced shutdown date: 2026-07-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
+          # @deprecated Announced shutdown date: 2026-07-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           COMPUTER_USE_PREVIEW = :"computer-use-preview"
+          # @deprecated Announced shutdown date: 2026-07-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
           GPT_5_5_PRO = :"gpt-5.5-pro"
           GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
+          # @deprecated Announced shutdown date: 2026-07-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_CODEX = :"gpt-5-codex"
+          # @deprecated Announced shutdown date: 2026-12-11. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_PRO = :"gpt-5-pro"
+          # @deprecated Announced shutdown date: 2026-12-11. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
+          # @deprecated Announced shutdown date: 2026-07-23. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
           GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
           GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"