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
@@ -28,6 +28,17 @@ module OpenAI
28
28
  # @return [Hash{Symbol=>String}, nil]
29
29
  optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
30
30
 
31
+ # @!attribute prompt_cache_options
32
+ # Default prompt cache lifetime for future turns. Send null to clear the session
33
+ # default.
34
+ #
35
+ # @return [OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions, nil]
36
+ optional(
37
+ :prompt_cache_options,
38
+ -> { OpenAI::Beta::Agents::SessionUpdateParams::PromptCacheOptions },
39
+ nil?: true
40
+ )
41
+
31
42
  # @!attribute review
32
43
  # Default action review for new root turns. Existing turns and their subagents
33
44
  # keep their review mode.
@@ -48,7 +59,7 @@ module OpenAI
48
59
  nil?: true
49
60
  )
50
61
 
51
- # @!method initialize(session_id:, agent: nil, metadata: nil, review: nil, spend_control: nil, request_options: {})
62
+ # @!method initialize(session_id:, agent: nil, metadata: nil, prompt_cache_options: nil, review: nil, spend_control: nil, request_options: {})
52
63
  # @param session_id [String]
53
64
  #
54
65
  # @param agent [OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent]
@@ -59,6 +70,10 @@ module OpenAI
59
70
  # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
60
71
  # characters.
61
72
  #
73
+ # @param prompt_cache_options [OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions, nil]
74
+ # Default prompt cache lifetime for future turns. Send null to clear the session
75
+ # default.
76
+ #
62
77
  # @param review [Symbol, OpenAI::Models::Beta::Agents::SessionUpdateParams::Review]
63
78
  # Default action review for new root turns. Existing turns and their subagents
64
79
  # keep their review mode.
@@ -189,6 +204,34 @@ module OpenAI
189
204
  end
190
205
  end
191
206
 
207
+ class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
208
+ # @!attribute ttl
209
+ # Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
210
+ #
211
+ # @return [Symbol, OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::Ttl, nil]
212
+ optional :ttl, enum: -> { OpenAI::Beta::Agents::SessionUpdateParams::PromptCacheOptions::Ttl }
213
+
214
+ # @!method initialize(ttl: nil)
215
+ # Default prompt cache lifetime for future turns. Send null to clear the session
216
+ # default.
217
+ #
218
+ # @param ttl [Symbol, OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::Ttl]
219
+ # Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
220
+
221
+ # Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
222
+ #
223
+ # @see OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions#ttl
224
+ module Ttl
225
+ extend OpenAI::Internal::Type::Enum
226
+
227
+ TTL_30M = :"30m"
228
+ TTL_12H = :"12h"
229
+
230
+ # @!method self.values
231
+ # @return [Array<Symbol>]
232
+ end
233
+ end
234
+
192
235
  # Default action review for new root turns. Existing turns and their subagents
193
236
  # keep their review mode.
194
237
  module Review
@@ -18,7 +18,7 @@ module OpenAI
18
18
  # @!attribute events
19
19
  # The input events to submit to the session.
20
20
  #
21
- # @return [Array<OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputComputerUseApprovalRequestResult, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMessage, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputCancel, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputToolResult>]
21
+ # @return [Array<OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMcpApprovalRequestResult, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputComputerUseApprovalRequestResult, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMessage, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputCancel, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputToolResult>]
22
22
  required :events, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentSessionInputParam] }
23
23
 
24
24
  # @!attribute idempotency_key
@@ -29,7 +29,7 @@ module OpenAI
29
29
  # @!method initialize(session_id:, events:, idempotency_key: nil, request_options: {})
30
30
  # @param session_id [String]
31
31
  #
32
- # @param events [Array<OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputComputerUseApprovalRequestResult, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMessage, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputCancel, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputToolResult>]
32
+ # @param events [Array<OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMcpApprovalRequestResult, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputComputerUseApprovalRequestResult, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMessage, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputCancel, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputToolResult>]
33
33
  # The input events to submit to the session.
34
34
  #
35
35
  # @param idempotency_key [String]
