openai 0.102.0 → 0.104.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 (426) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +88 -0
  3. data/README.md +23 -1
  4. data/lib/openai/client.rb +3 -386
  5. data/lib/openai/helpers/admin/organization/projects/api_keys.rb +42 -0
  6. data/lib/openai/helpers/agents/session_stream_resource.rb +60 -0
  7. data/lib/openai/helpers/beta/agents/artifacts.rb +18 -0
  8. data/lib/openai/helpers/beta/agents/files.rb +41 -0
  9. data/lib/openai/helpers/client_runtime.rb +391 -0
  10. data/lib/openai/helpers/files.rb +47 -0
  11. data/lib/openai/helpers/live/websocket.rb +8 -57
  12. data/lib/openai/helpers/models/chat/parsed.rb +32 -0
  13. data/lib/openai/helpers/models/responses/parsed.rb +30 -0
  14. data/lib/openai/helpers/models/responses/response.rb +32 -0
  15. data/lib/openai/helpers/models/webhooks/webhook_endpoint_with_secret.rb +20 -0
  16. data/lib/openai/helpers/realtime/client_extension.rb +1 -2
  17. data/lib/openai/helpers/realtime/connection_manager.rb +1 -1
  18. data/lib/openai/helpers/realtime/translation.rb +7 -50
  19. data/lib/openai/helpers/responses_websocket/client_extension.rb +1 -2
  20. data/lib/openai/helpers/streaming/chat_completion_resource.rb +36 -0
  21. data/lib/openai/helpers/streaming/response_stream.rb +1 -16
  22. data/lib/openai/helpers/streaming/response_stream_resource.rb +78 -0
  23. data/lib/openai/helpers/vector_stores/file_batches.rb +188 -0
  24. data/lib/openai/helpers/vector_stores/files.rb +198 -0
  25. data/lib/openai/helpers/websocket/client_request.rb +31 -6
  26. data/lib/openai/helpers/websocket/connection.rb +58 -0
  27. data/lib/openai/helpers/websocket/connection_manager.rb +4 -2
  28. data/lib/openai/helpers/websocket/protocol.rb +2 -1
  29. data/lib/openai/helpers/websocket/resource.rb +54 -0
  30. data/lib/openai/helpers/websocket/typed_connection.rb +95 -0
  31. data/lib/openai/helpers/websocket.rb +4 -0
  32. data/lib/openai/models/admin/organization/audit_log_list_response.rb +5 -3
  33. data/lib/openai/models/admin/organization/external_storage_configuration.rb +5 -3
  34. data/lib/openai/models/admin/organization/external_storage_create_params.rb +33 -3
  35. data/lib/openai/models/admin/organization/oci_external_storage_provider.rb +37 -0
  36. data/lib/openai/models/admin/organization/project_residency.rb +3 -0
  37. data/lib/openai/models/admin/organization/projects/api_key_update_params.rb +64 -0
  38. data/lib/openai/models/admin/organization/projects/api_key_update_scopes_params.rb +34 -0
  39. data/lib/openai/models/admin/organization/usage_decisions_params.rb +177 -0
  40. data/lib/openai/models/admin/organization/usage_decisions_response.rb +351 -0
  41. data/lib/openai/models/audio/speech_create_params.rb +6 -3
  42. data/lib/openai/models/audio/translation_create_response.rb +0 -1
  43. data/lib/openai/models/audio/voice.rb +17 -2
  44. data/lib/openai/models/audio/voice_create_params.rb +100 -3
  45. data/lib/openai/models/beta/agent_create_params.rb +4 -2
  46. data/lib/openai/models/beta/agent_list_params.rb +4 -4
  47. data/lib/openai/models/beta/agent_session.rb +37 -1
  48. data/lib/openai/models/beta/agent_session_environment_expired_event.rb +57 -0
  49. data/lib/openai/models/beta/agent_session_environment_state.rb +6 -0
  50. data/lib/openai/models/beta/agent_session_environment_suspended_event.rb +57 -0
  51. data/lib/openai/models/beta/agent_session_event.rb +7 -1
  52. data/lib/openai/models/beta/agent_update_params.rb +4 -2
  53. data/lib/openai/models/beta/agents/environment_info.rb +3 -0
  54. data/lib/openai/models/beta/agents/environment_list_params.rb +7 -7
  55. data/lib/openai/models/beta/agents/session_create_params.rb +39 -3
  56. data/lib/openai/models/beta/agents/session_list_params.rb +7 -10
  57. data/lib/openai/models/beta/agents/session_update_params.rb +33 -1
  58. data/lib/openai/models/beta/agents/sessions/artifact_list_params.rb +11 -11
  59. data/lib/openai/models/beta/agents/vault_list_params.rb +23 -13
  60. data/lib/openai/models/beta/agents/vault_status_filter.rb +1 -3
  61. data/lib/openai/models/beta/agents/vault_update_params.rb +47 -0
  62. data/lib/openai/models/beta/agents/vaults/credential_list_params.rb +23 -13
  63. data/lib/openai/models/beta/beta_response.rb +23 -2
  64. data/lib/openai/models/beta/beta_response_error.rb +19 -1
  65. data/lib/openai/models/beta/beta_response_input_item.rb +107 -1
  66. data/lib/openai/models/beta/beta_response_item.rb +107 -1
  67. data/lib/openai/models/beta/beta_response_output_item.rb +107 -1
  68. data/lib/openai/models/beta/beta_responses_client_event.rb +23 -2
  69. data/lib/openai/models/beta/response_compact_params.rb +21 -0
  70. data/lib/openai/models/beta/response_create_params.rb +23 -2
  71. data/lib/openai/models/beta/session_turn_error.rb +3 -0
  72. data/lib/openai/models/chat/chat_completion_audio_param.rb +3 -3
  73. data/lib/openai/models/chat/chat_completion_message.rb +0 -8
  74. data/lib/openai/models/chat/chat_completion_message_function_tool_call.rb +0 -8
  75. data/lib/openai/models/chat/completion_create_params.rb +5 -12
  76. data/lib/openai/models/chat_model.rb +21 -0
  77. data/lib/openai/models/conversations/conversation_item.rb +107 -1
  78. data/lib/openai/models/decision.rb +17 -2
  79. data/lib/openai/models/decision_create_params.rb +29 -12
  80. data/lib/openai/models/decision_input_image.rb +4 -3
  81. data/lib/openai/models/decision_input_message.rb +4 -4
  82. data/lib/openai/models/decision_input_part.rb +3 -2
  83. data/lib/openai/models/image_edit_completed_event.rb +1 -2
  84. data/lib/openai/models/image_edit_partial_image_event.rb +1 -2
  85. data/lib/openai/models/image_gen_completed_event.rb +1 -2
  86. data/lib/openai/models/image_gen_partial_image_event.rb +1 -2
  87. data/lib/openai/models/images_response.rb +1 -2
  88. data/lib/openai/models/live/built_in_voice.rb +1 -0
  89. data/lib/openai/models/live/client_event.rb +14 -2
  90. data/lib/openai/models/live/decision_create_event.rb +26 -0
  91. data/lib/openai/models/live/decision_event.rb +117 -0
  92. data/lib/openai/models/live/decision_item_create_event.rb +194 -0
  93. data/lib/openai/models/live/decision_item_created_event.rb +202 -0
  94. data/lib/openai/models/live/decision_item_delete_event.rb +38 -0
  95. data/lib/openai/models/live/decision_item_deleted_event.rb +46 -0
  96. data/lib/openai/models/live/decision_trigger.rb +244 -0
  97. data/lib/openai/models/live/decisions_delegation_config.rb +201 -0
  98. data/lib/openai/models/live/decisions_delegation_update_config.rb +208 -0
  99. data/lib/openai/models/live/delegation_created_event.rb +10 -10
  100. data/lib/openai/models/live/fork_client_event.rb +14 -2
  101. data/lib/openai/models/live/fork_server_event.rb +17 -2
  102. data/lib/openai/models/live/media_session_config.rb +47 -11
  103. data/lib/openai/models/live/output_audio_fixture_play_event.rb +48 -0
  104. data/lib/openai/models/live/output_audio_fixture_played_event.rb +42 -0
  105. data/lib/openai/models/live/output_audio_fixture_playing_event.rb +41 -0
  106. data/lib/openai/models/live/server_event.rb +17 -2
  107. data/lib/openai/models/live/session_accept_params.rb +47 -11
  108. data/lib/openai/models/live/session_config.rb +47 -11
  109. data/lib/openai/models/live/session_resource.rb +47 -11
  110. data/lib/openai/models/live/session_update_config.rb +38 -6
  111. data/lib/openai/models/live/session_update_event.rb +8 -8
  112. data/lib/openai/models/live/sideband_client_event.rb +57 -0
  113. data/lib/openai/models/live/sideband_server_event.rb +78 -0
  114. data/lib/openai/models/realtime/realtime_audio_config_output.rb +6 -3
  115. data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +6 -3
  116. data/lib/openai/models/realtime/realtime_response_status.rb +10 -1
  117. data/lib/openai/models/response_format_json_schema.rb +1 -1
  118. data/lib/openai/models/responses/function_tool.rb +8 -6
  119. data/lib/openai/models/responses/response.rb +2 -23
  120. data/lib/openai/models/responses/response_compact_params.rb +21 -0
  121. data/lib/openai/models/responses/response_create_params.rb +3 -6
  122. data/lib/openai/models/responses/response_error.rb +19 -1
  123. data/lib/openai/models/responses/response_format_text_config.rb +0 -4
  124. data/lib/openai/models/responses/response_function_tool_call.rb +0 -8
  125. data/lib/openai/models/responses/response_input_item.rb +107 -1
  126. data/lib/openai/models/responses/response_item.rb +107 -1
  127. data/lib/openai/models/responses/response_output_item.rb +107 -1
  128. data/lib/openai/models/responses/response_output_text.rb +0 -8
  129. data/lib/openai/models/responses/responses_client_event.rb +2 -2
  130. data/lib/openai/models/safety/safety_alert.rb +12 -1
  131. data/lib/openai/models/video_create_error.rb +19 -1
  132. data/lib/openai/models/webhooks/agent_environment_expired_webhook_event.rb +72 -0
  133. data/lib/openai/models/webhooks/agent_environment_suspended_webhook_event.rb +72 -0
  134. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +8 -3
  135. data/lib/openai/models/webhooks/webhook_create_params.rb +2 -0
  136. data/lib/openai/models/webhooks/webhook_endpoint_with_secret.rb +0 -9
  137. data/lib/openai/models/webhooks/webhook_test_params.rb +2 -0
  138. data/lib/openai/models/webhooks/webhook_update_params.rb +2 -0
  139. data/lib/openai/resources/admin/organization/external_storage.rb +1 -1
  140. data/lib/openai/resources/admin/organization/projects/api_keys.rb +61 -0
  141. data/lib/openai/resources/admin/organization/usage.rb +67 -0
  142. data/lib/openai/resources/audio/speech.rb +2 -1
  143. data/lib/openai/resources/audio/voices.rb +10 -10
  144. data/lib/openai/resources/beta/agents/environments/files.rb +3 -31
  145. data/lib/openai/resources/beta/agents/environments.rb +3 -3
  146. data/lib/openai/resources/beta/agents/sessions/artifacts.rb +5 -11
  147. data/lib/openai/resources/beta/agents/sessions/events.rb +1 -1
  148. data/lib/openai/resources/beta/agents/sessions.rb +20 -56
  149. data/lib/openai/resources/beta/agents/vaults/credentials.rb +10 -6
  150. data/lib/openai/resources/beta/agents/vaults.rb +45 -6
  151. data/lib/openai/resources/beta/agents.rb +6 -4
  152. data/lib/openai/resources/beta/responses.rb +2 -2
  153. data/lib/openai/resources/chat/completions.rb +11 -37
  154. data/lib/openai/resources/decisions.rb +9 -15
  155. data/lib/openai/resources/files.rb +0 -39
  156. data/lib/openai/resources/live/forks.rb +19 -0
  157. data/lib/openai/resources/live/sideband.rb +19 -0
  158. data/lib/openai/resources/live.rb +19 -0
  159. data/lib/openai/resources/realtime/translations.rb +19 -0
  160. data/lib/openai/resources/realtime.rb +19 -0
  161. data/lib/openai/resources/responses.rb +44 -95
  162. data/lib/openai/resources/vector_stores/file_batches.rb +0 -178
  163. data/lib/openai/resources/vector_stores/files.rb +0 -188
  164. data/lib/openai/resources/webhooks.rb +13 -29
  165. data/lib/openai/version.rb +1 -1
  166. data/lib/openai.rb +35 -0
  167. data/rbi/openai/client.rbi +0 -103
  168. data/rbi/openai/helpers/admin/organization/projects/api_keys.rbi +25 -0
  169. data/rbi/openai/helpers/beta/agents/artifacts.rbi +25 -0
  170. data/rbi/openai/helpers/beta/agents/files.rbi +48 -0
  171. data/rbi/openai/helpers/client_runtime.rbi +108 -0
  172. data/rbi/openai/helpers/files.rbi +25 -0
  173. data/rbi/openai/helpers/models/chat/parsed.rbi +21 -0
  174. data/rbi/openai/helpers/models/responses/parsed.rbi +19 -0
  175. data/rbi/openai/helpers/models/responses/response.rbi +15 -0
  176. data/rbi/openai/helpers/streaming/response_stream.rbi +301 -0
  177. data/rbi/openai/helpers/vector_stores/file_batches.rbi +102 -0
  178. data/rbi/openai/helpers/vector_stores/files.rbi +122 -0
  179. data/rbi/openai/helpers/websocket.rbi +82 -0
  180. data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +6 -3
  181. data/rbi/openai/models/admin/organization/external_storage_configuration.rbi +4 -2
  182. data/rbi/openai/models/admin/organization/external_storage_create_params.rbi +63 -4
  183. data/rbi/openai/models/admin/organization/oci_external_storage_provider.rbi +71 -0
  184. data/rbi/openai/models/admin/organization/project_residency.rbi +12 -0
  185. data/rbi/openai/models/admin/organization/projects/api_key_update_params.rbi +110 -0
  186. data/rbi/openai/models/admin/organization/projects/api_key_update_scopes_params.rbi +72 -0
  187. data/rbi/openai/models/admin/organization/usage_decisions_params.rbi +229 -0
  188. data/rbi/openai/models/admin/organization/usage_decisions_response.rbi +479 -0
  189. data/rbi/openai/models/audio/speech_create_params.rbi +6 -3
  190. data/rbi/openai/models/audio/voice.rbi +21 -2
  191. data/rbi/openai/models/audio/voice_create_params.rbi +149 -4
  192. data/rbi/openai/models/beta/agent_create_params.rbi +4 -2
  193. data/rbi/openai/models/beta/agent_list_params.rbi +8 -5
  194. data/rbi/openai/models/beta/agent_session.rbi +64 -1
  195. data/rbi/openai/models/beta/agent_session_environment_expired_event.rbi +95 -0
  196. data/rbi/openai/models/beta/agent_session_environment_state.rbi +6 -0
  197. data/rbi/openai/models/beta/agent_session_environment_suspended_event.rbi +95 -0
  198. data/rbi/openai/models/beta/agent_session_event.rbi +2 -0
  199. data/rbi/openai/models/beta/agent_update_params.rbi +4 -2
  200. data/rbi/openai/models/beta/agents/environment_info.rbi +3 -0
  201. data/rbi/openai/models/beta/agents/environment_list_params.rbi +7 -7
  202. data/rbi/openai/models/beta/agents/session_create_params.rbi +62 -2
  203. data/rbi/openai/models/beta/agents/session_list_params.rbi +11 -11
  204. data/rbi/openai/models/beta/agents/session_update_params.rbi +56 -0
  205. data/rbi/openai/models/beta/agents/sessions/artifact_list_params.rbi +19 -13
  206. data/rbi/openai/models/beta/agents/vault_list_params.rbi +30 -13
  207. data/rbi/openai/models/beta/agents/vault_status_filter.rbi +1 -3
  208. data/rbi/openai/models/beta/agents/vault_update_params.rbi +87 -0
  209. data/rbi/openai/models/beta/agents/vaults/credential_list_params.rbi +30 -13
  210. data/rbi/openai/models/beta/beta_response.rbi +2 -2
  211. data/rbi/openai/models/beta/beta_response_error.rbi +24 -3
  212. data/rbi/openai/models/beta/beta_response_input_item.rbi +191 -0
  213. data/rbi/openai/models/beta/beta_response_item.rbi +189 -0
  214. data/rbi/openai/models/beta/beta_response_output_item.rbi +191 -0
  215. data/rbi/openai/models/beta/beta_responses_client_event.rbi +2 -2
  216. data/rbi/openai/models/beta/response_create_params.rbi +2 -2
  217. data/rbi/openai/models/beta/session_turn_error.rbi +3 -0
  218. data/rbi/openai/models/chat/chat_completion_audio_param.rbi +3 -3
  219. data/rbi/openai/models/chat/chat_completion_message.rbi +0 -4
  220. data/rbi/openai/models/chat/chat_completion_message_function_tool_call.rbi +0 -4
  221. data/rbi/openai/models/chat/completion_create_params.rbi +63 -78
  222. data/rbi/openai/models/conversations/conversation_item.rbi +191 -0
  223. data/rbi/openai/models/decision.rbi +14 -1
  224. data/rbi/openai/models/decision_create_params.rbi +23 -12
  225. data/rbi/openai/models/decision_input_image.rbi +4 -3
  226. data/rbi/openai/models/decision_input_message.rbi +4 -4
  227. data/rbi/openai/models/decision_input_part.rbi +2 -1
  228. data/rbi/openai/models/image_edit_completed_event.rbi +1 -0
  229. data/rbi/openai/models/image_edit_partial_image_event.rbi +1 -0
  230. data/rbi/openai/models/image_gen_completed_event.rbi +1 -0
  231. data/rbi/openai/models/image_gen_partial_image_event.rbi +1 -0
  232. data/rbi/openai/models/images_response.rbi +1 -0
  233. data/rbi/openai/models/live/built_in_voice.rbi +1 -0
  234. data/rbi/openai/models/live/client_event.rbi +4 -0
  235. data/rbi/openai/models/live/decision_create_event.rbi +55 -0
  236. data/rbi/openai/models/live/decision_event.rbi +185 -0
  237. data/rbi/openai/models/live/decision_item_create_event.rbi +338 -0
  238. data/rbi/openai/models/live/decision_item_created_event.rbi +354 -0
  239. data/rbi/openai/models/live/decision_item_delete_event.rbi +66 -0
  240. data/rbi/openai/models/live/decision_item_deleted_event.rbi +77 -0
  241. data/rbi/openai/models/live/decision_trigger.rbi +465 -0
  242. data/rbi/openai/models/live/decisions_delegation_config.rbi +393 -0
  243. data/rbi/openai/models/live/decisions_delegation_update_config.rbi +412 -0
  244. data/rbi/openai/models/live/delegation_created_event.rbi +8 -10
  245. data/rbi/openai/models/live/fork_client_event.rbi +4 -0
  246. data/rbi/openai/models/live/fork_server_event.rbi +5 -0
  247. data/rbi/openai/models/live/media_session_config.rbi +95 -14
  248. data/rbi/openai/models/live/output_audio_fixture_play_event.rbi +76 -0
  249. data/rbi/openai/models/live/output_audio_fixture_played_event.rbi +73 -0
  250. data/rbi/openai/models/live/output_audio_fixture_playing_event.rbi +72 -0
  251. data/rbi/openai/models/live/server_event.rbi +5 -0
  252. data/rbi/openai/models/live/session_accept_params.rbi +88 -12
  253. data/rbi/openai/models/live/session_config.rbi +100 -14
  254. data/rbi/openai/models/live/session_resource.rbi +81 -10
  255. data/rbi/openai/models/live/session_update_config.rbi +86 -9
  256. data/rbi/openai/models/live/session_update_event.rbi +8 -8
  257. data/rbi/openai/models/live/sideband_client_event.rbi +40 -0
  258. data/rbi/openai/models/live/sideband_server_event.rbi +47 -0
  259. data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +6 -3
  260. data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +6 -3
  261. data/rbi/openai/models/realtime/realtime_response_status.rbi +13 -1
  262. data/rbi/openai/models/realtime/realtime_translation_input_audio_buffer_append_event.rbi +1 -1
  263. data/rbi/openai/models/realtime/realtime_translation_output_audio_delta_event.rbi +3 -3
  264. data/rbi/openai/models/realtime/realtime_translation_session_close_event.rbi +1 -1
  265. data/rbi/openai/models/realtime/realtime_translation_session_update_event.rbi +5 -1
  266. data/rbi/openai/models/responses/response.rbi +2 -7
  267. data/rbi/openai/models/responses/response_create_params.rbi +5 -9
  268. data/rbi/openai/models/responses/response_error.rbi +24 -3
  269. data/rbi/openai/models/responses/response_function_tool_call.rbi +0 -4
  270. data/rbi/openai/models/responses/response_function_web_search.rbi +21 -17
  271. data/rbi/openai/models/responses/response_input_item.rbi +191 -0
  272. data/rbi/openai/models/responses/response_item.rbi +189 -0
  273. data/rbi/openai/models/responses/response_output_item.rbi +191 -0
  274. data/rbi/openai/models/responses/response_output_text.rbi +0 -4
  275. data/rbi/openai/models/responses/responses_client_event.rbi +2 -2
  276. data/rbi/openai/models/safety/safety_alert.rbi +13 -1
  277. data/rbi/openai/models/video_create_error.rbi +24 -3
  278. data/rbi/openai/models/webhooks/agent_environment_expired_webhook_event.rbi +133 -0
  279. data/rbi/openai/models/webhooks/agent_environment_suspended_webhook_event.rbi +133 -0
  280. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +3 -2
  281. data/rbi/openai/models/webhooks/webhook_create_params.rbi +8 -0
  282. data/rbi/openai/models/webhooks/webhook_test_params.rbi +8 -0
  283. data/rbi/openai/models/webhooks/webhook_update_params.rbi +8 -0
  284. data/rbi/openai/resources/admin/organization/external_storage.rbi +2 -1
  285. data/rbi/openai/resources/admin/organization/projects/api_keys.rbi +48 -0
  286. data/rbi/openai/resources/admin/organization/usage.rbi +56 -0
  287. data/rbi/openai/resources/audio/speech.rbi +2 -1
  288. data/rbi/openai/resources/audio/voices.rbi +13 -10
  289. data/rbi/openai/resources/beta/agents/environments/files.rbi +3 -33
  290. data/rbi/openai/resources/beta/agents/environments.rbi +3 -3
  291. data/rbi/openai/resources/beta/agents/sessions/artifacts.rbi +5 -13
  292. data/rbi/openai/resources/beta/agents/sessions.rbi +15 -4
  293. data/rbi/openai/resources/beta/agents/vaults/credentials.rbi +9 -5
  294. data/rbi/openai/resources/beta/agents/vaults.rbi +34 -5
  295. data/rbi/openai/resources/beta/agents.rbi +6 -4
  296. data/rbi/openai/resources/beta/responses.rbi +2 -2
  297. data/rbi/openai/resources/chat/completions.rbi +26 -29
  298. data/rbi/openai/resources/decisions.rbi +9 -15
  299. data/rbi/openai/resources/files.rbi +0 -18
  300. data/rbi/openai/resources/live/forks.rbi +17 -0
  301. data/rbi/openai/resources/live/sideband.rbi +17 -0
  302. data/rbi/openai/resources/live.rbi +17 -0
  303. data/rbi/openai/resources/realtime/translations.rbi +17 -0
  304. data/rbi/openai/resources/realtime.rbi +17 -0
  305. data/rbi/openai/resources/responses.rbi +41 -333
  306. data/rbi/openai/resources/vector_stores/file_batches.rbi +0 -93
  307. data/rbi/openai/resources/vector_stores/files.rbi +0 -113
  308. data/rbi/openai/resources/webhooks.rbi +2 -0
  309. data/sig/openai/client.rbs +0 -50
  310. data/sig/openai/helpers/admin/organization/projects/api_keys.rbs +18 -0
  311. data/sig/openai/helpers/beta/agents/artifacts.rbs +17 -0
  312. data/sig/openai/helpers/beta/agents/files.rbs +30 -0
  313. data/sig/openai/helpers/client_runtime.rbs +53 -0
  314. data/sig/openai/helpers/files.rbs +12 -0
  315. data/sig/openai/helpers/models/responses/response.rbs +9 -0
  316. data/sig/openai/helpers/streaming/response_stream.rbs +37 -0
  317. data/sig/openai/helpers/vector_stores/file_batches.rbs +38 -0
  318. data/sig/openai/helpers/vector_stores/files.rbs +43 -0
  319. data/sig/openai/helpers/websocket.rbs +40 -0
  320. data/sig/openai/models/admin/organization/audit_log_list_response.rbs +1 -0
  321. data/sig/openai/models/admin/organization/external_storage_configuration.rbs +1 -0
  322. data/sig/openai/models/admin/organization/external_storage_create_params.rbs +33 -0
  323. data/sig/openai/models/admin/organization/oci_external_storage_provider.rbs +34 -0
  324. data/sig/openai/models/admin/organization/project_residency.rbs +6 -0
  325. data/sig/openai/models/admin/organization/projects/api_key_update_params.rbs +77 -0
  326. data/sig/openai/models/admin/organization/projects/api_key_update_scopes_params.rbs +38 -0
  327. data/sig/openai/models/admin/organization/usage_decisions_params.rbs +170 -0
  328. data/sig/openai/models/admin/organization/usage_decisions_response.rbs +319 -0
  329. data/sig/openai/models/audio/speech_create_params.rbs +4 -2
  330. data/sig/openai/models/audio/voice.rbs +21 -3
  331. data/sig/openai/models/audio/voice_create_params.rbs +90 -1
  332. data/sig/openai/models/beta/agent_create_params.rbs +4 -2
  333. data/sig/openai/models/beta/agent_list_params.rbs +9 -6
  334. data/sig/openai/models/beta/agent_session.rbs +36 -2
  335. data/sig/openai/models/beta/agent_session_environment_expired_event.rbs +57 -0
  336. data/sig/openai/models/beta/agent_session_environment_state.rbs +14 -1
  337. data/sig/openai/models/beta/agent_session_environment_suspended_event.rbs +57 -0
  338. data/sig/openai/models/beta/agent_session_event.rbs +2 -0
  339. data/sig/openai/models/beta/agent_update_params.rbs +4 -2
  340. data/sig/openai/models/beta/agents/environment_info.rbs +11 -1
  341. data/sig/openai/models/beta/agents/environment_list_params.rbs +9 -9
  342. data/sig/openai/models/beta/agents/session_create_params.rbs +29 -2
  343. data/sig/openai/models/beta/agents/session_list_params.rbs +12 -12
  344. data/sig/openai/models/beta/agents/session_update_params.rbs +23 -0
  345. data/sig/openai/models/beta/agents/sessions/artifact_list_params.rbs +21 -15
  346. data/sig/openai/models/beta/agents/vault_list_params.rbs +32 -14
  347. data/sig/openai/models/beta/agents/vault_update_params.rbs +54 -0
  348. data/sig/openai/models/beta/agents/vaults/credential_list_params.rbs +32 -14
  349. data/sig/openai/models/beta/beta_response.rbs +2 -2
  350. data/sig/openai/models/beta/beta_response_error.rbs +19 -3
  351. data/sig/openai/models/beta/beta_response_input_item.rbs +110 -0
  352. data/sig/openai/models/beta/beta_response_item.rbs +110 -0
  353. data/sig/openai/models/beta/beta_response_output_item.rbs +110 -0
  354. data/sig/openai/models/beta/beta_responses_client_event.rbs +2 -2
  355. data/sig/openai/models/beta/response_create_params.rbs +2 -2
  356. data/sig/openai/models/beta/session_turn_error.rbs +4 -0
  357. data/sig/openai/models/chat/chat_completion_audio_param.rbs +2 -2
  358. data/sig/openai/models/chat/completion_create_params.rbs +2 -2
  359. data/sig/openai/models/conversations/conversation_item.rbs +110 -0
  360. data/sig/openai/models/decision.rbs +13 -0
  361. data/sig/openai/models/decision_create_params.rbs +19 -8
  362. data/sig/openai/models/decision_input_image.rbs +2 -2
  363. data/sig/openai/models/decision_input_message.rbs +2 -2
  364. data/sig/openai/models/live/built_in_voice.rbs +2 -0
  365. data/sig/openai/models/live/client_event.rbs +4 -0
  366. data/sig/openai/models/live/decision_create_event.rbs +18 -0
  367. data/sig/openai/models/live/decision_event.rbs +102 -0
  368. data/sig/openai/models/live/decision_item_create_event.rbs +183 -0
  369. data/sig/openai/models/live/decision_item_created_event.rbs +195 -0
  370. data/sig/openai/models/live/decision_item_delete_event.rbs +33 -0
  371. data/sig/openai/models/live/decision_item_deleted_event.rbs +49 -0
  372. data/sig/openai/models/live/decision_trigger.rbs +234 -0
  373. data/sig/openai/models/live/decisions_delegation_config.rbs +195 -0
  374. data/sig/openai/models/live/decisions_delegation_update_config.rbs +202 -0
  375. data/sig/openai/models/live/delegation_created_event.rbs +6 -7
  376. data/sig/openai/models/live/fork_client_event.rbs +4 -0
  377. data/sig/openai/models/live/fork_server_event.rbs +5 -0
  378. data/sig/openai/models/live/media_session_config.rbs +58 -11
  379. data/sig/openai/models/live/output_audio_fixture_play_event.rbs +42 -0
  380. data/sig/openai/models/live/output_audio_fixture_played_event.rbs +44 -0
  381. data/sig/openai/models/live/output_audio_fixture_playing_event.rbs +44 -0
  382. data/sig/openai/models/live/server_event.rbs +5 -0
  383. data/sig/openai/models/live/session_accept_params.rbs +57 -10
  384. data/sig/openai/models/live/session_config.rbs +58 -11
  385. data/sig/openai/models/live/session_resource.rbs +57 -10
  386. data/sig/openai/models/live/session_update_config.rbs +54 -3
  387. data/sig/openai/models/live/session_update_event.rbs +6 -6
  388. data/sig/openai/models/live/sideband_client_event.rbs +26 -0
  389. data/sig/openai/models/live/sideband_server_event.rbs +33 -0
  390. data/sig/openai/models/realtime/realtime_audio_config_output.rbs +6 -3
  391. data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +6 -3
  392. data/sig/openai/models/realtime/realtime_response_status.rbs +15 -3
  393. data/sig/openai/models/responses/response.rbs +2 -4
  394. data/sig/openai/models/responses/response_create_params.rbs +2 -2
  395. data/sig/openai/models/responses/response_error.rbs +19 -3
  396. data/sig/openai/models/responses/response_input_item.rbs +110 -0
  397. data/sig/openai/models/responses/response_item.rbs +110 -0
  398. data/sig/openai/models/responses/response_output_item.rbs +110 -0
  399. data/sig/openai/models/responses/responses_client_event.rbs +2 -2
  400. data/sig/openai/models/safety/safety_alert.rbs +12 -2
  401. data/sig/openai/models/video_create_error.rbs +19 -3
  402. data/sig/openai/models/webhooks/agent_environment_expired_webhook_event.rbs +70 -0
  403. data/sig/openai/models/webhooks/agent_environment_suspended_webhook_event.rbs +70 -0
  404. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +3 -1
  405. data/sig/openai/models/webhooks/webhook_create_params.rbs +4 -0
  406. data/sig/openai/models/webhooks/webhook_test_params.rbs +4 -0
  407. data/sig/openai/models/webhooks/webhook_update_params.rbs +4 -0
  408. data/sig/openai/resources/admin/organization/projects/api_keys.rbs +8 -0
  409. data/sig/openai/resources/admin/organization/usage.rbs +15 -0
  410. data/sig/openai/resources/beta/agents/environments/files.rbs +0 -17
  411. data/sig/openai/resources/beta/agents/sessions/artifacts.rbs +2 -6
  412. data/sig/openai/resources/beta/agents/sessions.rbs +4 -1
  413. data/sig/openai/resources/beta/agents/vaults/credentials.rbs +2 -1
  414. data/sig/openai/resources/beta/agents/vaults.rbs +9 -1
  415. data/sig/openai/resources/beta/agents.rbs +1 -1
  416. data/sig/openai/resources/files.rbs +0 -7
  417. data/sig/openai/resources/live/forks.rbs +8 -0
  418. data/sig/openai/resources/live/sideband.rbs +8 -0
  419. data/sig/openai/resources/live.rbs +7 -0
  420. data/sig/openai/resources/realtime/translations.rbs +7 -0
  421. data/sig/openai/resources/realtime.rbs +7 -0
  422. data/sig/openai/resources/responses.rbs +7 -31
  423. data/sig/openai/resources/vector_stores/file_batches.rbs +0 -31
  424. data/sig/openai/resources/vector_stores/files.rbs +0 -36
  425. data/sig/openai/resources/webhooks.rbs +3 -1
  426. metadata +101 -1
