openai 0.97.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 (244) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +31 -0
  3. data/README.md +76 -1
  4. data/lib/openai/helpers/agents/session_stream.rb +60 -3
  5. data/lib/openai/helpers/beta/agents/artifacts.rb +72 -0
  6. data/lib/openai/helpers/beta/agents/creation_stream.rb +69 -0
  7. data/lib/openai/helpers/beta/agents/files.rb +236 -0
  8. data/lib/openai/helpers/beta/agents/function_tool.rb +65 -0
  9. data/lib/openai/helpers/beta/agents/model_adapter.rb +27 -0
  10. data/lib/openai/helpers/beta/agents/result.rb +170 -0
  11. data/lib/openai/helpers/beta/agents/typed_output.rb +191 -0
  12. data/lib/openai/helpers/live/websocket.rb +7 -1
  13. data/lib/openai/helpers/realtime/conversation_item_variant_resolver.rb +1 -1
  14. data/lib/openai/helpers/responses_websocket/connection.rb +7 -1
  15. data/lib/openai/helpers/responses_websocket/session.rb +5 -1
  16. data/lib/openai/helpers/responses_websocket/transports/async_websocket.rb +12 -2
  17. data/lib/openai/internal/transport/base_client.rb +18 -0
  18. data/lib/openai/internal/type/array_of.rb +1 -1
  19. data/lib/openai/internal/type/base_model.rb +6 -3
  20. data/lib/openai/internal/type/converter.rb +50 -3
  21. data/lib/openai/internal/type/hash_of.rb +1 -1
  22. data/lib/openai/internal/type/union.rb +6 -6
  23. data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +16 -3
  24. data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +16 -3
  25. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +16 -3
  26. data/lib/openai/models/admin/organization/usage_completions_response.rb +16 -3
  27. data/lib/openai/models/admin/organization/usage_costs_response.rb +16 -3
  28. data/lib/openai/models/admin/organization/usage_embeddings_response.rb +16 -3
  29. data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +16 -3
  30. data/lib/openai/models/admin/organization/usage_images_response.rb +16 -3
  31. data/lib/openai/models/admin/organization/usage_moderations_response.rb +16 -3
  32. data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +16 -3
  33. data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +16 -3
  34. data/lib/openai/models/all_models.rb +42 -0
  35. data/lib/openai/models/audio/speech_create_params.rb +6 -0
  36. data/lib/openai/models/audio/voice.rb +75 -0
  37. data/lib/openai/models/audio/voice_create_params.rb +217 -0
  38. data/lib/openai/models/beta/agent_create_params.rb +0 -3
  39. data/lib/openai/models/beta/agent_update_params.rb +0 -3
  40. data/lib/openai/models/beta/agents/session_create_params.rb +0 -3
  41. data/lib/openai/models/beta/agents/session_update_params.rb +0 -3
  42. data/lib/openai/models/beta/agents/sessions/session_trace.rb +64 -0
  43. data/lib/openai/models/beta/agents/sessions/trace_list_params.rb +68 -0
  44. data/lib/openai/models/beta/agents/vaults/credential.rb +8 -4
  45. data/lib/openai/models/beta/beta_response.rb +220 -0
  46. data/lib/openai/models/beta/beta_response_output_text.rb +2 -2
  47. data/lib/openai/models/beta/beta_response_output_text_annotation_added_event.rb +2 -2
  48. data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
  49. data/lib/openai/models/beta/beta_tool.rb +3 -9
  50. data/lib/openai/models/beta/environment.rb +33 -1
  51. data/lib/openai/models/beta/environment_param.rb +24 -1
  52. data/lib/openai/models/beta/response_compact_params.rb +220 -0
  53. data/lib/openai/models/beta/response_create_params.rb +220 -0
  54. data/lib/openai/models/beta/session_turn_error.rb +3 -0
  55. data/lib/openai/models/chat/chat_completion_audio_param.rb +6 -3
  56. data/lib/openai/models/chat/chat_completion_content_part_image.rb +1 -0
  57. data/lib/openai/models/chat_model.rb +178 -0
  58. data/lib/openai/models/image.rb +14 -14
  59. data/lib/openai/models/image_create_variation_params.rb +7 -7
  60. data/lib/openai/models/image_edit_params.rb +76 -87
  61. data/lib/openai/models/image_generate_params.rb +51 -62
  62. data/lib/openai/models/image_model.rb +5 -3
  63. data/lib/openai/models/live/fork_server_event.rb +14 -3
  64. data/lib/openai/models/live/server_event.rb +14 -3
  65. data/lib/openai/models/realtime/realtime_audio_config_output.rb +9 -6
  66. data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +9 -6
  67. data/lib/openai/models/realtime/translations/client_secret_create_params.rb +28 -0
  68. data/lib/openai/models/responses/response_compact_params.rb +220 -0
  69. data/lib/openai/models/responses/response_output_text.rb +2 -2
  70. data/lib/openai/models/responses/response_output_text_annotation_added_event.rb +2 -2
  71. data/lib/openai/models/responses/tool.rb +3 -9
  72. data/lib/openai/models/responses_model.rb +42 -0
  73. data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +109 -0
  74. data/lib/openai/models/webhooks/agent_session_created_webhook_event.rb +106 -0
  75. data/lib/openai/models/webhooks/agent_session_failed_webhook_event.rb +86 -0
  76. data/lib/openai/models/webhooks/agent_session_idle_webhook_event.rb +86 -0
  77. data/lib/openai/models/webhooks/agent_session_in_progress_webhook_event.rb +86 -0
  78. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +18 -2
  79. data/lib/openai/models/webhooks/webhook_create_params.rb +5 -0
  80. data/lib/openai/models/webhooks/webhook_test_params.rb +5 -0
  81. data/lib/openai/models/webhooks/webhook_update_params.rb +5 -0
  82. data/lib/openai/resources/audio/speech.rb +2 -0
  83. data/lib/openai/resources/audio/voices.rb +53 -0
  84. data/lib/openai/resources/audio.rb +5 -0
  85. data/lib/openai/resources/beta/agents/environments/files.rb +31 -0
  86. data/lib/openai/resources/beta/agents/sessions/artifacts.rb +8 -0
  87. data/lib/openai/resources/beta/agents/sessions/events.rb +6 -5
  88. data/lib/openai/resources/beta/agents/sessions/traces.rb +58 -0
  89. data/lib/openai/resources/beta/agents/sessions.rb +18 -5
  90. data/lib/openai/resources/evals/runs.rb +1 -1
  91. data/lib/openai/resources/images.rb +71 -103
  92. data/lib/openai/resources/realtime/translations/client_secrets.rb +58 -0
  93. data/lib/openai/resources/realtime/translations.rb +20 -0
  94. data/lib/openai/resources/realtime.rb +4 -0
  95. data/lib/openai/resources/webhooks.rb +1 -1
  96. data/lib/openai/version.rb +1 -1
  97. data/lib/openai.rb +17 -1
  98. data/rbi/openai/helpers/agents.rbi +20 -1
  99. data/rbi/openai/helpers/beta/agents/artifacts.rbi +29 -0
  100. data/rbi/openai/helpers/beta/agents/files.rbi +65 -0
  101. data/rbi/openai/helpers/beta/agents/function_tool.rbi +40 -0
  102. data/rbi/openai/helpers/beta/agents/model_adapter.rbi +22 -0
  103. data/rbi/openai/helpers/beta/agents.rbi +146 -0
  104. data/rbi/openai/internal/transport/base_client.rbi +12 -0
  105. data/rbi/openai/internal/type/base_model.rbi +2 -2
  106. data/rbi/openai/internal/type/converter.rbi +21 -3
  107. data/rbi/openai/internal/type/union.rbi +6 -2
  108. data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +19 -2
  109. data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +19 -2
  110. data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +19 -2
  111. data/rbi/openai/models/admin/organization/usage_completions_response.rbi +19 -2
  112. data/rbi/openai/models/admin/organization/usage_costs_response.rbi +19 -2
  113. data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +19 -2
  114. data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +19 -2
  115. data/rbi/openai/models/admin/organization/usage_images_response.rbi +19 -2
  116. data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +19 -2
  117. data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +19 -2
  118. data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +19 -2
  119. data/rbi/openai/models/audio/speech_create_params.rbi +6 -0
  120. data/rbi/openai/models/audio/voice.rbi +111 -0
  121. data/rbi/openai/models/audio/voice_create_params.rbi +321 -0
  122. data/rbi/openai/models/beta/agent_create_params.rbi +0 -3
  123. data/rbi/openai/models/beta/agent_update_params.rbi +0 -3
  124. data/rbi/openai/models/beta/agents/session_create_params.rbi +0 -3
  125. data/rbi/openai/models/beta/agents/session_update_params.rbi +0 -3
  126. data/rbi/openai/models/beta/agents/sessions/session_trace.rbi +97 -0
  127. data/rbi/openai/models/beta/agents/sessions/trace_list_params.rbi +121 -0
  128. data/rbi/openai/models/beta/agents/vaults/credential.rbi +5 -5
  129. data/rbi/openai/models/beta/beta_response_output_text.rbi +2 -2
  130. data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi +2 -2
  131. data/rbi/openai/models/beta/beta_tool.rbi +3 -9
  132. data/rbi/openai/models/beta/environment.rbi +29 -0
  133. data/rbi/openai/models/beta/environment_param.rbi +31 -0
  134. data/rbi/openai/models/beta/session_turn_error.rbi +3 -0
  135. data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
  136. data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +1 -0
  137. data/rbi/openai/models/image.rbi +14 -14
  138. data/rbi/openai/models/image_create_variation_params.rbi +6 -6
  139. data/rbi/openai/models/image_edit_params.rbi +61 -82
  140. data/rbi/openai/models/image_generate_params.rbi +30 -61
  141. data/rbi/openai/models/image_model.rbi +3 -3
  142. data/rbi/openai/models/live/fork_server_event.rbi +14 -2
  143. data/rbi/openai/models/live/server_event.rbi +14 -2
  144. data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +9 -6
  145. data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +9 -6
  146. data/rbi/openai/models/realtime/translations/client_secret_create_params.rbi +68 -0
  147. data/rbi/openai/models/responses/response_output_text.rbi +2 -2
  148. data/rbi/openai/models/responses/response_output_text_annotation_added_event.rbi +2 -2
  149. data/rbi/openai/models/responses/tool.rbi +3 -9
  150. data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +222 -0
  151. data/rbi/openai/models/webhooks/agent_session_created_webhook_event.rbi +202 -0
  152. data/rbi/openai/models/webhooks/agent_session_failed_webhook_event.rbi +151 -0
  153. data/rbi/openai/models/webhooks/agent_session_idle_webhook_event.rbi +151 -0
  154. data/rbi/openai/models/webhooks/agent_session_in_progress_webhook_event.rbi +151 -0
  155. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +7 -1
  156. data/rbi/openai/models/webhooks/webhook_create_params.rbi +20 -0
  157. data/rbi/openai/models/webhooks/webhook_test_params.rbi +20 -0
  158. data/rbi/openai/models/webhooks/webhook_update_params.rbi +20 -0
  159. data/rbi/openai/resources/audio/speech.rbi +2 -0
  160. data/rbi/openai/resources/audio/voices.rbi +49 -0
  161. data/rbi/openai/resources/audio.rbi +4 -0
  162. data/rbi/openai/resources/beta/agents/environments/files.rbi +31 -0
  163. data/rbi/openai/resources/beta/agents/sessions/artifacts.rbi +8 -0
  164. data/rbi/openai/resources/beta/agents/sessions/events.rbi +6 -5
  165. data/rbi/openai/resources/beta/agents/sessions/traces.rbi +54 -0
  166. data/rbi/openai/resources/beta/agents/sessions.rbi +6 -1
  167. data/rbi/openai/resources/images.rbi +69 -103
  168. data/rbi/openai/resources/realtime/translations/client_secrets.rbi +54 -0
  169. data/rbi/openai/resources/realtime/translations.rbi +22 -0
  170. data/rbi/openai/resources/realtime.rbi +3 -0
  171. data/rbi/openai/resources/webhooks.rbi +5 -0
  172. data/sig/openai/helpers/agents.rbs +7 -0
  173. data/sig/openai/helpers/beta/agents/artifacts.rbs +20 -0
  174. data/sig/openai/helpers/beta/agents/files.rbs +41 -0
  175. data/sig/openai/helpers/beta/agents/function_tool.rbs +24 -0
  176. data/sig/openai/helpers/beta/agents/model_adapter.rbs +16 -0
  177. data/sig/openai/helpers/beta/agents.rbs +71 -0
  178. data/sig/openai/helpers/structured_output.rbs +12 -0
  179. data/sig/openai/internal/transport/base_client.rbs +8 -0
  180. data/sig/openai/internal/type/base_model.rbs +3 -1
  181. data/sig/openai/internal/type/converter.rbs +16 -2
  182. data/sig/openai/internal/type/union.rbs +2 -1
  183. data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +20 -3
  184. data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +20 -3
  185. data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +20 -3
  186. data/sig/openai/models/admin/organization/usage_completions_response.rbs +20 -3
  187. data/sig/openai/models/admin/organization/usage_costs_response.rbs +20 -3
  188. data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +20 -3
  189. data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +20 -3
  190. data/sig/openai/models/admin/organization/usage_images_response.rbs +20 -3
  191. data/sig/openai/models/admin/organization/usage_moderations_response.rbs +20 -3
  192. data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +20 -3
  193. data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +20 -3
  194. data/sig/openai/models/audio/speech_create_params.rbs +4 -0
  195. data/sig/openai/models/audio/voice.rbs +70 -0
  196. data/sig/openai/models/audio/voice_create_params.rbs +203 -0
  197. data/sig/openai/models/beta/agent_create_params.rbs +1 -5
  198. data/sig/openai/models/beta/agent_update_params.rbs +1 -5
  199. data/sig/openai/models/beta/agents/session_create_params.rbs +1 -5
  200. data/sig/openai/models/beta/agents/session_update_params.rbs +1 -5
  201. data/sig/openai/models/beta/agents/sessions/session_trace.rbs +65 -0
  202. data/sig/openai/models/beta/agents/sessions/trace_list_params.rbs +81 -0
  203. data/sig/openai/models/beta/agents/vaults/credential.rbs +5 -5
  204. data/sig/openai/models/beta/beta_response_output_text.rbs +2 -2
  205. data/sig/openai/models/beta/beta_response_output_text_annotation_added_event.rbs +2 -2
  206. data/sig/openai/models/beta/beta_tool.rbs +3 -9
  207. data/sig/openai/models/beta/environment.rbs +22 -0
  208. data/sig/openai/models/beta/environment_param.rbs +25 -0
  209. data/sig/openai/models/beta/session_turn_error.rbs +4 -0
  210. data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
  211. data/sig/openai/models/chat/chat_completion_content_part_image.rbs +2 -1
  212. data/sig/openai/models/image.rbs +21 -21
  213. data/sig/openai/models/image_create_variation_params.rbs +4 -4
  214. data/sig/openai/models/image_edit_params.rbs +46 -60
  215. data/sig/openai/models/image_generate_params.rbs +23 -45
  216. data/sig/openai/models/image_model.rbs +6 -6
  217. data/sig/openai/models/live/fork_server_event.rbs +17 -2
  218. data/sig/openai/models/live/server_event.rbs +17 -2
  219. data/sig/openai/models/realtime/realtime_audio_config_output.rbs +9 -6
  220. data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +9 -6
  221. data/sig/openai/models/realtime/translations/client_secret_create_params.rbs +39 -0
  222. data/sig/openai/models/responses/response_output_text.rbs +2 -2
  223. data/sig/openai/models/responses/response_output_text_annotation_added_event.rbs +2 -2
  224. data/sig/openai/models/responses/tool.rbs +3 -9
  225. data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +114 -0
  226. data/sig/openai/models/webhooks/agent_session_created_webhook_event.rbs +115 -0
  227. data/sig/openai/models/webhooks/agent_session_failed_webhook_event.rbs +89 -0
  228. data/sig/openai/models/webhooks/agent_session_idle_webhook_event.rbs +89 -0
  229. data/sig/openai/models/webhooks/agent_session_in_progress_webhook_event.rbs +89 -0
  230. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +6 -1
  231. data/sig/openai/models/webhooks/webhook_create_params.rbs +10 -0
  232. data/sig/openai/models/webhooks/webhook_test_params.rbs +10 -0
  233. data/sig/openai/models/webhooks/webhook_update_params.rbs +10 -0
  234. data/sig/openai/resources/audio/voices.rbs +14 -0
  235. data/sig/openai/resources/audio.rbs +2 -0
  236. data/sig/openai/resources/beta/agents/environments/files.rbs +17 -0
  237. data/sig/openai/resources/beta/agents/sessions/artifacts.rbs +4 -0
  238. data/sig/openai/resources/beta/agents/sessions/traces.rbs +21 -0
  239. data/sig/openai/resources/beta/agents/sessions.rbs +4 -1
  240. data/sig/openai/resources/realtime/translations/client_secrets.rbs +17 -0
  241. data/sig/openai/resources/realtime/translations.rbs +11 -0
  242. data/sig/openai/resources/realtime.rbs +2 -0
  243. data/sig/openai/resources/webhooks.rbs +6 -1
  244. metadata +61 -1
