openai 0.67.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 (704) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +31 -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 +39 -8
  188. data/lib/openai/models/realtime/realtime_session_create_request.rb +6 -0
  189. data/lib/openai/models/realtime/realtime_session_create_response.rb +45 -8
  190. data/lib/openai/models/realtime/realtime_tools_config_union.rb +39 -8
  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 +74 -10
  230. data/lib/openai/models/video_create_params.rb +1 -0
  231. data/lib/openai/models/video_edit_params.rb +2 -2
  232. data/lib/openai/models/webhooks/safety_identifier_blocked_webhook_event.rb +118 -0
  233. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +4 -1
  234. data/lib/openai/resources/beta/assistants.rb +2 -2
  235. data/lib/openai/resources/beta/responses/input_items.rb +58 -0
  236. data/lib/openai/resources/beta/responses/input_tokens.rb +73 -0
  237. data/lib/openai/resources/beta/responses.rb +440 -0
  238. data/lib/openai/resources/beta/threads/runs.rb +2 -2
  239. data/lib/openai/resources/beta.rb +4 -0
  240. data/lib/openai/resources/chat/completions.rb +10 -6
  241. data/lib/openai/resources/conversations/items.rb +3 -3
  242. data/lib/openai/resources/conversations.rb +1 -1
  243. data/lib/openai/resources/responses/input_items.rb +1 -1
  244. data/lib/openai/resources/responses/input_tokens.rb +3 -3
  245. data/lib/openai/resources/responses.rb +22 -12
  246. data/lib/openai/resources/webhooks.rb +1 -1
  247. data/lib/openai/version.rb +1 -1
  248. data/lib/openai.rb +163 -0
  249. data/rbi/openai/models/beta/assistant_create_params.rbi +12 -26
  250. data/rbi/openai/models/beta/assistant_update_params.rbi +12 -26
  251. data/rbi/openai/models/beta/beta_apply_patch_tool.rbi +99 -0
  252. data/rbi/openai/models/beta/beta_compacted_response.rbi +120 -0
  253. data/rbi/openai/models/beta/beta_computer_action.rbi +593 -0
  254. data/rbi/openai/models/beta/beta_computer_action_list.rbi +18 -0
  255. data/rbi/openai/models/beta/beta_computer_tool.rbi +33 -0
  256. data/rbi/openai/models/beta/beta_computer_use_preview_tool.rbi +126 -0
  257. data/rbi/openai/models/beta/beta_container_auto.rbi +231 -0
  258. data/rbi/openai/models/beta/beta_container_network_policy_allowlist.rbi +81 -0
  259. data/rbi/openai/models/beta/beta_container_network_policy_disabled.rbi +35 -0
  260. data/rbi/openai/models/beta/beta_container_network_policy_domain_secret.rbi +53 -0
  261. data/rbi/openai/models/beta/beta_container_reference.rbi +42 -0
  262. data/rbi/openai/models/beta/beta_custom_tool.rbi +302 -0
  263. data/rbi/openai/models/beta/beta_easy_input_message.rbi +211 -0
  264. data/rbi/openai/models/beta/beta_file_search_tool.rbi +863 -0
  265. data/rbi/openai/models/beta/beta_function_shell_tool.rbi +155 -0
  266. data/rbi/openai/models/beta/beta_function_tool.rbi +154 -0
  267. data/rbi/openai/models/beta/beta_inline_skill.rbi +68 -0
  268. data/rbi/openai/models/beta/beta_inline_skill_source.rbi +53 -0
  269. data/rbi/openai/models/beta/beta_local_environment.rbi +51 -0
  270. data/rbi/openai/models/beta/beta_local_skill.rbi +49 -0
  271. data/rbi/openai/models/beta/beta_namespace_tool.rbi +252 -0
  272. data/rbi/openai/models/beta/beta_response.rbi +2495 -0
  273. data/rbi/openai/models/beta/beta_response_apply_patch_tool_call.rbi +431 -0
  274. data/rbi/openai/models/beta/beta_response_apply_patch_tool_call_output.rbi +277 -0
  275. data/rbi/openai/models/beta/beta_response_audio_delta_event.rbi +110 -0
  276. data/rbi/openai/models/beta/beta_response_audio_done_event.rbi +100 -0
  277. data/rbi/openai/models/beta/beta_response_audio_transcript_delta_event.rbi +118 -0
  278. data/rbi/openai/models/beta/beta_response_audio_transcript_done_event.rbi +108 -0
  279. data/rbi/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rbi +136 -0
  280. data/rbi/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rbi +134 -0
  281. data/rbi/openai/models/beta/beta_response_code_interpreter_call_completed_event.rbi +128 -0
  282. data/rbi/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rbi +128 -0
  283. data/rbi/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rbi +128 -0
  284. data/rbi/openai/models/beta/beta_response_code_interpreter_tool_call.rbi +315 -0
  285. data/rbi/openai/models/beta/beta_response_compaction_item.rbi +116 -0
  286. data/rbi/openai/models/beta/beta_response_compaction_item_param.rbi +114 -0
  287. data/rbi/openai/models/beta/beta_response_completed_event.rbi +111 -0
  288. data/rbi/openai/models/beta/beta_response_computer_tool_call.rbi +404 -0
  289. data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +296 -0
  290. data/rbi/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rbi +62 -0
  291. data/rbi/openai/models/beta/beta_response_container_reference.rbi +41 -0
  292. data/rbi/openai/models/beta/beta_response_content.rbi +66 -0
  293. data/rbi/openai/models/beta/beta_response_content_part_added_event.rbi +205 -0
  294. data/rbi/openai/models/beta/beta_response_content_part_done_event.rbi +203 -0
  295. data/rbi/openai/models/beta/beta_response_conversation_param.rbi +35 -0
  296. data/rbi/openai/models/beta/beta_response_created_event.rbi +109 -0
  297. data/rbi/openai/models/beta/beta_response_custom_tool_call.rbi +242 -0
  298. data/rbi/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rbi +134 -0
  299. data/rbi/openai/models/beta/beta_response_custom_tool_call_input_done_event.rbi +134 -0
  300. data/rbi/openai/models/beta/beta_response_custom_tool_call_item.rbi +113 -0
  301. data/rbi/openai/models/beta/beta_response_custom_tool_call_output.rbi +303 -0
  302. data/rbi/openai/models/beta/beta_response_custom_tool_call_output_item.rbi +114 -0
  303. data/rbi/openai/models/beta/beta_response_error.rbi +165 -0
  304. data/rbi/openai/models/beta/beta_response_error_event.rbi +120 -0
  305. data/rbi/openai/models/beta/beta_response_failed_event.rbi +107 -0
  306. data/rbi/openai/models/beta/beta_response_file_search_call_completed_event.rbi +126 -0
  307. data/rbi/openai/models/beta/beta_response_file_search_call_in_progress_event.rbi +126 -0
  308. data/rbi/openai/models/beta/beta_response_file_search_call_searching_event.rbi +126 -0
  309. data/rbi/openai/models/beta/beta_response_file_search_tool_call.rbi +328 -0
  310. data/rbi/openai/models/beta/beta_response_format_text_config.rbi +97 -0
  311. data/rbi/openai/models/beta/beta_response_format_text_json_schema_config.rbi +97 -0
  312. data/rbi/openai/models/beta/beta_response_function_call_arguments_delta_event.rbi +134 -0
  313. data/rbi/openai/models/beta/beta_response_function_call_arguments_done_event.rbi +140 -0
  314. data/rbi/openai/models/beta/beta_response_function_call_output_item.rbi +32 -0
  315. data/rbi/openai/models/beta/beta_response_function_call_output_item_list.rbi +21 -0
  316. data/rbi/openai/models/beta/beta_response_function_shell_call_output_content.rbi +160 -0
  317. data/rbi/openai/models/beta/beta_response_function_shell_tool_call.rbi +389 -0
  318. data/rbi/openai/models/beta/beta_response_function_shell_tool_call_output.rbi +470 -0
  319. data/rbi/openai/models/beta/beta_response_function_tool_call.rbi +310 -0
  320. data/rbi/openai/models/beta/beta_response_function_tool_call_item.rbi +115 -0
  321. data/rbi/openai/models/beta/beta_response_function_tool_call_output_item.rbi +364 -0
  322. data/rbi/openai/models/beta/beta_response_function_web_search.rbi +416 -0
  323. data/rbi/openai/models/beta/beta_response_image_gen_call_completed_event.rbi +127 -0
  324. data/rbi/openai/models/beta/beta_response_image_gen_call_generating_event.rbi +127 -0
  325. data/rbi/openai/models/beta/beta_response_image_gen_call_in_progress_event.rbi +126 -0
  326. data/rbi/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbi +144 -0
  327. data/rbi/openai/models/beta/beta_response_in_progress_event.rbi +113 -0
  328. data/rbi/openai/models/beta/beta_response_includable.rbi +86 -0
  329. data/rbi/openai/models/beta/beta_response_incomplete_event.rbi +113 -0
  330. data/rbi/openai/models/beta/beta_response_inject_created_event.rbi +75 -0
  331. data/rbi/openai/models/beta/beta_response_inject_event.rbi +183 -0
  332. data/rbi/openai/models/beta/beta_response_inject_failed_event.rbi +304 -0
  333. data/rbi/openai/models/beta/beta_response_input.rbi +18 -0
  334. data/rbi/openai/models/beta/beta_response_input_audio.rbi +144 -0
  335. data/rbi/openai/models/beta/beta_response_input_content.rbi +31 -0
  336. data/rbi/openai/models/beta/beta_response_input_file.rbi +210 -0
  337. data/rbi/openai/models/beta/beta_response_input_file_content.rbi +211 -0
  338. data/rbi/openai/models/beta/beta_response_input_image.rbi +173 -0
  339. data/rbi/openai/models/beta/beta_response_input_image_content.rbi +191 -0
  340. data/rbi/openai/models/beta/beta_response_input_item.rbi +5505 -0
  341. data/rbi/openai/models/beta/beta_response_input_message_content_list.rbi +21 -0
  342. data/rbi/openai/models/beta/beta_response_input_message_item.rbi +235 -0
  343. data/rbi/openai/models/beta/beta_response_input_text.rbi +109 -0
  344. data/rbi/openai/models/beta/beta_response_input_text_content.rbi +115 -0
  345. data/rbi/openai/models/beta/beta_response_item.rbi +2592 -0
  346. data/rbi/openai/models/beta/beta_response_local_environment.rbi +35 -0
  347. data/rbi/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rbi +137 -0
  348. data/rbi/openai/models/beta/beta_response_mcp_call_arguments_done_event.rbi +134 -0
  349. data/rbi/openai/models/beta/beta_response_mcp_call_completed_event.rbi +123 -0
  350. data/rbi/openai/models/beta/beta_response_mcp_call_failed_event.rbi +121 -0
  351. data/rbi/openai/models/beta/beta_response_mcp_call_in_progress_event.rbi +124 -0
  352. data/rbi/openai/models/beta/beta_response_mcp_list_tools_completed_event.rbi +126 -0
  353. data/rbi/openai/models/beta/beta_response_mcp_list_tools_failed_event.rbi +124 -0
  354. data/rbi/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rbi +127 -0
  355. data/rbi/openai/models/beta/beta_response_output_audio.rbi +53 -0
  356. data/rbi/openai/models/beta/beta_response_output_item.rbi +2627 -0
  357. data/rbi/openai/models/beta/beta_response_output_item_added_event.rbi +154 -0
  358. data/rbi/openai/models/beta/beta_response_output_item_done_event.rbi +154 -0
  359. data/rbi/openai/models/beta/beta_response_output_message.rbi +267 -0
  360. data/rbi/openai/models/beta/beta_response_output_refusal.rbi +41 -0
  361. data/rbi/openai/models/beta/beta_response_output_text.rbi +479 -0
  362. data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi +150 -0
  363. data/rbi/openai/models/beta/beta_response_prompt.rbi +122 -0
  364. data/rbi/openai/models/beta/beta_response_queued_event.rbi +107 -0
  365. data/rbi/openai/models/beta/beta_response_reasoning_item.rbi +274 -0
  366. data/rbi/openai/models/beta/beta_response_reasoning_summary_part_added_event.rbi +188 -0
  367. data/rbi/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbi +243 -0
  368. data/rbi/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rbi +142 -0
  369. data/rbi/openai/models/beta/beta_response_reasoning_summary_text_done_event.rbi +142 -0
  370. data/rbi/openai/models/beta/beta_response_reasoning_text_delta_event.rbi +140 -0
  371. data/rbi/openai/models/beta/beta_response_reasoning_text_done_event.rbi +140 -0
  372. data/rbi/openai/models/beta/beta_response_refusal_delta_event.rbi +135 -0
  373. data/rbi/openai/models/beta/beta_response_refusal_done_event.rbi +135 -0
  374. data/rbi/openai/models/beta/beta_response_status.rbi +38 -0
  375. data/rbi/openai/models/beta/beta_response_stream_event.rbi +81 -0
  376. data/rbi/openai/models/beta/beta_response_text_config.rbi +166 -0
  377. data/rbi/openai/models/beta/beta_response_text_delta_event.rbi +263 -0
  378. data/rbi/openai/models/beta/beta_response_text_done_event.rbi +261 -0
  379. data/rbi/openai/models/beta/beta_response_tool_search_call.rbi +218 -0
  380. data/rbi/openai/models/beta/beta_response_tool_search_output_item.rbi +248 -0
  381. data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +307 -0
  382. data/rbi/openai/models/beta/beta_response_usage.rbi +163 -0
  383. data/rbi/openai/models/beta/beta_response_web_search_call_completed_event.rbi +126 -0
  384. data/rbi/openai/models/beta/beta_response_web_search_call_in_progress_event.rbi +126 -0
  385. data/rbi/openai/models/beta/beta_response_web_search_call_searching_event.rbi +126 -0
  386. data/rbi/openai/models/beta/beta_responses_client_event.rbi +2831 -0
  387. data/rbi/openai/models/beta/beta_responses_server_event.rbi +83 -0
  388. data/rbi/openai/models/beta/beta_skill_reference.rbi +52 -0
  389. data/rbi/openai/models/beta/beta_tool.rbi +1835 -0
  390. data/rbi/openai/models/beta/beta_tool_choice_allowed.rbi +126 -0
  391. data/rbi/openai/models/beta/beta_tool_choice_apply_patch.rbi +35 -0
  392. data/rbi/openai/models/beta/beta_tool_choice_custom.rbi +38 -0
  393. data/rbi/openai/models/beta/beta_tool_choice_function.rbi +41 -0
  394. data/rbi/openai/models/beta/beta_tool_choice_mcp.rbi +55 -0
  395. data/rbi/openai/models/beta/beta_tool_choice_options.rbi +38 -0
  396. data/rbi/openai/models/beta/beta_tool_choice_shell.rbi +32 -0
  397. data/rbi/openai/models/beta/beta_tool_choice_types.rbi +134 -0
  398. data/rbi/openai/models/beta/beta_tool_search_tool.rbi +109 -0
  399. data/rbi/openai/models/beta/beta_web_search_preview_tool.rbi +311 -0
  400. data/rbi/openai/models/beta/beta_web_search_tool.rbi +329 -0
  401. data/rbi/openai/models/beta/response_cancel_params.rbi +83 -0
  402. data/rbi/openai/models/beta/response_compact_params.rbi +1033 -0
  403. data/rbi/openai/models/beta/response_create_params.rbi +2739 -0
  404. data/rbi/openai/models/beta/response_delete_params.rbi +83 -0
  405. data/rbi/openai/models/beta/response_retrieve_params.rbi +145 -0
  406. data/rbi/openai/models/beta/responses/beta_response_item_list.rbi +113 -0
  407. data/rbi/openai/models/beta/responses/input_item_list_params.rbi +223 -0
  408. data/rbi/openai/models/beta/responses/input_token_count_params.rbi +1248 -0
  409. data/rbi/openai/models/beta/responses/input_token_count_response.rbi +37 -0
  410. data/rbi/openai/models/beta/threads/run_create_params.rbi +12 -26
  411. data/rbi/openai/models/chat/chat_completion_content_part.rbi +57 -1
  412. data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +57 -1
  413. data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +57 -1
  414. data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +70 -2
  415. data/rbi/openai/models/chat/completion_create_params.rbi +513 -32
  416. data/rbi/openai/models/chat_model.rbi +3 -0
  417. data/rbi/openai/models/completion_usage.rbi +21 -4
  418. data/rbi/openai/models/conversations/computer_screenshot_content.rbi +57 -1
  419. data/rbi/openai/models/conversations/conversation_create_params.rbi +9 -3
  420. data/rbi/openai/models/conversations/conversation_item.rbi +178 -0
  421. data/rbi/openai/models/conversations/conversation_item_list.rbi +2 -0
  422. data/rbi/openai/models/conversations/item_create_params.rbi +9 -3
  423. data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +12 -26
  424. data/rbi/openai/models/evals/run_cancel_response.rbi +26 -52
  425. data/rbi/openai/models/evals/run_create_params.rbi +28 -52
  426. data/rbi/openai/models/evals/run_create_response.rbi +26 -52
  427. data/rbi/openai/models/evals/run_list_response.rbi +26 -52
  428. data/rbi/openai/models/evals/run_retrieve_response.rbi +26 -52
  429. data/rbi/openai/models/graders/score_model_grader.rbi +12 -26
  430. data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +84 -11
  431. data/rbi/openai/models/realtime/realtime_session_create_request.rbi +10 -0
  432. data/rbi/openai/models/realtime/realtime_session_create_response.rbi +94 -11
  433. data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +84 -11
  434. data/rbi/openai/models/reasoning.rbi +51 -26
  435. data/rbi/openai/models/reasoning_effort.rbi +7 -13
  436. data/rbi/openai/models/responses/apply_patch_tool.rbi +69 -2
  437. data/rbi/openai/models/responses/compacted_response.rbi +2 -0
  438. data/rbi/openai/models/responses/custom_tool.rbi +53 -0
  439. data/rbi/openai/models/responses/function_shell_tool.rbi +57 -0
  440. data/rbi/openai/models/responses/function_tool.rbi +68 -3
  441. data/rbi/openai/models/responses/input_token_count_params.rbi +32 -0
  442. data/rbi/openai/models/responses/namespace_tool.rbi +76 -0
  443. data/rbi/openai/models/responses/response.rbi +192 -3
  444. data/rbi/openai/models/responses/response_apply_patch_tool_call.rbi +98 -0
  445. data/rbi/openai/models/responses/response_apply_patch_tool_call_output.rbi +98 -0
  446. data/rbi/openai/models/responses/response_compact_params.rbi +231 -0
  447. data/rbi/openai/models/responses/response_create_params.rbi +537 -6
  448. data/rbi/openai/models/responses/response_custom_tool_call.rbi +104 -0
  449. data/rbi/openai/models/responses/response_custom_tool_call_output.rbi +111 -1
  450. data/rbi/openai/models/responses/response_error.rbi +5 -0
  451. data/rbi/openai/models/responses/response_function_shell_tool_call.rbi +98 -0
  452. data/rbi/openai/models/responses/response_function_shell_tool_call_output.rbi +98 -0
  453. data/rbi/openai/models/responses/response_function_tool_call.rbi +104 -0
  454. data/rbi/openai/models/responses/response_function_tool_call_output_item.rbi +104 -0
  455. data/rbi/openai/models/responses/response_input_file.rbi +77 -10
  456. data/rbi/openai/models/responses/response_input_file_content.rbi +83 -10
  457. data/rbi/openai/models/responses/response_input_image.rbi +57 -1
  458. data/rbi/openai/models/responses/response_input_image_content.rbi +63 -1
  459. data/rbi/openai/models/responses/response_input_item.rbi +748 -8
  460. data/rbi/openai/models/responses/response_input_text.rbi +70 -2
  461. data/rbi/openai/models/responses/response_input_text_content.rbi +76 -2
  462. data/rbi/openai/models/responses/response_item.rbi +178 -0
  463. data/rbi/openai/models/responses/response_item_list.rbi +2 -0
  464. data/rbi/openai/models/responses/response_output_item.rbi +178 -0
  465. data/rbi/openai/models/responses/response_output_item_added_event.rbi +2 -0
  466. data/rbi/openai/models/responses/response_output_item_done_event.rbi +2 -0
  467. data/rbi/openai/models/responses/response_reasoning_summary_part_done_event.rbi +58 -1
  468. data/rbi/openai/models/responses/response_tool_search_output_item.rbi +1 -0
  469. data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +3 -0
  470. data/rbi/openai/models/responses/response_usage.rbi +16 -2
  471. data/rbi/openai/models/responses/responses_client_event.rbi +537 -6
  472. data/rbi/openai/models/responses/tool.rbi +166 -12
  473. data/rbi/openai/models/video_edit_params.rbi +1 -1
  474. data/rbi/openai/models/webhooks/safety_identifier_blocked_webhook_event.rbi +209 -0
  475. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +2 -1
  476. data/rbi/openai/resources/beta/assistants.rbi +12 -26
  477. data/rbi/openai/resources/beta/responses/input_items.rbi +58 -0
  478. data/rbi/openai/resources/beta/responses/input_tokens.rbi +154 -0
  479. data/rbi/openai/resources/beta/responses.rbi +903 -0
  480. data/rbi/openai/resources/beta/threads/runs.rbi +12 -26
  481. data/rbi/openai/resources/beta.rbi +3 -0
  482. data/rbi/openai/resources/chat/completions.rbi +48 -28
  483. data/rbi/openai/resources/conversations/items.rbi +3 -1
  484. data/rbi/openai/resources/conversations.rbi +3 -1
  485. data/rbi/openai/resources/responses/input_tokens.rbi +2 -0
  486. data/rbi/openai/resources/responses.rbi +54 -2
  487. data/rbi/openai/resources/webhooks.rbi +2 -1
  488. data/sig/openai/client.rbs +1 -1
  489. data/sig/openai/internal/transport/base_client.rbs +2 -2
  490. data/sig/openai/models/beta/beta_apply_patch_tool.rbs +40 -0
  491. data/sig/openai/models/beta/beta_compacted_response.rbs +44 -0
  492. data/sig/openai/models/beta/beta_computer_action.rbs +259 -0
  493. data/sig/openai/models/beta/beta_computer_action_list.rbs +12 -0
  494. data/sig/openai/models/beta/beta_computer_tool.rbs +17 -0
  495. data/sig/openai/models/beta/beta_computer_use_preview_tool.rbs +53 -0
  496. data/sig/openai/models/beta/beta_container_auto.rbs +86 -0
  497. data/sig/openai/models/beta/beta_container_network_policy_allowlist.rbs +38 -0
  498. data/sig/openai/models/beta/beta_container_network_policy_disabled.rbs +17 -0
  499. data/sig/openai/models/beta/beta_container_network_policy_domain_secret.rbs +22 -0
  500. data/sig/openai/models/beta/beta_container_reference.rbs +23 -0
  501. data/sig/openai/models/beta/beta_custom_tool.rbs +126 -0
  502. data/sig/openai/models/beta/beta_easy_input_message.rbs +87 -0
  503. data/sig/openai/models/beta/beta_file_search_tool.rbs +298 -0
  504. data/sig/openai/models/beta/beta_function_shell_tool.rbs +56 -0
  505. data/sig/openai/models/beta/beta_function_tool.rbs +72 -0
  506. data/sig/openai/models/beta/beta_inline_skill.rbs +39 -0
  507. data/sig/openai/models/beta/beta_inline_skill_source.rbs +30 -0
  508. data/sig/openai/models/beta/beta_local_environment.rbs +30 -0
  509. data/sig/openai/models/beta/beta_local_skill.rbs +26 -0
  510. data/sig/openai/models/beta/beta_namespace_tool.rbs +114 -0
  511. data/sig/openai/models/beta/beta_response.rbs +860 -0
  512. data/sig/openai/models/beta/beta_response_apply_patch_tool_call.rbs +177 -0
  513. data/sig/openai/models/beta/beta_response_apply_patch_tool_call_output.rbs +118 -0
  514. data/sig/openai/models/beta/beta_response_audio_delta_event.rbs +49 -0
  515. data/sig/openai/models/beta/beta_response_audio_done_event.rbs +44 -0
  516. data/sig/openai/models/beta/beta_response_audio_transcript_delta_event.rbs +49 -0
  517. data/sig/openai/models/beta/beta_response_audio_transcript_done_event.rbs +44 -0
  518. data/sig/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rbs +59 -0
  519. data/sig/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rbs +59 -0
  520. data/sig/openai/models/beta/beta_response_code_interpreter_call_completed_event.rbs +54 -0
  521. data/sig/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rbs +54 -0
  522. data/sig/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rbs +54 -0
  523. data/sig/openai/models/beta/beta_response_code_interpreter_tool_call.rbs +113 -0
  524. data/sig/openai/models/beta/beta_response_compaction_item.rbs +60 -0
  525. data/sig/openai/models/beta/beta_response_compaction_item_param.rbs +49 -0
  526. data/sig/openai/models/beta/beta_response_completed_event.rbs +49 -0
  527. data/sig/openai/models/beta/beta_response_computer_tool_call.rbs +118 -0
  528. data/sig/openai/models/beta/beta_response_computer_tool_call_output_item.rbs +107 -0
  529. data/sig/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rbs +34 -0
  530. data/sig/openai/models/beta/beta_response_container_reference.rbs +23 -0
  531. data/sig/openai/models/beta/beta_response_content.rbs +33 -0
  532. data/sig/openai/models/beta/beta_response_content_part_added_event.rbs +87 -0
  533. data/sig/openai/models/beta/beta_response_content_part_done_event.rbs +87 -0
  534. data/sig/openai/models/beta/beta_response_conversation_param.rbs +17 -0
  535. data/sig/openai/models/beta/beta_response_created_event.rbs +49 -0
  536. data/sig/openai/models/beta/beta_response_custom_tool_call.rbs +105 -0
  537. data/sig/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rbs +59 -0
  538. data/sig/openai/models/beta/beta_response_custom_tool_call_input_done_event.rbs +59 -0
  539. data/sig/openai/models/beta/beta_response_custom_tool_call_item.rbs +54 -0
  540. data/sig/openai/models/beta/beta_response_custom_tool_call_output.rbs +116 -0
  541. data/sig/openai/models/beta/beta_response_custom_tool_call_output_item.rbs +54 -0
  542. data/sig/openai/models/beta/beta_response_error.rbs +73 -0
  543. data/sig/openai/models/beta/beta_response_error_event.rbs +59 -0
  544. data/sig/openai/models/beta/beta_response_failed_event.rbs +49 -0
  545. data/sig/openai/models/beta/beta_response_file_search_call_completed_event.rbs +54 -0
  546. data/sig/openai/models/beta/beta_response_file_search_call_in_progress_event.rbs +54 -0
  547. data/sig/openai/models/beta/beta_response_file_search_call_searching_event.rbs +54 -0
  548. data/sig/openai/models/beta/beta_response_file_search_tool_call.rbs +127 -0
  549. data/sig/openai/models/beta/beta_response_format_text_config.rbs +38 -0
  550. data/sig/openai/models/beta/beta_response_format_text_json_schema_config.rbs +46 -0
  551. data/sig/openai/models/beta/beta_response_function_call_arguments_delta_event.rbs +59 -0
  552. data/sig/openai/models/beta/beta_response_function_call_arguments_done_event.rbs +64 -0
  553. data/sig/openai/models/beta/beta_response_function_call_output_item.rbs +18 -0
  554. data/sig/openai/models/beta/beta_response_function_call_output_item_list.rbs +12 -0
  555. data/sig/openai/models/beta/beta_response_function_shell_call_output_content.rbs +66 -0
  556. data/sig/openai/models/beta/beta_response_function_shell_tool_call.rbs +161 -0
  557. data/sig/openai/models/beta/beta_response_function_shell_tool_call_output.rbs +190 -0
  558. data/sig/openai/models/beta/beta_response_function_tool_call.rbs +126 -0
  559. data/sig/openai/models/beta/beta_response_function_tool_call_item.rbs +54 -0
  560. data/sig/openai/models/beta/beta_response_function_tool_call_output_item.rbs +138 -0
  561. data/sig/openai/models/beta/beta_response_function_web_search.rbs +165 -0
  562. data/sig/openai/models/beta/beta_response_image_gen_call_completed_event.rbs +54 -0
  563. data/sig/openai/models/beta/beta_response_image_gen_call_generating_event.rbs +54 -0
  564. data/sig/openai/models/beta/beta_response_image_gen_call_in_progress_event.rbs +54 -0
  565. data/sig/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbs +64 -0
  566. data/sig/openai/models/beta/beta_response_in_progress_event.rbs +49 -0
  567. data/sig/openai/models/beta/beta_response_includable.rbs +32 -0
  568. data/sig/openai/models/beta/beta_response_incomplete_event.rbs +49 -0
  569. data/sig/openai/models/beta/beta_response_inject_created_event.rbs +41 -0
  570. data/sig/openai/models/beta/beta_response_inject_event.rbs +34 -0
  571. data/sig/openai/models/beta/beta_response_inject_failed_event.rbs +84 -0
  572. data/sig/openai/models/beta/beta_response_input.rbs +12 -0
  573. data/sig/openai/models/beta/beta_response_input_audio.rbs +62 -0
  574. data/sig/openai/models/beta/beta_response_input_content.rbs +18 -0
  575. data/sig/openai/models/beta/beta_response_input_file.rbs +90 -0
  576. data/sig/openai/models/beta/beta_response_input_file_content.rbs +80 -0
  577. data/sig/openai/models/beta/beta_response_input_image.rbs +71 -0
  578. data/sig/openai/models/beta/beta_response_input_image_content.rbs +67 -0
  579. data/sig/openai/models/beta/beta_response_input_item.rbs +2064 -0
  580. data/sig/openai/models/beta/beta_response_input_message_content_list.rbs +12 -0
  581. data/sig/openai/models/beta/beta_response_input_message_item.rbs +87 -0
  582. data/sig/openai/models/beta/beta_response_input_text.rbs +48 -0
  583. data/sig/openai/models/beta/beta_response_input_text_content.rbs +44 -0
  584. data/sig/openai/models/beta/beta_response_item.rbs +1097 -0
  585. data/sig/openai/models/beta/beta_response_local_environment.rbs +17 -0
  586. data/sig/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rbs +59 -0
  587. data/sig/openai/models/beta/beta_response_mcp_call_arguments_done_event.rbs +59 -0
  588. data/sig/openai/models/beta/beta_response_mcp_call_completed_event.rbs +54 -0
  589. data/sig/openai/models/beta/beta_response_mcp_call_failed_event.rbs +54 -0
  590. data/sig/openai/models/beta/beta_response_mcp_call_in_progress_event.rbs +54 -0
  591. data/sig/openai/models/beta/beta_response_mcp_list_tools_completed_event.rbs +54 -0
  592. data/sig/openai/models/beta/beta_response_mcp_list_tools_failed_event.rbs +54 -0
  593. data/sig/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rbs +54 -0
  594. data/sig/openai/models/beta/beta_response_output_audio.rbs +30 -0
  595. data/sig/openai/models/beta/beta_response_output_item.rbs +1096 -0
  596. data/sig/openai/models/beta/beta_response_output_item_added_event.rbs +54 -0
  597. data/sig/openai/models/beta/beta_response_output_item_done_event.rbs +54 -0
  598. data/sig/openai/models/beta/beta_response_output_message.rbs +97 -0
  599. data/sig/openai/models/beta/beta_response_output_refusal.rbs +19 -0
  600. data/sig/openai/models/beta/beta_response_output_text.rbs +243 -0
  601. data/sig/openai/models/beta/beta_response_output_text_annotation_added_event.rbs +69 -0
  602. data/sig/openai/models/beta/beta_response_prompt.rbs +46 -0
  603. data/sig/openai/models/beta/beta_response_queued_event.rbs +49 -0
  604. data/sig/openai/models/beta/beta_response_reasoning_item.rbs +108 -0
  605. data/sig/openai/models/beta/beta_response_reasoning_summary_part_added_event.rbs +76 -0
  606. data/sig/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbs +95 -0
  607. data/sig/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rbs +64 -0
  608. data/sig/openai/models/beta/beta_response_reasoning_summary_text_done_event.rbs +64 -0
  609. data/sig/openai/models/beta/beta_response_reasoning_text_delta_event.rbs +64 -0
  610. data/sig/openai/models/beta/beta_response_reasoning_text_done_event.rbs +64 -0
  611. data/sig/openai/models/beta/beta_response_refusal_delta_event.rbs +64 -0
  612. data/sig/openai/models/beta/beta_response_refusal_done_event.rbs +64 -0
  613. data/sig/openai/models/beta/beta_response_status.rbs +23 -0
  614. data/sig/openai/models/beta/beta_response_stream_event.rbs +68 -0
  615. data/sig/openai/models/beta/beta_response_text_config.rbs +45 -0
  616. data/sig/openai/models/beta/beta_response_text_delta_event.rbs +116 -0
  617. data/sig/openai/models/beta/beta_response_text_done_event.rbs +116 -0
  618. data/sig/openai/models/beta/beta_response_tool_search_call.rbs +98 -0
  619. data/sig/openai/models/beta/beta_response_tool_search_output_item.rbs +98 -0
  620. data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +91 -0
  621. data/sig/openai/models/beta/beta_response_usage.rbs +73 -0
  622. data/sig/openai/models/beta/beta_response_web_search_call_completed_event.rbs +54 -0
  623. data/sig/openai/models/beta/beta_response_web_search_call_in_progress_event.rbs +54 -0
  624. data/sig/openai/models/beta/beta_response_web_search_call_searching_event.rbs +54 -0
  625. data/sig/openai/models/beta/beta_responses_client_event.rbs +804 -0
  626. data/sig/openai/models/beta/beta_responses_server_event.rbs +70 -0
  627. data/sig/openai/models/beta/beta_skill_reference.rbs +32 -0
  628. data/sig/openai/models/beta/beta_tool.rbs +634 -0
  629. data/sig/openai/models/beta/beta_tool_choice_allowed.rbs +45 -0
  630. data/sig/openai/models/beta/beta_tool_choice_apply_patch.rbs +17 -0
  631. data/sig/openai/models/beta/beta_tool_choice_custom.rbs +19 -0
  632. data/sig/openai/models/beta/beta_tool_choice_function.rbs +19 -0
  633. data/sig/openai/models/beta/beta_tool_choice_mcp.rbs +26 -0
  634. data/sig/openai/models/beta/beta_tool_choice_options.rbs +19 -0
  635. data/sig/openai/models/beta/beta_tool_choice_shell.rbs +17 -0
  636. data/sig/openai/models/beta/beta_tool_choice_types.rbs +47 -0
  637. data/sig/openai/models/beta/beta_tool_search_tool.rbs +54 -0
  638. data/sig/openai/models/beta/beta_web_search_preview_tool.rbs +118 -0
  639. data/sig/openai/models/beta/beta_web_search_tool.rbs +127 -0
  640. data/sig/openai/models/beta/response_cancel_params.rbs +47 -0
  641. data/sig/openai/models/beta/response_compact_params.rbs +368 -0
  642. data/sig/openai/models/beta/response_create_params.rbs +804 -0
  643. data/sig/openai/models/beta/response_delete_params.rbs +47 -0
  644. data/sig/openai/models/beta/response_retrieve_params.rbs +70 -0
  645. data/sig/openai/models/beta/responses/beta_response_item_list.rbs +44 -0
  646. data/sig/openai/models/beta/responses/input_item_list_params.rbs +92 -0
  647. data/sig/openai/models/beta/responses/input_token_count_params.rbs +325 -0
  648. data/sig/openai/models/beta/responses/input_token_count_response.rbs +26 -0
  649. data/sig/openai/models/chat/chat_completion_content_part.rbs +21 -2
  650. data/sig/openai/models/chat/chat_completion_content_part_image.rbs +21 -2
  651. data/sig/openai/models/chat/chat_completion_content_part_input_audio.rbs +21 -2
  652. data/sig/openai/models/chat/chat_completion_content_part_text.rbs +32 -3
  653. data/sig/openai/models/chat/completion_create_params.rbs +153 -3
  654. data/sig/openai/models/chat_model.rbs +7 -1
  655. data/sig/openai/models/completion_usage.rbs +15 -2
  656. data/sig/openai/models/conversations/computer_screenshot_content.rbs +21 -2
  657. data/sig/openai/models/conversations/conversation_item.rbs +87 -0
  658. data/sig/openai/models/realtime/realtime_response_create_mcp_tool.rbs +25 -2
  659. data/sig/openai/models/realtime/realtime_session_create_request.rbs +4 -0
  660. data/sig/openai/models/realtime/realtime_session_create_response.rbs +29 -2
  661. data/sig/openai/models/realtime/realtime_tools_config_union.rbs +25 -2
  662. data/sig/openai/models/reasoning.rbs +20 -0
  663. data/sig/openai/models/reasoning_effort.rbs +3 -1
  664. data/sig/openai/models/responses/apply_patch_tool.rbs +26 -3
  665. data/sig/openai/models/responses/custom_tool.rbs +16 -0
  666. data/sig/openai/models/responses/function_shell_tool.rbs +16 -0
  667. data/sig/openai/models/responses/function_tool.rbs +23 -2
  668. data/sig/openai/models/responses/input_token_count_params.rbs +12 -0
  669. data/sig/openai/models/responses/namespace_tool.rbs +21 -0
  670. data/sig/openai/models/responses/response.rbs +64 -0
  671. data/sig/openai/models/responses/response_apply_patch_tool_call.rbs +37 -0
  672. data/sig/openai/models/responses/response_apply_patch_tool_call_output.rbs +37 -0
  673. data/sig/openai/models/responses/response_compact_params.rbs +63 -1
  674. data/sig/openai/models/responses/response_create_params.rbs +165 -3
  675. data/sig/openai/models/responses/response_custom_tool_call.rbs +37 -0
  676. data/sig/openai/models/responses/response_custom_tool_call_output.rbs +39 -2
  677. data/sig/openai/models/responses/response_error.rbs +2 -0
  678. data/sig/openai/models/responses/response_function_shell_tool_call.rbs +37 -0
  679. data/sig/openai/models/responses/response_function_shell_tool_call_output.rbs +37 -0
  680. data/sig/openai/models/responses/response_function_tool_call.rbs +37 -0
  681. data/sig/openai/models/responses/response_function_tool_call_output_item.rbs +37 -0
  682. data/sig/openai/models/responses/response_input_file.rbs +23 -3
  683. data/sig/openai/models/responses/response_input_file_content.rbs +19 -3
  684. data/sig/openai/models/responses/response_input_image.rbs +21 -2
  685. data/sig/openai/models/responses/response_input_image_content.rbs +17 -2
  686. data/sig/openai/models/responses/response_input_item.rbs +274 -2
  687. data/sig/openai/models/responses/response_input_text.rbs +32 -3
  688. data/sig/openai/models/responses/response_input_text_content.rbs +28 -3
  689. data/sig/openai/models/responses/response_item.rbs +87 -0
  690. data/sig/openai/models/responses/response_output_item.rbs +87 -0
  691. data/sig/openai/models/responses/response_reasoning_summary_part_done_event.rbs +21 -2
  692. data/sig/openai/models/responses/response_usage.rbs +12 -3
  693. data/sig/openai/models/responses/responses_client_event.rbs +165 -3
  694. data/sig/openai/models/responses/tool.rbs +54 -4
  695. data/sig/openai/models/webhooks/safety_identifier_blocked_webhook_event.rbs +99 -0
  696. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
  697. data/sig/openai/resources/beta/responses/input_items.rbs +21 -0
  698. data/sig/openai/resources/beta/responses/input_tokens.rbs +28 -0
  699. data/sig/openai/resources/beta/responses.rbs +128 -0
  700. data/sig/openai/resources/beta.rbs +2 -0
  701. data/sig/openai/resources/chat/completions.rbs +2 -0
  702. data/sig/openai/resources/responses.rbs +3 -0
  703. data/sig/openai/resources/webhooks.rbs +2 -1
  704. metadata +491 -2
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ # @see OpenAI::Resources::Beta::Responses#cancel
7
+ class ResponseCancelParams < OpenAI::Internal::Type::BaseModel
8
+ extend OpenAI::Internal::Type::RequestParameters::Converter
9
+ include OpenAI::Internal::Type::RequestParameters
10
+
11
+ # @!attribute response_id
12
+ #
13
+ # @return [String]
14
+ required :response_id, String
15
+
16
+ # @!attribute betas
17
+ #
18
+ # @return [Array<Symbol, OpenAI::Models::Beta::ResponseCancelParams::Beta>, nil]
19
+ optional :betas, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::ResponseCancelParams::Beta] }
20
+
21
+ # @!method initialize(response_id:, betas: nil, request_options: {})
22
+ # @param response_id [String]
23
+ # @param betas [Array<Symbol, OpenAI::Models::Beta::ResponseCancelParams::Beta>]
24
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
25
+
26
+ module Beta
27
+ extend OpenAI::Internal::Type::Enum
28
+
29
+ RESPONSES_MULTI_AGENT_V1 = :"responses_multi_agent=v1"
30
+
31
+ # @!method self.values
32
+ # @return [Array<Symbol>]
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,549 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ # @see OpenAI::Resources::Beta::Responses#compact
7
+ class ResponseCompactParams < OpenAI::Internal::Type::BaseModel
8
+ extend OpenAI::Internal::Type::RequestParameters::Converter
9
+ include OpenAI::Internal::Type::RequestParameters
10
+
11
+ # @!attribute model
12
+ # Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a
13
+ # wide range of models with different capabilities, performance characteristics,
14
+ # and price points. Refer to the
15
+ # [model guide](https://platform.openai.com/docs/models) to browse and compare
16
+ # available models.
17
+ #
18
+ # @return [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil]
19
+ required :model, union: -> { OpenAI::Beta::ResponseCompactParams::Model }, nil?: true
20
+
21
+ # @!attribute input
22
+ # Text, image, or file inputs to the model, used to generate a response
23
+ #
24
+ # @return [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil]
25
+ optional :input, union: -> { OpenAI::Beta::ResponseCompactParams::Input }, nil?: true
26
+
27
+ # @!attribute instructions
28
+ # A system (or developer) message inserted into the model's context. When used
29
+ # along with `previous_response_id`, the instructions from a previous response
30
+ # will not be carried over to the next response. This makes it simple to swap out
31
+ # system (or developer) messages in new responses.
32
+ #
33
+ # @return [String, nil]
34
+ optional :instructions, String, nil?: true
35
+
36
+ # @!attribute previous_response_id
37
+ # The unique ID of the previous response to the model. Use this to create
38
+ # multi-turn conversations. Learn more about
39
+ # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
40
+ # Cannot be used in conjunction with `conversation`.
41
+ #
42
+ # @return [String, nil]
43
+ optional :previous_response_id, String, nil?: true
44
+
45
+ # @!attribute prompt_cache_key
46
+ # A key to use when reading from or writing to the prompt cache.
47
+ #
48
+ # @return [String, nil]
49
+ optional :prompt_cache_key, String, nil?: true
50
+
51
+ # @!attribute prompt_cache_options
52
+ # Options for prompt caching. Supported for `gpt-5.6` and later models. By
53
+ # default, OpenAI automatically chooses one implicit cache breakpoint. You can add
54
+ # explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
55
+ # request can write up to four breakpoints. For cache matching, OpenAI considers
56
+ # up to the latest 80 breakpoints in the conversation, without a content-block
57
+ # lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
58
+ # `ttl` defaults to `30m`, which is currently the only supported value. See the
59
+ # [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching)
60
+ # for current details.
61
+ #
62
+ # @return [OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions, nil]
63
+ optional :prompt_cache_options,
64
+ -> {
65
+ OpenAI::Beta::ResponseCompactParams::PromptCacheOptions
66
+ },
67
+ nil?: true
68
+
69
+ # @!attribute prompt_cache_retention
70
+ # @deprecated
71
+ #
72
+ # How long to retain a prompt cache entry created by this request.
73
+ #
74
+ # @return [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheRetention, nil]
75
+ optional :prompt_cache_retention,
76
+ enum: -> { OpenAI::Beta::ResponseCompactParams::PromptCacheRetention },
77
+ nil?: true
78
+
79
+ # @!attribute service_tier
80
+ # The service tier to use for this request.
81
+ #
82
+ # @return [Symbol, OpenAI::Models::Beta::ResponseCompactParams::ServiceTier, nil]
83
+ optional :service_tier, enum: -> { OpenAI::Beta::ResponseCompactParams::ServiceTier }, nil?: true
84
+
85
+ # @!attribute betas
86
+ #
87
+ # @return [Array<Symbol, OpenAI::Models::Beta::ResponseCompactParams::Beta>, nil]
88
+ optional :betas, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::ResponseCompactParams::Beta] }
89
+
90
+ # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, service_tier: nil, betas: nil, request_options: {})
91
+ # Some parameter documentations has been truncated, see
92
+ # {OpenAI::Models::Beta::ResponseCompactParams} for more details.
93
+ #
94
+ # @param model [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wi
95
+ #
96
+ # @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] Text, image, or file inputs to the model, used to generate a response
97
+ #
98
+ # @param instructions [String, nil] A system (or developer) message inserted into the model's context.
99
+ #
100
+ # @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to create multi-tu
101
+ #
102
+ # @param prompt_cache_key [String, nil] A key to use when reading from or writing to the prompt cache.
103
+ #
104
+ # @param prompt_cache_options [OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions, nil] Options for prompt caching. Supported for `gpt-5.6` and later models. By default
105
+ #
106
+ # @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheRetention, nil] How long to retain a prompt cache entry created by this request.
107
+ #
108
+ # @param service_tier [Symbol, OpenAI::Models::Beta::ResponseCompactParams::ServiceTier, nil] The service tier to use for this request.
109
+ #
110
+ # @param betas [Array<Symbol, OpenAI::Models::Beta::ResponseCompactParams::Beta>]
111
+ #
112
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
113
+
114
+ # Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a
115
+ # wide range of models with different capabilities, performance characteristics,
116
+ # and price points. Refer to the
117
+ # [model guide](https://platform.openai.com/docs/models) to browse and compare
118
+ # available models.
119
+ module Model
120
+ extend OpenAI::Internal::Type::Union
121
+
122
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_6_SOL }
123
+
124
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_6_TERRA }
125
+
126
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_6_LUNA }
127
+
128
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_4 }
129
+
130
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_4_MINI }
131
+
132
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_4_NANO }
133
+
134
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_4_MINI_2026_03_17 }
135
+
136
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_4_NANO_2026_03_17 }
137
+
138
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_3_CHAT_LATEST }
139
+
140
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_2 }
141
+
142
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_2_2025_12_11 }
143
+
144
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_2_CHAT_LATEST }
145
+
146
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_2_PRO }
147
+
148
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_2_PRO_2025_12_11 }
149
+
150
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_1 }
151
+
152
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_1_2025_11_13 }
153
+
154
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_1_CODEX }
155
+
156
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_1_MINI }
157
+
158
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_1_CHAT_LATEST }
159
+
160
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5 }
161
+
162
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_MINI }
163
+
164
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_NANO }
165
+
166
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_2025_08_07 }
167
+
168
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_MINI_2025_08_07 }
169
+
170
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_NANO_2025_08_07 }
171
+
172
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_CHAT_LATEST }
173
+
174
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_1 }
175
+
176
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_1_MINI }
177
+
178
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_1_NANO }
179
+
180
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_1_2025_04_14 }
181
+
182
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_1_MINI_2025_04_14 }
183
+
184
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_1_NANO_2025_04_14 }
185
+
186
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O4_MINI }
187
+
188
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O4_MINI_2025_04_16 }
189
+
190
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O3 }
191
+
192
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O3_2025_04_16 }
193
+
194
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O3_MINI }
195
+
196
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O3_MINI_2025_01_31 }
197
+
198
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1 }
199
+
200
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_2024_12_17 }
201
+
202
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_PREVIEW }
203
+
204
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_PREVIEW_2024_09_12 }
205
+
206
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_MINI }
207
+
208
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_MINI_2024_09_12 }
209
+
210
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O }
211
+
212
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_2024_11_20 }
213
+
214
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_2024_08_06 }
215
+
216
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_2024_05_13 }
217
+
218
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW }
219
+
220
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW_2024_10_01 }
221
+
222
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW_2024_12_17 }
223
+
224
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW_2025_06_03 }
225
+
226
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_MINI_AUDIO_PREVIEW }
227
+
228
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 }
229
+
230
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_SEARCH_PREVIEW }
231
+
232
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_MINI_SEARCH_PREVIEW }
233
+
234
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_SEARCH_PREVIEW_2025_03_11 }
235
+
236
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 }
237
+
238
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::CHATGPT_4O_LATEST }
239
+
240
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::CODEX_MINI_LATEST }
241
+
242
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_MINI }
243
+
244
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4O_MINI_2024_07_18 }
245
+
246
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_TURBO }
247
+
248
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_TURBO_2024_04_09 }
249
+
250
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_0125_PREVIEW }
251
+
252
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_TURBO_PREVIEW }
253
+
254
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_1106_PREVIEW }
255
+
256
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_VISION_PREVIEW }
257
+
258
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4 }
259
+
260
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_0314 }
261
+
262
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_0613 }
263
+
264
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_32K }
265
+
266
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_32K_0314 }
267
+
268
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_32K_0613 }
269
+
270
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO }
271
+
272
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_16K }
273
+
274
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_0301 }
275
+
276
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_0613 }
277
+
278
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_1106 }
279
+
280
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_0125 }
281
+
282
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_16K_0613 }
283
+
284
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_PRO }
285
+
286
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_PRO_2025_03_19 }
287
+
288
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O3_PRO }
289
+
290
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O3_PRO_2025_06_10 }
291
+
292
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O3_DEEP_RESEARCH }
293
+
294
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O3_DEEP_RESEARCH_2025_06_26 }
295
+
296
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O4_MINI_DEEP_RESEARCH }
297
+
298
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O4_MINI_DEEP_RESEARCH_2025_06_26 }
299
+
300
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::COMPUTER_USE_PREVIEW }
301
+
302
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::COMPUTER_USE_PREVIEW_2025_03_11 }
303
+
304
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_CODEX }
305
+
306
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_PRO }
307
+
308
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_PRO_2025_10_06 }
309
+
310
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_5_1_CODEX_MAX }
311
+
312
+ variant String
313
+
314
+ # @!method self.variants
315
+ # @return [Array(Symbol, String)]
316
+
317
+ define_sorbet_constant!(:Variants) do
318
+ T.type_alias { T.any(OpenAI::Beta::ResponseCompactParams::Model::TaggedSymbol, String) }
319
+ end
320
+
321
+ # @!group
322
+
323
+ GPT_5_6_SOL = :"gpt-5.6-sol"
324
+ GPT_5_6_TERRA = :"gpt-5.6-terra"
325
+ GPT_5_6_LUNA = :"gpt-5.6-luna"
326
+ GPT_5_4 = :"gpt-5.4"
327
+ GPT_5_4_MINI = :"gpt-5.4-mini"
328
+ GPT_5_4_NANO = :"gpt-5.4-nano"
329
+ GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
330
+ GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
331
+ GPT_5_3_CHAT_LATEST = :"gpt-5.3-chat-latest"
332
+ GPT_5_2 = :"gpt-5.2"
333
+ GPT_5_2_2025_12_11 = :"gpt-5.2-2025-12-11"
334
+ GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
335
+ GPT_5_2_PRO = :"gpt-5.2-pro"
336
+ GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
337
+ GPT_5_1 = :"gpt-5.1"
338
+ GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
339
+ GPT_5_1_CODEX = :"gpt-5.1-codex"
340
+ GPT_5_1_MINI = :"gpt-5.1-mini"
341
+ GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
342
+ GPT_5 = :"gpt-5"
343
+ GPT_5_MINI = :"gpt-5-mini"
344
+ GPT_5_NANO = :"gpt-5-nano"
345
+ GPT_5_2025_08_07 = :"gpt-5-2025-08-07"
346
+ GPT_5_MINI_2025_08_07 = :"gpt-5-mini-2025-08-07"
347
+ GPT_5_NANO_2025_08_07 = :"gpt-5-nano-2025-08-07"
348
+ GPT_5_CHAT_LATEST = :"gpt-5-chat-latest"
349
+ GPT_4_1 = :"gpt-4.1"
350
+ GPT_4_1_MINI = :"gpt-4.1-mini"
351
+ GPT_4_1_NANO = :"gpt-4.1-nano"
352
+ GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
353
+ GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
354
+ GPT_4_1_NANO_2025_04_14 = :"gpt-4.1-nano-2025-04-14"
355
+ O4_MINI = :"o4-mini"
356
+ O4_MINI_2025_04_16 = :"o4-mini-2025-04-16"
357
+ O3 = :o3
358
+ O3_2025_04_16 = :"o3-2025-04-16"
359
+ O3_MINI = :"o3-mini"
360
+ O3_MINI_2025_01_31 = :"o3-mini-2025-01-31"
361
+ O1 = :o1
362
+ O1_2024_12_17 = :"o1-2024-12-17"
363
+ O1_PREVIEW = :"o1-preview"
364
+ O1_PREVIEW_2024_09_12 = :"o1-preview-2024-09-12"
365
+ O1_MINI = :"o1-mini"
366
+ O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
367
+ GPT_4O = :"gpt-4o"
368
+ GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
369
+ GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
370
+ GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
371
+ GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
372
+ GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
373
+ GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
374
+ GPT_4O_AUDIO_PREVIEW_2025_06_03 = :"gpt-4o-audio-preview-2025-06-03"
375
+ GPT_4O_MINI_AUDIO_PREVIEW = :"gpt-4o-mini-audio-preview"
376
+ GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-mini-audio-preview-2024-12-17"
377
+ GPT_4O_SEARCH_PREVIEW = :"gpt-4o-search-preview"
378
+ GPT_4O_MINI_SEARCH_PREVIEW = :"gpt-4o-mini-search-preview"
379
+ GPT_4O_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-search-preview-2025-03-11"
380
+ GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-mini-search-preview-2025-03-11"
381
+ CHATGPT_4O_LATEST = :"chatgpt-4o-latest"
382
+ CODEX_MINI_LATEST = :"codex-mini-latest"
383
+ GPT_4O_MINI = :"gpt-4o-mini"
384
+ GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
385
+ GPT_4_TURBO = :"gpt-4-turbo"
386
+ GPT_4_TURBO_2024_04_09 = :"gpt-4-turbo-2024-04-09"
387
+ GPT_4_0125_PREVIEW = :"gpt-4-0125-preview"
388
+ GPT_4_TURBO_PREVIEW = :"gpt-4-turbo-preview"
389
+ GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
390
+ GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
391
+ GPT_4 = :"gpt-4"
392
+ GPT_4_0314 = :"gpt-4-0314"
393
+ GPT_4_0613 = :"gpt-4-0613"
394
+ GPT_4_32K = :"gpt-4-32k"
395
+ GPT_4_32K_0314 = :"gpt-4-32k-0314"
396
+ GPT_4_32K_0613 = :"gpt-4-32k-0613"
397
+ GPT_3_5_TURBO = :"gpt-3.5-turbo"
398
+ GPT_3_5_TURBO_16K = :"gpt-3.5-turbo-16k"
399
+ GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
400
+ GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
401
+ GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
402
+ GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
403
+ GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
404
+ O1_PRO = :"o1-pro"
405
+ O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
406
+ O3_PRO = :"o3-pro"
407
+ O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
408
+ O3_DEEP_RESEARCH = :"o3-deep-research"
409
+ O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
410
+ O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
411
+ O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
412
+ COMPUTER_USE_PREVIEW = :"computer-use-preview"
413
+ COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
414
+ GPT_5_CODEX = :"gpt-5-codex"
415
+ GPT_5_PRO = :"gpt-5-pro"
416
+ GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
417
+ GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
418
+
419
+ # @!endgroup
420
+ end
421
+
422
+ # Text, image, or file inputs to the model, used to generate a response
423
+ module Input
424
+ extend OpenAI::Internal::Type::Union
425
+
426
+ # A text input to the model, equivalent to a text input with the `user` role.
427
+ variant String
428
+
429
+ # A list of one or many input items to the model, containing different content types.
430
+ variant -> { OpenAI::Models::Beta::ResponseCompactParams::Input::BetaResponseInputItemArray }
431
+
432
+ # @!method self.variants
433
+ # @return [Array(String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>)]
434
+
435
+ # @type [OpenAI::Internal::Type::Converter]
436
+ BetaResponseInputItemArray =
437
+ OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Beta::BetaResponseInputItem }]
438
+ end
439
+
440
+ class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
441
+ # @!attribute mode
442
+ # Controls whether OpenAI automatically creates an implicit cache breakpoint.
443
+ # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
444
+ # and writes up to the latest three explicit breakpoints in the request. With
445
+ # `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
446
+ # latest four explicit breakpoints. If there are no explicit breakpoints, the
447
+ # request does not use prompt caching.
448
+ #
449
+ # @return [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::Mode, nil]
450
+ optional :mode, enum: -> { OpenAI::Beta::ResponseCompactParams::PromptCacheOptions::Mode }
451
+
452
+ # @!attribute ttl
453
+ # The minimum lifetime applied to every implicit and explicit cache breakpoint
454
+ # written by the request. Defaults to `30m`, which is currently the only supported
455
+ # value. The backend may retain cache entries for longer.
456
+ #
457
+ # @return [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::Ttl, nil]
458
+ optional :ttl, enum: -> { OpenAI::Beta::ResponseCompactParams::PromptCacheOptions::Ttl }
459
+
460
+ # @!method initialize(mode: nil, ttl: nil)
461
+ # Some parameter documentations has been truncated, see
462
+ # {OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions} for more
463
+ # details.
464
+ #
465
+ # Options for prompt caching. Supported for `gpt-5.6` and later models. By
466
+ # default, OpenAI automatically chooses one implicit cache breakpoint. You can add
467
+ # explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
468
+ # request can write up to four breakpoints. For cache matching, OpenAI considers
469
+ # up to the latest 80 breakpoints in the conversation, without a content-block
470
+ # lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
471
+ # `ttl` defaults to `30m`, which is currently the only supported value. See the
472
+ # [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching)
473
+ # for current details.
474
+ #
475
+ # @param mode [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::Mode] Controls whether OpenAI automatically creates an implicit cache breakpoint. Defa
476
+ #
477
+ # @param ttl [Symbol, OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::Ttl] The minimum lifetime applied to every implicit and explicit cache breakpoint wri
478
+
479
+ # Controls whether OpenAI automatically creates an implicit cache breakpoint.
480
+ # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
481
+ # and writes up to the latest three explicit breakpoints in the request. With
482
+ # `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
483
+ # latest four explicit breakpoints. If there are no explicit breakpoints, the
484
+ # request does not use prompt caching.
485
+ #
486
+ # @see OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions#mode
487
+ module Mode
488
+ extend OpenAI::Internal::Type::Enum
489
+
490
+ IMPLICIT = :implicit
491
+ EXPLICIT = :explicit
492
+
493
+ # @!method self.values
494
+ # @return [Array<Symbol>]
495
+ end
496
+
497
+ # The minimum lifetime applied to every implicit and explicit cache breakpoint
498
+ # written by the request. Defaults to `30m`, which is currently the only supported
499
+ # value. The backend may retain cache entries for longer.
500
+ #
501
+ # @see OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions#ttl
502
+ module Ttl
503
+ extend OpenAI::Internal::Type::Enum
504
+
505
+ TTL_30M = :"30m"
506
+
507
+ # @!method self.values
508
+ # @return [Array<Symbol>]
509
+ end
510
+ end
511
+
512
+ # @deprecated
513
+ #
514
+ # How long to retain a prompt cache entry created by this request.
515
+ module PromptCacheRetention
516
+ extend OpenAI::Internal::Type::Enum
517
+
518
+ IN_MEMORY = :in_memory
519
+ PROMPT_CACHE_RETENTION_24H = :"24h"
520
+
521
+ # @!method self.values
522
+ # @return [Array<Symbol>]
523
+ end
524
+
525
+ # The service tier to use for this request.
526
+ module ServiceTier
527
+ extend OpenAI::Internal::Type::Enum
528
+
529
+ AUTO = :auto
530
+ DEFAULT = :default
531
+ FLEX = :flex
532
+ PRIORITY = :priority
533
+
534
+ # @!method self.values
535
+ # @return [Array<Symbol>]
536
+ end
537
+
538
+ module Beta
539
+ extend OpenAI::Internal::Type::Enum
540
+
541
+ RESPONSES_MULTI_AGENT_V1 = :"responses_multi_agent=v1"
542
+
543
+ # @!method self.values
544
+ # @return [Array<Symbol>]
545
+ end
546
+ end
547
+ end
548
+ end
549
+ end