@@ -23,14 +23,13 @@ module OpenAI
23
23
  optional :agent_id, String
24
24
 
25
25
  # @!attribute limit
26
- # The maximum number of resources to return.
26
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
27
27
  #
28
28
  # @return [Integer, nil]
29
- optional :limit, Integer, nil?: true
29
+ optional :limit, Integer
30
30
 
31
31
  # @!attribute order
32
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
33
- # `desc` for descending order. Defaults to `desc`.
32
+ # The order in which resources are returned. Defaults to `desc`.
34
33
  #
35
34
  # @return [Symbol, OpenAI::Models::Beta::Agents::SessionListParams::Order, nil]
36
35
  optional :order, enum: -> { OpenAI::Beta::Agents::SessionListParams::Order }
@@ -43,17 +42,15 @@ module OpenAI
43
42
  # Only return sessions whose root agent has this ID. Omit to return sessions for
44
43
  # all agents.
45
44
  #
46
- # @param limit [Integer, nil]
47
- # The maximum number of resources to return.
45
+ # @param limit [Integer]
46
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
48
47
  #
49
48
  # @param order [Symbol, OpenAI::Models::Beta::Agents::SessionListParams::Order]
50
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
51
- # `desc` for descending order. Defaults to `desc`.
49
+ # The order in which resources are returned. Defaults to `desc`.
52
50
  #