data/lib/openai/models/beta/beta_response.rb CHANGED
@@ -937,96 +937,316 @@ module OpenAI
937
937
  GPT_5_4_NANO = :"gpt-5.4-nano"
938
938
  GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
939
939
  GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
940
+ # @deprecated Announced shutdown date: 2026-08-10. See
941
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
942
+ # replacements.
940
943
  GPT_5_3_CHAT_LATEST = :"gpt-5.3-chat-latest"
941
944
  GPT_5_2 = :"gpt-5.2"
942
945
  GPT_5_2_2025_12_11 = :"gpt-5.2-2025-12-11"
946
+ # @deprecated Announced shutdown date: 2026-08-10. See
947
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
948
+ # replacements.
943
949
  GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
944
950
  GPT_5_2_PRO = :"gpt-5.2-pro"
945
951
  GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
946
952
  GPT_5_1 = :"gpt-5.1"
947
953
  GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
954
+ # @deprecated Announced shutdown date: 2026-07-23. See
955
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
956
+ # replacements.
948
957
  GPT_5_1_CODEX = :"gpt-5.1-codex"
958
+ # @deprecated Not a supported model ID. Retained for SDK compatibility.
949
959
  GPT_5_1_MINI = :"gpt-5.1-mini"
960
+ # @deprecated Announced shutdown date: 2026-07-23. See
961
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
962
+ # replacements.
950
963
  GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
