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,448 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- # @see OpenAI::Resources::Beta::Assistants#create
7
- class AssistantCreateParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- # @!attribute model
12
- # ID of the model to use. You can use the
13
- # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
14
- # API to see all of your available models, or see our
15
- # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
16
- # of them.
17
- #
18
- # @return [String, Symbol, OpenAI::Models::ChatModel]
19
- required :model, union: -> { OpenAI::Beta::AssistantCreateParams::Model }
20
-
21
- # @!attribute description
22
- # The description of the assistant. The maximum length is 512 characters.
23
- #
24
- # @return [String, nil]
25
- optional :description, String, nil?: true
26
-
27
- # @!attribute instructions
28
- # The system instructions that the assistant uses. The maximum length is 256,000
29
- # characters.
30
- #
31
- # @return [String, nil]
32
- optional :instructions, String, nil?: true
33
-
34
- # @!attribute metadata
35
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
36
- # for storing additional information about the object in a structured format, and
37
- # querying for objects via API or the dashboard.
38
- #
39
- # Keys are strings with a maximum length of 64 characters. Values are strings with
40
- # a maximum length of 512 characters.
41
- #
42
- # @return [Hash{Symbol=>String}, nil]
43
- optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
44
-
45
- # @!attribute name
46
- # The name of the assistant. The maximum length is 256 characters.
47
- #
48
- # @return [String, nil]
49
- optional :name, String, nil?: true
50
-
51
- # @!attribute reasoning_effort
52
- # Constrains effort on reasoning for reasoning models. Currently supported values
53
- # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
54
- # reasoning effort can result in faster responses and fewer tokens used on
55
- # reasoning in a response. Not all reasoning models support every value. See the
56
- # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
57
- # model-specific support.
58
- #
59
- # @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
60
- optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
61
-
62
- # @!attribute response_format
63
- # Specifies the format that the model must output. Compatible with
64
- # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
65
- # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
66
- # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
67
- #
68
- # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
69
- # Outputs which ensures the model will match your supplied JSON schema. Learn more
70
- # in the
71
- # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
72
- #
73
- # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
74
- # message the model generates is valid JSON.
75
- #
76
- # **Important:** when using JSON mode, you **must** also instruct the model to
77
- # produce JSON yourself via a system or user message. Without this, the model may
78
- # generate an unending stream of whitespace until the generation reaches the token
79
- # limit, resulting in a long-running and seemingly "stuck" request. Also note that
80
- # the message content may be partially cut off if `finish_reason="length"`, which
81
- # indicates the generation exceeded `max_tokens` or the conversation exceeded the
82
- # max context length.
83
- #
84
- # @return [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil]
85
- optional :response_format, union: -> { OpenAI::Beta::AssistantResponseFormatOption }, nil?: true
86
-
87
- # @!attribute temperature
88
- # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
89
- # make the output more random, while lower values like 0.2 will make it more
90
- # focused and deterministic.
91
- #
92
- # @return [Float, nil]
93
- optional :temperature, Float, nil?: true
94
-
95
- # @!attribute tool_resources
96
- # A set of resources that are used by the assistant's tools. The resources are
97
- # specific to the type of tool. For example, the `code_interpreter` tool requires
98
- # a list of file IDs, while the `file_search` tool requires a list of vector store
99
- # IDs.
100
- #
101
- # @return [OpenAI::Models::Beta::AssistantCreateParams::ToolResources, nil]
102
- optional :tool_resources, -> { OpenAI::Beta::AssistantCreateParams::ToolResources }, nil?: true
103
-
104
- # @!attribute tools
105
- # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
106
- # assistant. Tools can be of types `code_interpreter`, `file_search`, or
107
- # `function`.
108
- #
109
- # @return [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool>, nil]
110
- optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AssistantTool] }
111
-
112
- # @!attribute top_p
113
- # An alternative to sampling with temperature, called nucleus sampling, where the
114
- # model considers the results of the tokens with top_p probability mass. So 0.1
115
- # means only the tokens comprising the top 10% probability mass are considered.
116
- #
117
- # We generally recommend altering this or temperature but not both.
118
- #
119
- # @return [Float, nil]
120
- optional :top_p, Float, nil?: true
121
-
122
- # @!method initialize(model:, description: nil, instructions: nil, metadata: nil, name: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_resources: nil, tools: nil, top_p: nil, request_options: {})
123
- # @param model [String, Symbol, OpenAI::Models::ChatModel]
124
- # ID of the model to use. You can use the
125
- # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
126
- # API to see all of your available models, or see our
127
- # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
128
- # of them.
129
- #
130
- # @param description [String, nil]
131
- # The description of the assistant. The maximum length is 512 characters.
132
- #
133
- # @param instructions [String, nil]
134
- # The system instructions that the assistant uses. The maximum length is 256,000
135
- # characters.
136
- #
137
- # @param metadata [Hash{Symbol=>String}, nil]
138
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
139
- # for storing additional information about the object in a structured format, and
140
- # querying for objects via API or the dashboard.
141
- #
142
- # Keys are strings with a maximum length of 64 characters. Values are strings with
143
- # a maximum length of 512 characters.
144
- #
145
- # @param name [String, nil]
146
- # The name of the assistant. The maximum length is 256 characters.
147
- #
148
- # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil]
149
- # Constrains effort on reasoning for reasoning models. Currently supported values
150
- # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
151
- # reasoning effort can result in faster responses and fewer tokens used on
152
- # reasoning in a response. Not all reasoning models support every value. See the
153
- # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
154
- # model-specific support.
155
- #
156
- # @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil]
157
- # Specifies the format that the model must output. Compatible with
158
- # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
159
- # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
160
- # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
161
- #
162
- # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
163
- # Outputs which ensures the model will match your supplied JSON schema. Learn more
164
- # in the
165
- # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
166
- #
167
- # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
168
- # message the model generates is valid JSON.
169
- #
170
- # **Important:** when using JSON mode, you **must** also instruct the model to
171
- # produce JSON yourself via a system or user message. Without this, the model may
172
- # generate an unending stream of whitespace until the generation reaches the token
173
- # limit, resulting in a long-running and seemingly "stuck" request. Also note that
174
- # the message content may be partially cut off if `finish_reason="length"`, which
175
- # indicates the generation exceeded `max_tokens` or the conversation exceeded the
176
- # max context length.
177
- #
178
- # @param temperature [Float, nil]
179
- # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
180
- # make the output more random, while lower values like 0.2 will make it more
181
- # focused and deterministic.
182
- #
183
- # @param tool_resources [OpenAI::Models::Beta::AssistantCreateParams::ToolResources, nil]
184
- # A set of resources that are used by the assistant's tools. The resources are
185
- # specific to the type of tool. For example, the `code_interpreter` tool requires
186
- # a list of file IDs, while the `file_search` tool requires a list of vector store
187
- # IDs.
188
- #
189
- # @param tools [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool>]
190
- # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
191
- # assistant. Tools can be of types `code_interpreter`, `file_search`, or
192
- # `function`.
193
- #
194
- # @param top_p [Float, nil]
195
- # An alternative to sampling with temperature, called nucleus sampling, where the
196
- # model considers the results of the tokens with top_p probability mass. So 0.1
197
- # means only the tokens comprising the top 10% probability mass are considered.
198
- #
199
- # We generally recommend altering this or temperature but not both.
200
- #
201
- # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
202
-
203
- # ID of the model to use. You can use the
204
- # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
205
- # API to see all of your available models, or see our
206
- # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
207
- # of them.
208
- module Model
209
- extend OpenAI::Internal::Type::Union
210
-
211
- variant String
212
-
213
- # ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them.
214
- variant enum: -> { OpenAI::ChatModel }
215
-
216
- # @!method self.variants
217
- # @return [Array(String, Symbol, OpenAI::Models::ChatModel)]
218
- end
219
-
220
- class ToolResources < OpenAI::Internal::Type::BaseModel
221
- # @!attribute code_interpreter
222
- #
223
- # @return [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::CodeInterpreter, nil]
224
- optional :code_interpreter, -> { OpenAI::Beta::AssistantCreateParams::ToolResources::CodeInterpreter }
225
-
226
- # @!attribute file_search
227
- #
228
- # @return [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch, nil]
229
- optional :file_search, -> { OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch }
230
-
231
- # @!method initialize(code_interpreter: nil, file_search: nil)
232
- # A set of resources that are used by the assistant's tools. The resources are
233
- # specific to the type of tool. For example, the `code_interpreter` tool requires
234
- # a list of file IDs, while the `file_search` tool requires a list of vector store
235
- # IDs.
236
- #
237
- # @param code_interpreter [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::CodeInterpreter]
238
- # @param file_search [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch]
239
-
240
- # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources#code_interpreter
241
- class CodeInterpreter < OpenAI::Internal::Type::BaseModel
242
- # @!attribute file_ids
243
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
244
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
245
- # files associated with the tool.
246
- #
247
- # @return [Array<String>, nil]
248
- optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
249
-
250
- # @!method initialize(file_ids: nil)
251
- # @param file_ids [Array<String>]
252
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
253
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
254
- # files associated with the tool.
255
- end
256
-
257
- # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources#file_search
258
- class FileSearch < OpenAI::Internal::Type::BaseModel
259
- # @!attribute vector_store_ids
260
- # The
261
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
262
- # attached to this assistant. There can be a maximum of 1 vector store attached to
263
- # the assistant.
264
- #
265
- # @return [Array<String>, nil]
266
- optional :vector_store_ids, OpenAI::Internal::Type::ArrayOf[String]
267
-
268
- # @!attribute vector_stores
269
- # A helper to create a
270
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
271
- # with file_ids and attach it to this assistant. There can be a maximum of 1
272
- # vector store attached to the assistant.
273
- #
274
- # @return [Array<OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore>, nil]
275
- optional(
276
- :vector_stores,
277
- -> {
278
- OpenAI::Internal::Type::ArrayOf[
279
- OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore
280
- ]
281
- }
282
- )
283
-
284
- # @!method initialize(vector_store_ids: nil, vector_stores: nil)
285
- # @param vector_store_ids [Array<String>]
286
- # The
287
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
288
- # attached to this assistant. There can be a maximum of 1 vector store attached to
289
- # the assistant.
290
- #
291
- # @param vector_stores [Array<OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore>]
292
- # A helper to create a
293
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
294
- # with file_ids and attach it to this assistant. There can be a maximum of 1
295
- # vector store attached to the assistant.
296
- class VectorStore < OpenAI::Internal::Type::BaseModel
297
- # @!attribute chunking_strategy
298
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
299
- # strategy.
300
- #
301
- # @return [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static, nil]
302
- optional(
303
- :chunking_strategy,
304
- union: -> {
305
- OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy
306
- }
307
- )
308
-
309
- # @!attribute file_ids
310
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
311
- # IDs to add to the vector store. For vector stores created before Nov 2025, there
312
- # can be a maximum of 10,000 files in a vector store. For vector stores created
313
- # starting in Nov 2025, the limit is 100,000,000 files.
314
- #
315
- # @return [Array<String>, nil]
316
- optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
317
-
318
- # @!attribute metadata
319
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
320
- # for storing additional information about the object in a structured format, and
321
- # querying for objects via API or the dashboard.
322
- #
323
- # Keys are strings with a maximum length of 64 characters. Values are strings with
324
- # a maximum length of 512 characters.
325
- #
326
- # @return [Hash{Symbol=>String}, nil]
327
- optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
328
-
329
- # @!method initialize(chunking_strategy: nil, file_ids: nil, metadata: nil)
330
- # @param chunking_strategy [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static]
331
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
332
- # strategy.
333
- #
334
- # @param file_ids [Array<String>]
335
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
336
- # IDs to add to the vector store. For vector stores created before Nov 2025, there
337
- # can be a maximum of 10,000 files in a vector store. For vector stores created
338
- # starting in Nov 2025, the limit is 100,000,000 files.
339
- #
340
- # @param metadata [Hash{Symbol=>String}, nil]
341
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
342
- # for storing additional information about the object in a structured format, and
343
- # querying for objects via API or the dashboard.
344
- #
345
- # Keys are strings with a maximum length of 64 characters. Values are strings with
346
- # a maximum length of 512 characters.
347
-
348
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
349
- # strategy.
350
- #
351
- # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore#chunking_strategy
352
- module ChunkingStrategy
353
- extend OpenAI::Internal::Type::Union
354
-
355
- discriminator :type
356
-
357
- # The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.
358
- variant(
359
- :auto,
360
- -> {
361
- OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto
362
- }
363
- )
364
-
365
- variant(
366
- :static,
367
- -> {
368
- OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static
369
- }
370
- )
371
-
372
- class Auto < OpenAI::Internal::Type::BaseModel
373
- # @!attribute type
374
- # Always `auto`.
375
- #
376
- # @return [Symbol, :auto]
377
- required :type, const: :auto
378
-
379
- # @!method initialize(type: :auto)
380
- # The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
381
- # `800` and `chunk_overlap_tokens` of `400`.
382
- #
383
- # @param type [Symbol, :auto]
384
- # Always `auto`.
385
- end
386
-
387
- class Static < OpenAI::Internal::Type::BaseModel
388
- # @!attribute static
389
- #
390
- # @return [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static]
391
- required(
392
- :static,
393
- -> {
394
- OpenAI::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static
395
- }
396
- )
397
-
398
- # @!attribute type
399
- # Always `static`.
400
- #
401
- # @return [Symbol, :static]
402
- required :type, const: :static
403
-
404
- # @!method initialize(static:, type: :static)
405
- # @param static [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static]
406
- #
407
- # @param type [Symbol, :static]
408
- # Always `static`.
409
-
410
- # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static#static
411
- class Static < OpenAI::Internal::Type::BaseModel
412
- # @!attribute chunk_overlap_tokens
413
- # The number of tokens that overlap between chunks. The default value is `400`.
414
- #
415
- # Note that the overlap must not exceed half of `max_chunk_size_tokens`.
416
- #
417
- # @return [Integer]
418
- required :chunk_overlap_tokens, Integer
419
-
420
- # @!attribute max_chunk_size_tokens
421
- # The maximum number of tokens in each chunk. The default value is `800`. The
422
- # minimum value is `100` and the maximum value is `4096`.
423
- #
424
- # @return [Integer]
425
- required :max_chunk_size_tokens, Integer
426
-
427
- # @!method initialize(chunk_overlap_tokens:, max_chunk_size_tokens:)
428
- # @param chunk_overlap_tokens [Integer]
429
- # The number of tokens that overlap between chunks. The default value is `400`.
430
- #
431
- # Note that the overlap must not exceed half of `max_chunk_size_tokens`.
432
- #
433
- # @param max_chunk_size_tokens [Integer]
434
- # The maximum number of tokens in each chunk. The default value is `800`. The
435
- # minimum value is `100` and the maximum value is `4096`.
436
- end
437
- end
438
-
439
- # @!method self.variants
440
- # @return [Array(OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static)]
441
- end
442
- end
443
- end
444
- end
445
- end
446
- end
447
- end
448
- end
@@ -1,22 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- # @see OpenAI::Resources::Beta::Assistants#delete
7
- class AssistantDeleteParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- # @!attribute assistant_id
12
- #
13
- # @return [String]
14
- required :assistant_id, String
15
-
16
- # @!method initialize(assistant_id:, request_options: {})
17
- # @param assistant_id [String]
18
- # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
- end
20
- end
21
- end
22
- end
@@ -1,30 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- # @see OpenAI::Resources::Beta::Assistants#delete
7
- class AssistantDeleted < OpenAI::Internal::Type::BaseModel
8
- # @!attribute id
9
- #
10
- # @return [String]
11
- required :id, String
12
-
13
- # @!attribute deleted
14
- #
15
- # @return [Boolean]
16
- required :deleted, OpenAI::Internal::Type::Boolean
17
-
18
- # @!attribute object
19
- #
20
- # @return [Symbol, :"assistant.deleted"]
21
- required :object, const: :"assistant.deleted"
22
-
23
- # @!method initialize(id:, deleted:, object: :"assistant.deleted")
24
- # @param id [String]
25
- # @param deleted [Boolean]
26
- # @param object [Symbol, :"assistant.deleted"]
27
- end
28
- end
29
- end
30
- end
@@ -1,80 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- # @see OpenAI::Resources::Beta::Assistants#list
7
- class AssistantListParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- # @!attribute after
12
- # A cursor for use in pagination. `after` is an object ID that defines your place
13
- # in the list. For instance, if you make a list request and receive 100 objects,
14
- # ending with obj_foo, your subsequent call can include after=obj_foo in order to
15
- # fetch the next page of the list.
16
- #
17
- # @return [String, nil]
18
- optional :after, String
19
-
20
- # @!attribute before
21
- # A cursor for use in pagination. `before` is an object ID that defines your place
22
- # in the list. For instance, if you make a list request and receive 100 objects,
23
- # starting with obj_foo, your subsequent call can include before=obj_foo in order
24
- # to fetch the previous page of the list.
25
- #
26
- # @return [String, nil]
27
- optional :before, String
28
-
29
- # @!attribute limit
30
- # A limit on the number of objects to be returned. Limit can range between 1 and
31
- # 100, and the default is 20.
32
- #
33
- # @return [Integer, nil]
34
- optional :limit, Integer
35
-
36
- # @!attribute order
37
- # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
38
- # order and `desc` for descending order.
39
- #
40
- # @return [Symbol, OpenAI::Models::Beta::AssistantListParams::Order, nil]
41
- optional :order, enum: -> { OpenAI::Beta::AssistantListParams::Order }
42
-
43
- # @!method initialize(after: nil, before: nil, limit: nil, order: nil, request_options: {})
44
- # @param after [String]
45
- # A cursor for use in pagination. `after` is an object ID that defines your place
46
- # in the list. For instance, if you make a list request and receive 100 objects,
47
- # ending with obj_foo, your subsequent call can include after=obj_foo in order to
48
- # fetch the next page of the list.
49
- #
50
- # @param before [String]
51
- # A cursor for use in pagination. `before` is an object ID that defines your place
52
- # in the list. For instance, if you make a list request and receive 100 objects,
53
- # starting with obj_foo, your subsequent call can include before=obj_foo in order
54
- # to fetch the previous page of the list.
55
- #
56
- # @param limit [Integer]
57
- # A limit on the number of objects to be returned. Limit can range between 1 and
58
- # 100, and the default is 20.
59
- #
60
- # @param order [Symbol, OpenAI::Models::Beta::AssistantListParams::Order]
61
- # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
62
- # order and `desc` for descending order.
63
- #
64
- # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
65
-
66
- # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
67
- # order and `desc` for descending order.
68
- module Order
69
- extend OpenAI::Internal::Type::Enum
70
-
71
- ASC = :asc
72
- DESC = :desc
73
-
74
- # @!method self.values
75
- # @return [Array<Symbol>]
76
- end
77
- end
78
- end
79
- end
80
- end
@@ -1,50 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- # Specifies the format that the model must output. Compatible with
7
- # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
8
- # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
9
- # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
10
- #
11
- # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
12
- # Outputs which ensures the model will match your supplied JSON schema. Learn more
13
- # in the
14
- # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
15
- #
16
- # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
17
- # message the model generates is valid JSON.
18
- #
19
- # **Important:** when using JSON mode, you **must** also instruct the model to
20
- # produce JSON yourself via a system or user message. Without this, the model may
21
- # generate an unending stream of whitespace until the generation reaches the token
22
- # limit, resulting in a long-running and seemingly "stuck" request. Also note that
23
- # the message content may be partially cut off if `finish_reason="length"`, which
24
- # indicates the generation exceeded `max_tokens` or the conversation exceeded the
25
- # max context length.
26
- module AssistantResponseFormatOption
27
- extend OpenAI::Internal::Type::Union
28
-
29
- # `auto` is the default value
30
- variant const: :auto
31
-
32
- # Default response format. Used to generate text responses.
33
- variant -> { OpenAI::ResponseFormatText }
34
-
35
- # JSON object response format. An older method of generating JSON responses.
36
- # Using `json_schema` is recommended for models that support it. Note that the
37
- # model will not generate JSON without a system or user message instructing it
38
- # to do so.
39
- variant -> { OpenAI::ResponseFormatJSONObject }
40
-
41
- # JSON Schema response format. Used to generate structured JSON responses.
42
- # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
43
- variant -> { OpenAI::ResponseFormatJSONSchema }
44
-
45
- # @!method self.variants
46
- # @return [Array(Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema)]
47
- end
48
- end
49
- end
50
- end
@@ -1,22 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- # @see OpenAI::Resources::Beta::Assistants#retrieve
7
- class AssistantRetrieveParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- # @!attribute assistant_id
12
- #
13
- # @return [String]
14
- required :assistant_id, String
15
-
16
- # @!method initialize(assistant_id:, request_options: {})
17
- # @param assistant_id [String]
18
- # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
- end
20
- end
21
- end
22
- end