53
51
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
54
52
 
55
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
56
- # `desc` for descending order. Defaults to `desc`.
53
+ # The order in which resources are returned. Defaults to `desc`.
57
54
  module Order
58
55
  extend OpenAI::Internal::Type::Enum
59
56
 
@@ -28,7 +28,20 @@ module OpenAI
28
28
  # @return [Hash{Symbol=>String}, nil]
29
29
  optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
30
30
 
31
- # @!method initialize(session_id:, agent: nil, metadata: nil, request_options: {})
31
+ # @!attribute spend_control
32
+ # Omit to retain the limit; null or a null limit removes it without resetting
33
+ # spend.
34
+ #
35
+ # @return [OpenAI::Models::Beta::Agents::SessionUpdateParams::SpendControl, nil]
36
+ optional(
37
+ :spend_control,
38
+ -> {
39
+ OpenAI::Beta::Agents::SessionUpdateParams::SpendControl
40
+ },
41
+ nil?: true
42
+ )
43
+
44
+ # @!method initialize(session_id:, agent: nil, metadata: nil, spend_control: nil, request_options: {})
32
45
  # @param session_id [String]
33
46
  #
34
47
  # @param agent [OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent]
@@ -39,6 +52,10 @@ module OpenAI
39
52
  # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
40
53
  # characters.
