openai 0.3.0 → 0.4.1

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 (1495) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +376 -0
  4. data/README.md +292 -28
  5. data/SECURITY.md +29 -0
  6. data/lib/openai/client.rb +136 -120
  7. data/lib/openai/errors.rb +228 -0
  8. data/lib/openai/file_part.rb +55 -0
  9. data/lib/openai/helpers/structured_output/array_of.rb +49 -0
  10. data/lib/openai/helpers/structured_output/base_model.rb +78 -0
  11. data/lib/openai/helpers/structured_output/boolean.rb +28 -0
  12. data/lib/openai/helpers/structured_output/enum_of.rb +63 -0
  13. data/lib/openai/helpers/structured_output/json_schema_converter.rb +163 -0
  14. data/lib/openai/helpers/structured_output/union_of.rb +64 -0
  15. data/lib/openai/helpers/structured_output.rb +16 -0
  16. data/lib/openai/internal/cursor_page.rb +86 -0
  17. data/lib/openai/internal/page.rb +80 -0
  18. data/lib/openai/internal/stream.rb +60 -0
  19. data/lib/openai/internal/transport/base_client.rb +558 -0
  20. data/lib/openai/internal/transport/pooled_net_requester.rb +209 -0
  21. data/lib/openai/internal/type/array_of.rb +162 -0
  22. data/lib/openai/internal/type/base_model.rb +477 -0
  23. data/lib/openai/internal/type/base_page.rb +55 -0
  24. data/lib/openai/internal/type/base_stream.rb +90 -0
  25. data/lib/openai/internal/type/boolean.rb +71 -0
  26. data/lib/openai/internal/type/converter.rb +292 -0
  27. data/lib/openai/internal/type/enum.rb +145 -0
  28. data/lib/openai/internal/type/file_input.rb +103 -0
  29. data/lib/openai/internal/type/hash_of.rb +182 -0
  30. data/lib/openai/internal/type/request_parameters.rb +42 -0
  31. data/lib/openai/internal/type/union.rb +252 -0
  32. data/lib/openai/internal/type/unknown.rb +75 -0
  33. data/lib/openai/internal/util.rb +911 -0
  34. data/lib/openai/internal.rb +20 -0
  35. data/lib/openai/models/all_models.rb +30 -0
  36. data/lib/openai/models/audio/speech_create_params.rb +159 -0
  37. data/lib/openai/models/audio/speech_model.rb +18 -0
  38. data/lib/openai/models/audio/transcription.rb +61 -0
  39. data/lib/openai/models/audio/transcription_create_params.rb +222 -0
  40. data/lib/openai/models/audio/transcription_create_response.rb +26 -0
  41. data/lib/openai/models/audio/transcription_include.rb +16 -0
  42. data/lib/openai/models/audio/transcription_segment.rb +96 -0
  43. data/lib/openai/models/audio/transcription_stream_event.rb +26 -0
  44. data/lib/openai/models/audio/transcription_text_delta_event.rb +75 -0
  45. data/lib/openai/models/audio/transcription_text_done_event.rb +76 -0
  46. data/lib/openai/models/audio/transcription_verbose.rb +53 -0
  47. data/lib/openai/models/audio/transcription_word.rb +34 -0
  48. data/lib/openai/models/audio/translation.rb +17 -0
  49. data/lib/openai/models/audio/translation_create_params.rb +98 -0
  50. data/lib/openai/models/audio/translation_create_response.rb +19 -0
  51. data/lib/openai/models/audio/translation_verbose.rb +42 -0
  52. data/lib/openai/models/audio_model.rb +16 -0
  53. data/lib/openai/models/audio_response_format.rb +21 -0
  54. data/lib/openai/models/auto_file_chunking_strategy_param.rb +19 -0
  55. data/lib/openai/models/batch.rb +213 -0
  56. data/lib/openai/models/batch_cancel_params.rb +14 -0
  57. data/lib/openai/models/batch_create_params.rb +93 -0
  58. data/lib/openai/models/batch_error.rb +40 -0
  59. data/lib/openai/models/batch_list_params.rb +37 -0
  60. data/lib/openai/models/batch_request_counts.rb +34 -0
  61. data/lib/openai/models/batch_retrieve_params.rb +14 -0
  62. data/lib/openai/models/beta/assistant.rb +218 -0
  63. data/lib/openai/models/beta/assistant_create_params.rb +372 -0
  64. data/lib/openai/models/beta/assistant_delete_params.rb +16 -0
  65. data/lib/openai/models/beta/assistant_deleted.rb +30 -0
  66. data/lib/openai/models/beta/assistant_list_params.rb +71 -0
  67. data/lib/openai/models/beta/assistant_response_format_option.rb +50 -0
  68. data/lib/openai/models/beta/assistant_retrieve_params.rb +16 -0
  69. data/lib/openai/models/beta/assistant_stream_event.rb +754 -0
  70. data/lib/openai/models/beta/assistant_tool.rb +22 -0
  71. data/lib/openai/models/beta/assistant_tool_choice.rb +42 -0
  72. data/lib/openai/models/beta/assistant_tool_choice_function.rb +18 -0
  73. data/lib/openai/models/beta/assistant_tool_choice_option.rb +42 -0
  74. data/lib/openai/models/beta/assistant_update_params.rb +345 -0
  75. data/lib/openai/models/beta/code_interpreter_tool.rb +18 -0
  76. data/lib/openai/models/beta/file_search_tool.rb +110 -0
  77. data/lib/openai/models/beta/function_tool.rb +25 -0
  78. data/lib/openai/models/beta/message_stream_event.rb +171 -0
  79. data/lib/openai/models/beta/run_step_stream_event.rb +225 -0
  80. data/lib/openai/models/beta/run_stream_event.rb +299 -0
  81. data/lib/openai/models/beta/thread.rb +122 -0
  82. data/lib/openai/models/beta/thread_create_and_run_params.rb +722 -0
  83. data/lib/openai/models/beta/thread_create_params.rb +391 -0
  84. data/lib/openai/models/beta/thread_delete_params.rb +16 -0
  85. data/lib/openai/models/beta/thread_deleted.rb +30 -0
  86. data/lib/openai/models/beta/thread_retrieve_params.rb +16 -0
  87. data/lib/openai/models/beta/thread_stream_event.rb +41 -0
  88. data/lib/openai/models/beta/thread_update_params.rb +101 -0
  89. data/lib/openai/models/beta/threads/annotation.rb +27 -0
  90. data/lib/openai/models/beta/threads/annotation_delta.rb +27 -0
  91. data/lib/openai/models/beta/threads/file_citation_annotation.rb +65 -0
  92. data/lib/openai/models/beta/threads/file_citation_delta_annotation.rb +81 -0
  93. data/lib/openai/models/beta/threads/file_path_annotation.rb +64 -0
  94. data/lib/openai/models/beta/threads/file_path_delta_annotation.rb +72 -0
  95. data/lib/openai/models/beta/threads/image_file.rb +49 -0
  96. data/lib/openai/models/beta/threads/image_file_content_block.rb +30 -0
  97. data/lib/openai/models/beta/threads/image_file_delta.rb +49 -0
  98. data/lib/openai/models/beta/threads/image_file_delta_block.rb +38 -0
  99. data/lib/openai/models/beta/threads/image_url.rb +48 -0
  100. data/lib/openai/models/beta/threads/image_url_content_block.rb +29 -0
  101. data/lib/openai/models/beta/threads/image_url_delta.rb +48 -0
  102. data/lib/openai/models/beta/threads/image_url_delta_block.rb +37 -0
  103. data/lib/openai/models/beta/threads/message.rb +251 -0
  104. data/lib/openai/models/beta/threads/message_content.rb +32 -0
  105. data/lib/openai/models/beta/threads/message_content_delta.rb +32 -0
  106. data/lib/openai/models/beta/threads/message_content_part_param.rb +29 -0
  107. data/lib/openai/models/beta/threads/message_create_params.rb +150 -0
  108. data/lib/openai/models/beta/threads/message_delete_params.rb +24 -0
  109. data/lib/openai/models/beta/threads/message_deleted.rb +32 -0
  110. data/lib/openai/models/beta/threads/message_delta.rb +44 -0
  111. data/lib/openai/models/beta/threads/message_delta_event.rb +39 -0
  112. data/lib/openai/models/beta/threads/message_list_params.rb +81 -0
  113. data/lib/openai/models/beta/threads/message_retrieve_params.rb +24 -0
  114. data/lib/openai/models/beta/threads/message_update_params.rb +41 -0
  115. data/lib/openai/models/beta/threads/refusal_content_block.rb +29 -0
  116. data/lib/openai/models/beta/threads/refusal_delta_block.rb +37 -0
  117. data/lib/openai/models/beta/threads/required_action_function_tool_call.rb +68 -0
  118. data/lib/openai/models/beta/threads/run.rb +475 -0
  119. data/lib/openai/models/beta/threads/run_cancel_params.rb +24 -0
  120. data/lib/openai/models/beta/threads/run_create_params.rb +443 -0
  121. data/lib/openai/models/beta/threads/run_list_params.rb +73 -0
  122. data/lib/openai/models/beta/threads/run_retrieve_params.rb +24 -0
  123. data/lib/openai/models/beta/threads/run_status.rb +29 -0
  124. data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +62 -0
  125. data/lib/openai/models/beta/threads/run_update_params.rb +41 -0
  126. data/lib/openai/models/beta/threads/runs/code_interpreter_logs.rb +40 -0
  127. data/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb +54 -0
  128. data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +158 -0
  129. data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +100 -0
  130. data/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +193 -0
  131. data/lib/openai/models/beta/threads/runs/file_search_tool_call_delta.rb +50 -0
  132. data/lib/openai/models/beta/threads/runs/function_tool_call.rb +78 -0
  133. data/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb +86 -0
  134. data/lib/openai/models/beta/threads/runs/message_creation_step_details.rb +44 -0
  135. data/lib/openai/models/beta/threads/runs/run_step.rb +278 -0
  136. data/lib/openai/models/beta/threads/runs/run_step_delta.rb +44 -0
  137. data/lib/openai/models/beta/threads/runs/run_step_delta_event.rb +43 -0
  138. data/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb +48 -0
  139. data/lib/openai/models/beta/threads/runs/run_step_include.rb +23 -0
  140. data/lib/openai/models/beta/threads/runs/step_list_params.rb +97 -0
  141. data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +52 -0
  142. data/lib/openai/models/beta/threads/runs/tool_call.rb +28 -0
  143. data/lib/openai/models/beta/threads/runs/tool_call_delta.rb +28 -0
  144. data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb +38 -0
  145. data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb +40 -0
  146. data/lib/openai/models/beta/threads/text.rb +30 -0
  147. data/lib/openai/models/beta/threads/text_content_block.rb +29 -0
  148. data/lib/openai/models/beta/threads/text_content_block_param.rb +30 -0
  149. data/lib/openai/models/beta/threads/text_delta.rb +28 -0
  150. data/lib/openai/models/beta/threads/text_delta_block.rb +37 -0
  151. data/lib/openai/models/chat/chat_completion.rb +225 -0
  152. data/lib/openai/models/chat/chat_completion_assistant_message_param.rb +178 -0
  153. data/lib/openai/models/chat/chat_completion_audio.rb +53 -0
  154. data/lib/openai/models/chat/chat_completion_audio_param.rb +110 -0
  155. data/lib/openai/models/chat/chat_completion_chunk.rb +408 -0
  156. data/lib/openai/models/chat/chat_completion_content_part.rb +85 -0
  157. data/lib/openai/models/chat/chat_completion_content_part_image.rb +69 -0
  158. data/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +68 -0
  159. data/lib/openai/models/chat/chat_completion_content_part_refusal.rb +28 -0
  160. data/lib/openai/models/chat/chat_completion_content_part_text.rb +31 -0
  161. data/lib/openai/models/chat/chat_completion_deleted.rb +37 -0
  162. data/lib/openai/models/chat/chat_completion_developer_message_param.rb +64 -0
  163. data/lib/openai/models/chat/chat_completion_function_call_option.rb +23 -0
  164. data/lib/openai/models/chat/chat_completion_function_message_param.rb +37 -0
  165. data/lib/openai/models/chat/chat_completion_message.rb +179 -0
  166. data/lib/openai/models/chat/chat_completion_message_param.rb +42 -0
  167. data/lib/openai/models/chat/chat_completion_message_tool_call.rb +71 -0
  168. data/lib/openai/models/chat/chat_completion_modality.rb +19 -0
  169. data/lib/openai/models/chat/chat_completion_named_tool_choice.rb +42 -0
  170. data/lib/openai/models/chat/chat_completion_prediction_content.rb +60 -0
  171. data/lib/openai/models/chat/chat_completion_reasoning_effort.rb +11 -0
  172. data/lib/openai/models/chat/chat_completion_role.rb +24 -0
  173. data/lib/openai/models/chat/chat_completion_store_message.rb +22 -0
  174. data/lib/openai/models/chat/chat_completion_stream_options.rb +31 -0
  175. data/lib/openai/models/chat/chat_completion_system_message_param.rb +64 -0
  176. data/lib/openai/models/chat/chat_completion_token_logprob.rb +90 -0
  177. data/lib/openai/models/chat/chat_completion_tool.rb +27 -0
  178. data/lib/openai/models/chat/chat_completion_tool_choice_option.rb +45 -0
  179. data/lib/openai/models/chat/chat_completion_tool_message_param.rb +56 -0
  180. data/lib/openai/models/chat/chat_completion_user_message_param.rb +63 -0
  181. data/lib/openai/models/chat/completion_create_params.rb +714 -0
  182. data/lib/openai/models/chat/completion_delete_params.rb +16 -0
  183. data/lib/openai/models/chat/completion_list_params.rb +74 -0
  184. data/lib/openai/models/chat/completion_retrieve_params.rb +16 -0
  185. data/lib/openai/models/chat/completion_update_params.rb +32 -0
  186. data/lib/openai/models/chat/completions/message_list_params.rb +58 -0
  187. data/lib/openai/models/chat_model.rb +67 -0
  188. data/lib/openai/models/comparison_filter.rb +87 -0
  189. data/lib/openai/models/completion.rb +76 -0
  190. data/lib/openai/models/completion_choice.rb +89 -0
  191. data/lib/openai/models/completion_create_params.rb +306 -0
  192. data/lib/openai/models/completion_usage.rb +117 -0
  193. data/lib/openai/models/compound_filter.rb +57 -0
  194. data/lib/openai/models/container_create_params.rb +75 -0
  195. data/lib/openai/models/container_create_response.rb +98 -0
  196. data/lib/openai/models/container_delete_params.rb +14 -0
  197. data/lib/openai/models/container_list_params.rb +58 -0
  198. data/lib/openai/models/container_list_response.rb +98 -0
  199. data/lib/openai/models/container_retrieve_params.rb +14 -0
  200. data/lib/openai/models/container_retrieve_response.rb +98 -0
  201. data/lib/openai/models/containers/file_create_params.rb +35 -0
  202. data/lib/openai/models/containers/file_create_response.rb +67 -0
  203. data/lib/openai/models/containers/file_delete_params.rb +22 -0
  204. data/lib/openai/models/containers/file_list_params.rb +60 -0
  205. data/lib/openai/models/containers/file_list_response.rb +67 -0
  206. data/lib/openai/models/containers/file_retrieve_params.rb +22 -0
  207. data/lib/openai/models/containers/file_retrieve_response.rb +67 -0
  208. data/lib/openai/models/containers/files/content_retrieve_params.rb +24 -0
  209. data/lib/openai/models/create_embedding_response.rb +63 -0
  210. data/lib/openai/models/embedding.rb +39 -0
  211. data/lib/openai/models/embedding_create_params.rb +139 -0
  212. data/lib/openai/models/embedding_model.rb +16 -0
  213. data/lib/openai/models/error_object.rb +33 -0
  214. data/lib/openai/models/eval_create_params.rb +451 -0
  215. data/lib/openai/models/eval_create_response.rb +214 -0
  216. data/lib/openai/models/eval_custom_data_source_config.rb +35 -0
  217. data/lib/openai/models/eval_delete_params.rb +14 -0
  218. data/lib/openai/models/eval_delete_response.rb +28 -0
  219. data/lib/openai/models/eval_list_params.rb +75 -0
  220. data/lib/openai/models/eval_list_response.rb +214 -0
  221. data/lib/openai/models/eval_retrieve_params.rb +14 -0
  222. data/lib/openai/models/eval_retrieve_response.rb +214 -0
  223. data/lib/openai/models/eval_stored_completions_data_source_config.rb +44 -0
  224. data/lib/openai/models/eval_update_params.rb +38 -0
  225. data/lib/openai/models/eval_update_response.rb +214 -0
  226. data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +465 -0
  227. data/lib/openai/models/evals/create_eval_jsonl_run_data_source.rb +102 -0
  228. data/lib/openai/models/evals/eval_api_error.rb +30 -0
  229. data/lib/openai/models/evals/run_cancel_params.rb +22 -0
  230. data/lib/openai/models/evals/run_cancel_response.rb +758 -0
  231. data/lib/openai/models/evals/run_create_params.rb +602 -0
  232. data/lib/openai/models/evals/run_create_response.rb +758 -0
  233. data/lib/openai/models/evals/run_delete_params.rb +22 -0
  234. data/lib/openai/models/evals/run_delete_response.rb +30 -0
  235. data/lib/openai/models/evals/run_list_params.rb +80 -0
  236. data/lib/openai/models/evals/run_list_response.rb +758 -0
  237. data/lib/openai/models/evals/run_retrieve_params.rb +22 -0
  238. data/lib/openai/models/evals/run_retrieve_response.rb +762 -0
  239. data/lib/openai/models/evals/runs/output_item_list_params.rb +86 -0
  240. data/lib/openai/models/evals/runs/output_item_list_response.rb +265 -0
  241. data/lib/openai/models/evals/runs/output_item_retrieve_params.rb +30 -0
  242. data/lib/openai/models/evals/runs/output_item_retrieve_response.rb +266 -0
  243. data/lib/openai/models/file_chunking_strategy.rb +20 -0
  244. data/lib/openai/models/file_chunking_strategy_param.rb +22 -0
  245. data/lib/openai/models/file_content.rb +7 -0
  246. data/lib/openai/models/file_content_params.rb +14 -0
  247. data/lib/openai/models/file_create_params.rb +36 -0
  248. data/lib/openai/models/file_delete_params.rb +14 -0
  249. data/lib/openai/models/file_deleted.rb +28 -0
  250. data/lib/openai/models/file_list_params.rb +66 -0
  251. data/lib/openai/models/file_object.rb +131 -0
  252. data/lib/openai/models/file_purpose.rb +23 -0
  253. data/lib/openai/models/file_retrieve_params.rb +14 -0
  254. data/lib/openai/models/fine_tuning/alpha/grader_run_params.rb +89 -0
  255. data/lib/openai/models/fine_tuning/alpha/grader_run_response.rb +175 -0
  256. data/lib/openai/models/fine_tuning/alpha/grader_validate_params.rb +49 -0
  257. data/lib/openai/models/fine_tuning/alpha/grader_validate_response.rb +46 -0
  258. data/lib/openai/models/fine_tuning/checkpoints/permission_create_params.rb +26 -0
  259. data/lib/openai/models/fine_tuning/checkpoints/permission_create_response.rb +48 -0
  260. data/lib/openai/models/fine_tuning/checkpoints/permission_delete_params.rb +24 -0
  261. data/lib/openai/models/fine_tuning/checkpoints/permission_delete_response.rb +37 -0
  262. data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rb +61 -0
  263. data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rb +83 -0
  264. data/lib/openai/models/fine_tuning/dpo_hyperparameters.rb +112 -0
  265. data/lib/openai/models/fine_tuning/dpo_method.rb +20 -0
  266. data/lib/openai/models/fine_tuning/fine_tuning_job.rb +384 -0
  267. data/lib/openai/models/fine_tuning/fine_tuning_job_event.rb +98 -0
  268. data/lib/openai/models/fine_tuning/fine_tuning_job_integration.rb +11 -0
  269. data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rb +57 -0
  270. data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rb +35 -0
  271. data/lib/openai/models/fine_tuning/job_cancel_params.rb +16 -0
  272. data/lib/openai/models/fine_tuning/job_create_params.rb +377 -0
  273. data/lib/openai/models/fine_tuning/job_list_events_params.rb +32 -0
  274. data/lib/openai/models/fine_tuning/job_list_params.rb +44 -0
  275. data/lib/openai/models/fine_tuning/job_pause_params.rb +16 -0
  276. data/lib/openai/models/fine_tuning/job_resume_params.rb +16 -0
  277. data/lib/openai/models/fine_tuning/job_retrieve_params.rb +16 -0
  278. data/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb +34 -0
  279. data/lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb +121 -0
  280. data/lib/openai/models/fine_tuning/reinforcement_hyperparameters.rb +181 -0
  281. data/lib/openai/models/fine_tuning/reinforcement_method.rb +53 -0
  282. data/lib/openai/models/fine_tuning/supervised_hyperparameters.rb +88 -0
  283. data/lib/openai/models/fine_tuning/supervised_method.rb +20 -0
  284. data/lib/openai/models/function_definition.rb +55 -0
  285. data/lib/openai/models/function_parameters.rb +8 -0
  286. data/lib/openai/models/graders/label_model_grader.rb +171 -0
  287. data/lib/openai/models/graders/multi_grader.rb +71 -0
  288. data/lib/openai/models/graders/python_grader.rb +46 -0
  289. data/lib/openai/models/graders/score_model_grader.rb +171 -0
  290. data/lib/openai/models/graders/string_check_grader.rb +70 -0
  291. data/lib/openai/models/graders/text_similarity_grader.rb +80 -0
  292. data/lib/openai/models/image.rb +41 -0
  293. data/lib/openai/models/image_create_variation_params.rb +112 -0
  294. data/lib/openai/models/image_edit_params.rb +225 -0
  295. data/lib/openai/models/image_generate_params.rb +272 -0
  296. data/lib/openai/models/image_model.rb +16 -0
  297. data/lib/openai/models/images_response.rb +98 -0
  298. data/lib/openai/models/metadata.rb +8 -0
  299. data/lib/openai/models/model.rb +43 -0
  300. data/lib/openai/models/model_delete_params.rb +14 -0
  301. data/lib/openai/models/model_deleted.rb +28 -0
  302. data/lib/openai/models/model_list_params.rb +14 -0
  303. data/lib/openai/models/model_retrieve_params.rb +14 -0
  304. data/lib/openai/models/moderation.rb +563 -0
  305. data/lib/openai/models/moderation_create_params.rb +80 -0
  306. data/lib/openai/models/moderation_create_response.rb +35 -0
  307. data/lib/openai/models/moderation_image_url_input.rb +40 -0
  308. data/lib/openai/models/moderation_model.rb +17 -0
  309. data/lib/openai/models/moderation_multi_modal_input.rb +21 -0
  310. data/lib/openai/models/moderation_text_input.rb +26 -0
  311. data/lib/openai/models/other_file_chunking_strategy_object.rb +20 -0
  312. data/lib/openai/models/reasoning.rb +89 -0
  313. data/lib/openai/models/reasoning_effort.rb +22 -0
  314. data/lib/openai/models/response_format_json_object.rb +20 -0
  315. data/lib/openai/models/response_format_json_schema.rb +85 -0
  316. data/lib/openai/models/response_format_text.rb +18 -0
  317. data/lib/openai/models/responses/computer_tool.rb +61 -0
  318. data/lib/openai/models/responses/easy_input_message.rb +91 -0
  319. data/lib/openai/models/responses/file_search_tool.rb +114 -0
  320. data/lib/openai/models/responses/function_tool.rb +63 -0
  321. data/lib/openai/models/responses/input_item_list_params.rb +78 -0
  322. data/lib/openai/models/responses/response.rb +393 -0
  323. data/lib/openai/models/responses/response_audio_delta_event.rb +39 -0
  324. data/lib/openai/models/responses/response_audio_done_event.rb +31 -0
  325. data/lib/openai/models/responses/response_audio_transcript_delta_event.rb +39 -0
  326. data/lib/openai/models/responses/response_audio_transcript_done_event.rb +31 -0
  327. data/lib/openai/models/responses/response_cancel_params.rb +16 -0
  328. data/lib/openai/models/responses/response_code_interpreter_call_code_delta_event.rb +48 -0
  329. data/lib/openai/models/responses/response_code_interpreter_call_code_done_event.rb +48 -0
  330. data/lib/openai/models/responses/response_code_interpreter_call_completed_event.rb +48 -0
  331. data/lib/openai/models/responses/response_code_interpreter_call_in_progress_event.rb +48 -0
  332. data/lib/openai/models/responses/response_code_interpreter_call_interpreting_event.rb +48 -0
  333. data/lib/openai/models/responses/response_code_interpreter_tool_call.rb +171 -0
  334. data/lib/openai/models/responses/response_completed_event.rb +39 -0
  335. data/lib/openai/models/responses/response_computer_tool_call.rb +493 -0
  336. data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +111 -0
  337. data/lib/openai/models/responses/response_computer_tool_call_output_screenshot.rb +41 -0
  338. data/lib/openai/models/responses/response_content.rb +30 -0
  339. data/lib/openai/models/responses/response_content_part_added_event.rb +81 -0
  340. data/lib/openai/models/responses/response_content_part_done_event.rb +81 -0
  341. data/lib/openai/models/responses/response_create_params.rb +369 -0
  342. data/lib/openai/models/responses/response_created_event.rb +39 -0
  343. data/lib/openai/models/responses/response_delete_params.rb +16 -0
  344. data/lib/openai/models/responses/response_error.rb +60 -0
  345. data/lib/openai/models/responses/response_error_event.rb +55 -0
  346. data/lib/openai/models/responses/response_failed_event.rb +39 -0
  347. data/lib/openai/models/responses/response_file_search_call_completed_event.rb +48 -0
  348. data/lib/openai/models/responses/response_file_search_call_in_progress_event.rb +48 -0
  349. data/lib/openai/models/responses/response_file_search_call_searching_event.rb +48 -0
  350. data/lib/openai/models/responses/response_file_search_tool_call.rb +147 -0
  351. data/lib/openai/models/responses/response_format_text_config.rb +48 -0
  352. data/lib/openai/models/responses/response_format_text_json_schema_config.rb +70 -0
  353. data/lib/openai/models/responses/response_function_call_arguments_delta_event.rb +56 -0
  354. data/lib/openai/models/responses/response_function_call_arguments_done_event.rb +51 -0
  355. data/lib/openai/models/responses/response_function_tool_call.rb +87 -0
  356. data/lib/openai/models/responses/response_function_tool_call_item.rb +25 -0
  357. data/lib/openai/models/responses/response_function_tool_call_output_item.rb +70 -0
  358. data/lib/openai/models/responses/response_function_web_search.rb +56 -0
  359. data/lib/openai/models/responses/response_image_gen_call_completed_event.rb +45 -0
  360. data/lib/openai/models/responses/response_image_gen_call_generating_event.rb +45 -0
  361. data/lib/openai/models/responses/response_image_gen_call_in_progress_event.rb +44 -0
  362. data/lib/openai/models/responses/response_image_gen_call_partial_image_event.rb +65 -0
  363. data/lib/openai/models/responses/response_in_progress_event.rb +39 -0
  364. data/lib/openai/models/responses/response_includable.rb +32 -0
  365. data/lib/openai/models/responses/response_incomplete_event.rb +39 -0
  366. data/lib/openai/models/responses/response_input.rb +10 -0
  367. data/lib/openai/models/responses/response_input_audio.rb +52 -0
  368. data/lib/openai/models/responses/response_input_content.rb +26 -0
  369. data/lib/openai/models/responses/response_input_file.rb +47 -0
  370. data/lib/openai/models/responses/response_input_image.rb +65 -0
  371. data/lib/openai/models/responses/response_input_item.rb +876 -0
  372. data/lib/openai/models/responses/response_input_message_content_list.rb +11 -0
  373. data/lib/openai/models/responses/response_input_message_item.rb +99 -0
  374. data/lib/openai/models/responses/response_input_text.rb +28 -0
  375. data/lib/openai/models/responses/response_item.rb +549 -0
  376. data/lib/openai/models/responses/response_item_list.rb +54 -0
  377. data/lib/openai/models/responses/response_mcp_call_arguments_delta_event.rb +53 -0
  378. data/lib/openai/models/responses/response_mcp_call_arguments_done_event.rb +52 -0
  379. data/lib/openai/models/responses/response_mcp_call_completed_event.rb +28 -0
  380. data/lib/openai/models/responses/response_mcp_call_failed_event.rb +28 -0
  381. data/lib/openai/models/responses/response_mcp_call_in_progress_event.rb +44 -0
  382. data/lib/openai/models/responses/response_mcp_list_tools_completed_event.rb +28 -0
  383. data/lib/openai/models/responses/response_mcp_list_tools_failed_event.rb +28 -0
  384. data/lib/openai/models/responses/response_mcp_list_tools_in_progress_event.rb +29 -0
  385. data/lib/openai/models/responses/response_output_audio.rb +39 -0
  386. data/lib/openai/models/responses/response_output_item.rb +442 -0
  387. data/lib/openai/models/responses/response_output_item_added_event.rb +47 -0
  388. data/lib/openai/models/responses/response_output_item_done_event.rb +47 -0
  389. data/lib/openai/models/responses/response_output_message.rb +90 -0
  390. data/lib/openai/models/responses/response_output_refusal.rb +28 -0
  391. data/lib/openai/models/responses/response_output_text.rb +171 -0
  392. data/lib/openai/models/responses/response_output_text_annotation_added_event.rb +68 -0
  393. data/lib/openai/models/responses/response_queued_event.rb +36 -0
  394. data/lib/openai/models/responses/response_reasoning_delta_event.rb +60 -0
  395. data/lib/openai/models/responses/response_reasoning_done_event.rb +60 -0
  396. data/lib/openai/models/responses/response_reasoning_item.rb +98 -0
  397. data/lib/openai/models/responses/response_reasoning_summary_delta_event.rb +65 -0
  398. data/lib/openai/models/responses/response_reasoning_summary_done_event.rb +60 -0
  399. data/lib/openai/models/responses/response_reasoning_summary_part_added_event.rb +86 -0
  400. data/lib/openai/models/responses/response_reasoning_summary_part_done_event.rb +86 -0
  401. data/lib/openai/models/responses/response_reasoning_summary_text_delta_event.rb +64 -0
  402. data/lib/openai/models/responses/response_reasoning_summary_text_done_event.rb +64 -0
  403. data/lib/openai/models/responses/response_refusal_delta_event.rb +63 -0
  404. data/lib/openai/models/responses/response_refusal_done_event.rb +63 -0
  405. data/lib/openai/models/responses/response_retrieve_params.rb +28 -0
  406. data/lib/openai/models/responses/response_status.rb +23 -0
  407. data/lib/openai/models/responses/response_stream_event.rb +217 -0
  408. data/lib/openai/models/responses/response_text_config.rb +39 -0
  409. data/lib/openai/models/responses/response_text_delta_event.rb +63 -0
  410. data/lib/openai/models/responses/response_text_done_event.rb +63 -0
  411. data/lib/openai/models/responses/response_usage.rb +85 -0
  412. data/lib/openai/models/responses/response_web_search_call_completed_event.rb +48 -0
  413. data/lib/openai/models/responses/response_web_search_call_in_progress_event.rb +48 -0
  414. data/lib/openai/models/responses/response_web_search_call_searching_event.rb +48 -0
  415. data/lib/openai/models/responses/tool.rb +512 -0
  416. data/lib/openai/models/responses/tool_choice_function.rb +28 -0
  417. data/lib/openai/models/responses/tool_choice_options.rb +26 -0
  418. data/lib/openai/models/responses/tool_choice_types.rb +62 -0
  419. data/lib/openai/models/responses/web_search_tool.rb +123 -0
  420. data/lib/openai/models/responses_model.rb +30 -0
  421. data/lib/openai/models/static_file_chunking_strategy.rb +30 -0
  422. data/lib/openai/models/static_file_chunking_strategy_object.rb +23 -0
  423. data/lib/openai/models/static_file_chunking_strategy_object_param.rb +25 -0
  424. data/lib/openai/models/upload.rb +103 -0
  425. data/lib/openai/models/upload_cancel_params.rb +14 -0
  426. data/lib/openai/models/upload_complete_params.rb +34 -0
  427. data/lib/openai/models/upload_create_params.rb +55 -0
  428. data/lib/openai/models/uploads/part_create_params.rb +27 -0
  429. data/lib/openai/models/uploads/upload_part.rb +47 -0
  430. data/lib/openai/models/vector_store.rb +195 -0
  431. data/lib/openai/models/vector_store_create_params.rb +90 -0
  432. data/lib/openai/models/vector_store_delete_params.rb +14 -0
  433. data/lib/openai/models/vector_store_deleted.rb +28 -0
  434. data/lib/openai/models/vector_store_list_params.rb +69 -0
  435. data/lib/openai/models/vector_store_retrieve_params.rb +14 -0
  436. data/lib/openai/models/vector_store_search_params.rb +116 -0
  437. data/lib/openai/models/vector_store_search_response.rb +103 -0
  438. data/lib/openai/models/vector_store_update_params.rb +71 -0
  439. data/lib/openai/models/vector_stores/file_batch_cancel_params.rb +22 -0
  440. data/lib/openai/models/vector_stores/file_batch_create_params.rb +67 -0
  441. data/lib/openai/models/vector_stores/file_batch_list_files_params.rb +99 -0
  442. data/lib/openai/models/vector_stores/file_batch_retrieve_params.rb +22 -0
  443. data/lib/openai/models/vector_stores/file_content_params.rb +22 -0
  444. data/lib/openai/models/vector_stores/file_content_response.rb +27 -0
  445. data/lib/openai/models/vector_stores/file_create_params.rb +67 -0
  446. data/lib/openai/models/vector_stores/file_delete_params.rb +22 -0
  447. data/lib/openai/models/vector_stores/file_list_params.rb +92 -0
  448. data/lib/openai/models/vector_stores/file_retrieve_params.rb +22 -0
  449. data/lib/openai/models/vector_stores/file_update_params.rb +55 -0
  450. data/lib/openai/models/vector_stores/vector_store_file.rb +172 -0
  451. data/lib/openai/models/vector_stores/vector_store_file_batch.rb +130 -0
  452. data/lib/openai/models/vector_stores/vector_store_file_deleted.rb +32 -0
  453. data/lib/openai/models.rb +237 -0
  454. data/lib/openai/request_options.rb +77 -0
  455. data/lib/openai/resources/audio/speech.rb +52 -0
  456. data/lib/openai/resources/audio/transcriptions.rb +116 -0
  457. data/lib/openai/resources/audio/translations.rb +50 -0
  458. data/lib/openai/resources/audio.rb +26 -0
  459. data/lib/openai/resources/batches.rb +109 -0
  460. data/lib/openai/resources/beta/assistants.rb +180 -0
  461. data/lib/openai/resources/beta/threads/messages.rb +177 -0
  462. data/lib/openai/resources/beta/threads/runs/steps.rb +101 -0
  463. data/lib/openai/resources/beta/threads/runs.rb +374 -0
  464. data/lib/openai/resources/beta/threads.rb +248 -0
  465. data/lib/openai/resources/beta.rb +22 -0
  466. data/lib/openai/resources/chat/completions/messages.rb +51 -0
  467. data/lib/openai/resources/chat/completions.rb +412 -0
  468. data/lib/openai/resources/chat.rb +18 -0
  469. data/lib/openai/resources/completions.rb +143 -0
  470. data/lib/openai/resources/containers/files/content.rb +43 -0
  471. data/lib/openai/resources/containers/files.rb +135 -0
  472. data/lib/openai/resources/containers.rb +113 -0
  473. data/lib/openai/resources/embeddings.rb +47 -0
  474. data/lib/openai/resources/evals/runs/output_items.rb +91 -0
  475. data/lib/openai/resources/evals/runs.rb +168 -0
  476. data/lib/openai/resources/evals.rb +155 -0
  477. data/lib/openai/resources/files.rb +155 -0
  478. data/lib/openai/resources/fine_tuning/alpha/graders.rb +66 -0
  479. data/lib/openai/resources/fine_tuning/alpha.rb +20 -0
  480. data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb +125 -0
  481. data/lib/openai/resources/fine_tuning/checkpoints.rb +20 -0
  482. data/lib/openai/resources/fine_tuning/jobs/checkpoints.rb +48 -0
  483. data/lib/openai/resources/fine_tuning/jobs.rb +221 -0
  484. data/lib/openai/resources/fine_tuning/methods.rb +16 -0
  485. data/lib/openai/resources/fine_tuning.rb +30 -0
  486. data/lib/openai/resources/graders/grader_models.rb +16 -0
  487. data/lib/openai/resources/graders.rb +18 -0
  488. data/lib/openai/resources/images.rb +143 -0
  489. data/lib/openai/resources/models.rb +76 -0
  490. data/lib/openai/resources/moderations.rb +42 -0
  491. data/lib/openai/resources/responses/input_items.rb +52 -0
  492. data/lib/openai/resources/responses.rb +323 -0
  493. data/lib/openai/resources/uploads/parts.rb +54 -0
  494. data/lib/openai/resources/uploads.rb +125 -0
  495. data/lib/openai/resources/vector_stores/file_batches.rb +144 -0
  496. data/lib/openai/resources/vector_stores/files.rb +203 -0
  497. data/lib/openai/resources/vector_stores.rb +195 -0
  498. data/lib/openai/structured_output.rb +10 -0
  499. data/lib/openai/version.rb +3 -1
  500. data/lib/openai.rb +520 -7
  501. data/manifest.yaml +15 -0
  502. data/rbi/openai/client.rbi +109 -0
  503. data/rbi/openai/errors.rbi +189 -0
  504. data/rbi/openai/file_part.rbi +37 -0
  505. data/rbi/openai/helpers/structured_output/array_of.rbi +16 -0
  506. data/rbi/openai/helpers/structured_output/base_model.rbi +22 -0
  507. data/rbi/openai/helpers/structured_output/boolean.rbi +11 -0
  508. data/rbi/openai/helpers/structured_output/enum_of.rbi +30 -0
  509. data/rbi/openai/helpers/structured_output/json_schema_converter.rbi +83 -0
  510. data/rbi/openai/helpers/structured_output/union_of.rbi +23 -0
  511. data/rbi/openai/helpers/structured_output.rbi +16 -0
  512. data/rbi/openai/internal/cursor_page.rbi +22 -0
  513. data/rbi/openai/internal/page.rbi +22 -0
  514. data/rbi/openai/internal/stream.rbi +18 -0
  515. data/rbi/openai/internal/transport/base_client.rbi +309 -0
  516. data/rbi/openai/internal/transport/pooled_net_requester.rbi +78 -0
  517. data/rbi/openai/internal/type/array_of.rbi +104 -0
  518. data/rbi/openai/internal/type/base_model.rbi +295 -0
  519. data/rbi/openai/internal/type/base_page.rbi +42 -0
  520. data/rbi/openai/internal/type/base_stream.rbi +68 -0
  521. data/rbi/openai/internal/type/boolean.rbi +56 -0
  522. data/rbi/openai/internal/type/converter.rbi +158 -0
  523. data/rbi/openai/internal/type/enum.rbi +82 -0
  524. data/rbi/openai/internal/type/file_input.rbi +59 -0
  525. data/rbi/openai/internal/type/hash_of.rbi +104 -0
  526. data/rbi/openai/internal/type/request_parameters.rbi +29 -0
  527. data/rbi/openai/internal/type/union.rbi +116 -0
  528. data/rbi/openai/internal/type/unknown.rbi +56 -0
  529. data/rbi/openai/internal/util.rbi +482 -0
  530. data/rbi/openai/internal.rbi +16 -0
  531. data/rbi/openai/models/all_models.rbi +56 -0
  532. data/rbi/openai/models/audio/speech_create_params.rbi +273 -0
  533. data/rbi/openai/models/audio/speech_model.rbi +26 -0
  534. data/rbi/openai/models/audio/transcription.rbi +118 -0
  535. data/rbi/openai/models/audio/transcription_create_params.rbi +424 -0
  536. data/rbi/openai/models/audio/transcription_create_response.rbi +31 -0
  537. data/rbi/openai/models/audio/transcription_include.rbi +26 -0
  538. data/rbi/openai/models/audio/transcription_segment.rbi +120 -0
  539. data/rbi/openai/models/audio/transcription_stream_event.rbi +31 -0
  540. data/rbi/openai/models/audio/transcription_text_delta_event.rbi +142 -0
  541. data/rbi/openai/models/audio/transcription_text_done_event.rbi +144 -0
  542. data/rbi/openai/models/audio/transcription_verbose.rbi +90 -0
  543. data/rbi/openai/models/audio/transcription_word.rbi +45 -0
  544. data/rbi/openai/models/audio/translation.rbi +25 -0
  545. data/rbi/openai/models/audio/translation_create_params.rbi +190 -0
  546. data/rbi/openai/models/audio/translation_create_response.rbi +24 -0
  547. data/rbi/openai/models/audio/translation_verbose.rbi +72 -0
  548. data/rbi/openai/models/audio_model.rbi +22 -0
  549. data/rbi/openai/models/audio_response_format.rbi +28 -0
  550. data/rbi/openai/models/auto_file_chunking_strategy_param.rbi +32 -0
  551. data/rbi/openai/models/batch.rbi +290 -0
  552. data/rbi/openai/models/batch_cancel_params.rbi +27 -0
  553. data/rbi/openai/models/batch_create_params.rbi +170 -0
  554. data/rbi/openai/models/batch_error.rbi +65 -0
  555. data/rbi/openai/models/batch_list_params.rbi +65 -0
  556. data/rbi/openai/models/batch_request_counts.rbi +48 -0
  557. data/rbi/openai/models/batch_retrieve_params.rbi +27 -0
  558. data/rbi/openai/models/beta/assistant.rbi +384 -0
  559. data/rbi/openai/models/beta/assistant_create_params.rbi +760 -0
  560. data/rbi/openai/models/beta/assistant_delete_params.rbi +32 -0
  561. data/rbi/openai/models/beta/assistant_deleted.rbi +37 -0
  562. data/rbi/openai/models/beta/assistant_list_params.rbi +126 -0
  563. data/rbi/openai/models/beta/assistant_response_format_option.rbi +49 -0
  564. data/rbi/openai/models/beta/assistant_retrieve_params.rbi +32 -0
  565. data/rbi/openai/models/beta/assistant_stream_event.rbi +1170 -0
  566. data/rbi/openai/models/beta/assistant_tool.rbi +26 -0
  567. data/rbi/openai/models/beta/assistant_tool_choice.rbi +89 -0
  568. data/rbi/openai/models/beta/assistant_tool_choice_function.rbi +32 -0
  569. data/rbi/openai/models/beta/assistant_tool_choice_option.rbi +74 -0
  570. data/rbi/openai/models/beta/assistant_update_params.rbi +682 -0
  571. data/rbi/openai/models/beta/code_interpreter_tool.rbi +29 -0
  572. data/rbi/openai/models/beta/file_search_tool.rbi +246 -0
  573. data/rbi/openai/models/beta/function_tool.rbi +45 -0
  574. data/rbi/openai/models/beta/message_stream_event.rbi +263 -0
  575. data/rbi/openai/models/beta/run_step_stream_event.rbi +362 -0
  576. data/rbi/openai/models/beta/run_stream_event.rbi +485 -0
  577. data/rbi/openai/models/beta/thread.rbi +233 -0
  578. data/rbi/openai/models/beta/thread_create_and_run_params.rbi +1535 -0
  579. data/rbi/openai/models/beta/thread_create_params.rbi +847 -0
  580. data/rbi/openai/models/beta/thread_delete_params.rbi +29 -0
  581. data/rbi/openai/models/beta/thread_deleted.rbi +37 -0
  582. data/rbi/openai/models/beta/thread_retrieve_params.rbi +29 -0
  583. data/rbi/openai/models/beta/thread_stream_event.rbi +60 -0
  584. data/rbi/openai/models/beta/thread_update_params.rbi +225 -0
  585. data/rbi/openai/models/beta/threads/annotation.rbi +32 -0
  586. data/rbi/openai/models/beta/threads/annotation_delta.rbi +32 -0
  587. data/rbi/openai/models/beta/threads/file_citation_annotation.rbi +110 -0
  588. data/rbi/openai/models/beta/threads/file_citation_delta_annotation.rbi +145 -0
  589. data/rbi/openai/models/beta/threads/file_path_annotation.rbi +106 -0
  590. data/rbi/openai/models/beta/threads/file_path_delta_annotation.rbi +133 -0
  591. data/rbi/openai/models/beta/threads/image_file.rbi +102 -0
  592. data/rbi/openai/models/beta/threads/image_file_content_block.rbi +54 -0
  593. data/rbi/openai/models/beta/threads/image_file_delta.rbi +113 -0
  594. data/rbi/openai/models/beta/threads/image_file_delta_block.rbi +67 -0
  595. data/rbi/openai/models/beta/threads/image_url.rbi +97 -0
  596. data/rbi/openai/models/beta/threads/image_url_content_block.rbi +53 -0
  597. data/rbi/openai/models/beta/threads/image_url_delta.rbi +111 -0
  598. data/rbi/openai/models/beta/threads/image_url_delta_block.rbi +64 -0
  599. data/rbi/openai/models/beta/threads/message.rbi +486 -0
  600. data/rbi/openai/models/beta/threads/message_content.rbi +33 -0
  601. data/rbi/openai/models/beta/threads/message_content_delta.rbi +33 -0
  602. data/rbi/openai/models/beta/threads/message_content_part_param.rbi +32 -0
  603. data/rbi/openai/models/beta/threads/message_create_params.rbi +318 -0
  604. data/rbi/openai/models/beta/threads/message_delete_params.rbi +42 -0
  605. data/rbi/openai/models/beta/threads/message_deleted.rbi +44 -0
  606. data/rbi/openai/models/beta/threads/message_delta.rbi +128 -0
  607. data/rbi/openai/models/beta/threads/message_delta_event.rbi +67 -0
  608. data/rbi/openai/models/beta/threads/message_list_params.rbi +157 -0
  609. data/rbi/openai/models/beta/threads/message_retrieve_params.rbi +42 -0
  610. data/rbi/openai/models/beta/threads/message_update_params.rbi +66 -0
  611. data/rbi/openai/models/beta/threads/refusal_content_block.rbi +41 -0
  612. data/rbi/openai/models/beta/threads/refusal_delta_block.rbi +54 -0
  613. data/rbi/openai/models/beta/threads/required_action_function_tool_call.rbi +117 -0
  614. data/rbi/openai/models/beta/threads/run.rbi +870 -0
  615. data/rbi/openai/models/beta/threads/run_cancel_params.rbi +42 -0
  616. data/rbi/openai/models/beta/threads/run_create_params.rbi +882 -0
  617. data/rbi/openai/models/beta/threads/run_list_params.rbi +143 -0
  618. data/rbi/openai/models/beta/threads/run_retrieve_params.rbi +42 -0
  619. data/rbi/openai/models/beta/threads/run_status.rbi +50 -0
  620. data/rbi/openai/models/beta/threads/run_submit_tool_outputs_params.rbi +111 -0
  621. data/rbi/openai/models/beta/threads/run_update_params.rbi +66 -0
  622. data/rbi/openai/models/beta/threads/runs/code_interpreter_logs.rbi +58 -0
  623. data/rbi/openai/models/beta/threads/runs/code_interpreter_output_image.rbi +106 -0
  624. data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call.rbi +281 -0
  625. data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbi +196 -0
  626. data/rbi/openai/models/beta/threads/runs/file_search_tool_call.rbi +432 -0
  627. data/rbi/openai/models/beta/threads/runs/file_search_tool_call_delta.rbi +75 -0
  628. data/rbi/openai/models/beta/threads/runs/function_tool_call.rbi +128 -0
  629. data/rbi/openai/models/beta/threads/runs/function_tool_call_delta.rbi +149 -0
  630. data/rbi/openai/models/beta/threads/runs/message_creation_step_details.rbi +92 -0
  631. data/rbi/openai/models/beta/threads/runs/run_step.rbi +485 -0
  632. data/rbi/openai/models/beta/threads/runs/run_step_delta.rbi +94 -0
  633. data/rbi/openai/models/beta/threads/runs/run_step_delta_event.rbi +73 -0
  634. data/rbi/openai/models/beta/threads/runs/run_step_delta_message_delta.rbi +99 -0
  635. data/rbi/openai/models/beta/threads/runs/run_step_include.rbi +39 -0
  636. data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +203 -0
  637. data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +100 -0
  638. data/rbi/openai/models/beta/threads/runs/tool_call.rbi +33 -0
  639. data/rbi/openai/models/beta/threads/runs/tool_call_delta.rbi +33 -0
  640. data/rbi/openai/models/beta/threads/runs/tool_call_delta_object.rbi +89 -0
  641. data/rbi/openai/models/beta/threads/runs/tool_calls_step_details.rbi +69 -0
  642. data/rbi/openai/models/beta/threads/text.rbi +54 -0
  643. data/rbi/openai/models/beta/threads/text_content_block.rbi +51 -0
  644. data/rbi/openai/models/beta/threads/text_content_block_param.rbi +41 -0
  645. data/rbi/openai/models/beta/threads/text_delta.rbi +76 -0
  646. data/rbi/openai/models/beta/threads/text_delta_block.rbi +62 -0
  647. data/rbi/openai/models/chat/chat_completion.rbi +419 -0
  648. data/rbi/openai/models/chat/chat_completion_assistant_message_param.rbi +299 -0
  649. data/rbi/openai/models/chat/chat_completion_audio.rbi +72 -0
  650. data/rbi/openai/models/chat/chat_completion_audio_param.rbi +213 -0
  651. data/rbi/openai/models/chat/chat_completion_chunk.rbi +841 -0
  652. data/rbi/openai/models/chat/chat_completion_content_part.rbi +141 -0
  653. data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +162 -0
  654. data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +148 -0
  655. data/rbi/openai/models/chat/chat_completion_content_part_refusal.rbi +40 -0
  656. data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +42 -0
  657. data/rbi/openai/models/chat/chat_completion_deleted.rbi +52 -0
  658. data/rbi/openai/models/chat/chat_completion_developer_message_param.rbi +106 -0
  659. data/rbi/openai/models/chat/chat_completion_function_call_option.rbi +36 -0
  660. data/rbi/openai/models/chat/chat_completion_function_message_param.rbi +57 -0
  661. data/rbi/openai/models/chat/chat_completion_message.rbi +309 -0
  662. data/rbi/openai/models/chat/chat_completion_message_param.rbi +36 -0
  663. data/rbi/openai/models/chat/chat_completion_message_tool_call.rbi +113 -0
  664. data/rbi/openai/models/chat/chat_completion_modality.rbi +29 -0
  665. data/rbi/openai/models/chat/chat_completion_named_tool_choice.rbi +86 -0
  666. data/rbi/openai/models/chat/chat_completion_prediction_content.rbi +99 -0
  667. data/rbi/openai/models/chat/chat_completion_reasoning_effort.rbi +11 -0
  668. data/rbi/openai/models/chat/chat_completion_role.rbi +36 -0
  669. data/rbi/openai/models/chat/chat_completion_store_message.rbi +35 -0
  670. data/rbi/openai/models/chat/chat_completion_stream_options.rbi +50 -0
  671. data/rbi/openai/models/chat/chat_completion_system_message_param.rbi +105 -0
  672. data/rbi/openai/models/chat/chat_completion_token_logprob.rbi +151 -0
  673. data/rbi/openai/models/chat/chat_completion_tool.rbi +47 -0
  674. data/rbi/openai/models/chat/chat_completion_tool_choice_option.rbi +77 -0
  675. data/rbi/openai/models/chat/chat_completion_tool_message_param.rbi +97 -0
  676. data/rbi/openai/models/chat/chat_completion_user_message_param.rbi +104 -0
  677. data/rbi/openai/models/chat/completion_create_params.rbi +1351 -0
  678. data/rbi/openai/models/chat/completion_delete_params.rbi +32 -0
  679. data/rbi/openai/models/chat/completion_list_params.rbi +131 -0
  680. data/rbi/openai/models/chat/completion_retrieve_params.rbi +32 -0
  681. data/rbi/openai/models/chat/completion_update_params.rbi +58 -0
  682. data/rbi/openai/models/chat/completions/message_list_params.rbi +126 -0
  683. data/rbi/openai/models/chat_model.rbi +119 -0
  684. data/rbi/openai/models/comparison_filter.rbi +116 -0
  685. data/rbi/openai/models/completion.rbi +97 -0
  686. data/rbi/openai/models/completion_choice.rbi +158 -0
  687. data/rbi/openai/models/completion_create_params.rbi +445 -0
  688. data/rbi/openai/models/completion_usage.rbi +215 -0
  689. data/rbi/openai/models/compound_filter.rbi +81 -0
  690. data/rbi/openai/models/container_create_params.rbi +145 -0
  691. data/rbi/openai/models/container_create_response.rbi +192 -0
  692. data/rbi/openai/models/container_delete_params.rbi +27 -0
  693. data/rbi/openai/models/container_list_params.rbi +99 -0
  694. data/rbi/openai/models/container_list_response.rbi +190 -0
  695. data/rbi/openai/models/container_retrieve_params.rbi +27 -0
  696. data/rbi/openai/models/container_retrieve_response.rbi +193 -0
  697. data/rbi/openai/models/containers/file_create_params.rbi +62 -0
  698. data/rbi/openai/models/containers/file_create_response.rbi +90 -0
  699. data/rbi/openai/models/containers/file_delete_params.rbi +40 -0
  700. data/rbi/openai/models/containers/file_list_params.rbi +116 -0
  701. data/rbi/openai/models/containers/file_list_response.rbi +90 -0
  702. data/rbi/openai/models/containers/file_retrieve_params.rbi +40 -0
  703. data/rbi/openai/models/containers/file_retrieve_response.rbi +90 -0
  704. data/rbi/openai/models/containers/files/content_retrieve_params.rbi +42 -0
  705. data/rbi/openai/models/create_embedding_response.rbi +102 -0
  706. data/rbi/openai/models/embedding.rbi +52 -0
  707. data/rbi/openai/models/embedding_create_params.rbi +231 -0
  708. data/rbi/openai/models/embedding_model.rbi +23 -0
  709. data/rbi/openai/models/error_object.rbi +46 -0
  710. data/rbi/openai/models/eval_create_params.rbi +806 -0
  711. data/rbi/openai/models/eval_create_response.rbi +330 -0
  712. data/rbi/openai/models/eval_custom_data_source_config.rbi +47 -0
  713. data/rbi/openai/models/eval_delete_params.rbi +27 -0
  714. data/rbi/openai/models/eval_delete_response.rbi +37 -0
  715. data/rbi/openai/models/eval_list_params.rbi +127 -0
  716. data/rbi/openai/models/eval_list_response.rbi +328 -0
  717. data/rbi/openai/models/eval_retrieve_params.rbi +27 -0
  718. data/rbi/openai/models/eval_retrieve_response.rbi +332 -0
  719. data/rbi/openai/models/eval_stored_completions_data_source_config.rbi +69 -0
  720. data/rbi/openai/models/eval_update_params.rbi +64 -0
  721. data/rbi/openai/models/eval_update_response.rbi +330 -0
  722. data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +874 -0
  723. data/rbi/openai/models/evals/create_eval_jsonl_run_data_source.rbi +215 -0
  724. data/rbi/openai/models/evals/eval_api_error.rbi +38 -0
  725. data/rbi/openai/models/evals/run_cancel_params.rbi +37 -0
  726. data/rbi/openai/models/evals/run_cancel_response.rbi +1296 -0
  727. data/rbi/openai/models/evals/run_create_params.rbi +1064 -0
  728. data/rbi/openai/models/evals/run_create_response.rbi +1296 -0
  729. data/rbi/openai/models/evals/run_delete_params.rbi +37 -0
  730. data/rbi/openai/models/evals/run_delete_response.rbi +51 -0
  731. data/rbi/openai/models/evals/run_list_params.rbi +149 -0
  732. data/rbi/openai/models/evals/run_list_response.rbi +1292 -0
  733. data/rbi/openai/models/evals/run_retrieve_params.rbi +37 -0
  734. data/rbi/openai/models/evals/run_retrieve_response.rbi +1298 -0
  735. data/rbi/openai/models/evals/runs/output_item_list_params.rbi +186 -0
  736. data/rbi/openai/models/evals/runs/output_item_list_response.rbi +411 -0
  737. data/rbi/openai/models/evals/runs/output_item_retrieve_params.rbi +50 -0
  738. data/rbi/openai/models/evals/runs/output_item_retrieve_response.rbi +413 -0
  739. data/rbi/openai/models/file_chunking_strategy.rbi +22 -0
  740. data/rbi/openai/models/file_chunking_strategy_param.rbi +25 -0
  741. data/rbi/openai/models/file_content.rbi +7 -0
  742. data/rbi/openai/models/file_content_params.rbi +27 -0
  743. data/rbi/openai/models/file_create_params.rbi +57 -0
  744. data/rbi/openai/models/file_delete_params.rbi +27 -0
  745. data/rbi/openai/models/file_deleted.rbi +33 -0
  746. data/rbi/openai/models/file_list_params.rbi +110 -0
  747. data/rbi/openai/models/file_object.rbi +164 -0
  748. data/rbi/openai/models/file_purpose.rbi +27 -0
  749. data/rbi/openai/models/file_retrieve_params.rbi +27 -0
  750. data/rbi/openai/models/fine_tuning/alpha/grader_run_params.rbi +150 -0
  751. data/rbi/openai/models/fine_tuning/alpha/grader_run_response.rbi +268 -0
  752. data/rbi/openai/models/fine_tuning/alpha/grader_validate_params.rbi +100 -0
  753. data/rbi/openai/models/fine_tuning/alpha/grader_validate_response.rbi +98 -0
  754. data/rbi/openai/models/fine_tuning/checkpoints/permission_create_params.rbi +50 -0
  755. data/rbi/openai/models/fine_tuning/checkpoints/permission_create_response.rbi +70 -0
  756. data/rbi/openai/models/fine_tuning/checkpoints/permission_delete_params.rbi +45 -0
  757. data/rbi/openai/models/fine_tuning/checkpoints/permission_delete_response.rbi +54 -0
  758. data/rbi/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbi +134 -0
  759. data/rbi/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rbi +139 -0
  760. data/rbi/openai/models/fine_tuning/dpo_hyperparameters.rbi +157 -0
  761. data/rbi/openai/models/fine_tuning/dpo_method.rbi +45 -0
  762. data/rbi/openai/models/fine_tuning/fine_tuning_job.rbi +625 -0
  763. data/rbi/openai/models/fine_tuning/fine_tuning_job_event.rbi +181 -0
  764. data/rbi/openai/models/fine_tuning/fine_tuning_job_integration.rbi +12 -0
  765. data/rbi/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rbi +85 -0
  766. data/rbi/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rbi +66 -0
  767. data/rbi/openai/models/fine_tuning/job_cancel_params.rbi +32 -0
  768. data/rbi/openai/models/fine_tuning/job_create_params.rbi +665 -0
  769. data/rbi/openai/models/fine_tuning/job_list_events_params.rbi +62 -0
  770. data/rbi/openai/models/fine_tuning/job_list_params.rbi +69 -0
  771. data/rbi/openai/models/fine_tuning/job_pause_params.rbi +29 -0
  772. data/rbi/openai/models/fine_tuning/job_resume_params.rbi +32 -0
  773. data/rbi/openai/models/fine_tuning/job_retrieve_params.rbi +32 -0
  774. data/rbi/openai/models/fine_tuning/jobs/checkpoint_list_params.rbi +64 -0
  775. data/rbi/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rbi +197 -0
  776. data/rbi/openai/models/fine_tuning/reinforcement_hyperparameters.rbi +281 -0
  777. data/rbi/openai/models/fine_tuning/reinforcement_method.rbi +112 -0
  778. data/rbi/openai/models/fine_tuning/supervised_hyperparameters.rbi +128 -0
  779. data/rbi/openai/models/fine_tuning/supervised_method.rbi +52 -0
  780. data/rbi/openai/models/function_definition.rbi +91 -0
  781. data/rbi/openai/models/function_parameters.rbi +11 -0
  782. data/rbi/openai/models/graders/label_model_grader.rbi +300 -0
  783. data/rbi/openai/models/graders/multi_grader.rbi +123 -0
  784. data/rbi/openai/models/graders/python_grader.rbi +64 -0
  785. data/rbi/openai/models/graders/score_model_grader.rbi +307 -0
  786. data/rbi/openai/models/graders/string_check_grader.rbi +118 -0
  787. data/rbi/openai/models/graders/text_similarity_grader.rbi +161 -0
  788. data/rbi/openai/models/image.rbi +62 -0
  789. data/rbi/openai/models/image_create_variation_params.rbi +201 -0
  790. data/rbi/openai/models/image_edit_params.rbi +336 -0
  791. data/rbi/openai/models/image_generate_params.rbi +442 -0
  792. data/rbi/openai/models/image_model.rbi +20 -0
  793. data/rbi/openai/models/images_response.rbi +165 -0
  794. data/rbi/openai/models/metadata.rbi +11 -0
  795. data/rbi/openai/models/model.rbi +54 -0
  796. data/rbi/openai/models/model_delete_params.rbi +27 -0
  797. data/rbi/openai/models/model_deleted.rbi +33 -0
  798. data/rbi/openai/models/model_list_params.rbi +27 -0
  799. data/rbi/openai/models/model_retrieve_params.rbi +27 -0
  800. data/rbi/openai/models/moderation.rbi +1061 -0
  801. data/rbi/openai/models/moderation_create_params.rbi +122 -0
  802. data/rbi/openai/models/moderation_create_response.rbi +53 -0
  803. data/rbi/openai/models/moderation_image_url_input.rbi +76 -0
  804. data/rbi/openai/models/moderation_model.rbi +28 -0
  805. data/rbi/openai/models/moderation_multi_modal_input.rbi +21 -0
  806. data/rbi/openai/models/moderation_text_input.rbi +34 -0
  807. data/rbi/openai/models/other_file_chunking_strategy_object.rbi +33 -0
  808. data/rbi/openai/models/reasoning.rbi +127 -0
  809. data/rbi/openai/models/reasoning_effort.rbi +26 -0
  810. data/rbi/openai/models/response_format_json_object.rbi +30 -0
  811. data/rbi/openai/models/response_format_json_schema.rbi +150 -0
  812. data/rbi/openai/models/response_format_text.rbi +28 -0
  813. data/rbi/openai/models/responses/computer_tool.rbi +113 -0
  814. data/rbi/openai/models/responses/easy_input_message.rbi +164 -0
  815. data/rbi/openai/models/responses/file_search_tool.rbi +223 -0
  816. data/rbi/openai/models/responses/function_tool.rbi +76 -0
  817. data/rbi/openai/models/responses/input_item_list_params.rbi +157 -0
  818. data/rbi/openai/models/responses/response.rbi +664 -0
  819. data/rbi/openai/models/responses/response_audio_delta_event.rbi +53 -0
  820. data/rbi/openai/models/responses/response_audio_done_event.rbi +43 -0
  821. data/rbi/openai/models/responses/response_audio_transcript_delta_event.rbi +53 -0
  822. data/rbi/openai/models/responses/response_audio_transcript_done_event.rbi +43 -0
  823. data/rbi/openai/models/responses/response_cancel_params.rbi +32 -0
  824. data/rbi/openai/models/responses/response_code_interpreter_call_code_delta_event.rbi +67 -0
  825. data/rbi/openai/models/responses/response_code_interpreter_call_code_done_event.rbi +67 -0
  826. data/rbi/openai/models/responses/response_code_interpreter_call_completed_event.rbi +77 -0
  827. data/rbi/openai/models/responses/response_code_interpreter_call_in_progress_event.rbi +77 -0
  828. data/rbi/openai/models/responses/response_code_interpreter_call_interpreting_event.rbi +77 -0
  829. data/rbi/openai/models/responses/response_code_interpreter_tool_call.rbi +297 -0
  830. data/rbi/openai/models/responses/response_completed_event.rbi +62 -0
  831. data/rbi/openai/models/responses/response_computer_tool_call.rbi +795 -0
  832. data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi +223 -0
  833. data/rbi/openai/models/responses/response_computer_tool_call_output_screenshot.rbi +59 -0
  834. data/rbi/openai/models/responses/response_content.rbi +31 -0
  835. data/rbi/openai/models/responses/response_content_part_added_event.rbi +115 -0
  836. data/rbi/openai/models/responses/response_content_part_done_event.rbi +115 -0
  837. data/rbi/openai/models/responses/response_create_params.rbi +688 -0
  838. data/rbi/openai/models/responses/response_created_event.rbi +62 -0
  839. data/rbi/openai/models/responses/response_delete_params.rbi +32 -0
  840. data/rbi/openai/models/responses/response_error.rbi +158 -0
  841. data/rbi/openai/models/responses/response_error_event.rbi +75 -0
  842. data/rbi/openai/models/responses/response_failed_event.rbi +62 -0
  843. data/rbi/openai/models/responses/response_file_search_call_completed_event.rbi +67 -0
  844. data/rbi/openai/models/responses/response_file_search_call_in_progress_event.rbi +67 -0
  845. data/rbi/openai/models/responses/response_file_search_call_searching_event.rbi +67 -0
  846. data/rbi/openai/models/responses/response_file_search_tool_call.rbi +276 -0
  847. data/rbi/openai/models/responses/response_format_text_config.rbi +41 -0
  848. data/rbi/openai/models/responses/response_format_text_json_schema_config.rbi +94 -0
  849. data/rbi/openai/models/responses/response_function_call_arguments_delta_event.rbi +75 -0
  850. data/rbi/openai/models/responses/response_function_call_arguments_done_event.rbi +73 -0
  851. data/rbi/openai/models/responses/response_function_tool_call.rbi +148 -0
  852. data/rbi/openai/models/responses/response_function_tool_call_item.rbi +35 -0
  853. data/rbi/openai/models/responses/response_function_tool_call_output_item.rbi +133 -0
  854. data/rbi/openai/models/responses/response_function_web_search.rbi +112 -0
  855. data/rbi/openai/models/responses/response_image_gen_call_completed_event.rbi +68 -0
  856. data/rbi/openai/models/responses/response_image_gen_call_generating_event.rbi +68 -0
  857. data/rbi/openai/models/responses/response_image_gen_call_in_progress_event.rbi +67 -0
  858. data/rbi/openai/models/responses/response_image_gen_call_partial_image_event.rbi +85 -0
  859. data/rbi/openai/models/responses/response_in_progress_event.rbi +62 -0
  860. data/rbi/openai/models/responses/response_includable.rbi +57 -0
  861. data/rbi/openai/models/responses/response_incomplete_event.rbi +62 -0
  862. data/rbi/openai/models/responses/response_input.rbi +15 -0
  863. data/rbi/openai/models/responses/response_input_audio.rbi +91 -0
  864. data/rbi/openai/models/responses/response_input_content.rbi +29 -0
  865. data/rbi/openai/models/responses/response_input_file.rbi +73 -0
  866. data/rbi/openai/models/responses/response_input_image.rbi +110 -0
  867. data/rbi/openai/models/responses/response_input_item.rbi +1499 -0
  868. data/rbi/openai/models/responses/response_input_message_content_list.rbi +15 -0
  869. data/rbi/openai/models/responses/response_input_message_item.rbi +225 -0
  870. data/rbi/openai/models/responses/response_input_text.rbi +39 -0
  871. data/rbi/openai/models/responses/response_item.rbi +820 -0
  872. data/rbi/openai/models/responses/response_item_list.rbi +97 -0
  873. data/rbi/openai/models/responses/response_mcp_call_arguments_delta_event.rbi +76 -0
  874. data/rbi/openai/models/responses/response_mcp_call_arguments_done_event.rbi +75 -0
  875. data/rbi/openai/models/responses/response_mcp_call_completed_event.rbi +43 -0
  876. data/rbi/openai/models/responses/response_mcp_call_failed_event.rbi +43 -0
  877. data/rbi/openai/models/responses/response_mcp_call_in_progress_event.rbi +67 -0
  878. data/rbi/openai/models/responses/response_mcp_list_tools_completed_event.rbi +43 -0
  879. data/rbi/openai/models/responses/response_mcp_list_tools_failed_event.rbi +43 -0
  880. data/rbi/openai/models/responses/response_mcp_list_tools_in_progress_event.rbi +44 -0
  881. data/rbi/openai/models/responses/response_output_audio.rbi +51 -0
  882. data/rbi/openai/models/responses/response_output_item.rbi +645 -0
  883. data/rbi/openai/models/responses/response_output_item_added_event.rbi +81 -0
  884. data/rbi/openai/models/responses/response_output_item_done_event.rbi +81 -0
  885. data/rbi/openai/models/responses/response_output_message.rbi +162 -0
  886. data/rbi/openai/models/responses/response_output_refusal.rbi +39 -0
  887. data/rbi/openai/models/responses/response_output_text.rbi +271 -0
  888. data/rbi/openai/models/responses/response_output_text_annotation_added_event.rbi +91 -0
  889. data/rbi/openai/models/responses/response_queued_event.rbi +62 -0
  890. data/rbi/openai/models/responses/response_reasoning_delta_event.rbi +83 -0
  891. data/rbi/openai/models/responses/response_reasoning_done_event.rbi +83 -0
  892. data/rbi/openai/models/responses/response_reasoning_item.rbi +170 -0
  893. data/rbi/openai/models/responses/response_reasoning_summary_delta_event.rbi +85 -0
  894. data/rbi/openai/models/responses/response_reasoning_summary_done_event.rbi +83 -0
  895. data/rbi/openai/models/responses/response_reasoning_summary_part_added_event.rbi +129 -0
  896. data/rbi/openai/models/responses/response_reasoning_summary_part_done_event.rbi +129 -0
  897. data/rbi/openai/models/responses/response_reasoning_summary_text_delta_event.rbi +83 -0
  898. data/rbi/openai/models/responses/response_reasoning_summary_text_done_event.rbi +83 -0
  899. data/rbi/openai/models/responses/response_refusal_delta_event.rbi +83 -0
  900. data/rbi/openai/models/responses/response_refusal_done_event.rbi +83 -0
  901. data/rbi/openai/models/responses/response_retrieve_params.rbi +62 -0
  902. data/rbi/openai/models/responses/response_status.rbi +36 -0
  903. data/rbi/openai/models/responses/response_stream_event.rbi +79 -0
  904. data/rbi/openai/models/responses/response_text_config.rbi +103 -0
  905. data/rbi/openai/models/responses/response_text_delta_event.rbi +83 -0
  906. data/rbi/openai/models/responses/response_text_done_event.rbi +83 -0
  907. data/rbi/openai/models/responses/response_usage.rbi +147 -0
  908. data/rbi/openai/models/responses/response_web_search_call_completed_event.rbi +67 -0
  909. data/rbi/openai/models/responses/response_web_search_call_in_progress_event.rbi +67 -0
  910. data/rbi/openai/models/responses/response_web_search_call_searching_event.rbi +67 -0
  911. data/rbi/openai/models/responses/tool.rbi +1063 -0
  912. data/rbi/openai/models/responses/tool_choice_function.rbi +39 -0
  913. data/rbi/openai/models/responses/tool_choice_options.rbi +36 -0
  914. data/rbi/openai/models/responses/tool_choice_types.rbi +121 -0
  915. data/rbi/openai/models/responses/web_search_tool.rbi +231 -0
  916. data/rbi/openai/models/responses_model.rbi +61 -0
  917. data/rbi/openai/models/static_file_chunking_strategy.rbi +48 -0
  918. data/rbi/openai/models/static_file_chunking_strategy_object.rbi +46 -0
  919. data/rbi/openai/models/static_file_chunking_strategy_object_param.rbi +47 -0
  920. data/rbi/openai/models/upload.rbi +123 -0
  921. data/rbi/openai/models/upload_cancel_params.rbi +27 -0
  922. data/rbi/openai/models/upload_complete_params.rbi +56 -0
  923. data/rbi/openai/models/upload_create_params.rbi +79 -0
  924. data/rbi/openai/models/uploads/part_create_params.rbi +45 -0
  925. data/rbi/openai/models/uploads/upload_part.rbi +66 -0
  926. data/rbi/openai/models/vector_store.rbi +254 -0
  927. data/rbi/openai/models/vector_store_create_params.rbi +166 -0
  928. data/rbi/openai/models/vector_store_delete_params.rbi +27 -0
  929. data/rbi/openai/models/vector_store_deleted.rbi +35 -0
  930. data/rbi/openai/models/vector_store_list_params.rbi +116 -0
  931. data/rbi/openai/models/vector_store_retrieve_params.rbi +27 -0
  932. data/rbi/openai/models/vector_store_search_params.rbi +242 -0
  933. data/rbi/openai/models/vector_store_search_response.rbi +202 -0
  934. data/rbi/openai/models/vector_store_update_params.rbi +113 -0
  935. data/rbi/openai/models/vector_stores/file_batch_cancel_params.rbi +40 -0
  936. data/rbi/openai/models/vector_stores/file_batch_create_params.rbi +143 -0
  937. data/rbi/openai/models/vector_stores/file_batch_list_files_params.rbi +224 -0
  938. data/rbi/openai/models/vector_stores/file_batch_retrieve_params.rbi +40 -0
  939. data/rbi/openai/models/vector_stores/file_content_params.rbi +40 -0
  940. data/rbi/openai/models/vector_stores/file_content_response.rbi +44 -0
  941. data/rbi/openai/models/vector_stores/file_create_params.rbi +143 -0
  942. data/rbi/openai/models/vector_stores/file_delete_params.rbi +40 -0
  943. data/rbi/openai/models/vector_stores/file_list_params.rbi +202 -0
  944. data/rbi/openai/models/vector_stores/file_retrieve_params.rbi +40 -0
  945. data/rbi/openai/models/vector_stores/file_update_params.rbi +99 -0
  946. data/rbi/openai/models/vector_stores/vector_store_file.rbi +337 -0
  947. data/rbi/openai/models/vector_stores/vector_store_file_batch.rbi +219 -0
  948. data/rbi/openai/models/vector_stores/vector_store_file_deleted.rbi +42 -0
  949. data/rbi/openai/models.rbi +202 -0
  950. data/rbi/openai/request_options.rbi +55 -0
  951. data/rbi/openai/resources/audio/speech.rbi +52 -0
  952. data/rbi/openai/resources/audio/transcriptions.rbi +178 -0
  953. data/rbi/openai/resources/audio/translations.rbi +51 -0
  954. data/rbi/openai/resources/audio.rbi +21 -0
  955. data/rbi/openai/resources/batches.rbi +104 -0
  956. data/rbi/openai/resources/beta/assistants.rbi +294 -0
  957. data/rbi/openai/resources/beta/threads/messages.rbi +159 -0
  958. data/rbi/openai/resources/beta/threads/runs/steps.rbi +106 -0
  959. data/rbi/openai/resources/beta/threads/runs.rbi +546 -0
  960. data/rbi/openai/resources/beta/threads.rbi +415 -0
  961. data/rbi/openai/resources/beta.rbi +18 -0
  962. data/rbi/openai/resources/chat/completions/messages.rbi +46 -0
  963. data/rbi/openai/resources/chat/completions.rbi +682 -0
  964. data/rbi/openai/resources/chat.rbi +15 -0
  965. data/rbi/openai/resources/completions.rbi +292 -0
  966. data/rbi/openai/resources/containers/files/content.rbi +27 -0
  967. data/rbi/openai/resources/containers/files.rbi +92 -0
  968. data/rbi/openai/resources/containers.rbi +86 -0
  969. data/rbi/openai/resources/embeddings.rbi +55 -0
  970. data/rbi/openai/resources/evals/runs/output_items.rbi +73 -0
  971. data/rbi/openai/resources/evals/runs.rbi +133 -0
  972. data/rbi/openai/resources/evals.rbi +146 -0
  973. data/rbi/openai/resources/files.rbi +122 -0
  974. data/rbi/openai/resources/fine_tuning/alpha/graders.rbi +65 -0
  975. data/rbi/openai/resources/fine_tuning/alpha.rbi +17 -0
  976. data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi +94 -0
  977. data/rbi/openai/resources/fine_tuning/checkpoints.rbi +17 -0
  978. data/rbi/openai/resources/fine_tuning/jobs/checkpoints.rbi +40 -0
  979. data/rbi/openai/resources/fine_tuning/jobs.rbi +214 -0
  980. data/rbi/openai/resources/fine_tuning/methods.rbi +14 -0
  981. data/rbi/openai/resources/fine_tuning.rbi +24 -0
  982. data/rbi/openai/resources/graders/grader_models.rbi +14 -0
  983. data/rbi/openai/resources/graders.rbi +15 -0
  984. data/rbi/openai/resources/images.rbi +205 -0
  985. data/rbi/openai/resources/models.rbi +52 -0
  986. data/rbi/openai/resources/moderations.rbi +34 -0
  987. data/rbi/openai/resources/responses/input_items.rbi +52 -0
  988. data/rbi/openai/resources/responses.rbi +485 -0
  989. data/rbi/openai/resources/uploads/parts.rbi +41 -0
  990. data/rbi/openai/resources/uploads.rbi +109 -0
  991. data/rbi/openai/resources/vector_stores/file_batches.rbi +134 -0
  992. data/rbi/openai/resources/vector_stores/files.rbi +183 -0
  993. data/rbi/openai/resources/vector_stores.rbi +182 -0
  994. data/rbi/openai/structured_output.rbi +10 -0
  995. data/rbi/openai/version.rbi +5 -0
  996. data/sig/openai/client.rbs +64 -0
  997. data/sig/openai/errors.rbs +107 -0
  998. data/sig/openai/file_part.rbs +21 -0
  999. data/sig/openai/internal/cursor_page.rbs +13 -0
  1000. data/sig/openai/internal/page.rbs +13 -0
  1001. data/sig/openai/internal/stream.rbs +9 -0
  1002. data/sig/openai/internal/transport/base_client.rbs +131 -0
  1003. data/sig/openai/internal/transport/pooled_net_requester.rbs +45 -0
  1004. data/sig/openai/internal/type/array_of.rbs +48 -0
  1005. data/sig/openai/internal/type/base_model.rbs +102 -0
  1006. data/sig/openai/internal/type/base_page.rbs +24 -0
  1007. data/sig/openai/internal/type/base_stream.rbs +33 -0
  1008. data/sig/openai/internal/type/boolean.rbs +26 -0
  1009. data/sig/openai/internal/type/converter.rbs +56 -0
  1010. data/sig/openai/internal/type/enum.rbs +32 -0
  1011. data/sig/openai/internal/type/file_input.rbs +25 -0
  1012. data/sig/openai/internal/type/hash_of.rbs +48 -0
  1013. data/sig/openai/internal/type/request_parameters.rbs +17 -0
  1014. data/sig/openai/internal/type/union.rbs +52 -0
  1015. data/sig/openai/internal/type/unknown.rbs +26 -0
  1016. data/sig/openai/internal/util.rbs +185 -0
  1017. data/sig/openai/internal.rbs +9 -0
  1018. data/sig/openai/models/all_models.rbs +31 -0
  1019. data/sig/openai/models/audio/speech_create_params.rbs +116 -0
  1020. data/sig/openai/models/audio/speech_model.rbs +17 -0
  1021. data/sig/openai/models/audio/transcription.rbs +59 -0
  1022. data/sig/openai/models/audio/transcription_create_params.rbs +163 -0
  1023. data/sig/openai/models/audio/transcription_create_response.rbs +14 -0
  1024. data/sig/openai/models/audio/transcription_include.rbs +15 -0
  1025. data/sig/openai/models/audio/transcription_segment.rbs +67 -0
  1026. data/sig/openai/models/audio/transcription_stream_event.rbs +15 -0
  1027. data/sig/openai/models/audio/transcription_text_delta_event.rbs +60 -0
  1028. data/sig/openai/models/audio/transcription_text_done_event.rbs +60 -0
  1029. data/sig/openai/models/audio/transcription_verbose.rbs +50 -0
  1030. data/sig/openai/models/audio/transcription_word.rbs +19 -0
  1031. data/sig/openai/models/audio/translation.rbs +15 -0
  1032. data/sig/openai/models/audio/translation_create_params.rbs +78 -0
  1033. data/sig/openai/models/audio/translation_create_response.rbs +14 -0
  1034. data/sig/openai/models/audio/translation_verbose.rbs +41 -0
  1035. data/sig/openai/models/audio_model.rbs +16 -0
  1036. data/sig/openai/models/audio_response_format.rbs +17 -0
  1037. data/sig/openai/models/auto_file_chunking_strategy_param.rbs +13 -0
  1038. data/sig/openai/models/batch.rbs +185 -0
  1039. data/sig/openai/models/batch_cancel_params.rbs +14 -0
  1040. data/sig/openai/models/batch_create_params.rbs +68 -0
  1041. data/sig/openai/models/batch_error.rbs +34 -0
  1042. data/sig/openai/models/batch_list_params.rbs +32 -0
  1043. data/sig/openai/models/batch_request_counts.rbs +22 -0
  1044. data/sig/openai/models/batch_retrieve_params.rbs +15 -0
  1045. data/sig/openai/models/beta/assistant.rbs +136 -0
  1046. data/sig/openai/models/beta/assistant_create_params.rbs +257 -0
  1047. data/sig/openai/models/beta/assistant_delete_params.rbs +17 -0
  1048. data/sig/openai/models/beta/assistant_deleted.rbs +28 -0
  1049. data/sig/openai/models/beta/assistant_list_params.rbs +64 -0
  1050. data/sig/openai/models/beta/assistant_response_format_option.rbs +17 -0
  1051. data/sig/openai/models/beta/assistant_retrieve_params.rbs +17 -0
  1052. data/sig/openai/models/beta/assistant_stream_event.rbs +535 -0
  1053. data/sig/openai/models/beta/assistant_tool.rbs +16 -0
  1054. data/sig/openai/models/beta/assistant_tool_choice.rbs +43 -0
  1055. data/sig/openai/models/beta/assistant_tool_choice_function.rbs +15 -0
  1056. data/sig/openai/models/beta/assistant_tool_choice_option.rbs +27 -0
  1057. data/sig/openai/models/beta/assistant_update_params.rbs +222 -0
  1058. data/sig/openai/models/beta/code_interpreter_tool.rbs +15 -0
  1059. data/sig/openai/models/beta/file_search_tool.rbs +96 -0
  1060. data/sig/openai/models/beta/function_tool.rbs +24 -0
  1061. data/sig/openai/models/beta/message_stream_event.rbs +128 -0
  1062. data/sig/openai/models/beta/run_step_stream_event.rbs +174 -0
  1063. data/sig/openai/models/beta/run_stream_event.rbs +216 -0
  1064. data/sig/openai/models/beta/thread.rbs +96 -0
  1065. data/sig/openai/models/beta/thread_create_and_run_params.rbs +500 -0
  1066. data/sig/openai/models/beta/thread_create_params.rbs +312 -0
  1067. data/sig/openai/models/beta/thread_delete_params.rbs +17 -0
  1068. data/sig/openai/models/beta/thread_deleted.rbs +24 -0
  1069. data/sig/openai/models/beta/thread_retrieve_params.rbs +17 -0
  1070. data/sig/openai/models/beta/thread_stream_event.rbs +30 -0
  1071. data/sig/openai/models/beta/thread_update_params.rbs +87 -0
  1072. data/sig/openai/models/beta/threads/annotation.rbs +17 -0
  1073. data/sig/openai/models/beta/threads/annotation_delta.rbs +17 -0
  1074. data/sig/openai/models/beta/threads/file_citation_annotation.rbs +54 -0
  1075. data/sig/openai/models/beta/threads/file_citation_delta_annotation.rbs +75 -0
  1076. data/sig/openai/models/beta/threads/file_path_annotation.rbs +54 -0
  1077. data/sig/openai/models/beta/threads/file_path_delta_annotation.rbs +71 -0
  1078. data/sig/openai/models/beta/threads/image_file.rbs +45 -0
  1079. data/sig/openai/models/beta/threads/image_file_content_block.rbs +26 -0
  1080. data/sig/openai/models/beta/threads/image_file_delta.rbs +47 -0
  1081. data/sig/openai/models/beta/threads/image_file_delta_block.rbs +38 -0
  1082. data/sig/openai/models/beta/threads/image_url.rbs +45 -0
  1083. data/sig/openai/models/beta/threads/image_url_content_block.rbs +26 -0
  1084. data/sig/openai/models/beta/threads/image_url_delta.rbs +47 -0
  1085. data/sig/openai/models/beta/threads/image_url_delta_block.rbs +38 -0
  1086. data/sig/openai/models/beta/threads/message.rbs +197 -0
  1087. data/sig/openai/models/beta/threads/message_content.rbs +19 -0
  1088. data/sig/openai/models/beta/threads/message_content_delta.rbs +19 -0
  1089. data/sig/openai/models/beta/threads/message_content_part_param.rbs +18 -0
  1090. data/sig/openai/models/beta/threads/message_create_params.rbs +116 -0
  1091. data/sig/openai/models/beta/threads/message_delete_params.rbs +27 -0
  1092. data/sig/openai/models/beta/threads/message_deleted.rbs +30 -0
  1093. data/sig/openai/models/beta/threads/message_delta.rbs +48 -0
  1094. data/sig/openai/models/beta/threads/message_delta_event.rbs +34 -0
  1095. data/sig/openai/models/beta/threads/message_list_params.rbs +73 -0
  1096. data/sig/openai/models/beta/threads/message_retrieve_params.rbs +27 -0
  1097. data/sig/openai/models/beta/threads/message_update_params.rbs +32 -0
  1098. data/sig/openai/models/beta/threads/refusal_content_block.rbs +19 -0
  1099. data/sig/openai/models/beta/threads/refusal_delta_block.rbs +28 -0
  1100. data/sig/openai/models/beta/threads/required_action_function_tool_call.rbs +46 -0
  1101. data/sig/openai/models/beta/threads/run.rbs +319 -0
  1102. data/sig/openai/models/beta/threads/run_cancel_params.rbs +27 -0
  1103. data/sig/openai/models/beta/threads/run_create_params.rbs +260 -0
  1104. data/sig/openai/models/beta/threads/run_list_params.rbs +66 -0
  1105. data/sig/openai/models/beta/threads/run_retrieve_params.rbs +27 -0
  1106. data/sig/openai/models/beta/threads/run_status.rbs +34 -0
  1107. data/sig/openai/models/beta/threads/run_submit_tool_outputs_params.rbs +51 -0
  1108. data/sig/openai/models/beta/threads/run_update_params.rbs +32 -0
  1109. data/sig/openai/models/beta/threads/runs/code_interpreter_logs.rbs +30 -0
  1110. data/sig/openai/models/beta/threads/runs/code_interpreter_output_image.rbs +52 -0
  1111. data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call.rbs +112 -0
  1112. data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbs +85 -0
  1113. data/sig/openai/models/beta/threads/runs/file_search_tool_call.rbs +173 -0
  1114. data/sig/openai/models/beta/threads/runs/file_search_tool_call_delta.rbs +38 -0
  1115. data/sig/openai/models/beta/threads/runs/function_tool_call.rbs +58 -0
  1116. data/sig/openai/models/beta/threads/runs/function_tool_call_delta.rbs +73 -0
  1117. data/sig/openai/models/beta/threads/runs/message_creation_step_details.rbs +41 -0
  1118. data/sig/openai/models/beta/threads/runs/run_step.rbs +199 -0
  1119. data/sig/openai/models/beta/threads/runs/run_step_delta.rbs +42 -0
  1120. data/sig/openai/models/beta/threads/runs/run_step_delta_event.rbs +38 -0
  1121. data/sig/openai/models/beta/threads/runs/run_step_delta_message_delta.rbs +49 -0
  1122. data/sig/openai/models/beta/threads/runs/run_step_include.rbs +22 -0
  1123. data/sig/openai/models/beta/threads/runs/step_list_params.rbs +82 -0
  1124. data/sig/openai/models/beta/threads/runs/step_retrieve_params.rbs +46 -0
  1125. data/sig/openai/models/beta/threads/runs/tool_call.rbs +20 -0
  1126. data/sig/openai/models/beta/threads/runs/tool_call_delta.rbs +20 -0
  1127. data/sig/openai/models/beta/threads/runs/tool_call_delta_object.rbs +35 -0
  1128. data/sig/openai/models/beta/threads/runs/tool_calls_step_details.rbs +31 -0
  1129. data/sig/openai/models/beta/threads/text.rbs +29 -0
  1130. data/sig/openai/models/beta/threads/text_content_block.rbs +23 -0
  1131. data/sig/openai/models/beta/threads/text_content_block_param.rbs +19 -0
  1132. data/sig/openai/models/beta/threads/text_delta.rbs +35 -0
  1133. data/sig/openai/models/beta/threads/text_delta_block.rbs +38 -0
  1134. data/sig/openai/models/chat/chat_completion.rbs +144 -0
  1135. data/sig/openai/models/chat/chat_completion_assistant_message_param.rbs +104 -0
  1136. data/sig/openai/models/chat/chat_completion_audio.rbs +34 -0
  1137. data/sig/openai/models/chat/chat_completion_audio_param.rbs +76 -0
  1138. data/sig/openai/models/chat/chat_completion_chunk.rbs +289 -0
  1139. data/sig/openai/models/chat/chat_completion_content_part.rbs +69 -0
  1140. data/sig/openai/models/chat/chat_completion_content_part_image.rbs +67 -0
  1141. data/sig/openai/models/chat/chat_completion_content_part_input_audio.rbs +62 -0
  1142. data/sig/openai/models/chat/chat_completion_content_part_refusal.rbs +20 -0
  1143. data/sig/openai/models/chat/chat_completion_content_part_text.rbs +19 -0
  1144. data/sig/openai/models/chat/chat_completion_deleted.rbs +30 -0
  1145. data/sig/openai/models/chat/chat_completion_developer_message_param.rbs +47 -0
  1146. data/sig/openai/models/chat/chat_completion_function_call_option.rbs +17 -0
  1147. data/sig/openai/models/chat/chat_completion_function_message_param.rbs +26 -0
  1148. data/sig/openai/models/chat/chat_completion_message.rbs +132 -0
  1149. data/sig/openai/models/chat/chat_completion_message_param.rbs +21 -0
  1150. data/sig/openai/models/chat/chat_completion_message_tool_call.rbs +46 -0
  1151. data/sig/openai/models/chat/chat_completion_modality.rbs +18 -0
  1152. data/sig/openai/models/chat/chat_completion_named_tool_choice.rbs +39 -0
  1153. data/sig/openai/models/chat/chat_completion_prediction_content.rbs +40 -0
  1154. data/sig/openai/models/chat/chat_completion_reasoning_effort.rbs +9 -0
  1155. data/sig/openai/models/chat/chat_completion_role.rbs +23 -0
  1156. data/sig/openai/models/chat/chat_completion_store_message.rbs +19 -0
  1157. data/sig/openai/models/chat/chat_completion_stream_options.rbs +19 -0
  1158. data/sig/openai/models/chat/chat_completion_system_message_param.rbs +47 -0
  1159. data/sig/openai/models/chat/chat_completion_token_logprob.rbs +62 -0
  1160. data/sig/openai/models/chat/chat_completion_tool.rbs +26 -0
  1161. data/sig/openai/models/chat/chat_completion_tool_choice_option.rbs +29 -0
  1162. data/sig/openai/models/chat/chat_completion_tool_message_param.rbs +45 -0
  1163. data/sig/openai/models/chat/chat_completion_user_message_param.rbs +47 -0
  1164. data/sig/openai/models/chat/completion_create_params.rbs +407 -0
  1165. data/sig/openai/models/chat/completion_delete_params.rbs +17 -0
  1166. data/sig/openai/models/chat/completion_list_params.rbs +69 -0
  1167. data/sig/openai/models/chat/completion_retrieve_params.rbs +17 -0
  1168. data/sig/openai/models/chat/completion_update_params.rbs +26 -0
  1169. data/sig/openai/models/chat/completions/message_list_params.rbs +59 -0
  1170. data/sig/openai/models/chat_model.rbs +120 -0
  1171. data/sig/openai/models/comparison_filter.rbs +53 -0
  1172. data/sig/openai/models/completion.rbs +54 -0
  1173. data/sig/openai/models/completion_choice.rbs +89 -0
  1174. data/sig/openai/models/completion_create_params.rbs +146 -0
  1175. data/sig/openai/models/completion_usage.rbs +108 -0
  1176. data/sig/openai/models/compound_filter.rbs +44 -0
  1177. data/sig/openai/models/container_create_params.rbs +74 -0
  1178. data/sig/openai/models/container_create_response.rbs +87 -0
  1179. data/sig/openai/models/container_delete_params.rbs +15 -0
  1180. data/sig/openai/models/container_list_params.rbs +55 -0
  1181. data/sig/openai/models/container_list_response.rbs +87 -0
  1182. data/sig/openai/models/container_retrieve_params.rbs +15 -0
  1183. data/sig/openai/models/container_retrieve_response.rbs +87 -0
  1184. data/sig/openai/models/containers/file_create_params.rbs +36 -0
  1185. data/sig/openai/models/containers/file_create_response.rbs +52 -0
  1186. data/sig/openai/models/containers/file_delete_params.rbs +25 -0
  1187. data/sig/openai/models/containers/file_list_params.rbs +57 -0
  1188. data/sig/openai/models/containers/file_list_response.rbs +52 -0
  1189. data/sig/openai/models/containers/file_retrieve_params.rbs +25 -0
  1190. data/sig/openai/models/containers/file_retrieve_response.rbs +52 -0
  1191. data/sig/openai/models/containers/files/content_retrieve_params.rbs +27 -0
  1192. data/sig/openai/models/create_embedding_response.rbs +47 -0
  1193. data/sig/openai/models/embedding.rbs +26 -0
  1194. data/sig/openai/models/embedding_create_params.rbs +88 -0
  1195. data/sig/openai/models/embedding_model.rbs +18 -0
  1196. data/sig/openai/models/error_object.rbs +30 -0
  1197. data/sig/openai/models/eval_create_params.rbs +308 -0
  1198. data/sig/openai/models/eval_create_response.rbs +137 -0
  1199. data/sig/openai/models/eval_custom_data_source_config.rbs +16 -0
  1200. data/sig/openai/models/eval_delete_params.rbs +14 -0
  1201. data/sig/openai/models/eval_delete_response.rbs +18 -0
  1202. data/sig/openai/models/eval_list_params.rbs +75 -0
  1203. data/sig/openai/models/eval_list_response.rbs +137 -0
  1204. data/sig/openai/models/eval_retrieve_params.rbs +15 -0
  1205. data/sig/openai/models/eval_retrieve_response.rbs +137 -0
  1206. data/sig/openai/models/eval_stored_completions_data_source_config.rbs +30 -0
  1207. data/sig/openai/models/eval_update_params.rbs +30 -0
  1208. data/sig/openai/models/eval_update_response.rbs +137 -0
  1209. data/sig/openai/models/evals/create_eval_completions_run_data_source.rbs +345 -0
  1210. data/sig/openai/models/evals/create_eval_jsonl_run_data_source.rbs +92 -0
  1211. data/sig/openai/models/evals/eval_api_error.rbs +19 -0
  1212. data/sig/openai/models/evals/run_cancel_params.rbs +25 -0
  1213. data/sig/openai/models/evals/run_cancel_response.rbs +563 -0
  1214. data/sig/openai/models/evals/run_create_params.rbs +434 -0
  1215. data/sig/openai/models/evals/run_create_response.rbs +563 -0
  1216. data/sig/openai/models/evals/run_delete_params.rbs +25 -0
  1217. data/sig/openai/models/evals/run_delete_response.rbs +30 -0
  1218. data/sig/openai/models/evals/run_list_params.rbs +80 -0
  1219. data/sig/openai/models/evals/run_list_response.rbs +563 -0
  1220. data/sig/openai/models/evals/run_retrieve_params.rbs +25 -0
  1221. data/sig/openai/models/evals/run_retrieve_response.rbs +563 -0
  1222. data/sig/openai/models/evals/runs/output_item_list_params.rbs +84 -0
  1223. data/sig/openai/models/evals/runs/output_item_list_response.rbs +191 -0
  1224. data/sig/openai/models/evals/runs/output_item_retrieve_params.rbs +32 -0
  1225. data/sig/openai/models/evals/runs/output_item_retrieve_response.rbs +191 -0
  1226. data/sig/openai/models/file_chunking_strategy.rbs +13 -0
  1227. data/sig/openai/models/file_chunking_strategy_param.rbs +13 -0
  1228. data/sig/openai/models/file_content.rbs +5 -0
  1229. data/sig/openai/models/file_content_params.rbs +14 -0
  1230. data/sig/openai/models/file_create_params.rbs +31 -0
  1231. data/sig/openai/models/file_delete_params.rbs +14 -0
  1232. data/sig/openai/models/file_deleted.rbs +17 -0
  1233. data/sig/openai/models/file_list_params.rbs +62 -0
  1234. data/sig/openai/models/file_object.rbs +99 -0
  1235. data/sig/openai/models/file_purpose.rbs +19 -0
  1236. data/sig/openai/models/file_retrieve_params.rbs +15 -0
  1237. data/sig/openai/models/fine_tuning/alpha/grader_run_params.rbs +63 -0
  1238. data/sig/openai/models/fine_tuning/alpha/grader_run_response.rbs +168 -0
  1239. data/sig/openai/models/fine_tuning/alpha/grader_validate_params.rbs +43 -0
  1240. data/sig/openai/models/fine_tuning/alpha/grader_validate_response.rbs +41 -0
  1241. data/sig/openai/models/fine_tuning/checkpoints/permission_create_params.rbs +28 -0
  1242. data/sig/openai/models/fine_tuning/checkpoints/permission_create_response.rbs +39 -0
  1243. data/sig/openai/models/fine_tuning/checkpoints/permission_delete_params.rbs +28 -0
  1244. data/sig/openai/models/fine_tuning/checkpoints/permission_delete_response.rbs +30 -0
  1245. data/sig/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbs +66 -0
  1246. data/sig/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rbs +76 -0
  1247. data/sig/openai/models/fine_tuning/dpo_hyperparameters.rbs +85 -0
  1248. data/sig/openai/models/fine_tuning/dpo_method.rbs +24 -0
  1249. data/sig/openai/models/fine_tuning/fine_tuning_job.rbs +272 -0
  1250. data/sig/openai/models/fine_tuning/fine_tuning_job_event.rbs +83 -0
  1251. data/sig/openai/models/fine_tuning/fine_tuning_job_integration.rbs +9 -0
  1252. data/sig/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rbs +41 -0
  1253. data/sig/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rbs +29 -0
  1254. data/sig/openai/models/fine_tuning/job_cancel_params.rbs +16 -0
  1255. data/sig/openai/models/fine_tuning/job_create_params.rbs +269 -0
  1256. data/sig/openai/models/fine_tuning/job_list_events_params.rbs +34 -0
  1257. data/sig/openai/models/fine_tuning/job_list_params.rbs +38 -0
  1258. data/sig/openai/models/fine_tuning/job_pause_params.rbs +16 -0
  1259. data/sig/openai/models/fine_tuning/job_resume_params.rbs +16 -0
  1260. data/sig/openai/models/fine_tuning/job_retrieve_params.rbs +17 -0
  1261. data/sig/openai/models/fine_tuning/jobs/checkpoint_list_params.rbs +36 -0
  1262. data/sig/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rbs +115 -0
  1263. data/sig/openai/models/fine_tuning/reinforcement_hyperparameters.rbs +141 -0
  1264. data/sig/openai/models/fine_tuning/reinforcement_method.rbs +44 -0
  1265. data/sig/openai/models/fine_tuning/supervised_hyperparameters.rbs +68 -0
  1266. data/sig/openai/models/fine_tuning/supervised_method.rbs +24 -0
  1267. data/sig/openai/models/function_definition.rbs +41 -0
  1268. data/sig/openai/models/function_parameters.rbs +7 -0
  1269. data/sig/openai/models/graders/label_model_grader.rbs +126 -0
  1270. data/sig/openai/models/graders/multi_grader.rbs +52 -0
  1271. data/sig/openai/models/graders/python_grader.rbs +36 -0
  1272. data/sig/openai/models/graders/score_model_grader.rbs +130 -0
  1273. data/sig/openai/models/graders/string_check_grader.rbs +57 -0
  1274. data/sig/openai/models/graders/text_similarity_grader.rbs +73 -0
  1275. data/sig/openai/models/image.rbs +31 -0
  1276. data/sig/openai/models/image_create_variation_params.rbs +84 -0
  1277. data/sig/openai/models/image_edit_params.rbs +152 -0
  1278. data/sig/openai/models/image_generate_params.rbs +188 -0
  1279. data/sig/openai/models/image_model.rbs +15 -0
  1280. data/sig/openai/models/images_response.rbs +81 -0
  1281. data/sig/openai/models/metadata.rbs +7 -0
  1282. data/sig/openai/models/model.rbs +30 -0
  1283. data/sig/openai/models/model_delete_params.rbs +14 -0
  1284. data/sig/openai/models/model_deleted.rbs +17 -0
  1285. data/sig/openai/models/model_list_params.rbs +14 -0
  1286. data/sig/openai/models/model_retrieve_params.rbs +15 -0
  1287. data/sig/openai/models/moderation.rbs +402 -0
  1288. data/sig/openai/models/moderation_create_params.rbs +58 -0
  1289. data/sig/openai/models/moderation_create_response.rbs +26 -0
  1290. data/sig/openai/models/moderation_image_url_input.rbs +32 -0
  1291. data/sig/openai/models/moderation_model.rbs +20 -0
  1292. data/sig/openai/models/moderation_multi_modal_input.rbs +12 -0
  1293. data/sig/openai/models/moderation_text_input.rbs +15 -0
  1294. data/sig/openai/models/other_file_chunking_strategy_object.rbs +13 -0
  1295. data/sig/openai/models/reasoning.rbs +54 -0
  1296. data/sig/openai/models/reasoning_effort.rbs +15 -0
  1297. data/sig/openai/models/response_format_json_object.rbs +13 -0
  1298. data/sig/openai/models/response_format_json_schema.rbs +61 -0
  1299. data/sig/openai/models/response_format_text.rbs +13 -0
  1300. data/sig/openai/models/responses/computer_tool.rbs +51 -0
  1301. data/sig/openai/models/responses/easy_input_message.rbs +69 -0
  1302. data/sig/openai/models/responses/file_search_tool.rbs +95 -0
  1303. data/sig/openai/models/responses/function_tool.rbs +42 -0
  1304. data/sig/openai/models/responses/input_item_list_params.rbs +73 -0
  1305. data/sig/openai/models/responses/response.rbs +217 -0
  1306. data/sig/openai/models/responses/response_audio_delta_event.rbs +32 -0
  1307. data/sig/openai/models/responses/response_audio_done_event.rbs +24 -0
  1308. data/sig/openai/models/responses/response_audio_transcript_delta_event.rbs +32 -0
  1309. data/sig/openai/models/responses/response_audio_transcript_done_event.rbs +24 -0
  1310. data/sig/openai/models/responses/response_cancel_params.rbs +17 -0
  1311. data/sig/openai/models/responses/response_code_interpreter_call_code_delta_event.rbs +37 -0
  1312. data/sig/openai/models/responses/response_code_interpreter_call_code_done_event.rbs +37 -0
  1313. data/sig/openai/models/responses/response_code_interpreter_call_completed_event.rbs +37 -0
  1314. data/sig/openai/models/responses/response_code_interpreter_call_in_progress_event.rbs +37 -0
  1315. data/sig/openai/models/responses/response_code_interpreter_call_interpreting_event.rbs +37 -0
  1316. data/sig/openai/models/responses/response_code_interpreter_tool_call.rbs +117 -0
  1317. data/sig/openai/models/responses/response_completed_event.rbs +32 -0
  1318. data/sig/openai/models/responses/response_computer_tool_call.rbs +294 -0
  1319. data/sig/openai/models/responses/response_computer_tool_call_output_item.rbs +82 -0
  1320. data/sig/openai/models/responses/response_computer_tool_call_output_screenshot.rbs +32 -0
  1321. data/sig/openai/models/responses/response_content.rbs +18 -0
  1322. data/sig/openai/models/responses/response_content_part_added_event.rbs +57 -0
  1323. data/sig/openai/models/responses/response_content_part_done_event.rbs +57 -0
  1324. data/sig/openai/models/responses/response_create_params.rbs +174 -0
  1325. data/sig/openai/models/responses/response_created_event.rbs +32 -0
  1326. data/sig/openai/models/responses/response_delete_params.rbs +17 -0
  1327. data/sig/openai/models/responses/response_error.rbs +72 -0
  1328. data/sig/openai/models/responses/response_error_event.rbs +42 -0
  1329. data/sig/openai/models/responses/response_failed_event.rbs +32 -0
  1330. data/sig/openai/models/responses/response_file_search_call_completed_event.rbs +37 -0
  1331. data/sig/openai/models/responses/response_file_search_call_in_progress_event.rbs +37 -0
  1332. data/sig/openai/models/responses/response_file_search_call_searching_event.rbs +37 -0
  1333. data/sig/openai/models/responses/response_file_search_tool_call.rbs +110 -0
  1334. data/sig/openai/models/responses/response_format_text_config.rbs +16 -0
  1335. data/sig/openai/models/responses/response_format_text_json_schema_config.rbs +44 -0
  1336. data/sig/openai/models/responses/response_function_call_arguments_delta_event.rbs +42 -0
  1337. data/sig/openai/models/responses/response_function_call_arguments_done_event.rbs +42 -0
  1338. data/sig/openai/models/responses/response_function_tool_call.rbs +65 -0
  1339. data/sig/openai/models/responses/response_function_tool_call_item.rbs +17 -0
  1340. data/sig/openai/models/responses/response_function_tool_call_output_item.rbs +58 -0
  1341. data/sig/openai/models/responses/response_function_web_search.rbs +45 -0
  1342. data/sig/openai/models/responses/response_image_gen_call_completed_event.rbs +37 -0
  1343. data/sig/openai/models/responses/response_image_gen_call_generating_event.rbs +37 -0
  1344. data/sig/openai/models/responses/response_image_gen_call_in_progress_event.rbs +37 -0
  1345. data/sig/openai/models/responses/response_image_gen_call_partial_image_event.rbs +47 -0
  1346. data/sig/openai/models/responses/response_in_progress_event.rbs +32 -0
  1347. data/sig/openai/models/responses/response_includable.rbs +22 -0
  1348. data/sig/openai/models/responses/response_incomplete_event.rbs +32 -0
  1349. data/sig/openai/models/responses/response_input.rbs +10 -0
  1350. data/sig/openai/models/responses/response_input_audio.rbs +43 -0
  1351. data/sig/openai/models/responses/response_input_content.rbs +16 -0
  1352. data/sig/openai/models/responses/response_input_file.rbs +41 -0
  1353. data/sig/openai/models/responses/response_input_image.rbs +49 -0
  1354. data/sig/openai/models/responses/response_input_item.rbs +630 -0
  1355. data/sig/openai/models/responses/response_input_message_content_list.rbs +10 -0
  1356. data/sig/openai/models/responses/response_input_message_item.rbs +84 -0
  1357. data/sig/openai/models/responses/response_input_text.rbs +17 -0
  1358. data/sig/openai/models/responses/response_item.rbs +399 -0
  1359. data/sig/openai/models/responses/response_item_list.rbs +44 -0
  1360. data/sig/openai/models/responses/response_mcp_call_arguments_delta_event.rbs +42 -0
  1361. data/sig/openai/models/responses/response_mcp_call_arguments_done_event.rbs +42 -0
  1362. data/sig/openai/models/responses/response_mcp_call_completed_event.rbs +24 -0
  1363. data/sig/openai/models/responses/response_mcp_call_failed_event.rbs +24 -0
  1364. data/sig/openai/models/responses/response_mcp_call_in_progress_event.rbs +37 -0
  1365. data/sig/openai/models/responses/response_mcp_list_tools_completed_event.rbs +24 -0
  1366. data/sig/openai/models/responses/response_mcp_list_tools_failed_event.rbs +24 -0
  1367. data/sig/openai/models/responses/response_mcp_list_tools_in_progress_event.rbs +27 -0
  1368. data/sig/openai/models/responses/response_output_audio.rbs +28 -0
  1369. data/sig/openai/models/responses/response_output_item.rbs +314 -0
  1370. data/sig/openai/models/responses/response_output_item_added_event.rbs +37 -0
  1371. data/sig/openai/models/responses/response_output_item_done_event.rbs +37 -0
  1372. data/sig/openai/models/responses/response_output_message.rbs +64 -0
  1373. data/sig/openai/models/responses/response_output_refusal.rbs +17 -0
  1374. data/sig/openai/models/responses/response_output_text.rbs +125 -0
  1375. data/sig/openai/models/responses/response_output_text_annotation_added_event.rbs +52 -0
  1376. data/sig/openai/models/responses/response_queued_event.rbs +32 -0
  1377. data/sig/openai/models/responses/response_reasoning_delta_event.rbs +47 -0
  1378. data/sig/openai/models/responses/response_reasoning_done_event.rbs +47 -0
  1379. data/sig/openai/models/responses/response_reasoning_item.rbs +70 -0
  1380. data/sig/openai/models/responses/response_reasoning_summary_delta_event.rbs +47 -0
  1381. data/sig/openai/models/responses/response_reasoning_summary_done_event.rbs +47 -0
  1382. data/sig/openai/models/responses/response_reasoning_summary_part_added_event.rbs +59 -0
  1383. data/sig/openai/models/responses/response_reasoning_summary_part_done_event.rbs +59 -0
  1384. data/sig/openai/models/responses/response_reasoning_summary_text_delta_event.rbs +47 -0
  1385. data/sig/openai/models/responses/response_reasoning_summary_text_done_event.rbs +47 -0
  1386. data/sig/openai/models/responses/response_refusal_delta_event.rbs +47 -0
  1387. data/sig/openai/models/responses/response_refusal_done_event.rbs +47 -0
  1388. data/sig/openai/models/responses/response_retrieve_params.rbs +30 -0
  1389. data/sig/openai/models/responses/response_status.rbs +21 -0
  1390. data/sig/openai/models/responses/response_stream_event.rbs +66 -0
  1391. data/sig/openai/models/responses/response_text_config.rbs +24 -0
  1392. data/sig/openai/models/responses/response_text_delta_event.rbs +47 -0
  1393. data/sig/openai/models/responses/response_text_done_event.rbs +47 -0
  1394. data/sig/openai/models/responses/response_usage.rbs +62 -0
  1395. data/sig/openai/models/responses/response_web_search_call_completed_event.rbs +37 -0
  1396. data/sig/openai/models/responses/response_web_search_call_in_progress_event.rbs +37 -0
  1397. data/sig/openai/models/responses/response_web_search_call_searching_event.rbs +37 -0
  1398. data/sig/openai/models/responses/tool.rbs +400 -0
  1399. data/sig/openai/models/responses/tool_choice_function.rbs +17 -0
  1400. data/sig/openai/models/responses/tool_choice_options.rbs +17 -0
  1401. data/sig/openai/models/responses/tool_choice_types.rbs +43 -0
  1402. data/sig/openai/models/responses/web_search_tool.rbs +96 -0
  1403. data/sig/openai/models/responses_model.rbs +31 -0
  1404. data/sig/openai/models/static_file_chunking_strategy.rbs +22 -0
  1405. data/sig/openai/models/static_file_chunking_strategy_object.rbs +22 -0
  1406. data/sig/openai/models/static_file_chunking_strategy_object_param.rbs +22 -0
  1407. data/sig/openai/models/upload.rbs +73 -0
  1408. data/sig/openai/models/upload_cancel_params.rbs +15 -0
  1409. data/sig/openai/models/upload_complete_params.rbs +30 -0
  1410. data/sig/openai/models/upload_create_params.rbs +41 -0
  1411. data/sig/openai/models/uploads/part_create_params.rbs +26 -0
  1412. data/sig/openai/models/uploads/upload_part.rbs +39 -0
  1413. data/sig/openai/models/vector_store.rbs +135 -0
  1414. data/sig/openai/models/vector_store_create_params.rbs +70 -0
  1415. data/sig/openai/models/vector_store_delete_params.rbs +15 -0
  1416. data/sig/openai/models/vector_store_deleted.rbs +26 -0
  1417. data/sig/openai/models/vector_store_list_params.rbs +62 -0
  1418. data/sig/openai/models/vector_store_retrieve_params.rbs +15 -0
  1419. data/sig/openai/models/vector_store_search_params.rbs +115 -0
  1420. data/sig/openai/models/vector_store_search_response.rbs +80 -0
  1421. data/sig/openai/models/vector_store_update_params.rbs +48 -0
  1422. data/sig/openai/models/vector_stores/file_batch_cancel_params.rbs +25 -0
  1423. data/sig/openai/models/vector_stores/file_batch_create_params.rbs +50 -0
  1424. data/sig/openai/models/vector_stores/file_batch_list_files_params.rbs +91 -0
  1425. data/sig/openai/models/vector_stores/file_batch_retrieve_params.rbs +25 -0
  1426. data/sig/openai/models/vector_stores/file_content_params.rbs +25 -0
  1427. data/sig/openai/models/vector_stores/file_content_response.rbs +21 -0
  1428. data/sig/openai/models/vector_stores/file_create_params.rbs +50 -0
  1429. data/sig/openai/models/vector_stores/file_delete_params.rbs +25 -0
  1430. data/sig/openai/models/vector_stores/file_list_params.rbs +86 -0
  1431. data/sig/openai/models/vector_stores/file_retrieve_params.rbs +25 -0
  1432. data/sig/openai/models/vector_stores/file_update_params.rbs +41 -0
  1433. data/sig/openai/models/vector_stores/vector_store_file.rbs +123 -0
  1434. data/sig/openai/models/vector_stores/vector_store_file_batch.rbs +99 -0
  1435. data/sig/openai/models/vector_stores/vector_store_file_deleted.rbs +30 -0
  1436. data/sig/openai/models.rbs +195 -0
  1437. data/sig/openai/request_options.rbs +34 -0
  1438. data/sig/openai/resources/audio/speech.rbs +19 -0
  1439. data/sig/openai/resources/audio/transcriptions.rbs +35 -0
  1440. data/sig/openai/resources/audio/translations.rbs +18 -0
  1441. data/sig/openai/resources/audio.rbs +13 -0
  1442. data/sig/openai/resources/batches.rbs +31 -0
  1443. data/sig/openai/resources/beta/assistants.rbs +58 -0
  1444. data/sig/openai/resources/beta/threads/messages.rbs +49 -0
  1445. data/sig/openai/resources/beta/threads/runs/steps.rbs +32 -0
  1446. data/sig/openai/resources/beta/threads/runs.rbs +99 -0
  1447. data/sig/openai/resources/beta/threads.rbs +75 -0
  1448. data/sig/openai/resources/beta.rbs +11 -0
  1449. data/sig/openai/resources/chat/completions/messages.rbs +19 -0
  1450. data/sig/openai/resources/chat/completions.rbs +104 -0
  1451. data/sig/openai/resources/chat.rbs +9 -0
  1452. data/sig/openai/resources/completions.rbs +49 -0
  1453. data/sig/openai/resources/containers/files/content.rbs +17 -0
  1454. data/sig/openai/resources/containers/files.rbs +38 -0
  1455. data/sig/openai/resources/containers.rbs +33 -0
  1456. data/sig/openai/resources/embeddings.rbs +16 -0
  1457. data/sig/openai/resources/evals/runs/output_items.rbs +28 -0
  1458. data/sig/openai/resources/evals/runs.rbs +46 -0
  1459. data/sig/openai/resources/evals.rbs +42 -0
  1460. data/sig/openai/resources/files.rbs +36 -0
  1461. data/sig/openai/resources/fine_tuning/alpha/graders.rbs +23 -0
  1462. data/sig/openai/resources/fine_tuning/alpha.rbs +11 -0
  1463. data/sig/openai/resources/fine_tuning/checkpoints/permissions.rbs +32 -0
  1464. data/sig/openai/resources/fine_tuning/checkpoints.rbs +11 -0
  1465. data/sig/openai/resources/fine_tuning/jobs/checkpoints.rbs +18 -0
  1466. data/sig/openai/resources/fine_tuning/jobs.rbs +58 -0
  1467. data/sig/openai/resources/fine_tuning/methods.rbs +9 -0
  1468. data/sig/openai/resources/fine_tuning.rbs +15 -0
  1469. data/sig/openai/resources/graders/grader_models.rbs +9 -0
  1470. data/sig/openai/resources/graders.rbs +9 -0
  1471. data/sig/openai/resources/images.rbs +47 -0
  1472. data/sig/openai/resources/models.rbs +21 -0
  1473. data/sig/openai/resources/moderations.rbs +13 -0
  1474. data/sig/openai/resources/responses/input_items.rbs +19 -0
  1475. data/sig/openai/resources/responses.rbs +71 -0
  1476. data/sig/openai/resources/uploads/parts.rbs +15 -0
  1477. data/sig/openai/resources/uploads.rbs +29 -0
  1478. data/sig/openai/resources/vector_stores/file_batches.rbs +40 -0
  1479. data/sig/openai/resources/vector_stores/files.rbs +52 -0
  1480. data/sig/openai/resources/vector_stores.rbs +56 -0
  1481. data/sig/openai/version.rbs +3 -0
  1482. metadata +1496 -78
  1483. data/.gitignore +0 -9
  1484. data/.travis.yml +0 -6
  1485. data/Gemfile +0 -4
  1486. data/LICENSE.txt +0 -21
  1487. data/Rakefile +0 -6
  1488. data/bin/console +0 -14
  1489. data/bin/setup +0 -8
  1490. data/lib/openai/choice.rb +0 -3
  1491. data/lib/openai/completion.rb +0 -7
  1492. data/lib/openai/engine.rb +0 -3
  1493. data/lib/openai/logprobs.rb +0 -3
  1494. data/lib/openai/search_result.rb +0 -3
  1495. data/openai.gemspec +0 -32
