openai 0.98.0 → 0.100.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 (245) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/bedrock.md +17 -1
  5. data/lib/openai/client.rb +9 -0
  6. data/lib/openai/helpers/agents/session_stream.rb +11 -36
  7. data/lib/openai/helpers/agents/tools.rb +34 -4
  8. data/lib/openai/helpers/beta/agents/creation_stream.rb +26 -0
  9. data/lib/openai/helpers/beta/agents/function_tool.rb +11 -4
  10. data/lib/openai/helpers/beta/agents/tool_dispatcher.rb +74 -0
  11. data/lib/openai/helpers/beta/agents/tool_error.rb +28 -0
  12. data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +140 -5
  13. data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +140 -5
  14. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +140 -5
  15. data/lib/openai/models/admin/organization/usage_completions_params.rb +9 -4
  16. data/lib/openai/models/admin/organization/usage_completions_response.rb +140 -5
  17. data/lib/openai/models/admin/organization/usage_costs_params.rb +16 -4
  18. data/lib/openai/models/admin/organization/usage_costs_response.rb +140 -5
  19. data/lib/openai/models/admin/organization/usage_embeddings_response.rb +140 -5
  20. data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +140 -5
  21. data/lib/openai/models/admin/organization/usage_images_response.rb +140 -5
  22. data/lib/openai/models/admin/organization/usage_moderations_response.rb +140 -5
  23. data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +140 -5
  24. data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +9 -4
  25. data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +140 -5
  26. data/lib/openai/models/all_models.rb +42 -0
  27. data/lib/openai/models/audio/speech_create_params.rb +6 -0
  28. data/lib/openai/models/audio/voice.rb +75 -0
  29. data/lib/openai/models/audio/voice_create_params.rb +217 -0
  30. data/lib/openai/models/beta/agent_create_params.rb +0 -3
  31. data/lib/openai/models/beta/agent_update_params.rb +0 -3
  32. data/lib/openai/models/beta/agents/environments/template_create_params.rb +6 -6
  33. data/lib/openai/models/beta/agents/environments/template_update_params.rb +3 -6
  34. data/lib/openai/models/beta/agents/session_create_params.rb +0 -3
  35. data/lib/openai/models/beta/agents/session_update_params.rb +0 -3
  36. data/lib/openai/models/beta/agents/sessions/turns/item_list_params.rb +79 -0
  37. data/lib/openai/models/beta/beta_response.rb +220 -0
  38. data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +2 -2
  39. data/lib/openai/models/beta/beta_response_error.rb +12 -1
  40. data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
  41. data/lib/openai/models/beta/beta_responses_server_event.rb +12 -1
  42. data/lib/openai/models/beta/beta_tool.rb +15 -18
  43. data/lib/openai/models/beta/environment_param.rb +6 -6
  44. data/lib/openai/models/beta/response_compact_params.rb +220 -0
  45. data/lib/openai/models/beta/response_create_params.rb +220 -0
  46. data/lib/openai/models/beta/session_turn_error.rb +9 -0
  47. data/lib/openai/models/chat/chat_completion_audio_param.rb +6 -3
  48. data/lib/openai/models/chat/chat_completion_chunk.rb +85 -18
  49. data/lib/openai/models/chat_model.rb +178 -0
  50. data/lib/openai/models/error_object.rb +12 -1
  51. data/lib/openai/models/eval_create_params.rb +1 -1
  52. data/lib/openai/models/eval_create_response.rb +1 -1
  53. data/lib/openai/models/eval_list_response.rb +1 -1
  54. data/lib/openai/models/eval_retrieve_response.rb +1 -1
  55. data/lib/openai/models/eval_update_response.rb +1 -1
  56. data/lib/openai/models/fine_tuning/job_list_params.rb +14 -4
  57. data/lib/openai/models/graders/score_model_grader.rb +2 -2
  58. data/lib/openai/models/image.rb +14 -14
  59. data/lib/openai/models/image_create_variation_params.rb +7 -7
  60. data/lib/openai/models/image_edit_params.rb +88 -96
  61. data/lib/openai/models/image_generate_params.rb +51 -62
  62. data/lib/openai/models/image_model.rb +5 -3
  63. data/lib/openai/models/realtime/realtime_audio_config_output.rb +9 -6
  64. data/lib/openai/models/realtime/realtime_client_event.rb +9 -0
  65. data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +9 -6
  66. data/lib/openai/models/realtime/session_update_event.rb +16 -0
  67. data/lib/openai/models/responses/response_compact_params.rb +220 -0
  68. data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +2 -2
  69. data/lib/openai/models/responses/response_error.rb +12 -1
  70. data/lib/openai/models/responses/responses_server_event.rb +12 -1
  71. data/lib/openai/models/responses/tool.rb +15 -18
  72. data/lib/openai/models/responses_model.rb +42 -0
  73. data/lib/openai/models/video_create_error.rb +12 -1
  74. data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +109 -0
  75. data/lib/openai/models/webhooks/agent_session_created_webhook_event.rb +106 -0
  76. data/lib/openai/models/webhooks/agent_session_failed_webhook_event.rb +86 -0
  77. data/lib/openai/models/webhooks/agent_session_idle_webhook_event.rb +86 -0
  78. data/lib/openai/models/webhooks/agent_session_in_progress_webhook_event.rb +86 -0
  79. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +18 -2
  80. data/lib/openai/models/webhooks/webhook_create_params.rb +5 -0
  81. data/lib/openai/models/webhooks/webhook_test_params.rb +5 -0
  82. data/lib/openai/models/webhooks/webhook_update_params.rb +5 -0
  83. data/lib/openai/providers/bedrock.rb +20 -1
  84. data/lib/openai/resources/admin/organization/usage.rb +15 -6
  85. data/lib/openai/resources/audio/speech.rb +2 -0
  86. data/lib/openai/resources/audio/voices.rb +53 -0
  87. data/lib/openai/resources/audio.rb +5 -0
  88. data/lib/openai/resources/beta/agents/environments/templates.rb +3 -4
  89. data/lib/openai/resources/beta/agents/sessions/turns/items.rb +68 -0
  90. data/lib/openai/resources/beta/agents/sessions/turns.rb +4 -0
  91. data/lib/openai/resources/beta/agents/sessions.rb +22 -2
  92. data/lib/openai/resources/fine_tuning/jobs.rb +7 -2
  93. data/lib/openai/resources/images.rb +79 -109
  94. data/lib/openai/resources/webhooks.rb +1 -1
  95. data/lib/openai/version.rb +1 -1
  96. data/lib/openai.rb +10 -0
  97. data/rbi/openai/helpers/agents.rbi +2 -0
  98. data/rbi/openai/helpers/beta/agents/function_tool.rbi +8 -3
  99. data/rbi/openai/helpers/beta/agents/tool_error.rbi +19 -0
  100. data/rbi/openai/helpers/beta/agents.rbi +12 -0
  101. data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +213 -3
  102. data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +213 -3
  103. data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +213 -3
  104. data/rbi/openai/models/admin/organization/usage_completions_params.rbi +9 -4
  105. data/rbi/openai/models/admin/organization/usage_completions_response.rbi +213 -3
  106. data/rbi/openai/models/admin/organization/usage_costs_params.rbi +16 -4
  107. data/rbi/openai/models/admin/organization/usage_costs_response.rbi +213 -3
  108. data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +213 -3
  109. data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +213 -3
  110. data/rbi/openai/models/admin/organization/usage_images_response.rbi +213 -3
  111. data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +213 -3
  112. data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +213 -3
  113. data/rbi/openai/models/admin/organization/usage_web_search_calls_params.rbi +12 -4
  114. data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +213 -3
  115. data/rbi/openai/models/audio/speech_create_params.rbi +6 -0
  116. data/rbi/openai/models/audio/voice.rbi +111 -0
  117. data/rbi/openai/models/audio/voice_create_params.rbi +321 -0
  118. data/rbi/openai/models/beta/agent_create_params.rbi +0 -3
  119. data/rbi/openai/models/beta/agent_update_params.rbi +0 -3
  120. data/rbi/openai/models/beta/agents/environments/template_create_params.rbi +6 -6
  121. data/rbi/openai/models/beta/agents/environments/template_update_params.rbi +3 -6
  122. data/rbi/openai/models/beta/agents/session_create_params.rbi +0 -3
  123. data/rbi/openai/models/beta/agents/session_update_params.rbi +0 -3
  124. data/rbi/openai/models/beta/agents/sessions/turns/item_list_params.rbi +139 -0
  125. data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +2 -2
  126. data/rbi/openai/models/beta/beta_response_error.rbi +12 -0
  127. data/rbi/openai/models/beta/beta_responses_server_event.rbi +12 -0
  128. data/rbi/openai/models/beta/beta_tool.rbi +15 -18
  129. data/rbi/openai/models/beta/environment_param.rbi +6 -6
  130. data/rbi/openai/models/beta/session_turn_error.rbi +18 -0
  131. data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
  132. data/rbi/openai/models/chat/chat_completion_chunk.rbi +123 -17
  133. data/rbi/openai/models/error_object.rbi +12 -0
  134. data/rbi/openai/models/eval_create_params.rbi +1 -1
  135. data/rbi/openai/models/eval_create_response.rbi +1 -1
  136. data/rbi/openai/models/eval_list_response.rbi +1 -1
  137. data/rbi/openai/models/eval_retrieve_response.rbi +1 -1
  138. data/rbi/openai/models/eval_update_response.rbi +1 -1
  139. data/rbi/openai/models/fine_tuning/job_list_params.rbi +14 -4
  140. data/rbi/openai/models/graders/score_model_grader.rbi +2 -2
  141. data/rbi/openai/models/image.rbi +14 -14
  142. data/rbi/openai/models/image_create_variation_params.rbi +6 -6
  143. data/rbi/openai/models/image_edit_params.rbi +73 -91
  144. data/rbi/openai/models/image_generate_params.rbi +30 -61
  145. data/rbi/openai/models/image_model.rbi +3 -3
  146. data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +9 -6
  147. data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +9 -6
  148. data/rbi/openai/models/realtime/session_update_event.rbi +16 -0
  149. data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi +2 -2
  150. data/rbi/openai/models/responses/response_error.rbi +12 -0
  151. data/rbi/openai/models/responses/responses_server_event.rbi +12 -0
  152. data/rbi/openai/models/responses/tool.rbi +15 -18
  153. data/rbi/openai/models/video_create_error.rbi +12 -0
  154. data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +222 -0
  155. data/rbi/openai/models/webhooks/agent_session_created_webhook_event.rbi +202 -0
  156. data/rbi/openai/models/webhooks/agent_session_failed_webhook_event.rbi +151 -0
  157. data/rbi/openai/models/webhooks/agent_session_idle_webhook_event.rbi +151 -0
  158. data/rbi/openai/models/webhooks/agent_session_in_progress_webhook_event.rbi +151 -0
  159. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +7 -1
  160. data/rbi/openai/models/webhooks/webhook_create_params.rbi +20 -0
  161. data/rbi/openai/models/webhooks/webhook_test_params.rbi +20 -0
  162. data/rbi/openai/models/webhooks/webhook_update_params.rbi +20 -0
  163. data/rbi/openai/resources/admin/organization/usage.rbi +15 -6
  164. data/rbi/openai/resources/audio/speech.rbi +2 -0
  165. data/rbi/openai/resources/audio/voices.rbi +49 -0
  166. data/rbi/openai/resources/audio.rbi +4 -0
  167. data/rbi/openai/resources/beta/agents/environments/templates.rbi +3 -4
  168. data/rbi/openai/resources/beta/agents/sessions/turns/items.rbi +62 -0
  169. data/rbi/openai/resources/beta/agents/sessions/turns.rbi +3 -0
  170. data/rbi/openai/resources/beta/agents/sessions.rbi +2 -0
  171. data/rbi/openai/resources/fine_tuning/jobs.rbi +7 -2
  172. data/rbi/openai/resources/images.rbi +77 -109
  173. data/rbi/openai/resources/webhooks.rbi +5 -0
  174. data/sig/openai/helpers/agents.rbs +3 -0
  175. data/sig/openai/helpers/beta/agents/function_tool.rbs +5 -2
  176. data/sig/openai/helpers/beta/agents/tool_error.rbs +17 -0
  177. data/sig/openai/helpers/beta/agents.rbs +5 -0
  178. data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +107 -5
  179. data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +107 -5
  180. data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +107 -5
  181. data/sig/openai/models/admin/organization/usage_completions_params.rbs +14 -6
  182. data/sig/openai/models/admin/organization/usage_completions_response.rbs +107 -5
  183. data/sig/openai/models/admin/organization/usage_costs_params.rbs +25 -7
  184. data/sig/openai/models/admin/organization/usage_costs_response.rbs +107 -5
  185. data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +107 -5
  186. data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +107 -5
  187. data/sig/openai/models/admin/organization/usage_images_response.rbs +107 -5
  188. data/sig/openai/models/admin/organization/usage_moderations_response.rbs +107 -5
  189. data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +107 -5
  190. data/sig/openai/models/admin/organization/usage_web_search_calls_params.rbs +19 -7
  191. data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +107 -5
  192. data/sig/openai/models/audio/speech_create_params.rbs +4 -0
  193. data/sig/openai/models/audio/voice.rbs +70 -0
  194. data/sig/openai/models/audio/voice_create_params.rbs +203 -0
  195. data/sig/openai/models/beta/agent_create_params.rbs +1 -5
  196. data/sig/openai/models/beta/agent_update_params.rbs +1 -5
  197. data/sig/openai/models/beta/agents/environments/template_create_params.rbs +4 -4
  198. data/sig/openai/models/beta/agents/environments/template_update_params.rbs +2 -4
  199. data/sig/openai/models/beta/agents/session_create_params.rbs +1 -5
  200. data/sig/openai/models/beta/agents/session_update_params.rbs +1 -5
  201. data/sig/openai/models/beta/agents/sessions/turns/item_list_params.rbs +91 -0
  202. data/sig/openai/models/beta/beta_response_computer_tool_call_output_item.rbs +2 -2
  203. data/sig/openai/models/beta/beta_response_error.rbs +10 -0
  204. data/sig/openai/models/beta/beta_responses_server_event.rbs +10 -0
  205. data/sig/openai/models/beta/beta_tool.rbs +11 -15
  206. data/sig/openai/models/beta/environment_param.rbs +4 -4
  207. data/sig/openai/models/beta/session_turn_error.rbs +12 -0
  208. data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
  209. data/sig/openai/models/chat/chat_completion_chunk.rbs +96 -12
  210. data/sig/openai/models/error_object.rbs +10 -0
  211. data/sig/openai/models/eval_create_params.rbs +1 -1
  212. data/sig/openai/models/eval_create_response.rbs +1 -1
  213. data/sig/openai/models/eval_list_response.rbs +1 -1
  214. data/sig/openai/models/eval_retrieve_response.rbs +1 -1
  215. data/sig/openai/models/eval_update_response.rbs +1 -1
  216. data/sig/openai/models/fine_tuning/job_list_params.rbs +14 -4
  217. data/sig/openai/models/graders/score_model_grader.rbs +3 -3
  218. data/sig/openai/models/image.rbs +21 -21
  219. data/sig/openai/models/image_create_variation_params.rbs +4 -4
  220. data/sig/openai/models/image_edit_params.rbs +54 -66
  221. data/sig/openai/models/image_generate_params.rbs +23 -45
  222. data/sig/openai/models/image_model.rbs +6 -6
  223. data/sig/openai/models/realtime/realtime_audio_config_output.rbs +9 -6
  224. data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +9 -6
  225. data/sig/openai/models/responses/response_computer_tool_call_output_item.rbs +2 -2
  226. data/sig/openai/models/responses/response_error.rbs +10 -0
  227. data/sig/openai/models/responses/responses_server_event.rbs +10 -0
  228. data/sig/openai/models/responses/tool.rbs +11 -15
  229. data/sig/openai/models/video_create_error.rbs +10 -0
  230. data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +114 -0
  231. data/sig/openai/models/webhooks/agent_session_created_webhook_event.rbs +115 -0
  232. data/sig/openai/models/webhooks/agent_session_failed_webhook_event.rbs +89 -0
  233. data/sig/openai/models/webhooks/agent_session_idle_webhook_event.rbs +89 -0
  234. data/sig/openai/models/webhooks/agent_session_in_progress_webhook_event.rbs +89 -0
  235. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +6 -1
  236. data/sig/openai/models/webhooks/webhook_create_params.rbs +10 -0
  237. data/sig/openai/models/webhooks/webhook_test_params.rbs +10 -0
  238. data/sig/openai/models/webhooks/webhook_update_params.rbs +10 -0
  239. data/sig/openai/resources/audio/voices.rbs +14 -0
  240. data/sig/openai/resources/audio.rbs +2 -0
  241. data/sig/openai/resources/beta/agents/sessions/turns/items.rbs +24 -0
  242. data/sig/openai/resources/beta/agents/sessions/turns.rbs +2 -0
  243. data/sig/openai/resources/beta/agents/sessions.rbs +1 -0
  244. data/sig/openai/resources/webhooks.rbs +6 -1
  245. metadata +35 -1
