openai 0.123.0 → 0.124.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 (227) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/openai/models/admin/organization/audit_log_list_response.rb +10 -1
  5. data/lib/openai/models/admin/organization/external_key.rb +25 -1
  6. data/lib/openai/models/admin/organization/external_key_create_params.rb +78 -3
  7. data/lib/openai/models/beta/agent_output_command_execution_output_delta_event.rb +10 -1
  8. data/lib/openai/models/beta/agent_session.rb +128 -4
  9. data/lib/openai/models/beta/agent_session_created_event.rb +10 -1
  10. data/lib/openai/models/beta/agent_session_environment_connected_event.rb +10 -1
  11. data/lib/openai/models/beta/agent_session_environment_disconnected_event.rb +10 -1
  12. data/lib/openai/models/beta/agent_session_environment_expired_event.rb +10 -1
  13. data/lib/openai/models/beta/agent_session_environment_failed_event.rb +10 -1
  14. data/lib/openai/models/beta/agent_session_environment_pending_event.rb +10 -1
  15. data/lib/openai/models/beta/agent_session_environment_ready_event.rb +10 -1
  16. data/lib/openai/models/beta/agent_session_environment_reset_event.rb +10 -1
  17. data/lib/openai/models/beta/agent_session_environment_suspended_event.rb +10 -1
  18. data/lib/openai/models/beta/agent_session_error_event.rb +10 -1
  19. data/lib/openai/models/beta/agent_session_failed_event.rb +10 -1
  20. data/lib/openai/models/beta/agent_session_idle_event.rb +10 -1
  21. data/lib/openai/models/beta/agent_session_in_progress_event.rb +10 -1
  22. data/lib/openai/models/beta/agent_session_input_param.rb +87 -1
  23. data/lib/openai/models/beta/agent_session_requires_action_event.rb +10 -1
  24. data/lib/openai/models/beta/agent_session_subagent_active_event.rb +10 -1
  25. data/lib/openai/models/beta/agent_session_subagent_closed_event.rb +10 -1
  26. data/lib/openai/models/beta/agent_session_subagent_created_event.rb +10 -1
  27. data/lib/openai/models/beta/agent_session_turn_cancelled_event.rb +10 -1
  28. data/lib/openai/models/beta/agent_session_turn_completed_event.rb +10 -1
  29. data/lib/openai/models/beta/agent_session_turn_content_part_added_event.rb +10 -1
  30. data/lib/openai/models/beta/agent_session_turn_content_part_done_event.rb +10 -1
  31. data/lib/openai/models/beta/agent_session_turn_created_event.rb +10 -1
  32. data/lib/openai/models/beta/agent_session_turn_failed_event.rb +10 -1
  33. data/lib/openai/models/beta/agent_session_turn_in_progress_event.rb +10 -1
  34. data/lib/openai/models/beta/agent_session_turn_item_added_event.rb +10 -1
  35. data/lib/openai/models/beta/agent_session_turn_item_done_event.rb +10 -1
  36. data/lib/openai/models/beta/agent_session_turn_output_text_delta_event.rb +10 -1
  37. data/lib/openai/models/beta/agent_session_turn_output_text_done_event.rb +10 -1
  38. data/lib/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rb +10 -1
  39. data/lib/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rb +10 -1
  40. data/lib/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rb +10 -1
  41. data/lib/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rb +10 -1
  42. data/lib/openai/models/beta/agents/session_create_params.rb +69 -1
  43. data/lib/openai/models/beta/agents/session_update_params.rb +44 -1
  44. data/lib/openai/models/beta/agents/sessions/event_create_params.rb +2 -2
  45. data/lib/openai/models/beta/agents/sessions/event_stream_params.rb +13 -1
  46. data/lib/openai/models/beta/agents/sessions/turn.rb +41 -1
  47. data/lib/openai/models/beta/beta_response.rb +9 -3
  48. data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +6 -3
  49. data/lib/openai/models/beta/beta_responses_client_event.rb +9 -3
  50. data/lib/openai/models/beta/beta_tool.rb +6 -3
  51. data/lib/openai/models/beta/response_compact_params.rb +2 -0
  52. data/lib/openai/models/beta/response_create_params.rb +9 -3
  53. data/lib/openai/models/beta/responses/input_token_count_params.rb +27 -15
  54. data/lib/openai/models/content_provenance_check_create_params.rb +2 -0
  55. data/lib/openai/models/image_edit_params.rb +84 -5
  56. data/lib/openai/models/image_generate_params.rb +4 -4
  57. data/lib/openai/models/images_response.rb +9 -12
  58. data/lib/openai/models/live/media_session_config.rb +12 -1
  59. data/lib/openai/models/live/session_accept_params.rb +12 -1
  60. data/lib/openai/models/responses/input_token_count_params.rb +27 -15
  61. data/lib/openai/models/responses/response.rb +9 -3
  62. data/lib/openai/models/responses/response_compact_params.rb +2 -0
  63. data/lib/openai/models/responses/response_create_params.rb +9 -3
  64. data/lib/openai/models/responses/response_tool_search_output_item_param.rb +6 -3
  65. data/lib/openai/models/responses/responses_client_event.rb +9 -3
  66. data/lib/openai/models/responses/tool.rb +6 -3
  67. data/lib/openai/models/video_create_error.rb +6 -4
  68. data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +1 -0
  69. data/lib/openai/models/webhooks/live_transport_connected_webhook_event.rb +74 -0
  70. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +4 -1
  71. data/lib/openai/resources/admin/organization/external_keys.rb +1 -1
  72. data/lib/openai/resources/beta/agents/sessions/events.rb +10 -3
  73. data/lib/openai/resources/beta/agents/sessions.rb +24 -5
  74. data/lib/openai/resources/beta/responses/input_tokens.rb +9 -6
  75. data/lib/openai/resources/beta/responses.rb +6 -2
  76. data/lib/openai/resources/content_provenance_checks.rb +1 -0
  77. data/lib/openai/resources/images.rb +20 -6
  78. data/lib/openai/resources/responses/input_tokens.rb +9 -5
  79. data/lib/openai/resources/responses.rb +6 -2
  80. data/lib/openai/resources/webhooks.rb +1 -1
  81. data/lib/openai/version.rb +1 -1
  82. data/lib/openai.rb +1 -0
  83. data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +13 -1
  84. data/rbi/openai/models/admin/organization/external_key.rbi +44 -0
  85. data/rbi/openai/models/admin/organization/external_key_create_params.rbi +137 -4
  86. data/rbi/openai/models/beta/agent_output_command_execution_output_delta_event.rbi +14 -1
  87. data/rbi/openai/models/beta/agent_session.rbi +207 -0
  88. data/rbi/openai/models/beta/agent_session_created_event.rbi +13 -1
  89. data/rbi/openai/models/beta/agent_session_environment_connected_event.rbi +14 -1
  90. data/rbi/openai/models/beta/agent_session_environment_disconnected_event.rbi +14 -1
  91. data/rbi/openai/models/beta/agent_session_environment_expired_event.rbi +14 -1
  92. data/rbi/openai/models/beta/agent_session_environment_failed_event.rbi +14 -1
  93. data/rbi/openai/models/beta/agent_session_environment_pending_event.rbi +14 -1
  94. data/rbi/openai/models/beta/agent_session_environment_ready_event.rbi +14 -1
  95. data/rbi/openai/models/beta/agent_session_environment_reset_event.rbi +14 -1
  96. data/rbi/openai/models/beta/agent_session_environment_suspended_event.rbi +14 -1
  97. data/rbi/openai/models/beta/agent_session_error_event.rbi +13 -1
  98. data/rbi/openai/models/beta/agent_session_failed_event.rbi +13 -1
  99. data/rbi/openai/models/beta/agent_session_idle_event.rbi +13 -1
  100. data/rbi/openai/models/beta/agent_session_in_progress_event.rbi +13 -1
  101. data/rbi/openai/models/beta/agent_session_input_param.rbi +159 -0
  102. data/rbi/openai/models/beta/agent_session_requires_action_event.rbi +13 -1
  103. data/rbi/openai/models/beta/agent_session_subagent_active_event.rbi +13 -1
  104. data/rbi/openai/models/beta/agent_session_subagent_closed_event.rbi +13 -1
  105. data/rbi/openai/models/beta/agent_session_subagent_created_event.rbi +13 -1
  106. data/rbi/openai/models/beta/agent_session_turn_cancelled_event.rbi +14 -1
  107. data/rbi/openai/models/beta/agent_session_turn_completed_event.rbi +14 -1
  108. data/rbi/openai/models/beta/agent_session_turn_content_part_added_event.rbi +14 -1
  109. data/rbi/openai/models/beta/agent_session_turn_content_part_done_event.rbi +14 -1
  110. data/rbi/openai/models/beta/agent_session_turn_created_event.rbi +14 -1
  111. data/rbi/openai/models/beta/agent_session_turn_failed_event.rbi +14 -1
  112. data/rbi/openai/models/beta/agent_session_turn_in_progress_event.rbi +14 -1
  113. data/rbi/openai/models/beta/agent_session_turn_item_added_event.rbi +14 -1
  114. data/rbi/openai/models/beta/agent_session_turn_item_done_event.rbi +14 -1
  115. data/rbi/openai/models/beta/agent_session_turn_output_text_delta_event.rbi +14 -1
  116. data/rbi/openai/models/beta/agent_session_turn_output_text_done_event.rbi +14 -1
  117. data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbi +14 -1
  118. data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbi +14 -1
  119. data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbi +14 -1
  120. data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbi +14 -1
  121. data/rbi/openai/models/beta/agents/session_create_params.rbi +138 -0
  122. data/rbi/openai/models/beta/agents/session_update_params.rbi +82 -0
  123. data/rbi/openai/models/beta/agents/sessions/event_create_params.rbi +3 -0
  124. data/rbi/openai/models/beta/agents/sessions/event_stream_params.rbi +15 -1
  125. data/rbi/openai/models/beta/agents/sessions/turn.rbi +74 -1
  126. data/rbi/openai/models/beta/beta_response.rbi +9 -3
  127. data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +6 -3
  128. data/rbi/openai/models/beta/beta_responses_client_event.rbi +9 -3
  129. data/rbi/openai/models/beta/beta_tool.rbi +6 -3
  130. data/rbi/openai/models/beta/response_create_params.rbi +9 -3
  131. data/rbi/openai/models/beta/responses/input_token_count_params.rbi +27 -15
  132. data/rbi/openai/models/content_provenance_check_create_params.rbi +2 -0
  133. data/rbi/openai/models/image_edit_params.rbi +143 -4
  134. data/rbi/openai/models/image_generate_params.rbi +4 -4
  135. data/rbi/openai/models/images_response.rbi +9 -12
  136. data/rbi/openai/models/live/media_session_config.rbi +12 -0
  137. data/rbi/openai/models/live/session_accept_params.rbi +12 -0
  138. data/rbi/openai/models/responses/input_token_count_params.rbi +27 -15
  139. data/rbi/openai/models/responses/response.rbi +9 -3
  140. data/rbi/openai/models/responses/response_create_params.rbi +9 -3
  141. data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +6 -3
  142. data/rbi/openai/models/responses/responses_client_event.rbi +9 -3
  143. data/rbi/openai/models/responses/tool.rbi +6 -3
  144. data/rbi/openai/models/video_create_error.rbi +6 -4
  145. data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +4 -0
  146. data/rbi/openai/models/webhooks/live_transport_connected_webhook_event.rbi +135 -0
  147. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +1 -0
  148. data/rbi/openai/resources/admin/organization/external_keys.rbi +2 -1
  149. data/rbi/openai/resources/beta/agents/sessions/events.rbi +9 -2
  150. data/rbi/openai/resources/beta/agents/sessions.rbi +21 -2
  151. data/rbi/openai/resources/beta/responses/input_tokens.rbi +9 -6
  152. data/rbi/openai/resources/beta/responses.rbi +6 -2
  153. data/rbi/openai/resources/content_provenance_checks.rbi +1 -0
  154. data/rbi/openai/resources/images.rbi +18 -4
  155. data/rbi/openai/resources/responses/input_tokens.rbi +9 -5
  156. data/rbi/openai/resources/responses.rbi +6 -2
  157. data/rbi/openai/resources/webhooks.rbi +1 -0
  158. data/sig/openai/models/admin/organization/audit_log_list_response.rbs +18 -3
  159. data/sig/openai/models/admin/organization/external_key.rbs +28 -0
  160. data/sig/openai/models/admin/organization/external_key_create_params.rbs +108 -0
  161. data/sig/openai/models/beta/agent_output_command_execution_output_delta_event.rbs +13 -2
  162. data/sig/openai/models/beta/agent_session.rbs +126 -1
  163. data/sig/openai/models/beta/agent_session_created_event.rbs +13 -2
  164. data/sig/openai/models/beta/agent_session_environment_connected_event.rbs +13 -2
  165. data/sig/openai/models/beta/agent_session_environment_disconnected_event.rbs +13 -2
  166. data/sig/openai/models/beta/agent_session_environment_expired_event.rbs +13 -2
  167. data/sig/openai/models/beta/agent_session_environment_failed_event.rbs +13 -2
  168. data/sig/openai/models/beta/agent_session_environment_pending_event.rbs +13 -2
  169. data/sig/openai/models/beta/agent_session_environment_ready_event.rbs +13 -2
  170. data/sig/openai/models/beta/agent_session_environment_reset_event.rbs +13 -2
  171. data/sig/openai/models/beta/agent_session_environment_suspended_event.rbs +13 -2
  172. data/sig/openai/models/beta/agent_session_error_event.rbs +13 -2
  173. data/sig/openai/models/beta/agent_session_failed_event.rbs +13 -2
  174. data/sig/openai/models/beta/agent_session_idle_event.rbs +13 -2
  175. data/sig/openai/models/beta/agent_session_in_progress_event.rbs +13 -2
  176. data/sig/openai/models/beta/agent_session_input_param.rbs +80 -1
  177. data/sig/openai/models/beta/agent_session_requires_action_event.rbs +13 -2
  178. data/sig/openai/models/beta/agent_session_subagent_active_event.rbs +13 -2
  179. data/sig/openai/models/beta/agent_session_subagent_closed_event.rbs +13 -2
  180. data/sig/openai/models/beta/agent_session_subagent_created_event.rbs +13 -2
  181. data/sig/openai/models/beta/agent_session_turn_cancelled_event.rbs +13 -2
  182. data/sig/openai/models/beta/agent_session_turn_completed_event.rbs +13 -2
  183. data/sig/openai/models/beta/agent_session_turn_content_part_added_event.rbs +13 -2
  184. data/sig/openai/models/beta/agent_session_turn_content_part_done_event.rbs +13 -2
  185. data/sig/openai/models/beta/agent_session_turn_created_event.rbs +13 -2
  186. data/sig/openai/models/beta/agent_session_turn_failed_event.rbs +13 -2
  187. data/sig/openai/models/beta/agent_session_turn_in_progress_event.rbs +13 -2
  188. data/sig/openai/models/beta/agent_session_turn_item_added_event.rbs +13 -2
  189. data/sig/openai/models/beta/agent_session_turn_item_done_event.rbs +13 -2
  190. data/sig/openai/models/beta/agent_session_turn_output_text_delta_event.rbs +13 -2
  191. data/sig/openai/models/beta/agent_session_turn_output_text_done_event.rbs +13 -2
  192. data/sig/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbs +13 -2
  193. data/sig/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbs +13 -2
  194. data/sig/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbs +13 -2
  195. data/sig/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbs +13 -2
  196. data/sig/openai/models/beta/agents/session_create_params.rbs +78 -0
  197. data/sig/openai/models/beta/agents/session_update_params.rbs +46 -0
  198. data/sig/openai/models/beta/agents/sessions/event_stream_params.rbs +18 -1
  199. data/sig/openai/models/beta/agents/sessions/turn.rbs +40 -2
  200. data/sig/openai/models/beta/beta_response.rbs +6 -2
  201. data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +6 -3
  202. data/sig/openai/models/beta/beta_responses_client_event.rbs +6 -2
  203. data/sig/openai/models/beta/beta_tool.rbs +6 -3
  204. data/sig/openai/models/beta/response_create_params.rbs +6 -2
  205. data/sig/openai/models/beta/responses/input_token_count_params.rbs +27 -15
  206. data/sig/openai/models/content_provenance_check_create_params.rbs +2 -0
  207. data/sig/openai/models/image_edit_params.rbs +87 -4
  208. data/sig/openai/models/image_generate_params.rbs +4 -4
  209. data/sig/openai/models/images_response.rbs +9 -12
  210. data/sig/openai/models/live/media_session_config.rbs +10 -0
  211. data/sig/openai/models/live/session_accept_params.rbs +10 -0
  212. data/sig/openai/models/responses/input_token_count_params.rbs +27 -15
  213. data/sig/openai/models/responses/response.rbs +6 -2
  214. data/sig/openai/models/responses/response_create_params.rbs +6 -2
  215. data/sig/openai/models/responses/response_tool_search_output_item_param.rbs +6 -3
  216. data/sig/openai/models/responses/responses_client_event.rbs +6 -2
  217. data/sig/openai/models/responses/tool.rbs +6 -3
  218. data/sig/openai/models/video_create_error.rbs +9 -6
  219. data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +2 -0
  220. data/sig/openai/models/webhooks/live_transport_connected_webhook_event.rbs +66 -0
  221. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
  222. data/sig/openai/resources/admin/organization/external_keys.rbs +9 -0
  223. data/sig/openai/resources/beta/agents/sessions/events.rbs +1 -0
  224. data/sig/openai/resources/beta/agents/sessions.rbs +5 -0
  225. data/sig/openai/resources/images.rbs +2 -0
  226. data/sig/openai/resources/webhooks.rbs +1 -0
  227. metadata +4 -1
