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,443 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- # @see OpenAI::Resources::Beta::Threads#create
7
- class ThreadCreateParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- # @!attribute messages
12
- # A list of
13
- # [messages](https://developers.openai.com/api/docs/assistants/migration) to start
14
- # the thread with.
15
- #
16
- # @return [Array<OpenAI::Models::Beta::ThreadCreateParams::Message>, nil]
17
- optional :messages, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::ThreadCreateParams::Message] }
18
-
19
- # @!attribute metadata
20
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
21
- # for storing additional information about the object in a structured format, and
22
- # querying for objects via API or the dashboard.
23
- #
24
- # Keys are strings with a maximum length of 64 characters. Values are strings with
25
- # a maximum length of 512 characters.
26
- #
27
- # @return [Hash{Symbol=>String}, nil]
28
- optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
29
-
30
- # @!attribute tool_resources
31
- # A set of resources that are made available to the assistant's tools in this
32
- # thread. The resources are specific to the type of tool. For example, the
33
- # `code_interpreter` tool requires a list of file IDs, while the `file_search`
34
- # tool requires a list of vector store IDs.
35
- #
36
- # @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources, nil]
37
- optional :tool_resources, -> { OpenAI::Beta::ThreadCreateParams::ToolResources }, nil?: true
38
-
39
- # @!method initialize(messages: nil, metadata: nil, tool_resources: nil, request_options: {})
40
- # @param messages [Array<OpenAI::Models::Beta::ThreadCreateParams::Message>]
41
- # A list of
42
- # [messages](https://developers.openai.com/api/docs/assistants/migration) to start
43
- # the thread with.
44
- #
45
- # @param metadata [Hash{Symbol=>String}, nil]
46
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
47
- # for storing additional information about the object in a structured format, and
48
- # querying for objects via API or the dashboard.
49
- #
50
- # Keys are strings with a maximum length of 64 characters. Values are strings with
51
- # a maximum length of 512 characters.
52
- #
53
- # @param tool_resources [OpenAI::Models::Beta::ThreadCreateParams::ToolResources, nil]
54
- # A set of resources that are made available to the assistant's tools in this
55
- # thread. The resources are specific to the type of tool. For example, the
56
- # `code_interpreter` tool requires a list of file IDs, while the `file_search`
57
- # tool requires a list of vector store IDs.
58
- #
59
- # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
60
-
61
- class Message < OpenAI::Internal::Type::BaseModel
62
- # @!attribute content
63
- # The text contents of the message.
64
- #
65
- # @return [String, Array<OpenAI::Models::Beta::Threads::ImageFileContentBlock, OpenAI::Models::Beta::Threads::ImageURLContentBlock, OpenAI::Models::Beta::Threads::TextContentBlockParam>]
66
- required :content, union: -> { OpenAI::Beta::ThreadCreateParams::Message::Content }
67
-
68
- # @!attribute role
69
- # The role of the entity that is creating the message. Allowed values include:
70
- #
71
- # - `user`: Indicates the message is sent by an actual user and should be used in
72
- # most cases to represent user-generated messages.
73
- # - `assistant`: Indicates the message is generated by the assistant. Use this
74
- # value to insert messages from the assistant into the conversation.
75
- #
76
- # @return [Symbol, OpenAI::Models::Beta::ThreadCreateParams::Message::Role]
77
- required :role, enum: -> { OpenAI::Beta::ThreadCreateParams::Message::Role }
78
-
79
- # @!attribute attachments
80
- # A list of files attached to the message, and the tools they should be added to.
81
- #
82
- # @return [Array<OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment>, nil]
83
- optional(
84
- :attachments,
85
- -> {
86
- OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::ThreadCreateParams::Message::Attachment]
87
- },
88
- nil?: true
89
- )
90
-
91
- # @!attribute metadata
92
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
93
- # for storing additional information about the object in a structured format, and
94
- # querying for objects via API or the dashboard.
95
- #
96
- # Keys are strings with a maximum length of 64 characters. Values are strings with
97
- # a maximum length of 512 characters.
98
- #
99
- # @return [Hash{Symbol=>String}, nil]
100
- optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
101
-
102
- # @!method initialize(content:, role:, attachments: nil, metadata: nil)
103
- # @param content [String, Array<OpenAI::Models::Beta::Threads::ImageFileContentBlock, OpenAI::Models::Beta::Threads::ImageURLContentBlock, OpenAI::Models::Beta::Threads::TextContentBlockParam>]
104
- # The text contents of the message.
105
- #
106
- # @param role [Symbol, OpenAI::Models::Beta::ThreadCreateParams::Message::Role]
107
- # The role of the entity that is creating the message. Allowed values include:
108
- #
109
- # - `user`: Indicates the message is sent by an actual user and should be used in
110
- # most cases to represent user-generated messages.
111
- # - `assistant`: Indicates the message is generated by the assistant. Use this
112
- # value to insert messages from the assistant into the conversation.
113
- #
114
- # @param attachments [Array<OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment>, nil]
115
- # A list of files attached to the message, and the tools they should be added to.
116
- #
117
- # @param metadata [Hash{Symbol=>String}, nil]
118
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
119
- # for storing additional information about the object in a structured format, and
120
- # querying for objects via API or the dashboard.
121
- #
122
- # Keys are strings with a maximum length of 64 characters. Values are strings with
123
- # a maximum length of 512 characters.
124
-
125
- # The text contents of the message.
126
- #
127
- # @see OpenAI::Models::Beta::ThreadCreateParams::Message#content
128
- module Content
129
- extend OpenAI::Internal::Type::Union
130
-
131
- # The text contents of the message.
132
- variant String
133
-
134
- # An array of content parts with a defined type, each can be of type `text` or images can be passed with `image_url` or `image_file`. Image types are only supported on [Vision-compatible models](https://developers.openai.com/api/docs/models).
135
- variant -> { OpenAI::Models::Beta::ThreadCreateParams::Message::Content::MessageContentPartParamArray }
136
-
137
- # @!method self.variants
138
- # @return [Array(String, Array<OpenAI::Models::Beta::Threads::ImageFileContentBlock, OpenAI::Models::Beta::Threads::ImageURLContentBlock, OpenAI::Models::Beta::Threads::TextContentBlockParam>)]
139
-
140
- # @type [OpenAI::Internal::Type::Converter]
141
- MessageContentPartParamArray = OpenAI::Internal::Type::ArrayOf[
142
- union: -> { OpenAI::Beta::Threads::MessageContentPartParam }
143
- ]
144
- end
145
-
146
- # The role of the entity that is creating the message. Allowed values include:
147
- #
148
- # - `user`: Indicates the message is sent by an actual user and should be used in
149
- # most cases to represent user-generated messages.
150
- # - `assistant`: Indicates the message is generated by the assistant. Use this
151
- # value to insert messages from the assistant into the conversation.
152
- #
153
- # @see OpenAI::Models::Beta::ThreadCreateParams::Message#role
154
- module Role
155
- extend OpenAI::Internal::Type::Enum
156
-
157
- USER = :user
158
- ASSISTANT = :assistant
159
-
160
- # @!method self.values
161
- # @return [Array<Symbol>]
162
- end
163
-
164
- class Attachment < OpenAI::Internal::Type::BaseModel
165
- # @!attribute file_id
166
- # The ID of the file to attach to the message.
167
- #
168
- # @return [String, nil]
169
- optional :file_id, String
170
-
171
- # @!attribute tools
172
- # The tools to add this file to.
173
- #
174
- # @return [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment::Tool::FileSearch>, nil]
175
- optional(
176
- :tools,
177
- -> {
178
- OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::ThreadCreateParams::Message::Attachment::Tool]
179
- }
180
- )
181
-
182
- # @!method initialize(file_id: nil, tools: nil)
183
- # @param file_id [String]
184
- # The ID of the file to attach to the message.
185
- #
186
- # @param tools [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment::Tool::FileSearch>]
187
- # The tools to add this file to.
188
- module Tool
189
- extend OpenAI::Internal::Type::Union
190
-
191
- discriminator :type
192
-
193
- variant :code_interpreter, -> { OpenAI::Beta::CodeInterpreterTool }
194
-
195
- variant :file_search, -> { OpenAI::Beta::ThreadCreateParams::Message::Attachment::Tool::FileSearch }
196
-
197
- class FileSearch < OpenAI::Internal::Type::BaseModel
198
- # @!attribute type
199
- # The type of tool being defined: `file_search`
200
- #
201
- # @return [Symbol, :file_search]
202
- required :type, const: :file_search
203
-
204
- # @!method initialize(type: :file_search)
205
- # @param type [Symbol, :file_search]
206
- # The type of tool being defined: `file_search`
207
- end
208
-
209
- # @!method self.variants
210
- # @return [Array(OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment::Tool::FileSearch)]
211
- end
212
- end
213
- end
214
-
215
- class ToolResources < OpenAI::Internal::Type::BaseModel
216
- # @!attribute code_interpreter
217
- #
218
- # @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::CodeInterpreter, nil]
219
- optional :code_interpreter, -> { OpenAI::Beta::ThreadCreateParams::ToolResources::CodeInterpreter }
220
-
221
- # @!attribute file_search
222
- #
223
- # @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch, nil]
224
- optional :file_search, -> { OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch }
225
-
226
- # @!method initialize(code_interpreter: nil, file_search: nil)
227
- # A set of resources that are made available to the assistant's tools in this
228
- # thread. The resources are specific to the type of tool. For example, the
229
- # `code_interpreter` tool requires a list of file IDs, while the `file_search`
230
- # tool requires a list of vector store IDs.
231
- #
232
- # @param code_interpreter [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::CodeInterpreter]
233
- # @param file_search [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch]
234
-
235
- # @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources#code_interpreter
236
- class CodeInterpreter < OpenAI::Internal::Type::BaseModel
237
- # @!attribute file_ids
238
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
239
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
240
- # files associated with the tool.
241
- #
242
- # @return [Array<String>, nil]
243
- optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
244
-
245
- # @!method initialize(file_ids: nil)
246
- # @param file_ids [Array<String>]
247
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
248
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
249
- # files associated with the tool.
250
- end
251
-
252
- # @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources#file_search
253
- class FileSearch < OpenAI::Internal::Type::BaseModel
254
- # @!attribute vector_store_ids
255
- # The
256
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
257
- # attached to this thread. There can be a maximum of 1 vector store attached to
258
- # the thread.
259
- #
260
- # @return [Array<String>, nil]
261
- optional :vector_store_ids, OpenAI::Internal::Type::ArrayOf[String]
262
-
263
- # @!attribute vector_stores
264
- # A helper to create a
265
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
266
- # with file_ids and attach it to this thread. There can be a maximum of 1 vector
267
- # store attached to the thread.
268
- #
269
- # @return [Array<OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore>, nil]
270
- optional(
271
- :vector_stores,
272
- -> {
273
- OpenAI::Internal::Type::ArrayOf[
274
- OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore
275
- ]
276
- }
277
- )
278
-
279
- # @!method initialize(vector_store_ids: nil, vector_stores: nil)
280
- # @param vector_store_ids [Array<String>]
281
- # The
282
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
283
- # attached to this thread. There can be a maximum of 1 vector store attached to
284
- # the thread.
285
- #
286
- # @param vector_stores [Array<OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore>]
287
- # A helper to create a
288
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
289
- # with file_ids and attach it to this thread. There can be a maximum of 1 vector
290
- # store attached to the thread.
291
- class VectorStore < OpenAI::Internal::Type::BaseModel
292
- # @!attribute chunking_strategy
293
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
294
- # strategy.
295
- #
296
- # @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static, nil]
297
- optional(
298
- :chunking_strategy,
299
- union: -> {
300
- OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy
301
- }
302
- )
303
-
304
- # @!attribute file_ids
305
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
306
- # IDs to add to the vector store. For vector stores created before Nov 2025, there
307
- # can be a maximum of 10,000 files in a vector store. For vector stores created
308
- # starting in Nov 2025, the limit is 100,000,000 files.
309
- #
310
- # @return [Array<String>, nil]
311
- optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
312
-
313
- # @!attribute metadata
314
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
315
- # for storing additional information about the object in a structured format, and
316
- # querying for objects via API or the dashboard.
317
- #
318
- # Keys are strings with a maximum length of 64 characters. Values are strings with
319
- # a maximum length of 512 characters.
320
- #
321
- # @return [Hash{Symbol=>String}, nil]
322
- optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
323
-
324
- # @!method initialize(chunking_strategy: nil, file_ids: nil, metadata: nil)
325
- # @param chunking_strategy [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static]
326
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
327
- # strategy.
328
- #
329
- # @param file_ids [Array<String>]
330
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
331
- # IDs to add to the vector store. For vector stores created before Nov 2025, there
332
- # can be a maximum of 10,000 files in a vector store. For vector stores created
333
- # starting in Nov 2025, the limit is 100,000,000 files.
334
- #
335
- # @param metadata [Hash{Symbol=>String}, nil]
336
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
337
- # for storing additional information about the object in a structured format, and
338
- # querying for objects via API or the dashboard.
339
- #
340
- # Keys are strings with a maximum length of 64 characters. Values are strings with
341
- # a maximum length of 512 characters.
342
-
343
- # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
344
- # strategy.
345
- #
346
- # @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore#chunking_strategy
347
- module ChunkingStrategy
348
- extend OpenAI::Internal::Type::Union
349
-
350
- discriminator :type
351
-
352
- # The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.
353
- variant(
354
- :auto,
355
- -> {
356
- OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto
357
- }
358
- )
359
-
360
- variant(
361
- :static,
362
- -> {
363
- OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static
364
- }
365
- )
366
-
367
- class Auto < OpenAI::Internal::Type::BaseModel
368
- # @!attribute type
369
- # Always `auto`.
370
- #
371
- # @return [Symbol, :auto]
372
- required :type, const: :auto
373
-
374
- # @!method initialize(type: :auto)
375
- # The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
376
- # `800` and `chunk_overlap_tokens` of `400`.
377
- #
378
- # @param type [Symbol, :auto]
379
- # Always `auto`.
380
- end
381
-
382
- class Static < OpenAI::Internal::Type::BaseModel
383
- # @!attribute static
384
- #
385
- # @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static]
386
- required(
387
- :static,
388
- -> {
389
- OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static
390
- }
391
- )
392
-
393
- # @!attribute type
394
- # Always `static`.
395
- #
396
- # @return [Symbol, :static]
397
- required :type, const: :static
398
-
399
- # @!method initialize(static:, type: :static)
400
- # @param static [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static]
401
- #
402
- # @param type [Symbol, :static]
403
- # Always `static`.
404
-
405
- # @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static#static
406
- class Static < OpenAI::Internal::Type::BaseModel
407
- # @!attribute chunk_overlap_tokens
408
- # The number of tokens that overlap between chunks. The default value is `400`.
409
- #
410
- # Note that the overlap must not exceed half of `max_chunk_size_tokens`.
411
- #
412
- # @return [Integer]
413
- required :chunk_overlap_tokens, Integer
414
-
415
- # @!attribute max_chunk_size_tokens
416
- # The maximum number of tokens in each chunk. The default value is `800`. The
417
- # minimum value is `100` and the maximum value is `4096`.
418
- #
419
- # @return [Integer]
420
- required :max_chunk_size_tokens, Integer
421
-
422
- # @!method initialize(chunk_overlap_tokens:, max_chunk_size_tokens:)
423
- # @param chunk_overlap_tokens [Integer]
424
- # The number of tokens that overlap between chunks. The default value is `400`.
425
- #
426
- # Note that the overlap must not exceed half of `max_chunk_size_tokens`.
427
- #
428
- # @param max_chunk_size_tokens [Integer]
429
- # The maximum number of tokens in each chunk. The default value is `800`. The
430
- # minimum value is `100` and the maximum value is `4096`.
431
- end
432
- end
433
-
434
- # @!method self.variants
435
- # @return [Array(OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static)]
436
- end
437
- end
438
- end
439
- end
440
- end
441
- end
442
- end
443
- 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::Threads#delete
7
- class ThreadDeleteParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- # @!attribute thread_id
12
- #
13
- # @return [String]
14
- required :thread_id, String
15
-
16
- # @!method initialize(thread_id:, request_options: {})
17
- # @param thread_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::Threads#delete
7
- class ThreadDeleted < 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, :"thread.deleted"]
21
- required :object, const: :"thread.deleted"
22
-
23
- # @!method initialize(id:, deleted:, object: :"thread.deleted")
24
- # @param id [String]
25
- # @param deleted [Boolean]
26
- # @param object [Symbol, :"thread.deleted"]
27
- end
28
- end
29
- end
30
- 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::Threads#retrieve
7
- class ThreadRetrieveParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- # @!attribute thread_id
12
- #
13
- # @return [String]
14
- required :thread_id, String
15
-
16
- # @!method initialize(thread_id:, request_options: {})
17
- # @param thread_id [String]
18
- # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
19
- end
20
- end
21
- end
22
- end
@@ -1,41 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- class ThreadStreamEvent < OpenAI::Internal::Type::BaseModel
7
- # @!attribute data
8
- # Represents a thread that contains
9
- # [messages](https://developers.openai.com/api/docs/assistants/migration).
10
- #
11
- # @return [OpenAI::Models::Beta::Thread]
12
- required :data, -> { OpenAI::Beta::Thread }
13
-
14
- # @!attribute event
15
- #
16
- # @return [Symbol, :"thread.created"]
17
- required :event, const: :"thread.created"
18
-
19
- # @!attribute enabled
20
- # Whether to enable input audio transcription.
21
- #
22
- # @return [Boolean, nil]
23
- optional :enabled, OpenAI::Internal::Type::Boolean
24
-
25
- # @!method initialize(data:, enabled: nil, event: :"thread.created")
26
- # Occurs when a new
27
- # [thread](https://developers.openai.com/api/docs/assistants/migration) is
28
- # created.
29
- #
30
- # @param data [OpenAI::Models::Beta::Thread]
31
- # Represents a thread that contains
32
- # [messages](https://developers.openai.com/api/docs/assistants/migration).
33
- #
34
- # @param enabled [Boolean]
35
- # Whether to enable input audio transcription.
36
- #
37
- # @param event [Symbol, :"thread.created"]
38
- end
39
- end
40
- end
41
- end
@@ -1,114 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module OpenAI
4
- module Models
5
- module Beta
6
- # @see OpenAI::Resources::Beta::Threads#update
7
- class ThreadUpdateParams < OpenAI::Internal::Type::BaseModel
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- # @!attribute thread_id
12
- #
13
- # @return [String]
14
- required :thread_id, String
15
-
16
- # @!attribute metadata
17
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
18
- # for storing additional information about the object in a structured format, and
19
- # querying for objects via API or the dashboard.
20
- #
21
- # Keys are strings with a maximum length of 64 characters. Values are strings with
22
- # a maximum length of 512 characters.
23
- #
24
- # @return [Hash{Symbol=>String}, nil]
25
- optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
26
-
27
- # @!attribute tool_resources
28
- # A set of resources that are made available to the assistant's tools in this
29
- # thread. The resources are specific to the type of tool. For example, the
30
- # `code_interpreter` tool requires a list of file IDs, while the `file_search`
31
- # tool requires a list of vector store IDs.
32
- #
33
- # @return [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, nil]
34
- optional :tool_resources, -> { OpenAI::Beta::ThreadUpdateParams::ToolResources }, nil?: true
35
-
36
- # @!method initialize(thread_id:, metadata: nil, tool_resources: nil, request_options: {})
37
- # @param thread_id [String]
38
- #
39
- # @param metadata [Hash{Symbol=>String}, nil]
40
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
41
- # for storing additional information about the object in a structured format, and
42
- # querying for objects via API or the dashboard.
43
- #
44
- # Keys are strings with a maximum length of 64 characters. Values are strings with
45
- # a maximum length of 512 characters.
46
- #
47
- # @param tool_resources [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, nil]
48
- # A set of resources that are made available to the assistant's tools in this
49
- # thread. The resources are specific to the type of tool. For example, the
50
- # `code_interpreter` tool requires a list of file IDs, while the `file_search`
51
- # tool requires a list of vector store IDs.
52
- #
53
- # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
54
-
55
- class ToolResources < OpenAI::Internal::Type::BaseModel
56
- # @!attribute code_interpreter
57
- #
58
- # @return [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources::CodeInterpreter, nil]
59
- optional :code_interpreter, -> { OpenAI::Beta::ThreadUpdateParams::ToolResources::CodeInterpreter }
60
-
61
- # @!attribute file_search
62
- #
63
- # @return [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources::FileSearch, nil]
64
- optional :file_search, -> { OpenAI::Beta::ThreadUpdateParams::ToolResources::FileSearch }
65
-
66
- # @!method initialize(code_interpreter: nil, file_search: nil)
67
- # A set of resources that are made available to the assistant's tools in this
68
- # thread. The resources are specific to the type of tool. For example, the
69
- # `code_interpreter` tool requires a list of file IDs, while the `file_search`
70
- # tool requires a list of vector store IDs.
71
- #
72
- # @param code_interpreter [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources::CodeInterpreter]
73
- # @param file_search [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources::FileSearch]
74
-
75
- # @see OpenAI::Models::Beta::ThreadUpdateParams::ToolResources#code_interpreter
76
- class CodeInterpreter < OpenAI::Internal::Type::BaseModel
77
- # @!attribute file_ids
78
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
79
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
80
- # files associated with the tool.
81
- #
82
- # @return [Array<String>, nil]
83
- optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
84
-
85
- # @!method initialize(file_ids: nil)
86
- # @param file_ids [Array<String>]
87
- # A list of [file](https://developers.openai.com/api/reference/resources/files)
88
- # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
89
- # files associated with the tool.
90
- end
91
-
92
- # @see OpenAI::Models::Beta::ThreadUpdateParams::ToolResources#file_search
93
- class FileSearch < OpenAI::Internal::Type::BaseModel
94
- # @!attribute vector_store_ids
95
- # The
96
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
97
- # attached to this thread. There can be a maximum of 1 vector store attached to
98
- # the thread.
99
- #
100
- # @return [Array<String>, nil]
101
- optional :vector_store_ids, OpenAI::Internal::Type::ArrayOf[String]
102
-
103
- # @!method initialize(vector_store_ids: nil)
104
- # @param vector_store_ids [Array<String>]
105
- # The
106
- # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
107
- # attached to this thread. There can be a maximum of 1 vector store attached to
108
- # the thread.
109
- end
110
- end
111
- end
112
- end
113
- end
114
- end