41
54
  #
55
+ # @param spend_control [OpenAI::Models::Beta::Agents::SessionUpdateParams::SpendControl, nil]
56
+ # Omit to retain the limit; null or a null limit removes it without resetting
57
+ # spend.
58
+ #
42
59
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
43
60
 
44
61
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -138,6 +155,21 @@ module OpenAI
138
155
  # @return [Array<Symbol>]
139
156
  end
140
157
  end
158
+
159
+ class SpendControl < OpenAI::Internal::Type::BaseModel
160
+ # @!attribute limit
161
+ # Positive USD cents, or null to remove the limit.
162
+ #
163
+ # @return [Integer, nil]
164
+ required :limit, Integer, nil?: true
165
+
166
+ # @!method initialize(limit:)
167
+ # Omit to retain the limit; null or a null limit removes it without resetting
168
+ # spend.
169
+ #
170
+ # @param limit [Integer, nil]
171
+ # Positive USD cents, or null to remove the limit.
172
+ end
141
173
  end
142
174
  end
143
175
  end
@@ -16,10 +16,10 @@ module OpenAI
16
16
  required :session_id, String
17
17
 
18
18
  # @!attribute after
19
- # Return artifacts after this immutable artifact ID.
19
+ # Return resources after this resource ID in the selected order.
20
20
  #
