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
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +16 -3
  5. data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +16 -3
  6. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +16 -3
  7. data/lib/openai/models/admin/organization/usage_completions_response.rb +16 -3
  8. data/lib/openai/models/admin/organization/usage_costs_response.rb +16 -3
  9. data/lib/openai/models/admin/organization/usage_embeddings_response.rb +16 -3
  10. data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +16 -3
  11. data/lib/openai/models/admin/organization/usage_images_response.rb +16 -3
  12. data/lib/openai/models/admin/organization/usage_moderations_response.rb +16 -3
  13. data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +16 -3
  14. data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +16 -3
  15. data/lib/openai/models/all_models.rb +42 -0
  16. data/lib/openai/models/audio/speech_create_params.rb +6 -0
  17. data/lib/openai/models/audio/voice.rb +75 -0
  18. data/lib/openai/models/audio/voice_create_params.rb +217 -0
  19. data/lib/openai/models/beta/agent_create_params.rb +0 -3
  20. data/lib/openai/models/beta/agent_update_params.rb +0 -3
  21. data/lib/openai/models/beta/agents/session_create_params.rb +0 -3
  22. data/lib/openai/models/beta/agents/session_update_params.rb +0 -3
  23. data/lib/openai/models/beta/beta_response.rb +220 -0
  24. data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
  25. data/lib/openai/models/beta/beta_tool.rb +3 -9
  26. data/lib/openai/models/beta/response_compact_params.rb +220 -0
  27. data/lib/openai/models/beta/response_create_params.rb +220 -0
  28. data/lib/openai/models/chat/chat_completion_audio_param.rb +6 -3
  29. data/lib/openai/models/chat_model.rb +178 -0
  30. data/lib/openai/models/image.rb +14 -14
  31. data/lib/openai/models/image_create_variation_params.rb +7 -7
  32. data/lib/openai/models/image_edit_params.rb +76 -87
  33. data/lib/openai/models/image_generate_params.rb +51 -62
  34. data/lib/openai/models/image_model.rb +5 -3
  35. data/lib/openai/models/realtime/realtime_audio_config_output.rb +9 -6
  36. data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +9 -6
  37. data/lib/openai/models/responses/response_compact_params.rb +220 -0
  38. data/lib/openai/models/responses/tool.rb +3 -9
  39. data/lib/openai/models/responses_model.rb +42 -0
  40. data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +109 -0
  41. data/lib/openai/models/webhooks/agent_session_created_webhook_event.rb +106 -0
  42. data/lib/openai/models/webhooks/agent_session_failed_webhook_event.rb +86 -0
  43. data/lib/openai/models/webhooks/agent_session_idle_webhook_event.rb +86 -0
  44. data/lib/openai/models/webhooks/agent_session_in_progress_webhook_event.rb +86 -0
  45. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +18 -2
  46. data/lib/openai/models/webhooks/webhook_create_params.rb +5 -0
  47. data/lib/openai/models/webhooks/webhook_test_params.rb +5 -0
  48. data/lib/openai/models/webhooks/webhook_update_params.rb +5 -0
  49. data/lib/openai/resources/audio/speech.rb +2 -0
  50. data/lib/openai/resources/audio/voices.rb +53 -0
  51. data/lib/openai/resources/audio.rb +5 -0
  52. data/lib/openai/resources/images.rb +71 -103
  53. data/lib/openai/resources/webhooks.rb +1 -1
  54. data/lib/openai/version.rb +1 -1
  55. data/lib/openai.rb +8 -0
  56. data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +19 -2
  57. data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +19 -2
  58. data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +19 -2
  59. data/rbi/openai/models/admin/organization/usage_completions_response.rbi +19 -2
  60. data/rbi/openai/models/admin/organization/usage_costs_response.rbi +19 -2
  61. data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +19 -2
  62. data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +19 -2
  63. data/rbi/openai/models/admin/organization/usage_images_response.rbi +19 -2
  64. data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +19 -2
  65. data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +19 -2
  66. data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +19 -2
  67. data/rbi/openai/models/audio/speech_create_params.rbi +6 -0
  68. data/rbi/openai/models/audio/voice.rbi +111 -0
  69. data/rbi/openai/models/audio/voice_create_params.rbi +321 -0
  70. data/rbi/openai/models/beta/agent_create_params.rbi +0 -3
  71. data/rbi/openai/models/beta/agent_update_params.rbi +0 -3
  72. data/rbi/openai/models/beta/agents/session_create_params.rbi +0 -3
  73. data/rbi/openai/models/beta/agents/session_update_params.rbi +0 -3
  74. data/rbi/openai/models/beta/beta_tool.rbi +3 -9
  75. data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
  76. data/rbi/openai/models/image.rbi +14 -14
  77. data/rbi/openai/models/image_create_variation_params.rbi +6 -6
  78. data/rbi/openai/models/image_edit_params.rbi +61 -82
  79. data/rbi/openai/models/image_generate_params.rbi +30 -61
  80. data/rbi/openai/models/image_model.rbi +3 -3
  81. data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +9 -6
  82. data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +9 -6
  83. data/rbi/openai/models/responses/tool.rbi +3 -9
  84. data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +222 -0
  85. data/rbi/openai/models/webhooks/agent_session_created_webhook_event.rbi +202 -0
  86. data/rbi/openai/models/webhooks/agent_session_failed_webhook_event.rbi +151 -0
  87. data/rbi/openai/models/webhooks/agent_session_idle_webhook_event.rbi +151 -0
  88. data/rbi/openai/models/webhooks/agent_session_in_progress_webhook_event.rbi +151 -0
  89. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +7 -1
  90. data/rbi/openai/models/webhooks/webhook_create_params.rbi +20 -0
  91. data/rbi/openai/models/webhooks/webhook_test_params.rbi +20 -0
  92. data/rbi/openai/models/webhooks/webhook_update_params.rbi +20 -0
  93. data/rbi/openai/resources/audio/speech.rbi +2 -0
  94. data/rbi/openai/resources/audio/voices.rbi +49 -0
  95. data/rbi/openai/resources/audio.rbi +4 -0
  96. data/rbi/openai/resources/images.rbi +69 -103
  97. data/rbi/openai/resources/webhooks.rbi +5 -0
  98. data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +20 -3
  99. data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +20 -3
  100. data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +20 -3
  101. data/sig/openai/models/admin/organization/usage_completions_response.rbs +20 -3
  102. data/sig/openai/models/admin/organization/usage_costs_response.rbs +20 -3
  103. data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +20 -3
  104. data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +20 -3
  105. data/sig/openai/models/admin/organization/usage_images_response.rbs +20 -3
  106. data/sig/openai/models/admin/organization/usage_moderations_response.rbs +20 -3
  107. data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +20 -3
  108. data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +20 -3
  109. data/sig/openai/models/audio/speech_create_params.rbs +4 -0
  110. data/sig/openai/models/audio/voice.rbs +70 -0
  111. data/sig/openai/models/audio/voice_create_params.rbs +203 -0
  112. data/sig/openai/models/beta/agent_create_params.rbs +1 -5
  113. data/sig/openai/models/beta/agent_update_params.rbs +1 -5
  114. data/sig/openai/models/beta/agents/session_create_params.rbs +1 -5
  115. data/sig/openai/models/beta/agents/session_update_params.rbs +1 -5
  116. data/sig/openai/models/beta/beta_tool.rbs +3 -9
  117. data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
  118. data/sig/openai/models/image.rbs +21 -21
  119. data/sig/openai/models/image_create_variation_params.rbs +4 -4
  120. data/sig/openai/models/image_edit_params.rbs +46 -60
  121. data/sig/openai/models/image_generate_params.rbs +23 -45
  122. data/sig/openai/models/image_model.rbs +6 -6
  123. data/sig/openai/models/realtime/realtime_audio_config_output.rbs +9 -6
  124. data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +9 -6
  125. data/sig/openai/models/responses/tool.rbs +3 -9
  126. data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +114 -0
  127. data/sig/openai/models/webhooks/agent_session_created_webhook_event.rbs +115 -0
  128. data/sig/openai/models/webhooks/agent_session_failed_webhook_event.rbs +89 -0
  129. data/sig/openai/models/webhooks/agent_session_idle_webhook_event.rbs +89 -0
  130. data/sig/openai/models/webhooks/agent_session_in_progress_webhook_event.rbs +89 -0
  131. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +6 -1
  132. data/sig/openai/models/webhooks/webhook_create_params.rbs +10 -0
  133. data/sig/openai/models/webhooks/webhook_test_params.rbs +10 -0
  134. data/sig/openai/models/webhooks/webhook_update_params.rbs +10 -0
  135. data/sig/openai/resources/audio/voices.rbs +14 -0
  136. data/sig/openai/resources/audio.rbs +2 -0
  137. data/sig/openai/resources/webhooks.rbs +6 -1
  138. metadata +25 -1
