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
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Responses
6
+ class ToolSearchTool < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute type
8
+ # The type of the tool. Always `tool_search`.
9
+ #
10
+ # @return [Symbol, :tool_search]
11
+ required :type, const: :tool_search
12
+
13
+ # @!attribute description
14
+ # Description shown to the model for a client-executed tool search tool.
15
+ #
16
+ # @return [String, nil]
17
+ optional :description, String, nil?: true
18
+
19
+ # @!attribute execution
20
+ # Whether tool search is executed by the server or by the client.
21
+ #
22
+ # @return [Symbol, OpenAI::Models::Responses::ToolSearchTool::Execution, nil]
23
+ optional :execution, enum: -> { OpenAI::Responses::ToolSearchTool::Execution }
24
+
25
+ # @!attribute parameters
26
+ # Parameter schema for a client-executed tool search tool.
27
+ #
28
+ # @return [Object, nil]
29
+ optional :parameters, OpenAI::Internal::Type::Unknown, nil?: true
30
+
31
+ # @!method initialize(description: nil, execution: nil, parameters: nil, type: :tool_search)
32
+ # Hosted or BYOT tool search configuration for deferred tools.
33
+ #
34
+ # @param description [String, nil] Description shown to the model for a client-executed tool search tool.
35
+ #
36
+ # @param execution [Symbol, OpenAI::Models::Responses::ToolSearchTool::Execution] Whether tool search is executed by the server or by the client.
37
+ #
38
+ # @param parameters [Object, nil] Parameter schema for a client-executed tool search tool.
39
+ #
40
+ # @param type [Symbol, :tool_search] The type of the tool. Always `tool_search`.
41
+
42
+ # Whether tool search is executed by the server or by the client.
43
+ #
44
+ # @see OpenAI::Models::Responses::ToolSearchTool#execution
45
+ module Execution
46
+ extend OpenAI::Internal::Type::Enum
47
+
48
+ SERVER = :server
49
+ CLIENT = :client
50
+
51
+ # @!method self.values
52
+ # @return [Array<Symbol>]
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -11,6 +11,12 @@ module OpenAI
11
11
  # @return [Symbol, OpenAI::Models::Responses::WebSearchPreviewTool::Type]
12
12
  required :type, enum: -> { OpenAI::Responses::WebSearchPreviewTool::Type }
13
13
 
14
+ # @!attribute search_content_types
15
+ #
16
+ # @return [Array<Symbol, OpenAI::Models::Responses::WebSearchPreviewTool::SearchContentType>, nil]
17
+ optional :search_content_types,
18
+ -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::WebSearchPreviewTool::SearchContentType] }
19
+
14
20
  # @!attribute search_context_size
15
21
  # High level guidance for the amount of context window space to use for the
16
22
  # search. One of `low`, `medium`, or `high`. `medium` is the default.
@@ -24,7 +30,7 @@ module OpenAI
24
30
  # @return [OpenAI::Models::Responses::WebSearchPreviewTool::UserLocation, nil]
25
31
  optional :user_location, -> { OpenAI::Responses::WebSearchPreviewTool::UserLocation }, nil?: true
26
32
 
27
- # @!method initialize(type:, search_context_size: nil, user_location: nil)
33
+ # @!method initialize(type:, search_content_types: nil, search_context_size: nil, user_location: nil)
28
34
  # Some parameter documentations has been truncated, see
29
35
  # {OpenAI::Models::Responses::WebSearchPreviewTool} for more details.
30
36
  #
@@ -34,6 +40,8 @@ module OpenAI
34
40
  #
35
41
  # @param type [Symbol, OpenAI::Models::Responses::WebSearchPreviewTool::Type] The type of the web search tool. One of `web_search_preview` or `web_search_prev
36
42
  #
43
+ # @param search_content_types [Array<Symbol, OpenAI::Models::Responses::WebSearchPreviewTool::SearchContentType>]
44
+ #
37
45
  # @param search_context_size [Symbol, OpenAI::Models::Responses::WebSearchPreviewTool::SearchContextSize] High level guidance for the amount of context window space to use for the search
38
46
  #
39
47
  # @param user_location [OpenAI::Models::Responses::WebSearchPreviewTool::UserLocation, nil] The user's location.
@@ -52,6 +60,16 @@ module OpenAI
52
60
  # @return [Array<Symbol>]
53
61
  end
54
62
 
63
+ module SearchContentType
64
+ extend OpenAI::Internal::Type::Enum
65
+
66
+ TEXT = :text
67
+ IMAGE = :image
68
+
69
+ # @!method self.values
70
+ # @return [Array<Symbol>]
71
+ end
72
+
55
73
  # High level guidance for the amount of context window space to use for the