21
21
  # @return [String, nil]
22
- optional :after, String, nil?: true
22
+ optional :after, String
23
23
 
24
24
  # @!attribute environment_id
25
25
  # Restrict the listing to artifacts produced by this environment.
@@ -28,13 +28,13 @@ module OpenAI
28
28
  optional :environment_id, String, nil?: true
29
29
 
30
30
  # @!attribute limit
31
- # The maximum number of artifacts to return, between 1 and 100.
31
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
32
32
  #
33
33
  # @return [Integer, nil]
34
- optional :limit, Integer, nil?: true
34
+ optional :limit, Integer
35
35
 
36
36
  # @!attribute order
37
- # Sort by creation time and ID. Defaults to descending.
37
+ # The order in which resources are returned. Defaults to `desc`.
38
38
  #
39
39
  # @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::Order, nil]
40
40
  optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::ArtifactListParams::Order }
@@ -42,21 +42,21 @@ module OpenAI
42
42
  # @!method initialize(session_id:, after: nil, environment_id: nil, limit: nil, order: nil, request_options: {})
43
43
  # @param session_id [String]
44
44
  #
45
- # @param after [String, nil]
46
- # Return artifacts after this immutable artifact ID.
45
+ # @param after [String]
46
+ # Return resources after this resource ID in the selected order.
47
47
  #
