openai 0.50.0 → 0.52.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 (554) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +38 -0
  3. data/README.md +1 -1
  4. data/lib/openai/client.rb +14 -0
  5. data/lib/openai/internal/conversation_cursor_page.rb +2 -2
  6. data/lib/openai/internal/type/enum.rb +6 -6
  7. data/lib/openai/internal/util.rb +31 -0
  8. data/lib/openai/models/batch_cancel_params.rb +7 -1
  9. data/lib/openai/models/batch_retrieve_params.rb +7 -1
  10. data/lib/openai/models/beta/assistant_create_params.rb +3 -2
  11. data/lib/openai/models/beta/assistant_delete_params.rb +7 -1
  12. data/lib/openai/models/beta/assistant_retrieve_params.rb +7 -1
  13. data/lib/openai/models/beta/assistant_update_params.rb +8 -1
  14. data/lib/openai/models/beta/chatkit/session_cancel_params.rb +7 -1
  15. data/lib/openai/models/beta/chatkit/thread_delete_params.rb +7 -1
  16. data/lib/openai/models/beta/chatkit/thread_list_items_params.rb +8 -1
  17. data/lib/openai/models/beta/chatkit/thread_retrieve_params.rb +7 -1
  18. data/lib/openai/models/beta/thread_create_and_run_params.rb +3 -2
  19. data/lib/openai/models/beta/thread_create_params.rb +3 -2
  20. data/lib/openai/models/beta/thread_delete_params.rb +7 -1
  21. data/lib/openai/models/beta/thread_retrieve_params.rb +7 -1
  22. data/lib/openai/models/beta/thread_update_params.rb +8 -1
  23. data/lib/openai/models/beta/threads/message_create_params.rb +8 -1
  24. data/lib/openai/models/beta/threads/message_delete_params.rb +7 -1
  25. data/lib/openai/models/beta/threads/message_list_params.rb +8 -1
  26. data/lib/openai/models/beta/threads/message_retrieve_params.rb +7 -1
  27. data/lib/openai/models/beta/threads/message_update_params.rb +8 -1
  28. data/lib/openai/models/beta/threads/run_cancel_params.rb +7 -1
  29. data/lib/openai/models/beta/threads/run_create_params.rb +8 -1
  30. data/lib/openai/models/beta/threads/run_list_params.rb +8 -1
  31. data/lib/openai/models/beta/threads/run_retrieve_params.rb +7 -1
  32. data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +8 -1
  33. data/lib/openai/models/beta/threads/run_update_params.rb +8 -1
  34. data/lib/openai/models/beta/threads/runs/step_list_params.rb +8 -1
  35. data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +8 -1
  36. data/lib/openai/models/chat/completion_delete_params.rb +7 -1
  37. data/lib/openai/models/chat/completion_retrieve_params.rb +7 -1
  38. data/lib/openai/models/chat/completion_update_params.rb +8 -1
  39. data/lib/openai/models/chat/completions/message_list_params.rb +8 -1
  40. data/lib/openai/models/chat_model.rb +2 -0
  41. data/lib/openai/models/container_delete_params.rb +7 -1
  42. data/lib/openai/models/container_retrieve_params.rb +7 -1
  43. data/lib/openai/models/containers/file_create_params.rb +8 -1
  44. data/lib/openai/models/containers/file_delete_params.rb +7 -1
  45. data/lib/openai/models/containers/file_list_params.rb +8 -1
  46. data/lib/openai/models/containers/file_retrieve_params.rb +7 -1
  47. data/lib/openai/models/containers/files/content_retrieve_params.rb +7 -1
  48. data/lib/openai/models/conversations/computer_screenshot_content.rb +26 -1
  49. data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
  50. data/lib/openai/models/conversations/conversation_delete_params.rb +7 -1
  51. data/lib/openai/models/conversations/conversation_item.rb +5 -1
  52. data/lib/openai/models/conversations/conversation_item_list.rb +2 -2
  53. data/lib/openai/models/conversations/conversation_retrieve_params.rb +7 -1
  54. data/lib/openai/models/conversations/conversation_update_params.rb +8 -1
  55. data/lib/openai/models/conversations/item_create_params.rb +10 -3
  56. data/lib/openai/models/conversations/item_delete_params.rb +7 -1
  57. data/lib/openai/models/conversations/item_list_params.rb +8 -1
  58. data/lib/openai/models/conversations/item_retrieve_params.rb +8 -1
  59. data/lib/openai/models/eval_delete_params.rb +7 -1
  60. data/lib/openai/models/eval_retrieve_params.rb +7 -1
  61. data/lib/openai/models/eval_update_params.rb +8 -1
  62. data/lib/openai/models/evals/run_cancel_params.rb +7 -1
  63. data/lib/openai/models/evals/run_cancel_response.rb +2 -2
  64. data/lib/openai/models/evals/run_create_params.rb +10 -3
  65. data/lib/openai/models/evals/run_create_response.rb +2 -2
  66. data/lib/openai/models/evals/run_delete_params.rb +7 -1
  67. data/lib/openai/models/evals/run_list_params.rb +8 -1
  68. data/lib/openai/models/evals/run_list_response.rb +2 -2
  69. data/lib/openai/models/evals/run_retrieve_params.rb +7 -1
  70. data/lib/openai/models/evals/run_retrieve_response.rb +2 -2
  71. data/lib/openai/models/evals/runs/output_item_list_params.rb +8 -1
  72. data/lib/openai/models/evals/runs/output_item_retrieve_params.rb +7 -1
  73. data/lib/openai/models/file_content_params.rb +7 -1
  74. data/lib/openai/models/file_delete_params.rb +7 -1
  75. data/lib/openai/models/file_retrieve_params.rb +7 -1
  76. data/lib/openai/models/fine_tuning/checkpoints/permission_create_params.rb +8 -1
  77. data/lib/openai/models/fine_tuning/checkpoints/permission_delete_params.rb +7 -1
  78. data/lib/openai/models/fine_tuning/checkpoints/permission_list_params.rb +68 -0
  79. data/lib/openai/models/fine_tuning/checkpoints/permission_list_response.rb +48 -0
  80. data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rb +8 -1
  81. data/lib/openai/models/fine_tuning/job_cancel_params.rb +7 -1
  82. data/lib/openai/models/fine_tuning/job_list_events_params.rb +8 -1
  83. data/lib/openai/models/fine_tuning/job_pause_params.rb +7 -1
  84. data/lib/openai/models/fine_tuning/job_resume_params.rb +7 -1
  85. data/lib/openai/models/fine_tuning/job_retrieve_params.rb +7 -1
  86. data/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb +8 -1
  87. data/lib/openai/models/model_delete_params.rb +7 -1
  88. data/lib/openai/models/model_retrieve_params.rb +7 -1
  89. data/lib/openai/models/realtime/call_accept_params.rb +7 -1
  90. data/lib/openai/models/realtime/call_hangup_params.rb +7 -1
  91. data/lib/openai/models/realtime/call_refer_params.rb +8 -1
  92. data/lib/openai/models/realtime/call_reject_params.rb +8 -1
  93. data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +9 -1
  94. data/lib/openai/models/realtime/realtime_session_create_response.rb +9 -1
  95. data/lib/openai/models/realtime/realtime_tools_config_union.rb +9 -1
  96. data/lib/openai/models/responses/compacted_response.rb +2 -2
  97. data/lib/openai/models/responses/computer_action.rb +356 -0
  98. data/lib/openai/models/responses/computer_action_list.rb +10 -0
  99. data/lib/openai/models/responses/computer_use_tool.rb +21 -0
  100. data/lib/openai/models/responses/custom_tool.rb +9 -1
  101. data/lib/openai/models/responses/easy_input_message.rb +28 -1
  102. data/lib/openai/models/responses/function_tool.rb +9 -1
  103. data/lib/openai/models/responses/input_item_list_params.rb +8 -1
  104. data/lib/openai/models/responses/input_token_count_params.rb +5 -5
  105. data/lib/openai/models/responses/namespace_tool.rb +93 -0
  106. data/lib/openai/models/responses/response.rb +7 -7
  107. data/lib/openai/models/responses/response_cancel_params.rb +7 -1
  108. data/lib/openai/models/responses/response_compact_params.rb +18 -4
  109. data/lib/openai/models/responses/response_computer_tool_call.rb +74 -65
  110. data/lib/openai/models/responses/response_create_params.rb +5 -5
  111. data/lib/openai/models/responses/response_custom_tool_call.rb +9 -1
  112. data/lib/openai/models/responses/response_delete_params.rb +7 -1
  113. data/lib/openai/models/responses/response_function_tool_call.rb +9 -1
  114. data/lib/openai/models/responses/response_input_file.rb +24 -1
  115. data/lib/openai/models/responses/response_input_file_content.rb +27 -1
  116. data/lib/openai/models/responses/response_input_image.rb +6 -5
  117. data/lib/openai/models/responses/response_input_image_content.rb +6 -5
  118. data/lib/openai/models/responses/response_input_item.rb +87 -1
  119. data/lib/openai/models/responses/response_item.rb +5 -1
  120. data/lib/openai/models/responses/response_item_list.rb +2 -2
  121. data/lib/openai/models/responses/response_output_item.rb +5 -1
  122. data/lib/openai/models/responses/response_output_item_added_event.rb +2 -2
  123. data/lib/openai/models/responses/response_output_item_done_event.rb +2 -2
  124. data/lib/openai/models/responses/response_output_message.rb +28 -1
  125. data/lib/openai/models/responses/response_retrieve_params.rb +8 -1
  126. data/lib/openai/models/responses/response_tool_search_call.rb +93 -0
  127. data/lib/openai/models/responses/response_tool_search_output_item.rb +93 -0
  128. data/lib/openai/models/responses/response_tool_search_output_item_param.rb +89 -0
  129. data/lib/openai/models/responses/responses_client_event.rb +5 -5
  130. data/lib/openai/models/responses/tool.rb +19 -2
  131. data/lib/openai/models/responses/tool_choice_types.rb +6 -0
  132. data/lib/openai/models/responses/tool_search_tool.rb +57 -0
  133. data/lib/openai/models/responses/web_search_preview_tool.rb +19 -1
  134. data/lib/openai/models/skill_delete_params.rb +7 -1
  135. data/lib/openai/models/skill_retrieve_params.rb +7 -1
  136. data/lib/openai/models/skill_update_params.rb +8 -1
  137. data/lib/openai/models/skills/content_retrieve_params.rb +7 -1
  138. data/lib/openai/models/skills/version_create_params.rb +8 -1
  139. data/lib/openai/models/skills/version_delete_params.rb +10 -1
  140. data/lib/openai/models/skills/version_list_params.rb +8 -1
  141. data/lib/openai/models/skills/version_retrieve_params.rb +10 -1
  142. data/lib/openai/models/skills/versions/content_retrieve_params.rb +10 -1
  143. data/lib/openai/models/upload_cancel_params.rb +7 -1
  144. data/lib/openai/models/upload_complete_params.rb +8 -1
  145. data/lib/openai/models/uploads/part_create_params.rb +8 -1
  146. data/lib/openai/models/vector_store_delete_params.rb +7 -1
  147. data/lib/openai/models/vector_store_retrieve_params.rb +7 -1
  148. data/lib/openai/models/vector_store_search_params.rb +8 -1
  149. data/lib/openai/models/vector_store_update_params.rb +8 -1
  150. data/lib/openai/models/vector_stores/file_batch_cancel_params.rb +7 -1
  151. data/lib/openai/models/vector_stores/file_batch_create_params.rb +8 -1
  152. data/lib/openai/models/vector_stores/file_batch_list_files_params.rb +8 -1
  153. data/lib/openai/models/vector_stores/file_batch_retrieve_params.rb +7 -1
  154. data/lib/openai/models/vector_stores/file_content_params.rb +7 -1
  155. data/lib/openai/models/vector_stores/file_create_params.rb +8 -1
  156. data/lib/openai/models/vector_stores/file_delete_params.rb +7 -1
  157. data/lib/openai/models/vector_stores/file_list_params.rb +8 -1
  158. data/lib/openai/models/vector_stores/file_retrieve_params.rb +7 -1
  159. data/lib/openai/models/vector_stores/file_update_params.rb +8 -1
  160. data/lib/openai/models/video.rb +24 -4
  161. data/lib/openai/models/video_create_params.rb +2 -2
  162. data/lib/openai/models/video_delete_params.rb +7 -1
  163. data/lib/openai/models/video_download_content_params.rb +8 -1
  164. data/lib/openai/models/video_remix_params.rb +8 -1
  165. data/lib/openai/models/video_retrieve_params.rb +7 -1
  166. data/lib/openai/resources/audio/speech.rb +1 -0
  167. data/lib/openai/resources/audio/transcriptions.rb +1 -0
  168. data/lib/openai/resources/audio/translations.rb +1 -0
  169. data/lib/openai/resources/audio.rb +3 -0
  170. data/lib/openai/resources/batches.rb +3 -1
  171. data/lib/openai/resources/beta/assistants.rb +3 -1
  172. data/lib/openai/resources/beta/chatkit/threads.rb +4 -2
  173. data/lib/openai/resources/beta/threads/messages.rb +4 -1
  174. data/lib/openai/resources/beta/threads/runs/steps.rb +6 -2
  175. data/lib/openai/resources/beta/threads/runs.rb +11 -5
  176. data/lib/openai/resources/beta/threads.rb +4 -0
  177. data/lib/openai/resources/beta.rb +2 -0
  178. data/lib/openai/resources/chat/completions/messages.rb +4 -1
  179. data/lib/openai/resources/chat/completions.rb +6 -1
  180. data/lib/openai/resources/chat.rb +2 -0
  181. data/lib/openai/resources/completions.rb +2 -0
  182. data/lib/openai/resources/containers/files.rb +2 -1
  183. data/lib/openai/resources/containers.rb +2 -1
  184. data/lib/openai/resources/conversations/items.rb +11 -7
  185. data/lib/openai/resources/conversations.rb +3 -1
  186. data/lib/openai/resources/embeddings.rb +2 -0
  187. data/lib/openai/resources/evals/runs/output_items.rb +3 -1
  188. data/lib/openai/resources/evals/runs.rb +4 -1
  189. data/lib/openai/resources/evals.rb +4 -1
  190. data/lib/openai/resources/files.rb +4 -1
  191. data/lib/openai/resources/fine_tuning/alpha/graders.rb +1 -0
  192. data/lib/openai/resources/fine_tuning/alpha.rb +1 -0
  193. data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb +44 -1
  194. data/lib/openai/resources/fine_tuning/checkpoints.rb +1 -0
  195. data/lib/openai/resources/fine_tuning/jobs/checkpoints.rb +3 -1
  196. data/lib/openai/resources/fine_tuning/jobs.rb +6 -2
  197. data/lib/openai/resources/fine_tuning.rb +1 -0
  198. data/lib/openai/resources/images.rb +1 -0
  199. data/lib/openai/resources/models.rb +1 -0
  200. data/lib/openai/resources/moderations.rb +2 -0
  201. data/lib/openai/resources/responses/input_items.rb +3 -2
  202. data/lib/openai/resources/responses/input_tokens.rb +2 -2
  203. data/lib/openai/resources/responses.rb +12 -8
  204. data/lib/openai/resources/skills/versions.rb +2 -1
  205. data/lib/openai/resources/skills.rb +2 -1
  206. data/lib/openai/resources/uploads/parts.rb +1 -0
  207. data/lib/openai/resources/uploads.rb +2 -0
  208. data/lib/openai/resources/vector_stores/file_batches.rb +2 -1
  209. data/lib/openai/resources/vector_stores/files.rb +2 -1
  210. data/lib/openai/resources/vector_stores.rb +2 -1
  211. data/lib/openai/resources/videos.rb +5 -3
  212. data/lib/openai/version.rb +1 -1
  213. data/lib/openai.rb +10 -0
  214. data/rbi/openai/client.rbi +14 -0
  215. data/rbi/openai/internal/util.rbi +20 -0
  216. data/rbi/openai/models/batch_cancel_params.rbi +13 -5
  217. data/rbi/openai/models/batch_retrieve_params.rbi +13 -5
  218. data/rbi/openai/models/beta/assistant_create_params.rbi +6 -4
  219. data/rbi/openai/models/beta/assistant_delete_params.rbi +13 -5
  220. data/rbi/openai/models/beta/assistant_retrieve_params.rbi +13 -5
  221. data/rbi/openai/models/beta/assistant_update_params.rbi +6 -0
  222. data/rbi/openai/models/beta/chatkit/session_cancel_params.rbi +13 -5
  223. data/rbi/openai/models/beta/chatkit/thread_delete_params.rbi +13 -5
  224. data/rbi/openai/models/beta/chatkit/thread_list_items_params.rbi +6 -0
  225. data/rbi/openai/models/beta/chatkit/thread_retrieve_params.rbi +13 -5
  226. data/rbi/openai/models/beta/thread_create_and_run_params.rbi +6 -4
  227. data/rbi/openai/models/beta/thread_create_params.rbi +6 -4
  228. data/rbi/openai/models/beta/thread_delete_params.rbi +13 -5
  229. data/rbi/openai/models/beta/thread_retrieve_params.rbi +13 -5
  230. data/rbi/openai/models/beta/thread_update_params.rbi +6 -0
  231. data/rbi/openai/models/beta/threads/message_create_params.rbi +6 -0
  232. data/rbi/openai/models/beta/threads/message_delete_params.rbi +10 -2
  233. data/rbi/openai/models/beta/threads/message_list_params.rbi +6 -0
  234. data/rbi/openai/models/beta/threads/message_retrieve_params.rbi +10 -2
  235. data/rbi/openai/models/beta/threads/message_update_params.rbi +6 -0
  236. data/rbi/openai/models/beta/threads/run_cancel_params.rbi +10 -2
  237. data/rbi/openai/models/beta/threads/run_create_params.rbi +6 -0
  238. data/rbi/openai/models/beta/threads/run_list_params.rbi +6 -0
  239. data/rbi/openai/models/beta/threads/run_retrieve_params.rbi +10 -2
  240. data/rbi/openai/models/beta/threads/run_submit_tool_outputs_params.rbi +6 -0
  241. data/rbi/openai/models/beta/threads/run_update_params.rbi +6 -0
  242. data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +6 -0
  243. data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +6 -0
  244. data/rbi/openai/models/chat/completion_delete_params.rbi +13 -5
  245. data/rbi/openai/models/chat/completion_retrieve_params.rbi +13 -5
  246. data/rbi/openai/models/chat/completion_update_params.rbi +6 -0
  247. data/rbi/openai/models/chat/completions/message_list_params.rbi +6 -0
  248. data/rbi/openai/models/chat_model.rbi +3 -0
  249. data/rbi/openai/models/container_delete_params.rbi +13 -5
  250. data/rbi/openai/models/container_retrieve_params.rbi +13 -5
  251. data/rbi/openai/models/containers/file_create_params.rbi +6 -0
  252. data/rbi/openai/models/containers/file_delete_params.rbi +10 -2
  253. data/rbi/openai/models/containers/file_list_params.rbi +6 -0
  254. data/rbi/openai/models/containers/file_retrieve_params.rbi +10 -2
  255. data/rbi/openai/models/containers/files/content_retrieve_params.rbi +10 -2
  256. data/rbi/openai/models/conversations/computer_screenshot_content.rbi +62 -0
  257. data/rbi/openai/models/conversations/conversation_create_params.rbi +6 -0
  258. data/rbi/openai/models/conversations/conversation_delete_params.rbi +13 -5
  259. data/rbi/openai/models/conversations/conversation_item.rbi +2 -0
  260. data/rbi/openai/models/conversations/conversation_item_list.rbi +2 -0
  261. data/rbi/openai/models/conversations/conversation_retrieve_params.rbi +13 -5
  262. data/rbi/openai/models/conversations/conversation_update_params.rbi +6 -0
  263. data/rbi/openai/models/conversations/item_create_params.rbi +12 -0
  264. data/rbi/openai/models/conversations/item_delete_params.rbi +10 -2
  265. data/rbi/openai/models/conversations/item_list_params.rbi +6 -0
  266. data/rbi/openai/models/conversations/item_retrieve_params.rbi +6 -0
  267. data/rbi/openai/models/eval_delete_params.rbi +13 -5
  268. data/rbi/openai/models/eval_retrieve_params.rbi +13 -5
  269. data/rbi/openai/models/eval_update_params.rbi +6 -0
  270. data/rbi/openai/models/evals/run_cancel_params.rbi +10 -2
  271. data/rbi/openai/models/evals/run_cancel_response.rbi +6 -0
  272. data/rbi/openai/models/evals/run_create_params.rbi +18 -0
  273. data/rbi/openai/models/evals/run_create_response.rbi +6 -0
  274. data/rbi/openai/models/evals/run_delete_params.rbi +10 -2
  275. data/rbi/openai/models/evals/run_list_params.rbi +6 -0
  276. data/rbi/openai/models/evals/run_list_response.rbi +6 -0
  277. data/rbi/openai/models/evals/run_retrieve_params.rbi +10 -2
  278. data/rbi/openai/models/evals/run_retrieve_response.rbi +6 -0
  279. data/rbi/openai/models/evals/runs/output_item_list_params.rbi +6 -0
  280. data/rbi/openai/models/evals/runs/output_item_retrieve_params.rbi +6 -1
  281. data/rbi/openai/models/file_content_params.rbi +13 -5
  282. data/rbi/openai/models/file_delete_params.rbi +13 -5
  283. data/rbi/openai/models/file_retrieve_params.rbi +13 -5
  284. data/rbi/openai/models/fine_tuning/checkpoints/permission_create_params.rbi +6 -0
  285. data/rbi/openai/models/fine_tuning/checkpoints/permission_delete_params.rbi +10 -1
  286. data/rbi/openai/models/fine_tuning/checkpoints/permission_list_params.rbi +140 -0
  287. data/rbi/openai/models/fine_tuning/checkpoints/permission_list_response.rbi +70 -0
  288. data/rbi/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbi +6 -0
  289. data/rbi/openai/models/fine_tuning/job_cancel_params.rbi +16 -5
  290. data/rbi/openai/models/fine_tuning/job_list_events_params.rbi +6 -0
  291. data/rbi/openai/models/fine_tuning/job_pause_params.rbi +16 -5
  292. data/rbi/openai/models/fine_tuning/job_resume_params.rbi +16 -5
  293. data/rbi/openai/models/fine_tuning/job_retrieve_params.rbi +16 -5
  294. data/rbi/openai/models/fine_tuning/jobs/checkpoint_list_params.rbi +6 -0
  295. data/rbi/openai/models/model_delete_params.rbi +13 -5
  296. data/rbi/openai/models/model_retrieve_params.rbi +13 -5
  297. data/rbi/openai/models/realtime/call_accept_params.rbi +13 -5
  298. data/rbi/openai/models/realtime/call_hangup_params.rbi +13 -5
  299. data/rbi/openai/models/realtime/call_refer_params.rbi +10 -1
  300. data/rbi/openai/models/realtime/call_reject_params.rbi +10 -1
  301. data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +11 -0
  302. data/rbi/openai/models/realtime/realtime_session_create_response.rbi +11 -0
  303. data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +11 -0
  304. data/rbi/openai/models/responses/compacted_response.rbi +2 -0
  305. data/rbi/openai/models/responses/computer_action.rbi +534 -0
  306. data/rbi/openai/models/responses/computer_action_list.rbi +15 -0
  307. data/rbi/openai/models/responses/computer_use_tool.rbi +31 -0
  308. data/rbi/openai/models/responses/custom_tool.rbi +11 -0
  309. data/rbi/openai/models/responses/easy_input_message.rbi +53 -0
  310. data/rbi/openai/models/responses/function_tool.rbi +11 -0
  311. data/rbi/openai/models/responses/input_item_list_params.rbi +6 -0
  312. data/rbi/openai/models/responses/input_token_count_params.rbi +9 -0
  313. data/rbi/openai/models/responses/namespace_tool.rbi +163 -0
  314. data/rbi/openai/models/responses/response.rbi +5 -0
  315. data/rbi/openai/models/responses/response_cancel_params.rbi +13 -5
  316. data/rbi/openai/models/responses/response_compact_params.rbi +18 -0
  317. data/rbi/openai/models/responses/response_computer_tool_call.rbi +245 -151
  318. data/rbi/openai/models/responses/response_create_params.rbi +12 -0
  319. data/rbi/openai/models/responses/response_custom_tool_call.rbi +12 -1
  320. data/rbi/openai/models/responses/response_delete_params.rbi +13 -5
  321. data/rbi/openai/models/responses/response_function_tool_call.rbi +11 -0
  322. data/rbi/openai/models/responses/response_input_file.rbi +54 -0
  323. data/rbi/openai/models/responses/response_input_file_content.rbi +59 -0
  324. data/rbi/openai/models/responses/response_input_image.rbi +11 -6
  325. data/rbi/openai/models/responses/response_input_image_content.rbi +11 -6
  326. data/rbi/openai/models/responses/response_input_item.rbi +180 -0
  327. data/rbi/openai/models/responses/response_item.rbi +2 -0
  328. data/rbi/openai/models/responses/response_item_list.rbi +2 -0
  329. data/rbi/openai/models/responses/response_output_item.rbi +2 -0
  330. data/rbi/openai/models/responses/response_output_item_added_event.rbi +2 -0
  331. data/rbi/openai/models/responses/response_output_item_done_event.rbi +2 -0
  332. data/rbi/openai/models/responses/response_output_message.rbi +60 -1
  333. data/rbi/openai/models/responses/response_retrieve_params.rbi +6 -0
  334. data/rbi/openai/models/responses/response_tool_search_call.rbi +176 -0
  335. data/rbi/openai/models/responses/response_tool_search_output_item.rbi +199 -0
  336. data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +245 -0
  337. data/rbi/openai/models/responses/responses_client_event.rbi +12 -0
  338. data/rbi/openai/models/responses/tool.rbi +14 -0
  339. data/rbi/openai/models/responses/tool_choice_types.rbi +16 -0
  340. data/rbi/openai/models/responses/tool_search_tool.rbi +107 -0
  341. data/rbi/openai/models/responses/web_search_preview_tool.rbi +64 -0
  342. data/rbi/openai/models/skill_delete_params.rbi +13 -5
  343. data/rbi/openai/models/skill_retrieve_params.rbi +13 -5
  344. data/rbi/openai/models/skill_update_params.rbi +10 -1
  345. data/rbi/openai/models/skills/content_retrieve_params.rbi +13 -5
  346. data/rbi/openai/models/skills/version_create_params.rbi +6 -0
  347. data/rbi/openai/models/skills/version_delete_params.rbi +16 -2
  348. data/rbi/openai/models/skills/version_list_params.rbi +6 -0
  349. data/rbi/openai/models/skills/version_retrieve_params.rbi +16 -2
  350. data/rbi/openai/models/skills/versions/content_retrieve_params.rbi +16 -2
  351. data/rbi/openai/models/upload_cancel_params.rbi +13 -5
  352. data/rbi/openai/models/upload_complete_params.rbi +6 -0
  353. data/rbi/openai/models/uploads/part_create_params.rbi +6 -0
  354. data/rbi/openai/models/vector_store_delete_params.rbi +13 -5
  355. data/rbi/openai/models/vector_store_retrieve_params.rbi +13 -5
  356. data/rbi/openai/models/vector_store_search_params.rbi +6 -0
  357. data/rbi/openai/models/vector_store_update_params.rbi +6 -0
  358. data/rbi/openai/models/vector_stores/file_batch_cancel_params.rbi +10 -2
  359. data/rbi/openai/models/vector_stores/file_batch_create_params.rbi +6 -0
  360. data/rbi/openai/models/vector_stores/file_batch_list_files_params.rbi +6 -0
  361. data/rbi/openai/models/vector_stores/file_batch_retrieve_params.rbi +10 -2
  362. data/rbi/openai/models/vector_stores/file_content_params.rbi +10 -2
  363. data/rbi/openai/models/vector_stores/file_create_params.rbi +6 -0
  364. data/rbi/openai/models/vector_stores/file_delete_params.rbi +10 -2
  365. data/rbi/openai/models/vector_stores/file_list_params.rbi +6 -0
  366. data/rbi/openai/models/vector_stores/file_retrieve_params.rbi +10 -2
  367. data/rbi/openai/models/vector_stores/file_update_params.rbi +6 -0
  368. data/rbi/openai/models/video.rbi +20 -5
  369. data/rbi/openai/models/video_create_params.rbi +2 -2
  370. data/rbi/openai/models/video_delete_params.rbi +13 -5
  371. data/rbi/openai/models/video_download_content_params.rbi +6 -0
  372. data/rbi/openai/models/video_remix_params.rbi +10 -1
  373. data/rbi/openai/models/video_retrieve_params.rbi +13 -5
  374. data/rbi/openai/resources/audio/speech.rbi +1 -0
  375. data/rbi/openai/resources/audio/transcriptions.rbi +1 -0
  376. data/rbi/openai/resources/audio/translations.rbi +1 -0
  377. data/rbi/openai/resources/audio.rbi +3 -0
  378. data/rbi/openai/resources/batches.rbi +1 -0
  379. data/rbi/openai/resources/beta/assistants.rbi +1 -0
  380. data/rbi/openai/resources/beta/threads/messages.rbi +1 -0
  381. data/rbi/openai/resources/beta/threads/runs/steps.rbi +1 -0
  382. data/rbi/openai/resources/beta/threads/runs.rbi +2 -0
  383. data/rbi/openai/resources/beta/threads.rbi +3 -0
  384. data/rbi/openai/resources/beta.rbi +2 -0
  385. data/rbi/openai/resources/chat/completions/messages.rbi +2 -0
  386. data/rbi/openai/resources/chat/completions.rbi +4 -0
  387. data/rbi/openai/resources/chat.rbi +2 -0
  388. data/rbi/openai/resources/completions.rbi +2 -0
  389. data/rbi/openai/resources/conversations/items.rbi +3 -0
  390. data/rbi/openai/resources/conversations.rbi +4 -0
  391. data/rbi/openai/resources/embeddings.rbi +2 -0
  392. data/rbi/openai/resources/evals/runs/output_items.rbi +1 -0
  393. data/rbi/openai/resources/evals/runs.rbi +2 -0
  394. data/rbi/openai/resources/evals.rbi +2 -0
  395. data/rbi/openai/resources/files.rbi +2 -0
  396. data/rbi/openai/resources/fine_tuning/alpha/graders.rbi +1 -0
  397. data/rbi/openai/resources/fine_tuning/alpha.rbi +1 -0
  398. data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi +35 -0
  399. data/rbi/openai/resources/fine_tuning/checkpoints.rbi +1 -0
  400. data/rbi/openai/resources/fine_tuning/jobs/checkpoints.rbi +1 -0
  401. data/rbi/openai/resources/fine_tuning/jobs.rbi +2 -0
  402. data/rbi/openai/resources/fine_tuning.rbi +1 -0
  403. data/rbi/openai/resources/images.rbi +1 -0
  404. data/rbi/openai/resources/models.rbi +1 -0
  405. data/rbi/openai/resources/moderations.rbi +2 -0
  406. data/rbi/openai/resources/responses/input_tokens.rbi +3 -0
  407. data/rbi/openai/resources/responses.rbi +9 -0
  408. data/rbi/openai/resources/uploads/parts.rbi +1 -0
  409. data/rbi/openai/resources/uploads.rbi +2 -0
  410. data/rbi/openai/resources/videos.rbi +1 -1
  411. data/sig/openai/internal/util.rbs +10 -0
  412. data/sig/openai/models/batch_cancel_params.rbs +12 -3
  413. data/sig/openai/models/batch_retrieve_params.rbs +11 -3
  414. data/sig/openai/models/beta/assistant_delete_params.rbs +11 -3
  415. data/sig/openai/models/beta/assistant_retrieve_params.rbs +11 -3
  416. data/sig/openai/models/beta/assistant_update_params.rbs +5 -0
  417. data/sig/openai/models/beta/chatkit/session_cancel_params.rbs +11 -3
  418. data/sig/openai/models/beta/chatkit/thread_delete_params.rbs +11 -3
  419. data/sig/openai/models/beta/chatkit/thread_list_items_params.rbs +5 -0
  420. data/sig/openai/models/beta/chatkit/thread_retrieve_params.rbs +11 -3
  421. data/sig/openai/models/beta/thread_delete_params.rbs +11 -3
  422. data/sig/openai/models/beta/thread_retrieve_params.rbs +11 -3
  423. data/sig/openai/models/beta/thread_update_params.rbs +5 -0
  424. data/sig/openai/models/beta/threads/message_create_params.rbs +5 -0
  425. data/sig/openai/models/beta/threads/message_delete_params.rbs +6 -1
  426. data/sig/openai/models/beta/threads/message_list_params.rbs +5 -0
  427. data/sig/openai/models/beta/threads/message_retrieve_params.rbs +6 -1
  428. data/sig/openai/models/beta/threads/message_update_params.rbs +9 -1
  429. data/sig/openai/models/beta/threads/run_cancel_params.rbs +6 -1
  430. data/sig/openai/models/beta/threads/run_create_params.rbs +5 -0
  431. data/sig/openai/models/beta/threads/run_list_params.rbs +5 -0
  432. data/sig/openai/models/beta/threads/run_retrieve_params.rbs +6 -1
  433. data/sig/openai/models/beta/threads/run_submit_tool_outputs_params.rbs +5 -0
  434. data/sig/openai/models/beta/threads/run_update_params.rbs +9 -1
  435. data/sig/openai/models/beta/threads/runs/step_list_params.rbs +5 -0
  436. data/sig/openai/models/beta/threads/runs/step_retrieve_params.rbs +5 -0
  437. data/sig/openai/models/chat/completion_delete_params.rbs +11 -3
  438. data/sig/openai/models/chat/completion_retrieve_params.rbs +11 -3
  439. data/sig/openai/models/chat/completion_update_params.rbs +5 -1
  440. data/sig/openai/models/chat/completions/message_list_params.rbs +5 -0
  441. data/sig/openai/models/chat_model.rbs +5 -1
  442. data/sig/openai/models/container_delete_params.rbs +11 -3
  443. data/sig/openai/models/container_retrieve_params.rbs +11 -3
  444. data/sig/openai/models/containers/file_create_params.rbs +9 -1
  445. data/sig/openai/models/containers/file_delete_params.rbs +6 -1
  446. data/sig/openai/models/containers/file_list_params.rbs +5 -0
  447. data/sig/openai/models/containers/file_retrieve_params.rbs +6 -1
  448. data/sig/openai/models/containers/files/content_retrieve_params.rbs +6 -1
  449. data/sig/openai/models/conversations/computer_screenshot_content.rbs +23 -1
  450. data/sig/openai/models/conversations/conversation_delete_params.rbs +11 -3
  451. data/sig/openai/models/conversations/conversation_item.rbs +2 -0
  452. data/sig/openai/models/conversations/conversation_retrieve_params.rbs +11 -3
  453. data/sig/openai/models/conversations/conversation_update_params.rbs +5 -1
  454. data/sig/openai/models/conversations/item_create_params.rbs +5 -0
  455. data/sig/openai/models/conversations/item_delete_params.rbs +6 -1
  456. data/sig/openai/models/conversations/item_list_params.rbs +5 -0
  457. data/sig/openai/models/conversations/item_retrieve_params.rbs +5 -0
  458. data/sig/openai/models/eval_delete_params.rbs +12 -3
  459. data/sig/openai/models/eval_retrieve_params.rbs +11 -3
  460. data/sig/openai/models/eval_update_params.rbs +5 -1
  461. data/sig/openai/models/evals/run_cancel_params.rbs +6 -1
  462. data/sig/openai/models/evals/run_create_params.rbs +5 -0
  463. data/sig/openai/models/evals/run_delete_params.rbs +6 -1
  464. data/sig/openai/models/evals/run_list_params.rbs +5 -0
  465. data/sig/openai/models/evals/run_retrieve_params.rbs +6 -1
  466. data/sig/openai/models/evals/runs/output_item_list_params.rbs +5 -0
  467. data/sig/openai/models/evals/runs/output_item_retrieve_params.rbs +5 -1
  468. data/sig/openai/models/file_content_params.rbs +12 -3
  469. data/sig/openai/models/file_delete_params.rbs +12 -3
  470. data/sig/openai/models/file_retrieve_params.rbs +11 -3
  471. data/sig/openai/models/fine_tuning/checkpoints/permission_create_params.rbs +5 -1
  472. data/sig/openai/models/fine_tuning/checkpoints/permission_delete_params.rbs +5 -1
  473. data/sig/openai/models/fine_tuning/checkpoints/permission_list_params.rbs +71 -0
  474. data/sig/openai/models/fine_tuning/checkpoints/permission_list_response.rbs +39 -0
  475. data/sig/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbs +5 -0
  476. data/sig/openai/models/fine_tuning/job_cancel_params.rbs +13 -3
  477. data/sig/openai/models/fine_tuning/job_list_events_params.rbs +5 -1
  478. data/sig/openai/models/fine_tuning/job_pause_params.rbs +13 -3
  479. data/sig/openai/models/fine_tuning/job_resume_params.rbs +13 -3
  480. data/sig/openai/models/fine_tuning/job_retrieve_params.rbs +12 -3
  481. data/sig/openai/models/fine_tuning/jobs/checkpoint_list_params.rbs +5 -1
  482. data/sig/openai/models/model_delete_params.rbs +9 -3
  483. data/sig/openai/models/model_retrieve_params.rbs +8 -3
  484. data/sig/openai/models/realtime/call_accept_params.rbs +13 -3
  485. data/sig/openai/models/realtime/call_hangup_params.rbs +11 -3
  486. data/sig/openai/models/realtime/call_refer_params.rbs +6 -1
  487. data/sig/openai/models/realtime/call_reject_params.rbs +6 -1
  488. data/sig/openai/models/realtime/realtime_response_create_mcp_tool.rbs +7 -0
  489. data/sig/openai/models/realtime/realtime_session_create_response.rbs +7 -0
  490. data/sig/openai/models/realtime/realtime_tools_config_union.rbs +7 -0
  491. data/sig/openai/models/responses/computer_action.rbs +215 -0
  492. data/sig/openai/models/responses/computer_action_list.rbs +10 -0
  493. data/sig/openai/models/responses/computer_use_tool.rbs +15 -0
  494. data/sig/openai/models/responses/custom_tool.rbs +7 -0
  495. data/sig/openai/models/responses/easy_input_message.rbs +16 -0
  496. data/sig/openai/models/responses/function_tool.rbs +7 -0
  497. data/sig/openai/models/responses/input_item_list_params.rbs +5 -0
  498. data/sig/openai/models/responses/namespace_tool.rbs +84 -0
  499. data/sig/openai/models/responses/response_cancel_params.rbs +11 -3
  500. data/sig/openai/models/responses/response_compact_params.rbs +11 -2
  501. data/sig/openai/models/responses/response_computer_tool_call.rbs +62 -49
  502. data/sig/openai/models/responses/response_custom_tool_call.rbs +9 -2
  503. data/sig/openai/models/responses/response_delete_params.rbs +11 -3
  504. data/sig/openai/models/responses/response_function_tool_call.rbs +7 -0
  505. data/sig/openai/models/responses/response_input_file.rbs +20 -0
  506. data/sig/openai/models/responses/response_input_file_content.rbs +20 -0
  507. data/sig/openai/models/responses/response_input_image.rbs +2 -1
  508. data/sig/openai/models/responses/response_input_image_content.rbs +2 -1
  509. data/sig/openai/models/responses/response_input_item.rbs +71 -0
  510. data/sig/openai/models/responses/response_item.rbs +2 -0
  511. data/sig/openai/models/responses/response_output_item.rbs +2 -0
  512. data/sig/openai/models/responses/response_output_message.rbs +18 -2
  513. data/sig/openai/models/responses/response_retrieve_params.rbs +5 -0
  514. data/sig/openai/models/responses/response_tool_search_call.rbs +77 -0
  515. data/sig/openai/models/responses/response_tool_search_output_item.rbs +77 -0
  516. data/sig/openai/models/responses/response_tool_search_output_item_param.rbs +74 -0
  517. data/sig/openai/models/responses/tool.rbs +10 -0
  518. data/sig/openai/models/responses/tool_choice_types.rbs +4 -0
  519. data/sig/openai/models/responses/tool_search_tool.rbs +52 -0
  520. data/sig/openai/models/responses/web_search_preview_tool.rbs +20 -0
  521. data/sig/openai/models/skill_delete_params.rbs +12 -3
  522. data/sig/openai/models/skill_retrieve_params.rbs +11 -3
  523. data/sig/openai/models/skill_update_params.rbs +6 -1
  524. data/sig/openai/models/skills/content_retrieve_params.rbs +11 -3
  525. data/sig/openai/models/skills/version_create_params.rbs +5 -0
  526. data/sig/openai/models/skills/version_delete_params.rbs +6 -1
  527. data/sig/openai/models/skills/version_list_params.rbs +5 -0
  528. data/sig/openai/models/skills/version_retrieve_params.rbs +6 -1
  529. data/sig/openai/models/skills/versions/content_retrieve_params.rbs +6 -1
  530. data/sig/openai/models/upload_cancel_params.rbs +11 -3
  531. data/sig/openai/models/upload_complete_params.rbs +5 -1
  532. data/sig/openai/models/uploads/part_create_params.rbs +5 -1
  533. data/sig/openai/models/vector_store_delete_params.rbs +11 -3
  534. data/sig/openai/models/vector_store_retrieve_params.rbs +11 -3
  535. data/sig/openai/models/vector_store_search_params.rbs +5 -0
  536. data/sig/openai/models/vector_store_update_params.rbs +5 -0
  537. data/sig/openai/models/vector_stores/file_batch_cancel_params.rbs +6 -1
  538. data/sig/openai/models/vector_stores/file_batch_create_params.rbs +5 -0
  539. data/sig/openai/models/vector_stores/file_batch_list_files_params.rbs +5 -0
  540. data/sig/openai/models/vector_stores/file_batch_retrieve_params.rbs +6 -1
  541. data/sig/openai/models/vector_stores/file_content_params.rbs +6 -1
  542. data/sig/openai/models/vector_stores/file_create_params.rbs +5 -0
  543. data/sig/openai/models/vector_stores/file_delete_params.rbs +6 -1
  544. data/sig/openai/models/vector_stores/file_list_params.rbs +5 -0
  545. data/sig/openai/models/vector_stores/file_retrieve_params.rbs +6 -1
  546. data/sig/openai/models/vector_stores/file_update_params.rbs +5 -0
  547. data/sig/openai/models/video.rbs +12 -4
  548. data/sig/openai/models/video_delete_params.rbs +12 -3
  549. data/sig/openai/models/video_download_content_params.rbs +8 -1
  550. data/sig/openai/models/video_remix_params.rbs +6 -1
  551. data/sig/openai/models/video_retrieve_params.rbs +11 -3
  552. data/sig/openai/resources/fine_tuning/checkpoints/permissions.rbs +9 -0
  553. data/sig/openai/resources/responses.rbs +1 -0
  554. metadata +32 -2
