openai 0.123.0 → 0.125.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 (263) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -0
  3. data/README.md +1 -1
  4. data/lib/openai/internal/stream.rb +1 -1
  5. data/lib/openai/internal/transport/base_client.rb +11 -2
  6. data/lib/openai/internal/type/base_stream.rb +10 -0
  7. data/lib/openai/models/admin/organization/audit_log_list_response.rb +10 -1
  8. data/lib/openai/models/admin/organization/external_key.rb +25 -1
  9. data/lib/openai/models/admin/organization/external_key_create_params.rb +78 -3
  10. data/lib/openai/models/beta/agent.rb +2 -2
  11. data/lib/openai/models/beta/agent_create_params.rb +9 -9
  12. data/lib/openai/models/beta/agent_output_command_execution_output_delta_event.rb +10 -1
  13. data/lib/openai/models/beta/agent_session.rb +130 -6
  14. data/lib/openai/models/beta/agent_session_created_event.rb +10 -1
  15. data/lib/openai/models/beta/agent_session_environment_connected_event.rb +10 -1
  16. data/lib/openai/models/beta/agent_session_environment_disconnected_event.rb +10 -1
  17. data/lib/openai/models/beta/agent_session_environment_expired_event.rb +10 -1
  18. data/lib/openai/models/beta/agent_session_environment_failed_event.rb +10 -1
  19. data/lib/openai/models/beta/agent_session_environment_pending_event.rb +10 -1
  20. data/lib/openai/models/beta/agent_session_environment_ready_event.rb +10 -1
  21. data/lib/openai/models/beta/agent_session_environment_reset_event.rb +10 -1
  22. data/lib/openai/models/beta/agent_session_environment_suspended_event.rb +10 -1
  23. data/lib/openai/models/beta/agent_session_error_event.rb +10 -1
  24. data/lib/openai/models/beta/agent_session_failed_event.rb +10 -1
  25. data/lib/openai/models/beta/agent_session_idle_event.rb +10 -1
  26. data/lib/openai/models/beta/agent_session_in_progress_event.rb +10 -1
  27. data/lib/openai/models/beta/agent_session_input_param.rb +87 -1
  28. data/lib/openai/models/beta/agent_session_requires_action_event.rb +10 -1
  29. data/lib/openai/models/beta/agent_session_subagent_active_event.rb +10 -1
  30. data/lib/openai/models/beta/agent_session_subagent_closed_event.rb +10 -1
  31. data/lib/openai/models/beta/agent_session_subagent_created_event.rb +10 -1
  32. data/lib/openai/models/beta/agent_session_turn_cancelled_event.rb +10 -1
  33. data/lib/openai/models/beta/agent_session_turn_completed_event.rb +10 -1
  34. data/lib/openai/models/beta/agent_session_turn_content_part_added_event.rb +10 -1
  35. data/lib/openai/models/beta/agent_session_turn_content_part_done_event.rb +10 -1
  36. data/lib/openai/models/beta/agent_session_turn_created_event.rb +10 -1
  37. data/lib/openai/models/beta/agent_session_turn_failed_event.rb +10 -1
  38. data/lib/openai/models/beta/agent_session_turn_in_progress_event.rb +10 -1
  39. data/lib/openai/models/beta/agent_session_turn_item_added_event.rb +10 -1
  40. data/lib/openai/models/beta/agent_session_turn_item_done_event.rb +10 -1
  41. data/lib/openai/models/beta/agent_session_turn_output_text_delta_event.rb +10 -1
  42. data/lib/openai/models/beta/agent_session_turn_output_text_done_event.rb +10 -1
  43. data/lib/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rb +10 -1
  44. data/lib/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rb +10 -1
  45. data/lib/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rb +10 -1
  46. data/lib/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rb +10 -1
  47. data/lib/openai/models/beta/agent_update_params.rb +9 -12
  48. data/lib/openai/models/beta/agents/automation_agent_config.rb +2 -2
  49. data/lib/openai/models/beta/agents/automation_target_param.rb +9 -12
  50. data/lib/openai/models/beta/agents/one_time_automation.rb +28 -1
  51. data/lib/openai/models/beta/agents/periodic_automation.rb +28 -1
  52. data/lib/openai/models/beta/agents/session_create_params.rb +78 -13
  53. data/lib/openai/models/beta/agents/session_update_params.rb +44 -1
  54. data/lib/openai/models/beta/agents/sessions/event_create_params.rb +2 -2
  55. data/lib/openai/models/beta/agents/sessions/event_stream_params.rb +13 -1
  56. data/lib/openai/models/beta/agents/sessions/turn.rb +41 -1
  57. data/lib/openai/models/beta/beta_response.rb +9 -3
  58. data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +6 -3
  59. data/lib/openai/models/beta/beta_responses_client_event.rb +9 -3
  60. data/lib/openai/models/beta/beta_tool.rb +6 -3
  61. data/lib/openai/models/beta/response_compact_params.rb +2 -0
  62. data/lib/openai/models/beta/response_create_params.rb +9 -3
  63. data/lib/openai/models/beta/responses/input_token_count_params.rb +27 -15
  64. data/lib/openai/models/content_provenance_check_create_params.rb +2 -0
  65. data/lib/openai/models/image_edit_params.rb +84 -5
  66. data/lib/openai/models/image_generate_params.rb +4 -4
  67. data/lib/openai/models/images_response.rb +9 -12
  68. data/lib/openai/models/live/media_session_config.rb +12 -1
  69. data/lib/openai/models/live/session_accept_params.rb +12 -1
  70. data/lib/openai/models/live/session_config.rb +12 -1
  71. data/lib/openai/models/live/session_resource.rb +12 -1
  72. data/lib/openai/models/responses/input_token_count_params.rb +27 -15
  73. data/lib/openai/models/responses/response.rb +9 -3
  74. data/lib/openai/models/responses/response_compact_params.rb +2 -0
  75. data/lib/openai/models/responses/response_create_params.rb +9 -3
  76. data/lib/openai/models/responses/response_tool_search_output_item_param.rb +6 -3
  77. data/lib/openai/models/responses/responses_client_event.rb +9 -3
  78. data/lib/openai/models/responses/tool.rb +6 -3
  79. data/lib/openai/models/video_create_error.rb +6 -4
  80. data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +1 -0
  81. data/lib/openai/models/webhooks/live_transport_connected_webhook_event.rb +74 -0
  82. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +4 -1
  83. data/lib/openai/resources/admin/organization/external_keys.rb +1 -1
  84. data/lib/openai/resources/beta/agents/sessions/events.rb +11 -3
  85. data/lib/openai/resources/beta/agents/sessions.rb +25 -5
  86. data/lib/openai/resources/beta/agents.rb +2 -3
  87. data/lib/openai/resources/beta/responses/input_tokens.rb +9 -6
  88. data/lib/openai/resources/beta/responses.rb +6 -2
  89. data/lib/openai/resources/content_provenance_checks.rb +1 -0
  90. data/lib/openai/resources/images.rb +20 -6
  91. data/lib/openai/resources/responses/input_tokens.rb +9 -5
  92. data/lib/openai/resources/responses.rb +6 -2
  93. data/lib/openai/resources/webhooks.rb +1 -1
  94. data/lib/openai/version.rb +1 -1
  95. data/lib/openai.rb +1 -0
  96. data/rbi/openai/internal/transport/base_client.rbi +4 -1
  97. data/rbi/openai/internal/type/base_stream.rbi +5 -0
  98. data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +13 -1
  99. data/rbi/openai/models/admin/organization/external_key.rbi +44 -0
  100. data/rbi/openai/models/admin/organization/external_key_create_params.rbi +137 -4
  101. data/rbi/openai/models/beta/agent.rbi +2 -2
  102. data/rbi/openai/models/beta/agent_create_params.rbi +9 -9
  103. data/rbi/openai/models/beta/agent_output_command_execution_output_delta_event.rbi +14 -1
  104. data/rbi/openai/models/beta/agent_session.rbi +209 -2
  105. data/rbi/openai/models/beta/agent_session_created_event.rbi +13 -1
  106. data/rbi/openai/models/beta/agent_session_environment_connected_event.rbi +14 -1
  107. data/rbi/openai/models/beta/agent_session_environment_disconnected_event.rbi +14 -1
  108. data/rbi/openai/models/beta/agent_session_environment_expired_event.rbi +14 -1
  109. data/rbi/openai/models/beta/agent_session_environment_failed_event.rbi +14 -1
  110. data/rbi/openai/models/beta/agent_session_environment_pending_event.rbi +14 -1
  111. data/rbi/openai/models/beta/agent_session_environment_ready_event.rbi +14 -1
  112. data/rbi/openai/models/beta/agent_session_environment_reset_event.rbi +14 -1
  113. data/rbi/openai/models/beta/agent_session_environment_suspended_event.rbi +14 -1
  114. data/rbi/openai/models/beta/agent_session_error_event.rbi +13 -1
  115. data/rbi/openai/models/beta/agent_session_failed_event.rbi +13 -1
  116. data/rbi/openai/models/beta/agent_session_idle_event.rbi +13 -1
  117. data/rbi/openai/models/beta/agent_session_in_progress_event.rbi +13 -1
  118. data/rbi/openai/models/beta/agent_session_input_param.rbi +159 -0
  119. data/rbi/openai/models/beta/agent_session_requires_action_event.rbi +13 -1
  120. data/rbi/openai/models/beta/agent_session_subagent_active_event.rbi +13 -1
  121. data/rbi/openai/models/beta/agent_session_subagent_closed_event.rbi +13 -1
  122. data/rbi/openai/models/beta/agent_session_subagent_created_event.rbi +13 -1
  123. data/rbi/openai/models/beta/agent_session_turn_cancelled_event.rbi +14 -1
  124. data/rbi/openai/models/beta/agent_session_turn_completed_event.rbi +14 -1
  125. data/rbi/openai/models/beta/agent_session_turn_content_part_added_event.rbi +14 -1
  126. data/rbi/openai/models/beta/agent_session_turn_content_part_done_event.rbi +14 -1
  127. data/rbi/openai/models/beta/agent_session_turn_created_event.rbi +14 -1
  128. data/rbi/openai/models/beta/agent_session_turn_failed_event.rbi +14 -1
  129. data/rbi/openai/models/beta/agent_session_turn_in_progress_event.rbi +14 -1
  130. data/rbi/openai/models/beta/agent_session_turn_item_added_event.rbi +14 -1
  131. data/rbi/openai/models/beta/agent_session_turn_item_done_event.rbi +14 -1
  132. data/rbi/openai/models/beta/agent_session_turn_output_text_delta_event.rbi +14 -1
  133. data/rbi/openai/models/beta/agent_session_turn_output_text_done_event.rbi +14 -1
  134. data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbi +14 -1
  135. data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbi +14 -1
  136. data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbi +14 -1
  137. data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbi +14 -1
  138. data/rbi/openai/models/beta/agent_update_params.rbi +9 -12
  139. data/rbi/openai/models/beta/agents/automation_agent_config.rbi +2 -2
  140. data/rbi/openai/models/beta/agents/automation_target_param.rbi +9 -12
  141. data/rbi/openai/models/beta/agents/one_time_automation.rbi +28 -1
  142. data/rbi/openai/models/beta/agents/periodic_automation.rbi +28 -1
  143. data/rbi/openai/models/beta/agents/session_create_params.rbi +147 -12
  144. data/rbi/openai/models/beta/agents/session_update_params.rbi +82 -0
  145. data/rbi/openai/models/beta/agents/sessions/event_create_params.rbi +3 -0
  146. data/rbi/openai/models/beta/agents/sessions/event_stream_params.rbi +15 -1
  147. data/rbi/openai/models/beta/agents/sessions/turn.rbi +74 -1
  148. data/rbi/openai/models/beta/beta_response.rbi +9 -3
  149. data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +6 -3
  150. data/rbi/openai/models/beta/beta_responses_client_event.rbi +9 -3
  151. data/rbi/openai/models/beta/beta_tool.rbi +6 -3
  152. data/rbi/openai/models/beta/response_create_params.rbi +9 -3
  153. data/rbi/openai/models/beta/responses/input_token_count_params.rbi +27 -15
  154. data/rbi/openai/models/content_provenance_check_create_params.rbi +2 -0
  155. data/rbi/openai/models/image_edit_params.rbi +143 -4
  156. data/rbi/openai/models/image_generate_params.rbi +4 -4
  157. data/rbi/openai/models/images_response.rbi +9 -12
  158. data/rbi/openai/models/live/media_session_config.rbi +12 -0
  159. data/rbi/openai/models/live/session_accept_params.rbi +12 -0
  160. data/rbi/openai/models/live/session_config.rbi +12 -0
  161. data/rbi/openai/models/live/session_resource.rbi +12 -0
  162. data/rbi/openai/models/responses/input_token_count_params.rbi +27 -15
  163. data/rbi/openai/models/responses/response.rbi +9 -3
  164. data/rbi/openai/models/responses/response_create_params.rbi +9 -3
  165. data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +6 -3
  166. data/rbi/openai/models/responses/responses_client_event.rbi +9 -3
  167. data/rbi/openai/models/responses/tool.rbi +6 -3
  168. data/rbi/openai/models/video_create_error.rbi +6 -4
  169. data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +4 -0
  170. data/rbi/openai/models/webhooks/live_transport_connected_webhook_event.rbi +135 -0
  171. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +1 -0
  172. data/rbi/openai/resources/admin/organization/external_keys.rbi +2 -1
  173. data/rbi/openai/resources/beta/agents/sessions/events.rbi +9 -2
  174. data/rbi/openai/resources/beta/agents/sessions.rbi +21 -2
  175. data/rbi/openai/resources/beta/agents.rbi +2 -3
  176. data/rbi/openai/resources/beta/responses/input_tokens.rbi +9 -6
  177. data/rbi/openai/resources/beta/responses.rbi +6 -2
  178. data/rbi/openai/resources/content_provenance_checks.rbi +1 -0
  179. data/rbi/openai/resources/images.rbi +18 -4
  180. data/rbi/openai/resources/responses/input_tokens.rbi +9 -5
  181. data/rbi/openai/resources/responses.rbi +6 -2
  182. data/rbi/openai/resources/webhooks.rbi +1 -0
  183. data/sig/openai/internal/transport/base_client.rbs +1 -0
  184. data/sig/openai/internal/type/base_stream.rbs +2 -0
  185. data/sig/openai/models/admin/organization/audit_log_list_response.rbs +18 -3
  186. data/sig/openai/models/admin/organization/external_key.rbs +28 -0
  187. data/sig/openai/models/admin/organization/external_key_create_params.rbs +108 -0
  188. data/sig/openai/models/beta/agent.rbs +2 -2
  189. data/sig/openai/models/beta/agent_create_params.rbs +8 -8
  190. data/sig/openai/models/beta/agent_output_command_execution_output_delta_event.rbs +13 -2
  191. data/sig/openai/models/beta/agent_session.rbs +128 -3
  192. data/sig/openai/models/beta/agent_session_created_event.rbs +13 -2
  193. data/sig/openai/models/beta/agent_session_environment_connected_event.rbs +13 -2
  194. data/sig/openai/models/beta/agent_session_environment_disconnected_event.rbs +13 -2
  195. data/sig/openai/models/beta/agent_session_environment_expired_event.rbs +13 -2
  196. data/sig/openai/models/beta/agent_session_environment_failed_event.rbs +13 -2
  197. data/sig/openai/models/beta/agent_session_environment_pending_event.rbs +13 -2
  198. data/sig/openai/models/beta/agent_session_environment_ready_event.rbs +13 -2
  199. data/sig/openai/models/beta/agent_session_environment_reset_event.rbs +13 -2
  200. data/sig/openai/models/beta/agent_session_environment_suspended_event.rbs +13 -2
  201. data/sig/openai/models/beta/agent_session_error_event.rbs +13 -2
  202. data/sig/openai/models/beta/agent_session_failed_event.rbs +13 -2
  203. data/sig/openai/models/beta/agent_session_idle_event.rbs +13 -2
  204. data/sig/openai/models/beta/agent_session_in_progress_event.rbs +13 -2
  205. data/sig/openai/models/beta/agent_session_input_param.rbs +80 -1
  206. data/sig/openai/models/beta/agent_session_requires_action_event.rbs +13 -2
  207. data/sig/openai/models/beta/agent_session_subagent_active_event.rbs +13 -2
  208. data/sig/openai/models/beta/agent_session_subagent_closed_event.rbs +13 -2
  209. data/sig/openai/models/beta/agent_session_subagent_created_event.rbs +13 -2
  210. data/sig/openai/models/beta/agent_session_turn_cancelled_event.rbs +13 -2
  211. data/sig/openai/models/beta/agent_session_turn_completed_event.rbs +13 -2
  212. data/sig/openai/models/beta/agent_session_turn_content_part_added_event.rbs +13 -2
  213. data/sig/openai/models/beta/agent_session_turn_content_part_done_event.rbs +13 -2
  214. data/sig/openai/models/beta/agent_session_turn_created_event.rbs +13 -2
  215. data/sig/openai/models/beta/agent_session_turn_failed_event.rbs +13 -2
  216. data/sig/openai/models/beta/agent_session_turn_in_progress_event.rbs +13 -2
  217. data/sig/openai/models/beta/agent_session_turn_item_added_event.rbs +13 -2
  218. data/sig/openai/models/beta/agent_session_turn_item_done_event.rbs +13 -2
  219. data/sig/openai/models/beta/agent_session_turn_output_text_delta_event.rbs +13 -2
  220. data/sig/openai/models/beta/agent_session_turn_output_text_done_event.rbs +13 -2
  221. data/sig/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbs +13 -2
  222. data/sig/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbs +13 -2
  223. data/sig/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbs +13 -2
  224. data/sig/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbs +13 -2
  225. data/sig/openai/models/beta/agent_update_params.rbs +8 -10
  226. data/sig/openai/models/beta/agents/automation_agent_config.rbs +2 -2
  227. data/sig/openai/models/beta/agents/automation_target_param.rbs +8 -10
  228. data/sig/openai/models/beta/agents/one_time_automation.rbs +20 -2
  229. data/sig/openai/models/beta/agents/periodic_automation.rbs +20 -2
  230. data/sig/openai/models/beta/agents/session_create_params.rbs +86 -10
  231. data/sig/openai/models/beta/agents/session_update_params.rbs +46 -0
  232. data/sig/openai/models/beta/agents/sessions/event_stream_params.rbs +18 -1
  233. data/sig/openai/models/beta/agents/sessions/turn.rbs +40 -2
  234. data/sig/openai/models/beta/beta_response.rbs +6 -2
  235. data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +6 -3
  236. data/sig/openai/models/beta/beta_responses_client_event.rbs +6 -2
  237. data/sig/openai/models/beta/beta_tool.rbs +6 -3
  238. data/sig/openai/models/beta/response_create_params.rbs +6 -2
  239. data/sig/openai/models/beta/responses/input_token_count_params.rbs +27 -15
  240. data/sig/openai/models/content_provenance_check_create_params.rbs +2 -0
  241. data/sig/openai/models/image_edit_params.rbs +87 -4
  242. data/sig/openai/models/image_generate_params.rbs +4 -4
  243. data/sig/openai/models/images_response.rbs +9 -12
  244. data/sig/openai/models/live/media_session_config.rbs +10 -0
  245. data/sig/openai/models/live/session_accept_params.rbs +10 -0
  246. data/sig/openai/models/live/session_config.rbs +10 -0
  247. data/sig/openai/models/live/session_resource.rbs +10 -0
  248. data/sig/openai/models/responses/input_token_count_params.rbs +27 -15
  249. data/sig/openai/models/responses/response.rbs +6 -2
  250. data/sig/openai/models/responses/response_create_params.rbs +6 -2
  251. data/sig/openai/models/responses/response_tool_search_output_item_param.rbs +6 -3
  252. data/sig/openai/models/responses/responses_client_event.rbs +6 -2
  253. data/sig/openai/models/responses/tool.rbs +6 -3
  254. data/sig/openai/models/video_create_error.rbs +9 -6
  255. data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +2 -0
  256. data/sig/openai/models/webhooks/live_transport_connected_webhook_event.rbs +66 -0
  257. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
  258. data/sig/openai/resources/admin/organization/external_keys.rbs +9 -0
  259. data/sig/openai/resources/beta/agents/sessions/events.rbs +1 -0
  260. data/sig/openai/resources/beta/agents/sessions.rbs +5 -0
  261. data/sig/openai/resources/images.rbs +2 -0
  262. data/sig/openai/resources/webhooks.rbs +1 -0
  263. metadata +4 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c94cbc1845194c892da00630d5143feac80c478c518f1325ba36f510afc6d355