964
+ # @deprecated Announced shutdown date: 2026-12-11. See
965
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
966
+ # replacements.
951
967
  GPT_5 = :"gpt-5"
968
+ # @deprecated Announced shutdown date: 2026-12-11. See
969
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
970
+ # replacements.
952
971
  GPT_5_MINI = :"gpt-5-mini"
972
+ # @deprecated Announced shutdown date: 2026-12-11. See
973
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
974
+ # replacements.
953
975
  GPT_5_NANO = :"gpt-5-nano"
976
+ # @deprecated Announced shutdown date: 2026-12-11. See
977
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
978
+ # replacements.
954
979
  GPT_5_2025_08_07 = :"gpt-5-2025-08-07"
980
+ # @deprecated Announced shutdown date: 2026-12-11. See
981
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
982
+ # replacements.
955
983
  GPT_5_MINI_2025_08_07 = :"gpt-5-mini-2025-08-07"
984
+ # @deprecated Announced shutdown date: 2026-12-11. See
985
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
986
+ # replacements.
956
987
  GPT_5_NANO_2025_08_07 = :"gpt-5-nano-2025-08-07"
988
+ # @deprecated Announced shutdown date: 2026-07-23. See
989
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
990
+ # replacements.
957
991
  GPT_5_CHAT_LATEST = :"gpt-5-chat-latest"
