openai 0.130.0 → 1.0.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 (422) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +36 -0
  3. data/README.md +39 -3
  4. data/lib/openai/client.rb +0 -4
  5. data/lib/openai/internal/type/union.rb +5 -1
  6. data/lib/openai/models/batch_create_params.rb +6 -19
  7. data/lib/openai/models/beta/beta_compacted_response.rb +3 -3
  8. data/lib/openai/models/beta/beta_response.rb +0 -18
  9. data/lib/openai/models/beta/beta_responses_client_event.rb +0 -26
  10. data/lib/openai/models/beta/response_compact_params.rb +0 -18
  11. data/lib/openai/models/beta/response_create_params.rb +0 -18
  12. data/lib/openai/models/chat/completion_create_params.rb +8 -6
  13. data/lib/openai/models/chat_model.rb +0 -12
  14. data/lib/openai/models/completion_create_params.rb +4 -2
  15. data/lib/openai/models/graders/multi_grader.rb +11 -15
  16. data/lib/openai/models/image_edit_completed_event.rb +9 -17
  17. data/lib/openai/models/image_edit_partial_image_event.rb +9 -17
  18. data/lib/openai/models/image_gen_completed_event.rb +9 -17
  19. data/lib/openai/models/image_gen_partial_image_event.rb +9 -17
  20. data/lib/openai/models/images_response.rb +8 -14
  21. data/lib/openai/models/live/responses_delegation_config.rb +47 -21
  22. data/lib/openai/models/live/responses_delegation_update_config.rb +47 -21
  23. data/lib/openai/models/responses/compacted_response.rb +3 -3
  24. data/lib/openai/models/responses/response_compact_params.rb +0 -18
  25. data/lib/openai/models.rb +0 -32
  26. data/lib/openai/providers/vertex.rb +9 -6
  27. data/lib/openai/resources/batches.rb +2 -6
  28. data/lib/openai/resources/beta.rb +0 -10
  29. data/lib/openai/resources/chat/completions.rb +8 -6
  30. data/lib/openai/resources/completions.rb +4 -2
  31. data/lib/openai/version.rb +1 -1
  32. data/lib/openai.rb +0 -114
  33. data/rbi/openai/client.rbi +0 -3
  34. data/rbi/openai/models/batch_create_params.rbi +6 -19
  35. data/rbi/openai/models/beta/beta_compacted_response.rbi +22 -20
  36. data/rbi/openai/models/beta/beta_response.rbi +0 -3
  37. data/rbi/openai/models/beta/beta_responses_client_event.rbi +0 -12
  38. data/rbi/openai/models/beta/response_compact_params.rbi +0 -9
  39. data/rbi/openai/models/beta/response_create_params.rbi +0 -6
  40. data/rbi/openai/models/chat/completion_create_params.rbi +8 -6
  41. data/rbi/openai/models/chat_model.rbi +0 -3
  42. data/rbi/openai/models/completion_create_params.rbi +4 -2
  43. data/rbi/openai/models/graders/multi_grader.rbi +32 -27
  44. data/rbi/openai/models/image_edit_completed_event.rbi +11 -8
  45. data/rbi/openai/models/image_edit_partial_image_event.rbi +11 -8
  46. data/rbi/openai/models/image_gen_completed_event.rbi +11 -8
  47. data/rbi/openai/models/image_gen_partial_image_event.rbi +11 -8
  48. data/rbi/openai/models/images_response.rbi +6 -6
  49. data/rbi/openai/models/live/responses_delegation_config.rbi +54 -30
  50. data/rbi/openai/models/live/responses_delegation_update_config.rbi +54 -30
  51. data/rbi/openai/models/responses/compacted_response.rbi +19 -17
  52. data/rbi/openai/models/responses/response_compact_params.rbi +0 -12
  53. data/rbi/openai/models.rbi +0 -32
  54. data/rbi/openai/resources/batches.rbi +2 -6
  55. data/rbi/openai/resources/beta.rbi +0 -8
  56. data/rbi/openai/resources/chat/completions.rbi +8 -6
  57. data/rbi/openai/resources/completions.rbi +4 -2
  58. data/sig/openai/client.rbs +0 -2
  59. data/sig/openai/models/batch_create_params.rbs +4 -14
  60. data/sig/openai/models/beta/beta_compacted_response.rbs +4 -4
  61. data/sig/openai/models/beta/beta_response.rbs +0 -6
  62. data/sig/openai/models/beta/beta_responses_client_event.rbs +0 -6
  63. data/sig/openai/models/beta/response_compact_params.rbs +0 -6
  64. data/sig/openai/models/beta/response_create_params.rbs +0 -6
  65. data/sig/openai/models/chat/completion_create_params.rbs +8 -6
  66. data/sig/openai/models/chat_model.rbs +0 -6
  67. data/sig/openai/models/completion_create_params.rbs +4 -2
  68. data/sig/openai/models/graders/multi_grader.rbs +7 -12
  69. data/sig/openai/models/image_edit_completed_event.rbs +11 -9
  70. data/sig/openai/models/image_edit_partial_image_event.rbs +11 -9
  71. data/sig/openai/models/image_gen_completed_event.rbs +11 -9
  72. data/sig/openai/models/image_gen_partial_image_event.rbs +11 -9
  73. data/sig/openai/models/images_response.rbs +5 -7
  74. data/sig/openai/models/live/responses_delegation_config.rbs +50 -18
  75. data/sig/openai/models/live/responses_delegation_update_config.rbs +50 -18
  76. data/sig/openai/models/responses/compacted_response.rbs +4 -4
  77. data/sig/openai/models/responses/response_compact_params.rbs +0 -6
  78. data/sig/openai/models.rbs +0 -32
  79. data/sig/openai/resources/beta.rbs +0 -4
  80. metadata +1 -343
  81. data/lib/openai/models/beta/assistant.rb +0 -270
  82. data/lib/openai/models/beta/assistant_create_params.rb +0 -448
  83. data/lib/openai/models/beta/assistant_delete_params.rb +0 -22
  84. data/lib/openai/models/beta/assistant_deleted.rb +0 -30
  85. data/lib/openai/models/beta/assistant_list_params.rb +0 -80
  86. data/lib/openai/models/beta/assistant_response_format_option.rb +0 -50
  87. data/lib/openai/models/beta/assistant_retrieve_params.rb +0 -22
  88. data/lib/openai/models/beta/assistant_stream_event.rb +0 -688
  89. data/lib/openai/models/beta/assistant_tool.rb +0 -22
  90. data/lib/openai/models/beta/assistant_tool_choice.rb +0 -43
  91. data/lib/openai/models/beta/assistant_tool_choice_function.rb +0 -19
  92. data/lib/openai/models/beta/assistant_tool_choice_option.rb +0 -42
  93. data/lib/openai/models/beta/assistant_update_params.rb +0 -450
  94. data/lib/openai/models/beta/code_interpreter_tool.rb +0 -19
  95. data/lib/openai/models/beta/file_search_tool.rb +0 -123
  96. data/lib/openai/models/beta/function_tool.rb +0 -26
  97. data/lib/openai/models/beta/message_stream_event.rb +0 -159
  98. data/lib/openai/models/beta/run_step_stream_event.rb +0 -201
  99. data/lib/openai/models/beta/run_stream_event.rb +0 -288
  100. data/lib/openai/models/beta/thread.rb +0 -133
  101. data/lib/openai/models/beta/thread_create_and_run_params.rb +0 -857
  102. data/lib/openai/models/beta/thread_create_params.rb +0 -443
  103. data/lib/openai/models/beta/thread_delete_params.rb +0 -22
  104. data/lib/openai/models/beta/thread_deleted.rb +0 -30
  105. data/lib/openai/models/beta/thread_retrieve_params.rb +0 -22
  106. data/lib/openai/models/beta/thread_stream_event.rb +0 -41
  107. data/lib/openai/models/beta/thread_update_params.rb +0 -114
  108. data/lib/openai/models/beta/threads/annotation.rb +0 -27
  109. data/lib/openai/models/beta/threads/annotation_delta.rb +0 -27
  110. data/lib/openai/models/beta/threads/file_citation_annotation.rb +0 -68
  111. data/lib/openai/models/beta/threads/file_citation_delta_annotation.rb +0 -86
  112. data/lib/openai/models/beta/threads/file_path_annotation.rb +0 -67
  113. data/lib/openai/models/beta/threads/file_path_delta_annotation.rb +0 -76
  114. data/lib/openai/models/beta/threads/image_file.rb +0 -51
  115. data/lib/openai/models/beta/threads/image_file_content_block.rb +0 -32
  116. data/lib/openai/models/beta/threads/image_file_delta.rb +0 -51
  117. data/lib/openai/models/beta/threads/image_file_delta_block.rb +0 -41
  118. data/lib/openai/models/beta/threads/image_url.rb +0 -49
  119. data/lib/openai/models/beta/threads/image_url_content_block.rb +0 -30
  120. data/lib/openai/models/beta/threads/image_url_delta.rb +0 -49
  121. data/lib/openai/models/beta/threads/image_url_delta_block.rb +0 -39
  122. data/lib/openai/models/beta/threads/message.rb +0 -272
  123. data/lib/openai/models/beta/threads/message_content.rb +0 -33
  124. data/lib/openai/models/beta/threads/message_content_delta.rb +0 -33
  125. data/lib/openai/models/beta/threads/message_content_part_param.rb +0 -30
  126. data/lib/openai/models/beta/threads/message_create_params.rb +0 -172
  127. data/lib/openai/models/beta/threads/message_delete_params.rb +0 -30
  128. data/lib/openai/models/beta/threads/message_deleted.rb +0 -32
  129. data/lib/openai/models/beta/threads/message_delta.rb +0 -48
  130. data/lib/openai/models/beta/threads/message_delta_event.rb +0 -42
  131. data/lib/openai/models/beta/threads/message_list_params.rb +0 -98
  132. data/lib/openai/models/beta/threads/message_retrieve_params.rb +0 -30
  133. data/lib/openai/models/beta/threads/message_update_params.rb +0 -51
  134. data/lib/openai/models/beta/threads/refusal_content_block.rb +0 -30
  135. data/lib/openai/models/beta/threads/refusal_delta_block.rb +0 -39
  136. data/lib/openai/models/beta/threads/required_action_function_tool_call.rb +0 -73
  137. data/lib/openai/models/beta/threads/run.rb +0 -557
  138. data/lib/openai/models/beta/threads/run_cancel_params.rb +0 -30
  139. data/lib/openai/models/beta/threads/run_create_params.rb +0 -565
  140. data/lib/openai/models/beta/threads/run_list_params.rb +0 -89
  141. data/lib/openai/models/beta/threads/run_retrieve_params.rb +0 -30
  142. data/lib/openai/models/beta/threads/run_status.rb +0 -29
  143. data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +0 -69
  144. data/lib/openai/models/beta/threads/run_update_params.rb +0 -51
  145. data/lib/openai/models/beta/threads/runs/code_interpreter_logs.rb +0 -43
  146. data/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb +0 -54
  147. data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +0 -161
  148. data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +0 -107
  149. data/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +0 -207
  150. data/lib/openai/models/beta/threads/runs/file_search_tool_call_delta.rb +0 -52
  151. data/lib/openai/models/beta/threads/runs/function_tool_call.rb +0 -78
  152. data/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb +0 -87
  153. data/lib/openai/models/beta/threads/runs/message_creation_step_details.rb +0 -48
  154. data/lib/openai/models/beta/threads/runs/run_step.rb +0 -311
  155. data/lib/openai/models/beta/threads/runs/run_step_delta.rb +0 -45
  156. data/lib/openai/models/beta/threads/runs/run_step_delta_event.rb +0 -46
  157. data/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb +0 -47
  158. data/lib/openai/models/beta/threads/runs/run_step_include.rb +0 -22
  159. data/lib/openai/models/beta/threads/runs/step_list_params.rb +0 -122
  160. data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +0 -65
  161. data/lib/openai/models/beta/threads/runs/tool_call.rb +0 -28
  162. data/lib/openai/models/beta/threads/runs/tool_call_delta.rb +0 -28
  163. data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb +0 -41
  164. data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb +0 -38
  165. data/lib/openai/models/beta/threads/text.rb +0 -28
  166. data/lib/openai/models/beta/threads/text_content_block.rb +0 -30
  167. data/lib/openai/models/beta/threads/text_content_block_param.rb +0 -32
  168. data/lib/openai/models/beta/threads/text_delta.rb +0 -31
  169. data/lib/openai/models/beta/threads/text_delta_block.rb +0 -39
  170. data/lib/openai/models/image_input_reference_param.rb +0 -24
  171. data/lib/openai/models/video.rb +0 -161
  172. data/lib/openai/models/video_create_character_params.rb +0 -40
  173. data/lib/openai/models/video_create_character_response.rb +0 -36
  174. data/lib/openai/models/video_create_error.rb +0 -166
  175. data/lib/openai/models/video_create_params.rb +0 -85
  176. data/lib/openai/models/video_delete_params.rb +0 -20
  177. data/lib/openai/models/video_delete_response.rb +0 -38
  178. data/lib/openai/models/video_download_content_params.rb +0 -42
  179. data/lib/openai/models/video_edit_params.rb +0 -68
  180. data/lib/openai/models/video_extend_params.rb +0 -79
  181. data/lib/openai/models/video_get_character_params.rb +0 -20
  182. data/lib/openai/models/video_get_character_response.rb +0 -36
  183. data/lib/openai/models/video_list_params.rb +0 -55
  184. data/lib/openai/models/video_model.rb +0 -38
  185. data/lib/openai/models/video_remix_params.rb +0 -30
  186. data/lib/openai/models/video_retrieve_params.rb +0 -20
  187. data/lib/openai/models/video_seconds.rb +0 -16
  188. data/lib/openai/models/video_size.rb +0 -17
  189. data/lib/openai/resources/beta/assistants.rb +0 -320
  190. data/lib/openai/resources/beta/threads/messages.rb +0 -236
  191. data/lib/openai/resources/beta/threads/runs/steps.rb +0 -141
  192. data/lib/openai/resources/beta/threads/runs.rb +0 -623
  193. data/lib/openai/resources/beta/threads.rb +0 -444
  194. data/lib/openai/resources/videos.rb +0 -354
  195. data/rbi/openai/models/beta/assistant.rbi +0 -411
  196. data/rbi/openai/models/beta/assistant_create_params.rbi +0 -776
  197. data/rbi/openai/models/beta/assistant_delete_params.rbi +0 -53
  198. data/rbi/openai/models/beta/assistant_deleted.rbi +0 -60
  199. data/rbi/openai/models/beta/assistant_list_params.rbi +0 -132
  200. data/rbi/openai/models/beta/assistant_response_format_option.rbi +0 -49
  201. data/rbi/openai/models/beta/assistant_retrieve_params.rbi +0 -53
  202. data/rbi/openai/models/beta/assistant_stream_event.rbi +0 -1277
  203. data/rbi/openai/models/beta/assistant_tool.rbi +0 -28
  204. data/rbi/openai/models/beta/assistant_tool_choice.rbi +0 -79
  205. data/rbi/openai/models/beta/assistant_tool_choice_function.rbi +0 -49
  206. data/rbi/openai/models/beta/assistant_tool_choice_option.rbi +0 -53
  207. data/rbi/openai/models/beta/assistant_update_params.rbi +0 -556
  208. data/rbi/openai/models/beta/code_interpreter_tool.rbi +0 -49
  209. data/rbi/openai/models/beta/file_search_tool.rbi +0 -223
  210. data/rbi/openai/models/beta/function_tool.rbi +0 -59
  211. data/rbi/openai/models/beta/message_stream_event.rbi +0 -288
  212. data/rbi/openai/models/beta/run_step_stream_event.rbi +0 -378
  213. data/rbi/openai/models/beta/run_stream_event.rbi +0 -537
  214. data/rbi/openai/models/beta/thread.rbi +0 -255
  215. data/rbi/openai/models/beta/thread_create_and_run_params.rbi +0 -1461
  216. data/rbi/openai/models/beta/thread_create_params.rbi +0 -823
  217. data/rbi/openai/models/beta/thread_delete_params.rbi +0 -53
  218. data/rbi/openai/models/beta/thread_deleted.rbi +0 -60
  219. data/rbi/openai/models/beta/thread_retrieve_params.rbi +0 -53
  220. data/rbi/openai/models/beta/thread_stream_event.rbi +0 -75
  221. data/rbi/openai/models/beta/thread_update_params.rbi +0 -240
  222. data/rbi/openai/models/beta/threads/annotation.rbi +0 -34
  223. data/rbi/openai/models/beta/threads/annotation_delta.rbi +0 -34
  224. data/rbi/openai/models/beta/threads/file_citation_annotation.rbi +0 -132
  225. data/rbi/openai/models/beta/threads/file_citation_delta_annotation.rbi +0 -166
  226. data/rbi/openai/models/beta/threads/file_path_annotation.rbi +0 -131
  227. data/rbi/openai/models/beta/threads/file_path_delta_annotation.rbi +0 -153
  228. data/rbi/openai/models/beta/threads/image_file.rbi +0 -88
  229. data/rbi/openai/models/beta/threads/image_file_content_block.rbi +0 -66
  230. data/rbi/openai/models/beta/threads/image_file_delta.rbi +0 -91
  231. data/rbi/openai/models/beta/threads/image_file_delta_block.rbi +0 -75
  232. data/rbi/openai/models/beta/threads/image_url.rbi +0 -86
  233. data/rbi/openai/models/beta/threads/image_url_content_block.rbi +0 -64
  234. data/rbi/openai/models/beta/threads/image_url_delta.rbi +0 -89
  235. data/rbi/openai/models/beta/threads/image_url_delta_block.rbi +0 -73
  236. data/rbi/openai/models/beta/threads/message.rbi +0 -433
  237. data/rbi/openai/models/beta/threads/message_content.rbi +0 -36
  238. data/rbi/openai/models/beta/threads/message_content_delta.rbi +0 -36
  239. data/rbi/openai/models/beta/threads/message_content_part_param.rbi +0 -35
  240. data/rbi/openai/models/beta/threads/message_create_params.rbi +0 -299
  241. data/rbi/openai/models/beta/threads/message_delete_params.rbi +0 -64
  242. data/rbi/openai/models/beta/threads/message_deleted.rbi +0 -64
  243. data/rbi/openai/models/beta/threads/message_delta.rbi +0 -106
  244. data/rbi/openai/models/beta/threads/message_delta_event.rbi +0 -76
  245. data/rbi/openai/models/beta/threads/message_list_params.rbi +0 -157
  246. data/rbi/openai/models/beta/threads/message_retrieve_params.rbi +0 -64
  247. data/rbi/openai/models/beta/threads/message_update_params.rbi +0 -88
  248. data/rbi/openai/models/beta/threads/refusal_content_block.rbi +0 -61
  249. data/rbi/openai/models/beta/threads/refusal_delta_block.rbi +0 -73
  250. data/rbi/openai/models/beta/threads/required_action_function_tool_call.rbi +0 -130
  251. data/rbi/openai/models/beta/threads/run.rbi +0 -803
  252. data/rbi/openai/models/beta/threads/run_cancel_params.rbi +0 -64
  253. data/rbi/openai/models/beta/threads/run_create_params.rbi +0 -825
  254. data/rbi/openai/models/beta/threads/run_list_params.rbi +0 -144
  255. data/rbi/openai/models/beta/threads/run_retrieve_params.rbi +0 -64
  256. data/rbi/openai/models/beta/threads/run_status.rbi +0 -39
  257. data/rbi/openai/models/beta/threads/run_submit_tool_outputs_params.rbi +0 -132
  258. data/rbi/openai/models/beta/threads/run_update_params.rbi +0 -88
  259. data/rbi/openai/models/beta/threads/runs/code_interpreter_logs.rbi +0 -79
  260. data/rbi/openai/models/beta/threads/runs/code_interpreter_output_image.rbi +0 -118
  261. data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call.rbi +0 -315
  262. data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbi +0 -210
  263. data/rbi/openai/models/beta/threads/runs/file_search_tool_call.rbi +0 -409
  264. data/rbi/openai/models/beta/threads/runs/file_search_tool_call_delta.rbi +0 -89
  265. data/rbi/openai/models/beta/threads/runs/function_tool_call.rbi +0 -138
  266. data/rbi/openai/models/beta/threads/runs/function_tool_call_delta.rbi +0 -161
  267. data/rbi/openai/models/beta/threads/runs/message_creation_step_details.rbi +0 -111
  268. data/rbi/openai/models/beta/threads/runs/run_step.rbi +0 -422
  269. data/rbi/openai/models/beta/threads/runs/run_step_delta.rbi +0 -91
  270. data/rbi/openai/models/beta/threads/runs/run_step_delta_event.rbi +0 -82
  271. data/rbi/openai/models/beta/threads/runs/run_step_delta_message_delta.rbi +0 -113
  272. data/rbi/openai/models/beta/threads/runs/run_step_include.rbi +0 -37
  273. data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +0 -181
  274. data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +0 -105
  275. data/rbi/openai/models/beta/threads/runs/tool_call.rbi +0 -37
  276. data/rbi/openai/models/beta/threads/runs/tool_call_delta.rbi +0 -37
  277. data/rbi/openai/models/beta/threads/runs/tool_call_delta_object.rbi +0 -91
  278. data/rbi/openai/models/beta/threads/runs/tool_calls_step_details.rbi +0 -77
  279. data/rbi/openai/models/beta/threads/text.rbi +0 -65
  280. data/rbi/openai/models/beta/threads/text_content_block.rbi +0 -64
  281. data/rbi/openai/models/beta/threads/text_content_block_param.rbi +0 -63
  282. data/rbi/openai/models/beta/threads/text_delta.rbi +0 -81
  283. data/rbi/openai/models/beta/threads/text_delta_block.rbi +0 -73
  284. data/rbi/openai/models/image_input_reference_param.rbi +0 -58
  285. data/rbi/openai/models/video.rbi +0 -203
  286. data/rbi/openai/models/video_create_character_params.rbi +0 -68
  287. data/rbi/openai/models/video_create_character_response.rbi +0 -63
  288. data/rbi/openai/models/video_create_error.rbi +0 -255
  289. data/rbi/openai/models/video_create_params.rbi +0 -132
  290. data/rbi/openai/models/video_delete_params.rbi +0 -49
  291. data/rbi/openai/models/video_delete_response.rbi +0 -64
  292. data/rbi/openai/models/video_download_content_params.rbi +0 -81
  293. data/rbi/openai/models/video_edit_params.rbi +0 -122
  294. data/rbi/openai/models/video_extend_params.rbi +0 -134
  295. data/rbi/openai/models/video_get_character_params.rbi +0 -49
  296. data/rbi/openai/models/video_get_character_response.rbi +0 -63
  297. data/rbi/openai/models/video_list_params.rbi +0 -101
  298. data/rbi/openai/models/video_model.rbi +0 -35
  299. data/rbi/openai/models/video_remix_params.rbi +0 -58
  300. data/rbi/openai/models/video_retrieve_params.rbi +0 -49
  301. data/rbi/openai/models/video_seconds.rbi +0 -22
  302. data/rbi/openai/models/video_size.rbi +0 -23
  303. data/rbi/openai/resources/beta/assistants.rbi +0 -285
  304. data/rbi/openai/resources/beta/threads/messages.rbi +0 -161
  305. data/rbi/openai/resources/beta/threads/runs/steps.rbi +0 -107
  306. data/rbi/openai/resources/beta/threads/runs.rbi +0 -527
  307. data/rbi/openai/resources/beta/threads.rbi +0 -391
  308. data/rbi/openai/resources/videos.rbi +0 -205
  309. data/sig/openai/models/beta/assistant.rbs +0 -278
  310. data/sig/openai/models/beta/assistant_create_params.rbs +0 -485
  311. data/sig/openai/models/beta/assistant_delete_params.rbs +0 -25
  312. data/sig/openai/models/beta/assistant_deleted.rbs +0 -28
  313. data/sig/openai/models/beta/assistant_list_params.rbs +0 -104
  314. data/sig/openai/models/beta/assistant_response_format_option.rbs +0 -17
  315. data/sig/openai/models/beta/assistant_retrieve_params.rbs +0 -25
  316. data/sig/openai/models/beta/assistant_stream_event.rbs +0 -645
  317. data/sig/openai/models/beta/assistant_tool.rbs +0 -16
  318. data/sig/openai/models/beta/assistant_tool_choice.rbs +0 -46
  319. data/sig/openai/models/beta/assistant_tool_choice_function.rbs +0 -18
  320. data/sig/openai/models/beta/assistant_tool_choice_option.rbs +0 -27
  321. data/sig/openai/models/beta/assistant_update_params.rbs +0 -396
  322. data/sig/openai/models/beta/code_interpreter_tool.rbs +0 -18
  323. data/sig/openai/models/beta/file_search_tool.rbs +0 -159
  324. data/sig/openai/models/beta/function_tool.rbs +0 -27
  325. data/sig/openai/models/beta/message_stream_event.rbs +0 -153
  326. data/sig/openai/models/beta/run_step_stream_event.rbs +0 -197
  327. data/sig/openai/models/beta/run_stream_event.rbs +0 -269
  328. data/sig/openai/models/beta/thread.rbs +0 -150
  329. data/sig/openai/models/beta/thread_create_and_run_params.rbs +0 -885
  330. data/sig/openai/models/beta/thread_create_params.rbs +0 -492
  331. data/sig/openai/models/beta/thread_delete_params.rbs +0 -25
  332. data/sig/openai/models/beta/thread_deleted.rbs +0 -28
  333. data/sig/openai/models/beta/thread_retrieve_params.rbs +0 -25
  334. data/sig/openai/models/beta/thread_stream_event.rbs +0 -43
  335. data/sig/openai/models/beta/thread_update_params.rbs +0 -137
  336. data/sig/openai/models/beta/threads/annotation.rbs +0 -17
  337. data/sig/openai/models/beta/threads/annotation_delta.rbs +0 -17
  338. data/sig/openai/models/beta/threads/file_citation_annotation.rbs +0 -63
  339. data/sig/openai/models/beta/threads/file_citation_delta_annotation.rbs +0 -93
  340. data/sig/openai/models/beta/threads/file_path_annotation.rbs +0 -63
  341. data/sig/openai/models/beta/threads/file_path_delta_annotation.rbs +0 -85
  342. data/sig/openai/models/beta/threads/image_file.rbs +0 -59
  343. data/sig/openai/models/beta/threads/image_file_content_block.rbs +0 -29
  344. data/sig/openai/models/beta/threads/image_file_delta.rbs +0 -64
  345. data/sig/openai/models/beta/threads/image_file_delta_block.rbs +0 -44
  346. data/sig/openai/models/beta/threads/image_url.rbs +0 -57
  347. data/sig/openai/models/beta/threads/image_url_content_block.rbs +0 -29
  348. data/sig/openai/models/beta/threads/image_url_delta.rbs +0 -61
  349. data/sig/openai/models/beta/threads/image_url_delta_block.rbs +0 -44
  350. data/sig/openai/models/beta/threads/message.rbs +0 -275
  351. data/sig/openai/models/beta/threads/message_content.rbs +0 -19
  352. data/sig/openai/models/beta/threads/message_content_delta.rbs +0 -19
  353. data/sig/openai/models/beta/threads/message_content_part_param.rbs +0 -18
  354. data/sig/openai/models/beta/threads/message_create_params.rbs +0 -167
  355. data/sig/openai/models/beta/threads/message_delete_params.rbs +0 -35
  356. data/sig/openai/models/beta/threads/message_deleted.rbs +0 -30
  357. data/sig/openai/models/beta/threads/message_delta.rbs +0 -56
  358. data/sig/openai/models/beta/threads/message_delta_event.rbs +0 -43
  359. data/sig/openai/models/beta/threads/message_list_params.rbs +0 -122
  360. data/sig/openai/models/beta/threads/message_retrieve_params.rbs +0 -35
  361. data/sig/openai/models/beta/threads/message_update_params.rbs +0 -53
  362. data/sig/openai/models/beta/threads/refusal_content_block.rbs +0 -22
  363. data/sig/openai/models/beta/threads/refusal_delta_block.rbs +0 -34
  364. data/sig/openai/models/beta/threads/required_action_function_tool_call.rbs +0 -69
  365. data/sig/openai/models/beta/threads/run.rbs +0 -545
  366. data/sig/openai/models/beta/threads/run_cancel_params.rbs +0 -35
  367. data/sig/openai/models/beta/threads/run_create_params.rbs +0 -524
  368. data/sig/openai/models/beta/threads/run_list_params.rbs +0 -111
  369. data/sig/openai/models/beta/threads/run_retrieve_params.rbs +0 -35
  370. data/sig/openai/models/beta/threads/run_status.rbs +0 -34
  371. data/sig/openai/models/beta/threads/run_submit_tool_outputs_params.rbs +0 -70
  372. data/sig/openai/models/beta/threads/run_update_params.rbs +0 -53
  373. data/sig/openai/models/beta/threads/runs/code_interpreter_logs.rbs +0 -40
  374. data/sig/openai/models/beta/threads/runs/code_interpreter_output_image.rbs +0 -65
  375. data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call.rbs +0 -147
  376. data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbs +0 -115
  377. data/sig/openai/models/beta/threads/runs/file_search_tool_call.rbs +0 -228
  378. data/sig/openai/models/beta/threads/runs/file_search_tool_call_delta.rbs +0 -58
  379. data/sig/openai/models/beta/threads/runs/function_tool_call.rbs +0 -80
  380. data/sig/openai/models/beta/threads/runs/function_tool_call_delta.rbs +0 -103
  381. data/sig/openai/models/beta/threads/runs/message_creation_step_details.rbs +0 -47
  382. data/sig/openai/models/beta/threads/runs/run_step.rbs +0 -290
  383. data/sig/openai/models/beta/threads/runs/run_step_delta.rbs +0 -46
  384. data/sig/openai/models/beta/threads/runs/run_step_delta_event.rbs +0 -47
  385. data/sig/openai/models/beta/threads/runs/run_step_delta_message_delta.rbs +0 -56
  386. data/sig/openai/models/beta/threads/runs/run_step_include.rbs +0 -22
  387. data/sig/openai/models/beta/threads/runs/step_list_params.rbs +0 -149
  388. data/sig/openai/models/beta/threads/runs/step_retrieve_params.rbs +0 -73
  389. data/sig/openai/models/beta/threads/runs/tool_call.rbs +0 -20
  390. data/sig/openai/models/beta/threads/runs/tool_call_delta.rbs +0 -20
  391. data/sig/openai/models/beta/threads/runs/tool_call_delta_object.rbs +0 -48
  392. data/sig/openai/models/beta/threads/runs/tool_calls_step_details.rbs +0 -41
  393. data/sig/openai/models/beta/threads/text.rbs +0 -32
  394. data/sig/openai/models/beta/threads/text_content_block.rbs +0 -26
  395. data/sig/openai/models/beta/threads/text_content_block_param.rbs +0 -25
  396. data/sig/openai/models/beta/threads/text_delta.rbs +0 -39
  397. data/sig/openai/models/beta/threads/text_delta_block.rbs +0 -44
  398. data/sig/openai/models/image_input_reference_param.rbs +0 -23
  399. data/sig/openai/models/video.rbs +0 -142
  400. data/sig/openai/models/video_create_character_params.rbs +0 -45
  401. data/sig/openai/models/video_create_character_response.rbs +0 -27
  402. data/sig/openai/models/video_create_error.rbs +0 -163
  403. data/sig/openai/models/video_create_params.rbs +0 -104
  404. data/sig/openai/models/video_delete_params.rbs +0 -23
  405. data/sig/openai/models/video_delete_response.rbs +0 -31
  406. data/sig/openai/models/video_download_content_params.rbs +0 -51
  407. data/sig/openai/models/video_edit_params.rbs +0 -77
  408. data/sig/openai/models/video_extend_params.rbs +0 -87
  409. data/sig/openai/models/video_get_character_params.rbs +0 -23
  410. data/sig/openai/models/video_get_character_response.rbs +0 -27
  411. data/sig/openai/models/video_list_params.rbs +0 -70
  412. data/sig/openai/models/video_model.rbs +0 -23
  413. data/sig/openai/models/video_remix_params.rbs +0 -34
  414. data/sig/openai/models/video_retrieve_params.rbs +0 -23
  415. data/sig/openai/models/video_seconds.rbs +0 -15
  416. data/sig/openai/models/video_size.rbs +0 -16
  417. data/sig/openai/resources/beta/assistants.rbs +0 -58
  418. data/sig/openai/resources/beta/threads/messages.rbs +0 -49
  419. data/sig/openai/resources/beta/threads/runs/steps.rbs +0 -32
  420. data/sig/openai/resources/beta/threads/runs.rbs +0 -99
  421. data/sig/openai/resources/beta/threads.rbs +0 -75
  422. data/sig/openai/resources/videos.rbs +0 -69