56
74
  # search. One of `low`, `medium`, or `high`. `medium` is the default.
57
75
  #
@@ -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 skill_id
11
+ #
12
+ # @return [String]
13
+ required :skill_id, String
14
+
15
+ # @!method initialize(skill_id:, request_options: {})
16
+ # @param skill_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 skill_id
11
+ #
12
+ # @return [String]
13
+ required :skill_id, String
14
+
15
+ # @!method initialize(skill_id:, request_options: {})
16
+ # @param skill_id [String]
11
17
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,13 +7,20 @@ module OpenAI
7
7
  extend OpenAI::Internal::Type::RequestParameters::Converter
8
8
  include OpenAI::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute skill_id
11
+ #
12
+ # @return [String]
13
+ required :skill_id, String
14
+
10
15
  # @!attribute default_version
11
16
  # The skill version number to set as default.
12
17
  #
13
18
  # @return [String]
14
19
  required :default_version, String
15
20
 
16
- # @!method initialize(default_version:, request_options: {})
21
+ # @!method initialize(skill_id:, default_version:, request_options: {})
22
+ # @param skill_id [String]
23
+ #
17
24
  # @param default_version [String] The skill version number to set as default.
18
25
  #
19
26
  # @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 skill_id
12
+ #
13
+ # @return [String]
14
+ required :skill_id, String
15
+
16
+ # @!method initialize(skill_id:, request_options: {})
17
+ # @param skill_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 skill_id
12
+ #
13
+ # @return [String]
14
+ required :skill_id, String
15
+
11
16
  # @!attribute default
12
17
  # Whether to set this version as the default.
13
18
  #
@@ -20,7 +25,9 @@ module OpenAI
20
25
  # @return [Array<Pathname, StringIO, IO, String, OpenAI::FilePart>, Pathname, StringIO, IO, String, OpenAI::FilePart, nil]
21
26
  optional :files, union: -> { OpenAI::Skills::VersionCreateParams::Files }
22
27
 
23
- # @!method initialize(default: nil, files: nil, request_options: {})
28
+ # @!method initialize(skill_id:, default: nil, files: nil, request_options: {})
29
+ # @param skill_id [String]
30
+ #
24
31
  # @param default [Boolean] Whether to set this version as the default.
25
32
  #
26
33
  # @param files [Array<Pathname, StringIO, IO, String, OpenAI::FilePart>, Pathname, StringIO, IO, String, OpenAI::FilePart] Skill files to upload (directory upload) or a single zip file.
@@ -13,8 +13,17 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :skill_id, String
15
15
 
16
- # @!method initialize(skill_id:, request_options: {})
16
+ # @!attribute version
17
+ # The skill version number.
18
+ #
19
+ # @return [String]
20
+ required :version, String
21
+
22
+ # @!method initialize(skill_id:, version:, request_options: {})
17
23
  # @param skill_id [String]
24
+ #
25
+ # @param version [String] The skill version number.
26
+ #
18
27
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
28
  end
20
29
  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 skill_id
12
+ #
13
+ # @return [String]
14
+ required :skill_id, String
15
+
11
16
  # @!attribute after
12
17
  # The skill version ID to start after.
13
18
  #
@@ -26,7 +31,9 @@ module OpenAI
26
31
  # @return [Symbol, OpenAI::Models::Skills::VersionListParams::Order, nil]
27
32
  optional :order, enum: -> { OpenAI::Skills::VersionListParams::Order }
28
33
 
29
- # @!method initialize(after: nil, limit: nil, order: nil, request_options: {})
34
+ # @!method initialize(skill_id:, after: nil, limit: nil, order: nil, request_options: {})
35
+ # @param skill_id [String]
36
+ #
30
37
  # @param after [String] The skill version ID to start after.
31
38
  #
32
39
  # @param limit [Integer] Number of versions to retrieve.
@@ -13,8 +13,17 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :skill_id, String
15
15
 
16
- # @!method initialize(skill_id:, request_options: {})
16
+ # @!attribute version
17
+ # The version number to retrieve.
18
+ #
19
+ # @return [String]
20
+ required :version, String
21
+
22
+ # @!method initialize(skill_id:, version:, request_options: {})
17
23
  # @param skill_id [String]
24
+ #
25
+ # @param version [String] The version number to retrieve.
26
+ #
18
27
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
28
  end
20
29
  end