958
992
  GPT_4_1 = :"gpt-4.1"
959
993
  GPT_4_1_MINI = :"gpt-4.1-mini"
994
+ # @deprecated Announced shutdown date: 2026-10-23. See
995
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
996
+ # replacements.
960
997
  GPT_4_1_NANO = :"gpt-4.1-nano"
961
998
  GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
962
999
  GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
1000
+ # @deprecated Announced shutdown date: 2026-10-23. See
1001
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1002
+ # replacements.
963
1003
  GPT_4_1_NANO_2025_04_14 = :"gpt-4.1-nano-2025-04-14"
1004
+ # @deprecated Announced shutdown date: 2026-10-23. See
1005
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1006
+ # replacements.
964
1007
  O4_MINI = :"o4-mini"
1008
+ # @deprecated Announced shutdown date: 2026-10-23. See
1009
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1010
+ # replacements.
965
1011
  O4_MINI_2025_04_16 = :"o4-mini-2025-04-16"
1012
+ # @deprecated Announced shutdown date: 2026-12-11. See
1013
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1014
+ # replacements.
966
1015
  O3 = :o3
1016
+ # @deprecated Announced shutdown date: 2026-12-11. See
1017
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1018
+ # replacements.
967
1019
  O3_2025_04_16 = :"o3-2025-04-16"