@@ -1324,96 +1324,316 @@ module OpenAI
1324
1324
  GPT_5_4_NANO = :"gpt-5.4-nano"
1325
1325
  GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
1326
1326
  GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
1327
+ # @deprecated Announced shutdown date: 2026-08-10. See
1328
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1329
+ # replacements.
1327
1330
  GPT_5_3_CHAT_LATEST = :"gpt-5.3-chat-latest"
1328
1331
  GPT_5_2 = :"gpt-5.2"
1329
1332
  GPT_5_2_2025_12_11 = :"gpt-5.2-2025-12-11"
1333
+ # @deprecated Announced shutdown date: 2026-08-10. See
1334
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1335
+ # replacements.
1330
1336
  GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
1331
1337
  GPT_5_2_PRO = :"gpt-5.2-pro"
1332
1338
  GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
1333
1339
  GPT_5_1 = :"gpt-5.1"
1334
1340
  GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
1341
+ # @deprecated Announced shutdown date: 2026-07-23. See
1342
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1343
+ # replacements.
1335
1344
  GPT_5_1_CODEX = :"gpt-5.1-codex"
1345
+ # @deprecated Not a supported model ID. Retained for SDK compatibility.
1336
1346
  GPT_5_1_MINI = :"gpt-5.1-mini"