@@ -9,6 +9,11 @@ module OpenAI
9
9
  extend OpenAI::Internal::Type::RequestParameters::Converter
10
10
  include OpenAI::Internal::Type::RequestParameters
11
11
 
12
+ # @!attribute thread_id
13
+ #
14
+ # @return [String]
15
+ required :thread_id, String
16
+
12
17
  # @!attribute after
13
18
  # A cursor for use in pagination. `after` is an object ID that defines your place
14
19
  # in the list. For instance, if you make a list request and receive 100 objects,
@@ -41,10 +46,12 @@ module OpenAI
41
46
  # @return [Symbol, OpenAI::Models::Beta::Threads::RunListParams::Order, nil]
42
47
  optional :order, enum: -> { OpenAI::Beta::Threads::RunListParams::Order }
43
48
 
44
- # @!method initialize(after: nil, before: nil, limit: nil, order: nil, request_options: {})
49
+ # @!method initialize(thread_id:, after: nil, before: nil, limit: nil, order: nil, request_options: {})
45
50
  # Some parameter documentations has been truncated, see
46
51
  # {OpenAI::Models::Beta::Threads::RunListParams} for more details.
47
52
  #
53
+ # @param thread_id [String]
54
+ #
48
55
  # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
49
56
  #
50
57
  # @param before [String] A cursor for use in pagination. `before` is an object ID that defines your place