@@ -44,6 +44,13 @@ module OpenAI
44
44
  sig { params(usage: T.nilable(OpenAI::Beta::TokenUsage::OrHash)).void }
45
45
  attr_writer :usage
46
46
 
47
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
48
+ sig { returns(T.nilable(String)) }
49
+ attr_reader :obfuscation
50
+
51
+ sig { params(obfuscation: String).void }
52
+ attr_writer :obfuscation
53
+
47
54
  # Emitted when a turn is cancelled.
48
55
  sig do
49
56
  params(
@@ -58,6 +65,8 @@ module OpenAI
58
65
 
59
66
  usage: T.nilable(OpenAI::Beta::TokenUsage::OrHash),
60
67
 
68
+ obfuscation: String,
69
+
61
70
  type: Symbol
62
71
  )
63
72
  .returns(T.attached_class)
@@ -79,6 +88,9 @@ module OpenAI
79
88
  # Token usage by the root agent during the turn, when available.
80
89
  usage:,
81
90
 
91
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
92
+ obfuscation: nil,
93
+
82
94
  # The type of the object. Always `agent.session.turn.cancelled`.
83
95
 
84
96
  type: :"agent.session.turn.cancelled"
@@ -93,7 +105,8 @@ module OpenAI
93
105
  turn: OpenAI::Beta::Agents::Sessions::Turn,