@@ -14,8 +14,17 @@ module OpenAI
14
14
  # @return [String]
15
15
  required :skill_id, String
16
16
 
17
- # @!method initialize(skill_id:, request_options: {})
17
+ # @!attribute version
18
+ # The skill version number.
19
+ #
20
+ # @return [String]
21
+ required :version, String
22
+
23
+ # @!method initialize(skill_id:, version:, request_options: {})
18
24
  # @param skill_id [String]
25
+ #
26
+ # @param version [String] The skill version number.
27
+ #
19
28
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
20
29
  end
21
30
  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 upload_id
11
+ #
12
+ # @return [String]
13
+ required :upload_id, String
14
+
15
+ # @!method initialize(upload_id:, request_options: {})
16
+ # @param upload_id [String]
11
17
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,6 +7,11 @@ module OpenAI
7
7
  extend OpenAI::Internal::Type::RequestParameters::Converter
8
8
  include OpenAI::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute upload_id
11
+ #
12
+ # @return [String]
13
+ required :upload_id, String
14
+
10
15
  # @!attribute part_ids
11
16
  # The ordered list of Part IDs.
12
17
  #
@@ -20,10 +25,12 @@ module OpenAI
20
25
  # @return [String, nil]
21
26
  optional :md5, String
22
27
 
23
- # @!method initialize(part_ids:, md5: nil, request_options: {})
28
+ # @!method initialize(upload_id:, part_ids:, md5: nil, request_options: {})
24
29
  # Some parameter documentations has been truncated, see
25
30
  # {OpenAI::Models::UploadCompleteParams} for more details.
26
31
  #
32
+ # @param upload_id [String]
33
+ #
27
34
  # @param part_ids [Array<String>] The ordered list of Part IDs.
28
35
  #
29
36
  # @param md5 [String] The optional md5 checksum for the file contents to verify if the bytes uploaded
@@ -8,16 +8,23 @@ module OpenAI
8
8
  extend OpenAI::Internal::Type::RequestParameters::Converter
9
9
  include OpenAI::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute upload_id
12
+ #
13
+ # @return [String]
14
+ required :upload_id, String
15
+
11
16
  # @!attribute data
12
17
  # The chunk of bytes for this Part.
13
18
  #
14
19
  # @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
15
20
  required :data, OpenAI::Internal::Type::FileInput
16
21
 
17
- # @!method initialize(data:, request_options: {})
22
+ # @!method initialize(upload_id:, data:, request_options: {})
18
23
  # Some parameter documentations has been truncated, see
19
24
  # {OpenAI::Models::Uploads::PartCreateParams} for more details.
20
25
  #
26
+ # @param upload_id [String]
27
+ #
21
28
  # @param data [Pathname, StringIO, IO, String, OpenAI::FilePart] The chunk of bytes for this Part.
22
29
  #
23
30
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
@@ -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 vector_store_id
11
+ #
12
+ # @return [String]
13
+ required :vector_store_id, String
14
+
15
+ # @!method initialize(vector_store_id:, request_options: {})
16
+ # @param vector_store_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 vector_store_id
11
+ #
12
+ # @return [String]
13
+ required :vector_store_id, String
14
+
15
+ # @!method initialize(vector_store_id:, request_options: {})
16
+ # @param vector_store_id [String]
11
17
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,6 +7,11 @@ module OpenAI
7
7
  extend OpenAI::Internal::Type::RequestParameters::Converter
8
8
  include OpenAI::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute vector_store_id
11
+ #
12
+ # @return [String]
13
+ required :vector_store_id, String
14
+
10
15
  # @!attribute query
11
16
  # A query string for a search
12
17
  #
@@ -38,10 +43,12 @@ module OpenAI
38
43
  # @return [Boolean, nil]
39
44
  optional :rewrite_query, OpenAI::Internal::Type::Boolean
40
45
 
41
- # @!method initialize(query:, filters: nil, max_num_results: nil, ranking_options: nil, rewrite_query: nil, request_options: {})
46
+ # @!method initialize(vector_store_id:, query:, filters: nil, max_num_results: nil, ranking_options: nil, rewrite_query: nil, request_options: {})
42
47
  # Some parameter documentations has been truncated, see
43
48
  # {OpenAI::Models::VectorStoreSearchParams} for more details.
44
49
  #
50
+ # @param vector_store_id [String]
51
+ #
45
52
  # @param query [String, Array<String>] A query string for a search
46
53
  #
47
54
  # @param filters [OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter] A filter to apply based on file attributes.
