openai 0.68.0 → 0.69.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 (701) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +23 -0
  3. data/README.md +7 -7
  4. data/lib/openai/internal/type/enum.rb +6 -6
  5. data/lib/openai/internal/util.rb +14 -2
  6. data/lib/openai/models/beta/assistant_create_params.rb +7 -14
  7. data/lib/openai/models/beta/assistant_update_params.rb +7 -14
  8. data/lib/openai/models/beta/beta_apply_patch_tool.rb +44 -0
  9. data/lib/openai/models/beta/beta_compacted_response.rb +58 -0
  10. data/lib/openai/models/beta/beta_computer_action.rb +398 -0
  11. data/lib/openai/models/beta/beta_computer_action_list.rb +13 -0
  12. data/lib/openai/models/beta/beta_computer_tool.rb +23 -0
  13. data/lib/openai/models/beta/beta_computer_use_preview_tool.rb +63 -0
  14. data/lib/openai/models/beta/beta_container_auto.rb +96 -0
  15. data/lib/openai/models/beta/beta_container_network_policy_allowlist.rb +37 -0
  16. data/lib/openai/models/beta/beta_container_network_policy_disabled.rb +20 -0
  17. data/lib/openai/models/beta/beta_container_network_policy_domain_secret.rb +36 -0
  18. data/lib/openai/models/beta/beta_container_reference.rb +28 -0
  19. data/lib/openai/models/beta/beta_custom_tool.rb +148 -0
  20. data/lib/openai/models/beta/beta_easy_input_message.rb +120 -0
  21. data/lib/openai/models/beta/beta_file_search_tool.rb +424 -0
  22. data/lib/openai/models/beta/beta_function_shell_tool.rb +67 -0
  23. data/lib/openai/models/beta/beta_function_tool.rb +97 -0
  24. data/lib/openai/models/beta/beta_inline_skill.rb +44 -0
  25. data/lib/openai/models/beta/beta_inline_skill_source.rb +38 -0
  26. data/lib/openai/models/beta/beta_local_environment.rb +28 -0
  27. data/lib/openai/models/beta/beta_local_skill.rb +36 -0
  28. data/lib/openai/models/beta/beta_namespace_tool.rb +146 -0
  29. data/lib/openai/models/beta/beta_response.rb +1425 -0
  30. data/lib/openai/models/beta/beta_response_apply_patch_tool_call.rb +258 -0
  31. data/lib/openai/models/beta/beta_response_apply_patch_tool_call_output.rb +156 -0
  32. data/lib/openai/models/beta/beta_response_audio_delta_event.rb +63 -0
  33. data/lib/openai/models/beta/beta_response_audio_done_event.rb +55 -0
  34. data/lib/openai/models/beta/beta_response_audio_transcript_delta_event.rb +63 -0
  35. data/lib/openai/models/beta/beta_response_audio_transcript_done_event.rb +55 -0
  36. data/lib/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rb +81 -0
  37. data/lib/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rb +76 -0
  38. data/lib/openai/models/beta/beta_response_code_interpreter_call_completed_event.rb +73 -0
  39. data/lib/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rb +77 -0
  40. data/lib/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rb +77 -0
  41. data/lib/openai/models/beta/beta_response_code_interpreter_tool_call.rb +168 -0
  42. data/lib/openai/models/beta/beta_response_compaction_item.rb +69 -0
  43. data/lib/openai/models/beta/beta_response_compaction_item_param.rb +61 -0
  44. data/lib/openai/models/beta/beta_response_completed_event.rb +63 -0
  45. data/lib/openai/models/beta/beta_response_computer_tool_call.rb +156 -0
  46. data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +141 -0
  47. data/lib/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rb +43 -0
  48. data/lib/openai/models/beta/beta_response_container_reference.rb +29 -0
  49. data/lib/openai/models/beta/beta_response_content.rb +56 -0
  50. data/lib/openai/models/beta/beta_response_content_part_added_event.rb +129 -0
  51. data/lib/openai/models/beta/beta_response_content_part_done_event.rb +129 -0
  52. data/lib/openai/models/beta/beta_response_conversation_param.rb +22 -0
  53. data/lib/openai/models/beta/beta_response_created_event.rb +63 -0
  54. data/lib/openai/models/beta/beta_response_custom_tool_call.rb +142 -0
  55. data/lib/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rb +76 -0
  56. data/lib/openai/models/beta/beta_response_custom_tool_call_input_done_event.rb +76 -0
  57. data/lib/openai/models/beta/beta_response_custom_tool_call_item.rb +55 -0
  58. data/lib/openai/models/beta/beta_response_custom_tool_call_output.rb +171 -0
  59. data/lib/openai/models/beta/beta_response_custom_tool_call_output_item.rb +55 -0
  60. data/lib/openai/models/beta/beta_response_error.rb +63 -0
  61. data/lib/openai/models/beta/beta_response_error_event.rb +79 -0
  62. data/lib/openai/models/beta/beta_response_failed_event.rb +63 -0
  63. data/lib/openai/models/beta/beta_response_file_search_call_completed_event.rb +72 -0
  64. data/lib/openai/models/beta/beta_response_file_search_call_in_progress_event.rb +72 -0
  65. data/lib/openai/models/beta/beta_response_file_search_call_searching_event.rb +72 -0
  66. data/lib/openai/models/beta/beta_response_file_search_tool_call.rb +168 -0
  67. data/lib/openai/models/beta/beta_response_format_text_config.rb +72 -0
  68. data/lib/openai/models/beta/beta_response_format_text_json_schema_config.rb +66 -0
  69. data/lib/openai/models/beta/beta_response_function_call_arguments_delta_event.rb +80 -0
  70. data/lib/openai/models/beta/beta_response_function_call_arguments_done_event.rb +83 -0
  71. data/lib/openai/models/beta/beta_response_function_call_output_item.rb +28 -0
  72. data/lib/openai/models/beta/beta_response_function_call_output_item_list.rb +14 -0
  73. data/lib/openai/models/beta/beta_response_function_shell_call_output_content.rb +90 -0
  74. data/lib/openai/models/beta/beta_response_function_shell_tool_call.rb +216 -0
  75. data/lib/openai/models/beta/beta_response_function_shell_tool_call_output.rb +265 -0
  76. data/lib/openai/models/beta/beta_response_function_tool_call.rb +168 -0
  77. data/lib/openai/models/beta/beta_response_function_tool_call_item.rb +57 -0
  78. data/lib/openai/models/beta/beta_response_function_tool_call_output_item.rb +201 -0
  79. data/lib/openai/models/beta/beta_response_function_web_search.rb +238 -0
  80. data/lib/openai/models/beta/beta_response_image_gen_call_completed_event.rb +69 -0
  81. data/lib/openai/models/beta/beta_response_image_gen_call_generating_event.rb +69 -0
  82. data/lib/openai/models/beta/beta_response_image_gen_call_in_progress_event.rb +68 -0
  83. data/lib/openai/models/beta/beta_response_image_gen_call_partial_image_event.rb +89 -0
  84. data/lib/openai/models/beta/beta_response_in_progress_event.rb +63 -0
  85. data/lib/openai/models/beta/beta_response_includable.rb +45 -0
  86. data/lib/openai/models/beta/beta_response_incomplete_event.rb +63 -0
  87. data/lib/openai/models/beta/beta_response_inject_created_event.rb +51 -0
  88. data/lib/openai/models/beta/beta_response_inject_event.rb +40 -0
  89. data/lib/openai/models/beta/beta_response_inject_failed_event.rb +103 -0
  90. data/lib/openai/models/beta/beta_response_input.rb +13 -0
  91. data/lib/openai/models/beta/beta_response_input_audio.rb +70 -0
  92. data/lib/openai/models/beta/beta_response_input_content.rb +28 -0
  93. data/lib/openai/models/beta/beta_response_input_file.rb +113 -0
  94. data/lib/openai/models/beta/beta_response_input_file_content.rb +115 -0
  95. data/lib/openai/models/beta/beta_response_input_image.rb +94 -0
  96. data/lib/openai/models/beta/beta_response_input_image_content.rb +96 -0
  97. data/lib/openai/models/beta/beta_response_input_item.rb +2819 -0
  98. data/lib/openai/models/beta/beta_response_input_message_content_list.rb +14 -0
  99. data/lib/openai/models/beta/beta_response_input_message_item.rb +108 -0
  100. data/lib/openai/models/beta/beta_response_input_text.rb +59 -0
  101. data/lib/openai/models/beta/beta_response_input_text_content.rb +61 -0
  102. data/lib/openai/models/beta/beta_response_item.rb +1438 -0
  103. data/lib/openai/models/beta/beta_response_local_environment.rb +22 -0
  104. data/lib/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rb +81 -0
  105. data/lib/openai/models/beta/beta_response_mcp_call_arguments_done_event.rb +79 -0
  106. data/lib/openai/models/beta/beta_response_mcp_call_completed_event.rb +68 -0
  107. data/lib/openai/models/beta/beta_response_mcp_call_failed_event.rb +68 -0
  108. data/lib/openai/models/beta/beta_response_mcp_call_in_progress_event.rb +68 -0
  109. data/lib/openai/models/beta/beta_response_mcp_list_tools_completed_event.rb +68 -0
  110. data/lib/openai/models/beta/beta_response_mcp_list_tools_failed_event.rb +68 -0
  111. data/lib/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rb +69 -0
  112. data/lib/openai/models/beta/beta_response_output_audio.rb +41 -0
  113. data/lib/openai/models/beta/beta_response_output_item.rb +1444 -0
  114. data/lib/openai/models/beta/beta_response_output_item_added_event.rb +71 -0
  115. data/lib/openai/models/beta/beta_response_output_item_done_event.rb +71 -0
  116. data/lib/openai/models/beta/beta_response_output_message.rb +139 -0
  117. data/lib/openai/models/beta/beta_response_output_refusal.rb +30 -0
  118. data/lib/openai/models/beta/beta_response_output_text.rb +292 -0
  119. data/lib/openai/models/beta/beta_response_output_text_annotation_added_event.rb +92 -0
  120. data/lib/openai/models/beta/beta_response_prompt.rb +65 -0
  121. data/lib/openai/models/beta/beta_response_queued_event.rb +60 -0
  122. data/lib/openai/models/beta/beta_response_reasoning_item.rb +151 -0
  123. data/lib/openai/models/beta/beta_response_reasoning_summary_part_added_event.rb +110 -0
  124. data/lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb +132 -0
  125. data/lib/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rb +88 -0
  126. data/lib/openai/models/beta/beta_response_reasoning_summary_text_done_event.rb +88 -0
  127. data/lib/openai/models/beta/beta_response_reasoning_text_delta_event.rb +87 -0
  128. data/lib/openai/models/beta/beta_response_reasoning_text_done_event.rb +87 -0
  129. data/lib/openai/models/beta/beta_response_refusal_delta_event.rb +87 -0
  130. data/lib/openai/models/beta/beta_response_refusal_done_event.rb +87 -0
  131. data/lib/openai/models/beta/beta_response_status.rb +25 -0
  132. data/lib/openai/models/beta/beta_response_stream_event.rb +203 -0
  133. data/lib/openai/models/beta/beta_response_text_config.rb +67 -0
  134. data/lib/openai/models/beta/beta_response_text_delta_event.rb +150 -0
  135. data/lib/openai/models/beta/beta_response_text_done_event.rb +150 -0
  136. data/lib/openai/models/beta/beta_response_tool_search_call.rb +117 -0
  137. data/lib/openai/models/beta/beta_response_tool_search_output_item.rb +117 -0
  138. data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +109 -0
  139. data/lib/openai/models/beta/beta_response_usage.rb +95 -0
  140. data/lib/openai/models/beta/beta_response_web_search_call_completed_event.rb +72 -0
  141. data/lib/openai/models/beta/beta_response_web_search_call_in_progress_event.rb +72 -0
  142. data/lib/openai/models/beta/beta_response_web_search_call_searching_event.rb +72 -0
  143. data/lib/openai/models/beta/beta_responses_client_event.rb +1432 -0
  144. data/lib/openai/models/beta/beta_responses_server_event.rb +212 -0
  145. data/lib/openai/models/beta/beta_skill_reference.rb +36 -0
  146. data/lib/openai/models/beta/beta_tool.rb +910 -0
  147. data/lib/openai/models/beta/beta_tool_choice_allowed.rb +75 -0
  148. data/lib/openai/models/beta/beta_tool_choice_apply_patch.rb +22 -0
  149. data/lib/openai/models/beta/beta_tool_choice_custom.rb +30 -0
  150. data/lib/openai/models/beta/beta_tool_choice_function.rb +30 -0
  151. data/lib/openai/models/beta/beta_tool_choice_mcp.rb +42 -0
  152. data/lib/openai/models/beta/beta_tool_choice_options.rb +28 -0
  153. data/lib/openai/models/beta/beta_tool_choice_shell.rb +22 -0
  154. data/lib/openai/models/beta/beta_tool_choice_types.rb +67 -0
  155. data/lib/openai/models/beta/beta_tool_search_tool.rb +59 -0
  156. data/lib/openai/models/beta/beta_web_search_preview_tool.rb +143 -0
  157. data/lib/openai/models/beta/beta_web_search_tool.rb +162 -0
  158. data/lib/openai/models/beta/response_cancel_params.rb +37 -0
  159. data/lib/openai/models/beta/response_compact_params.rb +549 -0
  160. data/lib/openai/models/beta/response_create_params.rb +1343 -0
  161. data/lib/openai/models/beta/response_delete_params.rb +37 -0
  162. data/lib/openai/models/beta/response_retrieve_params.rb +74 -0
  163. data/lib/openai/models/beta/responses/beta_response_item_list.rb +54 -0
  164. data/lib/openai/models/beta/responses/input_item_list_params.rb +96 -0
  165. data/lib/openai/models/beta/responses/input_token_count_params.rb +542 -0
  166. data/lib/openai/models/beta/responses/input_token_count_response.rb +26 -0
  167. data/lib/openai/models/beta/threads/run_create_params.rb +7 -14
  168. data/lib/openai/models/chat/chat_completion_content_part.rb +31 -1
  169. data/lib/openai/models/chat/chat_completion_content_part_image.rb +31 -1
  170. data/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +31 -1
  171. data/lib/openai/models/chat/chat_completion_content_part_text.rb +31 -1
  172. data/lib/openai/models/chat/completion_create_params.rb +200 -19
  173. data/lib/openai/models/chat_model.rb +3 -0
  174. data/lib/openai/models/completion_usage.rb +9 -1
  175. data/lib/openai/models/conversations/computer_screenshot_content.rb +28 -1
  176. data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
  177. data/lib/openai/models/conversations/conversation_item.rb +106 -3
  178. data/lib/openai/models/conversations/conversation_item_list.rb +2 -2
  179. data/lib/openai/models/conversations/item_create_params.rb +2 -2
  180. data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +7 -14
  181. data/lib/openai/models/evals/run_cancel_response.rb +16 -30
  182. data/lib/openai/models/evals/run_create_params.rb +16 -30
  183. data/lib/openai/models/evals/run_create_response.rb +16 -30
  184. data/lib/openai/models/evals/run_list_response.rb +16 -30
  185. data/lib/openai/models/evals/run_retrieve_response.rb +16 -30
  186. data/lib/openai/models/graders/score_model_grader.rb +7 -14
  187. data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +23 -1
  188. data/lib/openai/models/realtime/realtime_session_create_request.rb +6 -0
  189. data/lib/openai/models/realtime/realtime_session_create_response.rb +29 -1
  190. data/lib/openai/models/realtime/realtime_tools_config_union.rb +23 -1
  191. data/lib/openai/models/reasoning.rb +47 -15
  192. data/lib/openai/models/reasoning_effort.rb +7 -13
  193. data/lib/openai/models/responses/apply_patch_tool.rb +23 -1
  194. data/lib/openai/models/responses/compacted_response.rb +2 -2
  195. data/lib/openai/models/responses/custom_tool.rb +21 -1
  196. data/lib/openai/models/responses/function_shell_tool.rb +23 -1
  197. data/lib/openai/models/responses/function_tool.rb +32 -3
  198. data/lib/openai/models/responses/input_token_count_params.rb +21 -8
  199. data/lib/openai/models/responses/namespace_tool.rb +41 -2
  200. data/lib/openai/models/responses/response.rb +98 -14
  201. data/lib/openai/models/responses/response_apply_patch_tool_call.rb +56 -1
  202. data/lib/openai/models/responses/response_apply_patch_tool_call_output.rb +56 -1
  203. data/lib/openai/models/responses/response_compact_params.rb +107 -4
  204. data/lib/openai/models/responses/response_create_params.rb +214 -13
  205. data/lib/openai/models/responses/response_custom_tool_call.rb +56 -1
  206. data/lib/openai/models/responses/response_custom_tool_call_output.rb +58 -1
  207. data/lib/openai/models/responses/response_error.rb +1 -0
  208. data/lib/openai/models/responses/response_function_shell_tool_call.rb +56 -1
  209. data/lib/openai/models/responses/response_function_shell_tool_call_output.rb +56 -1
  210. data/lib/openai/models/responses/response_function_tool_call.rb +56 -1
  211. data/lib/openai/models/responses/response_function_tool_call_output_item.rb +58 -1
  212. data/lib/openai/models/responses/response_input_file.rb +39 -8
  213. data/lib/openai/models/responses/response_input_file_content.rb +41 -8
  214. data/lib/openai/models/responses/response_input_image.rb +27 -1
  215. data/lib/openai/models/responses/response_input_image_content.rb +29 -1
  216. data/lib/openai/models/responses/response_input_item.rb +396 -8
  217. data/lib/openai/models/responses/response_input_text.rb +30 -1
  218. data/lib/openai/models/responses/response_input_text_content.rb +32 -1
  219. data/lib/openai/models/responses/response_item.rb +106 -3
  220. data/lib/openai/models/responses/response_item_list.rb +2 -2
  221. data/lib/openai/models/responses/response_output_item.rb +106 -3
  222. data/lib/openai/models/responses/response_output_item_added_event.rb +2 -2
  223. data/lib/openai/models/responses/response_output_item_done_event.rb +2 -2
  224. data/lib/openai/models/responses/response_reasoning_summary_part_done_event.rb +23 -1
  225. data/lib/openai/models/responses/response_tool_search_output_item.rb +2 -2
  226. data/lib/openai/models/responses/response_tool_search_output_item_param.rb +2 -2
  227. data/lib/openai/models/responses/response_usage.rb +9 -1
  228. data/lib/openai/models/responses/responses_client_event.rb +215 -13
  229. data/lib/openai/models/responses/tool.rb +58 -3
  230. data/lib/openai/models/webhooks/safety_identifier_blocked_webhook_event.rb +118 -0
  231. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +4 -1
  232. data/lib/openai/resources/beta/assistants.rb +2 -2
  233. data/lib/openai/resources/beta/responses/input_items.rb +58 -0
  234. data/lib/openai/resources/beta/responses/input_tokens.rb +73 -0
  235. data/lib/openai/resources/beta/responses.rb +440 -0
  236. data/lib/openai/resources/beta/threads/runs.rb +2 -2
  237. data/lib/openai/resources/beta.rb +4 -0
  238. data/lib/openai/resources/chat/completions.rb +10 -6
  239. data/lib/openai/resources/conversations/items.rb +3 -3
  240. data/lib/openai/resources/conversations.rb +1 -1
  241. data/lib/openai/resources/responses/input_items.rb +1 -1
  242. data/lib/openai/resources/responses/input_tokens.rb +3 -3
  243. data/lib/openai/resources/responses.rb +22 -12
  244. data/lib/openai/resources/webhooks.rb +1 -1
  245. data/lib/openai/version.rb +1 -1
  246. data/lib/openai.rb +163 -0
  247. data/rbi/openai/models/beta/assistant_create_params.rbi +12 -26
  248. data/rbi/openai/models/beta/assistant_update_params.rbi +12 -26
  249. data/rbi/openai/models/beta/beta_apply_patch_tool.rbi +99 -0
  250. data/rbi/openai/models/beta/beta_compacted_response.rbi +120 -0
  251. data/rbi/openai/models/beta/beta_computer_action.rbi +593 -0
  252. data/rbi/openai/models/beta/beta_computer_action_list.rbi +18 -0
  253. data/rbi/openai/models/beta/beta_computer_tool.rbi +33 -0
  254. data/rbi/openai/models/beta/beta_computer_use_preview_tool.rbi +126 -0
  255. data/rbi/openai/models/beta/beta_container_auto.rbi +231 -0
  256. data/rbi/openai/models/beta/beta_container_network_policy_allowlist.rbi +81 -0
  257. data/rbi/openai/models/beta/beta_container_network_policy_disabled.rbi +35 -0
  258. data/rbi/openai/models/beta/beta_container_network_policy_domain_secret.rbi +53 -0
  259. data/rbi/openai/models/beta/beta_container_reference.rbi +42 -0
  260. data/rbi/openai/models/beta/beta_custom_tool.rbi +302 -0
  261. data/rbi/openai/models/beta/beta_easy_input_message.rbi +211 -0
  262. data/rbi/openai/models/beta/beta_file_search_tool.rbi +863 -0
  263. data/rbi/openai/models/beta/beta_function_shell_tool.rbi +155 -0
  264. data/rbi/openai/models/beta/beta_function_tool.rbi +154 -0
  265. data/rbi/openai/models/beta/beta_inline_skill.rbi +68 -0
  266. data/rbi/openai/models/beta/beta_inline_skill_source.rbi +53 -0
  267. data/rbi/openai/models/beta/beta_local_environment.rbi +51 -0
  268. data/rbi/openai/models/beta/beta_local_skill.rbi +49 -0
  269. data/rbi/openai/models/beta/beta_namespace_tool.rbi +252 -0
  270. data/rbi/openai/models/beta/beta_response.rbi +2495 -0
  271. data/rbi/openai/models/beta/beta_response_apply_patch_tool_call.rbi +431 -0
  272. data/rbi/openai/models/beta/beta_response_apply_patch_tool_call_output.rbi +277 -0
  273. data/rbi/openai/models/beta/beta_response_audio_delta_event.rbi +110 -0
  274. data/rbi/openai/models/beta/beta_response_audio_done_event.rbi +100 -0
  275. data/rbi/openai/models/beta/beta_response_audio_transcript_delta_event.rbi +118 -0
  276. data/rbi/openai/models/beta/beta_response_audio_transcript_done_event.rbi +108 -0
  277. data/rbi/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rbi +136 -0
  278. data/rbi/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rbi +134 -0
  279. data/rbi/openai/models/beta/beta_response_code_interpreter_call_completed_event.rbi +128 -0
  280. data/rbi/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rbi +128 -0
  281. data/rbi/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rbi +128 -0
  282. data/rbi/openai/models/beta/beta_response_code_interpreter_tool_call.rbi +315 -0
  283. data/rbi/openai/models/beta/beta_response_compaction_item.rbi +116 -0
  284. data/rbi/openai/models/beta/beta_response_compaction_item_param.rbi +114 -0
  285. data/rbi/openai/models/beta/beta_response_completed_event.rbi +111 -0
  286. data/rbi/openai/models/beta/beta_response_computer_tool_call.rbi +404 -0
  287. data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +296 -0
  288. data/rbi/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rbi +62 -0
  289. data/rbi/openai/models/beta/beta_response_container_reference.rbi +41 -0
  290. data/rbi/openai/models/beta/beta_response_content.rbi +66 -0
  291. data/rbi/openai/models/beta/beta_response_content_part_added_event.rbi +205 -0
  292. data/rbi/openai/models/beta/beta_response_content_part_done_event.rbi +203 -0
  293. data/rbi/openai/models/beta/beta_response_conversation_param.rbi +35 -0
  294. data/rbi/openai/models/beta/beta_response_created_event.rbi +109 -0
  295. data/rbi/openai/models/beta/beta_response_custom_tool_call.rbi +242 -0
  296. data/rbi/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rbi +134 -0
  297. data/rbi/openai/models/beta/beta_response_custom_tool_call_input_done_event.rbi +134 -0
  298. data/rbi/openai/models/beta/beta_response_custom_tool_call_item.rbi +113 -0
  299. data/rbi/openai/models/beta/beta_response_custom_tool_call_output.rbi +303 -0
  300. data/rbi/openai/models/beta/beta_response_custom_tool_call_output_item.rbi +114 -0
  301. data/rbi/openai/models/beta/beta_response_error.rbi +165 -0
  302. data/rbi/openai/models/beta/beta_response_error_event.rbi +120 -0
  303. data/rbi/openai/models/beta/beta_response_failed_event.rbi +107 -0
  304. data/rbi/openai/models/beta/beta_response_file_search_call_completed_event.rbi +126 -0
  305. data/rbi/openai/models/beta/beta_response_file_search_call_in_progress_event.rbi +126 -0
  306. data/rbi/openai/models/beta/beta_response_file_search_call_searching_event.rbi +126 -0
  307. data/rbi/openai/models/beta/beta_response_file_search_tool_call.rbi +328 -0
  308. data/rbi/openai/models/beta/beta_response_format_text_config.rbi +97 -0
  309. data/rbi/openai/models/beta/beta_response_format_text_json_schema_config.rbi +97 -0
  310. data/rbi/openai/models/beta/beta_response_function_call_arguments_delta_event.rbi +134 -0
  311. data/rbi/openai/models/beta/beta_response_function_call_arguments_done_event.rbi +140 -0
  312. data/rbi/openai/models/beta/beta_response_function_call_output_item.rbi +32 -0
  313. data/rbi/openai/models/beta/beta_response_function_call_output_item_list.rbi +21 -0
  314. data/rbi/openai/models/beta/beta_response_function_shell_call_output_content.rbi +160 -0
  315. data/rbi/openai/models/beta/beta_response_function_shell_tool_call.rbi +389 -0
  316. data/rbi/openai/models/beta/beta_response_function_shell_tool_call_output.rbi +470 -0
  317. data/rbi/openai/models/beta/beta_response_function_tool_call.rbi +310 -0
  318. data/rbi/openai/models/beta/beta_response_function_tool_call_item.rbi +115 -0
  319. data/rbi/openai/models/beta/beta_response_function_tool_call_output_item.rbi +364 -0
  320. data/rbi/openai/models/beta/beta_response_function_web_search.rbi +416 -0
  321. data/rbi/openai/models/beta/beta_response_image_gen_call_completed_event.rbi +127 -0
  322. data/rbi/openai/models/beta/beta_response_image_gen_call_generating_event.rbi +127 -0
  323. data/rbi/openai/models/beta/beta_response_image_gen_call_in_progress_event.rbi +126 -0
  324. data/rbi/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbi +144 -0
  325. data/rbi/openai/models/beta/beta_response_in_progress_event.rbi +113 -0
  326. data/rbi/openai/models/beta/beta_response_includable.rbi +86 -0
  327. data/rbi/openai/models/beta/beta_response_incomplete_event.rbi +113 -0
  328. data/rbi/openai/models/beta/beta_response_inject_created_event.rbi +75 -0
  329. data/rbi/openai/models/beta/beta_response_inject_event.rbi +183 -0
  330. data/rbi/openai/models/beta/beta_response_inject_failed_event.rbi +304 -0
  331. data/rbi/openai/models/beta/beta_response_input.rbi +18 -0
  332. data/rbi/openai/models/beta/beta_response_input_audio.rbi +144 -0
  333. data/rbi/openai/models/beta/beta_response_input_content.rbi +31 -0
  334. data/rbi/openai/models/beta/beta_response_input_file.rbi +210 -0
  335. data/rbi/openai/models/beta/beta_response_input_file_content.rbi +211 -0
  336. data/rbi/openai/models/beta/beta_response_input_image.rbi +173 -0
  337. data/rbi/openai/models/beta/beta_response_input_image_content.rbi +191 -0
  338. data/rbi/openai/models/beta/beta_response_input_item.rbi +5505 -0
  339. data/rbi/openai/models/beta/beta_response_input_message_content_list.rbi +21 -0
  340. data/rbi/openai/models/beta/beta_response_input_message_item.rbi +235 -0
  341. data/rbi/openai/models/beta/beta_response_input_text.rbi +109 -0
  342. data/rbi/openai/models/beta/beta_response_input_text_content.rbi +115 -0
  343. data/rbi/openai/models/beta/beta_response_item.rbi +2592 -0
  344. data/rbi/openai/models/beta/beta_response_local_environment.rbi +35 -0
  345. data/rbi/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rbi +137 -0
  346. data/rbi/openai/models/beta/beta_response_mcp_call_arguments_done_event.rbi +134 -0
  347. data/rbi/openai/models/beta/beta_response_mcp_call_completed_event.rbi +123 -0
  348. data/rbi/openai/models/beta/beta_response_mcp_call_failed_event.rbi +121 -0
  349. data/rbi/openai/models/beta/beta_response_mcp_call_in_progress_event.rbi +124 -0
  350. data/rbi/openai/models/beta/beta_response_mcp_list_tools_completed_event.rbi +126 -0
  351. data/rbi/openai/models/beta/beta_response_mcp_list_tools_failed_event.rbi +124 -0
  352. data/rbi/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rbi +127 -0
  353. data/rbi/openai/models/beta/beta_response_output_audio.rbi +53 -0
  354. data/rbi/openai/models/beta/beta_response_output_item.rbi +2627 -0
  355. data/rbi/openai/models/beta/beta_response_output_item_added_event.rbi +154 -0
  356. data/rbi/openai/models/beta/beta_response_output_item_done_event.rbi +154 -0
  357. data/rbi/openai/models/beta/beta_response_output_message.rbi +267 -0
  358. data/rbi/openai/models/beta/beta_response_output_refusal.rbi +41 -0
  359. data/rbi/openai/models/beta/beta_response_output_text.rbi +479 -0
  360. data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi +150 -0
  361. data/rbi/openai/models/beta/beta_response_prompt.rbi +122 -0
  362. data/rbi/openai/models/beta/beta_response_queued_event.rbi +107 -0
  363. data/rbi/openai/models/beta/beta_response_reasoning_item.rbi +274 -0
  364. data/rbi/openai/models/beta/beta_response_reasoning_summary_part_added_event.rbi +188 -0
  365. data/rbi/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbi +243 -0
  366. data/rbi/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rbi +142 -0
  367. data/rbi/openai/models/beta/beta_response_reasoning_summary_text_done_event.rbi +142 -0
  368. data/rbi/openai/models/beta/beta_response_reasoning_text_delta_event.rbi +140 -0
  369. data/rbi/openai/models/beta/beta_response_reasoning_text_done_event.rbi +140 -0
  370. data/rbi/openai/models/beta/beta_response_refusal_delta_event.rbi +135 -0
  371. data/rbi/openai/models/beta/beta_response_refusal_done_event.rbi +135 -0
  372. data/rbi/openai/models/beta/beta_response_status.rbi +38 -0
  373. data/rbi/openai/models/beta/beta_response_stream_event.rbi +81 -0
  374. data/rbi/openai/models/beta/beta_response_text_config.rbi +166 -0
  375. data/rbi/openai/models/beta/beta_response_text_delta_event.rbi +263 -0
  376. data/rbi/openai/models/beta/beta_response_text_done_event.rbi +261 -0
  377. data/rbi/openai/models/beta/beta_response_tool_search_call.rbi +218 -0
  378. data/rbi/openai/models/beta/beta_response_tool_search_output_item.rbi +248 -0
  379. data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +307 -0
  380. data/rbi/openai/models/beta/beta_response_usage.rbi +163 -0
  381. data/rbi/openai/models/beta/beta_response_web_search_call_completed_event.rbi +126 -0
  382. data/rbi/openai/models/beta/beta_response_web_search_call_in_progress_event.rbi +126 -0
  383. data/rbi/openai/models/beta/beta_response_web_search_call_searching_event.rbi +126 -0
  384. data/rbi/openai/models/beta/beta_responses_client_event.rbi +2831 -0
  385. data/rbi/openai/models/beta/beta_responses_server_event.rbi +83 -0
  386. data/rbi/openai/models/beta/beta_skill_reference.rbi +52 -0
  387. data/rbi/openai/models/beta/beta_tool.rbi +1835 -0
  388. data/rbi/openai/models/beta/beta_tool_choice_allowed.rbi +126 -0
  389. data/rbi/openai/models/beta/beta_tool_choice_apply_patch.rbi +35 -0
  390. data/rbi/openai/models/beta/beta_tool_choice_custom.rbi +38 -0
  391. data/rbi/openai/models/beta/beta_tool_choice_function.rbi +41 -0
  392. data/rbi/openai/models/beta/beta_tool_choice_mcp.rbi +55 -0
  393. data/rbi/openai/models/beta/beta_tool_choice_options.rbi +38 -0
  394. data/rbi/openai/models/beta/beta_tool_choice_shell.rbi +32 -0
  395. data/rbi/openai/models/beta/beta_tool_choice_types.rbi +134 -0
  396. data/rbi/openai/models/beta/beta_tool_search_tool.rbi +109 -0
  397. data/rbi/openai/models/beta/beta_web_search_preview_tool.rbi +311 -0
  398. data/rbi/openai/models/beta/beta_web_search_tool.rbi +329 -0
  399. data/rbi/openai/models/beta/response_cancel_params.rbi +83 -0
  400. data/rbi/openai/models/beta/response_compact_params.rbi +1033 -0
  401. data/rbi/openai/models/beta/response_create_params.rbi +2739 -0
  402. data/rbi/openai/models/beta/response_delete_params.rbi +83 -0
  403. data/rbi/openai/models/beta/response_retrieve_params.rbi +145 -0
  404. data/rbi/openai/models/beta/responses/beta_response_item_list.rbi +113 -0
  405. data/rbi/openai/models/beta/responses/input_item_list_params.rbi +223 -0
  406. data/rbi/openai/models/beta/responses/input_token_count_params.rbi +1248 -0
  407. data/rbi/openai/models/beta/responses/input_token_count_response.rbi +37 -0
  408. data/rbi/openai/models/beta/threads/run_create_params.rbi +12 -26
  409. data/rbi/openai/models/chat/chat_completion_content_part.rbi +57 -1
  410. data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +57 -1
  411. data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +57 -1
  412. data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +70 -2
  413. data/rbi/openai/models/chat/completion_create_params.rbi +513 -32
  414. data/rbi/openai/models/chat_model.rbi +3 -0
  415. data/rbi/openai/models/completion_usage.rbi +21 -4
  416. data/rbi/openai/models/conversations/computer_screenshot_content.rbi +57 -1
  417. data/rbi/openai/models/conversations/conversation_create_params.rbi +9 -3
  418. data/rbi/openai/models/conversations/conversation_item.rbi +178 -0
  419. data/rbi/openai/models/conversations/conversation_item_list.rbi +2 -0
  420. data/rbi/openai/models/conversations/item_create_params.rbi +9 -3
  421. data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +12 -26
  422. data/rbi/openai/models/evals/run_cancel_response.rbi +26 -52
  423. data/rbi/openai/models/evals/run_create_params.rbi +28 -52
  424. data/rbi/openai/models/evals/run_create_response.rbi +26 -52
  425. data/rbi/openai/models/evals/run_list_response.rbi +26 -52
  426. data/rbi/openai/models/evals/run_retrieve_response.rbi +26 -52
  427. data/rbi/openai/models/graders/score_model_grader.rbi +12 -26
  428. data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +60 -0
  429. data/rbi/openai/models/realtime/realtime_session_create_request.rbi +10 -0
  430. data/rbi/openai/models/realtime/realtime_session_create_response.rbi +70 -0
  431. data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +60 -0
  432. data/rbi/openai/models/reasoning.rbi +51 -26
  433. data/rbi/openai/models/reasoning_effort.rbi +7 -13
  434. data/rbi/openai/models/responses/apply_patch_tool.rbi +69 -2
  435. data/rbi/openai/models/responses/compacted_response.rbi +2 -0
  436. data/rbi/openai/models/responses/custom_tool.rbi +53 -0
  437. data/rbi/openai/models/responses/function_shell_tool.rbi +57 -0
  438. data/rbi/openai/models/responses/function_tool.rbi +68 -3
  439. data/rbi/openai/models/responses/input_token_count_params.rbi +32 -0
  440. data/rbi/openai/models/responses/namespace_tool.rbi +76 -0
  441. data/rbi/openai/models/responses/response.rbi +192 -3
  442. data/rbi/openai/models/responses/response_apply_patch_tool_call.rbi +98 -0
  443. data/rbi/openai/models/responses/response_apply_patch_tool_call_output.rbi +98 -0
  444. data/rbi/openai/models/responses/response_compact_params.rbi +231 -0
  445. data/rbi/openai/models/responses/response_create_params.rbi +537 -6
  446. data/rbi/openai/models/responses/response_custom_tool_call.rbi +104 -0
  447. data/rbi/openai/models/responses/response_custom_tool_call_output.rbi +111 -1
  448. data/rbi/openai/models/responses/response_error.rbi +5 -0
  449. data/rbi/openai/models/responses/response_function_shell_tool_call.rbi +98 -0
  450. data/rbi/openai/models/responses/response_function_shell_tool_call_output.rbi +98 -0
  451. data/rbi/openai/models/responses/response_function_tool_call.rbi +104 -0
  452. data/rbi/openai/models/responses/response_function_tool_call_output_item.rbi +104 -0
  453. data/rbi/openai/models/responses/response_input_file.rbi +77 -10
  454. data/rbi/openai/models/responses/response_input_file_content.rbi +83 -10
  455. data/rbi/openai/models/responses/response_input_image.rbi +57 -1
  456. data/rbi/openai/models/responses/response_input_image_content.rbi +63 -1
  457. data/rbi/openai/models/responses/response_input_item.rbi +748 -8
  458. data/rbi/openai/models/responses/response_input_text.rbi +70 -2
  459. data/rbi/openai/models/responses/response_input_text_content.rbi +76 -2
  460. data/rbi/openai/models/responses/response_item.rbi +178 -0
  461. data/rbi/openai/models/responses/response_item_list.rbi +2 -0
  462. data/rbi/openai/models/responses/response_output_item.rbi +178 -0
  463. data/rbi/openai/models/responses/response_output_item_added_event.rbi +2 -0
  464. data/rbi/openai/models/responses/response_output_item_done_event.rbi +2 -0
  465. data/rbi/openai/models/responses/response_reasoning_summary_part_done_event.rbi +58 -1
  466. data/rbi/openai/models/responses/response_tool_search_output_item.rbi +1 -0
  467. data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +3 -0
  468. data/rbi/openai/models/responses/response_usage.rbi +16 -2
  469. data/rbi/openai/models/responses/responses_client_event.rbi +537 -6
  470. data/rbi/openai/models/responses/tool.rbi +142 -1
  471. data/rbi/openai/models/webhooks/safety_identifier_blocked_webhook_event.rbi +209 -0
  472. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +2 -1
  473. data/rbi/openai/resources/beta/assistants.rbi +12 -26
  474. data/rbi/openai/resources/beta/responses/input_items.rbi +58 -0
  475. data/rbi/openai/resources/beta/responses/input_tokens.rbi +154 -0
  476. data/rbi/openai/resources/beta/responses.rbi +903 -0
  477. data/rbi/openai/resources/beta/threads/runs.rbi +12 -26
  478. data/rbi/openai/resources/beta.rbi +3 -0
  479. data/rbi/openai/resources/chat/completions.rbi +48 -28
  480. data/rbi/openai/resources/conversations/items.rbi +3 -1
  481. data/rbi/openai/resources/conversations.rbi +3 -1
  482. data/rbi/openai/resources/responses/input_tokens.rbi +2 -0
  483. data/rbi/openai/resources/responses.rbi +54 -2
  484. data/rbi/openai/resources/webhooks.rbi +2 -1
  485. data/sig/openai/client.rbs +1 -1
  486. data/sig/openai/internal/transport/base_client.rbs +2 -2
  487. data/sig/openai/models/beta/beta_apply_patch_tool.rbs +40 -0
  488. data/sig/openai/models/beta/beta_compacted_response.rbs +44 -0
  489. data/sig/openai/models/beta/beta_computer_action.rbs +259 -0
  490. data/sig/openai/models/beta/beta_computer_action_list.rbs +12 -0
  491. data/sig/openai/models/beta/beta_computer_tool.rbs +17 -0
  492. data/sig/openai/models/beta/beta_computer_use_preview_tool.rbs +53 -0
  493. data/sig/openai/models/beta/beta_container_auto.rbs +86 -0
  494. data/sig/openai/models/beta/beta_container_network_policy_allowlist.rbs +38 -0
  495. data/sig/openai/models/beta/beta_container_network_policy_disabled.rbs +17 -0
  496. data/sig/openai/models/beta/beta_container_network_policy_domain_secret.rbs +22 -0
  497. data/sig/openai/models/beta/beta_container_reference.rbs +23 -0
  498. data/sig/openai/models/beta/beta_custom_tool.rbs +126 -0
  499. data/sig/openai/models/beta/beta_easy_input_message.rbs +87 -0
  500. data/sig/openai/models/beta/beta_file_search_tool.rbs +298 -0
  501. data/sig/openai/models/beta/beta_function_shell_tool.rbs +56 -0
  502. data/sig/openai/models/beta/beta_function_tool.rbs +72 -0
  503. data/sig/openai/models/beta/beta_inline_skill.rbs +39 -0
  504. data/sig/openai/models/beta/beta_inline_skill_source.rbs +30 -0
  505. data/sig/openai/models/beta/beta_local_environment.rbs +30 -0
  506. data/sig/openai/models/beta/beta_local_skill.rbs +26 -0
  507. data/sig/openai/models/beta/beta_namespace_tool.rbs +114 -0
  508. data/sig/openai/models/beta/beta_response.rbs +860 -0
  509. data/sig/openai/models/beta/beta_response_apply_patch_tool_call.rbs +177 -0
  510. data/sig/openai/models/beta/beta_response_apply_patch_tool_call_output.rbs +118 -0
  511. data/sig/openai/models/beta/beta_response_audio_delta_event.rbs +49 -0
  512. data/sig/openai/models/beta/beta_response_audio_done_event.rbs +44 -0
  513. data/sig/openai/models/beta/beta_response_audio_transcript_delta_event.rbs +49 -0
  514. data/sig/openai/models/beta/beta_response_audio_transcript_done_event.rbs +44 -0
  515. data/sig/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rbs +59 -0
  516. data/sig/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rbs +59 -0
  517. data/sig/openai/models/beta/beta_response_code_interpreter_call_completed_event.rbs +54 -0
  518. data/sig/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rbs +54 -0
  519. data/sig/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rbs +54 -0
  520. data/sig/openai/models/beta/beta_response_code_interpreter_tool_call.rbs +113 -0
  521. data/sig/openai/models/beta/beta_response_compaction_item.rbs +60 -0
  522. data/sig/openai/models/beta/beta_response_compaction_item_param.rbs +49 -0
  523. data/sig/openai/models/beta/beta_response_completed_event.rbs +49 -0
  524. data/sig/openai/models/beta/beta_response_computer_tool_call.rbs +118 -0
  525. data/sig/openai/models/beta/beta_response_computer_tool_call_output_item.rbs +107 -0
  526. data/sig/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rbs +34 -0
  527. data/sig/openai/models/beta/beta_response_container_reference.rbs +23 -0
  528. data/sig/openai/models/beta/beta_response_content.rbs +33 -0
  529. data/sig/openai/models/beta/beta_response_content_part_added_event.rbs +87 -0
  530. data/sig/openai/models/beta/beta_response_content_part_done_event.rbs +87 -0
  531. data/sig/openai/models/beta/beta_response_conversation_param.rbs +17 -0
  532. data/sig/openai/models/beta/beta_response_created_event.rbs +49 -0
  533. data/sig/openai/models/beta/beta_response_custom_tool_call.rbs +105 -0
  534. data/sig/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rbs +59 -0
  535. data/sig/openai/models/beta/beta_response_custom_tool_call_input_done_event.rbs +59 -0
  536. data/sig/openai/models/beta/beta_response_custom_tool_call_item.rbs +54 -0
  537. data/sig/openai/models/beta/beta_response_custom_tool_call_output.rbs +116 -0
  538. data/sig/openai/models/beta/beta_response_custom_tool_call_output_item.rbs +54 -0
  539. data/sig/openai/models/beta/beta_response_error.rbs +73 -0
  540. data/sig/openai/models/beta/beta_response_error_event.rbs +59 -0
  541. data/sig/openai/models/beta/beta_response_failed_event.rbs +49 -0
  542. data/sig/openai/models/beta/beta_response_file_search_call_completed_event.rbs +54 -0
  543. data/sig/openai/models/beta/beta_response_file_search_call_in_progress_event.rbs +54 -0
  544. data/sig/openai/models/beta/beta_response_file_search_call_searching_event.rbs +54 -0
  545. data/sig/openai/models/beta/beta_response_file_search_tool_call.rbs +127 -0
  546. data/sig/openai/models/beta/beta_response_format_text_config.rbs +38 -0
  547. data/sig/openai/models/beta/beta_response_format_text_json_schema_config.rbs +46 -0
  548. data/sig/openai/models/beta/beta_response_function_call_arguments_delta_event.rbs +59 -0
  549. data/sig/openai/models/beta/beta_response_function_call_arguments_done_event.rbs +64 -0
  550. data/sig/openai/models/beta/beta_response_function_call_output_item.rbs +18 -0
  551. data/sig/openai/models/beta/beta_response_function_call_output_item_list.rbs +12 -0
  552. data/sig/openai/models/beta/beta_response_function_shell_call_output_content.rbs +66 -0
  553. data/sig/openai/models/beta/beta_response_function_shell_tool_call.rbs +161 -0
  554. data/sig/openai/models/beta/beta_response_function_shell_tool_call_output.rbs +190 -0
  555. data/sig/openai/models/beta/beta_response_function_tool_call.rbs +126 -0
  556. data/sig/openai/models/beta/beta_response_function_tool_call_item.rbs +54 -0
  557. data/sig/openai/models/beta/beta_response_function_tool_call_output_item.rbs +138 -0
  558. data/sig/openai/models/beta/beta_response_function_web_search.rbs +165 -0
  559. data/sig/openai/models/beta/beta_response_image_gen_call_completed_event.rbs +54 -0
  560. data/sig/openai/models/beta/beta_response_image_gen_call_generating_event.rbs +54 -0
  561. data/sig/openai/models/beta/beta_response_image_gen_call_in_progress_event.rbs +54 -0
  562. data/sig/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbs +64 -0
  563. data/sig/openai/models/beta/beta_response_in_progress_event.rbs +49 -0
  564. data/sig/openai/models/beta/beta_response_includable.rbs +32 -0
  565. data/sig/openai/models/beta/beta_response_incomplete_event.rbs +49 -0
  566. data/sig/openai/models/beta/beta_response_inject_created_event.rbs +41 -0
  567. data/sig/openai/models/beta/beta_response_inject_event.rbs +34 -0
  568. data/sig/openai/models/beta/beta_response_inject_failed_event.rbs +84 -0
  569. data/sig/openai/models/beta/beta_response_input.rbs +12 -0
  570. data/sig/openai/models/beta/beta_response_input_audio.rbs +62 -0
  571. data/sig/openai/models/beta/beta_response_input_content.rbs +18 -0
  572. data/sig/openai/models/beta/beta_response_input_file.rbs +90 -0
  573. data/sig/openai/models/beta/beta_response_input_file_content.rbs +80 -0
  574. data/sig/openai/models/beta/beta_response_input_image.rbs +71 -0
  575. data/sig/openai/models/beta/beta_response_input_image_content.rbs +67 -0
  576. data/sig/openai/models/beta/beta_response_input_item.rbs +2064 -0
  577. data/sig/openai/models/beta/beta_response_input_message_content_list.rbs +12 -0
  578. data/sig/openai/models/beta/beta_response_input_message_item.rbs +87 -0
  579. data/sig/openai/models/beta/beta_response_input_text.rbs +48 -0
  580. data/sig/openai/models/beta/beta_response_input_text_content.rbs +44 -0
  581. data/sig/openai/models/beta/beta_response_item.rbs +1097 -0
  582. data/sig/openai/models/beta/beta_response_local_environment.rbs +17 -0
  583. data/sig/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rbs +59 -0
  584. data/sig/openai/models/beta/beta_response_mcp_call_arguments_done_event.rbs +59 -0
  585. data/sig/openai/models/beta/beta_response_mcp_call_completed_event.rbs +54 -0
  586. data/sig/openai/models/beta/beta_response_mcp_call_failed_event.rbs +54 -0
  587. data/sig/openai/models/beta/beta_response_mcp_call_in_progress_event.rbs +54 -0
  588. data/sig/openai/models/beta/beta_response_mcp_list_tools_completed_event.rbs +54 -0
  589. data/sig/openai/models/beta/beta_response_mcp_list_tools_failed_event.rbs +54 -0
  590. data/sig/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rbs +54 -0
  591. data/sig/openai/models/beta/beta_response_output_audio.rbs +30 -0
  592. data/sig/openai/models/beta/beta_response_output_item.rbs +1096 -0
  593. data/sig/openai/models/beta/beta_response_output_item_added_event.rbs +54 -0
  594. data/sig/openai/models/beta/beta_response_output_item_done_event.rbs +54 -0
  595. data/sig/openai/models/beta/beta_response_output_message.rbs +97 -0
  596. data/sig/openai/models/beta/beta_response_output_refusal.rbs +19 -0
  597. data/sig/openai/models/beta/beta_response_output_text.rbs +243 -0
  598. data/sig/openai/models/beta/beta_response_output_text_annotation_added_event.rbs +69 -0
  599. data/sig/openai/models/beta/beta_response_prompt.rbs +46 -0
  600. data/sig/openai/models/beta/beta_response_queued_event.rbs +49 -0
  601. data/sig/openai/models/beta/beta_response_reasoning_item.rbs +108 -0
  602. data/sig/openai/models/beta/beta_response_reasoning_summary_part_added_event.rbs +76 -0
  603. data/sig/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbs +95 -0
  604. data/sig/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rbs +64 -0
  605. data/sig/openai/models/beta/beta_response_reasoning_summary_text_done_event.rbs +64 -0
  606. data/sig/openai/models/beta/beta_response_reasoning_text_delta_event.rbs +64 -0
  607. data/sig/openai/models/beta/beta_response_reasoning_text_done_event.rbs +64 -0
  608. data/sig/openai/models/beta/beta_response_refusal_delta_event.rbs +64 -0
  609. data/sig/openai/models/beta/beta_response_refusal_done_event.rbs +64 -0
  610. data/sig/openai/models/beta/beta_response_status.rbs +23 -0
  611. data/sig/openai/models/beta/beta_response_stream_event.rbs +68 -0
  612. data/sig/openai/models/beta/beta_response_text_config.rbs +45 -0
  613. data/sig/openai/models/beta/beta_response_text_delta_event.rbs +116 -0
  614. data/sig/openai/models/beta/beta_response_text_done_event.rbs +116 -0
  615. data/sig/openai/models/beta/beta_response_tool_search_call.rbs +98 -0
  616. data/sig/openai/models/beta/beta_response_tool_search_output_item.rbs +98 -0
  617. data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +91 -0
  618. data/sig/openai/models/beta/beta_response_usage.rbs +73 -0
  619. data/sig/openai/models/beta/beta_response_web_search_call_completed_event.rbs +54 -0
  620. data/sig/openai/models/beta/beta_response_web_search_call_in_progress_event.rbs +54 -0
  621. data/sig/openai/models/beta/beta_response_web_search_call_searching_event.rbs +54 -0
  622. data/sig/openai/models/beta/beta_responses_client_event.rbs +804 -0
  623. data/sig/openai/models/beta/beta_responses_server_event.rbs +70 -0
  624. data/sig/openai/models/beta/beta_skill_reference.rbs +32 -0
  625. data/sig/openai/models/beta/beta_tool.rbs +634 -0
  626. data/sig/openai/models/beta/beta_tool_choice_allowed.rbs +45 -0
  627. data/sig/openai/models/beta/beta_tool_choice_apply_patch.rbs +17 -0
  628. data/sig/openai/models/beta/beta_tool_choice_custom.rbs +19 -0
  629. data/sig/openai/models/beta/beta_tool_choice_function.rbs +19 -0
  630. data/sig/openai/models/beta/beta_tool_choice_mcp.rbs +26 -0
  631. data/sig/openai/models/beta/beta_tool_choice_options.rbs +19 -0
  632. data/sig/openai/models/beta/beta_tool_choice_shell.rbs +17 -0
  633. data/sig/openai/models/beta/beta_tool_choice_types.rbs +47 -0
  634. data/sig/openai/models/beta/beta_tool_search_tool.rbs +54 -0
  635. data/sig/openai/models/beta/beta_web_search_preview_tool.rbs +118 -0
  636. data/sig/openai/models/beta/beta_web_search_tool.rbs +127 -0
  637. data/sig/openai/models/beta/response_cancel_params.rbs +47 -0
  638. data/sig/openai/models/beta/response_compact_params.rbs +368 -0
  639. data/sig/openai/models/beta/response_create_params.rbs +804 -0
  640. data/sig/openai/models/beta/response_delete_params.rbs +47 -0
  641. data/sig/openai/models/beta/response_retrieve_params.rbs +70 -0
  642. data/sig/openai/models/beta/responses/beta_response_item_list.rbs +44 -0
  643. data/sig/openai/models/beta/responses/input_item_list_params.rbs +92 -0
  644. data/sig/openai/models/beta/responses/input_token_count_params.rbs +325 -0
  645. data/sig/openai/models/beta/responses/input_token_count_response.rbs +26 -0
  646. data/sig/openai/models/chat/chat_completion_content_part.rbs +21 -2
  647. data/sig/openai/models/chat/chat_completion_content_part_image.rbs +21 -2
  648. data/sig/openai/models/chat/chat_completion_content_part_input_audio.rbs +21 -2
  649. data/sig/openai/models/chat/chat_completion_content_part_text.rbs +32 -3
  650. data/sig/openai/models/chat/completion_create_params.rbs +153 -3
  651. data/sig/openai/models/chat_model.rbs +7 -1
  652. data/sig/openai/models/completion_usage.rbs +15 -2
  653. data/sig/openai/models/conversations/computer_screenshot_content.rbs +21 -2
  654. data/sig/openai/models/conversations/conversation_item.rbs +87 -0
  655. data/sig/openai/models/realtime/realtime_response_create_mcp_tool.rbs +16 -0
  656. data/sig/openai/models/realtime/realtime_session_create_request.rbs +4 -0
  657. data/sig/openai/models/realtime/realtime_session_create_response.rbs +20 -0
  658. data/sig/openai/models/realtime/realtime_tools_config_union.rbs +16 -0
  659. data/sig/openai/models/reasoning.rbs +20 -0
  660. data/sig/openai/models/reasoning_effort.rbs +3 -1
  661. data/sig/openai/models/responses/apply_patch_tool.rbs +26 -3
  662. data/sig/openai/models/responses/custom_tool.rbs +16 -0
  663. data/sig/openai/models/responses/function_shell_tool.rbs +16 -0
  664. data/sig/openai/models/responses/function_tool.rbs +23 -2
  665. data/sig/openai/models/responses/input_token_count_params.rbs +12 -0
  666. data/sig/openai/models/responses/namespace_tool.rbs +21 -0
  667. data/sig/openai/models/responses/response.rbs +64 -0
  668. data/sig/openai/models/responses/response_apply_patch_tool_call.rbs +37 -0
  669. data/sig/openai/models/responses/response_apply_patch_tool_call_output.rbs +37 -0
  670. data/sig/openai/models/responses/response_compact_params.rbs +63 -1
  671. data/sig/openai/models/responses/response_create_params.rbs +165 -3
  672. data/sig/openai/models/responses/response_custom_tool_call.rbs +37 -0
  673. data/sig/openai/models/responses/response_custom_tool_call_output.rbs +39 -2
  674. data/sig/openai/models/responses/response_error.rbs +2 -0
  675. data/sig/openai/models/responses/response_function_shell_tool_call.rbs +37 -0
  676. data/sig/openai/models/responses/response_function_shell_tool_call_output.rbs +37 -0
  677. data/sig/openai/models/responses/response_function_tool_call.rbs +37 -0
  678. data/sig/openai/models/responses/response_function_tool_call_output_item.rbs +37 -0
  679. data/sig/openai/models/responses/response_input_file.rbs +23 -3
  680. data/sig/openai/models/responses/response_input_file_content.rbs +19 -3
  681. data/sig/openai/models/responses/response_input_image.rbs +21 -2
  682. data/sig/openai/models/responses/response_input_image_content.rbs +17 -2
  683. data/sig/openai/models/responses/response_input_item.rbs +274 -2
  684. data/sig/openai/models/responses/response_input_text.rbs +32 -3
  685. data/sig/openai/models/responses/response_input_text_content.rbs +28 -3
  686. data/sig/openai/models/responses/response_item.rbs +87 -0
  687. data/sig/openai/models/responses/response_output_item.rbs +87 -0
  688. data/sig/openai/models/responses/response_reasoning_summary_part_done_event.rbs +21 -2
  689. data/sig/openai/models/responses/response_usage.rbs +12 -3
  690. data/sig/openai/models/responses/responses_client_event.rbs +165 -3
  691. data/sig/openai/models/responses/tool.rbs +45 -2
  692. data/sig/openai/models/webhooks/safety_identifier_blocked_webhook_event.rbs +99 -0
  693. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
  694. data/sig/openai/resources/beta/responses/input_items.rbs +21 -0
  695. data/sig/openai/resources/beta/responses/input_tokens.rbs +28 -0
  696. data/sig/openai/resources/beta/responses.rbs +128 -0
  697. data/sig/openai/resources/beta.rbs +2 -0
  698. data/sig/openai/resources/chat/completions.rbs +2 -0
  699. data/sig/openai/resources/responses.rbs +3 -0
  700. data/sig/openai/resources/webhooks.rbs +2 -1
  701. metadata +491 -2
