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
@@ -10,7 +10,8 @@ module OpenAI
10
10
  part: OpenAI::Beta::OutputText,
11
11
  session_id: String,
12
12
  turn_id: String?,
13
- ?type: :"agent.session.turn.content_part.done"
13
+ ?type: :"agent.session.turn.content_part.done",
14
+ ?obfuscation: String
14
15
  }
15
16
 
16
17
  class AgentSessionTurnContentPartDoneEvent < OpenAI::Internal::Type::BaseModel
@@ -38,6 +39,12 @@ module OpenAI
38
39
  # The type of the object. Always `agent.session.turn.content_part.done`.
39
40
  attr_accessor type: :"agent.session.turn.content_part.done"
40
41
 
42
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
43
+ attr_reader obfuscation: String?
44
+
45
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
46
+ def obfuscation=: (String) -> String
47
+
41
48
  # @param content_index
42
49
  # The index of the content part in the message.
43
50
  # @param event_id
@@ -52,6 +59,8 @@ module OpenAI
52
59
  # The ID of the session associated with the event.
53
60
  # @param turn_id
54
61
  # The ID of the turn associated with the event, when applicable.
62
+ # @param obfuscation
63
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
55
64
  # @param type
56
65
  # The type of the object. Always `agent.session.turn.content_part.done`.
57
66
  def initialize: (
@@ -62,6 +71,7 @@ module OpenAI
62
71
  part: OpenAI::Beta::OutputText,
63
72
  session_id: String,
64
73
  turn_id: String?,
74
+ ?obfuscation: String,
65
75
  ?type: :"agent.session.turn.content_part.done"
66
76
  ) -> void
67
77
 
@@ -73,7 +83,8 @@ module OpenAI
73
83
  part: OpenAI::Beta::OutputText,
74
84
  session_id: String,
75
85
  turn_id: String?,
76
- ?type: :"agent.session.turn.content_part.done"
86
+ ?type: :"agent.session.turn.content_part.done",
87
+ ?obfuscation: String
77
88
  }
78
89
  end
79
90
  end
@@ -7,7 +7,8 @@ module OpenAI
7
7
  session_id: String,
8
8
  turn: OpenAI::Beta::Agents::Sessions::Turn,
9
9
  turn_id: String,
10
- ?type: :"agent.session.turn.created"
10
+ ?type: :"agent.session.turn.created",
11
+ ?obfuscation: String
11
12
  }
12
13
 
13
14
  class AgentSessionTurnCreatedEvent < OpenAI::Internal::Type::BaseModel
@@ -26,6 +27,12 @@ module OpenAI
26
27
  # The type of the object. Always `agent.session.turn.created`.
27
28
  attr_accessor type: :"agent.session.turn.created"
28
29
 
30
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
31
+ attr_reader obfuscation: String?
32
+
33
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
34
+ def obfuscation=: (String) -> String
35
+
29
36
  # @param event_id
30
37
  # The unique ID of the event.
31
38
  # @param session_id
@@ -34,6 +41,8 @@ module OpenAI
34
41
  # The turn at the time it was created.
35
42
  # @param turn_id
36
43
  # The ID of the turn associated with the event.
44
+ # @param obfuscation
45
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
37
46
  # @param type
38
47
  # The type of the object. Always `agent.session.turn.created`.
39
48
  def initialize: (
@@ -41,6 +50,7 @@ module OpenAI
41
50
  session_id: String,
42
51
  turn: OpenAI::Beta::Agents::Sessions::Turn,
43
52
  turn_id: String,
53
+ ?obfuscation: String,
44
54
  ?type: :"agent.session.turn.created"
45
55
  ) -> void
46
56
 
@@ -49,7 +59,8 @@ module OpenAI
49
59
  session_id: String,
50
60
  turn: OpenAI::Beta::Agents::Sessions::Turn,
51
61
  turn_id: String,
52
- ?type: :"agent.session.turn.created"
62
+ ?type: :"agent.session.turn.created",
63
+ ?obfuscation: String
53
64
  }
54
65
  end
55
66
  end
@@ -8,7 +8,8 @@ module OpenAI
8
8
  turn: OpenAI::Beta::Agents::Sessions::Turn,
9
9
  turn_id: String,
10
10
  ?type: :"agent.session.turn.failed",
11
- usage: OpenAI::Beta::TokenUsage?
11
+ usage: OpenAI::Beta::TokenUsage?,
12
+ ?obfuscation: String
12
13
  }
13
14
 