@@ -7,6 +7,11 @@ module OpenAI
7
7
  extend OpenAI::Internal::Type::RequestParameters::Converter
8
8
  include OpenAI::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute vector_store_id
11
+ #
12
+ # @return [String]
13
+ required :vector_store_id, String
14
+
10
15
  # @!attribute expires_after
11
16
  # The expiration policy for a vector store.
12
17
  #
@@ -30,10 +35,12 @@ module OpenAI
30
35
  # @return [String, nil]
31
36
  optional :name, String, nil?: true
32
37
 
33
- # @!method initialize(expires_after: nil, metadata: nil, name: nil, request_options: {})
38
+ # @!method initialize(vector_store_id:, expires_after: nil, metadata: nil, name: nil, request_options: {})
34
39
  # Some parameter documentations has been truncated, see
35
40
  # {OpenAI::Models::VectorStoreUpdateParams} for more details.
36
41
  #
42
+ # @param vector_store_id [String]
43
+ #
37
44
  # @param expires_after [OpenAI::Models::VectorStoreUpdateParams::ExpiresAfter, nil] The expiration policy for a vector store.
38
45
  #
39
46
  # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
@@ -13,8 +13,14 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :vector_store_id, String
15
15
 
16
- # @!method initialize(vector_store_id:, request_options: {})
16
+ # @!attribute batch_id
17
+ #
18
+ # @return [String]
19
+ required :batch_id, String
20
+
21
+ # @!method initialize(vector_store_id:, batch_id:, request_options: {})
17
22
  # @param vector_store_id [String]
23
+ # @param batch_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 vector_store_id
12
+ #
13
+ # @return [String]
14
+ required :vector_store_id, String
15
+
11
16
  # @!attribute attributes
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
@@ -49,10 +54,12 @@ module OpenAI
49
54
  # @return [Array<OpenAI::Models::VectorStores::FileBatchCreateParams::File>, nil]
50
55
  optional :files, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::VectorStores::FileBatchCreateParams::File] }
51
56
 
52
- # @!method initialize(attributes: nil, chunking_strategy: nil, file_ids: nil, files: nil, request_options: {})
57
+ # @!method initialize(vector_store_id:, attributes: nil, chunking_strategy: nil, file_ids: nil, files: nil, request_options: {})
53
58
  # Some parameter documentations has been truncated, see
54
59
  # {OpenAI::Models::VectorStores::FileBatchCreateParams} for more details.
55
60
  #
61
+ # @param vector_store_id [String]
62
+ #
56
63
  # @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
57
64
  #
58
65
  # @param chunking_strategy [OpenAI::Models::AutoFileChunkingStrategyParam, OpenAI::Models::StaticFileChunkingStrategyObjectParam] The chunking strategy used to chunk the file(s). If not set, will use the `auto`
@@ -13,6 +13,11 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :vector_store_id, String
15
15
 
16
+ # @!attribute batch_id
17
+ #
18
+ # @return [String]
19
+ required :batch_id, String
20
+
16
21
  # @!attribute after
17
22
  # A cursor for use in pagination. `after` is an object ID that defines your place
18
23
  # in the list. For instance, if you make a list request and receive 100 objects,
@@ -51,12 +56,14 @@ module OpenAI
51
56
  # @return [Symbol, OpenAI::Models::VectorStores::FileBatchListFilesParams::Order, nil]
52
57
  optional :order, enum: -> { OpenAI::VectorStores::FileBatchListFilesParams::Order }
53
58
 
54
- # @!method initialize(vector_store_id:, after: nil, before: nil, filter: nil, limit: nil, order: nil, request_options: {})
59
+ # @!method initialize(vector_store_id:, batch_id:, after: nil, before: nil, filter: nil, limit: nil, order: nil, request_options: {})
55
60
  # Some parameter documentations has been truncated, see
56
61
  # {OpenAI::Models::VectorStores::FileBatchListFilesParams} for more details.
57
62
  #
58
63
  # @param vector_store_id [String]
59
64
  #
65
+ # @param batch_id [String]
66
+ #
60
67
  # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
61
68
  #
62
69
  # @param before [String] A cursor for use in pagination. `before` is an object ID that defines your place
@@ -13,8 +13,14 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :vector_store_id, String
15
15
 
16
- # @!method initialize(vector_store_id:, request_options: {})
16
+ # @!attribute batch_id
17
+ #
18
+ # @return [String]
19
+ required :batch_id, String
20
+
21
+ # @!method initialize(vector_store_id:, batch_id:, request_options: {})
17
22
  # @param vector_store_id [String]
23
+ # @param batch_id [String]
18
24
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
25
  end