1020
+ # @deprecated Announced shutdown date: 2026-10-23. See
1021
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1022
+ # replacements.
968
1023
  O3_MINI = :"o3-mini"
1024
+ # @deprecated Announced shutdown date: 2026-10-23. See
1025
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1026
+ # replacements.
969
1027
  O3_MINI_2025_01_31 = :"o3-mini-2025-01-31"
1028
+ # @deprecated Announced shutdown date: 2026-10-23. See
1029
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1030
+ # replacements.
970
1031
  O1 = :o1
1032
+ # @deprecated Announced shutdown date: 2026-10-23. See
1033
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1034
+ # replacements.
971
1035
  O1_2024_12_17 = :"o1-2024-12-17"
1036
+ # @deprecated Announced shutdown date: 2025-07-28. See
1037
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1038
+ # replacements.
972
1039
  O1_PREVIEW = :"o1-preview"
1040
+ # @deprecated Announced shutdown date: 2025-07-28. See
1041
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1042
+ # replacements.
973
1043
  O1_PREVIEW_2024_09_12 = :"o1-preview-2024-09-12"
1044
+ # @deprecated Announced shutdown date: 2025-10-27. See
1045
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1046
+ # replacements.
974
1047
  O1_MINI = :"o1-mini"
1048
+ # @deprecated Announced shutdown date: 2025-10-27. See
1049
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1050
+ # replacements.
975
1051
  O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