@@ -14,8 +14,14 @@ module OpenAI
14
14
  # @return [String]
15
15
  required :thread_id, String
16
16
 
17
- # @!method initialize(thread_id:, request_options: {})
17
+ # @!attribute run_id
18
+ #
19
+ # @return [String]
20
+ required :run_id, String
21
+
22
+ # @!method initialize(thread_id:, run_id:, request_options: {})
18
23
  # @param thread_id [String]
24
+ # @param run_id [String]
19
25
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
20
26
  end
21
27
  end
@@ -16,6 +16,11 @@ module OpenAI
16
16
  # @return [String]
17
17
  required :thread_id, String
18
18
 
19
+ # @!attribute run_id
20
+ #
21
+ # @return [String]
22
+ required :run_id, String
23
+
19
24
  # @!attribute tool_outputs
20
25
  # A list of tools for which the outputs are being submitted.
21
26
  #
@@ -23,9 +28,11 @@ module OpenAI
23
28
  required :tool_outputs,
24
29
  -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::Threads::RunSubmitToolOutputsParams::ToolOutput] }
25
30
 
26
- # @!method initialize(thread_id:, tool_outputs:, request_options: {})
31
+ # @!method initialize(thread_id:, run_id:, tool_outputs:, request_options: {})
27
32
  # @param thread_id [String]
