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/realtime/realtime_response_create_audio_output.rb CHANGED Viewed

@@ -27,8 +27,9 @@ module OpenAI
           #   `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
           #   `cedar`. You may also provide a custom voice object with an `id`, for example
           #   `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
-          #   model has responded with audio at least once. We recommend `marin` and `cedar`
-          #   for best quality.
+          #   model has responded with audio at least once. Custom voices must be created from
+          #   audio samples. Voices created from text prompts are supported only in Live. We
+          #   recommend `marin` and `cedar` for best quality.
           #
           #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice, nil]
           optional :voice, union: -> { OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice }
@@ -42,15 +43,17 @@ module OpenAI
           #     `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
           #     `cedar`. You may also provide a custom voice object with an `id`, for example
           #     `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
-          #     model has responded with audio at least once. We recommend `marin` and `cedar`
-          #     for best quality.
+          #     model has responded with audio at least once. Custom voices must be created from
+          #     audio samples. Voices created from text prompts are supported only in Live. We
+          #     recommend `marin` and `cedar` for best quality.
           # The voice the model uses to respond. Supported built-in voices are `alloy`,
           # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
           # `cedar`. You may also provide a custom voice object with an `id`, for example
           # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
-          # model has responded with audio at least once. We recommend `marin` and `cedar`
-          # for best quality.
+          # model has responded with audio at least once. Custom voices must be created from
+          # audio samples. Voices created from text prompts are supported only in Live. We
+          # recommend `marin` and `cedar` for best quality.
           #
           # @see OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output#voice
           module Voice

data/lib/openai/models/responses/response_compact_params.rb CHANGED Viewed

@@ -428,96 +428,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"

data/lib/openai/models/responses/tool.rb CHANGED Viewed

@@ -709,9 +709,7 @@ 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.
           #
           #   @return [String, Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Size, nil]
           optional :size, union: -> { OpenAI::Responses::Tool::ImageGeneration::Size }
@@ -779,9 +777,7 @@ 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 type [Symbol, :image_generation]
           #     The type of the image generation tool. Always `image_generation`.
@@ -978,9 +974,7 @@ 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.
           #
           # @see OpenAI::Models::Responses::Tool::ImageGeneration#size
           module Size

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

@@ -14,21 +14,63 @@ module OpenAI
       module ResponsesOnlyModel
         extend OpenAI::Internal::Type::Enum
+        # @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"

data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb ADDED Viewed

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+module OpenAI
+  module Models
+    module Webhooks
+      class AgentSessionActionRequiredWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+        # @!attribute created_at
+        #   The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+        # @!attribute data
+        #
+        #   @return [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data }
+        # @!attribute object
+        #   The object type. Always `event`.
+        #
+        #   @return [Symbol, :event]
+        required :object, const: :event
+        # @!attribute type
+        #   The event type. Always `agent.session.action_required`.
+        #
+        #   @return [Symbol, :"agent.session.action_required"]
+        required :type, const: :"agent.session.action_required"
+        # @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.action_required")
+        #   Sent when an agent session requires an action. Retrieve the session for action
+        #   details.
+        #
+        #   @param id [String]
+        #     The unique ID of the event.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @param data [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data]
+        #
+        #   @param object [Symbol, :event]
+        #     The object type. Always `event`.
+        #
+        #   @param type [Symbol, :"agent.session.action_required"]
+        #     The event type. Always `agent.session.action_required`.
+        # @see OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the session.
+          #
+          #   @return [String]
+          required :id, String
+          # @!attribute required_action
+          #   The action type. Retrieve the session for action details.
+          #
+          #   @return [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction]
+          required(
+            :required_action,
+            -> { OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction }
+          )
+          # @!method initialize(id:, required_action:)
+          #   @param id [String]
+          #     The ID of the session.
+          #
+          #   @param required_action [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction]
+          #     The action type. Retrieve the session for action details.
+          # @see OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data#required_action
+          class RequiredAction < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type]
+            required(
+              :type,
+              enum: -> { OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type }
+            )
+            # @!method initialize(type:)
+            #   The action type. Retrieve the session for action details.
+            #
+            #   @param type [Symbol, OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type]
+            # @see OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction#type
+            module Type
+              extend OpenAI::Internal::Type::Enum
+              COMPUTER_USE_APPROVAL_REQUEST = :computer_use_approval_request
+              FUNCTION_CALL = :function_call
+              ENVIRONMENT_CONNECTION = :environment_connection
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end