@@ -92,6 +92,7 @@ module OpenAI
92
92
  {
93
93
  ?detailed_explanation: String,
94
94
  ?error_type: OpenAI::Models::Responses::ResponseError::Misalignment::error_type,
95
+ ?review_target: String?,
95
96
  ?steer: OpenAI::Responses::ResponseError::Misalignment::Steer
96
97
  }
97
98
 
@@ -110,6 +111,10 @@ module OpenAI
110
111
  OpenAI::Models::Responses::ResponseError::Misalignment::error_type
111
112
  ) -> OpenAI::Models::Responses::ResponseError::Misalignment::error_type
112
113
 
114
+ # An opaque target for explicitly continuing this review, or null when
115
+ # unavailable.
116
+ attr_accessor review_target: String?
117
+
113
118
  # An optional public continuation instruction.
114
119
  attr_reader steer: OpenAI::Responses::ResponseError::Misalignment::Steer?
115
120
 
@@ -122,17 +127,22 @@ module OpenAI
122
127
  # The public explanation for this block.
123
128
  # @param error_type
124
129
  # An optional classification; clients must accept additional values.
130
+ # @param review_target
131
+ # An opaque target for explicitly continuing this review, or null when
132
+ # unavailable.
125
133
  # @param steer
126
134
  # An optional public continuation instruction.