1347
+ # @deprecated Announced shutdown date: 2026-07-23. See
1348
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1349
+ # replacements.
1337
1350
  GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
1351
+ # @deprecated Announced shutdown date: 2026-12-11. See
1352
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1353
+ # replacements.
1338
1354
  GPT_5 = :"gpt-5"
1355
+ # @deprecated Announced shutdown date: 2026-12-11. See
1356
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1357
+ # replacements.
1339
1358
  GPT_5_MINI = :"gpt-5-mini"
1359
+ # @deprecated Announced shutdown date: 2026-12-11. See
1360
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1361
+ # replacements.
1340
1362
  GPT_5_NANO = :"gpt-5-nano"
1363
+ # @deprecated Announced shutdown date: 2026-12-11. See
1364
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1365
+ # replacements.
1341
1366
  GPT_5_2025_08_07 = :"gpt-5-2025-08-07"
1367
+ # @deprecated Announced shutdown date: 2026-12-11. See
1368
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1369
+ # replacements.
1342
1370
  GPT_5_MINI_2025_08_07 = :"gpt-5-mini-2025-08-07"
1371
+ # @deprecated Announced shutdown date: 2026-12-11. See
1372
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1373
+ # replacements.
1343
1374
  GPT_5_NANO_2025_08_07 = :"gpt-5-nano-2025-08-07"
1375
+ # @deprecated Announced shutdown date: 2026-07-23. See
1376
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1377
+ # replacements.
1344
1378
  GPT_5_CHAT_LATEST = :"gpt-5-chat-latest"
1345
1379
  GPT_4_1 = :"gpt-4.1"
1346
1380
  GPT_4_1_MINI = :"gpt-4.1-mini"
1381
+ # @deprecated Announced shutdown date: 2026-10-23. See
1382
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1383
+ # replacements.
1347
1384
  GPT_4_1_NANO = :"gpt-4.1-nano"
1348
1385
  GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
1349
1386
  GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
1387
+ # @deprecated Announced shutdown date: 2026-10-23. See
1388
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1389
+ # replacements.
1350
1390
  GPT_4_1_NANO_2025_04_14 = :"gpt-4.1-nano-2025-04-14"