14
15
  class AgentSessionTurnFailedEvent < OpenAI::Internal::Type::BaseModel
@@ -30,6 +31,12 @@ module OpenAI
30
31
  # Token usage by the root agent during the turn, when available.
31
32
  attr_accessor usage: OpenAI::Beta::TokenUsage?
32
33
 
34
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
35
+ attr_reader obfuscation: String?
36
+
37
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
38
+ def obfuscation=: (String) -> String
39
+
33
40
  # @param event_id
34
41
  # The unique ID of the event.
35
42
  # @param session_id
@@ -40,6 +47,8 @@ module OpenAI
40
47
  # The ID of the turn associated with the event.
41
48
  # @param usage
42
49
  # Token usage by the root agent during the turn, when available.
50
+ # @param obfuscation
51
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
43
52
  # @param type
44
53
  # The type of the object. Always `agent.session.turn.failed`.
45
54
  def initialize: (
@@ -48,6 +57,7 @@ module OpenAI
48
57
  turn: OpenAI::Beta::Agents::Sessions::Turn,
49
58
  turn_id: String,
50
59
  usage: OpenAI::Beta::TokenUsage?,
60
+ ?obfuscation: String,
51
61
  ?type: :"agent.session.turn.failed"
52
62
  ) -> void
53
63
 
@@ -57,7 +67,8 @@ module OpenAI
57
67
  turn: OpenAI::Beta::Agents::Sessions::Turn,
58
68
  turn_id: String,
59
69
  ?type: :"agent.session.turn.failed",
60
- usage: OpenAI::Beta::TokenUsage?
70
+ usage: OpenAI::Beta::TokenUsage?,
71
+ ?obfuscation: String
61
72
  }
62
73
  end
63
74
  end
@@ -7,7 +7,8 @@ module OpenAI
7
7
  session_id: String,
8
8
  turn: OpenAI::Beta::Agents::Sessions::Turn,
9
9
  turn_id: String,
10
- ?type: :"agent.session.turn.in_progress"
10
+ ?type: :"agent.session.turn.in_progress",
11
+ ?obfuscation: String
11
12
  }
12
13
 
13
14
  class AgentSessionTurnInProgressEvent < OpenAI::Internal::Type::BaseModel
@@ -26,6 +27,12 @@ module OpenAI
26
27
  # The type of the object. Always `agent.session.turn.in_progress`.
27
28
  attr_accessor type: :"agent.session.turn.in_progress"
28
29
 
30
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
31
+ attr_reader obfuscation: String?
32
+
33
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
34
+ def obfuscation=: (String) -> String
35
+
29
36
  # @param event_id
30
37
  # The unique ID of the event.
31
38
  # @param session_id
@@ -34,6 +41,8 @@ module OpenAI
34
41
  # The turn at the time it started running.
35
42
  # @param turn_id
36
43
  # The ID of the turn associated with the event.
44
+ # @param obfuscation
45
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
37
46
  # @param type
38
47
  # The type of the object. Always `agent.session.turn.in_progress`.
39
48
  def initialize: (
@@ -41,6 +50,7 @@ module OpenAI
41
50
  session_id: String,
42
51
  turn: OpenAI::Beta::Agents::Sessions::Turn,
43
52
  turn_id: String,
53
+ ?obfuscation: String,
44
54
  ?type: :"agent.session.turn.in_progress"
45
55
  ) -> void
46
56
 
@@ -49,7 +59,8 @@ module OpenAI
49
59
  session_id: String,
50
60
  turn: OpenAI::Beta::Agents::Sessions::Turn,
51
61
  turn_id: String,
52
- ?type: :"agent.session.turn.in_progress"
62
+ ?type: :"agent.session.turn.in_progress",
63
+ ?obfuscation: String
53
64
  }
54
65
  end
55
66
  end
@@ -8,7 +8,8 @@ module OpenAI
8
8
  output_index: Integer?,
9
9
  session_id: String,
10
10
  turn_id: String?,
11
- ?type: :"agent.session.turn.item.added"
11
+ ?type: :"agent.session.turn.item.added",
12
+ ?obfuscation: String
12
13
  }
13
14
 
14
15
  class AgentSessionTurnItemAddedEvent < OpenAI::Internal::Type::BaseModel
@@ -30,6 +31,12 @@ module OpenAI
30
31
  # The type of the object. Always `agent.session.turn.item.added`.
31
32
  attr_accessor type: :"agent.session.turn.item.added"
32
33
 