127
135
  def initialize: (
128
136
  ?detailed_explanation: String,
129
137
  ?error_type: OpenAI::Models::Responses::ResponseError::Misalignment::error_type,
138
+ ?review_target: String?,
130
139
  ?steer: OpenAI::Responses::ResponseError::Misalignment::Steer
131
140
  ) -> void
132
141
 
133
142
  def to_hash: -> {
134
143
  ?detailed_explanation: String,
135
144
  ?error_type: OpenAI::Models::Responses::ResponseError::Misalignment::error_type,
145
+ ?review_target: String?,
136
146
  ?steer: OpenAI::Responses::ResponseError::Misalignment::Steer
137
147
  }
138
148
 
@@ -3074,6 +3074,7 @@ module OpenAI
3074
3074
  {
3075
3075
  ?detailed_explanation: String,
3076
3076
  ?error_type: OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type,
3077
+ ?review_target: String?,
3077
3078
  ?steer: OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer
3078
3079
  }
3079
3080
 
@@ -3092,6 +3093,10 @@ module OpenAI
3092
3093
  OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type
3093
3094
  ) -> OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type
3094
3095
 
3096
+ # An opaque target for explicitly continuing this review, or null when
3097
+ # unavailable.
3098
+ attr_accessor review_target: String?
3099
+
3095
3100
  # An optional public continuation instruction.