@@ -15,8 +15,20 @@ module OpenAI
15
15
  # @return [String]
16
16
  required :session_id, String
17
17
 
18
- # @!method initialize(session_id:, request_options: {})
18
+ # @!attribute include_obfuscation
19
+ # Whether to include obfuscation padding in events on this connection. Defaults to
20
+ # `true`.
21
+ #
22
+ # @return [Boolean, nil]
23
+ optional :include_obfuscation, OpenAI::Internal::Type::Boolean
24
+
25
+ # @!method initialize(session_id:, include_obfuscation: nil, request_options: {})
19
26
  # @param session_id [String]
27
+ #
28
+ # @param include_obfuscation [Boolean]
29
+ # Whether to include obfuscation padding in events on this connection. Defaults to
30
+ # `true`.
31
+ #
20
32
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
21
33
  end
22
34
  end
@@ -76,7 +76,18 @@ module OpenAI
76
76
  # @return [OpenAI::Models::Beta::TokenUsage, nil]
77
77
  required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
78
78
 
79
- # @!method initialize(id:, agent_id:, completed_at:, created_at:, error:, session_id:, started_at:, status:, subagent_id:, usage:, object: :"agent.session.turn")
79
+ # @!attribute prompt_cache_options
80
+ # Prompt cache lifetime selected when this turn started, including an inherited
81
+ # session TTL. Null when the turn used the model default or no TTL was recorded.
82
+ #
83
+ # @return [OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions, nil]
84
+ optional(
85
+ :prompt_cache_options,
86
+ -> { OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions },
87
+ nil?: true
88
+ )
89
+
90
+ # @!method initialize(id:, agent_id:, completed_at:, created_at:, error:, session_id:, started_at:, status:, subagent_id:, usage:, prompt_cache_options: nil, object: :"agent.session.turn")
80
91
  # The canonical public representation of a session turn.
81
92
  #
82
93
  # @param id [String]
@@ -112,6 +123,10 @@ module OpenAI
112
123
  # Best-effort token usage for the turn, or null if unknown. Recorded usage may
113
124
  # change.
114
125
  #
126
+ # @param prompt_cache_options [OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions, nil]
127
+ # Prompt cache lifetime selected when this turn started, including an inherited
128
+ # session TTL. Null when the turn used the model default or no TTL was recorded.
129
+ #
115
130
  # @param object [Symbol, :"agent.session.turn"]
116
131
  # The object type. Always `agent.session.turn`.
117
132
 
@@ -142,6 +157,31 @@ module OpenAI
142
157
  # @!method self.values
143
158
  # @return [Array<Symbol>]
144
159
  end
160
+
161
+ # @see OpenAI::Models::Beta::Agents::Sessions::Turn#prompt_cache_options
162
+ class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
163
+ # @!attribute ttl
164
+ #
165
+ # @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl]
166
+ required :ttl, enum: -> { OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl }
167
+
168
+ # @!method initialize(ttl:)
169
+ # Prompt cache lifetime selected when this turn started, including an inherited
170
+ # session TTL. Null when the turn used the model default or no TTL was recorded.
171
+ #
172
+ # @param ttl [Symbol, OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl]
173
+
174
+ # @see OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions#ttl
175
+ module Ttl
176
+ extend OpenAI::Internal::Type::Enum
177
+
178
+ TTL_30M = :"30m"
179
+ TTL_12H = :"12h"
180
+
181
+ # @!method self.values
182
+ # @return [Array<Symbol>]
183
+ end
184
+ end
145
185
  end
146
186
  end
147
187
  end
@@ -363,7 +363,9 @@ module OpenAI
363
363
  #
364
364
  # - `auto`: If the input to this Response exceeds the model's context window size,
365
365
  # the model will truncate the response to fit the context window by dropping
366
- # items from the beginning of the conversation.
366
+ # items from the beginning of the conversation. On some models, trimming can
367
+ # begin earlier because the API subtracts the model's maximum output allowance
368
+ # from its input limit, even if you set a lower `max_output_tokens`.
367
369
  # - `disabled` (default): If the input size will exceed the context window size