28
33
  #
34
+ # @param run_id [String]
35
+ #
29
36
  # @param tool_outputs [Array<OpenAI::Models::Beta::Threads::RunSubmitToolOutputsParams::ToolOutput>] A list of tools for which the outputs are being submitted.
30
37
  #
31
38
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
@@ -14,6 +14,11 @@ module OpenAI
14
14
  # @return [String]
15
15
  required :thread_id, String
16
16
 
17
+ # @!attribute run_id
18
+ #
19
+ # @return [String]
20
+ required :run_id, String
21
+
17
22
  # @!attribute metadata
18
23
  # Set of 16 key-value pairs that can be attached to an object. This can be useful
19
24
  # for storing additional information about the object in a structured format, and
@@ -25,12 +30,14 @@ module OpenAI
25
30
  # @return [Hash{Symbol=>String}, nil]
26
31
  optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
27
32
 
28
- # @!method initialize(thread_id:, metadata: nil, request_options: {})
33
+ # @!method initialize(thread_id:, run_id:, metadata: nil, request_options: {})
29
34
  # Some parameter documentations has been truncated, see
30
35
  # {OpenAI::Models::Beta::Threads::RunUpdateParams} for more details.
31
36
  #
32
37
  # @param thread_id [String]
33
38
  #
39
+ # @param run_id [String]
40
+ #
34
41
  # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