@@ -0,0 +1,1438 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ # Content item used to generate a response.
7
+ module BetaResponseItem
8
+ extend OpenAI::Internal::Type::Union
9
+
10
+ discriminator :type
11
+
12
+ variant :message, -> { OpenAI::Beta::BetaResponseInputMessageItem }
13
+
14
+ # An output message from the model.
15
+ variant :message, -> { OpenAI::Beta::BetaResponseOutputMessage }
16
+
17
+ # The results of a file search tool call. See the
18
+ # [file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information.
19
+ variant :file_search_call, -> { OpenAI::Beta::BetaResponseFileSearchToolCall }
20
+
21
+ # A tool call to a computer use tool. See the
22
+ # [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information.
23
+ variant :computer_call, -> { OpenAI::Beta::BetaResponseComputerToolCall }
24
+
25
+ variant :computer_call_output, -> { OpenAI::Beta::BetaResponseComputerToolCallOutputItem }
26
+
27
+ # The results of a web search tool call. See the
28
+ # [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information.
29
+ variant :web_search_call, -> { OpenAI::Beta::BetaResponseFunctionWebSearch }
30
+
31
+ # A tool call to run a function. See the
32
+ # [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information.
33
+ variant :function_call, -> { OpenAI::Beta::BetaResponseFunctionToolCallItem }
34
+
35
+ variant :function_call_output, -> { OpenAI::Beta::BetaResponseFunctionToolCallOutputItem }
36
+
37
+ variant :agent_message, -> { OpenAI::Beta::BetaResponseItem::AgentMessage }
38
+
39
+ variant :multi_agent_call, -> { OpenAI::Beta::BetaResponseItem::MultiAgentCall }
40
+
41
+ variant :multi_agent_call_output, -> { OpenAI::Beta::BetaResponseItem::MultiAgentCallOutput }
42
+
43
+ variant :tool_search_call, -> { OpenAI::Beta::BetaResponseToolSearchCall }
44
+
45
+ variant :tool_search_output, -> { OpenAI::Beta::BetaResponseToolSearchOutputItem }
46
+
47
+ variant :additional_tools, -> { OpenAI::Beta::BetaResponseItem::AdditionalTools }
48
+
49
+ # A description of the chain of thought used by a reasoning model while generating
50
+ # a response. Be sure to include these items in your `input` to the Responses API
51
+ # for subsequent turns of a conversation if you are manually
52
+ # [managing context](https://platform.openai.com/docs/guides/conversation-state).
53
+ variant :reasoning, -> { OpenAI::Beta::BetaResponseReasoningItem }
54
+
55
+ variant :program, -> { OpenAI::Beta::BetaResponseItem::Program }
56
+
57
+ variant :program_output, -> { OpenAI::Beta::BetaResponseItem::ProgramOutput }
58
+
59
+ # A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
60
+ variant :compaction, -> { OpenAI::Beta::BetaResponseCompactionItem }
61
+
62
+ # An image generation request made by the model.
63
+ variant :image_generation_call, -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall }
64
+
65
+ # A tool call to run code.
66
+ variant :code_interpreter_call, -> { OpenAI::Beta::BetaResponseCodeInterpreterToolCall }
67
+
68
+ # A tool call to run a command on the local shell.
69
+ variant :local_shell_call, -> { OpenAI::Beta::BetaResponseItem::LocalShellCall }
70
+
71
+ # The output of a local shell tool call.
72
+ variant :local_shell_call_output, -> { OpenAI::Beta::BetaResponseItem::LocalShellCallOutput }
73
+
74
+ # A tool call that executes one or more shell commands in a managed environment.
75
+ variant :shell_call, -> { OpenAI::Beta::BetaResponseFunctionShellToolCall }
76
+
77
+ # The output of a shell tool call that was emitted.
78
+ variant :shell_call_output, -> { OpenAI::Beta::BetaResponseFunctionShellToolCallOutput }
79
+
80
+ # A tool call that applies file diffs by creating, deleting, or updating files.
81
+ variant :apply_patch_call, -> { OpenAI::Beta::BetaResponseApplyPatchToolCall }
82
+
83
+ # The output emitted by an apply patch tool call.
84
+ variant :apply_patch_call_output, -> { OpenAI::Beta::BetaResponseApplyPatchToolCallOutput }
85
+
86
+ # A list of tools available on an MCP server.
87
+ variant :mcp_list_tools, -> { OpenAI::Beta::BetaResponseItem::McpListTools }
88
+
89
+ # A request for human approval of a tool invocation.
90
+ variant :mcp_approval_request, -> { OpenAI::Beta::BetaResponseItem::McpApprovalRequest }
91
+
92
+ # A response to an MCP approval request.
93
+ variant :mcp_approval_response, -> { OpenAI::Beta::BetaResponseItem::McpApprovalResponse }
94
+
95
+ # An invocation of a tool on an MCP server.
96
+ variant :mcp_call, -> { OpenAI::Beta::BetaResponseItem::McpCall }
97
+
98
+ # A call to a custom tool created by the model.
99
+ variant :custom_tool_call, -> { OpenAI::Beta::BetaResponseCustomToolCallItem }
100
+
101
+ # The output of a custom tool call from your code, being sent back to the model.
102
+ variant :custom_tool_call_output, -> { OpenAI::Beta::BetaResponseCustomToolCallOutputItem }
103
+
104
+ class AgentMessage < OpenAI::Internal::Type::BaseModel
105
+ # @!attribute id
106
+ # The unique ID of the agent message.
107
+ #
108
+ # @return [String]
109
+ required :id, String
110
+
111
+ # @!attribute author
112
+ # The sending agent identity.
113
+ #
114
+ # @return [String]
115
+ required :author, String
116
+
117
+ # @!attribute content
118
+ # Encrypted content sent between agents.
119
+ #
120
+ # @return [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::Text, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::SummaryText, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ReasoningText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot, OpenAI::Models::Beta::BetaResponseInputFile, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::EncryptedContent>]
121
+ required :content,
122
+ -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseItem::AgentMessage::Content] }
123
+
124
+ # @!attribute recipient
125
+ # The destination agent identity.
126
+ #
127
+ # @return [String]
128
+ required :recipient, String
129
+
130
+ # @!attribute type
131
+ # The type of the item. Always `agent_message`.
132
+ #
133
+ # @return [Symbol, :agent_message]
134
+ required :type, const: :agent_message
135
+
136
+ # @!attribute agent
137
+ # The agent that produced this item.
138
+ #
139
+ # @return [OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Agent, nil]
140
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::AgentMessage::Agent }
141
+
142
+ # @!method initialize(id:, author:, content:, recipient:, agent: nil, type: :agent_message)
143
+ # @param id [String] The unique ID of the agent message.
144
+ #
145
+ # @param author [String] The sending agent identity.
146
+ #
147
+ # @param content [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::Text, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::SummaryText, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ReasoningText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot, OpenAI::Models::Beta::BetaResponseInputFile, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::EncryptedContent>] Encrypted content sent between agents.
148
+ #
149
+ # @param recipient [String] The destination agent identity.
150
+ #
151
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Agent] The agent that produced this item.
152
+ #
153
+ # @param type [Symbol, :agent_message] The type of the item. Always `agent_message`.
154
+
155
+ # A content part that makes up an input or output item.
156
+ module Content
157
+ extend OpenAI::Internal::Type::Union
158
+
159
+ discriminator :type
160
+
161
+ # A text input to the model.
162
+ variant :input_text, -> { OpenAI::Beta::BetaResponseInputText }
163
+
164
+ # A text output from the model.
165
+ variant :output_text, -> { OpenAI::Beta::BetaResponseOutputText }
166
+
167
+ # A text content.
168
+ variant :text, -> { OpenAI::Beta::BetaResponseItem::AgentMessage::Content::Text }
169
+
170
+ # A summary text from the model.
171
+ variant :summary_text, -> { OpenAI::Beta::BetaResponseItem::AgentMessage::Content::SummaryText }
172
+
173
+ # Reasoning text from the model.
174
+ variant :reasoning_text, -> { OpenAI::Beta::BetaResponseItem::AgentMessage::Content::ReasoningText }
175
+
176
+ # A refusal from the model.
177
+ variant :refusal, -> { OpenAI::Beta::BetaResponseOutputRefusal }
178
+
179
+ # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
180
+ variant :input_image, -> { OpenAI::Beta::BetaResponseInputImage }
181
+
182
+ # A screenshot of a computer.
183
+ variant :computer_screenshot,
184
+ -> { OpenAI::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot }
185
+
186
+ # A file input to the model.
187
+ variant :input_file, -> { OpenAI::Beta::BetaResponseInputFile }
188
+
189
+ # Opaque encrypted content that Responses API decrypts inside trusted model execution.
190
+ variant :encrypted_content, -> { OpenAI::Beta::BetaResponseItem::AgentMessage::Content::EncryptedContent }
191
+
192
+ class Text < OpenAI::Internal::Type::BaseModel
193
+ # @!attribute text
194
+ #
195
+ # @return [String]
196
+ required :text, String
197
+
198
+ # @!attribute type
199
+ #
200
+ # @return [Symbol, :text]
201
+ required :type, const: :text
202
+
203
+ # @!method initialize(text:, type: :text)
204
+ # A text content.
205
+ #
206
+ # @param text [String]
207
+ # @param type [Symbol, :text]
208
+ end
209
+
210
+ class SummaryText < OpenAI::Internal::Type::BaseModel
211
+ # @!attribute text
212
+ # A summary of the reasoning output from the model so far.
213
+ #
214
+ # @return [String]
215
+ required :text, String
216
+
217
+ # @!attribute type
218
+ # The type of the object. Always `summary_text`.
219
+ #
220
+ # @return [Symbol, :summary_text]
221
+ required :type, const: :summary_text
222
+
223
+ # @!method initialize(text:, type: :summary_text)
224
+ # A summary text from the model.
225
+ #
226
+ # @param text [String] A summary of the reasoning output from the model so far.
227
+ #
228
+ # @param type [Symbol, :summary_text] The type of the object. Always `summary_text`.
229
+ end
230
+
231
+ class ReasoningText < OpenAI::Internal::Type::BaseModel
232
+ # @!attribute text
233
+ # The reasoning text from the model.
234
+ #
235
+ # @return [String]
236
+ required :text, String
237
+
238
+ # @!attribute type
239
+ # The type of the reasoning text. Always `reasoning_text`.
240
+ #
241
+ # @return [Symbol, :reasoning_text]
242
+ required :type, const: :reasoning_text
243
+
244
+ # @!method initialize(text:, type: :reasoning_text)
245
+ # Reasoning text from the model.
246
+ #
247
+ # @param text [String] The reasoning text from the model.
248
+ #
249
+ # @param type [Symbol, :reasoning_text] The type of the reasoning text. Always `reasoning_text`.
250
+ end
251
+
252
+ class ComputerScreenshot < OpenAI::Internal::Type::BaseModel
253
+ # @!attribute detail
254
+ # The detail level of the screenshot image to be sent to the model. One of `high`,
255
+ # `low`, `auto`, or `original`. Defaults to `auto`.
256
+ #
257
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::Detail]
258
+ required :detail,
259
+ enum: -> { OpenAI::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::Detail }
260
+
261
+ # @!attribute file_id
262
+ # The identifier of an uploaded file that contains the screenshot.
263
+ #
264
+ # @return [String, nil]
265
+ required :file_id, String, nil?: true
266
+
267
+ # @!attribute image_url
268
+ # The URL of the screenshot image.
269
+ #
270
+ # @return [String, nil]
271
+ required :image_url, String, nil?: true
272
+
273
+ # @!attribute type
274
+ # Specifies the event type. For a computer screenshot, this property is always set
275
+ # to `computer_screenshot`.
276
+ #
277
+ # @return [Symbol, :computer_screenshot]
278
+ required :type, const: :computer_screenshot
279
+
280
+ # @!attribute prompt_cache_breakpoint
281
+ # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
282
+ # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
283
+ # token block.
284
+ #
285
+ # @return [OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::PromptCacheBreakpoint, nil]
286
+ optional :prompt_cache_breakpoint,
287
+ -> { OpenAI::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::PromptCacheBreakpoint }
288
+
289
+ # @!method initialize(detail:, file_id:, image_url:, prompt_cache_breakpoint: nil, type: :computer_screenshot)
290
+ # Some parameter documentations has been truncated, see
291
+ # {OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot}
292
+ # for more details.
293
+ #
294
+ # A screenshot of a computer.
295
+ #
296
+ # @param detail [Symbol, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::Detail] The detail level of the screenshot image to be sent to the model. One of `high`,
297
+ #
298
+ # @param file_id [String, nil] The identifier of an uploaded file that contains the screenshot.
299
+ #
300
+ # @param image_url [String, nil] The URL of the screenshot image.
301
+ #
302
+ # @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
303
+ #
304
+ # @param type [Symbol, :computer_screenshot] Specifies the event type. For a computer screenshot, this property is always set
305
+
306
+ # The detail level of the screenshot image to be sent to the model. One of `high`,
307
+ # `low`, `auto`, or `original`. Defaults to `auto`.
308
+ #
309
+ # @see OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot#detail
310
+ module Detail
311
+ extend OpenAI::Internal::Type::Enum
312
+
313
+ LOW = :low
314
+ HIGH = :high
315
+ AUTO = :auto
316
+ ORIGINAL = :original
317
+
318
+ # @!method self.values
319
+ # @return [Array<Symbol>]
320
+ end
321
+
322
+ # @see OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot#prompt_cache_breakpoint
323
+ class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
324
+ # @!attribute mode
325
+ # The breakpoint mode. Always `explicit`.
326
+ #
327
+ # @return [Symbol, :explicit]
328
+ required :mode, const: :explicit
329
+
330
+ # @!method initialize(mode: :explicit)
331
+ # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
332
+ # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
333
+ # token block.
334
+ #
335
+ # @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
336
+ end
337
+ end
338
+
339
+ class EncryptedContent < OpenAI::Internal::Type::BaseModel
340
+ # @!attribute encrypted_content
341
+ # Opaque encrypted content.
342
+ #
343
+ # @return [String]
344
+ required :encrypted_content, String
345
+
346
+ # @!attribute type
347
+ # The type of the input item. Always `encrypted_content`.
348
+ #
349
+ # @return [Symbol, :encrypted_content]
350
+ required :type, const: :encrypted_content
351
+
352
+ # @!method initialize(encrypted_content:, type: :encrypted_content)
353
+ # Opaque encrypted content that Responses API decrypts inside trusted model
354
+ # execution.
355
+ #
356
+ # @param encrypted_content [String] Opaque encrypted content.
357
+ #
358
+ # @param type [Symbol, :encrypted_content] The type of the input item. Always `encrypted_content`.
359
+ end
360
+
361
+ # @!method self.variants
362
+ # @return [Array(OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::Text, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::SummaryText, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ReasoningText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot, OpenAI::Models::Beta::BetaResponseInputFile, OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::EncryptedContent)]
363
+ end
364
+
365
+ # @see OpenAI::Models::Beta::BetaResponseItem::AgentMessage#agent
366
+ class Agent < OpenAI::Internal::Type::BaseModel
367
+ # @!attribute agent_name
368
+ # The canonical name of the agent that produced this item.
369
+ #
370
+ # @return [String]
371
+ required :agent_name, String
372
+
373
+ # @!method initialize(agent_name:)
374
+ # The agent that produced this item.
375
+ #
376
+ # @param agent_name [String] The canonical name of the agent that produced this item.
377
+ end
378
+ end
379
+
380
+ class MultiAgentCall < OpenAI::Internal::Type::BaseModel
381
+ # @!attribute id
382
+ # The unique ID of the multi-agent call item.
383
+ #
384
+ # @return [String]
385
+ required :id, String
386
+
387
+ # @!attribute action
388
+ # The multi-agent action to execute.
389
+ #
390
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall::Action]
391
+ required :action, enum: -> { OpenAI::Beta::BetaResponseItem::MultiAgentCall::Action }
392
+
393
+ # @!attribute arguments
394
+ # The JSON string of arguments generated for the action.
395
+ #
396
+ # @return [String]
397
+ required :arguments, String
398
+
399
+ # @!attribute call_id
400
+ # The unique ID linking this call to its output.
401
+ #
402
+ # @return [String]
403
+ required :call_id, String
404
+
405
+ # @!attribute type
406
+ # The type of the multi-agent call. Always `multi_agent_call`.
407
+ #
408
+ # @return [Symbol, :multi_agent_call]
409
+ required :type, const: :multi_agent_call
410
+
411
+ # @!attribute agent
412
+ # The agent that produced this item.
413
+ #
414
+ # @return [OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall::Agent, nil]
415
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::MultiAgentCall::Agent }
416
+
417
+ # @!method initialize(id:, action:, arguments:, call_id:, agent: nil, type: :multi_agent_call)
418
+ # @param id [String] The unique ID of the multi-agent call item.
419
+ #
420
+ # @param action [Symbol, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall::Action] The multi-agent action to execute.
421
+ #
422
+ # @param arguments [String] The JSON string of arguments generated for the action.
423
+ #
424
+ # @param call_id [String] The unique ID linking this call to its output.
425
+ #
426
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall::Agent] The agent that produced this item.
427
+ #
428
+ # @param type [Symbol, :multi_agent_call] The type of the multi-agent call. Always `multi_agent_call`.
429
+
430
+ # The multi-agent action to execute.
431
+ #
432
+ # @see OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall#action
433
+ module Action
434
+ extend OpenAI::Internal::Type::Enum
435
+
436
+ SPAWN_AGENT = :spawn_agent
437
+ INTERRUPT_AGENT = :interrupt_agent
438
+ LIST_AGENTS = :list_agents
439
+ SEND_MESSAGE = :send_message
440
+ FOLLOWUP_TASK = :followup_task
441
+ WAIT_AGENT = :wait_agent
442
+
443
+ # @!method self.values
444
+ # @return [Array<Symbol>]
445
+ end
446
+
447
+ # @see OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall#agent
448
+ class Agent < OpenAI::Internal::Type::BaseModel
449
+ # @!attribute agent_name
450
+ # The canonical name of the agent that produced this item.
451
+ #
452
+ # @return [String]
453
+ required :agent_name, String
454
+
455
+ # @!method initialize(agent_name:)
456
+ # The agent that produced this item.
457
+ #
458
+ # @param agent_name [String] The canonical name of the agent that produced this item.
459
+ end
460
+ end
461
+
462
+ class MultiAgentCallOutput < OpenAI::Internal::Type::BaseModel
463
+ # @!attribute id
464
+ # The unique ID of the multi-agent call output item.
465
+ #
466
+ # @return [String]
467
+ required :id, String
468
+
469
+ # @!attribute action
470
+ # The multi-agent action that produced this result.
471
+ #
472
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput::Action]
473
+ required :action, enum: -> { OpenAI::Beta::BetaResponseItem::MultiAgentCallOutput::Action }
474
+
475
+ # @!attribute call_id
476
+ # The unique ID of the multi-agent call.
477
+ #
478
+ # @return [String]
479
+ required :call_id, String
480
+
481
+ # @!attribute output
482
+ # Text output returned by the multi-agent action.
483
+ #
484
+ # @return [Array<OpenAI::Models::Beta::BetaResponseOutputText>]
485
+ required :output, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseOutputText] }
486
+
487
+ # @!attribute type
488
+ # The type of the multi-agent result. Always `multi_agent_call_output`.
489
+ #
490
+ # @return [Symbol, :multi_agent_call_output]
491
+ required :type, const: :multi_agent_call_output
492
+
493
+ # @!attribute agent
494
+ # The agent that produced this item.
495
+ #
496
+ # @return [OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput::Agent, nil]
497
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::MultiAgentCallOutput::Agent }
498
+
499
+ # @!method initialize(id:, action:, call_id:, output:, agent: nil, type: :multi_agent_call_output)
500
+ # @param id [String] The unique ID of the multi-agent call output item.
501
+ #
502
+ # @param action [Symbol, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput::Action] The multi-agent action that produced this result.
503
+ #
504
+ # @param call_id [String] The unique ID of the multi-agent call.
505
+ #
506
+ # @param output [Array<OpenAI::Models::Beta::BetaResponseOutputText>] Text output returned by the multi-agent action.
507
+ #
508
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput::Agent] The agent that produced this item.
509
+ #
510
+ # @param type [Symbol, :multi_agent_call_output] The type of the multi-agent result. Always `multi_agent_call_output`.
511
+
512
+ # The multi-agent action that produced this result.
513
+ #
514
+ # @see OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput#action
515
+ module Action
516
+ extend OpenAI::Internal::Type::Enum
517
+
518
+ SPAWN_AGENT = :spawn_agent
519
+ INTERRUPT_AGENT = :interrupt_agent
520
+ LIST_AGENTS = :list_agents
521
+ SEND_MESSAGE = :send_message
522
+ FOLLOWUP_TASK = :followup_task
523
+ WAIT_AGENT = :wait_agent
524
+
525
+ # @!method self.values
526
+ # @return [Array<Symbol>]
527
+ end
528
+
529
+ # @see OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput#agent
530
+ class Agent < OpenAI::Internal::Type::BaseModel
531
+ # @!attribute agent_name
532
+ # The canonical name of the agent that produced this item.
533
+ #
534
+ # @return [String]
535
+ required :agent_name, String
536
+
537
+ # @!method initialize(agent_name:)
538
+ # The agent that produced this item.
539
+ #
540
+ # @param agent_name [String] The canonical name of the agent that produced this item.
541
+ end
542
+ end
543
+
544
+ class AdditionalTools < OpenAI::Internal::Type::BaseModel
545
+ # @!attribute id
546
+ # The unique ID of the additional tools item.
547
+ #
548
+ # @return [String]
549
+ required :id, String
550
+
551
+ # @!attribute role
552
+ # The role that provided the additional tools.
553
+ #
554
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools::Role]
555
+ required :role, enum: -> { OpenAI::Beta::BetaResponseItem::AdditionalTools::Role }
556
+
557
+ # @!attribute tools
558
+ # The additional tool definitions made available at this item.
559
+ #
560
+ # @return [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>]
561
+ required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaTool] }
562
+
563
+ # @!attribute type
564
+ # The type of the item. Always `additional_tools`.
565
+ #
566
+ # @return [Symbol, :additional_tools]
567
+ required :type, const: :additional_tools
568
+
569
+ # @!attribute agent
570
+ # The agent that produced this item.
571
+ #
572
+ # @return [OpenAI::Models::Beta::BetaResponseItem::AdditionalTools::Agent, nil]
573
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::AdditionalTools::Agent }
574
+
575
+ # @!method initialize(id:, role:, tools:, agent: nil, type: :additional_tools)
576
+ # @param id [String] The unique ID of the additional tools item.
577
+ #
578
+ # @param role [Symbol, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools::Role] The role that provided the additional tools.
579
+ #
580
+ # @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>] The additional tool definitions made available at this item.
581
+ #
582
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::AdditionalTools::Agent] The agent that produced this item.
583
+ #
584
+ # @param type [Symbol, :additional_tools] The type of the item. Always `additional_tools`.
585
+
586
+ # The role that provided the additional tools.
587
+ #
588
+ # @see OpenAI::Models::Beta::BetaResponseItem::AdditionalTools#role
589
+ module Role
590
+ extend OpenAI::Internal::Type::Enum
591
+
592
+ UNKNOWN = :unknown
593
+ USER = :user
594
+ ASSISTANT = :assistant
595
+ SYSTEM = :system
596
+ CRITIC = :critic
597
+ DISCRIMINATOR = :discriminator
598
+ DEVELOPER = :developer
599
+ TOOL = :tool
600
+
601
+ # @!method self.values
602
+ # @return [Array<Symbol>]
603
+ end
604
+
605
+ # @see OpenAI::Models::Beta::BetaResponseItem::AdditionalTools#agent
606
+ class Agent < OpenAI::Internal::Type::BaseModel
607
+ # @!attribute agent_name
608
+ # The canonical name of the agent that produced this item.
609
+ #
610
+ # @return [String]
611
+ required :agent_name, String
612
+
613
+ # @!method initialize(agent_name:)
614
+ # The agent that produced this item.
615
+ #
616
+ # @param agent_name [String] The canonical name of the agent that produced this item.
617
+ end
618
+ end
619
+
620
+ class Program < OpenAI::Internal::Type::BaseModel
621
+ # @!attribute id
622
+ # The unique ID of the program item.
623
+ #
624
+ # @return [String]
625
+ required :id, String
626
+
627
+ # @!attribute call_id
628
+ # The stable call ID of the program item.
629
+ #
630
+ # @return [String]
631
+ required :call_id, String
632
+
633
+ # @!attribute code
634
+ # The JavaScript source executed by programmatic tool calling.
635
+ #
636
+ # @return [String]
637
+ required :code, String
638
+
639
+ # @!attribute fingerprint
640
+ # Opaque program replay fingerprint that must be round-tripped.
641
+ #
642
+ # @return [String]
643
+ required :fingerprint, String
644
+
645
+ # @!attribute type
646
+ # The type of the item. Always `program`.
647
+ #
648
+ # @return [Symbol, :program]
649
+ required :type, const: :program
650
+
651
+ # @!attribute agent
652
+ # The agent that produced this item.
653
+ #
654
+ # @return [OpenAI::Models::Beta::BetaResponseItem::Program::Agent, nil]
655
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::Program::Agent }
656
+
657
+ # @!method initialize(id:, call_id:, code:, fingerprint:, agent: nil, type: :program)
658
+ # @param id [String] The unique ID of the program item.
659
+ #
660
+ # @param call_id [String] The stable call ID of the program item.
661
+ #
662
+ # @param code [String] The JavaScript source executed by programmatic tool calling.
663
+ #
664
+ # @param fingerprint [String] Opaque program replay fingerprint that must be round-tripped.
665
+ #
666
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::Program::Agent] The agent that produced this item.
667
+ #
668
+ # @param type [Symbol, :program] The type of the item. Always `program`.
669
+
670
+ # @see OpenAI::Models::Beta::BetaResponseItem::Program#agent
671
+ class Agent < OpenAI::Internal::Type::BaseModel
672
+ # @!attribute agent_name
673
+ # The canonical name of the agent that produced this item.
674
+ #
675
+ # @return [String]
676
+ required :agent_name, String
677
+
678
+ # @!method initialize(agent_name:)
679
+ # The agent that produced this item.
680
+ #
681
+ # @param agent_name [String] The canonical name of the agent that produced this item.
682
+ end
683
+ end
684
+
685
+ class ProgramOutput < OpenAI::Internal::Type::BaseModel
686
+ # @!attribute id
687
+ # The unique ID of the program output item.
688
+ #
689
+ # @return [String]
690
+ required :id, String
691
+
692
+ # @!attribute call_id
693
+ # The call ID of the program item.
694
+ #
695
+ # @return [String]
696
+ required :call_id, String
697
+
698
+ # @!attribute result
699
+ # The result produced by the program item.
700
+ #
701
+ # @return [String]
702
+ required :result, String
703
+
704
+ # @!attribute status
705
+ # The terminal status of the program output item.
706
+ #
707
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::ProgramOutput::Status]
708
+ required :status, enum: -> { OpenAI::Beta::BetaResponseItem::ProgramOutput::Status }
709
+
710
+ # @!attribute type
711
+ # The type of the item. Always `program_output`.
712
+ #
713
+ # @return [Symbol, :program_output]
714
+ required :type, const: :program_output
715
+
716
+ # @!attribute agent
717
+ # The agent that produced this item.
718
+ #
719
+ # @return [OpenAI::Models::Beta::BetaResponseItem::ProgramOutput::Agent, nil]
720
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::ProgramOutput::Agent }
721
+
722
+ # @!method initialize(id:, call_id:, result:, status:, agent: nil, type: :program_output)
723
+ # @param id [String] The unique ID of the program output item.
724
+ #
725
+ # @param call_id [String] The call ID of the program item.
726
+ #
727
+ # @param result [String] The result produced by the program item.
728
+ #
729
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseItem::ProgramOutput::Status] The terminal status of the program output item.
730
+ #
731
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::ProgramOutput::Agent] The agent that produced this item.
732
+ #
733
+ # @param type [Symbol, :program_output] The type of the item. Always `program_output`.
734
+
735
+ # The terminal status of the program output item.
736
+ #
737
+ # @see OpenAI::Models::Beta::BetaResponseItem::ProgramOutput#status
738
+ module Status
739
+ extend OpenAI::Internal::Type::Enum
740
+
741
+ COMPLETED = :completed
742
+ INCOMPLETE = :incomplete
743
+
744
+ # @!method self.values
745
+ # @return [Array<Symbol>]
746
+ end
747
+
748
+ # @see OpenAI::Models::Beta::BetaResponseItem::ProgramOutput#agent
749
+ class Agent < OpenAI::Internal::Type::BaseModel
750
+ # @!attribute agent_name
751
+ # The canonical name of the agent that produced this item.
752
+ #
753
+ # @return [String]
754
+ required :agent_name, String
755
+
756
+ # @!method initialize(agent_name:)
757
+ # The agent that produced this item.
758
+ #
759
+ # @param agent_name [String] The canonical name of the agent that produced this item.
760
+ end
761
+ end
762
+
763
+ class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
764
+ # @!attribute id
765
+ # The unique ID of the image generation call.
766
+ #
767
+ # @return [String]
768
+ required :id, String
769
+
770
+ # @!attribute result
771
+ # The generated image encoded in base64.
772
+ #
773
+ # @return [String, nil]
774
+ required :result, String, nil?: true
775
+
776
+ # @!attribute status
777
+ # The status of the image generation call.
778
+ #
779
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Status]
780
+ required :status, enum: -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Status }
781
+
782
+ # @!attribute type
783
+ # The type of the image generation call. Always `image_generation_call`.
784
+ #
785
+ # @return [Symbol, :image_generation_call]
786
+ required :type, const: :image_generation_call
787
+
788
+ # @!attribute agent
789
+ # The agent that produced this item.
790
+ #
791
+ # @return [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Agent, nil]
792
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Agent }, nil?: true
793
+
794
+ # @!method initialize(id:, result:, status:, agent: nil, type: :image_generation_call)
795
+ # Some parameter documentations has been truncated, see
796
+ # {OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall} for more details.
797
+ #
798
+ # An image generation request made by the model.
799
+ #
800
+ # @param id [String] The unique ID of the image generation call.
801
+ #
802
+ # @param result [String, nil] The generated image encoded in base64.
803
+ #
804
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Status] The status of the image generation call.
805
+ #
806
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Agent, nil] The agent that produced this item.
807
+ #
808
+ # @param type [Symbol, :image_generation_call] The type of the image generation call. Always `image_generation_call`.
809
+
810
+ # The status of the image generation call.
811
+ #
812
+ # @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#status
813
+ module Status
814
+ extend OpenAI::Internal::Type::Enum
815
+
816
+ IN_PROGRESS = :in_progress
817
+ COMPLETED = :completed
818
+ GENERATING = :generating
819
+ FAILED = :failed
820
+
821
+ # @!method self.values
822
+ # @return [Array<Symbol>]
823
+ end
824
+
825
+ # @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#agent
826
+ class Agent < OpenAI::Internal::Type::BaseModel
827
+ # @!attribute agent_name
828
+ # The canonical name of the agent that produced this item.
829
+ #
830
+ # @return [String]
831
+ required :agent_name, String
832
+
833
+ # @!method initialize(agent_name:)
834
+ # The agent that produced this item.
835
+ #
836
+ # @param agent_name [String] The canonical name of the agent that produced this item.
837
+ end
838
+ end
839
+
840
+ class LocalShellCall < OpenAI::Internal::Type::BaseModel
841
+ # @!attribute id
842
+ # The unique ID of the local shell call.
843
+ #
844
+ # @return [String]
845
+ required :id, String
846
+
847
+ # @!attribute action
848
+ # Execute a shell command on the server.
849
+ #
850
+ # @return [OpenAI::Models::Beta::BetaResponseItem::LocalShellCall::Action]
851
+ required :action, -> { OpenAI::Beta::BetaResponseItem::LocalShellCall::Action }
852
+
853
+ # @!attribute call_id
854
+ # The unique ID of the local shell tool call generated by the model.
855
+ #
856
+ # @return [String]
857
+ required :call_id, String
858
+
859
+ # @!attribute status
860
+ # The status of the local shell call.
861
+ #
862
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::LocalShellCall::Status]
863
+ required :status, enum: -> { OpenAI::Beta::BetaResponseItem::LocalShellCall::Status }
864
+
865
+ # @!attribute type
866
+ # The type of the local shell call. Always `local_shell_call`.
867
+ #
868
+ # @return [Symbol, :local_shell_call]
869
+ required :type, const: :local_shell_call
870
+
871
+ # @!attribute agent
872
+ # The agent that produced this item.
873
+ #
874
+ # @return [OpenAI::Models::Beta::BetaResponseItem::LocalShellCall::Agent, nil]
875
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::LocalShellCall::Agent }, nil?: true
876
+
877
+ # @!method initialize(id:, action:, call_id:, status:, agent: nil, type: :local_shell_call)
878
+ # Some parameter documentations has been truncated, see
879
+ # {OpenAI::Models::Beta::BetaResponseItem::LocalShellCall} for more details.
880
+ #
881
+ # A tool call to run a command on the local shell.
882
+ #
883
+ # @param id [String] The unique ID of the local shell call.
884
+ #
885
+ # @param action [OpenAI::Models::Beta::BetaResponseItem::LocalShellCall::Action] Execute a shell command on the server.
886
+ #
887
+ # @param call_id [String] The unique ID of the local shell tool call generated by the model.
888
+ #
889
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseItem::LocalShellCall::Status] The status of the local shell call.
890
+ #
891
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::LocalShellCall::Agent, nil] The agent that produced this item.
892
+ #
893
+ # @param type [Symbol, :local_shell_call] The type of the local shell call. Always `local_shell_call`.
894
+
895
+ # @see OpenAI::Models::Beta::BetaResponseItem::LocalShellCall#action
896
+ class Action < OpenAI::Internal::Type::BaseModel
897
+ # @!attribute command
898
+ # The command to run.
899
+ #
900
+ # @return [Array<String>]
901
+ required :command, OpenAI::Internal::Type::ArrayOf[String]
902
+
903
+ # @!attribute env
904
+ # Environment variables to set for the command.
905
+ #
906
+ # @return [Hash{Symbol=>String}]
907
+ required :env, OpenAI::Internal::Type::HashOf[String]
908
+
909
+ # @!attribute type
910
+ # The type of the local shell action. Always `exec`.
911
+ #
912
+ # @return [Symbol, :exec]
913
+ required :type, const: :exec
914
+
915
+ # @!attribute timeout_ms
916
+ # Optional timeout in milliseconds for the command.
917
+ #
918
+ # @return [Integer, nil]
919
+ optional :timeout_ms, Integer, nil?: true
920
+
921
+ # @!attribute user
922
+ # Optional user to run the command as.
923
+ #
924
+ # @return [String, nil]
925
+ optional :user, String, nil?: true
926
+
927
+ # @!attribute working_directory
928
+ # Optional working directory to run the command in.
929
+ #
930
+ # @return [String, nil]
931
+ optional :working_directory, String, nil?: true
932
+
933
+ # @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
934
+ # Execute a shell command on the server.
935
+ #
936
+ # @param command [Array<String>] The command to run.
937
+ #
938
+ # @param env [Hash{Symbol=>String}] Environment variables to set for the command.
939
+ #
940
+ # @param timeout_ms [Integer, nil] Optional timeout in milliseconds for the command.
941
+ #
942
+ # @param user [String, nil] Optional user to run the command as.
943
+ #
944
+ # @param working_directory [String, nil] Optional working directory to run the command in.
945
+ #
946
+ # @param type [Symbol, :exec] The type of the local shell action. Always `exec`.
947
+ end
948
+
949
+ # The status of the local shell call.
950
+ #
951
+ # @see OpenAI::Models::Beta::BetaResponseItem::LocalShellCall#status
952
+ module Status
953
+ extend OpenAI::Internal::Type::Enum
954
+
955
+ IN_PROGRESS = :in_progress
956
+ COMPLETED = :completed
957
+ INCOMPLETE = :incomplete
958
+
959
+ # @!method self.values
960
+ # @return [Array<Symbol>]
961
+ end
962
+
963
+ # @see OpenAI::Models::Beta::BetaResponseItem::LocalShellCall#agent
964
+ class Agent < OpenAI::Internal::Type::BaseModel
965
+ # @!attribute agent_name
966
+ # The canonical name of the agent that produced this item.
967
+ #
968
+ # @return [String]
969
+ required :agent_name, String
970
+
971
+ # @!method initialize(agent_name:)
972
+ # The agent that produced this item.
973
+ #
974
+ # @param agent_name [String] The canonical name of the agent that produced this item.
975
+ end
976
+ end
977
+
978
+ class LocalShellCallOutput < OpenAI::Internal::Type::BaseModel
979
+ # @!attribute id
980
+ # The unique ID of the local shell tool call generated by the model.
981
+ #
982
+ # @return [String]
983
+ required :id, String
984
+
985
+ # @!attribute output
986
+ # A JSON string of the output of the local shell tool call.
987
+ #
988
+ # @return [String]
989
+ required :output, String
990
+
991
+ # @!attribute type
992
+ # The type of the local shell tool call output. Always `local_shell_call_output`.
993
+ #
994
+ # @return [Symbol, :local_shell_call_output]
995
+ required :type, const: :local_shell_call_output
996
+
997
+ # @!attribute agent
998
+ # The agent that produced this item.
999
+ #
1000
+ # @return [OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput::Agent, nil]
1001
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::LocalShellCallOutput::Agent }, nil?: true
1002
+
1003
+ # @!attribute status
1004
+ # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
1005
+ #
1006
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput::Status, nil]
1007
+ optional :status,
1008
+ enum: -> {
1009
+ OpenAI::Beta::BetaResponseItem::LocalShellCallOutput::Status
1010
+ },
1011
+ nil?: true
1012
+
1013
+ # @!method initialize(id:, output:, agent: nil, status: nil, type: :local_shell_call_output)
1014
+ # Some parameter documentations has been truncated, see
1015
+ # {OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput} for more details.
1016
+ #
1017
+ # The output of a local shell tool call.
1018
+ #
1019
+ # @param id [String] The unique ID of the local shell tool call generated by the model.
1020
+ #
1021
+ # @param output [String] A JSON string of the output of the local shell tool call.
1022
+ #
1023
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput::Agent, nil] The agent that produced this item.
1024
+ #
1025
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput::Status, nil] The status of the item. One of `in_progress`, `completed`, or `incomplete`.
1026
+ #
1027
+ # @param type [Symbol, :local_shell_call_output] The type of the local shell tool call output. Always `local_shell_call_output`.
1028
+
1029
+ # @see OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput#agent
1030
+ class Agent < OpenAI::Internal::Type::BaseModel
1031
+ # @!attribute agent_name
1032
+ # The canonical name of the agent that produced this item.
1033
+ #
1034
+ # @return [String]
1035
+ required :agent_name, String
1036
+
1037
+ # @!method initialize(agent_name:)
1038
+ # The agent that produced this item.
1039
+ #
1040
+ # @param agent_name [String] The canonical name of the agent that produced this item.
1041
+ end
1042
+
1043
+ # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
1044
+ #
1045
+ # @see OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput#status
1046
+ module Status
1047
+ extend OpenAI::Internal::Type::Enum
1048
+
1049
+ IN_PROGRESS = :in_progress
1050
+ COMPLETED = :completed
1051
+ INCOMPLETE = :incomplete
1052
+
1053
+ # @!method self.values
1054
+ # @return [Array<Symbol>]
1055
+ end
1056
+ end
1057
+
1058
+ class McpListTools < OpenAI::Internal::Type::BaseModel
1059
+ # @!attribute id
1060
+ # The unique ID of the list.
1061
+ #
1062
+ # @return [String]
1063
+ required :id, String
1064
+
1065
+ # @!attribute server_label
1066
+ # The label of the MCP server.
1067
+ #
1068
+ # @return [String]
1069
+ required :server_label, String
1070
+
1071
+ # @!attribute tools
1072
+ # The tools available on the server.
1073
+ #
1074
+ # @return [Array<OpenAI::Models::Beta::BetaResponseItem::McpListTools::Tool>]
1075
+ required :tools,
1076
+ -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseItem::McpListTools::Tool] }
1077
+
1078
+ # @!attribute type
1079
+ # The type of the item. Always `mcp_list_tools`.
1080
+ #
1081
+ # @return [Symbol, :mcp_list_tools]
1082
+ required :type, const: :mcp_list_tools
1083
+
1084
+ # @!attribute agent
1085
+ # The agent that produced this item.
1086
+ #
1087
+ # @return [OpenAI::Models::Beta::BetaResponseItem::McpListTools::Agent, nil]
1088
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::McpListTools::Agent }, nil?: true
1089
+
1090
+ # @!attribute error
1091
+ # Error message if the server could not list tools.
1092
+ #
1093
+ # @return [String, nil]
1094
+ optional :error, String, nil?: true
1095
+
1096
+ # @!method initialize(id:, server_label:, tools:, agent: nil, error: nil, type: :mcp_list_tools)
1097
+ # Some parameter documentations has been truncated, see
1098
+ # {OpenAI::Models::Beta::BetaResponseItem::McpListTools} for more details.
1099
+ #
1100
+ # A list of tools available on an MCP server.
1101
+ #
1102
+ # @param id [String] The unique ID of the list.
1103
+ #
1104
+ # @param server_label [String] The label of the MCP server.
1105
+ #
1106
+ # @param tools [Array<OpenAI::Models::Beta::BetaResponseItem::McpListTools::Tool>] The tools available on the server.
1107
+ #
1108
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::McpListTools::Agent, nil] The agent that produced this item.
1109
+ #
1110
+ # @param error [String, nil] Error message if the server could not list tools.
1111
+ #
1112
+ # @param type [Symbol, :mcp_list_tools] The type of the item. Always `mcp_list_tools`.
1113
+
1114
+ class Tool < OpenAI::Internal::Type::BaseModel
1115
+ # @!attribute input_schema
1116
+ # The JSON schema describing the tool's input.
1117
+ #
1118
+ # @return [Object]
1119
+ required :input_schema, OpenAI::Internal::Type::Unknown
1120
+
1121
+ # @!attribute name
1122
+ # The name of the tool.
1123
+ #
1124
+ # @return [String]
1125
+ required :name, String
1126
+
1127
+ # @!attribute annotations
1128
+ # Additional annotations about the tool.
1129
+ #
1130
+ # @return [Object, nil]
1131
+ optional :annotations, OpenAI::Internal::Type::Unknown, nil?: true
1132
+
1133
+ # @!attribute description
1134
+ # The description of the tool.
1135
+ #
1136
+ # @return [String, nil]
1137
+ optional :description, String, nil?: true
1138
+
1139
+ # @!method initialize(input_schema:, name:, annotations: nil, description: nil)
1140
+ # Some parameter documentations has been truncated, see
1141
+ # {OpenAI::Models::Beta::BetaResponseItem::McpListTools::Tool} for more details.
1142
+ #
1143
+ # A tool available on an MCP server.
1144
+ #
1145
+ # @param input_schema [Object] The JSON schema describing the tool's input.
1146
+ #
1147
+ # @param name [String] The name of the tool.
1148
+ #
1149
+ # @param annotations [Object, nil] Additional annotations about the tool.
1150
+ #
1151
+ # @param description [String, nil] The description of the tool.
1152
+ end
1153
+
1154
+ # @see OpenAI::Models::Beta::BetaResponseItem::McpListTools#agent
1155
+ class Agent < OpenAI::Internal::Type::BaseModel
1156
+ # @!attribute agent_name
1157
+ # The canonical name of the agent that produced this item.
1158
+ #
1159
+ # @return [String]
1160
+ required :agent_name, String
1161
+
1162
+ # @!method initialize(agent_name:)
1163
+ # The agent that produced this item.
1164
+ #
1165
+ # @param agent_name [String] The canonical name of the agent that produced this item.
1166
+ end
1167
+ end
1168
+
1169
+ class McpApprovalRequest < OpenAI::Internal::Type::BaseModel
1170
+ # @!attribute id
1171
+ # The unique ID of the approval request.
1172
+ #
1173
+ # @return [String]
1174
+ required :id, String
1175
+
1176
+ # @!attribute arguments
1177
+ # A JSON string of arguments for the tool.
1178
+ #
1179
+ # @return [String]
1180
+ required :arguments, String
1181
+
1182
+ # @!attribute name
1183
+ # The name of the tool to run.
1184
+ #
1185
+ # @return [String]
1186
+ required :name, String
1187
+
1188
+ # @!attribute server_label
1189
+ # The label of the MCP server making the request.
1190
+ #
1191
+ # @return [String]
1192
+ required :server_label, String
1193
+
1194
+ # @!attribute type
1195
+ # The type of the item. Always `mcp_approval_request`.
1196
+ #
1197
+ # @return [Symbol, :mcp_approval_request]
1198
+ required :type, const: :mcp_approval_request
1199
+
1200
+ # @!attribute agent
1201
+ # The agent that produced this item.
1202
+ #
1203
+ # @return [OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest::Agent, nil]
1204
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::McpApprovalRequest::Agent }, nil?: true
1205
+
1206
+ # @!method initialize(id:, arguments:, name:, server_label:, agent: nil, type: :mcp_approval_request)
1207
+ # Some parameter documentations has been truncated, see
1208
+ # {OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest} for more details.
1209
+ #
1210
+ # A request for human approval of a tool invocation.
1211
+ #
1212
+ # @param id [String] The unique ID of the approval request.
1213
+ #
1214
+ # @param arguments [String] A JSON string of arguments for the tool.
1215
+ #
1216
+ # @param name [String] The name of the tool to run.
1217
+ #
1218
+ # @param server_label [String] The label of the MCP server making the request.
1219
+ #
1220
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest::Agent, nil] The agent that produced this item.
1221
+ #
1222
+ # @param type [Symbol, :mcp_approval_request] The type of the item. Always `mcp_approval_request`.
1223
+
1224
+ # @see OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest#agent
1225
+ class Agent < OpenAI::Internal::Type::BaseModel
1226
+ # @!attribute agent_name
1227
+ # The canonical name of the agent that produced this item.
1228
+ #
1229
+ # @return [String]
1230
+ required :agent_name, String
1231
+
1232
+ # @!method initialize(agent_name:)
1233
+ # The agent that produced this item.
1234
+ #
1235
+ # @param agent_name [String] The canonical name of the agent that produced this item.
1236
+ end
1237
+ end
1238
+
1239
+ class McpApprovalResponse < OpenAI::Internal::Type::BaseModel
1240
+ # @!attribute id
1241
+ # The unique ID of the approval response
1242
+ #
1243
+ # @return [String]
1244
+ required :id, String
1245
+
1246
+ # @!attribute approval_request_id
1247
+ # The ID of the approval request being answered.
1248
+ #
1249
+ # @return [String]
1250
+ required :approval_request_id, String
1251
+
1252
+ # @!attribute approve
1253
+ # Whether the request was approved.
1254
+ #
1255
+ # @return [Boolean]
1256
+ required :approve, OpenAI::Internal::Type::Boolean
1257
+
1258
+ # @!attribute type
1259
+ # The type of the item. Always `mcp_approval_response`.
1260
+ #
1261
+ # @return [Symbol, :mcp_approval_response]
1262
+ required :type, const: :mcp_approval_response
1263
+
1264
+ # @!attribute agent
1265
+ # The agent that produced this item.
1266
+ #
1267
+ # @return [OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse::Agent, nil]
1268
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::McpApprovalResponse::Agent }, nil?: true
1269
+
1270
+ # @!attribute reason
1271
+ # Optional reason for the decision.
1272
+ #
1273
+ # @return [String, nil]
1274
+ optional :reason, String, nil?: true
1275
+
1276
+ # @!method initialize(id:, approval_request_id:, approve:, agent: nil, reason: nil, type: :mcp_approval_response)
1277
+ # Some parameter documentations has been truncated, see
1278
+ # {OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse} for more details.
1279
+ #
1280
+ # A response to an MCP approval request.
1281
+ #
1282
+ # @param id [String] The unique ID of the approval response
1283
+ #
1284
+ # @param approval_request_id [String] The ID of the approval request being answered.
1285
+ #
1286
+ # @param approve [Boolean] Whether the request was approved.
1287
+ #
1288
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse::Agent, nil] The agent that produced this item.
1289
+ #
1290
+ # @param reason [String, nil] Optional reason for the decision.
1291
+ #
1292
+ # @param type [Symbol, :mcp_approval_response] The type of the item. Always `mcp_approval_response`.
1293
+
1294
+ # @see OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse#agent
1295
+ class Agent < OpenAI::Internal::Type::BaseModel
1296
+ # @!attribute agent_name
1297
+ # The canonical name of the agent that produced this item.
1298
+ #
1299
+ # @return [String]
1300
+ required :agent_name, String
1301
+
1302
+ # @!method initialize(agent_name:)
1303
+ # The agent that produced this item.
1304
+ #
1305
+ # @param agent_name [String] The canonical name of the agent that produced this item.
1306
+ end
1307
+ end
1308
+
1309
+ class McpCall < OpenAI::Internal::Type::BaseModel
1310
+ # @!attribute id
1311
+ # The unique ID of the tool call.
1312
+ #
1313
+ # @return [String]
1314
+ required :id, String
1315
+
1316
+ # @!attribute arguments
1317
+ # A JSON string of the arguments passed to the tool.
1318
+ #
1319
+ # @return [String]
1320
+ required :arguments, String
1321
+
1322
+ # @!attribute name
1323
+ # The name of the tool that was run.
1324
+ #
1325
+ # @return [String]
1326
+ required :name, String
1327
+
1328
+ # @!attribute server_label
1329
+ # The label of the MCP server running the tool.
1330
+ #
1331
+ # @return [String]
1332
+ required :server_label, String
1333
+
1334
+ # @!attribute type
1335
+ # The type of the item. Always `mcp_call`.
1336
+ #
1337
+ # @return [Symbol, :mcp_call]
1338
+ required :type, const: :mcp_call
1339
+
1340
+ # @!attribute agent
1341
+ # The agent that produced this item.
1342
+ #
1343
+ # @return [OpenAI::Models::Beta::BetaResponseItem::McpCall::Agent, nil]
1344
+ optional :agent, -> { OpenAI::Beta::BetaResponseItem::McpCall::Agent }, nil?: true
1345
+
1346
+ # @!attribute approval_request_id
1347
+ # Unique identifier for the MCP tool call approval request. Include this value in
1348
+ # a subsequent `mcp_approval_response` input to approve or reject the
1349
+ # corresponding tool call.
1350
+ #
1351
+ # @return [String, nil]
1352
+ optional :approval_request_id, String, nil?: true
1353
+
1354
+ # @!attribute error
1355
+ # The error from the tool call, if any.
1356
+ #
1357
+ # @return [String, nil]
1358
+ optional :error, String, nil?: true
1359
+
1360
+ # @!attribute output
1361
+ # The output from the tool call.
1362
+ #
1363
+ # @return [String, nil]
1364
+ optional :output, String, nil?: true
1365
+
1366
+ # @!attribute status
1367
+ # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
1368
+ # `calling`, or `failed`.
1369
+ #
1370
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::McpCall::Status, nil]
1371
+ optional :status, enum: -> { OpenAI::Beta::BetaResponseItem::McpCall::Status }
1372
+
1373
+ # @!method initialize(id:, arguments:, name:, server_label:, agent: nil, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
1374
+ # Some parameter documentations has been truncated, see
1375
+ # {OpenAI::Models::Beta::BetaResponseItem::McpCall} for more details.
1376
+ #
1377
+ # An invocation of a tool on an MCP server.
1378
+ #
1379
+ # @param id [String] The unique ID of the tool call.
1380
+ #
1381
+ # @param arguments [String] A JSON string of the arguments passed to the tool.
1382
+ #
1383
+ # @param name [String] The name of the tool that was run.
1384
+ #
1385
+ # @param server_label [String] The label of the MCP server running the tool.
1386
+ #
1387
+ # @param agent [OpenAI::Models::Beta::BetaResponseItem::McpCall::Agent, nil] The agent that produced this item.
1388
+ #
1389
+ # @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
1390
+ #
1391
+ # @param error [String, nil] The error from the tool call, if any.
1392
+ #
1393
+ # @param output [String, nil] The output from the tool call.
1394
+ #
1395
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseItem::McpCall::Status] The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `c
1396
+ #
1397
+ # @param type [Symbol, :mcp_call] The type of the item. Always `mcp_call`.
1398
+
1399
+ # @see OpenAI::Models::Beta::BetaResponseItem::McpCall#agent
1400
+ class Agent < OpenAI::Internal::Type::BaseModel
1401
+ # @!attribute agent_name
1402
+ # The canonical name of the agent that produced this item.
1403
+ #
1404
+ # @return [String]
1405
+ required :agent_name, String
1406
+
1407
+ # @!method initialize(agent_name:)
1408
+ # The agent that produced this item.
1409
+ #
1410
+ # @param agent_name [String] The canonical name of the agent that produced this item.
1411
+ end
1412
+
1413
+ # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
1414
+ # `calling`, or `failed`.
1415
+ #
1416
+ # @see OpenAI::Models::Beta::BetaResponseItem::McpCall#status
1417
+ module Status
1418
+ extend OpenAI::Internal::Type::Enum
1419
+
1420
+ IN_PROGRESS = :in_progress
1421
+ COMPLETED = :completed
1422
+ INCOMPLETE = :incomplete
1423
+ CALLING = :calling
1424
+ FAILED = :failed
1425
+
1426
+ # @!method self.values
1427
+ # @return [Array<Symbol>]
1428
+ end
1429
+ end
1430
+
1431
+ # @!method self.variants
1432
+ # @return [Array(OpenAI::Models::Beta::BetaResponseInputMessageItem, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCallItem, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseItem::AgentMessage, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseItem::Program, OpenAI::Models::Beta::BetaResponseItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseItem::McpListTools, OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallItem, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem)]
1433
+ end
1434
+ end
1435
+
1436
+ BetaResponseItem = Beta::BetaResponseItem
1437
+ end
1438
+ end