1391
+ # @deprecated Announced shutdown date: 2026-10-23. See
1392
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1393
+ # replacements.
1351
1394
  O4_MINI = :"o4-mini"
1395
+ # @deprecated Announced shutdown date: 2026-10-23. See
1396
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1397
+ # replacements.
1352
1398
  O4_MINI_2025_04_16 = :"o4-mini-2025-04-16"
1399
+ # @deprecated Announced shutdown date: 2026-12-11. See
1400
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1401
+ # replacements.
1353
1402
  O3 = :o3
1403
+ # @deprecated Announced shutdown date: 2026-12-11. See
1404
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1405
+ # replacements.
1354
1406
  O3_2025_04_16 = :"o3-2025-04-16"
1407
+ # @deprecated Announced shutdown date: 2026-10-23. See
1408
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1409
+ # replacements.
1355
1410
  O3_MINI = :"o3-mini"
1411
+ # @deprecated Announced shutdown date: 2026-10-23. See
1412
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1413
+ # replacements.
1356
1414
  O3_MINI_2025_01_31 = :"o3-mini-2025-01-31"
1415
+ # @deprecated Announced shutdown date: 2026-10-23. See
1416
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1417
+ # replacements.
1357
1418
  O1 = :o1
1419
+ # @deprecated Announced shutdown date: 2026-10-23. See
1420
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1421
+ # replacements.
1358
1422
  O1_2024_12_17 = :"o1-2024-12-17"
1423
+ # @deprecated Announced shutdown date: 2025-07-28. See
1424
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1425
+ # replacements.
1359
1426
  O1_PREVIEW = :"o1-preview"
1427
+ # @deprecated Announced shutdown date: 2025-07-28. See
1428
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1429
+ # replacements.
1360
1430
  O1_PREVIEW_2024_09_12 = :"o1-preview-2024-09-12"
1431
+ # @deprecated Announced shutdown date: 2025-10-27. See
1432
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1433
+ # replacements.
1361
1434
  O1_MINI = :"o1-mini"
1435
+ # @deprecated Announced shutdown date: 2025-10-27. See
1436
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1437
+ # replacements.
1362
1438
  O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
1363
1439
  GPT_4O = :"gpt-4o"
1364
1440
  GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
1365
1441
  GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
1442
+ # @deprecated Announced shutdown date: 2026-10-23. See
1443
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1444
+ # replacements.
1366
1445
  GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
1446
+ # @deprecated Announced shutdown date: 2027-01-20. See
1447
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1448
+ # replacements.
1367
1449
  GPT_AUDIO_MINI = :"gpt-audio-mini"
1450
+ # @deprecated Announced shutdown date: 2027-01-20. See
1451
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1452
+ # replacements.
1368
1453
  GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
1454
+ # @deprecated Announced shutdown date: 2026-05-07. See
1455
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1456
+ # replacements.
1369
1457
  GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
1458
+ # @deprecated Announced shutdown date: 2025-10-10. See
1459
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1460
+ # replacements.
1370
1461
  GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
1462
+ # @deprecated Announced shutdown date: 2026-05-07. See
1463
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1464
+ # replacements.
1371
1465
  GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
1466
+ # @deprecated Announced shutdown date: 2026-05-07. See
1467
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1468
+ # replacements.
1372
1469
  GPT_4O_AUDIO_PREVIEW_2025_06_03 = :"gpt-4o-audio-preview-2025-06-03"
1470
+ # @deprecated Announced shutdown date: 2026-05-07. See
1471
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1472
+ # replacements.
1373
1473
  GPT_4O_MINI_AUDIO_PREVIEW = :"gpt-4o-mini-audio-preview"
1474
+ # @deprecated Announced shutdown date: 2026-05-07. See
1475
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1476
+ # replacements.
1374
1477
  GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-mini-audio-preview-2024-12-17"
1478
+ # @deprecated Announced shutdown date: 2026-07-23. See
1479
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1480
+ # replacements.
1375
1481
  GPT_4O_SEARCH_PREVIEW = :"gpt-4o-search-preview"