data/README.md CHANGED
@@ -1,57 +1,321 @@
1
- # OpenAI API client library to access GPT-3 in Ruby
1
+ # OpenAI Ruby API library
2
2
 
3
- This is a wrapper for calling OpenAI and GPT-3's HTTP APIs. API docs are available here: https://beta.openai.com/api-docs
3
+ The OpenAI Ruby library provides convenient access to the OpenAI REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/openai/openai-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
4
+
5
+ ## Documentation
6
+
7
+ Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/openai).
8
+
9
+ The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs).
4
10
 
5
11
  ## Installation
6
12
 
7
- Add this line to your application's Gemfile:
13
+ To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
14
+
15
+ <!-- x-release-please-start-version -->
8
16
 
9
17
  ```ruby
10
- gem 'openai'
18
+ gem "openai", "~> 0.4.1"
11
19
  ```
12
20
 
13
- And then execute:
21
+ <!-- x-release-please-end -->
14
22
 
15
- $ bundle
23
+ ## Usage
16
24
 
17
- Or install it yourself as:
25
+ ```ruby
26
+ require "bundler/setup"
27
+ require "openai"
18
28
 
19
- $ gem install openai
29
+ openai = OpenAI::Client.new(
30
+ api_key: ENV["OPENAI_API_KEY"] # This is the default and can be omitted
31
+ )
20
32
 
21
- ## Usage
33
+ chat_completion = openai.chat.completions.create(
34
+ messages: [{role: "user", content: "Say this is a test"}],
35
+ model: :"gpt-4.1"
36
+ )
37
+
38
+ puts(chat_completion)
39
+ ```
40
+
41
+ ### Streaming
42
+
43
+ We provide support for streaming responses using Server-Sent Events (SSE).
44
+
45
+ **coming soon:** `openai.chat.completions.stream` will soon come with Python SDK-style higher-level streaming responses support.
22
46
 