94
106
  turn_id: String,
95
107
  type: Symbol,
96
- usage: T.nilable(OpenAI::Beta::TokenUsage)
108
+ usage: T.nilable(OpenAI::Beta::TokenUsage),
109
+ obfuscation: String
97
110
  }
98
111
  )
99
112
  end
@@ -44,6 +44,13 @@ module OpenAI
44
44
  sig { params(usage: T.nilable(OpenAI::Beta::TokenUsage::OrHash)).void }
45
45
  attr_writer :usage
46
46
 
47
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
48
+ sig { returns(T.nilable(String)) }
49
+ attr_reader :obfuscation
50
+
51
+ sig { params(obfuscation: String).void }
52
+ attr_writer :obfuscation
53
+
47
54
  # Emitted when a turn completes.
48
55
  sig do
49
56
  params(
@@ -58,6 +65,8 @@ module OpenAI
58
65
 
59
66
  usage: T.nilable(OpenAI::Beta::TokenUsage::OrHash),
60
67
 
68
+ obfuscation: String,
69
+
61
70
  type: Symbol
62
71
  )
63
72
  .returns(T.attached_class)
@@ -79,6 +88,9 @@ module OpenAI
79
88
  # Token usage by the root agent during the turn, when available.
80
89
  usage:,
81
90
 