368
370
  # for a model, the request will fail with a 400 error.
369
371
  #
@@ -626,7 +628,9 @@ module OpenAI
626
628
  #
627
629
  # - `auto`: If the input to this Response exceeds the model's context window size,
628
630
  # the model will truncate the response to fit the context window by dropping
629
- # items from the beginning of the conversation.
631
+ # items from the beginning of the conversation. On some models, trimming can
632
+ # begin earlier because the API subtracts the model's maximum output allowance
633
+ # from its input limit, even if you set a lower `max_output_tokens`.
630
634
  # - `disabled` (default): If the input size will exceed the context window size
631
635
  # for a model, the request will fail with a 400 error.
632
636
  #
@@ -2431,7 +2435,9 @@ module OpenAI
2431
2435
  #
2432
2436
  # - `auto`: If the input to this Response exceeds the model's context window size,
2433
2437
  # the model will truncate the response to fit the context window by dropping
2434
- # items from the beginning of the conversation.
2438
+ # items from the beginning of the conversation. On some models, trimming can
2439
+ # begin earlier because the API subtracts the model's maximum output allowance
2440
+ # from its input limit, even if you set a lower `max_output_tokens`.
2435
2441
  # - `disabled` (default): If the input size will exceed the context window size
2436
2442
  # for a model, the request will fail with a 400 error.
2437
2443
  #
@@ -811,7 +811,8 @@ module OpenAI
811
811
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
812
812
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
813
813
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
814
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
814
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
815
+ # `gpt-image-2.6-sunburst`.
815
816
  #
816
817
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
817
818
  # `gpt-image-2.5-flare` instead.
@@ -943,7 +944,8 @@ module OpenAI
943
944
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
944
945
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
945
946
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
946
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
947
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
948
+ # `gpt-image-2.6-sunburst`.
947
949
  #
948
950
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
949
951
  # `gpt-image-2.5-flare` instead.
@@ -1092,7 +1094,8 @@ module OpenAI
1092
1094
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
1093
1095
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
1094
1096
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
1095
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
1097
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
1098
+ # `gpt-image-2.6-sunburst`.
1096
1099
  #
1097
1100
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
1098
1101
  # `gpt-image-2.5-flare` instead.
@@ -473,7 +473,9 @@ module OpenAI
473
473
  #
474
474
  # - `auto`: If the input to this Response exceeds the model's context window size,
475
475
  # the model will truncate the response to fit the context window by dropping
476
- # items from the beginning of the conversation.
476
+ # items from the beginning of the conversation. On some models, trimming can
477
+ # begin earlier because the API subtracts the model's maximum output allowance
478
+ # from its input limit, even if you set a lower `max_output_tokens`.
477
479
  # - `disabled` (default): If the input size will exceed the context window size
478
480
  # for a model, the request will fail with a 400 error.
479
481
  #
@@ -770,7 +772,9 @@ module OpenAI
770
772
  #
771
773
  # - `auto`: If the input to this Response exceeds the model's context window size,
772
774
  # the model will truncate the response to fit the context window by dropping
773
- # items from the beginning of the conversation.
775
+ # items from the beginning of the conversation. On some models, trimming can
776
+ # begin earlier because the API subtracts the model's maximum output allowance
777
+ # from its input limit, even if you set a lower `max_output_tokens`.
774
778
  # - `disabled` (default): If the input size will exceed the context window size
775
779
  # for a model, the request will fail with a 400 error.
776
780
  #
@@ -2409,7 +2413,9 @@ module OpenAI
2409
2413
  #
2410
2414
  # - `auto`: If the input to this Response exceeds the model's context window size,
2411
2415
  # the model will truncate the response to fit the context window by dropping
2412
- # items from the beginning of the conversation.
2416
+ # items from the beginning of the conversation. On some models, trimming can
2417
+ # begin earlier because the API subtracts the model's maximum output allowance
2418
+ # from its input limit, even if you set a lower `max_output_tokens`.
2413
2419
  # - `disabled` (default): If the input size will exceed the context window size