976
1052
  GPT_4O = :"gpt-4o"
977
1053
  GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
978
1054
  GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
1055
+ # @deprecated Announced shutdown date: 2026-10-23. See
1056
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1057
+ # replacements.
979
1058
  GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
1059
+ # @deprecated Announced shutdown date: 2027-01-20. See
1060
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1061
+ # replacements.
980
1062
  GPT_AUDIO_MINI = :"gpt-audio-mini"
1063
+ # @deprecated Announced shutdown date: 2027-01-20. See
1064
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1065
+ # replacements.
981
1066
  GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
1067
+ # @deprecated Announced shutdown date: 2026-05-07. See
1068
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1069
+ # replacements.
982
1070
  GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
1071
+ # @deprecated Announced shutdown date: 2025-10-10. See
1072
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1073
+ # replacements.
983
1074
  GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
1075
+ # @deprecated Announced shutdown date: 2026-05-07. See
1076
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1077
+ # replacements.
984
1078
  GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
1079
+ # @deprecated Announced shutdown date: 2026-05-07. See
1080
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1081
+ # replacements.
985
1082
  GPT_4O_AUDIO_PREVIEW_2025_06_03 = :"gpt-4o-audio-preview-2025-06-03"
1083
+ # @deprecated Announced shutdown date: 2026-05-07. See
1084
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1085
+ # replacements.
986
1086
  GPT_4O_MINI_AUDIO_PREVIEW = :"gpt-4o-mini-audio-preview"
1087
+ # @deprecated Announced shutdown date: 2026-05-07. See
1088
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1089
+ # replacements.
987
1090
  GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-mini-audio-preview-2024-12-17"
1091
+ # @deprecated Announced shutdown date: 2026-07-23. See
1092
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1093
+ # replacements.
988
1094
  GPT_4O_SEARCH_PREVIEW = :"gpt-4o-search-preview"