35
42
  #
36
43
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
@@ -15,6 +15,11 @@ module OpenAI
15
15
  # @return [String]
16
16
  required :thread_id, String
17
17
 
18
+ # @!attribute run_id
19
+ #
20
+ # @return [String]
21
+ required :run_id, String
22
+
18
23
  # @!attribute after
19
24
  # A cursor for use in pagination. `after` is an object ID that defines your place
20
25
  # in the list. For instance, if you make a list request and receive 100 objects,
@@ -60,12 +65,14 @@ module OpenAI
60
65
  # @return [Symbol, OpenAI::Models::Beta::Threads::Runs::StepListParams::Order, nil]
61
66
  optional :order, enum: -> { OpenAI::Beta::Threads::Runs::StepListParams::Order }
62
67
 
63
- # @!method initialize(thread_id:, after: nil, before: nil, include: nil, limit: nil, order: nil, request_options: {})
68
+ # @!method initialize(thread_id:, run_id:, after: nil, before: nil, include: nil, limit: nil, order: nil, request_options: {})
64
69
  # Some parameter documentations has been truncated, see
65
70
  # {OpenAI::Models::Beta::Threads::Runs::StepListParams} for more details.
66
71
  #
67
72
  # @param thread_id [String]
68
73
  #
74
+ # @param run_id [String]
75
+ #
69
76
  # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