23
47
  ```ruby
24
- require "openai"
48
+ stream = openai.chat.completions.stream_raw(
49
+ messages: [{role: "user", content: "Say this is a test"}],
50
+ model: :"gpt-4.1"
51
+ )
52
+
53
+ stream.each do |completion|
54
+ puts(completion)
55
+ end
56
+ ```
25
57
 
26
- openai_client = OpenAI::Client.new(api_key: ENV.fetch("OPENAI_API_KEY"), default_engine: "ada")
58
+ ### Pagination
27
59
 
28
- # List Engines
29
- openai_client.engines
60
+ List methods in the OpenAI API are paginated.
30
61
 
31
- # Retrieve Engine
32
- openai_client.engine("babbage")
62
+ This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
33
63
 
34
- # Search
35
- openai_client.search(documents: ["White House", "hospital", "school"], query: "the president")
64
+ ```ruby
65
+ page = openai.fine_tuning.jobs.list(limit: 20)
36
66
 
37
- # Create Completion
38
- openai_client.completions(prompt: "Once upon a time", max_tokens: 5)
67
+ # Fetch single item from page.
68
+ job = page.data[0]
69
+ puts(job.id)
70
+
71
+ # Automatically fetches more pages as needed.
72
+ page.auto_paging_each do |job|
73
+ puts(job.id)
74
+ end
39
75
  ```
