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,101 +0,0 @@
1
- # typed: strong
2
-
3
- module OpenAI
4
- module Models
5
-
6
- class VideoListParams < OpenAI::Internal::Type::BaseModel
7
-
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- OrHash = T.type_alias do
12
- T.any(
13
- OpenAI::VideoListParams,
14
- OpenAI::Internal::AnyHash
15
- )
16
- end
17
-
18
- # Identifier for the last item from the previous pagination request
19
- sig { returns(T.nilable(String)) }
20
- attr_reader :after
21
-
22
- sig { params(after: String).void }
23
- attr_writer :after
24
-
25
- # Number of items to retrieve
26
- sig { returns(T.nilable(Integer)) }
27
- attr_reader :limit
28
-
29
- sig { params(limit: Integer).void }
30
- attr_writer :limit
31
-
32
- # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
33
- # descending order.
34
- sig { returns(T.nilable(OpenAI::VideoListParams::Order::OrSymbol)) }
35
- attr_reader :order
36
-
37
- sig { params(order: OpenAI::VideoListParams::Order::OrSymbol).void }
38
- attr_writer :order
39
-
40
- sig do
41
- params(
42
-
43
- after: String,
44
-
45
- limit: Integer,
46
-
47
- order: OpenAI::VideoListParams::Order::OrSymbol,
48
-
49
- request_options: OpenAI::RequestOptions::OrHash
50
- )
51
- .returns(T.attached_class)
52
- end
53
- def self.new(
54
-
55
- # Identifier for the last item from the previous pagination request
56
- after: nil,
57
-
58
- # Number of items to retrieve
59
- limit: nil,
60
-
61
- # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
62
- # descending order.
63
- order: nil,
64
-
65
- request_options: {}
66
- )
67
- end
68
-
69
- sig do
70
- override.returns(
71
- {
72
- after: String,
73
- limit: Integer,
74
- order: OpenAI::VideoListParams::Order::OrSymbol,
75
- request_options: OpenAI::RequestOptions
76
- }
77
- )
78
- end
79
- def to_hash
80
- end
81
-
82
- # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
83
- # descending order.
84
- module Order
85
- extend OpenAI::Internal::Type::Enum
86
-
87
- TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoListParams::Order) }
88
- OrSymbol = T.type_alias { T.any(Symbol, String) }
89
-
90
- ASC = T.let(:asc, OpenAI::VideoListParams::Order::TaggedSymbol)
91
- DESC = T.let(:desc, OpenAI::VideoListParams::Order::TaggedSymbol)
92
-
93
- sig { override.returns(T::Array[OpenAI::VideoListParams::Order::TaggedSymbol]) }
94
- def self.values
95
- end
96
- end
97
-
98
- end
99
-
100
- end
101
- end
@@ -1,35 +0,0 @@
1
- # typed: strong
2
-
3
- module OpenAI
4
- module Models
5
-
6
- module VideoModel
7
- extend OpenAI::Internal::Type::Union
8
-
9
- Variants = T.type_alias do
10
- T.any(
11
- String,
12
- OpenAI::VideoModel::TaggedSymbol
13
- )
14
- end
15
-
16
- sig { override.returns(T::Array[OpenAI::VideoModel::Variants]) }
17
- def self.variants
18
- end
19
-
20
- TaggedSymbol = T.type_alias do
21
- T.all(Symbol, OpenAI::VideoModel)
22
- end
23
-
24
- OrSymbol = T.type_alias { T.any(Symbol, String) }
25
-
26
- SORA_2 = T.let(:"sora-2", OpenAI::VideoModel::TaggedSymbol)
27
- SORA_2_PRO = T.let(:"sora-2-pro", OpenAI::VideoModel::TaggedSymbol)
28
- SORA_2_2025_10_06 = T.let(:"sora-2-2025-10-06", OpenAI::VideoModel::TaggedSymbol)
29
- SORA_2_PRO_2025_10_06 = T.let(:"sora-2-pro-2025-10-06", OpenAI::VideoModel::TaggedSymbol)
30
- SORA_2_2025_12_08 = T.let(:"sora-2-2025-12-08", OpenAI::VideoModel::TaggedSymbol)
31
-
32
- end
33
-
34
- end
35
- end
@@ -1,58 +0,0 @@
1
- # typed: strong
2
-
3
- module OpenAI
4
- module Models
5
-
6
- class VideoRemixParams < OpenAI::Internal::Type::BaseModel
7
-
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- OrHash = T.type_alias do
12
- T.any(
13
- OpenAI::VideoRemixParams,
14
- OpenAI::Internal::AnyHash
15
- )
16
- end
17
-
18
- sig { returns(String) }
19
- attr_accessor :video_id
20
-
21
- # Updated text prompt that directs the remix generation.
22
- sig { returns(String) }
23
- attr_accessor :prompt
24
-
25
- sig do
26
- params(
27
-
28
- video_id: String,
29
-
30
- prompt: String,
31
-
32
- request_options: OpenAI::RequestOptions::OrHash
33
- )
34
- .returns(T.attached_class)
35
- end
36
- def self.new(
37
-
38
- video_id:,
39
-
40
- # Updated text prompt that directs the remix generation.
41
- prompt:,
42
-
43
- request_options: {}
44
- )
45
- end
46
-
47
- sig do
48
- override.returns(
49
- {video_id: String, prompt: String, request_options: OpenAI::RequestOptions}
50
- )
51
- end
52
- def to_hash
53
- end
54
-
55
- end
56
-
57
- end
58
- end
@@ -1,49 +0,0 @@
1
- # typed: strong
2
-
3
- module OpenAI
4
- module Models
5
-
6
- class VideoRetrieveParams < OpenAI::Internal::Type::BaseModel
7
-
8
- extend OpenAI::Internal::Type::RequestParameters::Converter
9
- include OpenAI::Internal::Type::RequestParameters
10
-
11
- OrHash = T.type_alias do
12
- T.any(
13
- OpenAI::VideoRetrieveParams,
14
- OpenAI::Internal::AnyHash
15
- )
16
- end
17
-
18
- sig { returns(String) }
19
- attr_accessor :video_id
20
-
21
- sig do
22
- params(
23
-
24
- video_id: String,
25
-
26
- request_options: OpenAI::RequestOptions::OrHash
27
- )
28
- .returns(T.attached_class)
29
- end
30
- def self.new(
31
-
32
- video_id:,
33
-
34
- request_options: {}
35
- )
36
- end
37
-
38
- sig do
39
- override.returns(
40
- {video_id: String, request_options: OpenAI::RequestOptions}
41
- )
42
- end
43
- def to_hash
44
- end
45
-
46
- end
47
-
48
- end
49
- end
@@ -1,22 +0,0 @@
1
- # typed: strong
2
-
3
- module OpenAI
4
- module Models
5
-
6
- module VideoSeconds
7
- extend OpenAI::Internal::Type::Enum
8
-
9
- TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoSeconds) }
10
- OrSymbol = T.type_alias { T.any(Symbol, String) }
11
-
12
- VIDEO_SECONDS_4 = T.let(:"4", OpenAI::VideoSeconds::TaggedSymbol)
13
- VIDEO_SECONDS_8 = T.let(:"8", OpenAI::VideoSeconds::TaggedSymbol)
14
- VIDEO_SECONDS_12 = T.let(:"12", OpenAI::VideoSeconds::TaggedSymbol)
15
-
16
- sig { override.returns(T::Array[OpenAI::VideoSeconds::TaggedSymbol]) }
17
- def self.values
18
- end
19
- end
20
-
21
- end
22
- end
@@ -1,23 +0,0 @@
1
- # typed: strong
2
-
3
- module OpenAI
4
- module Models
5
-
6
- module VideoSize
7
- extend OpenAI::Internal::Type::Enum
8
-
9
- TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoSize) }
10
- OrSymbol = T.type_alias { T.any(Symbol, String) }
11
-
12
- VIDEO_SIZE_720X1280 = T.let(:"720x1280", OpenAI::VideoSize::TaggedSymbol)
13
- VIDEO_SIZE_1280X720 = T.let(:"1280x720", OpenAI::VideoSize::TaggedSymbol)
14
- VIDEO_SIZE_1024X1792 = T.let(:"1024x1792", OpenAI::VideoSize::TaggedSymbol)
15
- VIDEO_SIZE_1792X1024 = T.let(:"1792x1024", OpenAI::VideoSize::TaggedSymbol)
16
-
17
- sig { override.returns(T::Array[OpenAI::VideoSize::TaggedSymbol]) }
18
- def self.values
19
- end
20
- end
21
-
22
- end
23
- end
@@ -1,285 +0,0 @@
1
- # typed: strong
2
-
3
- module OpenAI
4
- module Resources
5
-
6
- class Beta
7
-
8
- # Build Assistants that can call models and use tools.
9
- class Assistants
10
-
11
- # Create an assistant with a model and instructions.
12
- sig {
13
- params(
14
- model: T.any(String, OpenAI::ChatModel::OrSymbol),
15
- description: T.nilable(String),
16
- instructions: T.nilable(String),
17
- metadata: T.nilable(T::Hash[Symbol, String]),
18
- name: T.nilable(String),
19
- reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
20
- response_format: T.nilable(
21
- T.any(
22
- Symbol,
23
- OpenAI::ResponseFormatText::OrHash,
24
- OpenAI::ResponseFormatJSONObject::OrHash,
25
- OpenAI::ResponseFormatJSONSchema::OrHash
26
- )
27
- ),
28
- temperature: T.nilable(Float),
29
- tool_resources: T.nilable(OpenAI::Beta::AssistantCreateParams::ToolResources::OrHash),
30
- tools: T::Array[
31
- T.any(
32
- OpenAI::Beta::CodeInterpreterTool::OrHash,
33
- OpenAI::Beta::FileSearchTool::OrHash,
34
- OpenAI::Beta::FunctionTool::OrHash
35
- )
36
- ],
37
- top_p: T.nilable(Float),
38
- request_options: OpenAI::RequestOptions::OrHash
39
- )
40
- .returns(OpenAI::Beta::Assistant)
41
- }
42
- def create(
43
- # ID of the model to use. You can use the
44
- # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
45
- # API to see all of your available models, or see our
46
- # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
47
- # of them.
48
- model:,
49
- # The description of the assistant. The maximum length is 512 characters.
50
- description: nil,
51
- # The system instructions that the assistant uses. The maximum length is 256,000
52
- # characters.
53
- instructions: nil,
54
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
55
- # for storing additional information about the object in a structured format, and
56
- # querying for objects via API or the dashboard.
57
- #
58
- # Keys are strings with a maximum length of 64 characters. Values are strings with
59
- # a maximum length of 512 characters.
60
- metadata: nil,
61
- # The name of the assistant. The maximum length is 256 characters.
62
- name: nil,
63
- # Constrains effort on reasoning for reasoning models. Currently supported values
64
- # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
65
- # reasoning effort can result in faster responses and fewer tokens used on
66
- # reasoning in a response. Not all reasoning models support every value. See the
67
- # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
68
- # model-specific support.
69
- reasoning_effort: nil,
70
- # Specifies the format that the model must output. Compatible with
71
- # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
72
- # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
73
- # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
74
- #
75
- # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
76
- # Outputs which ensures the model will match your supplied JSON schema. Learn more
77
- # in the
78
- # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
79
- #
80
- # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
81
- # message the model generates is valid JSON.
82
- #
83
- # **Important:** when using JSON mode, you **must** also instruct the model to
84
- # produce JSON yourself via a system or user message. Without this, the model may
85
- # generate an unending stream of whitespace until the generation reaches the token
86
- # limit, resulting in a long-running and seemingly "stuck" request. Also note that
87
- # the message content may be partially cut off if `finish_reason="length"`, which
88
- # indicates the generation exceeded `max_tokens` or the conversation exceeded the
89
- # max context length.
90
- response_format: nil,
91
- # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
92
- # make the output more random, while lower values like 0.2 will make it more
93
- # focused and deterministic.
94
- temperature: nil,
95
- # A set of resources that are used by the assistant's tools. The resources are
96
- # specific to the type of tool. For example, the `code_interpreter` tool requires
97
- # a list of file IDs, while the `file_search` tool requires a list of vector store
98
- # IDs.
99
- tool_resources: nil,
100
- # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
101
- # assistant. Tools can be of types `code_interpreter`, `file_search`, or
102
- # `function`.
103
- tools: nil,
104
- # An alternative to sampling with temperature, called nucleus sampling, where the
105
- # model considers the results of the tokens with top_p probability mass. So 0.1
106
- # means only the tokens comprising the top 10% probability mass are considered.
107
- #
108
- # We generally recommend altering this or temperature but not both.
109
- top_p: nil,
110
- request_options: {}
111
- )
112
- end
113
-
114
- # Retrieves an assistant.
115
- sig {
116
- params(assistant_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(OpenAI::Beta::Assistant)
117
- }
118
- def retrieve(
119
- # The ID of the assistant to retrieve.
120
- assistant_id,
121
- request_options: {}
122
- )
123
- end
124
-
125
- # Modifies an assistant.
126
- sig {
127
- params(
128
- assistant_id: String,
129
- description: T.nilable(String),
130
- instructions: T.nilable(String),
131
- metadata: T.nilable(T::Hash[Symbol, String]),
132
- model: T.any(String, OpenAI::Beta::AssistantUpdateParams::Model::OrSymbol),
133
- name: T.nilable(String),
134
- reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
135
- response_format: T.nilable(
136
- T.any(
137
- Symbol,
138
- OpenAI::ResponseFormatText::OrHash,
139
- OpenAI::ResponseFormatJSONObject::OrHash,
140
- OpenAI::ResponseFormatJSONSchema::OrHash
141
- )
142
- ),
143
- temperature: T.nilable(Float),
144
- tool_resources: T.nilable(OpenAI::Beta::AssistantUpdateParams::ToolResources::OrHash),
145
- tools: T::Array[
146
- T.any(
147
- OpenAI::Beta::CodeInterpreterTool::OrHash,
148
- OpenAI::Beta::FileSearchTool::OrHash,
149
- OpenAI::Beta::FunctionTool::OrHash
150
- )
151
- ],
152
- top_p: T.nilable(Float),
153
- request_options: OpenAI::RequestOptions::OrHash
154
- )
155
- .returns(OpenAI::Beta::Assistant)
156
- }
157
- def update(
158
- # The ID of the assistant to modify.
159
- assistant_id,
160
- # The description of the assistant. The maximum length is 512 characters.
161
- description: nil,
162
- # The system instructions that the assistant uses. The maximum length is 256,000
163
- # characters.
164
- instructions: nil,
165
- # Set of 16 key-value pairs that can be attached to an object. This can be useful
166
- # for storing additional information about the object in a structured format, and
167
- # querying for objects via API or the dashboard.
168
- #
169
- # Keys are strings with a maximum length of 64 characters. Values are strings with
170
- # a maximum length of 512 characters.
171
- metadata: nil,
172
- # ID of the model to use. You can use the
173
- # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
174
- # API to see all of your available models, or see our
175
- # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
176
- # of them.
177
- model: nil,
178
- # The name of the assistant. The maximum length is 256 characters.
179
- name: nil,
180
- # Constrains effort on reasoning for reasoning models. Currently supported values
181
- # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
182
- # reasoning effort can result in faster responses and fewer tokens used on
183
- # reasoning in a response. Not all reasoning models support every value. See the
184
- # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
185
- # model-specific support.
186
- reasoning_effort: nil,
187
- # Specifies the format that the model must output. Compatible with
188
- # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
189
- # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
190
- # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
191
- #
192
- # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
193
- # Outputs which ensures the model will match your supplied JSON schema. Learn more
194
- # in the
195
- # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
196
- #
197
- # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
198
- # message the model generates is valid JSON.
199
- #
200
- # **Important:** when using JSON mode, you **must** also instruct the model to
201
- # produce JSON yourself via a system or user message. Without this, the model may
202
- # generate an unending stream of whitespace until the generation reaches the token
203
- # limit, resulting in a long-running and seemingly "stuck" request. Also note that
204
- # the message content may be partially cut off if `finish_reason="length"`, which
205
- # indicates the generation exceeded `max_tokens` or the conversation exceeded the
206
- # max context length.
207
- response_format: nil,
208
- # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
209
- # make the output more random, while lower values like 0.2 will make it more
210
- # focused and deterministic.
211
- temperature: nil,
212
- # A set of resources that are used by the assistant's tools. The resources are
213
- # specific to the type of tool. For example, the `code_interpreter` tool requires
214
- # a list of file IDs, while the `file_search` tool requires a list of vector store
215
- # IDs.
216
- tool_resources: nil,
217
- # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
218
- # assistant. Tools can be of types `code_interpreter`, `file_search`, or
219
- # `function`.
220
- tools: nil,
221
- # An alternative to sampling with temperature, called nucleus sampling, where the
222
- # model considers the results of the tokens with top_p probability mass. So 0.1
223
- # means only the tokens comprising the top 10% probability mass are considered.
224
- #
225
- # We generally recommend altering this or temperature but not both.
226
- top_p: nil,
227
- request_options: {}
228
- )
229
- end
230
-
231
- # Returns a list of assistants.
232
- sig {
233
- params(
234
- after: String,
235
- before: String,
236
- limit: Integer,
237
- order: OpenAI::Beta::AssistantListParams::Order::OrSymbol,
238
- request_options: OpenAI::RequestOptions::OrHash
239
- )
240
- .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Assistant])
241
- }
242
- def list(
243
- # A cursor for use in pagination. `after` is an object ID that defines your place
244
- # in the list. For instance, if you make a list request and receive 100 objects,
245
- # ending with obj_foo, your subsequent call can include after=obj_foo in order to
246
- # fetch the next page of the list.
247
- after: nil,
248
- # A cursor for use in pagination. `before` is an object ID that defines your place
249
- # in the list. For instance, if you make a list request and receive 100 objects,
250
- # starting with obj_foo, your subsequent call can include before=obj_foo in order
251
- # to fetch the previous page of the list.
252
- before: nil,
253
- # A limit on the number of objects to be returned. Limit can range between 1 and
254
- # 100, and the default is 20.
255
- limit: nil,
256
- # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
257
- # order and `desc` for descending order.
258
- order: nil,
259
- request_options: {}
260
- )
261
- end
262
-
263
- # Delete an assistant.
264
- sig {
265
- params(assistant_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
266
- OpenAI::Beta::AssistantDeleted
267
- )
268
- }
269
- def delete(
270
- # The ID of the assistant to delete.
271
- assistant_id,
272
- request_options: {}
273
- )
274
- end
275
-
276
- # @api private
277
- sig { params(client: OpenAI::Client).returns(T.attached_class) }
278
- def self.new(client:)
279
- end
280
- end
281
-
282
- end
283
-
284
- end
285
- end