91
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
92
+ obfuscation: nil,
93
+
82
94
  # The type of the object. Always `agent.session.turn.completed`.
83
95
 
84
96
  type: :"agent.session.turn.completed"
@@ -93,7 +105,8 @@ module OpenAI
93
105
  turn: OpenAI::Beta::Agents::Sessions::Turn,
94
106
  turn_id: String,
95
107
  type: Symbol,
96
- usage: T.nilable(OpenAI::Beta::TokenUsage)
108
+ usage: T.nilable(OpenAI::Beta::TokenUsage),
109
+ obfuscation: String
97
110
  }
98
111
  )
99
112
  end
@@ -49,6 +49,13 @@ module OpenAI
49
49
  sig { returns(Symbol) }
50
50
  attr_accessor :type
51
51
 
52
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
53
+ sig { returns(T.nilable(String)) }
54
+ attr_reader :obfuscation
55
+
56
+ sig { params(obfuscation: String).void }
57
+ attr_writer :obfuscation
58
+
52
59
  # Emitted when an output text content part is added.
53
60
  sig do
54
61
  params(
@@ -67,6 +74,8 @@ module OpenAI
67
74
 
68
75
  turn_id: T.nilable(String),
69
76
 
77
+ obfuscation: String,
78
+
70
79
  type: Symbol
71
80
  )