3096
3101
  attr_reader steer: OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer?
3097
3102
 
@@ -3104,17 +3109,22 @@ module OpenAI
3104
3109
  # The public explanation for this block.
3105
3110
  # @param error_type
3106
3111
  # An optional classification; clients must accept additional values.
3112
+ # @param review_target
3113
+ # An opaque target for explicitly continuing this review, or null when
3114
+ # unavailable.
3107
3115
  # @param steer
3108
3116
  # An optional public continuation instruction.
3109
3117
  def initialize: (
3110
3118
  ?detailed_explanation: String,
3111
3119
  ?error_type: OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type,
3120
+ ?review_target: String?,
3112
3121
  ?steer: OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer
3113
3122
  ) -> void
3114
3123
 
3115
3124
  def to_hash: -> {
3116
3125
  ?detailed_explanation: String,
3117
3126
  ?error_type: OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type,
3127
+ ?review_target: String?,
3118
3128
  ?steer: OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer
3119
3129
  }
3120
3130
 
@@ -641,9 +641,10 @@ module OpenAI
641
641
  OpenAI::Models::Responses::Tool::ImageGeneration::background
642
642
  ) -> OpenAI::Models::Responses::Tool::ImageGeneration::background
643
643
 
644
- # Controls fidelity to the original input image(s). This parameter is supported
645
- # for GPT image models that support input fidelity. `gpt-image-2` and
646
- # `gpt-image-2-2026-04-21` ignore this parameter.
644
+ # Control how much effort the model will exert to match the style and features,
645
+ # especially facial features, of input images. Supports `high` and `low` on
646
+ # `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
647
+ # `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
647
648
  attr_accessor input_fidelity: OpenAI::Models::Responses::Tool::ImageGeneration::input_fidelity?