2414
2420
  # for a model, the request will fail with a 400 error.
2415
2421
  #
@@ -681,7 +681,8 @@ module OpenAI
681
681
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
682
682
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
683
683
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
684
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
684
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
685
+ # `gpt-image-2.6-sunburst`.
685
686
  #
686
687
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
687
688
  # `gpt-image-2.5-flare` instead.
@@ -798,7 +799,8 @@ module OpenAI
798
799
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
799
800
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
800
801
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
801
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
802
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
803
+ # `gpt-image-2.6-sunburst`.
802
804
  #
803
805
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
804
806
  # `gpt-image-2.5-flare` instead.
@@ -947,7 +949,8 @@ module OpenAI
947
949
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
948
950
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
949
951
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
950
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
952
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
953
+ # `gpt-image-2.6-sunburst`.
951
954
  #
952
955
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
953
956
  # `gpt-image-2.5-flare` instead.
@@ -31,6 +31,8 @@ module OpenAI
31
31
  optional :input, union: -> { OpenAI::Beta::ResponseCompactParams::Input }, nil?: true
32
32
 
33
33
  # @!attribute instructions
34
+ # @deprecated
35
+ #
34
36
  # A system (or developer) message inserted into the model's context. When used
35
37
  # along with `previous_response_id`, the instructions from a previous response
36
38
  # will not be carried over to the next response. This makes it simple to swap out
@@ -364,7 +364,9 @@ module OpenAI
364
364
  #
365
365
  # - `auto`: If the input to this Response exceeds the model's context window size,
366
366
  # the model will truncate the response to fit the context window by dropping
367
- # items from the beginning of the conversation.
367
+ # items from the beginning of the conversation. On some models, trimming can
368
+ # begin earlier because the API subtracts the model's maximum output allowance
369
+ # from its input limit, even if you set a lower `max_output_tokens`.
368
370
  # - `disabled` (default): If the input size will exceed the context window size
369
371
  # for a model, the request will fail with a 400 error.
370
372
  #
@@ -632,7 +634,9 @@ module OpenAI
632
634
  #
633
635
  # - `auto`: If the input to this Response exceeds the model's context window size,
634
636
  # the model will truncate the response to fit the context window by dropping
635
- # items from the beginning of the conversation.
637
+ # items from the beginning of the conversation. On some models, trimming can
638
+ # begin earlier because the API subtracts the model's maximum output allowance
639
+ # from its input limit, even if you set a lower `max_output_tokens`.
636
640
  # - `disabled` (default): If the input size will exceed the context window size
637
641
  # for a model, the request will fail with a 400 error.
638
642
  #
@@ -2019,7 +2023,9 @@ module OpenAI
2019
2023
  #
2020
2024
  # - `auto`: If the input to this Response exceeds the model's context window size,
2021
2025
  # the model will truncate the response to fit the context window by dropping
2022
- # items from the beginning of the conversation.
2026
+ # items from the beginning of the conversation. On some models, trimming can
2027
+ # begin earlier because the API subtracts the model's maximum output allowance
2028
+ # from its input limit, even if you set a lower `max_output_tokens`.
2023
2029
  # - `disabled` (default): If the input size will exceed the context window size
2024
2030
  # for a model, the request will fail with a 400 error.
2025
2031
  module Truncation
@@ -107,11 +107,15 @@ module OpenAI
107
107
  # @!attribute truncation
108
108
  # @deprecated
109
109
  #
110
- # The truncation strategy to use for the model response. - `auto`: If the input to
111
- # this Response exceeds the model's context window size, the model will truncate
112
- # the response to fit the context window by dropping items from the beginning of
113
- # the conversation. - `disabled` (default): If the input size will exceed the
114
- # context window size for a model, the request will fail with a 400 error.
110
+ # The truncation strategy to use for the model response.
111
+ #
112
+ # - `auto`: If the input to this Response exceeds the model's context window size,
113
+ # the model will truncate the response to fit the context window by dropping
114
+ # items from the beginning of the conversation. On some models, trimming can
115
+ # begin earlier because the API subtracts the model's maximum output allowance
116
+ # from its input limit before counting tokens.
117
+ # - `disabled` (default): If the input size will exceed the context window size
118
+ # for a model, the request will fail with a 400 error.
115
119
  #