72
81
  .returns(T.attached_class)
@@ -94,6 +103,9 @@ module OpenAI
94
103
  # The ID of the turn associated with the event, when applicable.
95
104
  turn_id:,
96
105
 
106
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
107
+ obfuscation: nil,
108
+
97
109
  # The type of the object. Always `agent.session.turn.content_part.added`.
98
110
 
99
111
  type: :"agent.session.turn.content_part.added"
@@ -110,7 +122,8 @@ module OpenAI
110
122
  part: OpenAI::Beta::OutputText,
111
123
  session_id: String,
112
124
  turn_id: T.nilable(String),
113
- type: Symbol
125
+ type: Symbol,
126
+ obfuscation: String
114
127
  }
115
128
  )
116
129
  end
@@ -49,6 +49,13 @@ module OpenAI
49
49
  sig { returns(Symbol) }
50
50
  attr_accessor :type
51
51
 
52
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
53
+ sig { returns(T.nilable(String)) }
54
+ attr_reader :obfuscation
55
+
56
+ sig { params(obfuscation: String).void }
57
+ attr_writer :obfuscation
58
+
52
59
  # Emitted when an output content part is complete.
53
60
  sig do
54
61
  params(
@@ -67,6 +74,8 @@ module OpenAI
67
74
 
68
75
  turn_id: T.nilable(String),
69
76
 
77
+ obfuscation: String,
78
+
70
79
  type: Symbol
71
80
  )
72
81
  .returns(T.attached_class)
@@ -94,6 +103,9 @@ module OpenAI
94
103
  # The ID of the turn associated with the event, when applicable.
95
104
  turn_id:,
96
105
 
106
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
107
+ obfuscation: nil,
108
+
97
109
  # The type of the object. Always `agent.session.turn.content_part.done`.
98
110
 
99
111
  type: :"agent.session.turn.content_part.done"
@@ -110,7 +122,8 @@ module OpenAI
110
122
  part: OpenAI::Beta::OutputText,
111
123
  session_id: String,
112
124
  turn_id: T.nilable(String),
113
- type: Symbol
125
+ type: Symbol,
126
+ obfuscation: String
114
127
  }
115
128
  )
116
129
  end
@@ -37,6 +37,13 @@ module OpenAI
37
37
  sig { returns(Symbol) }
38
38
  attr_accessor :type
39
39
 
40
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
41
+ sig { returns(T.nilable(String)) }
42
+ attr_reader :obfuscation
43
+
44
+ sig { params(obfuscation: String).void }
45
+ attr_writer :obfuscation
46
+
40
47
  # Emitted when a turn is created.
41
48
  sig do
42
49
  params(
@@ -49,6 +56,8 @@ module OpenAI
49
56
 
50
57
  turn_id: String,
51
58
 
59
+ obfuscation: String,
60
+
52
61
  type: Symbol
53
62
  )
