openai 0.122.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 +24 -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 +69 -4
  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 +69 -4
  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 +112 -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 +115 -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 +73 -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 +73 -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
@@ -31,7 +31,7 @@ module OpenAI
31
31
  sig { params(data: T::Array[OpenAI::Image::OrHash]).void }
32
32
  attr_writer :data
33
33
 
34
- # The output format of the generated image.
34
+ # The output format of the generated or edited image.
35
35
  sig { returns(T.nilable(OpenAI::ImagesResponse::OutputFormat::TaggedSymbol)) }
36
36
  attr_reader :output_format
37
37
 
@@ -59,15 +59,14 @@ module OpenAI
59
59
  sig { params(size: T.any(String, OpenAI::ImagesResponse::Size::OrSymbol)).void }
60
60
  attr_writer :size
61
61
 
62
- # Token usage for the model that authored the SVG, separate from image rendering
63
- # usage.
62
+ # Token usage for SVG authoring, separate from image rendering usage.
64
63
  sig { returns(T.nilable(OpenAI::ImagesResponse::SvgUsage)) }
65
64
  attr_reader :svg_usage
66
65
 
67
66
  sig { params(svg_usage: OpenAI::ImagesResponse::SvgUsage::OrHash).void }
68
67
  attr_writer :svg_usage
69
68
 
70
- # For `gpt-image-1` only, the token usage information for the image generation.
69
+ # Token usage information for image generation with GPT Image models.
71
70
  sig { returns(T.nilable(OpenAI::ImagesResponse::Usage)) }
72
71
  attr_reader :usage
73
72
 
@@ -110,7 +109,7 @@ module OpenAI
110
109
  # The list of generated images.
111
110
  data: nil,
112
111
 
113
- # The output format of the generated image.
112
+ # The output format of the generated or edited image.
114
113
  output_format: nil,
115
114
 
116
115
  # The quality of the image generated. One of `low`, `medium`, `high`, `xhigh`, or
@@ -125,11 +124,10 @@ module OpenAI
125
124
  # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
126
125
  size: nil,
127
126
 
128
- # Token usage for the model that authored the SVG, separate from image rendering
129
- # usage.
127
+ # Token usage for SVG authoring, separate from image rendering usage.
130
128
  svg_usage: nil,
131
129
 
132
- # For `gpt-image-1` only, the token usage information for the image generation.
130
+ # Token usage information for image generation with GPT Image models.
133
131
 
134
132
  usage: nil
135
133
  )
@@ -169,7 +167,7 @@ module OpenAI
169
167
  end
170
168
  end
171
169
 
172
- # The output format of the generated image.
170
+ # The output format of the generated or edited image.
173
171
  module OutputFormat
174
172
  extend OpenAI::Internal::Type::Enum
175
173
 
@@ -255,8 +253,7 @@ module OpenAI
255
253
  sig { returns(Integer) }
256
254
  attr_accessor :total_tokens
257
255
 
258
- # Token usage for the model that authored the SVG, separate from image rendering
259
- # usage.
256
+ # Token usage for SVG authoring, separate from image rendering usage.
260
257
  sig do
261
258
  params(
262
259
 
@@ -336,7 +333,7 @@ module OpenAI
336
333
  sig { params(output_tokens_details: OpenAI::ImagesResponse::Usage::OutputTokensDetails::OrHash).void }
337
334
  attr_writer :output_tokens_details
338
335
 
339
- # For `gpt-image-1` only, the token usage information for the image generation.
336
+ # Token usage information for image generation with GPT Image models.
340
337
  sig do
341
338
  params(
342
339
 
@@ -93,6 +93,11 @@ module OpenAI
93
93
  sig { returns(T.nilable(String)) }
94
94
  attr_accessor :instructions
95
95
 
96
+ # A stable identifier for your end user, used for safety monitoring and abuse
97
+ # detection.
98
+ sig { returns(T.nilable(String)) }
99
+ attr_accessor :safety_identifier
100
+
96
101
  # Whether to store the session for later forking and recording download. Defaults
97
102
  # to false for new sessions.
98
103
  sig { returns(T.nilable(T::Boolean)) }
@@ -142,6 +147,8 @@ module OpenAI
142
147
 
143
148
  instructions: T.nilable(String),
144
149
 
150
+ safety_identifier: T.nilable(String),
151
+
145
152
  store: T::Boolean,
146
153
 
147
154
  triggers: T::Array[OpenAI::Live::DecisionTrigger::OrHash]
@@ -181,6 +188,10 @@ module OpenAI
181
188
  # server defaults. Immutable after startup.
182
189
  instructions: nil,
183
190
 
191
+ # A stable identifier for your end user, used for safety monitoring and abuse
192
+ # detection.
193
+ safety_identifier: nil,
194
+
184
195
  # Whether to store the session for later forking and recording download. Defaults
185
196
  # to false for new sessions.
186
197
  store: nil,
@@ -215,6 +226,7 @@ module OpenAI
215
226
  )
216
227
  ],