4
- data.tar.gz: e5f5dd4b686a977b6f6354e5772f0d7cb024f9ae1060c57c9c5cf9da8f9f2b4e
3
+ metadata.gz: b5cd2a7ee337aebf6fbf11cdeb052a2851dfadc9fcefb7b0ca6bf84b2a8c68e5
4
+ data.tar.gz: f9f4fd6019c8dbc2822f739df88cb57ae01fa66b081d4bbe571676a2eec79734
5
5
  SHA512:
6
- metadata.gz: 0c56d4ef6354d585b97eb289a6275268ab3fdeb77b8afc77c2d53b6dc2e8727edacd801b12f7f6746d426bff8a285fcbd3c75ae821ee49e033f3c84a2d275491
7
- data.tar.gz: cca0b2b708f90ebdb233cf56b73f073cba6d9c7009e1f33b9eb9fb33a6c1ec961f7bc42238e605955d3c99b5e195921f484c77c53a1479e8ff8a9b769c9afc3f
6
+ metadata.gz: fa3c1a6bcb6ba2982c9cadd983bc61b96975b13b11a9a4661be125c1f4affc75e14de83daadcb0f33d23b4f629523994d3db7cc0a85f5e755846419a6f1fbfe4
7
+ data.tar.gz: 674c65a1a2a2f725082597dbd96bb9114d6375a74dcd14761697c2ba1330fb8c25450e78973eec380f5cf3cb6896b8bd8d5436236d366e7484bb5501f71fecdc
data/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.125.0](https://github.com/openai/openai-ruby/compare/v0.124.0...v0.125.0) (2026-11-16)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** add schedule pause reasons ([#1068](https://github.com/openai/openai-ruby/issues/1068)) ([59b49f1](https://github.com/openai/openai-ruby/commit/59b49f1238b5515d9ce27991cc3f20c414689b27))
9
+ * **api:** deliver beta Agents session errors as stream events ([#1071](https://github.com/openai/openai-ruby/issues/1071)) ([372cde2](https://github.com/openai/openai-ruby/commit/372cde20c488904df4cd8d0ecc0159e86eab85af))
10
+
11
+ ## [0.124.0](https://github.com/openai/openai-ruby/compare/v0.123.0...v0.124.0) (2026-11-12)
12
+
13
+
14
+ ### Features
15
+
16
+ * **api:** update Live, Agents, images, and external keys ([#1061](https://github.com/openai/openai-ruby/issues/1061)) ([05218ac](https://github.com/openai/openai-ruby/commit/05218ac6c6bc57102de3abe868425832357d3ebd))
17
+
3
18
  ## [0.123.0](https://github.com/openai/openai-ruby/compare/v0.122.0...v0.123.0) (2026-11-12)
4
19
 
5
20
 
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "openai", "~> 0.123.0"
18
+ gem "openai", "~> 0.125.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -30,7 +30,7 @@ module OpenAI
30
30
  next
31
31
  in {data: String => data}
32
32
  case JSON.parse(data, symbolize_names: true)
33
- in {error: error}
33
+ in {error: error} if @stream_mode != :events
34
34
  message = case error
35
35
  in String
36
36
  error
@@ -54,6 +54,7 @@ module OpenAI
54
54
  :unwrap,
55
55
  :page,
56
56
  :stream,
57
+ :stream_mode,
57
58
  :model,
58
59
  :security,
59
60
  :options
@@ -390,6 +391,8 @@ module OpenAI
390
391
  #
391
392
  # @option req [Class<OpenAI::Internal::Type::BaseStream>, nil] :stream
392
393
  #
394
+ # @option req [Symbol, :legacy, :events, nil] :stream_mode
395
+ #
393
396
  # @option req [OpenAI::Internal::Type::Converter, Class, nil] :model
394
397
  #
395
398
  # @option req [Hash{Symbol=>Boolean}, nil] :security
@@ -776,7 +779,7 @@ module OpenAI
776
779
  # Execute the request specified by `req`. This is the method that all resource
777
780
  # methods call into.
778
781
  #
779
- # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: OpenAI::Internal::Type::Unknown, security: {bearer_auth: true, admin_api_key_auth: true}, options: {})
782
+ # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, stream_mode: nil, model: OpenAI::Internal::Type::Unknown, security: {bearer_auth: true, admin_api_key_auth: true}, options: {})
780
783
  #
781
784
  # @param method [Symbol]
782
785
  #
@@ -794,6 +797,9 @@ module OpenAI
794
797
  #
795
798
  # @param stream [Class<OpenAI::Internal::Type::BaseStream>, nil]
796
799
  #
800
+ # @param stream_mode [Symbol, :legacy, :events, nil]
801
+ # Deliver domain error events instead of raising when set to `:events`.
802
+ #
797
803
  # @param model [OpenAI::Internal::Type::Converter, Class, nil]
798
804
  #
799
805
  # @param security [Hash{Symbol=>Boolean}, nil]
@@ -948,7 +954,7 @@ module OpenAI
948
954
 
949
955
  case req
950
956
  in {stream: Class => st}
951
- st.new(
957
+ stream = st.new(
952
958
  model: model,
953
959
  url: url,
954
960
  response_metadata: response_metadata,
@@ -956,6 +962,8 @@ module OpenAI
956
962
  unwrap: unwrap,
957
963
  stream: decoded
958
964
  )
965
+ stream.set_stream_mode(req[:stream_mode]) if req[:stream_mode]
966
+ stream
959
967
  in {page: Class => page}
960
968
  page.new(client: self, req: req, response_metadata: response_metadata, page_data: decoded)
961
969
  else
@@ -1011,6 +1019,7 @@ module OpenAI
1011
1019
  stream: T.nilable(
1012
1020
  T::Class[OpenAI::Internal::Type::BaseStream[T.anything, OpenAI::Internal::Type::BaseModel]]
1013
1021
  ),
1022
+ stream_mode: T.nilable(Symbol),
1014
1023
  model: T.nilable(OpenAI::Internal::Type::Converter::Input),
1015
1024
  security: T.nilable(T::Hash[Symbol, T::Boolean]),
1016
1025
  options: T.nilable(OpenAI::RequestOptions::OrHash)
@@ -39,6 +39,16 @@ module OpenAI
39
39
  # @return [void]
40
40
  def close = OpenAI::Internal::Util.close_fused!(@iterator)
41
41
 
42
+ # Configure event delivery without changing custom stream initializers.
43
+ #
44
+ # @api private
45
+ # @param mode [Symbol, :legacy, :events]
46
+ # @return [self]
47
+ def set_stream_mode(mode)
48
+ @stream_mode = mode
49
+ self
50
+ end
51
+
42
52
  # Attach request lifecycle logging without changing the stream's identity.
43
53
  #
44
54
  # @api private
@@ -1229,15 +1229,24 @@ module OpenAI
1229
1229
 
1230
1230
  # @see OpenAI::Models::Admin::Organization::AuditLogListResponse::APIKeyUpdated#changes_requested
1231
1231
  class ChangesRequested < OpenAI::Internal::Type::BaseModel
1232
+ # @!attribute expires_in_seconds
1233
+ # Number of seconds from the update request until the API key expires.
1234
+ #
1235
+ # @return [Integer, nil]
1236
+ optional :expires_in_seconds, Integer
1237
+
1232
1238
  # @!attribute scopes
1233
1239
  # A list of scopes allowed for the API key, e.g. `["api.model.request"]`
1234
1240
  #
1235
1241
  # @return [Array<String>, nil]
1236
1242
  optional :scopes, OpenAI::Internal::Type::ArrayOf[String]
1237
1243
 
1238
- # @!method initialize(scopes: nil)
1244
+ # @!method initialize(expires_in_seconds: nil, scopes: nil)
1239
1245
  # The payload used to update the API key.
1240
1246
  #
1247
+ # @param expires_in_seconds [Integer]
1248
+ # Number of seconds from the update request until the API key expires.
1249
+ #
1241
1250
  # @param scopes [Array<String>]
1242
1251
  # A list of scopes allowed for the API key, e.g. `["api.model.request"]`
1243
1252
  end
@@ -56,11 +56,21 @@ module OpenAI
56
56
  # @return [String, nil]
57
57
  optional :key_name, String
58
58
 
59
+ # @!attribute key_ocid
60
+ #
61
+ # @return [String, nil]
62
+ optional :key_ocid, String
63
+
59
64
  # @!attribute key_version
60
65
  #
61
66
  # @return [String, nil]
62
67
  optional :key_version, String
63
68
 
69
+ # @!attribute key_version_ocid
70
+ #
71
+ # @return [String, nil]
72
+ optional :key_version_ocid, String
73
+
64
74
  # @!attribute kms_arn
65
75
  #
66
76
  # @return [String, nil]
@@ -96,6 +106,11 @@ module OpenAI
96
106
  # @return [Symbol, OpenAI::Models::Admin::Organization::ExternalKey::Purpose, nil]
97
107
  optional :purpose, enum: -> { OpenAI::Admin::Organization::ExternalKey::Purpose }
98
108
 
109
+ # @!attribute region
110
+ #
111
+ # @return [String, nil]
112
+ optional :region, String
113
+
99
114
  # @!attribute role_arn
100
115
  #
101
116
  # @return [String, nil]
@@ -106,6 +121,11 @@ module OpenAI
106
121
  # @return [String, nil]
107
122
  optional :tenant_id, String
108
123
 
124
+ # @!attribute vault_ocid
125
+ #
126
+ # @return [String, nil]
127
+ optional :vault_ocid, String
128
+
109
129
  # @!attribute vault_uri
110
130
  #
111
131
  # @return [String, nil]
@@ -126,7 +146,7 @@ module OpenAI
126
146
  # @return [String, nil]
127
147
  optional :workload_identity_provider_id, String
128
148
 
129
- # @!method initialize(id:, api_project_ids:, created_at:, name:, object:, type:, workspace_id:, audience: nil, external_id: nil, key_name: nil, key_version: nil, kms_arn: nil, kms_key_location: nil, kms_key_name: nil, kms_key_ring_name: nil, kms_key_version: nil, kms_project_id: nil, purpose: nil, role_arn: nil, tenant_id: nil, vault_uri: nil, workload_identity_pool_id: nil, workload_identity_project_number: nil, workload_identity_provider_id: nil)
149
+ # @!method initialize(id:, api_project_ids:, created_at:, name:, object:, type:, workspace_id:, audience: nil, external_id: nil, key_name: nil, key_ocid: nil, key_version: nil, key_version_ocid: nil, kms_arn: nil, kms_key_location: nil, kms_key_name: nil, kms_key_ring_name: nil, kms_key_version: nil, kms_project_id: nil, purpose: nil, region: nil, role_arn: nil, tenant_id: nil, vault_ocid: nil, vault_uri: nil, workload_identity_pool_id: nil, workload_identity_project_number: nil, workload_identity_provider_id: nil)
130
150
  # @param id [String]
131
151
  # @param api_project_ids [Array<String>]
132
152
  # @param created_at [Integer]
@@ -137,7 +157,9 @@ module OpenAI
137
157
  # @param audience [String]
138
158
  # @param external_id [String]
139
159
  # @param key_name [String]
160
+ # @param key_ocid [String]
140
161
  # @param key_version [String]
162
+ # @param key_version_ocid [String]
141
163
  # @param kms_arn [String]
142
164
  # @param kms_key_location [String]
143
165
  # @param kms_key_name [String]
@@ -145,8 +167,10 @@ module OpenAI
145
167
  # @param kms_key_version [String]
146
168
  # @param kms_project_id [String]
147
169
  # @param purpose [Symbol, OpenAI::Models::Admin::Organization::ExternalKey::Purpose]
170
+ # @param region [String]
148
171
  # @param role_arn [String]
149
172
  # @param tenant_id [String]
173
+ # @param vault_ocid [String]
150
174
  # @param vault_uri [String]
151
175
  # @param workload_identity_pool_id [String]
152
176
  # @param workload_identity_project_number [String]
@@ -11,11 +11,11 @@ module OpenAI
11
11
 
12
12
  # @!attribute body
13
13
  #
14
- # @return [OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure]
14
+ # @return [OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Oci]
15
15
  required :body, union: -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body }
16
16
 
17
17
  # @!method initialize(body:, request_options: {})
18
- # @param body [OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure]
18
+ # @param body [OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Oci]
19
19
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
20
20
 
21
21
  module Body
@@ -29,6 +29,8 @@ module OpenAI
29
29
 
30
30
  variant :azure, -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Azure }
31
31
 
32
+ variant :oci, -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Oci }
33
+
32
34
  class Aws < OpenAI::Internal::Type::BaseModel
33
35
  # @!attribute external_id
34
36
  # The ExternalID that OpenAI will pass in the AssumeRole call for the customer's
@@ -301,8 +303,81 @@ module OpenAI
301
303
  end
302
304
  end
303
305
 
306
+ class Oci < OpenAI::Internal::Type::BaseModel
307
+ # @!attribute key_ocid
308
+ # The OCI Vault key OCID
309
+ #
310
+ # @return [String]
311
+ required :key_ocid, String
312
+
313
+ # @!attribute name
314
+ # A friendly name to identify this config
315
+ #
316
+ # @return [String]
317
+ required :name, String
318
+
319
+ # @!attribute region
320
+ # The OCI region containing the vault
321
+ #
322
+ # @return [String]
323
+ required :region, String
324
+
325
+ # @!attribute type
326
+ #
327
+ # @return [Symbol, :oci]
328
+ required :type, const: :oci
329
+
330
+ # @!attribute vault_ocid
331
+ # The customer OCI Vault OCID
332
+ #
333
+ # @return [String]
334
+ required :vault_ocid, String
335
+
336
+ # @!attribute key_version_ocid
337
+ # The exact OCI key version OCID for PSP decryption.
338
+ #
339
+ # @return [String, nil]
340
+ optional :key_version_ocid, String
341
+
342
+ # @!attribute purpose
343
+ #
344
+ # @return [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Oci::Purpose, nil]
345
+ optional :purpose, enum: -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Oci::Purpose }
346
+
347
+ # @!method initialize(key_ocid:, name:, region:, vault_ocid:, key_version_ocid: nil, purpose: nil, type: :oci)
348
+ # @param key_ocid [String]
349
+ # The OCI Vault key OCID
350
+ #
351
+ # @param name [String]
352
+ # A friendly name to identify this config
353
+ #
354
+ # @param region [String]
355
+ # The OCI region containing the vault
356
+ #
357
+ # @param vault_ocid [String]
358
+ # The customer OCI Vault OCID
359
+ #
360
+ # @param key_version_ocid [String]
361
+ # The exact OCI key version OCID for PSP decryption.
362
+ #
363
+ # @param purpose [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Oci::Purpose]
364
+ #
365
+ # @param type [Symbol, :oci]
366
+
367
+ # @see OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Oci#purpose
368
+ module Purpose
369
+ extend OpenAI::Internal::Type::Enum
370
+
371
+ EKM = :ekm
372
+ PSP_DECRYPTION = :psp_decryption
373
+
374
+ # @!method self.values
375
+ # @return [Array<Symbol>]
376
+ end
377
+ end
378
+
304
379
  # @!method self.variants
305
- # @return [Array(OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure)]
380
+ # @return [Array(OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Oci)]
306
381
  end
307
382
  end
308
383
  end
@@ -165,7 +165,7 @@ module OpenAI
165
165
  # @see OpenAI::Models::Beta::Agent#compaction
166
166
  class Compaction < OpenAI::Internal::Type::BaseModel
167
167
  # @!attribute async
168
- # Whether context is compacted in the background. Defaults to true.
168
+ # Whether context is compacted in the background. Defaults to false.
169
169
  #
170
170
  # @return [Boolean]
171
171
  required :async, OpenAI::Internal::Type::Boolean
@@ -174,7 +174,7 @@ module OpenAI
174
174
  # The effective context compaction settings.
175
175
  #
176
176
  # @param async [Boolean]
177
- # Whether context is compacted in the background. Defaults to true.
177
+ # Whether context is compacted in the background. Defaults to false.
178
178
  end
179
179
 
180
180
  # @see OpenAI::Models::Beta::Agent#experimental
@@ -15,7 +15,7 @@ module OpenAI
15
15
  required :model, String
16
16
 
17
17
  # @!attribute compaction
18
- # Context compaction settings. Omission or null enables background compaction.
18
+ # Context compaction settings. Omission or null uses blocking compaction.
19
19
  #
20
20
  # @return [OpenAI::Models::Beta::AgentCreateParams::Compaction, nil]
21
21
  optional :compaction, -> { OpenAI::Beta::AgentCreateParams::Compaction }, nil?: true
@@ -88,7 +88,7 @@ module OpenAI
88
88
  # The model to use for the agent. The requested model name is preserved.
89
89
  #
90
90
  # @param compaction [OpenAI::Models::Beta::AgentCreateParams::Compaction, nil]
91
- # Context compaction settings. Omission or null enables background compaction.
91
+ # Context compaction settings. Omission or null uses blocking compaction.
92
92
  #
93
93
  # @param experimental [OpenAI::Models::Beta::AgentCreateParams::Experimental]
94
94
  # Experimental agent settings. All experimental features default to disabled.
@@ -126,20 +126,20 @@ module OpenAI
126
126
 
127
127
  class Compaction < OpenAI::Internal::Type::BaseModel
128
128
  # @!attribute async
129
- # Whether to compact context in the background. Omission or null defaults to true.
130
- # Set to false to use blocking compaction. Background compaction may increase
131
- # token usage.
129
+ # Whether to compact context in the background. Omission or null defaults to
130
+ # false. Set to true to enable background compaction. Background compaction may
131
+ # increase token usage.
132
132
  #
133
133
  # @return [Boolean, nil]
134
134
  optional :async, OpenAI::Internal::Type::Boolean, nil?: true
135
135
 
136
136
  # @!method initialize(async: nil)
137
- # Context compaction settings. Omission or null enables background compaction.
137
+ # Context compaction settings. Omission or null uses blocking compaction.
138
138
  #
139
139
  # @param async [Boolean, nil]
140
- # Whether to compact context in the background. Omission or null defaults to true.
141
- # Set to false to use blocking compaction. Background compaction may increase
142
- # token usage.
140
+ # Whether to compact context in the background. Omission or null defaults to
141
+ # false. Set to true to enable background compaction. Background compaction may
142
+ # increase token usage.
143
143
  end
144
144
 
145
145
  class Experimental < OpenAI::Internal::Type::BaseModel
@@ -46,7 +46,13 @@ module OpenAI
46
46
  # @return [Symbol, :"agent.output.command_execution_output.delta"]
47
47
  required :type, const: :"agent.output.command_execution_output.delta"
48
48
 
49
- # @!method initialize(delta:, event_id:, item_id:, output_index:, session_id:, turn_id:, type: :"agent.output.command_execution_output.delta")
49
+ # @!attribute obfuscation
50
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
51
+ #
52
+ # @return [String, nil]
53
+ optional :obfuscation, String
54
+
55
+ # @!method initialize(delta:, event_id:, item_id:, output_index:, session_id:, turn_id:, obfuscation: nil, type: :"agent.output.command_execution_output.delta")
50
56
  # Emitted when command execution produces an output delta.
51
57
  #
52
58
  # @param delta [String]
@@ -67,6 +73,9 @@ module OpenAI
67
73
  # @param turn_id [String, nil]
68
74
  # The ID of the turn associated with the event, when applicable.
69
75
  #
76
+ # @param obfuscation [String]
77
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
78
+ #
70
79
  # @param type [Symbol, :"agent.output.command_execution_output.delta"]
71
80
  # The type of the object. Always `agent.output.command_execution_output.delta`.
72
81
  end
@@ -55,7 +55,7 @@ module OpenAI
55
55
  # @!attribute required_actions
56
56
  # Actions that must be completed before the session can continue.
57
57
  #
58
- # @return [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>]
58
+ # @return [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::McpApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>]
59
59
  required(
60
60
  :required_actions,
61
61
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentSession::RequiredAction] }
@@ -80,6 +80,12 @@ module OpenAI
80
80
  # @return [Array<String>]
81
81
  required :vault_ids, OpenAI::Internal::Type::ArrayOf[String]
82
82
 
83
+ # @!attribute prompt_cache_options
84
+ # Default prompt cache lifetime for turns in this session, when configured.
85
+ #
86
+ # @return [OpenAI::Models::Beta::AgentSession::PromptCacheOptions, nil]
87
+ optional :prompt_cache_options, -> { OpenAI::Beta::AgentSession::PromptCacheOptions }, nil?: true
88
+
83
89
  # @!attribute review
84
90
  # Review applied to eligible actions in this session. Omitted when review is none
85
91
  # and automatic review is not enabled. Omission means none.
@@ -94,7 +100,7 @@ module OpenAI
94
100
  # @return [OpenAI::Models::Beta::AgentSession::SpendControl, nil]
95
101
  optional :spend_control, -> { OpenAI::Beta::AgentSession::SpendControl }
96
102
 
97
- # @!method initialize(id:, agent:, created_at:, environment:, error:, last_active_at:, metadata:, required_actions:, status:, usage:, vault_ids:, review: nil, spend_control: nil, object: :"agent.session")
103
+ # @!method initialize(id:, agent:, created_at:, environment:, error:, last_active_at:, metadata:, required_actions:, status:, usage:, vault_ids:, prompt_cache_options: nil, review: nil, spend_control: nil, object: :"agent.session")
98
104
  # A Managed Agents session.
99
105
  #
100
106
  # @param id [String]
@@ -118,7 +124,7 @@ module OpenAI
118
124
  # @param metadata [Hash{Symbol=>String}]
119
125
  # Custom string key-value pairs attached to the session.
120
126
  #
121
- # @param required_actions [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>]
127
+ # @param required_actions [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::McpApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>]
122
128
  # Actions that must be completed before the session can continue.
123
129
  #
124
130
  # @param status [Symbol, OpenAI::Models::Beta::AgentSession::Status]
@@ -131,6 +137,9 @@ module OpenAI
131
137
  # @param vault_ids [Array<String>]
132
138
  # The IDs of vaults made available to the session.
133
139
  #
140
+ # @param prompt_cache_options [OpenAI::Models::Beta::AgentSession::PromptCacheOptions, nil]
141
+ # Default prompt cache lifetime for turns in this session, when configured.
142
+ #
134
143
  # @param review [Symbol, OpenAI::Models::Beta::AgentSession::Review]
135
144
  # Review applied to eligible actions in this session. Omitted when review is none
136
145
  # and automatic review is not enabled. Omission means none.
@@ -268,7 +277,7 @@ module OpenAI
268
277
  # @see OpenAI::Models::Beta::AgentSession::Agent#compaction
269
278
  class Compaction < OpenAI::Internal::Type::BaseModel
270
279
  # @!attribute async
271
- # Whether context is compacted in the background. Defaults to true.
280
+ # Whether context is compacted in the background. Defaults to false.
272
281
  #
273
282
  # @return [Boolean]
274
283
  required :async, OpenAI::Internal::Type::Boolean
@@ -277,7 +286,7 @@ module OpenAI
277
286
  # The effective context compaction settings.
278
287
  #
279
288
  # @param async [Boolean]
280
- # Whether context is compacted in the background. Defaults to true.
289
+ # Whether context is compacted in the background. Defaults to false.
281
290
  end
282
291
 
283
292
  # @see OpenAI::Models::Beta::AgentSession::Agent#experimental
@@ -302,6 +311,9 @@ module OpenAI
302
311
 
303
312
  discriminator :type
304
313
 
314
+ # Respond to an MCP tool-call approval request.
315
+ variant :mcp_approval_request, -> { OpenAI::Beta::AgentSession::RequiredAction::McpApprovalRequest }
316
+
305
317
  # Respond to a computer-use request.
306
318
  variant(
307
319
  :computer_use_approval_request,
@@ -314,6 +326,94 @@ module OpenAI
314
326
  # Reconnect a session environment.
315
327
  variant :environment_connection, -> { OpenAI::Beta::AgentSession::RequiredAction::EnvironmentConnection }
316
328
 
329
+ class McpApprovalRequest < OpenAI::Internal::Type::BaseModel
330
+ # @!attribute request
331
+ # Information for presenting an MCP approval.
332
+ #
333
+ # @return [OpenAI::Models::Beta::AgentSession::RequiredAction::McpApprovalRequest::Request]
334
+ required :request, -> { OpenAI::Beta::AgentSession::RequiredAction::McpApprovalRequest::Request }
335
+
336
+ # @!attribute request_id
337
+ # The opaque approval ID to echo when responding.
338
+ #
339
+ # @return [String]
340
+ required :request_id, String
341
+
342
+ # @!attribute turn_id
343
+ # The turn that requested approval.
344
+ #
345
+ # @return [String]
346
+ required :turn_id, String
347
+
348
+ # @!attribute type
349
+ # The type of the object. Always `mcp_approval_request`.
350
+ #
351
+ # @return [Symbol, :mcp_approval_request]
352
+ required :type, const: :mcp_approval_request
353
+
354
+ # @!method initialize(request:, request_id:, turn_id:, type: :mcp_approval_request)
355
+ # Respond to an MCP tool-call approval request.
356
+ #
357
+ # @param request [OpenAI::Models::Beta::AgentSession::RequiredAction::McpApprovalRequest::Request]
358
+ # Information for presenting an MCP approval.
359
+ #
360
+ # @param request_id [String]
361
+ # The opaque approval ID to echo when responding.
362
+ #
363
+ # @param turn_id [String]
364
+ # The turn that requested approval.
365
+ #
366
+ # @param type [Symbol, :mcp_approval_request]
367
+ # The type of the object. Always `mcp_approval_request`.
368
+
369
+ # @see OpenAI::Models::Beta::AgentSession::RequiredAction::McpApprovalRequest#request
370
+ class Request < OpenAI::Internal::Type::BaseModel
371
+ # @!attribute arguments
372
+ # The tool arguments as JSON, or null when CCA does not provide them.
373
+ #
374
+ # @return [Object]
375
+ required :arguments, OpenAI::Internal::Type::Unknown
376
+
377
+ # @!attribute message
378
+ #
379
+ # @return [String]
380
+ required :message, String
381
+
382
+ # @!attribute name
383
+ # The tool name, or null when CCA does not provide it.
384
+ #
385
+ # @return [String, nil]
386
+ required :name, String, nil?: true
387
+
388
+ # @!attribute server_label
389
+ #
390
+ # @return [String]
391
+ required :server_label, String
392
+
393
+ # @!attribute type
394
+ # The type of the object. Always `mcp_tool_call`.
395
+ #
396
+ # @return [Symbol, :mcp_tool_call]
397
+ required :type, const: :mcp_tool_call
398
+
399
+ # @!method initialize(arguments:, message:, name:, server_label:, type: :mcp_tool_call)
400
+ # Information for presenting an MCP approval.
401
+ #
402
+ # @param arguments [Object]
403
+ # The tool arguments as JSON, or null when CCA does not provide them.
404
+ #
405
+ # @param message [String]
406
+ #
407
+ # @param name [String, nil]
408
+ # The tool name, or null when CCA does not provide it.
409
+ #
410
+ # @param server_label [String]
411
+ #
412
+ # @param type [Symbol, :mcp_tool_call]
413
+ # The type of the object. Always `mcp_tool_call`.
414
+ end
415
+ end
416
+
317
417
  class ComputerUseApprovalRequest < OpenAI::Internal::Type::BaseModel
318
418
  # @!attribute request
319
419
  # The information needed to render the request.
@@ -628,7 +728,7 @@ module OpenAI
628
728
  end
629
729
 
630
730
  # @!method self.variants
631
- # @return [Array(OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection)]
731
+ # @return [Array(OpenAI::Models::Beta::AgentSession::RequiredAction::McpApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection)]
632
732
  end
633
733
 
634
734
  # The current status of the session.
@@ -653,6 +753,30 @@ module OpenAI
653
753
  # @return [Array<Symbol>]
654
754
  end
655
755
 
756
+ # @see OpenAI::Models::Beta::AgentSession#prompt_cache_options
757
+ class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
758
+ # @!attribute ttl
759
+ #
760
+ # @return [Symbol, OpenAI::Models::Beta::AgentSession::PromptCacheOptions::Ttl]
761
+ required :ttl, enum: -> { OpenAI::Beta::AgentSession::PromptCacheOptions::Ttl }
762
+
763
+ # @!method initialize(ttl:)
764
+ # Default prompt cache lifetime for turns in this session, when configured.
765
+ #
766
+ # @param ttl [Symbol, OpenAI::Models::Beta::AgentSession::PromptCacheOptions::Ttl]
767
+
768
+ # @see OpenAI::Models::Beta::AgentSession::PromptCacheOptions#ttl
769
+ module Ttl
770
+ extend OpenAI::Internal::Type::Enum
771
+
772
+ TTL_30M = :"30m"
773
+ TTL_12H = :"12h"
774
+
775
+ # @!method self.values
776
+ # @return [Array<Symbol>]
777
+ end
778
+ end
779
+
656
780
  # Review applied to eligible actions in this session. Omitted when review is none
657
781
  # and automatic review is not enabled. Omission means none.
658
782
  #
@@ -22,7 +22,13 @@ module OpenAI
22
22
  # @return [Symbol, :"agent.session.created"]
23
23
  required :type, const: :"agent.session.created"
24
24
 
25
- # @!method initialize(event_id:, session:, type: :"agent.session.created")
25
+ # @!attribute obfuscation
26
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
27
+ #
28
+ # @return [String, nil]
29
+ optional :obfuscation, String
30
+
31
+ # @!method initialize(event_id:, session:, obfuscation: nil, type: :"agent.session.created")
26
32
  # Emitted when a session is created.
27
33
  #
28
34
  # @param event_id [String]
@@ -31,6 +37,9 @@ module OpenAI
31
37
  # @param session [OpenAI::Models::Beta::AgentSession]
32
38
  # The session that was created.
33
39
  #
40
+ # @param obfuscation [String]
41
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
42
+ #
34
43
  # @param type [Symbol, :"agent.session.created"]
35
44
  # The type of the object. Always `agent.session.created`.
36
45
  end