54
63
  .returns(T.attached_class)
@@ -67,6 +76,9 @@ module OpenAI
67
76
  # The ID of the turn associated with the event.
68
77
  turn_id:,
69
78
 
79
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
80
+ obfuscation: nil,
81
+
70
82
  # The type of the object. Always `agent.session.turn.created`.
71
83
 
72
84
  type: :"agent.session.turn.created"
@@ -80,7 +92,8 @@ module OpenAI
80
92
  session_id: String,
81
93
  turn: OpenAI::Beta::Agents::Sessions::Turn,
82
94
  turn_id: String,
83
- type: Symbol
95
+ type: Symbol,
96
+ obfuscation: String
84
97
  }
85
98
  )
86
99
  end
@@ -44,6 +44,13 @@ module OpenAI
44
44
  sig { params(usage: T.nilable(OpenAI::Beta::TokenUsage::OrHash)).void }
45
45
  attr_writer :usage
46
46
 
47
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
48
+ sig { returns(T.nilable(String)) }
49
+ attr_reader :obfuscation
50
+
51
+ sig { params(obfuscation: String).void }
52
+ attr_writer :obfuscation
53
+
47
54
  # Emitted when a turn fails.
48
55
  sig do
49
56
  params(
@@ -58,6 +65,8 @@ module OpenAI
58
65
 
59
66
  usage: T.nilable(OpenAI::Beta::TokenUsage::OrHash),
60
67
 
68
+ obfuscation: String,
69
+
61
70
  type: Symbol
62
71
  )
63
72
  .returns(T.attached_class)
@@ -79,6 +88,9 @@ module OpenAI
79
88
  # Token usage by the root agent during the turn, when available.
80
89
  usage:,
81
90
 
91
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
92
+ obfuscation: nil,
93
+
82
94
  # The type of the object. Always `agent.session.turn.failed`.
83
95
 
84
96
  type: :"agent.session.turn.failed"
@@ -93,7 +105,8 @@ module OpenAI
93
105
  turn: OpenAI::Beta::Agents::Sessions::Turn,
94
106
  turn_id: String,
95
107
  type: Symbol,
96
- usage: T.nilable(OpenAI::Beta::TokenUsage)
108
+ usage: T.nilable(OpenAI::Beta::TokenUsage),
109
+ obfuscation: String
97
110
  }
98
111
  )
99
112
  end
@@ -37,6 +37,13 @@ module OpenAI
37
37
  sig { returns(Symbol) }
38
38
  attr_accessor :type
39
39
 
40
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
41
+ sig { returns(T.nilable(String)) }
42
+ attr_reader :obfuscation
43
+
44
+ sig { params(obfuscation: String).void }
45
+ attr_writer :obfuscation
46
+
40
47
  # Emitted when a turn starts running.
41
48
  sig do
42
49
  params(
@@ -49,6 +56,8 @@ module OpenAI
49
56
 
50
57
  turn_id: String,
51
58
 
59
+ obfuscation: String,
60
+
52
61
  type: Symbol
53
62
  )
54
63
  .returns(T.attached_class)
@@ -67,6 +76,9 @@ module OpenAI
67
76
  # The ID of the turn associated with the event.
68
77
  turn_id:,
69
78
 
79
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
80
+ obfuscation: nil,
81
+
70
82
  # The type of the object. Always `agent.session.turn.in_progress`.
71
83
 
72
84
  type: :"agent.session.turn.in_progress"
@@ -80,7 +92,8 @@ module OpenAI
80
92
  session_id: String,
81
93
  turn: OpenAI::Beta::Agents::Sessions::Turn,
82
94
  turn_id: String,
83
- type: Symbol
95
+ type: Symbol,
96
+ obfuscation: String
84
97
  }
85
98
  )
86
99
  end
@@ -38,6 +38,13 @@ module OpenAI
38
38
  sig { returns(Symbol) }
39
39
  attr_accessor :type
40
40
 
41
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
42
+ sig { returns(T.nilable(String)) }
43
+ attr_reader :obfuscation
44
+
45
+ sig { params(obfuscation: String).void }
46
+ attr_writer :obfuscation
47
+
41
48
  # Emitted when an item is added to a turn.
42
49
  sig do
43
50
  params(
@@ -70,6 +77,8 @@ module OpenAI
70
77
 
71
78
  turn_id: T.nilable(String),
72
79
 
80
+ obfuscation: String,
81
+
73
82
  type: Symbol
74
83
  )
75
84
  .returns(T.attached_class)
@@ -91,6 +100,9 @@ module OpenAI
91
100
  # The ID of the turn associated with the event, when applicable.
92
101
  turn_id:,
93
102
 
103
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
104
+ obfuscation: nil,
105
+
94
106
  # The type of the object. Always `agent.session.turn.item.added`.
95
107
 
96
108
  type: :"agent.session.turn.item.added"
@@ -105,7 +117,8 @@ module OpenAI
105
117
  output_index: T.nilable(Integer),