@@ -1,485 +0,0 @@
1
- module OpenAI
2
- module Models
3
- module Beta
4
- type assistant_create_params =
5
- {
6
- model: OpenAI::Models::Beta::AssistantCreateParams::model,
7
- ?description: String?,
8
- ?instructions: String?,
9
- ?metadata: OpenAI::Models::metadata?,
10
- ?name: String?,
11
- ?reasoning_effort: OpenAI::Models::reasoning_effort?,
12
- ?response_format: OpenAI::Models::Beta::assistant_response_format_option?,
13
- ?temperature: Float?,
14
- ?tool_resources: OpenAI::Beta::AssistantCreateParams::ToolResources?,
15
- ?tools: ::Array[OpenAI::Models::Beta::assistant_tool],
16
- ?top_p: Float?,
17
- ?request_options: OpenAI::request_opts
18
- }
19
-
20
- class AssistantCreateParams < OpenAI::Internal::Type::BaseModel
21
- extend OpenAI::Internal::Type::RequestParameters::Converter
22
- include OpenAI::Internal::Type::RequestParameters
23
-
24
- # ID of the model to use. You can use the
25
- # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
26
- # API to see all of your available models, or see our
27
- # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
28
- # of them.
29
- attr_accessor model: OpenAI::Models::Beta::AssistantCreateParams::model
30
-
31
- # The description of the assistant. The maximum length is 512 characters.
32
- attr_accessor description: String?
33
-
34
- # The system instructions that the assistant uses. The maximum length is 256,000
35
- # characters.
36
- attr_accessor instructions: String?
37
-
38
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
39
- # for storing additional information about the object in a structured format, and
40
- # querying for objects via API or the dashboard.
41
- #
42
- # Keys are strings with a maximum length of 64 characters. Values are strings with
43
- # a maximum length of 512 characters.
44
- attr_accessor metadata: OpenAI::Models::metadata?
45
-
46
- # The name of the assistant. The maximum length is 256 characters.
47
- attr_accessor name: String?
48
-
49
- # Constrains effort on reasoning for reasoning models. Currently supported values
50
- # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
51
- # reasoning effort can result in faster responses and fewer tokens used on
52
- # reasoning in a response. Not all reasoning models support every value. See the
53
- # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
54
- # model-specific support.
55
- attr_accessor reasoning_effort: OpenAI::Models::reasoning_effort?
56
-
57
- # Specifies the format that the model must output. Compatible with
58
- # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
59
- # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
60
- # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
61
- #
62
- # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
63
- # Outputs which ensures the model will match your supplied JSON schema. Learn more
64
- # in the
65
- # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
66
- #
67
- # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
68
- # message the model generates is valid JSON.
69
- #
70
- # **Important:** when using JSON mode, you **must** also instruct the model to
71
- # produce JSON yourself via a system or user message. Without this, the model may
72
- # generate an unending stream of whitespace until the generation reaches the token
73
- # limit, resulting in a long-running and seemingly "stuck" request. Also note that
74
- # the message content may be partially cut off if `finish_reason="length"`, which
75
- # indicates the generation exceeded `max_tokens` or the conversation exceeded the
76
- # max context length.
77
- attr_accessor response_format: OpenAI::Models::Beta::assistant_response_format_option?
78
-
79
- # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
80
- # make the output more random, while lower values like 0.2 will make it more
81
- # focused and deterministic.
82
- attr_accessor temperature: Float?
83
-
84
- # A set of resources that are used by the assistant's tools. The resources are
85
- # specific to the type of tool. For example, the `code_interpreter` tool requires
86
- # a list of file IDs, while the `file_search` tool requires a list of vector store
87
- # IDs.
88
- attr_accessor tool_resources: OpenAI::Beta::AssistantCreateParams::ToolResources?
89
-
90
- # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
91
- # assistant. Tools can be of types `code_interpreter`, `file_search`, or
92
- # `function`.
93
- attr_reader tools: ::Array[OpenAI::Models::Beta::assistant_tool]?
94
-
95
- # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
96
- # assistant. Tools can be of types `code_interpreter`, `file_search`, or
97
- # `function`.
98
- def tools=: (
99
- ::Array[OpenAI::Models::Beta::assistant_tool]
100
- ) -> ::Array[OpenAI::Models::Beta::assistant_tool]
101
-
102
- # An alternative to sampling with temperature, called nucleus sampling, where the
103
- # model considers the results of the tokens with top_p probability mass. So 0.1
104
- # means only the tokens comprising the top 10% probability mass are considered.
105
- #
106
- # We generally recommend altering this or temperature but not both.
107
- attr_accessor top_p: Float?
108
-
109
- # @param model
110
- # ID of the model to use. You can use the
111
- # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
112
- # API to see all of your available models, or see our
113
- # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
114
- # of them.
115
- # @param description
116
- # The description of the assistant. The maximum length is 512 characters.
117
- # @param instructions
118
- # The system instructions that the assistant uses. The maximum length is 256,000
119
- # characters.
120
- # @param metadata
121
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
122
- # for storing additional information about the object in a structured format, and
123
- # querying for objects via API or the dashboard.
124
- #
125
- # Keys are strings with a maximum length of 64 characters. Values are strings with
126
- # a maximum length of 512 characters.
127
- # @param name
128
- # The name of the assistant. The maximum length is 256 characters.
129
- # @param reasoning_effort
130
- # Constrains effort on reasoning for reasoning models. Currently supported values
131
- # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
132
- # reasoning effort can result in faster responses and fewer tokens used on
133
- # reasoning in a response. Not all reasoning models support every value. See the
134
- # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
135
- # model-specific support.
136
- # @param response_format
137
- # Specifies the format that the model must output. Compatible with
138
- # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
139
- # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
140
- # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
141
- #
142
- # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
143
- # Outputs which ensures the model will match your supplied JSON schema. Learn more
144
- # in the
145
- # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
146
- #
147
- # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
148
- # message the model generates is valid JSON.
149
- #
150
- # **Important:** when using JSON mode, you **must** also instruct the model to
151
- # produce JSON yourself via a system or user message. Without this, the model may
152
- # generate an unending stream of whitespace until the generation reaches the token
153
- # limit, resulting in a long-running and seemingly "stuck" request. Also note that
154
- # the message content may be partially cut off if `finish_reason="length"`, which
155
- # indicates the generation exceeded `max_tokens` or the conversation exceeded the
156
- # max context length.
157
- # @param temperature
158
- # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
159
- # make the output more random, while lower values like 0.2 will make it more
160
- # focused and deterministic.
161
- # @param tool_resources
162
- # A set of resources that are used by the assistant's tools. The resources are
163
- # specific to the type of tool. For example, the `code_interpreter` tool requires
164
- # a list of file IDs, while the `file_search` tool requires a list of vector store
165
- # IDs.
166
- # @param tools
167
- # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
168
- # assistant. Tools can be of types `code_interpreter`, `file_search`, or
169
- # `function`.
170
- # @param top_p
171
- # An alternative to sampling with temperature, called nucleus sampling, where the
172
- # model considers the results of the tokens with top_p probability mass. So 0.1
173
- # means only the tokens comprising the top 10% probability mass are considered.
174
- #
175
- # We generally recommend altering this or temperature but not both.
176
- def initialize: (
177
- model: OpenAI::Models::Beta::AssistantCreateParams::model,
178
- ?description: String?,
179
- ?instructions: String?,
180
- ?metadata: OpenAI::Models::metadata?,
181
- ?name: String?,
182
- ?reasoning_effort: OpenAI::Models::reasoning_effort?,
183
- ?response_format: OpenAI::Models::Beta::assistant_response_format_option?,
184
- ?temperature: Float?,
185
- ?tool_resources: OpenAI::Beta::AssistantCreateParams::ToolResources?,
186
- ?tools: ::Array[OpenAI::Models::Beta::assistant_tool],
187
- ?top_p: Float?,
188
- ?request_options: OpenAI::request_opts
189
- ) -> void
190
-
191
- def to_hash: -> {
192
- model: OpenAI::Models::Beta::AssistantCreateParams::model,
193
- ?description: String?,
194
- ?instructions: String?,
195
- ?metadata: OpenAI::Models::metadata?,
196
- ?name: String?,
197
- ?reasoning_effort: OpenAI::Models::reasoning_effort?,
198
- ?response_format: OpenAI::Models::Beta::assistant_response_format_option?,
199
- ?temperature: Float?,
200
- ?tool_resources: OpenAI::Beta::AssistantCreateParams::ToolResources?,
201
- ?tools: ::Array[OpenAI::Models::Beta::assistant_tool],
202
- ?top_p: Float?,
203
- ?request_options: OpenAI::RequestOptions
204
- }
205
-
206
- type model = String | OpenAI::Models::chat_model
207
-
208
- module Model
209
- extend OpenAI::Internal::Type::Union
210
-
211
- def self?.variants: -> ::Array[OpenAI::Models::Beta::AssistantCreateParams::model]
212
- end
213
-
214
- type tool_resources =
215
- {
216
- ?code_interpreter: OpenAI::Beta::AssistantCreateParams::ToolResources::CodeInterpreter,
217
- ?file_search: OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch
218
- }
219
-
220
- class ToolResources < OpenAI::Internal::Type::BaseModel
221
- attr_reader code_interpreter: OpenAI::Beta::AssistantCreateParams::ToolResources::CodeInterpreter?
222
-
223
- def code_interpreter=: (
224
- OpenAI::Beta::AssistantCreateParams::ToolResources::CodeInterpreter
225
- ) -> OpenAI::Beta::AssistantCreateParams::ToolResources::CodeInterpreter
226
-
227
- attr_reader file_search: OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch?
228
-
229
- def file_search=: (
230
- OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch
231
- ) -> OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch
232
-
233
- def initialize: (
234
- ?code_interpreter: OpenAI::Beta::AssistantCreateParams::ToolResources::CodeInterpreter,
235
- ?file_search: OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch
236
- ) -> void
237
-
238
- def to_hash: -> {
239
- ?code_interpreter: OpenAI::Beta::AssistantCreateParams::ToolResources::CodeInterpreter,
240
- ?file_search: OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch
241
- }
242
-
243
- type code_interpreter = { ?file_ids: ::Array[String] }
244
-
245
- class CodeInterpreter < OpenAI::Internal::Type::BaseModel
246
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
247
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
248
- # files associated with the tool.
249
- attr_reader file_ids: ::Array[String]?
250
-
251
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
252
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
253
- # files associated with the tool.
254
- def file_ids=: (::Array[String]) -> ::Array[String]
255
-
256
- # @param file_ids
257
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
258
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
259
- # files associated with the tool.
260
- def initialize: (?file_ids: ::Array[String]) -> void
261
-
262
- def to_hash: -> { ?file_ids: ::Array[String] }
263
- end
264
-
265
- type file_search =
266
- {
267
- ?vector_store_ids: ::Array[String],
268
- ?vector_stores: ::Array[OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore]
269
- }
270
-
271
- class FileSearch < OpenAI::Internal::Type::BaseModel
272
- # The
273
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
274
- # attached to this assistant. There can be a maximum of 1 vector store attached to
275
- # the assistant.
276
- attr_reader vector_store_ids: ::Array[String]?
277
-
278
- # The
279
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
280
- # attached to this assistant. There can be a maximum of 1 vector store attached to
281
- # the assistant.
282
- def vector_store_ids=: (::Array[String]) -> ::Array[String]
283
-
284
- # A helper to create a
285
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
286
- # with file_ids and attach it to this assistant. There can be a maximum of 1
287
- # vector store attached to the assistant.
288
- attr_reader vector_stores: ::Array[OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore]?
289
-
290
- # A helper to create a
291
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
292
- # with file_ids and attach it to this assistant. There can be a maximum of 1
293
- # vector store attached to the assistant.
294
- def vector_stores=: (
295
- ::Array[OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore]
296
- ) -> ::Array[OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore]
297
-
298
- # @param vector_store_ids
299
- # The
300
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
301
- # attached to this assistant. There can be a maximum of 1 vector store attached to
302
- # the assistant.
303
- # @param vector_stores
304
- # A helper to create a
305
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
306
- # with file_ids and attach it to this assistant. There can be a maximum of 1
307
- # vector store attached to the assistant.
308
- def initialize: (
309
- ?vector_store_ids: ::Array[String],
310
- ?vector_stores: ::Array[OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore]
311
- ) -> void
312
-
313
- def to_hash: -> {
314
- ?vector_store_ids: ::Array[String],
315
- ?vector_stores: ::Array[OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore]
316
- }
317
-
318
- type vector_store =
319
- {
320
- ?chunking_strategy: OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::chunking_strategy,
321
- ?file_ids: ::Array[String],
322
- ?metadata: OpenAI::Models::metadata?
323
- }
324
-
325
- class VectorStore < OpenAI::Internal::Type::BaseModel
326
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
327
- # strategy.
328
- attr_reader chunking_strategy: OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::chunking_strategy?
329
-
330
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
331
- # strategy.
332
- def chunking_strategy=: (
333
- OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::chunking_strategy
334
- | { type: :auto }
335
- | {
336
- static: OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static,
337
- type: :static
338
- }
339
- ) -> (OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::chunking_strategy
340
- | { type: :auto }
341
- | {
342
- static: OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static,
343
- type: :static
344
- })
345
-
346
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
347
- # IDs to add to the vector store. For vector stores created before Nov 2025, there
348
- # can be a maximum of 10,000 files in a vector store. For vector stores created
349
- # starting in Nov 2025, the limit is 100,000,000 files.
350
- attr_reader file_ids: ::Array[String]?
351
-
352
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
353
- # IDs to add to the vector store. For vector stores created before Nov 2025, there
354
- # can be a maximum of 10,000 files in a vector store. For vector stores created
355
- # starting in Nov 2025, the limit is 100,000,000 files.
356
- def file_ids=: (::Array[String]) -> ::Array[String]
357
-
358
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
359
- # for storing additional information about the object in a structured format, and
360
- # querying for objects via API or the dashboard.
361
- #
362
- # Keys are strings with a maximum length of 64 characters. Values are strings with
363
- # a maximum length of 512 characters.
364
- attr_accessor metadata: OpenAI::Models::metadata?
365
-
366
- # @param chunking_strategy
367
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
368
- # strategy.
369
- # @param file_ids
370
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
371
- # IDs to add to the vector store. For vector stores created before Nov 2025, there
372
- # can be a maximum of 10,000 files in a vector store. For vector stores created
373
- # starting in Nov 2025, the limit is 100,000,000 files.
374
- # @param metadata
375
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
376
- # for storing additional information about the object in a structured format, and
377
- # querying for objects via API or the dashboard.
378
- #
379
- # Keys are strings with a maximum length of 64 characters. Values are strings with
380
- # a maximum length of 512 characters.
381
- def initialize: (
382
- ?chunking_strategy: OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::chunking_strategy
383
- | { type: :auto }
384
- | {
385
- static: OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static,
386
- type: :static
387
- },
388
- ?file_ids: ::Array[String],
389
- ?metadata: OpenAI::Models::metadata?
390
- ) -> void
391
-
392
- def to_hash: -> {
393
- ?chunking_strategy: OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::chunking_strategy,
394
- ?file_ids: ::Array[String],
395
- ?metadata: OpenAI::Models::metadata?
396
- }
397
-
398
- type chunking_strategy =
399
- OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto
400
- | OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static
401
-
402
- module ChunkingStrategy
403
- extend OpenAI::Internal::Type::Union
404
-
405
- type auto = { ?type: :auto }
406
-
407
- class Auto < OpenAI::Internal::Type::BaseModel
408
- # Always `auto`.
409
- attr_accessor type: :auto
410
-
411
- # @param type
412
- # Always `auto`.
413
- def initialize: (?type: :auto) -> void
414
-
415
- def to_hash: -> { ?type: :auto }
416
- end
417
-
418
- type static =
419
- {
420
- static: OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static,
421
- ?type: :static
422
- }
423
-
424
- class Static < OpenAI::Internal::Type::BaseModel
425
- attr_accessor static: OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static
426
-
427
- # Always `static`.
428
- attr_accessor type: :static
429
-
430
- # @param type
431
- # Always `static`.
432
- def initialize: (
433
- static: OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static,
434
- ?type: :static
435
- ) -> void
436
-
437
- def to_hash: -> {
438
- static: OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static,
439
- ?type: :static
440
- }
441
-
442
- type static =
443
- {
444
- chunk_overlap_tokens: Integer,
445
- max_chunk_size_tokens: Integer
446
- }
447
-
448
- class Static < OpenAI::Internal::Type::BaseModel
449
- # The number of tokens that overlap between chunks. The default value is `400`.
450
- #
451
- # Note that the overlap must not exceed half of `max_chunk_size_tokens`.
452
- attr_accessor chunk_overlap_tokens: Integer
453
-
454
- # The maximum number of tokens in each chunk. The default value is `800`. The
455
- # minimum value is `100` and the maximum value is `4096`.
456
- attr_accessor max_chunk_size_tokens: Integer
457
-
458
- # @param chunk_overlap_tokens
459
- # The number of tokens that overlap between chunks. The default value is `400`.
460
- #
461
- # Note that the overlap must not exceed half of `max_chunk_size_tokens`.
462
- # @param max_chunk_size_tokens
463
- # The maximum number of tokens in each chunk. The default value is `800`. The
464
- # minimum value is `100` and the maximum value is `4096`.
465
- def initialize: (
466
- chunk_overlap_tokens: Integer,
467
- max_chunk_size_tokens: Integer
468
- ) -> void
469
-
470
- def to_hash: -> {
471
- chunk_overlap_tokens: Integer,
472
- max_chunk_size_tokens: Integer
473
- }
474
- end
475
- end
476
-
477
- def self?.variants: -> ::Array[OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::chunking_strategy]
478
- end
479
- end
480
- end
481
- end
482
- end
483
- end
484
- end
485
- end
@@ -1,25 +0,0 @@
1
- module OpenAI
2
- module Models
3
- module Beta
4
- type assistant_delete_params =
5
- { assistant_id: String, ?request_options: OpenAI::request_opts }
6
-
7
- class AssistantDeleteParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- attr_accessor assistant_id: String
12
-
13
- def initialize: (
14
- assistant_id: String,
15
- ?request_options: OpenAI::request_opts
16
- ) -> void
17
-
18
- def to_hash: -> {
19
- assistant_id: String,
20
- ?request_options: OpenAI::RequestOptions
21
- }
22
- end
23
- end
24
- end
25
- end
@@ -1,28 +0,0 @@
1
- module OpenAI
2
- module Models
3
- module Beta
4
- type assistant_deleted =
5
- { id: String, deleted: bool, ?object: :"assistant.deleted" }
6
-
7
- class AssistantDeleted < OpenAI::Internal::Type::BaseModel
8
- attr_accessor id: String
9
-
10
- attr_accessor deleted: bool
11
-
12
- attr_accessor object: :"assistant.deleted"
13
-
14
- def initialize: (
15
- id: String,
16
- deleted: bool,
17
- ?object: :"assistant.deleted"
18
- ) -> void
19
-
20
- def to_hash: -> {
21
- id: String,
22
- deleted: bool,
23
- ?object: :"assistant.deleted"
24
- }
25
- end
26
- end
27
- end
28
- end
@@ -1,104 +0,0 @@
1
- module OpenAI
2
- module Models
3
- module Beta
4
- type assistant_list_params =
5
- {
6
- ?after: String,
7
- ?before: String,
8
- ?limit: Integer,
9
- ?order: OpenAI::Models::Beta::AssistantListParams::order,
10
- ?request_options: OpenAI::request_opts
11
- }
12
-
13
- class AssistantListParams < OpenAI::Internal::Type::BaseModel
14
- extend OpenAI::Internal::Type::RequestParameters::Converter
15
- include OpenAI::Internal::Type::RequestParameters
16
-
17
- # A cursor for use in pagination. `after` is an object ID that defines your place
18
- # in the list. For instance, if you make a list request and receive 100 objects,
19
- # ending with obj_foo, your subsequent call can include after=obj_foo in order to
20
- # fetch the next page of the list.
21
- attr_reader after: String?
22
-
23
- # A cursor for use in pagination. `after` is an object ID that defines your place
24
- # in the list. For instance, if you make a list request and receive 100 objects,
25
- # ending with obj_foo, your subsequent call can include after=obj_foo in order to
26
- # fetch the next page of the list.
27
- def after=: (String) -> String
28
-
29
- # A cursor for use in pagination. `before` is an object ID that defines your place
30
- # in the list. For instance, if you make a list request and receive 100 objects,
31
- # starting with obj_foo, your subsequent call can include before=obj_foo in order
32
- # to fetch the previous page of the list.
33
- attr_reader before: String?
34
-
35
- # A cursor for use in pagination. `before` is an object ID that defines your place
36
- # in the list. For instance, if you make a list request and receive 100 objects,
37
- # starting with obj_foo, your subsequent call can include before=obj_foo in order
38
- # to fetch the previous page of the list.
39
- def before=: (String) -> String
40
-
41
- # A limit on the number of objects to be returned. Limit can range between 1 and
42
- # 100, and the default is 20.
43
- attr_reader limit: Integer?
44
-
45
- # A limit on the number of objects to be returned. Limit can range between 1 and
46
- # 100, and the default is 20.
47
- def limit=: (Integer) -> Integer
48
-
49
- # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
50
- # order and `desc` for descending order.
51
- attr_reader order: OpenAI::Models::Beta::AssistantListParams::order?
52
-
53
- # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
54
- # order and `desc` for descending order.
55
- def order=: (
56
- OpenAI::Models::Beta::AssistantListParams::order
57
- ) -> OpenAI::Models::Beta::AssistantListParams::order
58
-
59
- # @param after
60
- # A cursor for use in pagination. `after` is an object ID that defines your place
61
- # in the list. For instance, if you make a list request and receive 100 objects,
62
- # ending with obj_foo, your subsequent call can include after=obj_foo in order to
63
- # fetch the next page of the list.
64
- # @param before
65
- # A cursor for use in pagination. `before` is an object ID that defines your place
66
- # in the list. For instance, if you make a list request and receive 100 objects,
67
- # starting with obj_foo, your subsequent call can include before=obj_foo in order
68
- # to fetch the previous page of the list.
69
- # @param limit
70
- # A limit on the number of objects to be returned. Limit can range between 1 and
71
- # 100, and the default is 20.
72
- # @param order
73
- # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
74
- # order and `desc` for descending order.
75
- def initialize: (
76
- ?after: String,
77
- ?before: String,
78
- ?limit: Integer,
79
- ?order: OpenAI::Models::Beta::AssistantListParams::order,
80
- ?request_options: OpenAI::request_opts
81
- ) -> void
82
-
83
- def to_hash: -> {
84
- ?after: String,
85
- ?before: String,
86
- ?limit: Integer,
87
- ?order: OpenAI::Models::Beta::AssistantListParams::order,
88
- ?request_options: OpenAI::RequestOptions
89
- }
90
-
91
- type order = :asc | :desc
92
-
93
- module Order
94
- extend OpenAI::Internal::Type::Enum
95
-
96
- ASC: :asc
97
- DESC: :desc
98
-
99
- def self?.values: -> ::Array[OpenAI::Models::Beta::AssistantListParams::order]
100
- end
101
- end
102
- end
103
- end
104
- end
@@ -1,17 +0,0 @@
1
- module OpenAI
2
- module Models
3
- module Beta
4
- type assistant_response_format_option =
5
- :auto
6
- | OpenAI::ResponseFormatText
7
- | OpenAI::ResponseFormatJSONObject
8
- | OpenAI::ResponseFormatJSONSchema
9
-
10
- module AssistantResponseFormatOption
11
- extend OpenAI::Internal::Type::Union
12
-
13
- def self?.variants: -> ::Array[OpenAI::Models::Beta::assistant_response_format_option]
14
- end
15
- end
16
- end
17
- end