116
120
  # @return [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Truncation, nil]
117
121
  optional :truncation, enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Truncation }
@@ -180,11 +184,15 @@ module OpenAI
180
184
  # specify which tool to use by setting the `tool_choice` parameter.
181
185
  #
182
186
  # @param truncation [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Truncation]
183
- # The truncation strategy to use for the model response. - `auto`: If the input to
184
- # this Response exceeds the model's context window size, the model will truncate
185
- # the response to fit the context window by dropping items from the beginning of
186
- # the conversation. - `disabled` (default): If the input size will exceed the
187
- # context window size for a model, the request will fail with a 400 error.
187
+ # The truncation strategy to use for the model response.
188
+ #
189
+ # - `auto`: If the input to this Response exceeds the model's context window size,
190
+ # the model will truncate the response to fit the context window by dropping
191
+ # items from the beginning of the conversation. On some models, trimming can
192
+ # begin earlier because the API subtracts the model's maximum output allowance
193
+ # from its input limit before counting tokens.
194
+ # - `disabled` (default): If the input size will exceed the context window size
195
+ # for a model, the request will fail with a 400 error.
188
196
  #
189
197
  # @param betas [Array<Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Beta>]
190
198
  #
@@ -614,11 +622,15 @@ module OpenAI
614
622
 
615
623
  # @deprecated
616
624
  #
617
- # The truncation strategy to use for the model response. - `auto`: If the input to
618
- # this Response exceeds the model's context window size, the model will truncate
619
- # the response to fit the context window by dropping items from the beginning of
620
- # the conversation. - `disabled` (default): If the input size will exceed the
621
- # context window size for a model, the request will fail with a 400 error.
625
+ # The truncation strategy to use for the model response.
626
+ #
627
+ # - `auto`: If the input to this Response exceeds the model's context window size,
628
+ # the model will truncate the response to fit the context window by dropping
629
+ # items from the beginning of the conversation. On some models, trimming can
630
+ # begin earlier because the API subtracts the model's maximum output allowance
631
+ # from its input limit before counting tokens.
632
+ # - `disabled` (default): If the input size will exceed the context window size
633
+ # for a model, the request will fail with a 400 error.
622
634
  module Truncation
623
635
  extend OpenAI::Internal::Type::Enum
624
636
 
@@ -9,6 +9,7 @@ module OpenAI
9
9
 
10
10
  # @!attribute file
11
11
  # The image or audio file to check for supported OpenAI provenance signals.
12
+ # Supported image formats are PNG, JPEG, WebP, and GIF (including animated GIFs).
12
13
  #
13
14
  # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
14
15
  # metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -20,6 +21,7 @@ module OpenAI
20
21
  # @!method initialize(file:, request_options: {})
21
22
  # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart]
22
23
  # The image or audio file to check for supported OpenAI provenance signals.
24
+ # Supported image formats are PNG, JPEG, WebP, and GIF (including animated GIFs).
23
25
  #
24
26
  # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
25
27
  # metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -136,7 +136,8 @@ module OpenAI
136
136
 
137
137
  # @!attribute output_format
138
138
  # The format in which the generated images are returned. This parameter is only
139
- # supported for the GPT image models. The default value is `png`.
139
+ # supported for the GPT image models. The default value is `png`. SVG output
140
+ # requires a supported image model and project access.
140
141
  #
141
142
  # @return [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil]
142
143
  optional :output_format, enum: -> { OpenAI::ImageEditParams::OutputFormat }, nil?: true
@@ -197,6 +198,15 @@ module OpenAI
197
198
  # @return [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil]
198
199
  optional :size, union: -> { OpenAI::ImageEditParams::Size }, nil?: true
199
200
 