34
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
35
+ attr_reader obfuscation: String?
36
+
37
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
38
+ def obfuscation=: (String) -> String
39
+
33
40
  # @param event_id
34
41
  # The unique ID of the event.
35
42
  # @param item
@@ -40,6 +47,8 @@ module OpenAI
40
47
  # The ID of the session associated with the event.
41
48
  # @param turn_id
42
49
  # The ID of the turn associated with the event, when applicable.
50
+ # @param obfuscation
51
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
43
52
  # @param type
44
53
  # The type of the object. Always `agent.session.turn.item.added`.
45
54
  def initialize: (
@@ -48,6 +57,7 @@ module OpenAI
48
57
  output_index: Integer?,
49
58
  session_id: String,
50
59
  turn_id: String?,
60
+ ?obfuscation: String,
51
61
  ?type: :"agent.session.turn.item.added"
52
62
  ) -> void
53
63
 
@@ -57,7 +67,8 @@ module OpenAI
57
67
  output_index: Integer?,
58
68
  session_id: String,
59
69
  turn_id: String?,
60
- ?type: :"agent.session.turn.item.added"
70
+ ?type: :"agent.session.turn.item.added",
71
+ ?obfuscation: String
61
72
  }
62
73
  end
63
74
  end
@@ -8,7 +8,8 @@ module OpenAI
8
8
  output_index: Integer,
9
9
  session_id: String,
10
10
  turn_id: String?,
11
- ?type: :"agent.session.turn.item.done"
11
+ ?type: :"agent.session.turn.item.done",
12
+ ?obfuscation: String
12
13
  }
13
14
 
14
15
  class AgentSessionTurnItemDoneEvent < OpenAI::Internal::Type::BaseModel
@@ -30,6 +31,12 @@ module OpenAI
30
31
  # The type of the object. Always `agent.session.turn.item.done`.
31
32
  attr_accessor type: :"agent.session.turn.item.done"
32
33
 
34
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
35
+ attr_reader obfuscation: String?
36
+
37
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
38
+ def obfuscation=: (String) -> String
39
+
33
40
  # @param event_id
34
41
  # The unique ID of the event.
35
42
  # @param item
@@ -40,6 +47,8 @@ module OpenAI
40
47
  # The ID of the session associated with the event.
41
48
  # @param turn_id
42
49
  # The ID of the turn associated with the event, when applicable.
50
+ # @param obfuscation
51
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
43
52
  # @param type
44
53
  # The type of the object. Always `agent.session.turn.item.done`.
45
54
  def initialize: (
@@ -48,6 +57,7 @@ module OpenAI
48
57
  output_index: Integer,
49
58
  session_id: String,
50
59
  turn_id: String?,
60
+ ?obfuscation: String,
51
61
  ?type: :"agent.session.turn.item.done"
52
62
  ) -> void
53
63
 
@@ -57,7 +67,8 @@ module OpenAI
57
67
  output_index: Integer,
58
68
  session_id: String,
59
69
  turn_id: String?,
60
- ?type: :"agent.session.turn.item.done"
70
+ ?type: :"agent.session.turn.item.done",
71
+ ?obfuscation: String
61
72
  }
62
73
  end
63
74
  end
@@ -10,7 +10,8 @@ module OpenAI
10
10
  output_index: Integer,
11
11
  session_id: String,
12
12
  turn_id: String?,
13
- ?type: :"agent.session.turn.output_text.delta"
13
+ ?type: :"agent.session.turn.output_text.delta",
14
+ ?obfuscation: String
14
15
  }
15
16
 
16
17
  class AgentSessionTurnOutputTextDeltaEvent < OpenAI::Internal::Type::BaseModel
@@ -38,6 +39,12 @@ module OpenAI
38
39
  # The type of the object. Always `agent.session.turn.output_text.delta`.
39
40
  attr_accessor type: :"agent.session.turn.output_text.delta"
40
41
 
42
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
43
+ attr_reader obfuscation: String?
44
+
45
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
46
+ def obfuscation=: (String) -> String
47
+
41
48
  # @param content_index
42
49
  # The index of the content part in the message.
43
50
  # @param delta
@@ -52,6 +59,8 @@ module OpenAI
52
59
  # The ID of the session associated with the event.
53
60
  # @param turn_id
54
61
  # The ID of the turn associated with the event, when applicable.
62
+ # @param obfuscation
63
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
55
64
  # @param type
56
65
  # The type of the object. Always `agent.session.turn.output_text.delta`.