48
48
  # @param environment_id [String, nil]
49
49
  # Restrict the listing to artifacts produced by this environment.
50
50
  #
51
- # @param limit [Integer, nil]
52
- # The maximum number of artifacts to return, between 1 and 100.
51
+ # @param limit [Integer]
52
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
53
53
  #
54
54
  # @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::Order]
55
- # Sort by creation time and ID. Defaults to descending.
55
+ # The order in which resources are returned. Defaults to `desc`.
56
56
  #
57
57
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
58
58
 
59
- # Sort by creation time and ID. Defaults to descending.
59
+ # The order in which resources are returned. Defaults to `desc`.
60
60
  module Order
61
61
  extend OpenAI::Internal::Type::Enum
62
62
 
@@ -16,15 +16,22 @@ module OpenAI
16
16
  optional :after, String
17
17
 
18
18
  # @!attribute limit
19
- # The maximum number of resources to return. Defaults to 20. Values are clamped
20
- # between 1 and 100.
19
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
21
20
  #
22
21
  # @return [Integer, nil]
23
- optional :limit, Integer, nil?: true
22
+ optional :limit, Integer
23
+
24
+ # @!attribute metadata
25
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
26
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
27
+ # characters. Filtering is eventually consistent; metadata changes may take time
28
+ # to appear.
29
+ #
30
+ # @return [Hash{Symbol=>String}, nil]
31
+ optional :metadata, OpenAI::Internal::Type::HashOf[String]
24
32
 
25
33
  # @!attribute order
26
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
27
- # `desc` for descending order. Defaults to `desc`.
34
+ # The order in which resources are returned. Defaults to `desc`.
28
35
  #
29
36
  # @return [Symbol, OpenAI::Models::Beta::Agents::VaultListParams::Order, nil]
30
37
  optional :order, enum: -> { OpenAI::Beta::Agents::VaultListParams::Order }
@@ -36,17 +43,21 @@ module OpenAI
36
43
  # @return [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>, nil]
37
44
  optional :status, union: -> { OpenAI::Beta::Agents::VaultStatusFilter }
38
45
 
39
- # @!method initialize(after: nil, limit: nil, order: nil, status: nil, request_options: {})
46
+ # @!method initialize(after: nil, limit: nil, metadata: nil, order: nil, status: nil, request_options: {})
40
47
  # @param after [String]
41
48
  # Return resources after this resource ID in the selected order.
42
49
  #
43
- # @param limit [Integer, nil]
44
- # The maximum number of resources to return. Defaults to 20. Values are clamped
45
- # between 1 and 100.
50
+ # @param limit [Integer]
51
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
52
+ #
53
+ # @param metadata [Hash{Symbol=>String}]
54
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
55
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
56
+ # characters. Filtering is eventually consistent; metadata changes may take time
57
+ # to appear.
46
58
  #
47
59
  # @param order [Symbol, OpenAI::Models::Beta::Agents::VaultListParams::Order]
48
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
49
- # `desc` for descending order. Defaults to `desc`.
60
+ # The order in which resources are returned. Defaults to `desc`.
50
61
  #
51
62
  # @param status [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>]
52
63
  # Filter by one status or a list, such as `status=active` or
@@ -54,8 +65,7 @@ module OpenAI
54
65
  #
55
66
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
56
67
 
57
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
58
- # `desc` for descending order. Defaults to `desc`.
68
+ # The order in which resources are returned. Defaults to `desc`.
59
69
  module Order
60
70
  extend OpenAI::Internal::Type::Enum
61
71
 
@@ -17,9 +17,7 @@ module OpenAI
17
17
  # @return [Array(Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>)]
18
18
 
19
19
  # @type [OpenAI::Internal::Type::Converter]
20
- VaultStatusArray = OpenAI::Internal::Type::ArrayOf[
21
- enum: -> { OpenAI::Models::Beta::Agents::VaultStatus }
22
- ]
20
+ VaultStatusArray = OpenAI::Internal::Type::ArrayOf[enum: -> { OpenAI::Models::Beta::Agents::VaultStatus }]
23
21
  end