217
228
  instructions: T.nilable(String),
229
+ safety_identifier: T.nilable(String),
218
230
  store: T::Boolean,
219
231
  triggers: T::Array[OpenAI::Live::DecisionTrigger]
220
232
  }
@@ -146,6 +146,11 @@ module OpenAI
146
146
  sig { returns(T.nilable(String)) }
147
147
  attr_accessor :instructions
148
148
 
149
+ # A stable identifier for your end user, used for safety monitoring and abuse
150
+ # detection.
151
+ sig { returns(T.nilable(String)) }
152
+ attr_accessor :safety_identifier
153
+
149
154
  # Whether to store the session for later forking and recording download. Defaults
150
155
  # to false for new sessions.
151
156
  sig { returns(T.nilable(T::Boolean)) }
@@ -191,6 +196,8 @@ module OpenAI
191
196
 
192
197
  instructions: T.nilable(String),
193
198
 
199
+ safety_identifier: T.nilable(String),
200
+
194
201
  store: T::Boolean,
195
202
 
196
203
  triggers: T::Array[OpenAI::Live::DecisionTrigger::OrHash],
@@ -228,6 +235,10 @@ module OpenAI
228
235
  # server defaults. Immutable after startup.
229
236
  instructions: nil,
230
237
 
238
+ # A stable identifier for your end user, used for safety monitoring and abuse
239
+ # detection.
240
+ safety_identifier: nil,
241
+
231
242
  # Whether to store the session for later forking and recording download. Defaults
232
243
  # to false for new sessions.
233
244
  store: nil,
@@ -265,6 +276,7 @@ module OpenAI
265
276
  )
266
277
  ],
267
278
  instructions: T.nilable(String),
279
+ safety_identifier: T.nilable(String),
268
280
  store: T::Boolean,
269
281
  triggers: T::Array[OpenAI::Live::DecisionTrigger]
270
282
  }
@@ -134,11 +134,15 @@ module OpenAI
134
134
  }
135
135
  attr_accessor :tools
136
136
 
137
- # The truncation strategy to use for the model response. - `auto`: If the input to
138
- # this Response exceeds the model's context window size, the model will truncate
139
- # the response to fit the context window by dropping items from the beginning of
140
- # the conversation. - `disabled` (default): If the input size will exceed the
141
- # context window size for a model, the request will fail with a 400 error.
137
+ # The truncation strategy to use for the model response.
138
+ #
139
+ # - `auto`: If the input to this Response exceeds the model's context window size,
140
+ # the model will truncate the response to fit the context window by dropping
141
+ # items from the beginning of the conversation. On some models, trimming can
142
+ # begin earlier because the API subtracts the model's maximum output allowance
143
+ # from its input limit before counting tokens.
144
+ # - `disabled` (default): If the input size will exceed the context window size
145
+ # for a model, the request will fail with a 400 error.
142
146
  sig { returns(T.nilable(OpenAI::Responses::InputTokenCountParams::Truncation::OrSymbol)) }
143
147
  attr_reader :truncation
144
148
 
@@ -265,11 +269,15 @@ module OpenAI
265
269
  # specify which tool to use by setting the `tool_choice` parameter.
266
270
  tools: nil,
