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
@@ -7,6 +7,7 @@ module OpenAI
7
7
  session_id: String,
8
8
  ?agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent,
9
9
  ?metadata: ::Hash[Symbol, String]?,
10
+ ?spend_control: OpenAI::Beta::Agents::SessionUpdateParams::SpendControl?,
10
11
  ?request_options: OpenAI::request_opts
11
12
  }
12
13
 
@@ -29,16 +30,24 @@ module OpenAI
29
30
  # characters.
30
31
  attr_accessor metadata: ::Hash[Symbol, String]?
31
32
 
33
+ # Omit to retain the limit; null or a null limit removes it without resetting
34
+ # spend.
35
+ attr_accessor spend_control: OpenAI::Beta::Agents::SessionUpdateParams::SpendControl?
36
+
32
37
  # @param agent
33
38
  # Model settings for subsequent turns. Omitted fields stay unchanged.
34
39
  # @param metadata
35
40
  # Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
36
41
  # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
37
42
  # characters.
43
+ # @param spend_control
44
+ # Omit to retain the limit; null or a null limit removes it without resetting
45
+ # spend.
38
46
  def initialize: (
39
47
  session_id: String,
40
48
  ?agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent,
41
49
  ?metadata: ::Hash[Symbol, String]?,
50
+ ?spend_control: OpenAI::Beta::Agents::SessionUpdateParams::SpendControl?,
42
51
  ?request_options: OpenAI::request_opts
43
52
  ) -> void
44
53
 
@@ -46,6 +55,7 @@ module OpenAI
46
55
  session_id: String,
47
56
  ?agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent,
48
57
  ?metadata: ::Hash[Symbol, String]?,
58
+ ?spend_control: OpenAI::Beta::Agents::SessionUpdateParams::SpendControl?,
49
59
  ?request_options: OpenAI::RequestOptions
50
60
  }
51
61
 
@@ -152,6 +162,19 @@ module OpenAI
152
162
  def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::service_tier]
153
163
  end
154
164
  end
165
+
166
+ type spend_control = { limit: Integer? }
167
+
168
+ class SpendControl < OpenAI::Internal::Type::BaseModel
169
+ # Positive USD cents, or null to remove the limit.
170
+ attr_accessor limit: Integer?
171
+
172
+ # @param limit
173
+ # Positive USD cents, or null to remove the limit.
174
+ def initialize: (limit: Integer?) -> void
175
+
176
+ def to_hash: -> { limit: Integer? }
177
+ end
155
178
  end
156
179
  end
157
180
  end
@@ -6,9 +6,9 @@ module OpenAI
6
6
  type artifact_list_params =
7
7
  {
8
8
  session_id: String,
9
- ?after: String?,
9
+ ?after: String,
10
10
  ?environment_id: String?,
11
- ?limit: Integer?,
11
+ ?limit: Integer,
12
12
  ?order: OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order,
13
13
  ?request_options: OpenAI::request_opts
14
14
  }
@@ -19,45 +19,51 @@ module OpenAI
19
19
 
20
20
  attr_accessor session_id: String
21
21
 
22
- # Return artifacts after this immutable artifact ID.
23
- attr_accessor after: String?
22
+ # Return resources after this resource ID in the selected order.
23
+ attr_reader after: String?
24
+
25
+ # Return resources after this resource ID in the selected order.
26
+ def after=: (String) -> String
24
27
 
25
28
  # Restrict the listing to artifacts produced by this environment.
26
29
  attr_accessor environment_id: String?
27
30
 
28
- # The maximum number of artifacts to return, between 1 and 100.
29
- attr_accessor limit: Integer?
31
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
32
+ attr_reader limit: Integer?
33
+
34
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
35
+ def limit=: (Integer) -> Integer
30
36
 
31
- # Sort by creation time and ID. Defaults to descending.
37
+ # The order in which resources are returned. Defaults to `desc`.
32
38
  attr_reader order: OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order?
33
39
 
34
- # Sort by creation time and ID. Defaults to descending.
40
+ # The order in which resources are returned. Defaults to `desc`.
35
41
  def order=: (
36
42
  OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order
37
43
  ) -> OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order
38
44
 
39
45
  # @param after
40
- # Return artifacts after this immutable artifact ID.
46
+ # Return resources after this resource ID in the selected order.
41
47
  # @param environment_id
42
48
  # Restrict the listing to artifacts produced by this environment.
43
49
  # @param limit
44
- # The maximum number of artifacts to return, between 1 and 100.
50
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
45
51
  # @param order