201
+ # @!attribute svg
202
+ # Selects the author model and reasoning effort for `output_format=svg`. Supply
203
+ # `svg.model` when SVG model selection is enabled. Otherwise, omit this object.
204
+ # SVG output requires `n=1` and cannot use streaming, partial images, or output
205
+ # compression. Use multipart fields such as `svg[model]`.
206
+ #
207
+ # @return [OpenAI::Models::ImageEditParams::Svg, nil]
208
+ optional :svg, -> { OpenAI::ImageEditParams::Svg }, nil?: true
209
+
200
210
  # @!attribute user
201
211
  # @deprecated
202
212
  #
@@ -208,7 +218,7 @@ module OpenAI
208
218
  # @return [String, nil]
209
219
  optional :user, String
210
220
 
211
- # @!method initialize(image:, prompt:, background: nil, complexity: nil, frame_count: nil, frame_duration_ms: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
221
+ # @!method initialize(image:, prompt:, background: nil, complexity: nil, frame_count: nil, frame_duration_ms: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, svg: nil, user: nil, request_options: {})
212
222
  # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
213
223
  # The image(s) to edit. Must be a supported image file or an array of images.
214
224
  #
@@ -300,7 +310,8 @@ module OpenAI
300
310
  #
301
311
  # @param output_format [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil]
302
312
  # The format in which the generated images are returned. This parameter is only
303
- # supported for the GPT image models. The default value is `png`.
313
+ # supported for the GPT image models. The default value is `png`. SVG output
314
+ # requires a supported image model and project access.
304
315
  #
305
316
  # @param partial_images [Integer, nil]
306
317
  # The number of partial images to generate. This parameter is used for streaming
@@ -341,6 +352,12 @@ module OpenAI
341
352
  # `1024x1536` are supported by the GPT image models; `auto` is supported for
342
353
  # models that allow automatic sizing.
343
354
  #
355
+ # @param svg [OpenAI::Models::ImageEditParams::Svg, nil]
356
+ # Selects the author model and reasoning effort for `output_format=svg`. Supply
357
+ # `svg.model` when SVG model selection is enabled. Otherwise, omit this object.
358
+ # SVG output requires `n=1` and cannot use streaming, partial images, or output
359
+ # compression. Use multipart fields such as `svg[model]`.
360
+ #
344
361
  # @param user [String]
345
362
  # Deprecated: use `safety_identifier` instead. This parameter remains accepted for
346
363
  # backward compatibility and is used when `safety_identifier` is omitted, null, or
@@ -448,14 +465,16 @@ module OpenAI
448
465
  end
449
466
 
450
467
  # The format in which the generated images are returned. This parameter is only
451
- # supported for the GPT image models. The default value is `png`.
468
+ # supported for the GPT image models. The default value is `png`. SVG output
469
+ # requires a supported image model and project access.
452
470
  module OutputFormat
453
471
  extend OpenAI::Internal::Type::Enum
454
472
 
455
473
  PNG = :png
456
- JPEG = :jpeg
457
474
  WEBP = :webp
475
+ JPEG = :jpeg
458
476
  GIF = :gif
477
+ SVG = :svg
459
478
 
460
479
  # @!method self.values
461
480
  # @return [Array<Symbol>]
@@ -546,6 +565,66 @@ module OpenAI
546
565
 
547
566
  # @!endgroup
548
567
  end