648
649
 
649
650
  # Optional mask for inpainting. Contains `image_url` (string, optional) and
@@ -727,9 +728,7 @@ module OpenAI
727
728
  # the maximum supported resolution is `3840x2160`. The requested size must also
728
729
  # satisfy the model's current pixel and edge limits. The standard sizes
729
730
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
730
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
731
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
732
- # `1024x1024`, `1792x1024`, or `1024x1792`.
731
+ # `auto` is supported for models that allow automatic sizing.
733
732
  attr_reader size: OpenAI::Models::Responses::Tool::ImageGeneration::size?
734
733
 
735
734
  # The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
@@ -741,9 +740,7 @@ module OpenAI
741
740
  # the maximum supported resolution is `3840x2160`. The requested size must also
742
741
  # satisfy the model's current pixel and edge limits. The standard sizes
743
742
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
744
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
745
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
746
- # `1024x1024`, `1792x1024`, or `1024x1792`.
743
+ # `auto` is supported for models that allow automatic sizing.
747
744
  def size=: (
748
745
  OpenAI::Models::Responses::Tool::ImageGeneration::size
749
746
  ) -> OpenAI::Models::Responses::Tool::ImageGeneration::size
@@ -761,9 +758,10 @@ module OpenAI
761
758
  # `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
762
759
  # set the output format to `png` or `webp`.
763
760
  # @param input_fidelity
764
- # Controls fidelity to the original input image(s). This parameter is supported
765
- # for GPT image models that support input fidelity. `gpt-image-2` and
766
- # `gpt-image-2-2026-04-21` ignore this parameter.
761
+ # Control how much effort the model will exert to match the style and features,
762
+ # especially facial features, of input images. Supports `high` and `low` on
763
+ # `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
764
+ # `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
767
765
  # @param input_image_mask
768
766
  # Optional mask for inpainting. Contains `image_url` (string, optional) and
769
767
  # `file_id` (string, optional).
@@ -798,9 +796,7 @@ module OpenAI
798
796
  # the maximum supported resolution is `3840x2160`. The requested size must also
799
797
  # satisfy the model's current pixel and edge limits. The standard sizes
800
798
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
801
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
802
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
803
- # `1024x1024`, `1792x1024`, or `1024x1792`.
799
+ # `auto` is supported for models that allow automatic sizing.
804
800
  # @param type
805
801
  # The type of the image generation tool. Always `image_generation`.
806
802
  def initialize: (
@@ -54,6 +54,7 @@ module OpenAI
54
54
  {
55
55
  ?detailed_explanation: String,
56
56
  ?error_type: OpenAI::Models::VideoCreateError::Misalignment::error_type,
57
+ ?review_target: String?,
57
58
  ?steer: OpenAI::VideoCreateError::Misalignment::Steer
58
59
  }
59
60
 
@@ -72,6 +73,10 @@ module OpenAI
72
73
  OpenAI::Models::VideoCreateError::Misalignment::error_type
73
74
  ) -> OpenAI::Models::VideoCreateError::Misalignment::error_type
74
75
 
76
+ # An opaque target for explicitly continuing this review, or null when
77
+ # unavailable.
78
+ attr_accessor review_target: String?
79
+
75
80
  # An optional public continuation instruction.
76
81
  attr_reader steer: OpenAI::VideoCreateError::Misalignment::Steer?
77
82
 
@@ -84,17 +89,22 @@ module OpenAI
84
89
  # The public explanation for this block.
85
90
  # @param error_type
86
91
  # An optional classification; clients must accept additional values.
92
+ # @param review_target
93
+ # An opaque target for explicitly continuing this review, or null when
94
+ # unavailable.
87
95
  # @param steer
88
96
  # An optional public continuation instruction.
89
97
  def initialize: (
90
98
  ?detailed_explanation: String,
91
99
  ?error_type: OpenAI::Models::VideoCreateError::Misalignment::error_type,
100
+ ?review_target: String?,
92
101
  ?steer: OpenAI::VideoCreateError::Misalignment::Steer
93
102
  ) -> void
94
103
 
95
104
  def to_hash: -> {
96
105
  ?detailed_explanation: String,
97
106
  ?error_type: OpenAI::Models::VideoCreateError::Misalignment::error_type,
107
+ ?review_target: String?,
98
108
  ?steer: OpenAI::VideoCreateError::Misalignment::Steer
99
109
  }
100
110
 