267
271
 
268
- # The truncation strategy to use for the model response. - `auto`: If the input to
269
- # this Response exceeds the model's context window size, the model will truncate
270
- # the response to fit the context window by dropping items from the beginning of
271
- # the conversation. - `disabled` (default): If the input size will exceed the
272
- # context window size for a model, the request will fail with a 400 error.
272
+ # The truncation strategy to use for the model response.
273
+ #
274
+ # - `auto`: If the input to this Response exceeds the model's context window size,
275
+ # the model will truncate the response to fit the context window by dropping
276
+ # items from the beginning of the conversation. On some models, trimming can
277
+ # begin earlier because the API subtracts the model's maximum output allowance
278
+ # from its input limit before counting tokens.
279
+ # - `disabled` (default): If the input size will exceed the context window size
280
+ # for a model, the request will fail with a 400 error.
273
281
  truncation: nil,
274
282
 
275
283
  request_options: {}
@@ -581,11 +589,15 @@ module OpenAI
581
589
 
582
590
  end
583
591
 
584
- # The truncation strategy to use for the model response. - `auto`: If the input to
585
- # this Response exceeds the model's context window size, the model will truncate
586
- # the response to fit the context window by dropping items from the beginning of
587
- # the conversation. - `disabled` (default): If the input size will exceed the
588
- # context window size for a model, the request will fail with a 400 error.
592
+ # The truncation strategy to use for the model response.
593
+ #
594
+ # - `auto`: If the input to this Response exceeds the model's context window size,
595
+ # the model will truncate the response to fit the context window by dropping
596
+ # items from the beginning of the conversation. On some models, trimming can
597
+ # begin earlier because the API subtracts the model's maximum output allowance
598
+ # from its input limit before counting tokens.
599
+ # - `disabled` (default): If the input size will exceed the context window size
600
+ # for a model, the request will fail with a 400 error.
589
601
  module Truncation
590
602
  extend OpenAI::Internal::Type::Enum
591
603
 
@@ -153,6 +153,13 @@ module OpenAI
153
153
  sig { params(image: OpenAI::Responses::Response::Image::OrHash).void }
154
154
  attr_writer :image
155
155
 
156
+ # Reasoning inputs withheld from the model, in input order.
157
+ sig { returns(T.nilable(T::Array[OpenAI::Responses::Response::InputTransformation])) }
158
+ attr_reader :input_transformations
159
+
160
+ sig { params(input_transformations: T::Array[OpenAI::Responses::Response::InputTransformation::OrHash]).void }
161
+ attr_writer :input_transformations
162
+
156
163
  # An upper bound for the number of tokens that can be generated for a response,
157
164
  # including visible output tokens and
158
165
  # [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
@@ -333,7 +340,9 @@ module OpenAI
333
340
  #
334
341
  # - `auto`: If the input to this Response exceeds the model's context window size,
335
342
  # the model will truncate the response to fit the context window by dropping
336
- # items from the beginning of the conversation.
343
+ # items from the beginning of the conversation. On some models, trimming can
344
+ # begin earlier because the API subtracts the model's maximum output allowance
345
+ # from its input limit, even if you set a lower `max_output_tokens`.
337
346
  # - `disabled` (default): If the input size will exceed the context window size
338
347
  # for a model, the request will fail with a 400 error.
339
348
  sig { returns(T.nilable(OpenAI::Responses::Response::Truncation::TaggedSymbol)) }
@@ -457,6 +466,8 @@ module OpenAI
457
466
 
458
467
  image: OpenAI::Responses::Response::Image::OrHash,
459
468
 
469
+ input_transformations: T::Array[OpenAI::Responses::Response::InputTransformation::OrHash],
470
+
460
471
  max_output_tokens: T.nilable(Integer),
461
472
 
462
473
  max_tool_calls: T.nilable(Integer),
@@ -608,6 +619,9 @@ module OpenAI
608
619
 
609
620
  image: nil,
610
621
 
622
+ # Reasoning inputs withheld from the model, in input order.
623
+ input_transformations: nil,
624
+
611
625
  # An upper bound for the number of tokens that can be generated for a response,