1482
+ # @deprecated Announced shutdown date: 2026-07-23. See
1483
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1484
+ # replacements.
1376
1485
  GPT_4O_MINI_SEARCH_PREVIEW = :"gpt-4o-mini-search-preview"
1486
+ # @deprecated Announced shutdown date: 2026-07-23. See
1487
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1488
+ # replacements.
1377
1489
  GPT_4O_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-search-preview-2025-03-11"
1490
+ # @deprecated Announced shutdown date: 2026-07-23. See
1491
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1492
+ # replacements.
1378
1493
  GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-mini-search-preview-2025-03-11"
1494
+ # @deprecated Announced shutdown date: 2026-02-17. See
1495
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1496
+ # replacements.
1379
1497
  CHATGPT_4O_LATEST = :"chatgpt-4o-latest"
1498
+ # @deprecated Announced shutdown date: 2026-02-12. See
1499
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1500
+ # replacements.
1380
1501
  CODEX_MINI_LATEST = :"codex-mini-latest"
1381
1502
  GPT_4O_MINI = :"gpt-4o-mini"
1382
1503
  GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
1504
+ # @deprecated Announced shutdown date: 2026-10-23. See
1505
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1506
+ # replacements.
1383
1507
  GPT_4_TURBO = :"gpt-4-turbo"
1508
+ # @deprecated Announced shutdown date: 2026-10-23. See
1509
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1510
+ # replacements.
1384
1511
  GPT_4_TURBO_2024_04_09 = :"gpt-4-turbo-2024-04-09"
1512
+ # @deprecated Announced shutdown date: 2026-03-26. See
1513
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1514
+ # replacements.
1385
1515
  GPT_4_0125_PREVIEW = :"gpt-4-0125-preview"
1516
+ # @deprecated Announced shutdown date: 2026-03-26. See
1517
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1518
+ # replacements.
1386
1519
  GPT_4_TURBO_PREVIEW = :"gpt-4-turbo-preview"
1520
+ # @deprecated Announced shutdown date: 2026-10-23. See
1521
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1522
+ # replacements.
1387
1523
  GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
1524
+ # @deprecated Announced shutdown date: 2024-12-06. See
1525
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1526
+ # replacements.
1388
1527
  GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
1528
+ # @deprecated Announced shutdown date: 2026-10-23. See
1529
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1530
+ # replacements.
1389
1531
  GPT_4 = :"gpt-4"
1532
+ # @deprecated Announced shutdown date: 2026-03-26. See
1533
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1534
+ # replacements.
1390
1535
  GPT_4_0314 = :"gpt-4-0314"
1536
+ # @deprecated Announced shutdown date: 2026-10-23. See
1537
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1538
+ # replacements.
1391
1539
  GPT_4_0613 = :"gpt-4-0613"
1540
+ # @deprecated Announced shutdown date: 2025-06-06. See
1541
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1542
+ # replacements.
1392
1543
  GPT_4_32K = :"gpt-4-32k"
1544
+ # @deprecated Announced shutdown date: 2025-06-06. See
1545
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1546
+ # replacements.
1393
1547
  GPT_4_32K_0314 = :"gpt-4-32k-0314"
1548
+ # @deprecated Announced shutdown date: 2025-06-06. See
1549
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1550
+ # replacements.
1394
1551
  GPT_4_32K_0613 = :"gpt-4-32k-0613"
1552
+ # @deprecated Announced shutdown date: 2026-10-23. See
1553
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1554
+ # replacements.
1395
1555
  GPT_3_5_TURBO = :"gpt-3.5-turbo"
1556
+ # @deprecated Announced shutdown date: 2024-09-13. See
1557
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1558
+ # replacements.
1396
1559
  GPT_3_5_TURBO_16K = :"gpt-3.5-turbo-16k"
1560
+ # @deprecated Announced shutdown date: 2024-09-13. See
1561
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1562
+ # replacements.
1397
1563
  GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
1564
+ # @deprecated Announced shutdown date: 2024-09-13. See
1565
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1566
+ # replacements.
1398
1567
  GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
1568
+ # @deprecated Announced shutdown date: 2026-09-28. See
1569
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1570
+ # replacements.
1399
1571
  GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