46
- # Sort by creation time and ID. Defaults to descending.
52
+ # The order in which resources are returned. Defaults to `desc`.
47
53
  def initialize: (
48
54
  session_id: String,
49
- ?after: String?,
55
+ ?after: String,
50
56
  ?environment_id: String?,
51
- ?limit: Integer?,
57
+ ?limit: Integer,
52
58
  ?order: OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order,
53
59
  ?request_options: OpenAI::request_opts
54
60
  ) -> void
55
61
 
56
62
  def to_hash: -> {
57
63
  session_id: String,
58
- ?after: String?,
64
+ ?after: String,
59
65
  ?environment_id: String?,
60
- ?limit: Integer?,
66
+ ?limit: Integer,
61
67
  ?order: OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order,
62
68
  ?request_options: OpenAI::RequestOptions
63
69
  }
@@ -5,7 +5,8 @@ module OpenAI
5
5
  type vault_list_params =
6
6
  {
7
7
  ?after: String,
8
- ?limit: Integer?,
8
+ ?limit: Integer,
9
+ ?metadata: ::Hash[Symbol, String],
9
10
  ?order: OpenAI::Models::Beta::Agents::VaultListParams::order,
10
11
  ?status: OpenAI::Models::Beta::Agents::vault_status_filter,
11
12
  ?request_options: OpenAI::request_opts
@@ -21,16 +22,28 @@ module OpenAI
21
22
  # Return resources after this resource ID in the selected order.
22
23
  def after=: (String) -> String
23
24
 
24
- # The maximum number of resources to return. Defaults to 20. Values are clamped
25
- # between 1 and 100.
26
- attr_accessor limit: Integer?
25
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
26
+ attr_reader limit: Integer?
27
27
 
28
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
29
- # `desc` for descending order. Defaults to `desc`.
28
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
29
+ def limit=: (Integer) -> Integer
30
+
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
+ attr_reader metadata: ::Hash[Symbol, String]?
36
+
37
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
38
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
39
+ # characters. Filtering is eventually consistent; metadata changes may take time
40
+ # to appear.
41
+ def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
42
+
43
+ # The order in which resources are returned. Defaults to `desc`.
30
44
  attr_reader order: OpenAI::Models::Beta::Agents::VaultListParams::order?
31
45
 
32
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
33
- # `desc` for descending order. Defaults to `desc`.
46
+ # The order in which resources are returned. Defaults to `desc`.
34
47
  def order=: (
35
48
  OpenAI::Models::Beta::Agents::VaultListParams::order
36
49
  ) -> OpenAI::Models::Beta::Agents::VaultListParams::order
@@ -48,17 +61,21 @@ module OpenAI
48
61
  # @param after
49
62
  # Return resources after this resource ID in the selected order.
50
63
  # @param limit
51
- # The maximum number of resources to return. Defaults to 20. Values are clamped
52
- # between 1 and 100.
64
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
65
+ # @param metadata
66
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
67
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
68
+ # characters. Filtering is eventually consistent; metadata changes may take time
69
+ # to appear.
53
70
  # @param order
54
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
55
- # `desc` for descending order. Defaults to `desc`.
71
+ # The order in which resources are returned. Defaults to `desc`.
56
72
  # @param status
57
73
  # Filter by one status or a list, such as `status=active` or
58
74
  # `status[]=active&status[]=archived`. Both statuses are included by default.
59
75
  def initialize: (
60
76
  ?after: String,
61
- ?limit: Integer?,
77
+ ?limit: Integer,
78
+ ?metadata: ::Hash[Symbol, String],
62
79
  ?order: OpenAI::Models::Beta::Agents::VaultListParams::order,
63
80
  ?status: OpenAI::Models::Beta::Agents::vault_status_filter,
64
81
  ?request_options: OpenAI::request_opts
@@ -66,7 +83,8 @@ module OpenAI
66
83
 
67
84
  def to_hash: -> {
68
85
  ?after: String,
69
- ?limit: Integer?,
86
+ ?limit: Integer,
87
+ ?metadata: ::Hash[Symbol, String],
70
88
  ?order: OpenAI::Models::Beta::Agents::VaultListParams::order,
71
89
  ?status: OpenAI::Models::Beta::Agents::vault_status_filter,
72
90
  ?request_options: OpenAI::RequestOptions
@@ -0,0 +1,54 @@
1
+ module OpenAI
2
+ module Models
3
+ module Beta
4
+ module Agents
5
+ type vault_update_params =
6
+ {
7
+ vault_id: String,
8
+ ?metadata: ::Hash[Symbol, String],
9
+ ?name: String?,
10
+ ?request_options: OpenAI::request_opts
11
+ }
12
+
13
+ class VaultUpdateParams < OpenAI::Internal::Type::BaseModel
14
+ extend OpenAI::Internal::Type::RequestParameters::Converter
15
+ include OpenAI::Internal::Type::RequestParameters
16
+
17
+ attr_accessor vault_id: String
18
+
19
+ # Replaces all metadata. Omit to leave unchanged, or pass {} to clear it. Up to 16
20
+ # string key-value pairs, with keys up to 64 and values up to 512 characters.
21
+ attr_reader metadata: ::Hash[Symbol, String]?
22
+
23
+ # Replaces all metadata. Omit to leave unchanged, or pass {} to clear it. Up to 16
24
+ # string key-value pairs, with keys up to 64 and values up to 512 characters.
25
+ def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
26
+
27
+ # A replacement name. Omit to leave unchanged, or pass null to clear it. The name
28
+ # is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.
29
+ attr_accessor name: String?
30
+
31
+ # @param metadata
32
+ # Replaces all metadata. Omit to leave unchanged, or pass {} to clear it. Up to 16
33
+ # string key-value pairs, with keys up to 64 and values up to 512 characters.
34
+ # @param name
35
+ # A replacement name. Omit to leave unchanged, or pass null to clear it. The name
36
+ # is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.
37
+ def initialize: (
38
+ vault_id: String,
39
+ ?metadata: ::Hash[Symbol, String],
40
+ ?name: String?,
41
+ ?request_options: OpenAI::request_opts
42
+ ) -> void
43
+
44
+ def to_hash: -> {
45
+ vault_id: String,
46
+ ?metadata: ::Hash[Symbol, String],
47
+ ?name: String?,
48
+ ?request_options: OpenAI::RequestOptions
49
+ }
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -7,7 +7,8 @@ module OpenAI
7
7
  {
8
8
  vault_id: String,
9
9
  ?after: String,
10
- ?limit: Integer?,
10
+ ?limit: Integer,
11
+ ?metadata: ::Hash[Symbol, String],
11
12
  ?order: OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::order,
12
13
  ?status: OpenAI::Models::Beta::Agents::vault_status_filter,
13
14
  ?request_options: OpenAI::request_opts
@@ -25,16 +26,28 @@ module OpenAI
25
26
  # Return resources after this resource ID in the selected order.
26
27
  def after=: (String) -> String
27
28
 
28
- # The maximum number of resources to return. Defaults to 20. Values are clamped
29
- # between 1 and 100.
30
- attr_accessor limit: Integer?
29
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
30
+ attr_reader limit: Integer?
31
31
 
32
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
33
- # `desc` for descending order. Defaults to `desc`.
32
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
33
+ def limit=: (Integer) -> Integer
34
+
35
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
36
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
37
+ # characters. Filtering is eventually consistent; metadata changes may take time
38
+ # to appear.
39
+ attr_reader metadata: ::Hash[Symbol, String]?
40
+
41
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
42
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
43
+ # characters. Filtering is eventually consistent; metadata changes may take time
44
+ # to appear.
45
+ def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
46
+
47
+ # The order in which resources are returned. Defaults to `desc`.
34
48
  attr_reader order: OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::order?
35
49
 
36
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
37
- # `desc` for descending order. Defaults to `desc`.
50
+ # The order in which resources are returned. Defaults to `desc`.
38
51
  def order=: (
39
52
  OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::order
40
53
  ) -> OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::order
@@ -52,18 +65,22 @@ module OpenAI
52
65
  # @param after
53
66
  # Return resources after this resource ID in the selected order.
54
67
  # @param limit
55
- # The maximum number of resources to return. Defaults to 20. Values are clamped
56
- # between 1 and 100.
68
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
69
+ # @param metadata
70
+ # Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
71
+ # match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
72
+ # characters. Filtering is eventually consistent; metadata changes may take time
73
+ # to appear.
57
74
  # @param order
58
- # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
59
- # `desc` for descending order. Defaults to `desc`.
75
+ # The order in which resources are returned. Defaults to `desc`.
60
76
  # @param status
61
77
  # Filter by one status or a list, such as `status=active` or
62
78
  # `status[]=active&status[]=archived`. Both statuses are included by default.
63
79
  def initialize: (
64
80
  vault_id: String,
65
81
  ?after: String,
66
- ?limit: Integer?,
82
+ ?limit: Integer,
83
+ ?metadata: ::Hash[Symbol, String],
67
84
  ?order: OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::order,
68
85
  ?status: OpenAI::Models::Beta::Agents::vault_status_filter,
69
86
  ?request_options: OpenAI::request_opts
@@ -72,7 +89,8 @@ module OpenAI
72
89
  def to_hash: -> {
73
90
  vault_id: String,
74
91
  ?after: String,
75
- ?limit: Integer?,
92
+ ?limit: Integer,
93
+ ?metadata: ::Hash[Symbol, String],
76
94
  ?order: OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::order,
77
95
  ?status: OpenAI::Models::Beta::Agents::vault_status_filter,
78
96
  ?request_options: OpenAI::RequestOptions
@@ -220,7 +220,7 @@ module OpenAI
220
220
 
221
221
  # A stable identifier used to help detect users of your application that may be
222
222
  # violating OpenAI's usage policies. The IDs should be a string that uniquely
223
- # identifies each user, with a maximum length of 64 characters. We recommend
223
+ # identifies each user, with a maximum length of 128 characters. We recommend
224
224
  # hashing their username or email address, in order to avoid sending us any
225
225
  # identifying information.
226
226
  # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -453,7 +453,7 @@ module OpenAI
453
453
  # @param safety_identifier
454
454
  # A stable identifier used to help detect users of your application that may be
455
455
  # violating OpenAI's usage policies. The IDs should be a string that uniquely
456
- # identifies each user, with a maximum length of 64 characters. We recommend
456
+ # identifies each user, with a maximum length of 128 characters. We recommend
457
457
  # hashing their username or email address, in order to avoid sending us any
458
458
  # identifying information.
459
459
  # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -7,7 +7,9 @@ module OpenAI
7
7
  {
8
8
  code: OpenAI::Models::Beta::BetaResponseError::code,
9
9
  message: String,
10
- ?misalignment: OpenAI::Beta::BetaResponseError::Misalignment
10
+ ?misalignment: OpenAI::Beta::BetaResponseError::Misalignment,
11
+ ?param: String?,
12
+ ?type: String?
11
13
  }
12
14
 
13
15
  class BetaResponseError < OpenAI::Internal::Type::BaseModel
@@ -23,20 +25,34 @@ module OpenAI
23
25
  OpenAI::Beta::BetaResponseError::Misalignment
24
26
  ) -> OpenAI::Beta::BetaResponseError::Misalignment
25
27
 
28
+ # The request parameter associated with the error, or null if none was recorded.
29
+ attr_accessor param: String?
30
+
31
+ # The original error type, or null if it was not recorded.
32
+ attr_accessor type: String?
33
+
26
34
  # @param code
27
35
  # The error code for the response.
28
36
  # @param message
29
37
  # A human-readable description of the error.
38
+ # @param param
39
+ # The request parameter associated with the error, or null if none was recorded.
40
+ # @param type
41
+ # The original error type, or null if it was not recorded.
30
42
  def initialize: (
31
43
  code: OpenAI::Models::Beta::BetaResponseError::code,
32
44
  message: String,
33
- ?misalignment: OpenAI::Beta::BetaResponseError::Misalignment
45
+ ?misalignment: OpenAI::Beta::BetaResponseError::Misalignment,
46
+ ?param: String?,
47
+ ?type: String?
34
48
  ) -> void
35
49
 
36
50
  def to_hash: -> {
37
51
  code: OpenAI::Models::Beta::BetaResponseError::code,
38
52
  message: String,
39
- ?misalignment: OpenAI::Beta::BetaResponseError::Misalignment
53
+ ?misalignment: OpenAI::Beta::BetaResponseError::Misalignment,
54
+ ?param: String?,
55
+ ?type: String?
40
56
  }
41
57
 
42
58
  type code =
@@ -1135,6 +1135,7 @@ module OpenAI
1135
1135
  ?action: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::action?,
1136
1136
  ?agent: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Agent?,
1137
1137
  ?background: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::background?,
1138
+ ?error: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error,
1138
1139
  ?output_format: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::output_format?,
1139
1140
  ?quality: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::quality?,
1140
1141
  ?revised_prompt: String?,
@@ -1163,6 +1164,14 @@ module OpenAI
1163
1164
  # The background setting used for generation.
1164
1165
  attr_accessor background: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::background?
1165
1166
 
1167
+ # Details of a moderation failure, when available.
1168
+ attr_reader error: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error?
1169
+
1170
+ # Details of a moderation failure, when available.
1171
+ def error=: (
1172
+ OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error
1173
+ ) -> OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error
1174
+
1166
1175
  # The output format used for generation.
1167
1176
  attr_accessor output_format: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::output_format?
1168
1177
 
@@ -1188,6 +1197,8 @@ module OpenAI
1188
1197
  # The agent that produced this item.
1189
1198
  # @param background
1190
1199
  # The background setting used for generation.
1200
+ # @param error
1201
+ # Details of a moderation failure, when available.
1191
1202
  # @param output_format
1192
1203
  # The output format used for generation.
1193
1204
  # @param quality
@@ -1206,6 +1217,7 @@ module OpenAI
1206
1217
  ?action: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::action?,
1207
1218
  ?agent: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Agent?,
1208
1219
  ?background: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::background?,
1220
+ ?error: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error,
1209
1221
  ?output_format: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::output_format?,
1210
1222
  ?quality: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::quality?,
1211
1223
  ?revised_prompt: String?,
@@ -1221,6 +1233,7 @@ module OpenAI
1221
1233
  ?action: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::action?,
1222
1234
  ?agent: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Agent?,
1223
1235
  ?background: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::background?,
1236
+ ?error: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error,
1224
1237
  ?output_format: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::output_format?,
1225
1238
  ?quality: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::quality?,
1226
1239
  ?revised_prompt: String?,
@@ -1277,6 +1290,103 @@ module OpenAI
1277
1290
  def self?.values: -> ::Array[OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::background]
1278
1291
  end
1279
1292
 
1293
+ type error =
1294
+ {
1295
+ code: String?,
1296
+ message: String,
1297
+ param: String?,
1298
+ type: String,
1299
+ ?moderation_details: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails
1300
+ }
1301
+
1302
+ class Error < OpenAI::Internal::Type::BaseModel
1303
+ # The error code.
1304
+ attr_accessor code: String?
1305
+
1306
+ # A description of the error.
1307
+ attr_accessor message: String
1308
+
1309
+ # The related request parameter.
1310
+ attr_accessor param: String?
1311
+
1312
+ # The error type.
1313
+ attr_accessor type: String
1314
+
1315
+ # Public details for a `moderation_blocked` error, when available.
1316
+ attr_reader moderation_details: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails?
1317
+
1318
+ # Public details for a `moderation_blocked` error, when available.
1319
+ def moderation_details=: (
1320
+ OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails
1321
+ ) -> OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails
1322
+
1323
+ # @param code
1324
+ # The error code.
1325
+ # @param message
1326
+ # A description of the error.
1327
+ # @param param
1328
+ # The related request parameter.
1329
+ # @param type
1330
+ # The error type.
1331
+ # @param moderation_details
1332
+ # Public details for a `moderation_blocked` error, when available.
1333
+ def initialize: (
1334
+ code: String?,
1335
+ message: String,
1336
+ param: String?,
1337
+ type: String,
1338
+ ?moderation_details: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails
1339
+ ) -> void
1340
+
1341
+ def to_hash: -> {
1342
+ code: String?,
1343
+ message: String,
1344
+ param: String?,
1345
+ type: String,
1346
+ ?moderation_details: OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails
1347
+ }
1348
+
1349
+ type moderation_details =
1350
+ {
1351
+ categories: ::Array[String],
1352
+ moderation_stage: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::moderation_stage
1353
+ }
1354
+
1355
+ class ModerationDetails < OpenAI::Internal::Type::BaseModel
1356
+ # Public moderation categories. New category values may be added over time.
1357
+ attr_accessor categories: ::Array[String]
1358
+
1359
+ # The stage where moderation blocked the image generation call.
1360
+ attr_accessor moderation_stage: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::moderation_stage
1361
+
1362
+ # @param categories
1363
+ # Public moderation categories. New category values may be added over time.
1364
+ # @param moderation_stage
1365
+ # The stage where moderation blocked the image generation call.
1366
+ def initialize: (
1367
+ categories: ::Array[String],
1368
+ moderation_stage: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::moderation_stage
1369
+ ) -> void
1370
+
1371
+ def to_hash: -> {
1372
+ categories: ::Array[String],
1373
+ moderation_stage: OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::moderation_stage
1374
+ }
1375
+
1376
+ type moderation_stage = :input | :output | :unknown
1377
+
1378
+ module ModerationStage
1379
+ extend OpenAI::Internal::Type::Enum
1380
+
1381
+ INPUT: :input
1382
+ OUTPUT: :output
1383
+ UNKNOWN: :unknown
1384
+
1385
+ def self?.values: -> ::Array[OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::moderation_stage]
1386
+ end
1387
+ end
1388
+ end
1389
+
1280
1390
  type output_format = :png | :webp | :jpeg
1281
1391
 
1282
1392
  module OutputFormat