612
626
  # including visible output tokens and
613
627
  # [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
@@ -738,7 +752,9 @@ module OpenAI
738
752
  #
739
753
  # - `auto`: If the input to this Response exceeds the model's context window size,
740
754
  # the model will truncate the response to fit the context window by dropping
741
- # items from the beginning of the conversation.
755
+ # items from the beginning of the conversation. On some models, trimming can
756
+ # begin earlier because the API subtracts the model's maximum output allowance
757
+ # from its input limit, even if you set a lower `max_output_tokens`.
742
758
  # - `disabled` (default): If the input size will exceed the context window size
743
759
  # for a model, the request will fail with a 400 error.
744
760
  truncation: nil,
@@ -782,6 +798,7 @@ module OpenAI
782
798
  completed_at: T.nilable(Float),
783
799
  conversation: T.nilable(OpenAI::Responses::Response::Conversation),
784
800
  image: OpenAI::Responses::Response::Image,
801
+ input_transformations: T::Array[OpenAI::Responses::Response::InputTransformation],
785
802
  max_output_tokens: T.nilable(Integer),
786
803
  max_tool_calls: T.nilable(Integer),
787
804
  moderation: T.nilable(OpenAI::Responses::Response::Moderation),
@@ -1102,6 +1119,99 @@ module OpenAI
1102
1119
  end
1103
1120
  end
1104
1121
 
1122
+ class InputTransformation < OpenAI::Internal::Type::BaseModel
1123
+ OrHash = T.type_alias do
1124
+ T.any(
1125
+ OpenAI::Responses::Response::InputTransformation,
1126
+ OpenAI::Internal::AnyHash
1127
+ )
1128
+ end
1129
+
1130
+ # The original reasoning item ID.
1131
+ sig { returns(String) }
1132
+ attr_accessor :id
1133
+
1134
+ sig { returns(Symbol) }
1135
+ attr_accessor :action
1136
+
1137
+ sig { returns(OpenAI::Responses::Response::InputTransformation::Reason::TaggedSymbol) }
1138
+ attr_accessor :reason
1139
+
1140
+ sig { returns(Symbol) }
1141
+ attr_accessor :type
1142
+
1143
+ sig do
1144
+ params(
1145
+
1146
+ id: String,
1147
+
1148
+ reason: OpenAI::Responses::Response::InputTransformation::Reason::OrSymbol,
1149
+
1150
+ action: Symbol,
1151
+
1152
+ type: Symbol
1153
+ )
1154
+ .returns(T.attached_class)
1155
+ end
1156
+ def self.new(
1157
+
1158
+ # The original reasoning item ID.
1159
+ id:,
1160
+
1161
+ reason:,
1162
+
1163
+ action: :removed,
1164
+
1165
+ type: :reasoning
1166
+ )
1167
+ end
1168
+
1169
+ sig do
1170
+ override.returns(
1171
+ {
1172
+ id: String,
1173
+ action: Symbol,
1174
+ reason: OpenAI::Responses::Response::InputTransformation::Reason::TaggedSymbol,
1175
+ type: Symbol
1176
+ }
1177
+ )
1178
+ end
1179
+ def to_hash
1180
+ end
1181
+
1182
+ module Reason
1183
+ extend OpenAI::Internal::Type::Enum
1184
+
1185
+ TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Responses::Response::InputTransformation::Reason) }
1186
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1187
+
1188
+ ORGANIZATION_MISMATCH = T.let(
1189
+ :organization_mismatch,
1190
+ OpenAI::Responses::Response::InputTransformation::Reason::TaggedSymbol
1191
+ )
1192
+ END_USER_MISMATCH = T.let(
1193
+ :end_user_mismatch,
1194
+ OpenAI::Responses::Response::InputTransformation::Reason::TaggedSymbol
1195
+ )
1196
+ MODEL_MISMATCH = T.let(
1197
+ :model_mismatch,
1198
+ OpenAI::Responses::Response::InputTransformation::Reason::TaggedSymbol
1199
+ )
1200
+ PREFIX_MISMATCH = T.let(
1201
+ :prefix_mismatch,
1202
+ OpenAI::Responses::Response::InputTransformation::Reason::TaggedSymbol
1203
+ )
1204
+ TURN_BOUNDARY = T.let(
1205
+ :turn_boundary,
1206
+ OpenAI::Responses::Response::InputTransformation::Reason::TaggedSymbol
1207
+ )
1208
+
1209
+ sig { override.returns(T::Array[OpenAI::Responses::Response::InputTransformation::Reason::TaggedSymbol]) }
1210
+ def self.values
1211
+ end
1212
+ end
1213
+ end
1214
+
1105
1215
  class Moderation < OpenAI::Internal::Type::BaseModel