70
77
  #
71
78
  # @param before [String] A cursor for use in pagination. `before` is an object ID that defines your place
@@ -20,6 +20,11 @@ module OpenAI
20
20
  # @return [String]
21
21
  required :run_id, String
22
22
 
23
+ # @!attribute step_id
24
+ #
25
+ # @return [String]
26
+ required :step_id, String
27
+
23
28
  # @!attribute include
24
29
  # A list of additional fields to include in the response. Currently the only
25
30
  # supported value is `step_details.tool_calls[*].file_search.results[*].content`
@@ -33,7 +38,7 @@ module OpenAI
33
38
  optional :include,
34
39
  -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::Threads::Runs::RunStepInclude] }
35
40
 
36
- # @!method initialize(thread_id:, run_id:, include: nil, request_options: {})
41
+ # @!method initialize(thread_id:, run_id:, step_id:, include: nil, request_options: {})
37
42
  # Some parameter documentations has been truncated, see
38
43
  # {OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams} for more details.
39
44
  #
@@ -41,6 +46,8 @@ module OpenAI
41
46
  #
42
47
  # @param run_id [String]
43
48
  #
49
+ # @param step_id [String]
50
+ #
44
51
  # @param include [Array<Symbol, OpenAI::Models::Beta::Threads::Runs::RunStepInclude>] A list of additional fields to include in the response. Currently the only suppo