1095
+ # @deprecated Announced shutdown date: 2026-07-23. See
1096
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1097
+ # replacements.
989
1098
  GPT_4O_MINI_SEARCH_PREVIEW = :"gpt-4o-mini-search-preview"
1099
+ # @deprecated Announced shutdown date: 2026-07-23. See
1100
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1101
+ # replacements.
990
1102
  GPT_4O_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-search-preview-2025-03-11"
1103
+ # @deprecated Announced shutdown date: 2026-07-23. See
1104
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1105
+ # replacements.
991
1106
  GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-mini-search-preview-2025-03-11"
1107
+ # @deprecated Announced shutdown date: 2026-02-17. See
1108
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1109
+ # replacements.
992
1110
  CHATGPT_4O_LATEST = :"chatgpt-4o-latest"
1111
+ # @deprecated Announced shutdown date: 2026-02-12. See
1112
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1113
+ # replacements.
993
1114
  CODEX_MINI_LATEST = :"codex-mini-latest"
994
1115
  GPT_4O_MINI = :"gpt-4o-mini"
995
1116
  GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
1117
+ # @deprecated Announced shutdown date: 2026-10-23. See
1118
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1119
+ # replacements.
996
1120
  GPT_4_TURBO = :"gpt-4-turbo"
1121
+ # @deprecated Announced shutdown date: 2026-10-23. See
1122
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1123
+ # replacements.
997
1124
  GPT_4_TURBO_2024_04_09 = :"gpt-4-turbo-2024-04-09"
1125
+ # @deprecated Announced shutdown date: 2026-03-26. See
1126
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1127
+ # replacements.
998
1128
  GPT_4_0125_PREVIEW = :"gpt-4-0125-preview"
1129
+ # @deprecated Announced shutdown date: 2026-03-26. See
1130
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1131
+ # replacements.
999
1132
  GPT_4_TURBO_PREVIEW = :"gpt-4-turbo-preview"
1133
+ # @deprecated Announced shutdown date: 2026-10-23. See
1134
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1135
+ # replacements.
1000
1136
  GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
1137
+ # @deprecated Announced shutdown date: 2024-12-06. See
1138
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1139
+ # replacements.
1001
1140
  GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
1141
+ # @deprecated Announced shutdown date: 2026-10-23. See
1142
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1143
+ # replacements.
1002
1144
  GPT_4 = :"gpt-4"
1145
+ # @deprecated Announced shutdown date: 2026-03-26. See
1146
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1147
+ # replacements.
1003
1148
  GPT_4_0314 = :"gpt-4-0314"
1149
+ # @deprecated Announced shutdown date: 2026-10-23. See
1150
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1151
+ # replacements.
1004
1152
  GPT_4_0613 = :"gpt-4-0613"
1153
+ # @deprecated Announced shutdown date: 2025-06-06. See
1154
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1155
+ # replacements.
1005
1156
  GPT_4_32K = :"gpt-4-32k"
1157
+ # @deprecated Announced shutdown date: 2025-06-06. See
1158
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1159
+ # replacements.
1006
1160
  GPT_4_32K_0314 = :"gpt-4-32k-0314"
1161
+ # @deprecated Announced shutdown date: 2025-06-06. See
1162
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1163
+ # replacements.
1007
1164
  GPT_4_32K_0613 = :"gpt-4-32k-0613"
1165
+ # @deprecated Announced shutdown date: 2026-10-23. See
1166
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1167
+ # replacements.
1008
1168
  GPT_3_5_TURBO = :"gpt-3.5-turbo"
1169
+ # @deprecated Announced shutdown date: 2024-09-13. See
1170
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1171
+ # replacements.
1009
1172
  GPT_3_5_TURBO_16K = :"gpt-3.5-turbo-16k"
1173
+ # @deprecated Announced shutdown date: 2024-09-13. See
1174
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1175
+ # replacements.
1010
1176
  GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
1177
+ # @deprecated Announced shutdown date: 2024-09-13. See
1178
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1179
+ # replacements.
1011
1180
  GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
1181
+ # @deprecated Announced shutdown date: 2026-09-28. See
1182
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1183
+ # replacements.
1012
1184
  GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