20
26
  end
@@ -13,8 +13,14 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :vector_store_id, String
15
15
 
16
- # @!method initialize(vector_store_id:, request_options: {})
16
+ # @!attribute file_id
17
+ #
18
+ # @return [String]
19
+ required :file_id, String
20
+
21
+ # @!method initialize(vector_store_id:, file_id:, request_options: {})
17
22
  # @param vector_store_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 vector_store_id
12
+ #
13
+ # @return [String]
14
+ required :vector_store_id, String
15
+
11
16
  # @!attribute file_id
12
17
  # A [File](https://platform.openai.com/docs/api-reference/files) ID that the
13
18
  # vector store should use. Useful for tools like `file_search` that can access
@@ -37,10 +42,12 @@ module OpenAI
37
42
  # @return [OpenAI::Models::AutoFileChunkingStrategyParam, OpenAI::Models::StaticFileChunkingStrategyObjectParam, nil]
38
43
  optional :chunking_strategy, union: -> { OpenAI::FileChunkingStrategyParam }
39
44
 
40
- # @!method initialize(file_id:, attributes: nil, chunking_strategy: nil, request_options: {})
45
+ # @!method initialize(vector_store_id:, file_id:, attributes: nil, chunking_strategy: nil, request_options: {})
41
46
  # Some parameter documentations has been truncated, see
42
47
  # {OpenAI::Models::VectorStores::FileCreateParams} for more details.
43
48
  #
49
+ # @param vector_store_id [String]
50
+ #
44
51
  # @param file_id [String] A [File](https://platform.openai.com/docs/api-reference/files) ID that the vecto
45
52
  #
46
53
  # @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
@@ -13,8 +13,14 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :vector_store_id, String
15
15
 
16
- # @!method initialize(vector_store_id:, request_options: {})
16
+ # @!attribute file_id
17
+ #
18
+ # @return [String]
19
+ required :file_id, String
20
+
21
+ # @!method initialize(vector_store_id:, file_id:, request_options: {})
17
22
  # @param vector_store_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 vector_store_id
12
+ #
13
+ # @return [String]
14
+ required :vector_store_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,
@@ -46,10 +51,12 @@ module OpenAI
46
51
  # @return [Symbol, OpenAI::Models::VectorStores::FileListParams::Order, nil]
47
52
  optional :order, enum: -> { OpenAI::VectorStores::FileListParams::Order }
48
53
 
49
- # @!method initialize(after: nil, before: nil, filter: nil, limit: nil, order: nil, request_options: {})
54
+ # @!method initialize(vector_store_id:, after: nil, before: nil, filter: nil, limit: nil, order: nil, request_options: {})
50
55
  # Some parameter documentations has been truncated, see
51
56
  # {OpenAI::Models::VectorStores::FileListParams} for more details.
52
57
  #
58
+ # @param vector_store_id [String]
59
+ #
53
60
  # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
54
61
  #
55
62
  # @param before [String] A cursor for use in pagination. `before` is an object ID that defines your place
@@ -13,8 +13,14 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :vector_store_id, String
15
15
 
16
- # @!method initialize(vector_store_id:, request_options: {})
16
+ # @!attribute file_id
17
+ #
18
+ # @return [String]
19
+ required :file_id, String
20
+
21
+ # @!method initialize(vector_store_id:, file_id:, request_options: {})
17
22
  # @param vector_store_id [String]
23
+ # @param file_id [String]
18
24
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
25
  end
20
26
  end
@@ -13,6 +13,11 @@ module OpenAI
13
13
  # @return [String]
14
14
  required :vector_store_id, String
15
15
 
16
+ # @!attribute file_id
17
+ #
18
+ # @return [String]
19
+ required :file_id, String
20
+
16
21
  # @!attribute attributes
17
22
  # Set of 16 key-value pairs that can be attached to an object. This can be useful
18
23
  # for storing additional information about the object in a structured format, and
@@ -27,12 +32,14 @@ module OpenAI
27
32
  },
28
33
  nil?: true
29
34
 
30
- # @!method initialize(vector_store_id:, attributes:, request_options: {})
35
+ # @!method initialize(vector_store_id:, file_id:, attributes:, request_options: {})
31
36
  # Some parameter documentations has been truncated, see
32
37
  # {OpenAI::Models::VectorStores::FileUpdateParams} for more details.
33
38
  #
34
39
  # @param vector_store_id [String]
35
40
  #
41
+ # @param file_id [String]
42
+ #
36
43
  # @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
37
44
  #
38
45
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]