@@ -0,0 +1,114 @@
1
+ module OpenAI
2
+ module Models
3
+ module Webhooks
4
+ type agent_session_action_required_webhook_event =
5
+ {
6
+ id: String,
7
+ created_at: Integer,
8
+ data: OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data,
9
+ ?object: :event,
10
+ ?type: :"agent.session.action_required"
11
+ }
12
+
13
+ class AgentSessionActionRequiredWebhookEvent < OpenAI::Internal::Type::BaseModel
14
+ # The unique ID of the event.
15
+ attr_accessor id: String
16
+
17
+ # The Unix timestamp, in seconds, when the event was created.
18
+ attr_accessor created_at: Integer
19
+
20
+ attr_accessor data: OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data
21
+
22
+ # The object type. Always `event`.
23
+ attr_accessor object: :event
24
+
25
+ # The event type. Always `agent.session.action_required`.
26
+ attr_accessor type: :"agent.session.action_required"
27
+
28
+ # @param id
29
+ # The unique ID of the event.
30
+ # @param created_at
31
+ # The Unix timestamp, in seconds, when the event was created.
32
+ # @param object
33
+ # The object type. Always `event`.
34
+ # @param type
35
+ # The event type. Always `agent.session.action_required`.
36
+ def initialize: (
37
+ id: String,
38
+ created_at: Integer,
39
+ data: OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data,
40
+ ?object: :event,
41
+ ?type: :"agent.session.action_required"
42
+ ) -> void
43
+
44
+ def to_hash: -> {
45
+ id: String,
46
+ created_at: Integer,
47
+ data: OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data,
48
+ ?object: :event,
49
+ ?type: :"agent.session.action_required"
50
+ }
51
+
52
+ type data =
53
+ {
54
+ id: String,
55
+ required_action: OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction
56
+ }
57
+
58
+ class Data < OpenAI::Internal::Type::BaseModel
59
+ # The ID of the session.
60
+ attr_accessor id: String
61
+
62
+ # The action type. Retrieve the session for action details.
63
+ attr_accessor required_action: OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction
64
+
65
+ # @param id
66
+ # The ID of the session.
67
+ # @param required_action
68
+ # The action type. Retrieve the session for action details.
69
+ def initialize: (
70
+ id: String,
71
+ required_action: OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction
72
+ ) -> void
73
+
74
+ def to_hash: -> {
75
+ id: String,
76
+ required_action: OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction
77
+ }
78
+
79
+ type required_action =
80
+ {
81
+ type: OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::type_
82
+ }
83
+
84
+ class RequiredAction < OpenAI::Internal::Type::BaseModel
85
+ attr_accessor type: OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::type_
86
+
87
+ def initialize: (
88
+ type: OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::type_
89
+ ) -> void
90
+
91
+ def to_hash: -> {
92
+ type: OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::type_
93
+ }
94
+
95
+ type type_ =
96
+ :computer_use_approval_request
97
+ | :function_call
98
+ | :environment_connection
99
+
100
+ module Type
101
+ extend OpenAI::Internal::Type::Enum
102
+
103
+ COMPUTER_USE_APPROVAL_REQUEST: :computer_use_approval_request
104
+ FUNCTION_CALL: :function_call
105
+ ENVIRONMENT_CONNECTION: :environment_connection
106
+
107
+ def self?.values: -> ::Array[OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::type_]
108
+ end
109
+ end
110
+ end
111
+ end
112
+ end
113
+ end
114
+ end
@@ -0,0 +1,115 @@
1
+ module OpenAI
2
+ module Models
3
+ module Webhooks
4
+ type agent_session_created_webhook_event =
5
+ {
6
+ id: String,
7
+ created_at: Integer,
8
+ data: OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data,
9
+ ?object: :event,
10
+ ?type: :"agent.session.created"
11
+ }
12
+
13
+ class AgentSessionCreatedWebhookEvent < OpenAI::Internal::Type::BaseModel
14
+ # The unique ID of the event.
15
+ attr_accessor id: String
16
+
17
+ # The Unix timestamp, in seconds, when the event was created.
18
+ attr_accessor created_at: Integer
19
+
20
+ attr_accessor data: OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data
21
+
22
+ # The object type. Always `event`.
23
+ attr_accessor object: :event
24
+
25
+ # The event type. Always `agent.session.created`.
26
+ attr_accessor type: :"agent.session.created"
27
+
28
+ # @param id
29
+ # The unique ID of the event.
30
+ # @param created_at
31
+ # The Unix timestamp, in seconds, when the event was created.
32
+ # @param object
33
+ # The object type. Always `event`.
34
+ # @param type
35
+ # The event type. Always `agent.session.created`.
36
+ def initialize: (
37
+ id: String,
38
+ created_at: Integer,
39
+ data: OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data,
40
+ ?object: :event,
41
+ ?type: :"agent.session.created"
42
+ ) -> void
43
+
44
+ def to_hash: -> {
45
+ id: String,
46
+ created_at: Integer,
47
+ data: OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data,
48
+ ?object: :event,
49
+ ?type: :"agent.session.created"
50
+ }
51
+
52
+ type data =
53
+ {
54
+ id: String,
55
+ environment_type: String,
56
+ ?connect: OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect,
57
+ ?environment_id: String
58
+ }
59
+
60
+ class Data < OpenAI::Internal::Type::BaseModel
61
+ # The ID of the session.
62
+ attr_accessor id: String
63
+
64
+ # The environment type: `none`, `openai_hosted`, or `self_hosted`.
65
+ attr_accessor environment_type: String
66
+
67
+ attr_reader connect: OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect?
68
+
69
+ def connect=: (
70
+ OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect
71
+ ) -> OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect
72
+
73
+ # The ID of the environment, when one exists.
74
+ attr_reader environment_id: String?
75
+
76
+ # The ID of the environment, when one exists.
77
+ def environment_id=: (String) -> String
78
+
79
+ # @param id
80
+ # The ID of the session.
81
+ # @param environment_type
82
+ # The environment type: `none`, `openai_hosted`, or `self_hosted`.
83
+ # @param environment_id
84
+ # The ID of the environment, when one exists.
85
+ def initialize: (
86
+ id: String,
87
+ environment_type: String,
88
+ ?connect: OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect,
89
+ ?environment_id: String
90
+ ) -> void
91
+
92
+ def to_hash: -> {
93
+ id: String,
94
+ environment_type: String,
95
+ ?connect: OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect,
96
+ ?environment_id: String
97
+ }
98
+
99
+ type connect = { remote_url: String }
100
+
101
+ class Connect < OpenAI::Internal::Type::BaseModel
102
+ # The URL used to connect the self-hosted environment.
103
+ attr_accessor remote_url: String
104
+
105
+ # @param remote_url
106
+ # The URL used to connect the self-hosted environment.
107
+ def initialize: (remote_url: String) -> void
108
+
109
+ def to_hash: -> { remote_url: String }
110
+ end
111
+ end
112
+ end
113
+ end
114
+ end
115
+ end
@@ -0,0 +1,89 @@
1
+ module OpenAI
2
+ module Models
3
+ module Webhooks
4
+ type agent_session_failed_webhook_event =
5
+ {
6
+ id: String,
7
+ created_at: Integer,
8
+ data: OpenAI::Webhooks::AgentSessionFailedWebhookEvent::Data,
9
+ ?object: :event,
10
+ ?type: :"agent.session.failed"
11
+ }
12
+
13
+ class AgentSessionFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
14
+ # The unique ID of the event.
15
+ attr_accessor id: String
16
+
17
+ # The Unix timestamp, in seconds, when the event was created.
18
+ attr_accessor created_at: Integer
19
+
20
+ attr_accessor data: OpenAI::Webhooks::AgentSessionFailedWebhookEvent::Data
21
+
22
+ # The object type. Always `event`.
23
+ attr_accessor object: :event
24
+
25
+ # The event type. Always `agent.session.failed`.
26
+ attr_accessor type: :"agent.session.failed"
27
+
28
+ # @param id
29
+ # The unique ID of the event.
30
+ # @param created_at
31
+ # The Unix timestamp, in seconds, when the event was created.
32
+ # @param object
33
+ # The object type. Always `event`.
34
+ # @param type
35
+ # The event type. Always `agent.session.failed`.
36
+ def initialize: (
37
+ id: String,
38
+ created_at: Integer,
39
+ data: OpenAI::Webhooks::AgentSessionFailedWebhookEvent::Data,
40
+ ?object: :event,
41
+ ?type: :"agent.session.failed"
42
+ ) -> void
43
+
44
+ def to_hash: -> {
45
+ id: String,
46
+ created_at: Integer,
47
+ data: OpenAI::Webhooks::AgentSessionFailedWebhookEvent::Data,
48
+ ?object: :event,
49
+ ?type: :"agent.session.failed"
50
+ }
51
+
52
+ type data =
53
+ { id: String, environment_type: String, ?environment_id: String }
54
+
55
+ class Data < OpenAI::Internal::Type::BaseModel
56
+ # The ID of the session.
57
+ attr_accessor id: String
58
+
59
+ # The environment type: `none`, `openai_hosted`, or `self_hosted`.
60
+ attr_accessor environment_type: String
61
+
62
+ # The ID of the environment, when one exists.
63
+ attr_reader environment_id: String?
64
+
65
+ # The ID of the environment, when one exists.
66
+ def environment_id=: (String) -> String
67
+
68
+ # @param id
69
+ # The ID of the session.
70
+ # @param environment_type
71
+ # The environment type: `none`, `openai_hosted`, or `self_hosted`.
72
+ # @param environment_id
73
+ # The ID of the environment, when one exists.
74
+ def initialize: (
75
+ id: String,
76
+ environment_type: String,
77
+ ?environment_id: String
78
+ ) -> void
79
+
80
+ def to_hash: -> {
81
+ id: String,
82
+ environment_type: String,
83
+ ?environment_id: String
84
+ }
85
+ end
86
+ end
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,89 @@
1
+ module OpenAI
2
+ module Models
3
+ module Webhooks
4
+ type agent_session_idle_webhook_event =
5
+ {
6
+ id: String,
7
+ created_at: Integer,
8
+ data: OpenAI::Webhooks::AgentSessionIdleWebhookEvent::Data,
9
+ ?object: :event,
10
+ ?type: :"agent.session.idle"
11
+ }
12
+
13
+ class AgentSessionIdleWebhookEvent < OpenAI::Internal::Type::BaseModel
14
+ # The unique ID of the event.
15
+ attr_accessor id: String
16
+
17
+ # The Unix timestamp, in seconds, when the event was created.
18
+ attr_accessor created_at: Integer
19
+
20
+ attr_accessor data: OpenAI::Webhooks::AgentSessionIdleWebhookEvent::Data
21
+
22
+ # The object type. Always `event`.
23
+ attr_accessor object: :event
24
+
25
+ # The event type. Always `agent.session.idle`.
26
+ attr_accessor type: :"agent.session.idle"
27
+
28
+ # @param id
29
+ # The unique ID of the event.
30
+ # @param created_at
31
+ # The Unix timestamp, in seconds, when the event was created.
32
+ # @param object
33
+ # The object type. Always `event`.
34
+ # @param type
35
+ # The event type. Always `agent.session.idle`.
36
+ def initialize: (
37
+ id: String,
38
+ created_at: Integer,
39
+ data: OpenAI::Webhooks::AgentSessionIdleWebhookEvent::Data,
40
+ ?object: :event,
41
+ ?type: :"agent.session.idle"
42
+ ) -> void
43
+
44
+ def to_hash: -> {
45
+ id: String,
46
+ created_at: Integer,
47
+ data: OpenAI::Webhooks::AgentSessionIdleWebhookEvent::Data,
48
+ ?object: :event,
49
+ ?type: :"agent.session.idle"
50
+ }
51
+
52
+ type data =
53
+ { id: String, environment_type: String, ?environment_id: String }
54
+
55
+ class Data < OpenAI::Internal::Type::BaseModel
56
+ # The ID of the session.
57
+ attr_accessor id: String
58
+
59
+ # The environment type: `none`, `openai_hosted`, or `self_hosted`.
60
+ attr_accessor environment_type: String
61
+
62
+ # The ID of the environment, when one exists.
63
+ attr_reader environment_id: String?
64
+
65
+ # The ID of the environment, when one exists.
66
+ def environment_id=: (String) -> String
67
+
68
+ # @param id
69
+ # The ID of the session.
70
+ # @param environment_type
71
+ # The environment type: `none`, `openai_hosted`, or `self_hosted`.
72
+ # @param environment_id
73
+ # The ID of the environment, when one exists.
74
+ def initialize: (
75
+ id: String,
76
+ environment_type: String,
77
+ ?environment_id: String
78
+ ) -> void
79
+
80
+ def to_hash: -> {
81
+ id: String,
82
+ environment_type: String,
83
+ ?environment_id: String
84
+ }
85
+ end
86
+ end
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,89 @@
1
+ module OpenAI
2
+ module Models
3
+ module Webhooks
4
+ type agent_session_in_progress_webhook_event =
5
+ {
6
+ id: String,
7
+ created_at: Integer,
8
+ data: OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::Data,
9
+ ?object: :event,
10
+ ?type: :"agent.session.in_progress"
11
+ }
12
+
13
+ class AgentSessionInProgressWebhookEvent < OpenAI::Internal::Type::BaseModel
14
+ # The unique ID of the event.
15
+ attr_accessor id: String
16
+
17
+ # The Unix timestamp, in seconds, when the event was created.
18
+ attr_accessor created_at: Integer
19
+
20
+ attr_accessor data: OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::Data
21
+
22
+ # The object type. Always `event`.
23
+ attr_accessor object: :event
24
+
25
+ # The event type. Always `agent.session.in_progress`.
26
+ attr_accessor type: :"agent.session.in_progress"
27
+
28
+ # @param id
29
+ # The unique ID of the event.
30
+ # @param created_at
31
+ # The Unix timestamp, in seconds, when the event was created.
32
+ # @param object
33
+ # The object type. Always `event`.
34
+ # @param type
35
+ # The event type. Always `agent.session.in_progress`.
36
+ def initialize: (
37
+ id: String,
38
+ created_at: Integer,
39
+ data: OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::Data,
40
+ ?object: :event,
41
+ ?type: :"agent.session.in_progress"
42
+ ) -> void
43
+
44
+ def to_hash: -> {
45
+ id: String,
46
+ created_at: Integer,
47
+ data: OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::Data,
48
+ ?object: :event,
49
+ ?type: :"agent.session.in_progress"
50
+ }
51
+
52
+ type data =
53
+ { id: String, environment_type: String, ?environment_id: String }
54
+
55
+ class Data < OpenAI::Internal::Type::BaseModel
56
+ # The ID of the session.
57
+ attr_accessor id: String
58
+
59
+ # The environment type: `none`, `openai_hosted`, or `self_hosted`.
60
+ attr_accessor environment_type: String
61
+
62
+ # The ID of the environment, when one exists.
63
+ attr_reader environment_id: String?
64
+
65
+ # The ID of the environment, when one exists.
66
+ def environment_id=: (String) -> String
67
+
68
+ # @param id
69
+ # The ID of the session.
70
+ # @param environment_type
71
+ # The environment type: `none`, `openai_hosted`, or `self_hosted`.
72
+ # @param environment_id
73
+ # The ID of the environment, when one exists.
74
+ def initialize: (
75
+ id: String,
76
+ environment_type: String,
77
+ ?environment_id: String
78
+ ) -> void
79
+
80
+ def to_hash: -> {
81
+ id: String,
82
+ environment_type: String,
83
+ ?environment_id: String
84
+ }
85
+ end
86
+ end
87
+ end
88
+ end
89
+ end