568
+
569
+ class Svg < OpenAI::Internal::Type::BaseModel
570
+ # @!attribute model
571
+ #
572
+ # @return [String, nil]
573
+ optional :model, String
574
+
575
+ # @!attribute reasoning
576
+ # Reasoning effort for SVG authoring. When omitted, uses the author model's
577
+ # default in both Images and Responses.
578
+ #
579
+ # @return [OpenAI::Models::ImageEditParams::Svg::Reasoning, nil]
580
+ optional :reasoning, -> { OpenAI::ImageEditParams::Svg::Reasoning }, nil?: true
581
+
582
+ # @!method initialize(model: nil, reasoning: nil)
583
+ # Selects the author model and reasoning effort for `output_format=svg`. Supply
584
+ # `svg.model` when SVG model selection is enabled. Otherwise, omit this object.
585
+ # SVG output requires `n=1` and cannot use streaming, partial images, or output
586
+ # compression. Use multipart fields such as `svg[model]`.
587
+ #
588
+ # @param model [String]
589
+ #
590
+ # @param reasoning [OpenAI::Models::ImageEditParams::Svg::Reasoning, nil]
591
+ # Reasoning effort for SVG authoring. When omitted, uses the author model's
592
+ # default in both Images and Responses.
593
+
594
+ # @see OpenAI::Models::ImageEditParams::Svg#reasoning
595
+ class Reasoning < OpenAI::Internal::Type::BaseModel
596
+ # @!attribute effort
597
+ # Controls how much effort the model should spend on reasoning for this request.
598
+ #
599
+ # @return [Symbol, OpenAI::Models::ImageEditParams::Svg::Reasoning::Effort, nil]
600
+ optional :effort, enum: -> { OpenAI::ImageEditParams::Svg::Reasoning::Effort }
601
+
602
+ # @!method initialize(effort: nil)
603
+ # Reasoning effort for SVG authoring. When omitted, uses the author model's
604
+ # default in both Images and Responses.
605
+ #
606
+ # @param effort [Symbol, OpenAI::Models::ImageEditParams::Svg::Reasoning::Effort]
607
+ # Controls how much effort the model should spend on reasoning for this request.
608
+
609
+ # Controls how much effort the model should spend on reasoning for this request.
610
+ #
611
+ # @see OpenAI::Models::ImageEditParams::Svg::Reasoning#effort
612
+ module Effort
613
+ extend OpenAI::Internal::Type::Enum
614
+
615
+ NONE = :none
616
+ MINIMAL = :minimal
617
+ LOW = :low
618
+ MEDIUM = :medium
619
+ HIGH = :high
620
+ XHIGH = :xhigh
621
+ MAX = :max
622
+
623
+ # @!method self.values
624
+ # @return [Array<Symbol>]
625
+ end
626
+ end
627
+ end
549
628
  end
550
629
  end
551
630
  end
@@ -172,7 +172,7 @@ module OpenAI
172
172
  # enabled, supply svg.model. When model selection is disabled, omit this object.
173
173
  # The top-level model selects the image model that creates the reference image.
174
174
  # SVG generation requires n=1 and does not support streaming, partial images,
175
- # prompt_rewriter, or output_compression. SVG edits are not supported.
175
+ # prompt_rewriter, or output_compression.
176
176
  #
177
177
  # @return [OpenAI::Models::ImageGenerateParams::Svg, nil]
178
178
  optional :svg, -> { OpenAI::ImageGenerateParams::Svg }, nil?: true
@@ -300,7 +300,7 @@ module OpenAI
300
300
  # enabled, supply svg.model. When model selection is disabled, omit this object.
301
301
  # The top-level model selects the image model that creates the reference image.
302
302
  # SVG generation requires n=1 and does not support streaming, partial images,
303
- # prompt_rewriter, or output_compression. SVG edits are not supported.
303
+ # prompt_rewriter, or output_compression.
304
304
  #
305
305
  # @param user [String]
306
306
  # Deprecated: use `safety_identifier` instead. This parameter remains accepted for
@@ -392,8 +392,8 @@ module OpenAI
392
392
  extend OpenAI::Internal::Type::Enum
393
393
 
394
394
  PNG = :png
395
- JPEG = :jpeg
396
395
  WEBP = :webp
396
+ JPEG = :jpeg
397
397
  GIF = :gif
398
398
  SVG = :svg
399
399
 
@@ -537,7 +537,7 @@ module OpenAI
537
537
  # enabled, supply svg.model. When model selection is disabled, omit this object.
538
538
  # The top-level model selects the image model that creates the reference image.
539
539
  # SVG generation requires n=1 and does not support streaming, partial images,
540
- # prompt_rewriter, or output_compression. SVG edits are not supported.
540
+ # prompt_rewriter, or output_compression.
541
541
  #
542
542
  # @param model [String]
543
543
  # Model used to author the SVG. Required when SVG model selection is enabled.