24
22
  end
25
23
  end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ module Agents
7
+ # @see OpenAI::Resources::Beta::Agents::Vaults#update
8
+ class VaultUpdateParams < OpenAI::Internal::Type::BaseModel
9
+ extend OpenAI::Internal::Type::RequestParameters::Converter
10
+ include OpenAI::Internal::Type::RequestParameters
11
+
12
+ # @!attribute vault_id
13
+ #
14
+ # @return [String]
15
+ required :vault_id, String
16
+
17
+ # @!attribute metadata
18
+ # Replaces all metadata. Omit to leave unchanged, or pass {} to clear it. Up to 16
19
+ # string key-value pairs, with keys up to 64 and values up to 512 characters.
20
+ #
21
+ # @return [Hash{Symbol=>String}, nil]
22
+ optional :metadata, OpenAI::Internal::Type::HashOf[String]
23
+
24
+ # @!attribute name
25
+ # A replacement name. Omit to leave unchanged, or pass null to clear it. The name
26
+ # is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.
27
+ #
28
+ # @return [String, nil]
29
+ optional :name, String, nil?: true
30
+
31
+ # @!method initialize(vault_id:, metadata: nil, name: nil, request_options: {})
32
+ # @param vault_id [String]
33
+ #
34
+ # @param metadata [Hash{Symbol=>String}]
35
+ # Replaces all metadata. Omit to leave unchanged, or pass {} to clear it. Up to 16
36
+ # string key-value pairs, with keys up to 64 and values up to 512 characters.
37
+ #
38
+ # @param name [String, nil]
39
+ # A replacement name. Omit to leave unchanged, or pass null to clear it. The name
40
+ # is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.
41
+ #
42
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
@@ -22,15 +22,22 @@ module OpenAI
22
22
  optional :after, String
23
23
 
24
24
  # @!attribute limit
25
- # The maximum number of resources to return. Defaults to 20. Values are clamped
26
- # between 1 and 100.
25
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
27
26
  #
28
27
  # @return [Integer, nil]
29
- optional :limit, Integer, nil?: true
28
+ optional :limit, Integer
29
+
30
+ # @!attribute metadata
31
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
32
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
33
+ # characters. Filtering is eventually consistent; metadata changes may take time
34
+ # to appear.
35
+ #
36
+ # @return [Hash{Symbol=>String}, nil]
37
+ optional :metadata, OpenAI::Internal::Type::HashOf[String]
30
38
 
31
39
  # @!attribute order
32
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
33
- # `desc` for descending order. Defaults to `desc`.
40
+ # The order in which resources are returned. Defaults to `desc`.
34
41
  #
35
42
  # @return [Symbol, OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::Order, nil]
36
43
  optional :order, enum: -> { OpenAI::Beta::Agents::Vaults::CredentialListParams::Order }
@@ -42,19 +49,23 @@ module OpenAI
42
49
  # @return [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>, nil]
43
50
  optional :status, union: -> { OpenAI::Beta::Agents::VaultStatusFilter }
44
51
 
45
- # @!method initialize(vault_id:, after: nil, limit: nil, order: nil, status: nil, request_options: {})
52
+ # @!method initialize(vault_id:, after: nil, limit: nil, metadata: nil, order: nil, status: nil, request_options: {})
46
53
  # @param vault_id [String]
47
54
  #
48
55
  # @param after [String]
49
56
  # Return resources after this resource ID in the selected order.
50
57
  #
51
- # @param limit [Integer, nil]
52
- # The maximum number of resources to return. Defaults to 20. Values are clamped
53
- # between 1 and 100.
58
+ # @param limit [Integer]
59
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
60
+ #
61
+ # @param metadata [Hash{Symbol=>String}]
62
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
63
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
64
+ # characters. Filtering is eventually consistent; metadata changes may take time
65
+ # to appear.
54
66
  #
55
67
  # @param order [Symbol, OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::Order]
56
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
57
- # `desc` for descending order. Defaults to `desc`.
68
+ # The order in which resources are returned. Defaults to `desc`.
58
69
  #
59
70
  # @param status [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>]
60
71
  # Filter by one status or a list, such as `status=active` or
@@ -62,8 +73,7 @@ module OpenAI
62
73
  #
63
74
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
64
75
 
65
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
66
- # `desc` for descending order. Defaults to `desc`.
76
+ # The order in which resources are returned. Defaults to `desc`.
67
77
  module Order
68
78
  extend OpenAI::Internal::Type::Enum
69
79
 
@@ -263,7 +263,7 @@ module OpenAI
263
263
  # @!attribute safety_identifier
264
264
  # A stable identifier used to help detect users of your application that may be
265
265
  # violating OpenAI's usage policies. The IDs should be a string that uniquely
266
- # identifies each user, with a maximum length of 64 characters. We recommend
266
+ # identifies each user, with a maximum length of 128 characters. We recommend
267
267
  # hashing their username or email address, in order to avoid sending us any
268
268
  # identifying information.
269
269
  # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -522,7 +522,7 @@ module OpenAI
522
522
  # @param safety_identifier [String, nil]
523
523
  # A stable identifier used to help detect users of your application that may be
524
524
  # violating OpenAI's usage policies. The IDs should be a string that uniquely
525
- # identifies each user, with a maximum length of 64 characters. We recommend
525
+ # identifies each user, with a maximum length of 128 characters. We recommend
526
526
  # hashing their username or email address, in order to avoid sending us any
527
527
  # identifying information.
528
528
  # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -934,6 +934,9 @@ module OpenAI
934
934
  GPT_5_5_2026_04_23 = :"gpt-5.5-2026-04-23"
935
935
  GPT_5_4 = :"gpt-5.4"
936
936
  GPT_5_4_MINI = :"gpt-5.4-mini"
937
+ # @deprecated Announced shutdown date: 2027-04-01. See
938
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
939
+ # replacements.
937
940
  GPT_5_4_NANO = :"gpt-5.4-nano"
938
941
  GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
939
942
  GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
@@ -949,6 +952,9 @@ module OpenAI
949
952
  GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
950
953
  GPT_5_2_PRO = :"gpt-5.2-pro"
951
954
  GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
955
+ # @deprecated Announced shutdown date: 2027-04-01. See
956
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
957
+ # replacements.
952
958
  GPT_5_1 = :"gpt-5.1"
953
959
  GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
954
960
  # @deprecated Announced shutdown date: 2026-07-23. See
@@ -995,7 +1001,13 @@ module OpenAI
995
1001
  # https://developers.openai.com/api/docs/deprecations for details and recommended
996
1002
  # replacements.
997
1003
  GPT_4_1_NANO = :"gpt-4.1-nano"
1004
+ # @deprecated Announced shutdown date: 2027-01-14. See
1005
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1006
+ # replacements.
998
1007
  GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
1008
+ # @deprecated Announced shutdown date: 2027-01-14. See
1009
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1010
+ # replacements.
999
1011
  GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
1000
1012
  # @deprecated Announced shutdown date: 2026-10-23. See