45
52
  #
46
53
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
@@ -8,7 +8,13 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
- # @!method initialize(request_options: {})
11
+ # @!attribute completion_id
12
+ #
13
+ # @return [String]
14
+ required :completion_id, String
15
+
16
+ # @!method initialize(completion_id:, request_options: {})
17
+ # @param completion_id [String]
12
18
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
13
19
  end
14
20
  end
@@ -8,7 +8,13 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
- # @!method initialize(request_options: {})
11
+ # @!attribute completion_id
12
+ #
13
+ # @return [String]
14
+ required :completion_id, String
15
+
16
+ # @!method initialize(completion_id:, request_options: {})
17
+ # @param completion_id [String]
12
18
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
13
19
  end
14
20
  end
@@ -8,6 +8,11 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute completion_id
12
+ #
13
+ # @return [String]
14
+ required :completion_id, String
15
+
11
16
  # @!attribute metadata
12
17
  # Set of 16 key-value pairs that can be attached to an object. This can be useful
13
18
  # for storing additional information about the object in a structured format, and
@@ -19,10 +24,12 @@ module OpenAI
19
24
  # @return [Hash{Symbol=>String}, nil]
20
25
  required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
21
26
 
22
- # @!method initialize(metadata:, request_options: {})
27
+ # @!method initialize(completion_id:, metadata:, request_options: {})
23
28
  # Some parameter documentations has been truncated, see
24
29
  # {OpenAI::Models::Chat::CompletionUpdateParams} for more details.
25
30
  #
31
+ # @param completion_id [String]
32
+ #
26
33
  # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
27
34
  #
28
35
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
@@ -9,6 +9,11 @@ module OpenAI
9
9
  extend OpenAI::Internal::Type::RequestParameters::Converter
10
10
  include OpenAI::Internal::Type::RequestParameters
11
11
 
12
+ # @!attribute completion_id
13
+ #
14
+ # @return [String]
15
+ required :completion_id, String
16
+
12
17
  # @!attribute after
13
18
  # Identifier for the last message from the previous pagination request.
14
19
  #
@@ -28,10 +33,12 @@ module OpenAI
28
33
  # @return [Symbol, OpenAI::Models::Chat::Completions::MessageListParams::Order, nil]
29
34
  optional :order, enum: -> { OpenAI::Chat::Completions::MessageListParams::Order }
30
35
 
31
- # @!method initialize(after: nil, limit: nil, order: nil, request_options: {})
36
+ # @!method initialize(completion_id:, after: nil, limit: nil, order: nil, request_options: {})
32
37
  # Some parameter documentations has been truncated, see
33
38
  # {OpenAI::Models::Chat::Completions::MessageListParams} for more details.
34
39
  #
40
+ # @param completion_id [String]
41
+ #
35
42
  # @param after [String] Identifier for the last message from the previous pagination request.
36
43
  #
37
44
  # @param limit [Integer] Number of messages to retrieve.
@@ -5,6 +5,8 @@ module OpenAI
5
5
  module ChatModel
6
6
  extend OpenAI::Internal::Type::Enum
7
7
 
8
+ GPT_5_4 = :"gpt-5.4"
9
+ GPT_5_3_CHAT_LATEST = :"gpt-5.3-chat-latest"
8
10
  GPT_5_2 = :"gpt-5.2"
9
11
  GPT_5_2_2025_12_11 = :"gpt-5.2-2025-12-11"
10
12
  GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
@@ -7,7 +7,13 @@ module OpenAI
7
7
  extend OpenAI::Internal::Type::RequestParameters::Converter
8
8
  include OpenAI::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute container_id
11
+ #
12
+ # @return [String]
13
+ required :container_id, String
14
+
15
+ # @!method initialize(container_id:, request_options: {})
16
+ # @param container_id [String]
11
17
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module OpenAI
7
7
  extend OpenAI::Internal::Type::RequestParameters::Converter
8
8
  include OpenAI::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute container_id
11
+ #
12
+ # @return [String]
13
+ required :container_id, String
14
+
15
+ # @!method initialize(container_id:, request_options: {})
16
+ # @param container_id [String]
11
17
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -8,6 +8,11 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute container_id
12
+ #
13
+ # @return [String]
14
+ required :container_id, String
15
+
11
16
  # @!attribute file
12
17
  # The File object (not file name) to be uploaded.
13
18
  #
@@ -20,10 +25,12 @@ module OpenAI
20
25
  # @return [String, nil]
21
26
  optional :file_id, String
22
27
 
23
- # @!method initialize(file: nil, file_id: nil, request_options: {})
28
+ # @!method initialize(container_id:, file: nil, file_id: nil, request_options: {})
24
29
  # Some parameter documentations has been truncated, see
25
30
  # {OpenAI::Models::Containers::FileCreateParams} for more details.
26
31
  #
32
+ # @param container_id [String]
33
+ #
27
34
  # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The File object (not file name) to be uploaded.
28
35
  #
29
36
  # @param file_id [String] Name of the file to create.
@@ -13,8 +13,14 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :container_id, String
15
15
 
16
- # @!method initialize(container_id:, request_options: {})
16
+ # @!attribute file_id
17
+ #
18
+ # @return [String]
19
+ required :file_id, String
20
+
21
+ # @!method initialize(container_id:, file_id:, request_options: {})
17
22
  # @param container_id [String]
23
+ # @param file_id [String]
18
24
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
25
  end
20
26
  end
@@ -8,6 +8,11 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute container_id
12
+ #
13
+ # @return [String]
14
+ required :container_id, String
15
+
11
16
  # @!attribute after
12
17
  # A cursor for use in pagination. `after` is an object ID that defines your place
13
18
  # in the list. For instance, if you make a list request and receive 100 objects,
@@ -31,10 +36,12 @@ module OpenAI
31
36
  # @return [Symbol, OpenAI::Models::Containers::FileListParams::Order, nil]
32
37
  optional :order, enum: -> { OpenAI::Containers::FileListParams::Order }
33
38
 
34
- # @!method initialize(after: nil, limit: nil, order: nil, request_options: {})
39
+ # @!method initialize(container_id:, after: nil, limit: nil, order: nil, request_options: {})
35
40
  # Some parameter documentations has been truncated, see
36
41
  # {OpenAI::Models::Containers::FileListParams} for more details.
37
42
  #
43
+ # @param container_id [String]
44
+ #
38
45
  # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
39
46
  #
40
47
  # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
@@ -13,8 +13,14 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :container_id, String
15
15
 
16
- # @!method initialize(container_id:, request_options: {})
16
+ # @!attribute file_id
17
+ #
18
+ # @return [String]
19
+ required :file_id, String
20
+
21
+ # @!method initialize(container_id:, file_id:, request_options: {})
17
22
  # @param container_id [String]