57
66
  def initialize: (
@@ -62,6 +71,7 @@ module OpenAI
62
71
  output_index: Integer,
63
72
  session_id: String,
64
73
  turn_id: String?,
74
+ ?obfuscation: String,
65
75
  ?type: :"agent.session.turn.output_text.delta"
66
76
  ) -> void
67
77
 
@@ -73,7 +83,8 @@ module OpenAI
73
83
  output_index: Integer,
74
84
  session_id: String,
75
85
  turn_id: String?,
76
- ?type: :"agent.session.turn.output_text.delta"
86
+ ?type: :"agent.session.turn.output_text.delta",
87
+ ?obfuscation: String
77
88
  }
78
89
  end
79
90
  end
@@ -10,7 +10,8 @@ module OpenAI
10
10
  session_id: String,
11
11
  text: String,
12
12
  turn_id: String?,
13
- ?type: :"agent.session.turn.output_text.done"
13
+ ?type: :"agent.session.turn.output_text.done",
14
+ ?obfuscation: String
14
15
  }
15
16
 
16
17
  class AgentSessionTurnOutputTextDoneEvent < OpenAI::Internal::Type::BaseModel
@@ -38,6 +39,12 @@ module OpenAI
38
39
  # The type of the object. Always `agent.session.turn.output_text.done`.
39
40
  attr_accessor type: :"agent.session.turn.output_text.done"
40
41
 
42
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
43
+ attr_reader obfuscation: String?
44
+
45
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
46
+ def obfuscation=: (String) -> String
47
+
41
48
  # @param content_index
42
49
  # The index of the content part in the message.
43
50
  # @param event_id
@@ -52,6 +59,8 @@ module OpenAI
52
59
  # The complete output text.
53
60
  # @param turn_id
54
61
  # The ID of the turn associated with the event, when applicable.
62
+ # @param obfuscation
63
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
55
64
  # @param type
56
65
  # The type of the object. Always `agent.session.turn.output_text.done`.
57
66
  def initialize: (
@@ -62,6 +71,7 @@ module OpenAI
62
71
  session_id: String,
63
72
  text: String,
64
73
  turn_id: String?,
74
+ ?obfuscation: String,
65
75
  ?type: :"agent.session.turn.output_text.done"
66
76
  ) -> void
67
77
 
@@ -73,7 +83,8 @@ module OpenAI
73
83
  session_id: String,
74
84
  text: String,
75
85
  turn_id: String?,
76
- ?type: :"agent.session.turn.output_text.done"
86
+ ?type: :"agent.session.turn.output_text.done",
87
+ ?obfuscation: String
77
88
  }
78
89
  end
79
90
  end
@@ -10,7 +10,8 @@ module OpenAI
10
10
  session_id: String,
11
11
  summary_index: Integer,
12
12
  turn_id: String?,
13
- ?type: :"agent.session.turn.reasoning_summary_part.added"
13
+ ?type: :"agent.session.turn.reasoning_summary_part.added",
14
+ ?obfuscation: String
14
15
  }
15
16
 
16
17
  class AgentSessionTurnReasoningSummaryPartAddedEvent < OpenAI::Internal::Type::BaseModel
@@ -39,6 +40,12 @@ module OpenAI
39
40
  # `agent.session.turn.reasoning_summary_part.added`.
40
41
  attr_accessor type: :"agent.session.turn.reasoning_summary_part.added"
41
42
 
43
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
44
+ attr_reader obfuscation: String?
45
+
46
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
47
+ def obfuscation=: (String) -> String
48
+
42
49
  # @param event_id
43
50
  # The unique ID of the event.
44
51
  # @param item_id
@@ -53,6 +60,8 @@ module OpenAI
53
60
  # The index of the summary content part.
54
61
  # @param turn_id
55
62
  # The ID of the turn associated with the event, when applicable.
63
+ # @param obfuscation
64
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
56
65
  # @param type
57
66
  # The type of the object. Always
58
67
  # `agent.session.turn.reasoning_summary_part.added`.
@@ -64,6 +73,7 @@ module OpenAI
64
73
  session_id: String,
65
74
  summary_index: Integer,
66
75
  turn_id: String?,
76
+ ?obfuscation: String,
67
77
  ?type: :"agent.session.turn.reasoning_summary_part.added"
68
78
  ) -> void
69
79
 
@@ -75,7 +85,8 @@ module OpenAI
75
85
  session_id: String,
76
86
  summary_index: Integer,
77
87
  turn_id: String?,