1106
1216
  OrHash = T.type_alias do
1107
1217
  T.any(
@@ -2365,7 +2475,9 @@ module OpenAI
2365
2475
  #
2366
2476
  # - `auto`: If the input to this Response exceeds the model's context window size,
2367
2477
  # the model will truncate the response to fit the context window by dropping
2368
- # items from the beginning of the conversation.
2478
+ # items from the beginning of the conversation. On some models, trimming can
2479
+ # begin earlier because the API subtracts the model's maximum output allowance
2480
+ # from its input limit, even if you set a lower `max_output_tokens`.
2369
2481
  # - `disabled` (default): If the input size will exceed the context window size
2370
2482
  # for a model, the request will fail with a 400 error.
2371
2483
  module Truncation
@@ -416,7 +416,9 @@ module OpenAI
416
416
  #
417
417
  # - `auto`: If the input to this Response exceeds the model's context window size,
418
418
  # the model will truncate the response to fit the context window by dropping
419
- # items from the beginning of the conversation.
419
+ # items from the beginning of the conversation. On some models, trimming can
420
+ # begin earlier because the API subtracts the model's maximum output allowance
421
+ # from its input limit, even if you set a lower `max_output_tokens`.
420
422
  # - `disabled` (default): If the input size will exceed the context window size
421
423
  # for a model, the request will fail with a 400 error.
422
424
  sig { returns(T.nilable(OpenAI::Responses::ResponseCreateParams::Truncation::OrSymbol)) }
@@ -774,7 +776,9 @@ module OpenAI
774
776
  #
775
777
  # - `auto`: If the input to this Response exceeds the model's context window size,
776
778
  # the model will truncate the response to fit the context window by dropping
777
- # items from the beginning of the conversation.
779
+ # items from the beginning of the conversation. On some models, trimming can
780
+ # begin earlier because the API subtracts the model's maximum output allowance
781
+ # from its input limit, even if you set a lower `max_output_tokens`.
778
782
  # - `disabled` (default): If the input size will exceed the context window size
779
783
  # for a model, the request will fail with a 400 error.
780
784
  truncation: nil,
@@ -1690,7 +1694,9 @@ module OpenAI
1690
1694
  #
1691
1695
  # - `auto`: If the input to this Response exceeds the model's context window size,
1692
1696
  # the model will truncate the response to fit the context window by dropping
1693
- # items from the beginning of the conversation.
1697
+ # items from the beginning of the conversation. On some models, trimming can
1698
+ # begin earlier because the API subtracts the model's maximum output allowance
1699
+ # from its input limit, even if you set a lower `max_output_tokens`.
1694
1700
  # - `disabled` (default): If the input size will exceed the context window size
1695
1701
  # for a model, the request will fail with a 400 error.
1696
1702
  module Truncation
@@ -1365,7 +1365,8 @@ module OpenAI
1365
1365
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
1366
1366
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
1367
1367
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
1368
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
1368
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
1369
+ # `gpt-image-2.6-sunburst`.
1369
1370
  #
1370
1371
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
1371
1372
  # `gpt-image-2.5-flare` instead.
@@ -1606,7 +1607,8 @@ module OpenAI
1606
1607
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
1607
1608
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
1608
1609
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
1609
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
1610
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
1611
+ # `gpt-image-2.6-sunburst`.
1610
1612
  #
1611
1613
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
1612
1614
  # `gpt-image-2.5-flare` instead.
@@ -1897,7 +1899,8 @@ module OpenAI
1897
1899
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
1898
1900
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
1899
1901
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
1900
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
1902
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
1903
+ # `gpt-image-2.6-sunburst`.
1901
1904
  #
1902
1905
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
1903
1906
  # `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
  sig { returns(T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Truncation::OrSymbol)) }