106
118
  session_id: String,
107
119
  turn_id: T.nilable(String),
108
- type: Symbol
120
+ type: Symbol,
121
+ obfuscation: String
109
122
  }
110
123
  )
111
124
  end
@@ -38,6 +38,13 @@ module OpenAI
38
38
  sig { returns(Symbol) }
39
39
  attr_accessor :type
40
40
 
41
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
42
+ sig { returns(T.nilable(String)) }
43
+ attr_reader :obfuscation
44
+
45
+ sig { params(obfuscation: String).void }
46
+ attr_writer :obfuscation
47
+
41
48
  # Emitted when an output item is complete.
42
49
  sig do
43
50
  params(
@@ -67,6 +74,8 @@ module OpenAI
67
74
 
68
75
  turn_id: T.nilable(String),
69
76
 
77
+ obfuscation: String,
78
+
70
79
  type: Symbol
71
80
  )
72
81
  .returns(T.attached_class)
@@ -88,6 +97,9 @@ module OpenAI
88
97
  # The ID of the turn associated with the event, when applicable.
89
98
  turn_id:,
90
99
 
100
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
101
+ obfuscation: nil,
102
+
91
103
  # The type of the object. Always `agent.session.turn.item.done`.
92
104
 
93
105
  type: :"agent.session.turn.item.done"
@@ -102,7 +114,8 @@ module OpenAI
102
114
  output_index: Integer,
103
115
  session_id: String,
104
116
  turn_id: T.nilable(String),
105
- type: Symbol
117
+ type: Symbol,
118
+ obfuscation: String
106
119
  }
107
120
  )
108
121
  end
@@ -46,6 +46,13 @@ module OpenAI
46
46
  sig { returns(Symbol) }
47
47
  attr_accessor :type
48
48
 
49
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
50
+ sig { returns(T.nilable(String)) }
51
+ attr_reader :obfuscation
52
+
53
+ sig { params(obfuscation: String).void }
54
+ attr_writer :obfuscation
55
+
49
56
  # Emitted when text is appended to an output text content part.
50
57
  sig do
51
58
  params(
@@ -64,6 +71,8 @@ module OpenAI
64
71
 
65
72
  turn_id: T.nilable(String),
66
73
 
74
+ obfuscation: String,
75
+
67
76
  type: Symbol
68
77
  )
69
78
  .returns(T.attached_class)
@@ -91,6 +100,9 @@ module OpenAI
91
100
  # The ID of the turn associated with the event, when applicable.
92
101
  turn_id:,
93
102
 
103
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
104
+ obfuscation: nil,
105
+
94
106
  # The type of the object. Always `agent.session.turn.output_text.delta`.
95
107
 
96
108
  type: :"agent.session.turn.output_text.delta"
@@ -107,7 +119,8 @@ module OpenAI
107
119
  output_index: Integer,
108
120
  session_id: String,
109
121
  turn_id: T.nilable(String),
110
- type: Symbol
122
+ type: Symbol,
123
+ obfuscation: String
111
124
  }
112
125
  )
113
126
  end
@@ -46,6 +46,13 @@ module OpenAI
46
46
  sig { returns(Symbol) }
47
47
  attr_accessor :type
48
48
 
49
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
50
+ sig { returns(T.nilable(String)) }
51
+ attr_reader :obfuscation
52
+
53
+ sig { params(obfuscation: String).void }
54
+ attr_writer :obfuscation
55
+
49
56
  # Emitted when an output text content part is complete.
50
57
  sig do
51
58
  params(
@@ -64,6 +71,8 @@ module OpenAI
64
71
 
65
72
  turn_id: T.nilable(String),
66
73
 
74
+ obfuscation: String,
75
+
67
76
  type: Symbol
68
77
  )
69
78
  .returns(T.attached_class)
@@ -91,6 +100,9 @@ module OpenAI
91
100
  # The ID of the turn associated with the event, when applicable.
92
101
  turn_id:,
93
102
 
103
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
104
+ obfuscation: nil,
105
+
94
106
  # The type of the object. Always `agent.session.turn.output_text.done`.
95
107
 
96
108
  type: :"agent.session.turn.output_text.done"
@@ -107,7 +119,8 @@ module OpenAI
107
119
  session_id: String,
108
120
  text: String,
109
121
  turn_id: T.nilable(String),
110
- type: Symbol
122
+ type: Symbol,
123
+ obfuscation: String
111
124
  }
112
125
  )
113
126
  end
@@ -50,6 +50,13 @@ module OpenAI
50
50
  sig { returns(Symbol) }
51
51
  attr_accessor :type
52
52
 
53
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
54
+ sig { returns(T.nilable(String)) }
55
+ attr_reader :obfuscation
56
+
57
+ sig { params(obfuscation: String).void }
58
+ attr_writer :obfuscation
59
+
53
60
  # Emitted when a reasoning summary content part is added.
54
61
  sig do
55
62
  params(
@@ -68,6 +75,8 @@ module OpenAI
68
75
 
69
76
  turn_id: T.nilable(String),
70
77
 
78
+ obfuscation: String,
79
+
71
80
  type: Symbol
72
81
  )