1185
+ # @deprecated Announced shutdown date: 2026-10-23. See
1186
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1187
+ # replacements.
1013
1188
  GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
1189
+ # @deprecated Announced shutdown date: 2024-09-13. See
1190
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1191
+ # replacements.
1014
1192
  GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
1193
+ # @deprecated Announced shutdown date: 2026-10-23. See
1194
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1195
+ # replacements.
1015
1196
  O1_PRO = :"o1-pro"
1197
+ # @deprecated Announced shutdown date: 2026-10-23. See
1198
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1199
+ # replacements.
1016
1200
  O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
1201
+ # @deprecated Announced shutdown date: 2026-12-11. See
1202
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1203
+ # replacements.
1017
1204
  O3_PRO = :"o3-pro"
1205
+ # @deprecated Announced shutdown date: 2026-12-11. See
1206
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1207
+ # replacements.
1018
1208
  O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
1209
+ # @deprecated Announced shutdown date: 2026-07-23. See
1210
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1211
+ # replacements.
1019
1212
  O3_DEEP_RESEARCH = :"o3-deep-research"
1213
+ # @deprecated Announced shutdown date: 2026-07-23. See
1214
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1215
+ # replacements.
1020
1216
  O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
1217
+ # @deprecated Announced shutdown date: 2026-07-23. See
1218
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1219
+ # replacements.
1021
1220
  O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
1221
+ # @deprecated Announced shutdown date: 2026-07-23. See
1222
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1223
+ # replacements.
1022
1224
  O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
1225
+ # @deprecated Announced shutdown date: 2026-07-23. See
1226
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1227
+ # replacements.
1023
1228
  COMPUTER_USE_PREVIEW = :"computer-use-preview"
1229
+ # @deprecated Announced shutdown date: 2026-07-23. See
1230
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1231
+ # replacements.
1024
1232
  COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
1025
1233
  GPT_5_5_PRO = :"gpt-5.5-pro"
1026
1234
  GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
1235
+ # @deprecated Announced shutdown date: 2026-07-23. See
1236
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1237
+ # replacements.
1027
1238
  GPT_5_CODEX = :"gpt-5-codex"
1239
+ # @deprecated Announced shutdown date: 2026-12-11. See
1240
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1241
+ # replacements.
1028
1242
  GPT_5_PRO = :"gpt-5-pro"
1243
+ # @deprecated Announced shutdown date: 2026-12-11. See
1244
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1245
+ # replacements.
1029
1246
  GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
1247
+ # @deprecated Announced shutdown date: 2026-07-23. See
1248
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1249
+ # replacements.
1030
1250
  GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
1031
1251
  GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
1032
1252
  GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
data/lib/openai/models/beta/beta_response_output_text.rb CHANGED
@@ -79,7 +79,7 @@ module OpenAI
79
79
  required :filename, String
80
80
 
81
81
  # @!attribute index
82
- # The index of the file in the list of files.
82
+ # The index in the output text at which to insert the file citation.
83
83
  #
84
84
  # @return [Integer]
85
85
  required :index, Integer
@@ -100,7 +100,7 @@ module OpenAI
100
100
  # The filename of the file cited.
101
101
  #
102
102
  # @param index [Integer]
103
- # The index of the file in the list of files.
103
+ # The index in the output text at which to insert the file citation.
104
104
  #
105
105
  # @param type [Symbol, :file_citation]
106
106
  # The type of the file citation. Always `file_citation`.
data/lib/openai/models/beta/beta_response_output_text_annotation_added_event.rb CHANGED
@@ -126,7 +126,7 @@ module OpenAI
126
126
  required :filename, String
127
127
 
128
128
  # @!attribute index
129
- # The index of the file in the list of files.
129
+ # The index in the output text at which to insert the file citation.
130
130
  #
131
131
  # @return [Integer]
132
132
  required :index, Integer
@@ -147,7 +147,7 @@ module OpenAI
147
147
  # The filename of the file cited.
148
148
  #
149
149
  # @param index [Integer]
150
- # The index of the file in the list of files.
150
+ # The index in the output text at which to insert the file citation.
151
151
  #
152
152
  # @param type [Symbol, :file_citation]
153
153
  # The type of the file citation. Always `file_citation`.