23
+ # @param file_id [String]
18
24
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
25
  end
20
26
  end
@@ -14,8 +14,14 @@ module OpenAI
14
14
  # @return [String]
15
15
  required :container_id, String
16
16
 
17
- # @!method initialize(container_id:, request_options: {})
17
+ # @!attribute file_id
18
+ #
19
+ # @return [String]
20
+ required :file_id, String
21
+
22
+ # @!method initialize(container_id:, file_id:, request_options: {})
18
23
  # @param container_id [String]
24
+ # @param file_id [String]
19
25
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
20
26
  end
21
27
  end
@@ -4,6 +4,13 @@ module OpenAI
4
4
  module Models
5
5
  module Conversations
6
6
  class ComputerScreenshotContent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute detail
8
+ # The detail level of the screenshot image to be sent to the model. One of `high`,
9
+ # `low`, `auto`, or `original`. Defaults to `auto`.
10
+ #
11
+ # @return [Symbol, OpenAI::Models::Conversations::ComputerScreenshotContent::Detail]
12
+ required :detail, enum: -> { OpenAI::Conversations::ComputerScreenshotContent::Detail }
13
+
7
14
  # @!attribute file_id
8
15
  # The identifier of an uploaded file that contains the screenshot.
9
16
  #
@@ -23,17 +30,35 @@ module OpenAI
23
30
  # @return [Symbol, :computer_screenshot]
24
31
  required :type, const: :computer_screenshot
25
32
 
26
- # @!method initialize(file_id:, image_url:, type: :computer_screenshot)
33
+ # @!method initialize(detail:, file_id:, image_url:, type: :computer_screenshot)
27
34
  # Some parameter documentations has been truncated, see
28
35
  # {OpenAI::Models::Conversations::ComputerScreenshotContent} for more details.
29
36
  #
30
37
  # A screenshot of a computer.
31
38
  #
39
+ # @param detail [Symbol, OpenAI::Models::Conversations::ComputerScreenshotContent::Detail] The detail level of the screenshot image to be sent to the model. One of `high`,
40
+ #
32
41
  # @param file_id [String, nil] The identifier of an uploaded file that contains the screenshot.
33
42
  #
34
43
  # @param image_url [String, nil] The URL of the screenshot image.
35
44
  #
36
45
  # @param type [Symbol, :computer_screenshot] Specifies the event type. For a computer screenshot, this property is always set
46
+
47
+ # The detail level of the screenshot image to be sent to the model. One of `high`,
48
+ # `low`, `auto`, or `original`. Defaults to `auto`.
49
+ #
50
+ # @see OpenAI::Models::Conversations::ComputerScreenshotContent#detail
51
+ module Detail
52
+ extend OpenAI::Internal::Type::Enum
53
+
54
+ LOW = :low
55
+ HIGH = :high
56
+ AUTO = :auto
57
+ ORIGINAL = :original
58
+
59
+ # @!method self.values
60
+ # @return [Array<Symbol>]
61
+ end
37
62
  end
38
63
  end
39
64
  end
@@ -12,7 +12,7 @@ module OpenAI
12
12
  # Initial items to include in the conversation context. You may add up to 20 items
13
13
  # at a time.
14
14
  #
15
- # @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
15
+ # @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
16
16
  optional :items,
17
17
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputItem] },
18
18
  nil?: true
@@ -32,7 +32,7 @@ module OpenAI
32
32
  # Some parameter documentations has been truncated, see
33
33
  # {OpenAI::Models::Conversations::ConversationCreateParams} for more details.
34
34
  #
35
- # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
35
+ # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
36
36
  #
37
37
  # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
38
38
  #
@@ -8,7 +8,13 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
- # @!method initialize(request_options: {})
11
+ # @!attribute conversation_id
12
+ #
13
+ # @return [String]
14
+ required :conversation_id, String
15
+
16
+ # @!method initialize(conversation_id:, request_options: {})
17
+ # @param conversation_id [String]
12
18
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
13
19
  end
14
20
  end
@@ -39,6 +39,10 @@ module OpenAI
39
39
 
40
40
  variant :computer_call_output, -> { OpenAI::Responses::ResponseComputerToolCallOutputItem }
41
41
 
42
+ variant :tool_search_call, -> { OpenAI::Responses::ResponseToolSearchCall }
43
+
44
+ variant :tool_search_output, -> { OpenAI::Responses::ResponseToolSearchOutputItem }
45
+
42
46
  # A description of the chain of thought used by a reasoning model while generating
43
47
  # a response. Be sure to include these items in your `input` to the Responses API
44
48
  # for subsequent turns of a conversation if you are manually
@@ -604,7 +608,7 @@ module OpenAI
604
608
  end
605
609
 
606
610
  # @!method self.variants
607
- # @return [Array(OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput)]
611
+ # @return [Array(OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput)]
608
612
  end
609
613
  end
610
614
 
@@ -8,7 +8,7 @@ module OpenAI
8
8
  # @!attribute data
9
9
  # A list of conversation items.
10
10
  #
11
- # @return [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
11
+ # @return [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
12
12
  required :data, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Conversations::ConversationItem] }
13
13
 
14
14
  # @!attribute first_id
@@ -38,7 +38,7 @@ module OpenAI
38
38
  # @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
39
39
  # A list of Conversation items.
40
40
  #
41
- # @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
41
+ # @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
42
42
  #
43
43
  # @param first_id [String] The ID of the first item in the list.
44
44
  #
@@ -8,7 +8,13 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
- # @!method initialize(request_options: {})
11
+ # @!attribute conversation_id
12
+ #
13
+ # @return [String]
14
+ required :conversation_id, String
15
+
16
+ # @!method initialize(conversation_id:, request_options: {})
17
+ # @param conversation_id [String]
12
18
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
13
19
  end
14
20
  end
@@ -8,6 +8,11 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute conversation_id
12
+ #
13
+ # @return [String]
14
+ required :conversation_id, String
15
+
11
16
  # @!attribute metadata
12
17
  # Set of 16 key-value pairs that can be attached to an object. This can be useful
13
18
  # for storing additional information about the object in a structured format, and
@@ -19,10 +24,12 @@ module OpenAI
19
24
  # @return [Hash{Symbol=>String}, nil]
20
25
  required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
21
26
 
22
- # @!method initialize(metadata:, request_options: {})
27
+ # @!method initialize(conversation_id:, metadata:, request_options: {})
23
28
  # Some parameter documentations has been truncated, see
24
29
  # {OpenAI::Models::Conversations::ConversationUpdateParams} for more details.
25
30
  #
31
+ # @param conversation_id [String]
32
+ #
26
33
  # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
27
34
  #
28
35
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
@@ -8,10 +8,15 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute conversation_id
12
+ #
13
+ # @return [String]
14
+ required :conversation_id, String
15
+
11
16
  # @!attribute items
12
17
  # The items to add to the conversation. You may add up to 20 items at a time.
13
18
  #
14
- # @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
19
+ # @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
15
20
  required :items, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputItem] }
16
21
 
17
22
  # @!attribute include
@@ -22,11 +27,13 @@ module OpenAI
22
27
  # @return [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
23
28
  optional :include, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::ResponseIncludable] }
24
29
 
25
- # @!method initialize(items:, include: nil, request_options: {})
30
+ # @!method initialize(conversation_id:, items:, include: nil, request_options: {})
26
31
  # Some parameter documentations has been truncated, see
27
32
  # {OpenAI::Models::Conversations::ItemCreateParams} for more details.
28
33
  #
29
- # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] The items to add to the conversation. You may add up to 20 items at a time.
34
+ # @param conversation_id [String]
35
+ #
36
+ # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] The items to add to the conversation. You may add up to 20 items at a time.
30
37
  #
31
38
  # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
32
39
  #
@@ -13,8 +13,14 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :conversation_id, String
15
15
 
16
- # @!method initialize(conversation_id:, request_options: {})
16
+ # @!attribute item_id
17
+ #
18
+ # @return [String]
19
+ required :item_id, String
20
+
21
+ # @!method initialize(conversation_id:, item_id:, request_options: {})
17
22
  # @param conversation_id [String]
23
+ # @param item_id [String]
18
24
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
25
  end
20
26
  end