1001
1013
  # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -1050,7 +1062,13 @@ module OpenAI
1050
1062
  # replacements.
1051
1063
  O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
1052
1064
  GPT_4O = :"gpt-4o"
1065
+ # @deprecated Announced shutdown date: 2027-01-14. See
1066
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1067
+ # replacements.
1053
1068
  GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
1069
+ # @deprecated Announced shutdown date: 2027-01-14. See
1070
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1071
+ # replacements.
1054
1072
  GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
1055
1073
  # @deprecated Announced shutdown date: 2026-10-23. See
1056
1074
  # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -1113,6 +1131,9 @@ module OpenAI
1113
1131
  # replacements.
1114
1132
  CODEX_MINI_LATEST = :"codex-mini-latest"
1115
1133
  GPT_4O_MINI = :"gpt-4o-mini"
1134
+ # @deprecated Announced shutdown date: 2027-01-14. See
1135
+ # https://developers.openai.com/api/docs/deprecations for details and recommended
1136
+ # replacements.
1116
1137
  GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
1117
1138
  # @deprecated Announced shutdown date: 2026-10-23. See
1118
1139
  # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -21,7 +21,19 @@ module OpenAI
21
21
  # @return [OpenAI::Models::Beta::BetaResponseError::Misalignment, nil]
22
22
  optional :misalignment, -> { OpenAI::Beta::BetaResponseError::Misalignment }
23
23
 
24
- # @!method initialize(code:, message:, misalignment: nil)
24
+ # @!attribute param
25
+ # The request parameter associated with the error, or null if none was recorded.
26
+ #
27
+ # @return [String, nil]
28
+ optional :param, String, nil?: true
29
+
30
+ # @!attribute type
31
+ # The original error type, or null if it was not recorded.
32
+ #
33
+ # @return [String, nil]
34
+ optional :type, String, nil?: true
35
+
36
+ # @!method initialize(code:, message:, misalignment: nil, param: nil, type: nil)
25
37
  # An error object returned when the model fails to generate a Response.
26
38
  #
27
39
  # @param code [Symbol, OpenAI::Models::Beta::BetaResponseError::Code]
@@ -31,6 +43,12 @@ module OpenAI
31
43
  # A human-readable description of the error.
32
44
  #
33
45
  # @param misalignment [OpenAI::Models::Beta::BetaResponseError::Misalignment]
46
+ #
47
+ # @param param [String, nil]
48
+ # The request parameter associated with the error, or null if none was recorded.
49
+ #
50
+ # @param type [String, nil]
51
+ # The original error type, or null if it was not recorded.
34
52
 
35
53
  # The error code for the response.
36
54
  #
@@ -1322,6 +1322,12 @@ module OpenAI
1322
1322
  nil?: true
1323
1323
  )
1324
1324
 
1325
+ # @!attribute error
1326
+ # Details of a moderation failure, when available.
1327
+ #
1328
+ # @return [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error, nil]
1329
+ optional :error, -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error }
1330
+
1325
1331
  # @!attribute output_format
1326
1332
  # The output format used for generation.
1327
1333
  #
@@ -1361,7 +1367,7 @@ module OpenAI
1361
1367
  nil?: true
1362
1368
  )
1363
1369
 
1364
- # @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
1370
+ # @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
1365
1371
  # An image generation request made by the model.
1366
1372
  #
1367
1373
  # @param id [String]
@@ -1382,6 +1388,9 @@ module OpenAI
1382
1388
  # @param background [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Background, nil]
1383
1389
  # The background setting used for generation.
1384
1390
  #
1391
+ # @param error [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error]
1392
+ # Details of a moderation failure, when available.
1393
+ #
1385
1394
  # @param output_format [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::OutputFormat, nil]
1386
1395
  # The output format used for generation.
1387
1396
  #
@@ -1456,6 +1465,103 @@ module OpenAI
1456
1465
  # @return [Array<Symbol>]
1457
1466
  end
1458
1467
 
1468
+ # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#error
1469
+ class Error < OpenAI::Internal::Type::BaseModel
1470
+ # @!attribute code
1471
+ # The error code.
1472
+ #
1473
+ # @return [String, nil]
1474
+ required :code, String, nil?: true
1475
+
1476
+ # @!attribute message
1477
+ # A description of the error.
1478
+ #
1479
+ # @return [String]
1480
+ required :message, String
1481
+
1482
+ # @!attribute param
1483
+ # The related request parameter.
1484
+ #
1485
+ # @return [String, nil]
1486
+ required :param, String, nil?: true
1487
+
1488
+ # @!attribute type
1489
+ # The error type.
1490
+ #
1491
+ # @return [String]
1492
+ required :type, String
1493
+
1494
+ # @!attribute moderation_details
1495
+ # Public details for a `moderation_blocked` error, when available.
1496
+ #
1497
+ # @return [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails, nil]
1498
+ optional(
1499
+ :moderation_details,
1500
+ -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails }
1501
+ )
1502
+
1503
+ # @!method initialize(code:, message:, param:, type:, moderation_details: nil)
1504
+ # Details of a moderation failure, when available.
1505
+ #
1506
+ # @param code [String, nil]
1507
+ # The error code.
1508
+ #
1509
+ # @param message [String]
1510
+ # A description of the error.
1511
+ #
1512
+ # @param param [String, nil]
1513
+ # The related request parameter.
1514
+ #
1515
+ # @param type [String]
1516
+ # The error type.
1517
+ #
1518
+ # @param moderation_details [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails]
1519
+ # Public details for a `moderation_blocked` error, when available.
1520
+
1521
+ # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error#moderation_details
1522
+ class ModerationDetails < OpenAI::Internal::Type::BaseModel
1523
+ # @!attribute categories
1524
+ # Public moderation categories. New category values may be added over time.
1525
+ #
1526
+ # @return [Array<String>]
1527
+ required :categories, OpenAI::Internal::Type::ArrayOf[String]
1528
+
1529
+ # @!attribute moderation_stage
1530
+ # The stage where moderation blocked the image generation call.
1531
+ #
1532
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage]
1533
+ required(
1534
+ :moderation_stage,
1535
+ enum: -> {
1536
+ OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage
1537
+ }
1538
+ )
1539
+
1540
+ # @!method initialize(categories:, moderation_stage:)
1541
+ # Public details for a `moderation_blocked` error, when available.
1542
+ #
1543
+ # @param categories [Array<String>]
1544
+ # Public moderation categories. New category values may be added over time.
1545
+ #
1546
+ # @param moderation_stage [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage]
1547
+ # The stage where moderation blocked the image generation call.
1548
+
1549
+ # The stage where moderation blocked the image generation call.
1550
+ #
1551
+ # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails#moderation_stage
1552
+ module ModerationStage
1553
+ extend OpenAI::Internal::Type::Enum
1554
+
1555
+ INPUT = :input
1556
+ OUTPUT = :output
1557
+ UNKNOWN = :unknown
1558
+
1559
+ # @!method self.values
1560
+ # @return [Array<Symbol>]
1561
+ end
1562
+ end
1563
+ end
1564
+
1459
1565
  # The output format used for generation.
1460
1566
  #
1461
1567
  # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#output_format