40
76
 
41
- ## TODO
77
+ Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
42
78
 
43
- * Stream Completion
79
+ ```ruby
80
+ if page.next_page?
81
+ new_page = page.next_page
82
+ puts(new_page.data[0].id)
83
+ end
84
+ ```
44
85
 
45
- ## Development
86
+ ### File uploads
46
87
 
47
- After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
88
+ Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
48
89
 
49
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
90
+ ```ruby
91
+ require "pathname"
50
92
 
51
- ## Contributing
93
+ # Use `Pathname` to send the filename and/or avoid paging a large file into memory:
94
+ file_object = openai.files.create(file: Pathname("input.jsonl"), purpose: "fine-tune")
95
+
96
+ # Alternatively, pass file contents or a `StringIO` directly:
97
+ file_object = openai.files.create(file: File.read("input.jsonl"), purpose: "fine-tune")
98
+
99
+ # Or, to control the filename and/or content type:
100
+ file = OpenAI::FilePart.new(File.read("input.jsonl"), filename: "input.jsonl", content_type: "…")
101
+ file_object = openai.files.create(file: file, purpose: "fine-tune")
102
+
103
+ puts(file_object.id)
104
+ ```
105
+
106
+ Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
107
+
108
+ ### Handling errors
109
+
110
+ When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `OpenAI::Errors::APIError` will be thrown:
111
+
112
+ ```ruby
113
+ begin
114
+ job = openai.fine_tuning.jobs.create(model: :"babbage-002", training_file: "file-abc123")
115
+ rescue OpenAI::Errors::APIConnectionError => e
116
+ puts("The server could not be reached")
117
+ puts(e.cause) # an underlying Exception, likely raised within `net/http`
118
+ rescue OpenAI::Errors::RateLimitError => e
119
+ puts("A 429 status code was received; we should back off a bit.")
120
+ rescue OpenAI::Errors::APIStatusError => e
121
+ puts("Another non-200-range status code was received")
122
+ puts(e.status)
123
+ end
124
+ ```
125
+
126
+ Error codes are as follows:
127
+
128
+ | Cause | Error Type |
129
+ | ---------------- | -------------------------- |
130
+ | HTTP 400 | `BadRequestError` |
131
+ | HTTP 401 | `AuthenticationError` |
132
+ | HTTP 403 | `PermissionDeniedError` |
133
+ | HTTP 404 | `NotFoundError` |
134
+ | HTTP 409 | `ConflictError` |
135
+ | HTTP 422 | `UnprocessableEntityError` |
136
+ | HTTP 429 | `RateLimitError` |
137
+ | HTTP >= 500 | `InternalServerError` |
138
+ | Other HTTP error | `APIStatusError` |
139
+ | Timeout | `APITimeoutError` |
140
+ | Network error | `APIConnectionError` |
141
+
142
+ ### Retries
143
+
144
+ Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
145
+
146
+ Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
147
+
148
+ You can use the `max_retries` option to configure or disable this:
149
+
150
+ ```ruby
151
+ # Configure the default for all requests:
152
+ openai = OpenAI::Client.new(
153
+ max_retries: 0 # default is 2
154
+ )
155
+
156
+ # Or, configure per-request:
157
+ openai.chat.completions.create(
158
+ messages: [{role: "user", content: "How can I get the name of the current day in JavaScript?"}],
159
+ model: :"gpt-4.1",
160
+ request_options: {max_retries: 5}
161
+ )
162
+ ```
163
+
164
+ ### Timeouts
165
+
166
+ By default, requests will time out after 600 seconds. You can use the timeout option to configure or disable this:
167
+
168
+ ```ruby
169
+ # Configure the default for all requests:
170
+ openai = OpenAI::Client.new(
171
+ timeout: nil # default is 600
172
+ )
173
+
174
+ # Or, configure per-request:
175
+ openai.chat.completions.create(
176
+ messages: [{role: "user", content: "How can I list all files in a directory using Python?"}],
177
+ model: :"gpt-4.1",
178
+ request_options: {timeout: 5}
179
+ )
180
+ ```
181
+
182
+ On timeout, `OpenAI::Errors::APITimeoutError` is raised.
183
+
184
+ Note that requests that time out are retried by default.
185
+
186
+ ## Advanced concepts
187
+
188
+ ### BaseModel
52
189
 