78
- ?type: :"agent.session.turn.reasoning_summary_part.added"
88
+ ?type: :"agent.session.turn.reasoning_summary_part.added",
89
+ ?obfuscation: String
79
90
  }
80
91
  end
81
92
  end
@@ -11,7 +11,8 @@ module OpenAI
11
11
  ?status: :incomplete?,
12
12
  summary_index: Integer,
13
13
  turn_id: String?,
14
- ?type: :"agent.session.turn.reasoning_summary_part.done"
14
+ ?type: :"agent.session.turn.reasoning_summary_part.done",
15
+ ?obfuscation: String
15
16
  }
16
17
 
17
18
  class AgentSessionTurnReasoningSummaryPartDoneEvent < OpenAI::Internal::Type::BaseModel
@@ -42,6 +43,12 @@ module OpenAI
42
43
  # The type of the object. Always `agent.session.turn.reasoning_summary_part.done`.
43
44
  attr_accessor type: :"agent.session.turn.reasoning_summary_part.done"
44
45
 
46
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
47
+ attr_reader obfuscation: String?
48
+
49
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
50
+ def obfuscation=: (String) -> String
51
+
45
52
  # @param event_id
46
53
  # The unique ID of the event.
47
54
  # @param item_id
@@ -56,6 +63,8 @@ module OpenAI
56
63
  # The index of the summary part.
57
64
  # @param turn_id
58
65
  # The ID of the turn associated with the event, when applicable.
66
+ # @param obfuscation
67
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
59
68
  # @param status
60
69
  # Present as `incomplete` when summary generation was interrupted.
61
70
  # @param type
@@ -68,6 +77,7 @@ module OpenAI
68
77
  session_id: String,
69
78
  summary_index: Integer,
70
79
  turn_id: String?,
80
+ ?obfuscation: String,
71
81
  ?status: :incomplete?,
72
82
  ?type: :"agent.session.turn.reasoning_summary_part.done"
73
83
  ) -> void
@@ -81,7 +91,8 @@ module OpenAI
81
91
  ?status: :incomplete?,
82
92
  summary_index: Integer,
83
93
  turn_id: String?,
84
- ?type: :"agent.session.turn.reasoning_summary_part.done"
94
+ ?type: :"agent.session.turn.reasoning_summary_part.done",
95
+ ?obfuscation: String
85
96
  }
86
97
  end
87
98
  end
@@ -10,7 +10,8 @@ module OpenAI
10
10
  session_id: String,
11
11
  summary_index: Integer,
12
12
  turn_id: String?,
13
- ?type: :"agent.session.turn.reasoning_summary_text.delta"
13
+ ?type: :"agent.session.turn.reasoning_summary_text.delta",
14
+ ?obfuscation: String
14
15
  }
15
16
 
16
17
  class AgentSessionTurnReasoningSummaryTextDeltaEvent < OpenAI::Internal::Type::BaseModel
@@ -39,6 +40,12 @@ module OpenAI
39
40
  # `agent.session.turn.reasoning_summary_text.delta`.
40
41
  attr_accessor type: :"agent.session.turn.reasoning_summary_text.delta"
41
42
 
43
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
44
+ attr_reader obfuscation: String?
45
+
46
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
47
+ def obfuscation=: (String) -> String
48
+
42
49
  # @param delta
43
50
  # The summary text that was appended.
44
51
  # @param event_id
@@ -53,6 +60,8 @@ module OpenAI
53
60
  # The index of the summary content part.
54
61
  # @param turn_id
55
62
  # The ID of the turn associated with the event, when applicable.
63
+ # @param obfuscation
64
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
56
65
  # @param type
57
66
  # The type of the object. Always
58
67
  # `agent.session.turn.reasoning_summary_text.delta`.
@@ -64,6 +73,7 @@ module OpenAI
64
73
  session_id: String,
65
74
  summary_index: Integer,
66
75
  turn_id: String?,
76
+ ?obfuscation: String,
67
77
  ?type: :"agent.session.turn.reasoning_summary_text.delta"
68
78
  ) -> void
69
79
 
@@ -75,7 +85,8 @@ module OpenAI
75
85
  session_id: String,
76
86
  summary_index: Integer,
77
87
  turn_id: String?,
78
- ?type: :"agent.session.turn.reasoning_summary_text.delta"
88
+ ?type: :"agent.session.turn.reasoning_summary_text.delta",
89
+ ?obfuscation: String
79
90
  }
80
91
  end
81
92
  end