73
82
  .returns(T.attached_class)
@@ -95,6 +104,9 @@ module OpenAI
95
104
  # The ID of the turn associated with the event, when applicable.
96
105
  turn_id:,
97
106
 
107
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
108
+ obfuscation: nil,
109
+
98
110
  # The type of the object. Always
99
111
  # `agent.session.turn.reasoning_summary_part.added`.
100
112
 
@@ -112,7 +124,8 @@ module OpenAI
112
124
  session_id: String,
113
125
  summary_index: Integer,
114
126
  turn_id: T.nilable(String),
115
- type: Symbol
127
+ type: Symbol,
128
+ obfuscation: String
116
129
  }
117
130
  )
118
131
  end
@@ -53,6 +53,13 @@ module OpenAI
53
53
  sig { returns(Symbol) }
54
54
  attr_accessor :type
55
55
 
56
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
57
+ sig { returns(T.nilable(String)) }
58
+ attr_reader :obfuscation
59
+
60
+ sig { params(obfuscation: String).void }
61
+ attr_writer :obfuscation
62
+
56
63
  # Emitted when a reasoning summary part is complete.
57
64
  sig do
58
65
  params(
@@ -71,6 +78,8 @@ module OpenAI
71
78
 
72
79
  turn_id: T.nilable(String),
73
80
 
81
+ obfuscation: String,
82
+
74
83
  status: T.nilable(Symbol),
75
84
 
76
85
  type: Symbol
@@ -100,6 +109,9 @@ module OpenAI
100
109
  # The ID of the turn associated with the event, when applicable.
101
110
  turn_id:,
102
111
 
112
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
113
+ obfuscation: nil,
114
+
103
115
  # Present as `incomplete` when summary generation was interrupted.
104
116
  status: :incomplete,
105
117
 
@@ -120,7 +132,8 @@ module OpenAI
120
132
  status: T.nilable(Symbol),
121
133
  summary_index: Integer,
122
134
  turn_id: T.nilable(String),
123
- type: Symbol
135
+ type: Symbol,
136
+ obfuscation: String
124
137
  }
125
138
  )
126
139
  end
@@ -47,6 +47,13 @@ module OpenAI
47
47
  sig { returns(Symbol) }
48
48
  attr_accessor :type
49
49
 
50
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
51
+ sig { returns(T.nilable(String)) }
52
+ attr_reader :obfuscation
53
+
54
+ sig { params(obfuscation: String).void }
55
+ attr_writer :obfuscation
56
+
50
57
  # Emitted when text is appended to a reasoning summary.
51
58
  sig do
52
59
  params(
@@ -65,6 +72,8 @@ module OpenAI
65
72
 
66
73
  turn_id: T.nilable(String),
67
74
 
75
+ obfuscation: String,
76
+
68
77
  type: Symbol
69
78
  )
70
79
  .returns(T.attached_class)
@@ -92,6 +101,9 @@ module OpenAI
92
101
  # The ID of the turn associated with the event, when applicable.
93
102
  turn_id:,
94
103
 
104
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
105
+ obfuscation: nil,
106
+
95
107
  # The type of the object. Always
96
108
  # `agent.session.turn.reasoning_summary_text.delta`.
97
109
 
@@ -109,7 +121,8 @@ module OpenAI
109
121
  session_id: String,
110
122
  summary_index: Integer,
111
123
  turn_id: T.nilable(String),
112
- type: Symbol
124
+ type: Symbol,
125
+ obfuscation: String
113
126
  }
114
127
  )
115
128
  end
@@ -46,6 +46,13 @@ module OpenAI
46
46
  sig { returns(Symbol) }
47
47
  attr_accessor :type
48
48
 
49
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
50
+ sig { returns(T.nilable(String)) }
51
+ attr_reader :obfuscation
52
+
53
+ sig { params(obfuscation: String).void }
54
+ attr_writer :obfuscation
55
+
49
56
  # Emitted when a reasoning summary content part is complete.
50
57
  sig do
51
58
  params(
@@ -64,6 +71,8 @@ module OpenAI
64
71
 
65
72
  turn_id: T.nilable(String),
66
73
 
74
+ obfuscation: String,
75
+
67
76
  type: Symbol
68
77
  )
69
78
  .returns(T.attached_class)
@@ -91,6 +100,9 @@ module OpenAI
91
100
  # The ID of the turn associated with the event, when applicable.
92
101
  turn_id:,
93
102
 
103
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
104
+ obfuscation: nil,
105
+
94
106
  # The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
95
107
 
96
108
  type: :"agent.session.turn.reasoning_summary_text.done"
@@ -107,7 +119,8 @@ module OpenAI
107
119
  summary_index: Integer,
108
120
  text: String,
109
121
  turn_id: T.nilable(String),
110
- type: Symbol
122
+ type: Symbol,
123
+ obfuscation: String
111
124
  }
112
125
  )
113
126
  end