openai 0.1.0.pre.beta.2

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 (1482) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +352 -0
  4. data/README.md +323 -0
  5. data/SECURITY.md +29 -0
  6. data/lib/openai/client.rb +156 -0
  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 +907 -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 +58 -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 +363 -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 +42 -0
  352. data/lib/openai/models/responses/response_format_text_json_schema_config.rb +65 -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 +81 -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 +165 -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 +510 -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 +248 -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 +5 -0
  500. data/lib/openai.rb +520 -0
  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 +680 -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 +144 -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 +267 -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 +481 -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 +1539 -0
@@ -0,0 +1,714 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Chat
6
+ # @see OpenAI::Resources::Chat::Completions#create
7
+ #
8
+ # @see OpenAI::Resources::Chat::Completions#stream_raw
9
+ class CompletionCreateParams < OpenAI::Internal::Type::BaseModel
10
+ extend OpenAI::Internal::Type::RequestParameters::Converter
11
+ include OpenAI::Internal::Type::RequestParameters
12
+
13
+ # @!attribute messages
14
+ # A list of messages comprising the conversation so far. Depending on the
15
+ # [model](https://platform.openai.com/docs/models) you use, different message
16
+ # types (modalities) are supported, like
17
+ # [text](https://platform.openai.com/docs/guides/text-generation),
18
+ # [images](https://platform.openai.com/docs/guides/vision), and
19
+ # [audio](https://platform.openai.com/docs/guides/audio).
20
+ #
21
+ # @return [Array<OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam, OpenAI::Models::Chat::ChatCompletionSystemMessageParam, OpenAI::Models::Chat::ChatCompletionUserMessageParam, OpenAI::Models::Chat::ChatCompletionAssistantMessageParam, OpenAI::Models::Chat::ChatCompletionToolMessageParam, OpenAI::Models::Chat::ChatCompletionFunctionMessageParam>]
22
+ required :messages,
23
+ -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Chat::ChatCompletionMessageParam] }
24
+
25
+ # @!attribute model
26
+ # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
27
+ # wide range of models with different capabilities, performance characteristics,
28
+ # and price points. Refer to the
29
+ # [model guide](https://platform.openai.com/docs/models) to browse and compare
30
+ # available models.
31
+ #
32
+ # @return [String, Symbol, OpenAI::Models::ChatModel]
33
+ required :model, union: -> { OpenAI::Chat::CompletionCreateParams::Model }
34
+
35
+ # @!attribute audio
36
+ # Parameters for audio output. Required when audio output is requested with
37
+ # `modalities: ["audio"]`.
38
+ # [Learn more](https://platform.openai.com/docs/guides/audio).
39
+ #
40
+ # @return [OpenAI::Models::Chat::ChatCompletionAudioParam, nil]
41
+ optional :audio, -> { OpenAI::Chat::ChatCompletionAudioParam }, nil?: true
42
+
43
+ # @!attribute frequency_penalty
44
+ # Number between -2.0 and 2.0. Positive values penalize new tokens based on their
45
+ # existing frequency in the text so far, decreasing the model's likelihood to
46
+ # repeat the same line verbatim.
47
+ #
48
+ # @return [Float, nil]
49
+ optional :frequency_penalty, Float, nil?: true
50
+
51
+ # @!attribute function_call
52
+ # @deprecated
53
+ #
54
+ # Deprecated in favor of `tool_choice`.
55
+ #
56
+ # Controls which (if any) function is called by the model.
57
+ #
58
+ # `none` means the model will not call a function and instead generates a message.
59
+ #
60
+ # `auto` means the model can pick between generating a message or calling a
61
+ # function.
62
+ #
63
+ # Specifying a particular function via `{"name": "my_function"}` forces the model
64
+ # to call that function.
65
+ #
66
+ # `none` is the default when no functions are present. `auto` is the default if
67
+ # functions are present.
68
+ #
69
+ # @return [Symbol, OpenAI::Models::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode, OpenAI::Models::Chat::ChatCompletionFunctionCallOption, nil]
70
+ optional :function_call, union: -> { OpenAI::Chat::CompletionCreateParams::FunctionCall }
71
+
72
+ # @!attribute functions
73
+ # @deprecated
74
+ #
75
+ # Deprecated in favor of `tools`.
76
+ #
77
+ # A list of functions the model may generate JSON inputs for.
78
+ #
79
+ # @return [Array<OpenAI::Models::Chat::CompletionCreateParams::Function>, nil]
80
+ optional :functions,
81
+ -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::CompletionCreateParams::Function] }
82
+
83
+ # @!attribute logit_bias
84
+ # Modify the likelihood of specified tokens appearing in the completion.
85
+ #
86
+ # Accepts a JSON object that maps tokens (specified by their token ID in the
87
+ # tokenizer) to an associated bias value from -100 to 100. Mathematically, the
88
+ # bias is added to the logits generated by the model prior to sampling. The exact
89
+ # effect will vary per model, but values between -1 and 1 should decrease or
90
+ # increase likelihood of selection; values like -100 or 100 should result in a ban
91
+ # or exclusive selection of the relevant token.
92
+ #
93
+ # @return [Hash{Symbol=>Integer}, nil]
94
+ optional :logit_bias, OpenAI::Internal::Type::HashOf[Integer], nil?: true
95
+
96
+ # @!attribute logprobs
97
+ # Whether to return log probabilities of the output tokens or not. If true,
98
+ # returns the log probabilities of each output token returned in the `content` of
99
+ # `message`.
100
+ #
101
+ # @return [Boolean, nil]
102
+ optional :logprobs, OpenAI::Internal::Type::Boolean, nil?: true
103
+
104
+ # @!attribute max_completion_tokens
105
+ # An upper bound for the number of tokens that can be generated for a completion,
106
+ # including visible output tokens and
107
+ # [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
108
+ #
109
+ # @return [Integer, nil]
110
+ optional :max_completion_tokens, Integer, nil?: true
111
+
112
+ # @!attribute max_tokens
113
+ # @deprecated
114
+ #
115
+ # The maximum number of [tokens](/tokenizer) that can be generated in the chat
116
+ # completion. This value can be used to control
117
+ # [costs](https://openai.com/api/pricing/) for text generated via API.
118
+ #
119
+ # This value is now deprecated in favor of `max_completion_tokens`, and is not
120
+ # compatible with
121
+ # [o-series models](https://platform.openai.com/docs/guides/reasoning).
122
+ #
123
+ # @return [Integer, nil]
124
+ optional :max_tokens, Integer, nil?: true
125
+
126
+ # @!attribute metadata
127
+ # Set of 16 key-value pairs that can be attached to an object. This can be useful
128
+ # for storing additional information about the object in a structured format, and
129
+ # querying for objects via API or the dashboard.
130
+ #
131
+ # Keys are strings with a maximum length of 64 characters. Values are strings with
132
+ # a maximum length of 512 characters.
133
+ #
134
+ # @return [Hash{Symbol=>String}, nil]
135
+ optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
136
+
137
+ # @!attribute modalities
138
+ # Output types that you would like the model to generate. Most models are capable
139
+ # of generating text, which is the default:
140
+ #
141
+ # `["text"]`
142
+ #
143
+ # The `gpt-4o-audio-preview` model can also be used to
144
+ # [generate audio](https://platform.openai.com/docs/guides/audio). To request that
145
+ # this model generate both text and audio responses, you can use:
146
+ #
147
+ # `["text", "audio"]`
148
+ #
149
+ # @return [Array<Symbol, OpenAI::Models::Chat::CompletionCreateParams::Modality>, nil]
150
+ optional :modalities,
151
+ -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Chat::CompletionCreateParams::Modality] },
152
+ nil?: true
153
+
154
+ # @!attribute n
155
+ # How many chat completion choices to generate for each input message. Note that
156
+ # you will be charged based on the number of generated tokens across all of the
157
+ # choices. Keep `n` as `1` to minimize costs.
158
+ #
159
+ # @return [Integer, nil]
160
+ optional :n, Integer, nil?: true
161
+
162
+ # @!attribute parallel_tool_calls
163
+ # Whether to enable
164
+ # [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
165
+ # during tool use.
166
+ #
167
+ # @return [Boolean, nil]
168
+ optional :parallel_tool_calls, OpenAI::Internal::Type::Boolean
169
+
170
+ # @!attribute prediction
171
+ # Static predicted output content, such as the content of a text file that is
172
+ # being regenerated.
173
+ #
174
+ # @return [OpenAI::Models::Chat::ChatCompletionPredictionContent, nil]
175
+ optional :prediction, -> { OpenAI::Chat::ChatCompletionPredictionContent }, nil?: true
176
+
177
+ # @!attribute presence_penalty
178
+ # Number between -2.0 and 2.0. Positive values penalize new tokens based on
179
+ # whether they appear in the text so far, increasing the model's likelihood to
180
+ # talk about new topics.
181
+ #
182
+ # @return [Float, nil]
183
+ optional :presence_penalty, Float, nil?: true
184
+
185
+ # @!attribute reasoning_effort
186
+ # **o-series models only**
187
+ #
188
+ # Constrains effort on reasoning for
189
+ # [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
190
+ # supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
191
+ # result in faster responses and fewer tokens used on reasoning in a response.
192
+ #
193
+ # @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
194
+ optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
195
+
196
+ # @!attribute response_format
197
+ # An object specifying the format that the model must output.
198
+ #
199
+ # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
200
+ # Outputs which ensures the model will match your supplied JSON schema. Learn more
201
+ # in the
202
+ # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
203
+ #
204
+ # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
205
+ # ensures the message the model generates is valid JSON. Using `json_schema` is
206
+ # preferred for models that support it.
207
+ #
208
+ # @return [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::ResponseFormatJSONObject, nil]
209
+ optional :response_format, union: -> { OpenAI::Chat::CompletionCreateParams::ResponseFormat }
210
+
211
+ # @!attribute seed
212
+ # This feature is in Beta. If specified, our system will make a best effort to
213
+ # sample deterministically, such that repeated requests with the same `seed` and
214
+ # parameters should return the same result. Determinism is not guaranteed, and you
215
+ # should refer to the `system_fingerprint` response parameter to monitor changes
216
+ # in the backend.
217
+ #
218
+ # @return [Integer, nil]
219
+ optional :seed, Integer, nil?: true
220
+
221
+ # @!attribute service_tier
222
+ # Specifies the latency tier to use for processing the request. This parameter is
223
+ # relevant for customers subscribed to the scale tier service:
224
+ #
225
+ # - If set to 'auto', and the Project is Scale tier enabled, the system will
226
+ # utilize scale tier credits until they are exhausted.
227
+ # - If set to 'auto', and the Project is not Scale tier enabled, the request will
228
+ # be processed using the default service tier with a lower uptime SLA and no
229
+ # latency guarentee.
230
+ # - If set to 'default', the request will be processed using the default service
231
+ # tier with a lower uptime SLA and no latency guarentee.
232
+ # - If set to 'flex', the request will be processed with the Flex Processing
233
+ # service tier.
234
+ # [Learn more](https://platform.openai.com/docs/guides/flex-processing).
235
+ # - When not set, the default behavior is 'auto'.
236
+ #
237
+ # When this parameter is set, the response body will include the `service_tier`
238
+ # utilized.
239
+ #
240
+ # @return [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil]
241
+ optional :service_tier, enum: -> { OpenAI::Chat::CompletionCreateParams::ServiceTier }, nil?: true
242
+
243
+ # @!attribute stop
244
+ # Not supported with latest reasoning models `o3` and `o4-mini`.
245
+ #
246
+ # Up to 4 sequences where the API will stop generating further tokens. The
247
+ # returned text will not contain the stop sequence.
248
+ #
249
+ # @return [String, Array<String>, nil]
250
+ optional :stop, union: -> { OpenAI::Chat::CompletionCreateParams::Stop }, nil?: true
251
+
252
+ # @!attribute store
253
+ # Whether or not to store the output of this chat completion request for use in
254
+ # our [model distillation](https://platform.openai.com/docs/guides/distillation)
255
+ # or [evals](https://platform.openai.com/docs/guides/evals) products.
256
+ #
257
+ # @return [Boolean, nil]
258
+ optional :store, OpenAI::Internal::Type::Boolean, nil?: true
259
+
260
+ # @!attribute stream_options
261
+ # Options for streaming response. Only set this when you set `stream: true`.
262
+ #
263
+ # @return [OpenAI::Models::Chat::ChatCompletionStreamOptions, nil]
264
+ optional :stream_options, -> { OpenAI::Chat::ChatCompletionStreamOptions }, nil?: true
265
+
266
+ # @!attribute temperature
267
+ # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
268
+ # make the output more random, while lower values like 0.2 will make it more
269
+ # focused and deterministic. We generally recommend altering this or `top_p` but
270
+ # not both.
271
+ #
272
+ # @return [Float, nil]
273
+ optional :temperature, Float, nil?: true
274
+
275
+ # @!attribute tool_choice
276
+ # Controls which (if any) tool is called by the model. `none` means the model will
277
+ # not call any tool and instead generates a message. `auto` means the model can
278
+ # pick between generating a message or calling one or more tools. `required` means
279
+ # the model must call one or more tools. Specifying a particular tool via
280
+ # `{"type": "function", "function": {"name": "my_function"}}` forces the model to
281
+ # call that tool.
282
+ #
283
+ # `none` is the default when no tools are present. `auto` is the default if tools
284
+ # are present.
285
+ #
286
+ # @return [Symbol, OpenAI::Models::Chat::ChatCompletionToolChoiceOption::Auto, OpenAI::Models::Chat::ChatCompletionNamedToolChoice, nil]
287
+ optional :tool_choice, union: -> { OpenAI::Chat::ChatCompletionToolChoiceOption }
288
+
289
+ # @!attribute tools
290
+ # A list of tools the model may call. Currently, only functions are supported as a
291
+ # tool. Use this to provide a list of functions the model may generate JSON inputs
292
+ # for. A max of 128 functions are supported.
293
+ #
294
+ # @return [Array<OpenAI::Models::Chat::ChatCompletionTool, OpenAI::StructuredOutput::JsonSchemaConverter>, nil]
295
+ optional :tools,
296
+ -> {
297
+ OpenAI::Internal::Type::ArrayOf[union: OpenAI::UnionOf[
298
+ OpenAI::Chat::ChatCompletionTool, OpenAI::StructuredOutput::JsonSchemaConverter
299
+ ]]
300
+ }
301
+
302
+ # @!attribute top_logprobs
303
+ # An integer between 0 and 20 specifying the number of most likely tokens to
304
+ # return at each token position, each with an associated log probability.
305
+ # `logprobs` must be set to `true` if this parameter is used.
306
+ #
307
+ # @return [Integer, nil]
308
+ optional :top_logprobs, Integer, nil?: true
309
+
310
+ # @!attribute top_p
311
+ # An alternative to sampling with temperature, called nucleus sampling, where the
312
+ # model considers the results of the tokens with top_p probability mass. So 0.1
313
+ # means only the tokens comprising the top 10% probability mass are considered.
314
+ #
315
+ # We generally recommend altering this or `temperature` but not both.
316
+ #
317
+ # @return [Float, nil]
318
+ optional :top_p, Float, nil?: true
319
+
320
+ # @!attribute user
321
+ # A stable identifier for your end-users. Used to boost cache hit rates by better
322
+ # bucketing similar requests and to help OpenAI detect and prevent abuse.
323
+ # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
324
+ #
325
+ # @return [String, nil]
326
+ optional :user, String
327
+
328
+ # @!attribute web_search_options
329
+ # This tool searches the web for relevant results to use in a response. Learn more
330
+ # about the
331
+ # [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
332
+ #
333
+ # @return [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions, nil]
334
+ optional :web_search_options, -> { OpenAI::Chat::CompletionCreateParams::WebSearchOptions }
335
+
336
+ # @!method initialize(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, reasoning_effort: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, web_search_options: nil, request_options: {})
337
+ # Some parameter documentations has been truncated, see
338
+ # {OpenAI::Models::Chat::CompletionCreateParams} for more details.
339
+ #
340
+ # @param messages [Array<OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam, OpenAI::Models::Chat::ChatCompletionSystemMessageParam, OpenAI::Models::Chat::ChatCompletionUserMessageParam, OpenAI::Models::Chat::ChatCompletionAssistantMessageParam, OpenAI::Models::Chat::ChatCompletionToolMessageParam, OpenAI::Models::Chat::ChatCompletionFunctionMessageParam>] A list of messages comprising the conversation so far. Depending on the
341
+ #
342
+ # @param model [String, Symbol, OpenAI::Models::ChatModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
343
+ #
344
+ # @param audio [OpenAI::Models::Chat::ChatCompletionAudioParam, nil] Parameters for audio output. Required when audio output is requested with
345
+ #
346
+ # @param frequency_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on
347
+ #
348
+ # @param function_call [Symbol, OpenAI::Models::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode, OpenAI::Models::Chat::ChatCompletionFunctionCallOption] Deprecated in favor of `tool_choice`.
349
+ #
350
+ # @param functions [Array<OpenAI::Models::Chat::CompletionCreateParams::Function>] Deprecated in favor of `tools`.
351
+ #
352
+ # @param logit_bias [Hash{Symbol=>Integer}, nil] Modify the likelihood of specified tokens appearing in the completion.
353
+ #
354
+ # @param logprobs [Boolean, nil] Whether to return log probabilities of the output tokens or not. If true,
355
+ #
356
+ # @param max_completion_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a completion,
357
+ #
358
+ # @param max_tokens [Integer, nil] The maximum number of [tokens](/tokenizer) that can be generated in the
359
+ #
360
+ # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
361
+ #
362
+ # @param modalities [Array<Symbol, OpenAI::Models::Chat::CompletionCreateParams::Modality>, nil] Output types that you would like the model to generate.
363
+ #
364
+ # @param n [Integer, nil] How many chat completion choices to generate for each input message. Note that y
365
+ #
366
+ # @param parallel_tool_calls [Boolean] Whether to enable [parallel function calling](https://platform.openai.com/docs/g
367
+ #
368
+ # @param prediction [OpenAI::Models::Chat::ChatCompletionPredictionContent, nil] Static predicted output content, such as the content of a text file that is
369
+ #
370
+ # @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on
371
+ #
372
+ # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] **o-series models only**
373
+ #
374
+ # @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::ResponseFormatJSONObject] An object specifying the format that the model must output.
375
+ #
376
+ # @param seed [Integer, nil] This feature is in Beta.
377
+ #
378
+ # @param service_tier [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
379
+ #
380
+ # @param stop [String, Array<String>, nil] Not supported with latest reasoning models `o3` and `o4-mini`.
381
+ #
382
+ # @param store [Boolean, nil] Whether or not to store the output of this chat completion request for
383
+ #
384
+ # @param stream_options [OpenAI::Models::Chat::ChatCompletionStreamOptions, nil] Options for streaming response. Only set this when you set `stream: true`.
385
+ #
386
+ # @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
387
+ #
388
+ # @param tool_choice [Symbol, OpenAI::Models::Chat::ChatCompletionToolChoiceOption::Auto, OpenAI::Models::Chat::ChatCompletionNamedToolChoice] Controls which (if any) tool is called by the model.
389
+ #
390
+ # @param tools [Array<OpenAI::Models::Chat::ChatCompletionTool, OpenAI::StructuredOutput::JsonSchemaConverter>] A list of tools the model may call. Currently, only functions are supported as a
391
+ #
392
+ # @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
393
+ #
394
+ # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
395
+ #
396
+ # @param user [String] A stable identifier for your end-users.
397
+ #
398
+ # @param web_search_options [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions] This tool searches the web for relevant results to use in a response.
399
+ #
400
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
401
+
402
+ # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
403
+ # wide range of models with different capabilities, performance characteristics,
404
+ # and price points. Refer to the
405
+ # [model guide](https://platform.openai.com/docs/models) to browse and compare
406
+ # available models.
407
+ module Model
408
+ extend OpenAI::Internal::Type::Union
409
+
410
+ variant String
411
+
412
+ # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
413
+ # offers a wide range of models with different capabilities, performance
414
+ # characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models)
415
+ # to browse and compare available models.
416
+ variant enum: -> { OpenAI::ChatModel }
417
+
418
+ # @!method self.variants
419
+ # @return [Array(String, Symbol, OpenAI::Models::ChatModel)]
420
+ end
421
+
422
+ # @deprecated
423
+ #
424
+ # Deprecated in favor of `tool_choice`.
425
+ #
426
+ # Controls which (if any) function is called by the model.
427
+ #
428
+ # `none` means the model will not call a function and instead generates a message.
429
+ #
430
+ # `auto` means the model can pick between generating a message or calling a
431
+ # function.
432
+ #
433
+ # Specifying a particular function via `{"name": "my_function"}` forces the model
434
+ # to call that function.
435
+ #
436
+ # `none` is the default when no functions are present. `auto` is the default if
437
+ # functions are present.
438
+ module FunctionCall
439
+ extend OpenAI::Internal::Type::Union
440
+
441
+ # `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.
442
+ variant enum: -> { OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode }
443
+
444
+ # Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.
445
+ variant -> { OpenAI::Chat::ChatCompletionFunctionCallOption }
446
+
447
+ # `none` means the model will not call a function and instead generates a message.
448
+ # `auto` means the model can pick between generating a message or calling a
449
+ # function.
450
+ module FunctionCallMode
451
+ extend OpenAI::Internal::Type::Enum
452
+
453
+ NONE = :none
454
+ AUTO = :auto
455
+
456
+ # @!method self.values
457
+ # @return [Array<Symbol>]
458
+ end
459
+
460
+ # @!method self.variants
461
+ # @return [Array(Symbol, OpenAI::Models::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode, OpenAI::Models::Chat::ChatCompletionFunctionCallOption)]
462
+ end
463
+
464
+ # @deprecated
465
+ class Function < OpenAI::Internal::Type::BaseModel
466
+ # @!attribute name
467
+ # The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
468
+ # underscores and dashes, with a maximum length of 64.
469
+ #
470
+ # @return [String]
471
+ required :name, String
472
+
473
+ # @!attribute description
474
+ # A description of what the function does, used by the model to choose when and
475
+ # how to call the function.
476
+ #
477
+ # @return [String, nil]
478
+ optional :description, String
479
+
480
+ # @!attribute parameters
481
+ # The parameters the functions accepts, described as a JSON Schema object. See the
482
+ # [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
483
+ # and the
484
+ # [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
485
+ # documentation about the format.
486
+ #
487
+ # Omitting `parameters` defines a function with an empty parameter list.
488
+ #
489
+ # @return [Hash{Symbol=>Object}, nil]
490
+ optional :parameters, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
491
+
492
+ # @!method initialize(name:, description: nil, parameters: nil)
493
+ # Some parameter documentations has been truncated, see
494
+ # {OpenAI::Models::Chat::CompletionCreateParams::Function} for more details.
495
+ #
496
+ # @param name [String] The name of the function to be called. Must be a-z, A-Z, 0-9, or contain undersc
497
+ #
498
+ # @param description [String] A description of what the function does, used by the model to choose when and ho
499
+ #
500
+ # @param parameters [Hash{Symbol=>Object}] The parameters the functions accepts, described as a JSON Schema object. See the
501
+ end
502
+
503
+ module Modality
504
+ extend OpenAI::Internal::Type::Enum
505
+
506
+ TEXT = :text
507
+ AUDIO = :audio
508
+
509
+ # @!method self.values
510
+ # @return [Array<Symbol>]
511
+ end
512
+
513
+ # An object specifying the format that the model must output.
514
+ #
515
+ # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
516
+ # Outputs which ensures the model will match your supplied JSON schema. Learn more
517
+ # in the
518
+ # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
519
+ #
520
+ # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
521
+ # ensures the message the model generates is valid JSON. Using `json_schema` is
522
+ # preferred for models that support it.
523
+ module ResponseFormat
524
+ extend OpenAI::Internal::Type::Union
525
+
526
+ # Default response format. Used to generate text responses.
527
+ variant -> { OpenAI::ResponseFormatText }
528
+
529
+ # JSON Schema response format. Used to generate structured JSON responses.
530
+ # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
531
+ variant -> { OpenAI::ResponseFormatJSONSchema }
532
+
533
+ # An {OpenAI::BaseModel} can be provided and implicitly converted into {OpenAI::ResponseFormatJSONSchema}.
534
+ # See examples for more details.
535
+ #
536
+ # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
537
+ variant -> { OpenAI::StructuredOutput::JsonSchemaConverter }
538
+
539
+ # JSON object response format. An older method of generating JSON responses.
540
+ # Using `json_schema` is recommended for models that support it. Note that the
541
+ # model will not generate JSON without a system or user message instructing it
542
+ # to do so.
543
+ variant -> { OpenAI::ResponseFormatJSONObject }
544
+
545
+ # @!method self.variants
546
+ # @return [Array(OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject)]
547
+ end
548
+
549
+ # Specifies the latency tier to use for processing the request. This parameter is
550
+ # relevant for customers subscribed to the scale tier service:
551
+ #
552
+ # - If set to 'auto', and the Project is Scale tier enabled, the system will
553
+ # utilize scale tier credits until they are exhausted.
554
+ # - If set to 'auto', and the Project is not Scale tier enabled, the request will
555
+ # be processed using the default service tier with a lower uptime SLA and no
556
+ # latency guarentee.
557
+ # - If set to 'default', the request will be processed using the default service
558
+ # tier with a lower uptime SLA and no latency guarentee.
559
+ # - If set to 'flex', the request will be processed with the Flex Processing
560
+ # service tier.
561
+ # [Learn more](https://platform.openai.com/docs/guides/flex-processing).
562
+ # - When not set, the default behavior is 'auto'.
563
+ #
564
+ # When this parameter is set, the response body will include the `service_tier`
565
+ # utilized.
566
+ module ServiceTier
567
+ extend OpenAI::Internal::Type::Enum
568
+
569
+ AUTO = :auto
570
+ DEFAULT = :default
571
+ FLEX = :flex
572
+
573
+ # @!method self.values
574
+ # @return [Array<Symbol>]
575
+ end
576
+
577
+ # Not supported with latest reasoning models `o3` and `o4-mini`.
578
+ #
579
+ # Up to 4 sequences where the API will stop generating further tokens. The
580
+ # returned text will not contain the stop sequence.
581
+ module Stop
582
+ extend OpenAI::Internal::Type::Union
583
+
584
+ variant String
585
+
586
+ variant -> { OpenAI::Models::Chat::CompletionCreateParams::Stop::StringArray }
587
+
588
+ # @!method self.variants
589
+ # @return [Array(String, Array<String>)]
590
+
591
+ # @type [OpenAI::Internal::Type::Converter]
592
+ StringArray = OpenAI::Internal::Type::ArrayOf[String]
593
+ end
594
+
595
+ class WebSearchOptions < OpenAI::Internal::Type::BaseModel
596
+ # @!attribute search_context_size
597
+ # High level guidance for the amount of context window space to use for the
598
+ # search. One of `low`, `medium`, or `high`. `medium` is the default.
599
+ #
600
+ # @return [Symbol, OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize, nil]
601
+ optional :search_context_size,
602
+ enum: -> { OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize }
603
+
604
+ # @!attribute user_location
605
+ # Approximate location parameters for the search.
606
+ #
607
+ # @return [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation, nil]
608
+ optional :user_location,
609
+ -> { OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation },
610
+ nil?: true
611
+
612
+ # @!method initialize(search_context_size: nil, user_location: nil)
613
+ # Some parameter documentations has been truncated, see
614
+ # {OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions} for more
615
+ # details.
616
+ #
617
+ # This tool searches the web for relevant results to use in a response. Learn more
618
+ # about the
619
+ # [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
620
+ #
621
+ # @param search_context_size [Symbol, OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize] High level guidance for the amount of context window space to use for the
622
+ #
623
+ # @param user_location [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation, nil] Approximate location parameters for the search.
624
+
625
+ # High level guidance for the amount of context window space to use for the
626
+ # search. One of `low`, `medium`, or `high`. `medium` is the default.
627
+ #
628
+ # @see OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions#search_context_size
629
+ module SearchContextSize
630
+ extend OpenAI::Internal::Type::Enum
631
+
632
+ LOW = :low
633
+ MEDIUM = :medium
634
+ HIGH = :high
635
+
636
+ # @!method self.values
637
+ # @return [Array<Symbol>]
638
+ end
639
+
640
+ # @see OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions#user_location
641
+ class UserLocation < OpenAI::Internal::Type::BaseModel
642
+ # @!attribute approximate
643
+ # Approximate location parameters for the search.
644
+ #
645
+ # @return [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate]
646
+ required :approximate,
647
+ -> { OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate }
648
+
649
+ # @!attribute type
650
+ # The type of location approximation. Always `approximate`.
651
+ #
652
+ # @return [Symbol, :approximate]
653
+ required :type, const: :approximate
654
+
655
+ # @!method initialize(approximate:, type: :approximate)
656
+ # Some parameter documentations has been truncated, see
657
+ # {OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation}
658
+ # for more details.
659
+ #
660
+ # Approximate location parameters for the search.
661
+ #
662
+ # @param approximate [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate] Approximate location parameters for the search.
663
+ #
664
+ # @param type [Symbol, :approximate] The type of location approximation. Always `approximate`.
665
+
666
+ # @see OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation#approximate
667
+ class Approximate < OpenAI::Internal::Type::BaseModel
668
+ # @!attribute city
669
+ # Free text input for the city of the user, e.g. `San Francisco`.
670
+ #
671
+ # @return [String, nil]
672
+ optional :city, String
673
+
674
+ # @!attribute country
675
+ # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
676
+ # the user, e.g. `US`.
677
+ #
678
+ # @return [String, nil]
679
+ optional :country, String
680
+
681
+ # @!attribute region
682
+ # Free text input for the region of the user, e.g. `California`.
683
+ #
684
+ # @return [String, nil]
685
+ optional :region, String
686
+
687
+ # @!attribute timezone
688
+ # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
689
+ # user, e.g. `America/Los_Angeles`.
690
+ #
691
+ # @return [String, nil]
692
+ optional :timezone, String
693
+
694
+ # @!method initialize(city: nil, country: nil, region: nil, timezone: nil)
695
+ # Some parameter documentations has been truncated, see
696
+ # {OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate}
697
+ # for more details.
698
+ #
699
+ # Approximate location parameters for the search.
700
+ #
701
+ # @param city [String] Free text input for the city of the user, e.g. `San Francisco`.
702
+ #
703
+ # @param country [String] The two-letter
704
+ #
705
+ # @param region [String] Free text input for the region of the user, e.g. `California`.
706
+ #
707
+ # @param timezone [String] The [IANA timezone](https://timeapi.io/documentation/iana-timezones)
708
+ end
709
+ end
710
+ end
711
+ end
712
+ end
713
+ end
714
+ end