@@ -10,7 +10,8 @@ module OpenAI
10
10
  summary_index: Integer,
11
11
  text: String,
12
12
  turn_id: String?,
13
- ?type: :"agent.session.turn.reasoning_summary_text.done"
13
+ ?type: :"agent.session.turn.reasoning_summary_text.done",
14
+ ?obfuscation: String
14
15
  }
15
16
 
16
17
  class AgentSessionTurnReasoningSummaryTextDoneEvent < OpenAI::Internal::Type::BaseModel
@@ -38,6 +39,12 @@ module OpenAI
38
39
  # The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
39
40
  attr_accessor type: :"agent.session.turn.reasoning_summary_text.done"
40
41
 
42
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
43
+ attr_reader obfuscation: String?
44
+
45
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
46
+ def obfuscation=: (String) -> String
47
+
41
48
  # @param event_id
42
49
  # The unique ID of the event.
43
50
  # @param item_id
@@ -52,6 +59,8 @@ module OpenAI
52
59
  # The complete reasoning summary text.
53
60
  # @param turn_id
54
61
  # The ID of the turn associated with the event, when applicable.
62
+ # @param obfuscation
63
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
55
64
  # @param type
56
65
  # The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
57
66
  def initialize: (
@@ -62,6 +71,7 @@ module OpenAI
62
71
  summary_index: Integer,
63
72
  text: String,
64
73
  turn_id: String?,
74
+ ?obfuscation: String,
65
75
  ?type: :"agent.session.turn.reasoning_summary_text.done"
66
76
  ) -> void
67
77
 
@@ -73,7 +83,8 @@ module OpenAI
73
83
  summary_index: Integer,
74
84
  text: String,
75
85
  turn_id: String?,
76
- ?type: :"agent.session.turn.reasoning_summary_text.done"
86
+ ?type: :"agent.session.turn.reasoning_summary_text.done",
87
+ ?obfuscation: String
77
88
  }
78
89
  end
79
90
  end
@@ -25,8 +25,7 @@ module OpenAI
25
25
  attr_accessor agent_id: String
26
26
 
27
27
  # Context compaction settings. Omit to keep the current settings. A supplied
28
- # object replaces the settings; null or an empty object enables background
29
- # compaction.
28
+ # object replaces the settings; null or an empty object uses blocking compaction.
30
29
  attr_accessor compaction: OpenAI::Beta::AgentUpdateParams::Compaction?
31
30
 
32
31
  # Experimental settings to merge by key. Omitted settings keep their current
@@ -76,8 +75,7 @@ module OpenAI
76
75
 
77
76
  # @param compaction
78
77
  # Context compaction settings. Omit to keep the current settings. A supplied
79
- # object replaces the settings; null or an empty object enables background
80
- # compaction.
78
+ # object replaces the settings; null or an empty object uses blocking compaction.
81
79
  # @param experimental
82
80
  # Experimental settings to merge by key. Omitted settings keep their current
83
81
  # values.
@@ -139,15 +137,15 @@ module OpenAI
139
137
  type compaction = { ?async: bool? }
140
138
 
141
139
  class Compaction < OpenAI::Internal::Type::BaseModel
142
- # Whether to compact context in the background. Omission or null defaults to true.
143
- # Set to false to use blocking compaction. Background compaction may increase
144
- # 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.
145
143
  attr_accessor async: bool?
146
144
 
147
145
  # @param async
148
- # Whether to compact context in the background. Omission or null defaults to true.
149
- # Set to false to use blocking compaction. Background compaction may increase
150
- # token usage.
146
+ # Whether to compact context in the background. Omission or null defaults to
147
+ # false. Set to true to enable background compaction. Background compaction may
148
+ # increase token usage.
151
149
  def initialize: (?async: bool?) -> void
152
150
 
153
151
  def to_hash: -> { ?async: bool? }
@@ -114,11 +114,11 @@ module OpenAI
114
114
  type compaction = { async: bool }
115
115
 
116
116
  class Compaction < OpenAI::Internal::Type::BaseModel
117
- # Whether context is compacted in the background. Defaults to true.
117
+ # Whether context is compacted in the background. Defaults to false.
118
118
  attr_accessor async: bool
119
119
 
120
120
  # @param async
121
- # Whether context is compacted in the background. Defaults to true.
121
+ # Whether context is compacted in the background. Defaults to false.
122
122
  def initialize: (async: bool) -> void
123
123
 
124
124
  def to_hash: -> { async: bool }