1572
+ # @deprecated Announced shutdown date: 2026-10-23. See
1573
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1574
+ # replacements.
1400
1575
  GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
1576
+ # @deprecated Announced shutdown date: 2024-09-13. See
1577
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1578
+ # replacements.
1401
1579
  GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
1580
+ # @deprecated Announced shutdown date: 2026-10-23. See
1581
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1582
+ # replacements.
1402
1583
  O1_PRO = :"o1-pro"
1584
+ # @deprecated Announced shutdown date: 2026-10-23. See
1585
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1586
+ # replacements.
1403
1587
  O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
1588
+ # @deprecated Announced shutdown date: 2026-12-11. See
1589
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1590
+ # replacements.
1404
1591
  O3_PRO = :"o3-pro"
1592
+ # @deprecated Announced shutdown date: 2026-12-11. See
1593
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1594
+ # replacements.
1405
1595
  O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
1596
+ # @deprecated Announced shutdown date: 2026-07-23. See
1597
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1598
+ # replacements.
1406
1599
  O3_DEEP_RESEARCH = :"o3-deep-research"
1600
+ # @deprecated Announced shutdown date: 2026-07-23. See
1601
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1602
+ # replacements.
1407
1603
  O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
1604
+ # @deprecated Announced shutdown date: 2026-07-23. See
1605
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1606
+ # replacements.
1408
1607
  O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
1608
+ # @deprecated Announced shutdown date: 2026-07-23. See
1609
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1610
+ # replacements.
1409
1611
  O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
1612
+ # @deprecated Announced shutdown date: 2026-07-23. See
1613
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1614
+ # replacements.
1410
1615
  COMPUTER_USE_PREVIEW = :"computer-use-preview"
1616
+ # @deprecated Announced shutdown date: 2026-07-23. See
1617
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1618
+ # replacements.
1411
1619
  COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
1412
1620
  GPT_5_5_PRO = :"gpt-5.5-pro"
1413
1621
  GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
1622
+ # @deprecated Announced shutdown date: 2026-07-23. See
1623
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1624
+ # replacements.
1414
1625
  GPT_5_CODEX = :"gpt-5-codex"
1626
+ # @deprecated Announced shutdown date: 2026-12-11. See
1627
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1628
+ # replacements.
1415
1629
  GPT_5_PRO = :"gpt-5-pro"
1630
+ # @deprecated Announced shutdown date: 2026-12-11. See
1631
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1632
+ # replacements.
1416
1633
  GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
1634
+ # @deprecated Announced shutdown date: 2026-07-23. See
1635
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1636
+ # replacements.
1417
1637
  GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
1418
1638
  GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
1419
1639
  GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
@@ -707,9 +707,7 @@ module OpenAI
707
707
  # the maximum supported resolution is `3840x2160`. The requested size must also
708
708
  # satisfy the model's current pixel and edge limits. The standard sizes
709
709
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
710
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
711
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
712
- # `1024x1024`, `1792x1024`, or `1024x1792`.
710
+ # `auto` is supported for models that allow automatic sizing.
713
711
  #
714
712
  # @return [String, Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Size, nil]
715
713
  optional :size, union: -> { OpenAI::Beta::BetaTool::ImageGeneration::Size }
@@ -777,9 +775,7 @@ module OpenAI
777
775
  # the maximum supported resolution is `3840x2160`. The requested size must also
778
776
  # satisfy the model's current pixel and edge limits. The standard sizes
779
777
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
780
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
781
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
782
- # `1024x1024`, `1792x1024`, or `1024x1792`.
778
+ # `auto` is supported for models that allow automatic sizing.
783
779
  #
784
780
  # @param type [Symbol, :image_generation]
785
781
  # The type of the image generation tool. Always `image_generation`.
@@ -976,9 +972,7 @@ module OpenAI
976
972
  # the maximum supported resolution is `3840x2160`. The requested size must also
977
973
  # satisfy the model's current pixel and edge limits. The standard sizes
978
974
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
979
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
980
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
981
- # `1024x1024`, `1792x1024`, or `1024x1792`.
975
+ # `auto` is supported for models that allow automatic sizing.
982
976
  #
983
977
  # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#size
984
978
  module Size