53
- Bug reports and pull requests are welcome on GitHub at https://github.com/nileshtrivedi/openai.
190
+ All parameter and response objects inherit from `OpenAI::Internal::Type::BaseModel`, which provides several conveniences, including:
54
191
 
55
- ## License
192
+ 1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
193
+
194
+ 2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
195
+
196
+ 3. Both instances and the classes themselves can be pretty-printed.
197
+
198
+ 4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
199
+
200
+ ### Making custom or undocumented requests
201
+
202
+ #### Undocumented properties
203
+
204
+ You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
205
+
206
+ Note: the `extra_` parameters of the same name overrides the documented parameters.
207
+
208
+ ```ruby
209
+ chat_completion =
210
+ openai.chat.completions.create(
211
+ messages: [{role: "user", content: "How can I get the name of the current day in JavaScript?"}],
212
+ model: :"gpt-4.1",
213
+ request_options: {
214
+ extra_query: {my_query_parameter: value},
215
+ extra_body: {my_body_parameter: value},
216
+ extra_headers: {"my-header": value}
217
+ }
218
+ )
219
+
220
+ puts(chat_completion[:my_undocumented_property])
221
+ ```
222
+
223
+ #### Undocumented request params
224
+
225
+ If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
226
+
227
+ #### Undocumented endpoints
228
+
229
+ To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
230
+
231
+ ```ruby
232
+ response = client.request(
233
+ method: :post,
234
+ path: '/undocumented/endpoint',
235
+ query: {"dog": "woof"},
236
+ headers: {"useful-header": "interesting-value"},
237
+ body: {"hello": "world"}
238
+ )
239
+ ```
240
+
241
+ ### Concurrency & connection pooling
242
+
243
+ The `OpenAI::Client` instances are threadsafe, but are only fork-safe when there are no in-flight HTTP requests.
244
+
245
+ Each instance of `OpenAI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
246
+
247
+ When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
248
+
249
+ Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
250
+
251
+ ## Sorbet
252
+
253
+ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions and has no dependency on sorbet-runtime.
254
+
255
+ You can provide typesafe request parameters like so:
256
+
257
+ ```ruby
258
+ openai.chat.completions.create(
259
+ messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
260
+ model: :"gpt-4.1"
261
+ )
262
+ ```
263
+
264
+ Or, equivalently:
265
+
266
+ ```ruby
267
+ # Hashes work, but are not typesafe:
268
+ openai.chat.completions.create(
269
+ messages: [{role: "user", content: "Say this is a test"}],
270
+ model: :"gpt-4.1"
271
+ )
272
+
273
+ # You can also splat a full Params class:
274
+ params = OpenAI::Chat::CompletionCreateParams.new(
275
+ messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
276
+ model: :"gpt-4.1"
277
+ )
278
+ openai.chat.completions.create(**params)
279
+ ```
280
+
281
+ ### Enums
282
+
283
+ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
284
+
285
+ ```ruby
286
+ # :low
287
+ puts(OpenAI::ReasoningEffort::LOW)
288
+
289
+ # Revealed type: `T.all(OpenAI::ReasoningEffort, Symbol)`
290
+ T.reveal_type(OpenAI::ReasoningEffort::LOW)
291
+ ```
292
+
293
+ Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
294
+
295
+ ```ruby
296
+ # Using the enum constants preserves the tagged type information:
297
+ openai.chat.completions.create(
298
+ reasoning_effort: OpenAI::ReasoningEffort::LOW,
299
+ # …
300
+ )
301
+
302
+ # Literal values are also permissible:
303
+ openai.chat.completions.create(
304
+ reasoning_effort: :low,
305
+ # …
306
+ )
307
+ ```
308
+
309
+ ## Versioning
310
+
311
+ This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
312
+
313
+ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
314
+
315
+ ## Requirements
316
+
317
+ Ruby 3.2.0 or higher.
318
+
319
+ ## Contributing
56
320
 
57
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
321
+ See [the contributing documentation](https://github.com/openai/openai-ruby/tree/main/CONTRIBUTING.md).
data/SECURITY.md ADDED
@@ -0,0 +1,29 @@
1
+ # Security Policy
2
+
3
+ ## Reporting Security Issues
4
+
5
+ This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
6
+
7
+ To report a security issue, please contact the Stainless team at security@stainless.com.
8
+
9
+ ## Responsible Disclosure
10
+
11
+ We appreciate the efforts of security researchers and individuals who help us maintain the security of
12
+ SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
13
+ disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
14
+ before making any information public.
15
+
16
+ ## Reporting Non-SDK Related Security Issues
17
+
18
+ If you encounter security issues that are not directly related to SDKs but pertain to the services
19
+ or products provided by OpenAI, please follow the respective company's security reporting guidelines.
20
+
21
+ ### OpenAI Terms and Policies
22
+
23
+ Our Security Policy can be found at [Security Policy URL](https://openai.com/policies/coordinated-vulnerability-disclosure-policy).
24
+
25
+ Please contact disclosure@openai.com for any questions or concerns regarding the security of our services.
26
+
27
+ ---
28
+
29
+ Thank you for helping us keep the SDKs and systems they interact with secure.
data/lib/openai/client.rb CHANGED
@@ -1,140 +1,156 @@
1
- require "json"
2
- require "net/http"
3
- require "time"
4
- require "uri"
1
+ # frozen_string_literal: true
5
2
 
6
3
  module OpenAI
7
- class Client
8
- class Error < RuntimeError
9
- end
4
+ class Client < OpenAI::Internal::Transport::BaseClient
5
+ # Default max number of retries to attempt after a failed retryable request.
6
+ DEFAULT_MAX_RETRIES = 2
10
7
 
11
- LastResponse = Struct.new(:date, :organization, :processing_ms, :request_id, :status_code, :status_message, keyword_init: true)
8
+ # Default per-request timeout.
9
+ DEFAULT_TIMEOUT_IN_SECONDS = 600.0
12
10
 
13
- attr_reader :last_response
14
- attr_writer :api_key
15
- attr_accessor :default_engine
11
+ # Default initial retry delay in seconds.
12
+ # Overall delay is calculated using exponential backoff + jitter.
13
+ DEFAULT_INITIAL_RETRY_DELAY = 0.5
16
14
 
17
- def initialize(api_key:, default_engine: "davinci")
18
- @api_key = api_key
19
- @default_engine = default_engine
20
- end
15
+ # Default max retry delay in seconds.
16
+ DEFAULT_MAX_RETRY_DELAY = 8.0
21
17
 
22
- def engine(id = default_engine)
23
- engine = get("/v1/engines/#{id}")
24
- Engine.new(**engine)
25
- end
18
+ # @return [String]
19
+ attr_reader :api_key
26
20
 
27
- def engines
28
- engines = get("/v1/engines")
29
- engines[:data].map do |engine|
30
- Engine.new(**engine)
31
- end
32
- end
21
+ # @return [String, nil]
22
+ attr_reader :organization
33
23
 
34
- def completions(prompt: nil, max_tokens: nil, temperature: nil, top_p: nil, n: nil, logprobs: nil, echo: nil, stop: nil, presence_penalty: nil, frequency_penalty: nil, best_of: nil, engine: default_engine)
35
- body = {
36
- "prompt" => prompt,
37
- "max_tokens" => max_tokens,
38
- "temperature" => temperature,
39
- "top_p" => top_p,
40
- "n" => n,
41
- "logprobs" => logprobs,
42
- "echo" => echo,
43
- "stop" => stop,
44
- "presence_penalty" => presence_penalty,
45
- "frequency_penalty" => frequency_penalty,
46
- "best_of" => best_of,
47
- }.compact
48
-
49
- completion = post("/v1/engines/#{engine}/completions", body: body)
50
-
51
- choices = completion[:choices]&.map do |choice|
52
- Choice.new(
53
- finish_reason: choice[:finish_reason],
54
- index: choice[:index],
55
- text: choice[:text],
56
- logprobs: choice[:logprobs]&.tap do |logprob|
57
- Logprobs.new(
58
- text_offset: logprob[:text_offset],
59
- token_logprobs: logprob[:token_logprobs],
60
- tokens: logprob[:tokens],
61
- top_logprobs: logprob[:top_logprobs]
62
- )
63
- end
64
- )
65
- end
24
+ # @return [String, nil]
25
+ attr_reader :project
66
26
 
67
- Completion.new(
68
- choices: choices,
69
- created: completion[:created],
70
- id: completion[:id],
71
- model: completion[:model],
72
- object: completion[:object]
73
- )
74
- end
27
+ # @return [OpenAI::Resources::Completions]
28
+ attr_reader :completions
75
29
 
76
- def search(documents:, query:, engine: default_engine)
77
- body = {
78
- "documents" => documents,
79
- "query" => query,
80
- }.compact
81
-
82
- search_results = post("/v1/engines/#{engine}/search", body: body)
83
- search_results[:data].map.with_index do |datum, index|
84
- SearchResult.new(**datum).tap do |result|
85
- result.text = documents[index]
86
- end
87
- end
88
- end
30
+ # @return [OpenAI::Resources::Chat]
31
+ attr_reader :chat
89
32
 
90
- private def get(path)
91
- uri = URI.parse("https://api.openai.com#{path}")
92
- req = Net::HTTP::Get.new(uri)
93
- headers.each do |name, value|
94
- req[name] = value
95
- end
96
- response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
97
- http.request(req)
98
- end
99
- handle_response(response)
100
- end
33
+ # @return [OpenAI::Resources::Embeddings]
34
+ attr_reader :embeddings
101
35
 
102
- private def post(path, body: nil)
103
- uri = URI.parse("https://api.openai.com#{path}")
104
- req = Net::HTTP::Post.new(uri)
105
- req.body = body.to_json
106
- headers.each do |name, value|
107
- req[name] = value
108
- end
109
- response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
110
- http.request(req)
111
- end
112
- handle_response(response)
36
+ # @return [OpenAI::Resources::Files]
37
+ attr_reader :files
38
+
39
+ # @return [OpenAI::Resources::Images]
40
+ attr_reader :images
41
+
42
+ # @return [OpenAI::Resources::Audio]
43
+ attr_reader :audio
44
+
45
+ # @return [OpenAI::Resources::Moderations]
46
+ attr_reader :moderations
47
+
48
+ # @return [OpenAI::Resources::Models]
49
+ attr_reader :models
50
+
51
+ # @return [OpenAI::Resources::FineTuning]
52
+ attr_reader :fine_tuning
53
+
54
+ # @return [OpenAI::Resources::Graders]
55
+ attr_reader :graders
56
+
57
+ # @return [OpenAI::Resources::VectorStores]
58
+ attr_reader :vector_stores
59
+
60
+ # @return [OpenAI::Resources::Beta]
61
+ attr_reader :beta
62
+
63
+ # @return [OpenAI::Resources::Batches]
64
+ attr_reader :batches
65
+
66
+ # @return [OpenAI::Resources::Uploads]
67
+ attr_reader :uploads
68
+
69
+ # @return [OpenAI::Resources::Responses]
70
+ attr_reader :responses
71
+
72
+ # @return [OpenAI::Resources::Evals]
73
+ attr_reader :evals
74
+
75
+ # @return [OpenAI::Resources::Containers]
76
+ attr_reader :containers
77
+
78
+ # @api private
79
+ #
80
+ # @return [Hash{String=>String}]
81
+ private def auth_headers
82
+ return {} if @api_key.nil?
83
+
84
+ {"authorization" => "Bearer #{@api_key}"}
113
85
  end
114
86
 
115
- private def handle_response(response)
116
- date = Time.httpdate(response["date"]) if response["date"]
117
- organization = response["openai-organization"]
118
- processing_ms = response["openai-processing-ms"]&.to_i
119
- request_id = response["x-request-id"]
120
- status_code = response.code&.to_i
121
- status_message = response.message
122
- @last_response = LastResponse.new(date: date, organization: organization, processing_ms: processing_ms, request_id: request_id, status_code: status_code, status_message: status_message)
123
-
124
- response_body = JSON.parse(response.body, symbolize_names: true)
125
- case response
126
- when Net::HTTPSuccess
127
- response_body
128
- else
129
- raise Error, response_body[:error][:message].to_s
87
+ # Creates and returns a new client for interacting with the API.
88
+ #
89
+ # @param api_key [String, nil] Defaults to `ENV["OPENAI_API_KEY"]`
90
+ #
91
+ # @param organization [String, nil] Defaults to `ENV["OPENAI_ORG_ID"]`
92
+ #
93
+ # @param project [String, nil] Defaults to `ENV["OPENAI_PROJECT_ID"]`
94
+ #
95
+ # @param base_url [String, nil] Override the default base URL for the API, e.g.,
96
+ # `"https://api.example.com/v2/"`. Defaults to `ENV["OPENAI_BASE_URL"]`
97
+ #
98
+ # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
99
+ #
100
+ # @param timeout [Float]
101
+ #
102
+ # @param initial_retry_delay [Float]
103
+ #
104
+ # @param max_retry_delay [Float]
105
+ def initialize(
106
+ api_key: ENV["OPENAI_API_KEY"],
107
+ organization: ENV["OPENAI_ORG_ID"],
108
+ project: ENV["OPENAI_PROJECT_ID"],
109
+ base_url: ENV["OPENAI_BASE_URL"],
110
+ max_retries: self.class::DEFAULT_MAX_RETRIES,
111
+ timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
112
+ initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
113
+ max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
114
+ )
115
+ base_url ||= "https://api.openai.com/v1"
116
+
117
+ if api_key.nil?
118
+ raise ArgumentError.new("api_key is required, and can be set via environ: \"OPENAI_API_KEY\"")
130
119
  end
131
- end
132
120
 
133
- private def headers
134
- @headers ||= {
135
- "Authorization" => "Bearer #{@api_key}",
136
- "Content-Type" => "application/json",
121
+ headers = {
122
+ "openai-organization" => (@organization = organization&.to_s),
123
+ "openai-project" => (@project = project&.to_s)
137
124
  }
125
+
126
+ @api_key = api_key.to_s
127
+
128
+ super(
129
+ base_url: base_url,
130
+ timeout: timeout,
131
+ max_retries: max_retries,
132
+ initial_retry_delay: initial_retry_delay,
133
+ max_retry_delay: max_retry_delay,
134
+ headers: headers
135
+ )
136
+
137
+ @completions = OpenAI::Resources::Completions.new(client: self)
138
+ @chat = OpenAI::Resources::Chat.new(client: self)
139
+ @embeddings = OpenAI::Resources::Embeddings.new(client: self)
140
+ @files = OpenAI::Resources::Files.new(client: self)
141
+ @images = OpenAI::Resources::Images.new(client: self)
142
+ @audio = OpenAI::Resources::Audio.new(client: self)
143
+ @moderations = OpenAI::Resources::Moderations.new(client: self)
144
+ @models = OpenAI::Resources::Models.new(client: self)
145
+ @fine_tuning = OpenAI::Resources::FineTuning.new(client: self)
146
+ @graders = OpenAI::Resources::Graders.new(client: self)
147
+ @vector_stores = OpenAI::Resources::VectorStores.new(client: self)
148
+ @beta = OpenAI::Resources::Beta.new(client: self)
149
+ @batches = OpenAI::Resources::Batches.new(client: self)
150
+ @uploads = OpenAI::Resources::Uploads.new(client: self)
151
+ @responses = OpenAI::Resources::Responses.new(client: self)
152
+ @evals = OpenAI::Resources::Evals.new(client: self)
153
+ @containers = OpenAI::Resources::Containers.new(client: self)
138
154
  end
139
155
  end
140
156
  end