@@ -870,7 +872,9 @@ module OpenAI
870
872
  #
871
873
  # - `auto`: If the input to this Response exceeds the model's context window size,
872
874
  # the model will truncate the response to fit the context window by dropping
873
- # items from the beginning of the conversation.
875
+ # items from the beginning of the conversation. On some models, trimming can
876
+ # begin earlier because the API subtracts the model's maximum output allowance
877
+ # from its input limit, even if you set a lower `max_output_tokens`.
874
878
  # - `disabled` (default): If the input size will exceed the context window size
875
879
  # for a model, the request will fail with a 400 error.
876
880
  truncation: nil,
@@ -1952,7 +1956,9 @@ module OpenAI
1952
1956
  #
1953
1957
  # - `auto`: If the input to this Response exceeds the model's context window size,
1954
1958
  # the model will truncate the response to fit the context window by dropping
1955
- # items from the beginning of the conversation.
1959
+ # items from the beginning of the conversation. On some models, trimming can
1960
+ # begin earlier because the API subtracts the model's maximum output allowance
1961
+ # from its input limit, even if you set a lower `max_output_tokens`.
1956
1962
  # - `disabled` (default): If the input size will exceed the context window size
1957
1963
  # for a model, the request will fail with a 400 error.
1958
1964
  module Truncation
@@ -1022,7 +1022,8 @@ module OpenAI
1022
1022
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
1023
1023
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
1024
1024
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
1025
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
1025
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
1026
+ # `gpt-image-2.6-sunburst`.
1026
1027
  #
1027
1028
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
1028
1029
  # `gpt-image-2.5-flare` instead.
@@ -1184,7 +1185,8 @@ module OpenAI
1184
1185
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
1185
1186
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
1186
1187
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
1187
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
1188
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
1189
+ # `gpt-image-2.6-sunburst`.
1188
1190
  #
1189
1191
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
1190
1192
  # `gpt-image-2.5-flare` instead.
@@ -1399,7 +1401,8 @@ module OpenAI
1399
1401
  # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
1400
1402
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
1401
1403
  # `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
1402
- # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
1404
+ # `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
1405
+ # `gpt-image-2.6-sunburst`.
1403
1406
  #
1404
1407
  # `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
1405
1408
  # `gpt-image-2.5-flare` instead.
@@ -20,8 +20,9 @@ module OpenAI
20
20
  sig { returns(String) }
21
21
  attr_accessor :message
22
22
 
23
- # The Retry-After and Retry-After-Ms headers returned with the original error, if
24
- # any.
23
+ # Headers returned with the original error. These can include Retry-After,
24
+ # Retry-After-Ms, and, on opted-in deployments,
25
+ # x-openai-inference-capacity-reason.
25
26
  sig { returns(T.nilable(T::Hash[Symbol, String])) }
26
27
  attr_reader :headers
27
28
 
@@ -68,8 +69,9 @@ module OpenAI
68
69
  # A human-readable description of the error that was returned.
69
70
  message:,
70
71
 
71
- # The Retry-After and Retry-After-Ms headers returned with the original error, if
72
- # any.
72
+ # Headers returned with the original error. These can include Retry-After,
73
+ # Retry-After-Ms, and, on opted-in deployments,
74
+ # x-openai-inference-capacity-reason.
73
75
  headers: nil,
74
76
 
75
77
  misalignment: nil,
@@ -192,6 +192,10 @@ module OpenAI
192
192
  :computer_use_approval_request,
193
193
  OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type::TaggedSymbol
194
194
  )
195
+ MCP_APPROVAL_REQUEST = T.let(
196
+ :mcp_approval_request,
197
+ OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type::TaggedSymbol
198
+ )
195
199
  FUNCTION_CALL = T.let(
196
200
  :function_call,
197
201
  OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type::TaggedSymbol