openai 0.3.0 → 0.4.0.pre.beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.ignore +2 -0
- data/CHANGELOG.md +368 -0
- data/README.md +292 -28
- data/SECURITY.md +29 -0
- data/lib/openai/client.rb +136 -120
- data/lib/openai/errors.rb +228 -0
- data/lib/openai/file_part.rb +55 -0
- data/lib/openai/helpers/structured_output/array_of.rb +49 -0
- data/lib/openai/helpers/structured_output/base_model.rb +78 -0
- data/lib/openai/helpers/structured_output/boolean.rb +28 -0
- data/lib/openai/helpers/structured_output/enum_of.rb +63 -0
- data/lib/openai/helpers/structured_output/json_schema_converter.rb +163 -0
- data/lib/openai/helpers/structured_output/union_of.rb +64 -0
- data/lib/openai/helpers/structured_output.rb +16 -0
- data/lib/openai/internal/cursor_page.rb +86 -0
- data/lib/openai/internal/page.rb +80 -0
- data/lib/openai/internal/stream.rb +60 -0
- data/lib/openai/internal/transport/base_client.rb +558 -0
- data/lib/openai/internal/transport/pooled_net_requester.rb +209 -0
- data/lib/openai/internal/type/array_of.rb +162 -0
- data/lib/openai/internal/type/base_model.rb +477 -0
- data/lib/openai/internal/type/base_page.rb +55 -0
- data/lib/openai/internal/type/base_stream.rb +90 -0
- data/lib/openai/internal/type/boolean.rb +71 -0
- data/lib/openai/internal/type/converter.rb +292 -0
- data/lib/openai/internal/type/enum.rb +145 -0
- data/lib/openai/internal/type/file_input.rb +103 -0
- data/lib/openai/internal/type/hash_of.rb +182 -0
- data/lib/openai/internal/type/request_parameters.rb +42 -0
- data/lib/openai/internal/type/union.rb +252 -0
- data/lib/openai/internal/type/unknown.rb +75 -0
- data/lib/openai/internal/util.rb +907 -0
- data/lib/openai/internal.rb +20 -0
- data/lib/openai/models/all_models.rb +30 -0
- data/lib/openai/models/audio/speech_create_params.rb +159 -0
- data/lib/openai/models/audio/speech_model.rb +18 -0
- data/lib/openai/models/audio/transcription.rb +61 -0
- data/lib/openai/models/audio/transcription_create_params.rb +222 -0
- data/lib/openai/models/audio/transcription_create_response.rb +26 -0
- data/lib/openai/models/audio/transcription_include.rb +16 -0
- data/lib/openai/models/audio/transcription_segment.rb +96 -0
- data/lib/openai/models/audio/transcription_stream_event.rb +26 -0
- data/lib/openai/models/audio/transcription_text_delta_event.rb +75 -0
- data/lib/openai/models/audio/transcription_text_done_event.rb +76 -0
- data/lib/openai/models/audio/transcription_verbose.rb +53 -0
- data/lib/openai/models/audio/transcription_word.rb +34 -0
- data/lib/openai/models/audio/translation.rb +17 -0
- data/lib/openai/models/audio/translation_create_params.rb +98 -0
- data/lib/openai/models/audio/translation_create_response.rb +19 -0
- data/lib/openai/models/audio/translation_verbose.rb +42 -0
- data/lib/openai/models/audio_model.rb +16 -0
- data/lib/openai/models/audio_response_format.rb +21 -0
- data/lib/openai/models/auto_file_chunking_strategy_param.rb +19 -0
- data/lib/openai/models/batch.rb +213 -0
- data/lib/openai/models/batch_cancel_params.rb +14 -0
- data/lib/openai/models/batch_create_params.rb +93 -0
- data/lib/openai/models/batch_error.rb +40 -0
- data/lib/openai/models/batch_list_params.rb +37 -0
- data/lib/openai/models/batch_request_counts.rb +34 -0
- data/lib/openai/models/batch_retrieve_params.rb +14 -0
- data/lib/openai/models/beta/assistant.rb +218 -0
- data/lib/openai/models/beta/assistant_create_params.rb +372 -0
- data/lib/openai/models/beta/assistant_delete_params.rb +16 -0
- data/lib/openai/models/beta/assistant_deleted.rb +30 -0
- data/lib/openai/models/beta/assistant_list_params.rb +71 -0
- data/lib/openai/models/beta/assistant_response_format_option.rb +50 -0
- data/lib/openai/models/beta/assistant_retrieve_params.rb +16 -0
- data/lib/openai/models/beta/assistant_stream_event.rb +754 -0
- data/lib/openai/models/beta/assistant_tool.rb +22 -0
- data/lib/openai/models/beta/assistant_tool_choice.rb +42 -0
- data/lib/openai/models/beta/assistant_tool_choice_function.rb +18 -0
- data/lib/openai/models/beta/assistant_tool_choice_option.rb +42 -0
- data/lib/openai/models/beta/assistant_update_params.rb +345 -0
- data/lib/openai/models/beta/code_interpreter_tool.rb +18 -0
- data/lib/openai/models/beta/file_search_tool.rb +110 -0
- data/lib/openai/models/beta/function_tool.rb +25 -0
- data/lib/openai/models/beta/message_stream_event.rb +171 -0
- data/lib/openai/models/beta/run_step_stream_event.rb +225 -0
- data/lib/openai/models/beta/run_stream_event.rb +299 -0
- data/lib/openai/models/beta/thread.rb +122 -0
- data/lib/openai/models/beta/thread_create_and_run_params.rb +722 -0
- data/lib/openai/models/beta/thread_create_params.rb +391 -0
- data/lib/openai/models/beta/thread_delete_params.rb +16 -0
- data/lib/openai/models/beta/thread_deleted.rb +30 -0
- data/lib/openai/models/beta/thread_retrieve_params.rb +16 -0
- data/lib/openai/models/beta/thread_stream_event.rb +41 -0
- data/lib/openai/models/beta/thread_update_params.rb +101 -0
- data/lib/openai/models/beta/threads/annotation.rb +27 -0
- data/lib/openai/models/beta/threads/annotation_delta.rb +27 -0
- data/lib/openai/models/beta/threads/file_citation_annotation.rb +65 -0
- data/lib/openai/models/beta/threads/file_citation_delta_annotation.rb +81 -0
- data/lib/openai/models/beta/threads/file_path_annotation.rb +64 -0
- data/lib/openai/models/beta/threads/file_path_delta_annotation.rb +72 -0
- data/lib/openai/models/beta/threads/image_file.rb +49 -0
- data/lib/openai/models/beta/threads/image_file_content_block.rb +30 -0
- data/lib/openai/models/beta/threads/image_file_delta.rb +49 -0
- data/lib/openai/models/beta/threads/image_file_delta_block.rb +38 -0
- data/lib/openai/models/beta/threads/image_url.rb +48 -0
- data/lib/openai/models/beta/threads/image_url_content_block.rb +29 -0
- data/lib/openai/models/beta/threads/image_url_delta.rb +48 -0
- data/lib/openai/models/beta/threads/image_url_delta_block.rb +37 -0
- data/lib/openai/models/beta/threads/message.rb +251 -0
- data/lib/openai/models/beta/threads/message_content.rb +32 -0
- data/lib/openai/models/beta/threads/message_content_delta.rb +32 -0
- data/lib/openai/models/beta/threads/message_content_part_param.rb +29 -0
- data/lib/openai/models/beta/threads/message_create_params.rb +150 -0
- data/lib/openai/models/beta/threads/message_delete_params.rb +24 -0
- data/lib/openai/models/beta/threads/message_deleted.rb +32 -0
- data/lib/openai/models/beta/threads/message_delta.rb +44 -0
- data/lib/openai/models/beta/threads/message_delta_event.rb +39 -0
- data/lib/openai/models/beta/threads/message_list_params.rb +81 -0
- data/lib/openai/models/beta/threads/message_retrieve_params.rb +24 -0
- data/lib/openai/models/beta/threads/message_update_params.rb +41 -0
- data/lib/openai/models/beta/threads/refusal_content_block.rb +29 -0
- data/lib/openai/models/beta/threads/refusal_delta_block.rb +37 -0
- data/lib/openai/models/beta/threads/required_action_function_tool_call.rb +68 -0
- data/lib/openai/models/beta/threads/run.rb +475 -0
- data/lib/openai/models/beta/threads/run_cancel_params.rb +24 -0
- data/lib/openai/models/beta/threads/run_create_params.rb +443 -0
- data/lib/openai/models/beta/threads/run_list_params.rb +73 -0
- data/lib/openai/models/beta/threads/run_retrieve_params.rb +24 -0
- data/lib/openai/models/beta/threads/run_status.rb +29 -0
- data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +62 -0
- data/lib/openai/models/beta/threads/run_update_params.rb +41 -0
- data/lib/openai/models/beta/threads/runs/code_interpreter_logs.rb +40 -0
- data/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb +54 -0
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +158 -0
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +100 -0
- data/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +193 -0
- data/lib/openai/models/beta/threads/runs/file_search_tool_call_delta.rb +50 -0
- data/lib/openai/models/beta/threads/runs/function_tool_call.rb +78 -0
- data/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb +86 -0
- data/lib/openai/models/beta/threads/runs/message_creation_step_details.rb +44 -0
- data/lib/openai/models/beta/threads/runs/run_step.rb +278 -0
- data/lib/openai/models/beta/threads/runs/run_step_delta.rb +44 -0
- data/lib/openai/models/beta/threads/runs/run_step_delta_event.rb +43 -0
- data/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb +48 -0
- data/lib/openai/models/beta/threads/runs/run_step_include.rb +23 -0
- data/lib/openai/models/beta/threads/runs/step_list_params.rb +97 -0
- data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +52 -0
- data/lib/openai/models/beta/threads/runs/tool_call.rb +28 -0
- data/lib/openai/models/beta/threads/runs/tool_call_delta.rb +28 -0
- data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb +38 -0
- data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb +40 -0
- data/lib/openai/models/beta/threads/text.rb +30 -0
- data/lib/openai/models/beta/threads/text_content_block.rb +29 -0
- data/lib/openai/models/beta/threads/text_content_block_param.rb +30 -0
- data/lib/openai/models/beta/threads/text_delta.rb +28 -0
- data/lib/openai/models/beta/threads/text_delta_block.rb +37 -0
- data/lib/openai/models/chat/chat_completion.rb +225 -0
- data/lib/openai/models/chat/chat_completion_assistant_message_param.rb +178 -0
- data/lib/openai/models/chat/chat_completion_audio.rb +53 -0
- data/lib/openai/models/chat/chat_completion_audio_param.rb +110 -0
- data/lib/openai/models/chat/chat_completion_chunk.rb +408 -0
- data/lib/openai/models/chat/chat_completion_content_part.rb +85 -0
- data/lib/openai/models/chat/chat_completion_content_part_image.rb +69 -0
- data/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +68 -0
- data/lib/openai/models/chat/chat_completion_content_part_refusal.rb +28 -0
- data/lib/openai/models/chat/chat_completion_content_part_text.rb +31 -0
- data/lib/openai/models/chat/chat_completion_deleted.rb +37 -0
- data/lib/openai/models/chat/chat_completion_developer_message_param.rb +64 -0
- data/lib/openai/models/chat/chat_completion_function_call_option.rb +23 -0
- data/lib/openai/models/chat/chat_completion_function_message_param.rb +37 -0
- data/lib/openai/models/chat/chat_completion_message.rb +179 -0
- data/lib/openai/models/chat/chat_completion_message_param.rb +42 -0
- data/lib/openai/models/chat/chat_completion_message_tool_call.rb +71 -0
- data/lib/openai/models/chat/chat_completion_modality.rb +19 -0
- data/lib/openai/models/chat/chat_completion_named_tool_choice.rb +42 -0
- data/lib/openai/models/chat/chat_completion_prediction_content.rb +60 -0
- data/lib/openai/models/chat/chat_completion_reasoning_effort.rb +11 -0
- data/lib/openai/models/chat/chat_completion_role.rb +24 -0
- data/lib/openai/models/chat/chat_completion_store_message.rb +22 -0
- data/lib/openai/models/chat/chat_completion_stream_options.rb +31 -0
- data/lib/openai/models/chat/chat_completion_system_message_param.rb +64 -0
- data/lib/openai/models/chat/chat_completion_token_logprob.rb +90 -0
- data/lib/openai/models/chat/chat_completion_tool.rb +27 -0
- data/lib/openai/models/chat/chat_completion_tool_choice_option.rb +45 -0
- data/lib/openai/models/chat/chat_completion_tool_message_param.rb +56 -0
- data/lib/openai/models/chat/chat_completion_user_message_param.rb +63 -0
- data/lib/openai/models/chat/completion_create_params.rb +714 -0
- data/lib/openai/models/chat/completion_delete_params.rb +16 -0
- data/lib/openai/models/chat/completion_list_params.rb +74 -0
- data/lib/openai/models/chat/completion_retrieve_params.rb +16 -0
- data/lib/openai/models/chat/completion_update_params.rb +32 -0
- data/lib/openai/models/chat/completions/message_list_params.rb +58 -0
- data/lib/openai/models/chat_model.rb +67 -0
- data/lib/openai/models/comparison_filter.rb +87 -0
- data/lib/openai/models/completion.rb +76 -0
- data/lib/openai/models/completion_choice.rb +89 -0
- data/lib/openai/models/completion_create_params.rb +306 -0
- data/lib/openai/models/completion_usage.rb +117 -0
- data/lib/openai/models/compound_filter.rb +57 -0
- data/lib/openai/models/container_create_params.rb +75 -0
- data/lib/openai/models/container_create_response.rb +98 -0
- data/lib/openai/models/container_delete_params.rb +14 -0
- data/lib/openai/models/container_list_params.rb +58 -0
- data/lib/openai/models/container_list_response.rb +98 -0
- data/lib/openai/models/container_retrieve_params.rb +14 -0
- data/lib/openai/models/container_retrieve_response.rb +98 -0
- data/lib/openai/models/containers/file_create_params.rb +35 -0
- data/lib/openai/models/containers/file_create_response.rb +67 -0
- data/lib/openai/models/containers/file_delete_params.rb +22 -0
- data/lib/openai/models/containers/file_list_params.rb +60 -0
- data/lib/openai/models/containers/file_list_response.rb +67 -0
- data/lib/openai/models/containers/file_retrieve_params.rb +22 -0
- data/lib/openai/models/containers/file_retrieve_response.rb +67 -0
- data/lib/openai/models/containers/files/content_retrieve_params.rb +24 -0
- data/lib/openai/models/create_embedding_response.rb +63 -0
- data/lib/openai/models/embedding.rb +39 -0
- data/lib/openai/models/embedding_create_params.rb +139 -0
- data/lib/openai/models/embedding_model.rb +16 -0
- data/lib/openai/models/error_object.rb +33 -0
- data/lib/openai/models/eval_create_params.rb +451 -0
- data/lib/openai/models/eval_create_response.rb +214 -0
- data/lib/openai/models/eval_custom_data_source_config.rb +35 -0
- data/lib/openai/models/eval_delete_params.rb +14 -0
- data/lib/openai/models/eval_delete_response.rb +28 -0
- data/lib/openai/models/eval_list_params.rb +75 -0
- data/lib/openai/models/eval_list_response.rb +214 -0
- data/lib/openai/models/eval_retrieve_params.rb +14 -0
- data/lib/openai/models/eval_retrieve_response.rb +214 -0
- data/lib/openai/models/eval_stored_completions_data_source_config.rb +44 -0
- data/lib/openai/models/eval_update_params.rb +38 -0
- data/lib/openai/models/eval_update_response.rb +214 -0
- data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +465 -0
- data/lib/openai/models/evals/create_eval_jsonl_run_data_source.rb +102 -0
- data/lib/openai/models/evals/eval_api_error.rb +30 -0
- data/lib/openai/models/evals/run_cancel_params.rb +22 -0
- data/lib/openai/models/evals/run_cancel_response.rb +758 -0
- data/lib/openai/models/evals/run_create_params.rb +602 -0
- data/lib/openai/models/evals/run_create_response.rb +758 -0
- data/lib/openai/models/evals/run_delete_params.rb +22 -0
- data/lib/openai/models/evals/run_delete_response.rb +30 -0
- data/lib/openai/models/evals/run_list_params.rb +80 -0
- data/lib/openai/models/evals/run_list_response.rb +758 -0
- data/lib/openai/models/evals/run_retrieve_params.rb +22 -0
- data/lib/openai/models/evals/run_retrieve_response.rb +762 -0
- data/lib/openai/models/evals/runs/output_item_list_params.rb +86 -0
- data/lib/openai/models/evals/runs/output_item_list_response.rb +265 -0
- data/lib/openai/models/evals/runs/output_item_retrieve_params.rb +30 -0
- data/lib/openai/models/evals/runs/output_item_retrieve_response.rb +266 -0
- data/lib/openai/models/file_chunking_strategy.rb +20 -0
- data/lib/openai/models/file_chunking_strategy_param.rb +22 -0
- data/lib/openai/models/file_content.rb +7 -0
- data/lib/openai/models/file_content_params.rb +14 -0
- data/lib/openai/models/file_create_params.rb +36 -0
- data/lib/openai/models/file_delete_params.rb +14 -0
- data/lib/openai/models/file_deleted.rb +28 -0
- data/lib/openai/models/file_list_params.rb +66 -0
- data/lib/openai/models/file_object.rb +131 -0
- data/lib/openai/models/file_purpose.rb +23 -0
- data/lib/openai/models/file_retrieve_params.rb +14 -0
- data/lib/openai/models/fine_tuning/alpha/grader_run_params.rb +89 -0
- data/lib/openai/models/fine_tuning/alpha/grader_run_response.rb +175 -0
- data/lib/openai/models/fine_tuning/alpha/grader_validate_params.rb +49 -0
- data/lib/openai/models/fine_tuning/alpha/grader_validate_response.rb +46 -0
- data/lib/openai/models/fine_tuning/checkpoints/permission_create_params.rb +26 -0
- data/lib/openai/models/fine_tuning/checkpoints/permission_create_response.rb +48 -0
- data/lib/openai/models/fine_tuning/checkpoints/permission_delete_params.rb +24 -0
- data/lib/openai/models/fine_tuning/checkpoints/permission_delete_response.rb +37 -0
- data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rb +61 -0
- data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rb +83 -0
- data/lib/openai/models/fine_tuning/dpo_hyperparameters.rb +112 -0
- data/lib/openai/models/fine_tuning/dpo_method.rb +20 -0
- data/lib/openai/models/fine_tuning/fine_tuning_job.rb +384 -0
- data/lib/openai/models/fine_tuning/fine_tuning_job_event.rb +98 -0
- data/lib/openai/models/fine_tuning/fine_tuning_job_integration.rb +11 -0
- data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rb +57 -0
- data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rb +35 -0
- data/lib/openai/models/fine_tuning/job_cancel_params.rb +16 -0
- data/lib/openai/models/fine_tuning/job_create_params.rb +377 -0
- data/lib/openai/models/fine_tuning/job_list_events_params.rb +32 -0
- data/lib/openai/models/fine_tuning/job_list_params.rb +44 -0
- data/lib/openai/models/fine_tuning/job_pause_params.rb +16 -0
- data/lib/openai/models/fine_tuning/job_resume_params.rb +16 -0
- data/lib/openai/models/fine_tuning/job_retrieve_params.rb +16 -0
- data/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb +34 -0
- data/lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb +121 -0
- data/lib/openai/models/fine_tuning/reinforcement_hyperparameters.rb +181 -0
- data/lib/openai/models/fine_tuning/reinforcement_method.rb +53 -0
- data/lib/openai/models/fine_tuning/supervised_hyperparameters.rb +88 -0
- data/lib/openai/models/fine_tuning/supervised_method.rb +20 -0
- data/lib/openai/models/function_definition.rb +55 -0
- data/lib/openai/models/function_parameters.rb +8 -0
- data/lib/openai/models/graders/label_model_grader.rb +171 -0
- data/lib/openai/models/graders/multi_grader.rb +71 -0
- data/lib/openai/models/graders/python_grader.rb +46 -0
- data/lib/openai/models/graders/score_model_grader.rb +171 -0
- data/lib/openai/models/graders/string_check_grader.rb +70 -0
- data/lib/openai/models/graders/text_similarity_grader.rb +80 -0
- data/lib/openai/models/image.rb +41 -0
- data/lib/openai/models/image_create_variation_params.rb +112 -0
- data/lib/openai/models/image_edit_params.rb +225 -0
- data/lib/openai/models/image_generate_params.rb +272 -0
- data/lib/openai/models/image_model.rb +16 -0
- data/lib/openai/models/images_response.rb +98 -0
- data/lib/openai/models/metadata.rb +8 -0
- data/lib/openai/models/model.rb +43 -0
- data/lib/openai/models/model_delete_params.rb +14 -0
- data/lib/openai/models/model_deleted.rb +28 -0
- data/lib/openai/models/model_list_params.rb +14 -0
- data/lib/openai/models/model_retrieve_params.rb +14 -0
- data/lib/openai/models/moderation.rb +563 -0
- data/lib/openai/models/moderation_create_params.rb +80 -0
- data/lib/openai/models/moderation_create_response.rb +35 -0
- data/lib/openai/models/moderation_image_url_input.rb +40 -0
- data/lib/openai/models/moderation_model.rb +17 -0
- data/lib/openai/models/moderation_multi_modal_input.rb +21 -0
- data/lib/openai/models/moderation_text_input.rb +26 -0
- data/lib/openai/models/other_file_chunking_strategy_object.rb +20 -0
- data/lib/openai/models/reasoning.rb +89 -0
- data/lib/openai/models/reasoning_effort.rb +22 -0
- data/lib/openai/models/response_format_json_object.rb +20 -0
- data/lib/openai/models/response_format_json_schema.rb +85 -0
- data/lib/openai/models/response_format_text.rb +18 -0
- data/lib/openai/models/responses/computer_tool.rb +61 -0
- data/lib/openai/models/responses/easy_input_message.rb +91 -0
- data/lib/openai/models/responses/file_search_tool.rb +114 -0
- data/lib/openai/models/responses/function_tool.rb +63 -0
- data/lib/openai/models/responses/input_item_list_params.rb +78 -0
- data/lib/openai/models/responses/response.rb +393 -0
- data/lib/openai/models/responses/response_audio_delta_event.rb +39 -0
- data/lib/openai/models/responses/response_audio_done_event.rb +31 -0
- data/lib/openai/models/responses/response_audio_transcript_delta_event.rb +39 -0
- data/lib/openai/models/responses/response_audio_transcript_done_event.rb +31 -0
- data/lib/openai/models/responses/response_cancel_params.rb +16 -0
- data/lib/openai/models/responses/response_code_interpreter_call_code_delta_event.rb +48 -0
- data/lib/openai/models/responses/response_code_interpreter_call_code_done_event.rb +48 -0
- data/lib/openai/models/responses/response_code_interpreter_call_completed_event.rb +48 -0
- data/lib/openai/models/responses/response_code_interpreter_call_in_progress_event.rb +48 -0
- data/lib/openai/models/responses/response_code_interpreter_call_interpreting_event.rb +48 -0
- data/lib/openai/models/responses/response_code_interpreter_tool_call.rb +171 -0
- data/lib/openai/models/responses/response_completed_event.rb +39 -0
- data/lib/openai/models/responses/response_computer_tool_call.rb +493 -0
- data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +111 -0
- data/lib/openai/models/responses/response_computer_tool_call_output_screenshot.rb +41 -0
- data/lib/openai/models/responses/response_content.rb +30 -0
- data/lib/openai/models/responses/response_content_part_added_event.rb +81 -0
- data/lib/openai/models/responses/response_content_part_done_event.rb +81 -0
- data/lib/openai/models/responses/response_create_params.rb +369 -0
- data/lib/openai/models/responses/response_created_event.rb +39 -0
- data/lib/openai/models/responses/response_delete_params.rb +16 -0
- data/lib/openai/models/responses/response_error.rb +60 -0
- data/lib/openai/models/responses/response_error_event.rb +55 -0
- data/lib/openai/models/responses/response_failed_event.rb +39 -0
- data/lib/openai/models/responses/response_file_search_call_completed_event.rb +48 -0
- data/lib/openai/models/responses/response_file_search_call_in_progress_event.rb +48 -0
- data/lib/openai/models/responses/response_file_search_call_searching_event.rb +48 -0
- data/lib/openai/models/responses/response_file_search_tool_call.rb +147 -0
- data/lib/openai/models/responses/response_format_text_config.rb +48 -0
- data/lib/openai/models/responses/response_format_text_json_schema_config.rb +70 -0
- data/lib/openai/models/responses/response_function_call_arguments_delta_event.rb +56 -0
- data/lib/openai/models/responses/response_function_call_arguments_done_event.rb +51 -0
- data/lib/openai/models/responses/response_function_tool_call.rb +87 -0
- data/lib/openai/models/responses/response_function_tool_call_item.rb +25 -0
- data/lib/openai/models/responses/response_function_tool_call_output_item.rb +70 -0
- data/lib/openai/models/responses/response_function_web_search.rb +56 -0
- data/lib/openai/models/responses/response_image_gen_call_completed_event.rb +45 -0
- data/lib/openai/models/responses/response_image_gen_call_generating_event.rb +45 -0
- data/lib/openai/models/responses/response_image_gen_call_in_progress_event.rb +44 -0
- data/lib/openai/models/responses/response_image_gen_call_partial_image_event.rb +65 -0
- data/lib/openai/models/responses/response_in_progress_event.rb +39 -0
- data/lib/openai/models/responses/response_includable.rb +32 -0
- data/lib/openai/models/responses/response_incomplete_event.rb +39 -0
- data/lib/openai/models/responses/response_input.rb +10 -0
- data/lib/openai/models/responses/response_input_audio.rb +52 -0
- data/lib/openai/models/responses/response_input_content.rb +26 -0
- data/lib/openai/models/responses/response_input_file.rb +47 -0
- data/lib/openai/models/responses/response_input_image.rb +65 -0
- data/lib/openai/models/responses/response_input_item.rb +876 -0
- data/lib/openai/models/responses/response_input_message_content_list.rb +11 -0
- data/lib/openai/models/responses/response_input_message_item.rb +99 -0
- data/lib/openai/models/responses/response_input_text.rb +28 -0
- data/lib/openai/models/responses/response_item.rb +549 -0
- data/lib/openai/models/responses/response_item_list.rb +54 -0
- data/lib/openai/models/responses/response_mcp_call_arguments_delta_event.rb +53 -0
- data/lib/openai/models/responses/response_mcp_call_arguments_done_event.rb +52 -0
- data/lib/openai/models/responses/response_mcp_call_completed_event.rb +28 -0
- data/lib/openai/models/responses/response_mcp_call_failed_event.rb +28 -0
- data/lib/openai/models/responses/response_mcp_call_in_progress_event.rb +44 -0
- data/lib/openai/models/responses/response_mcp_list_tools_completed_event.rb +28 -0
- data/lib/openai/models/responses/response_mcp_list_tools_failed_event.rb +28 -0
- data/lib/openai/models/responses/response_mcp_list_tools_in_progress_event.rb +29 -0
- data/lib/openai/models/responses/response_output_audio.rb +39 -0
- data/lib/openai/models/responses/response_output_item.rb +442 -0
- data/lib/openai/models/responses/response_output_item_added_event.rb +47 -0
- data/lib/openai/models/responses/response_output_item_done_event.rb +47 -0
- data/lib/openai/models/responses/response_output_message.rb +90 -0
- data/lib/openai/models/responses/response_output_refusal.rb +28 -0
- data/lib/openai/models/responses/response_output_text.rb +171 -0
- data/lib/openai/models/responses/response_output_text_annotation_added_event.rb +68 -0
- data/lib/openai/models/responses/response_queued_event.rb +36 -0
- data/lib/openai/models/responses/response_reasoning_delta_event.rb +60 -0
- data/lib/openai/models/responses/response_reasoning_done_event.rb +60 -0
- data/lib/openai/models/responses/response_reasoning_item.rb +98 -0
- data/lib/openai/models/responses/response_reasoning_summary_delta_event.rb +65 -0
- data/lib/openai/models/responses/response_reasoning_summary_done_event.rb +60 -0
- data/lib/openai/models/responses/response_reasoning_summary_part_added_event.rb +86 -0
- data/lib/openai/models/responses/response_reasoning_summary_part_done_event.rb +86 -0
- data/lib/openai/models/responses/response_reasoning_summary_text_delta_event.rb +64 -0
- data/lib/openai/models/responses/response_reasoning_summary_text_done_event.rb +64 -0
- data/lib/openai/models/responses/response_refusal_delta_event.rb +63 -0
- data/lib/openai/models/responses/response_refusal_done_event.rb +63 -0
- data/lib/openai/models/responses/response_retrieve_params.rb +28 -0
- data/lib/openai/models/responses/response_status.rb +23 -0
- data/lib/openai/models/responses/response_stream_event.rb +217 -0
- data/lib/openai/models/responses/response_text_config.rb +39 -0
- data/lib/openai/models/responses/response_text_delta_event.rb +63 -0
- data/lib/openai/models/responses/response_text_done_event.rb +63 -0
- data/lib/openai/models/responses/response_usage.rb +85 -0
- data/lib/openai/models/responses/response_web_search_call_completed_event.rb +48 -0
- data/lib/openai/models/responses/response_web_search_call_in_progress_event.rb +48 -0
- data/lib/openai/models/responses/response_web_search_call_searching_event.rb +48 -0
- data/lib/openai/models/responses/tool.rb +512 -0
- data/lib/openai/models/responses/tool_choice_function.rb +28 -0
- data/lib/openai/models/responses/tool_choice_options.rb +26 -0
- data/lib/openai/models/responses/tool_choice_types.rb +62 -0
- data/lib/openai/models/responses/web_search_tool.rb +123 -0
- data/lib/openai/models/responses_model.rb +30 -0
- data/lib/openai/models/static_file_chunking_strategy.rb +30 -0
- data/lib/openai/models/static_file_chunking_strategy_object.rb +23 -0
- data/lib/openai/models/static_file_chunking_strategy_object_param.rb +25 -0
- data/lib/openai/models/upload.rb +103 -0
- data/lib/openai/models/upload_cancel_params.rb +14 -0
- data/lib/openai/models/upload_complete_params.rb +34 -0
- data/lib/openai/models/upload_create_params.rb +55 -0
- data/lib/openai/models/uploads/part_create_params.rb +27 -0
- data/lib/openai/models/uploads/upload_part.rb +47 -0
- data/lib/openai/models/vector_store.rb +195 -0
- data/lib/openai/models/vector_store_create_params.rb +90 -0
- data/lib/openai/models/vector_store_delete_params.rb +14 -0
- data/lib/openai/models/vector_store_deleted.rb +28 -0
- data/lib/openai/models/vector_store_list_params.rb +69 -0
- data/lib/openai/models/vector_store_retrieve_params.rb +14 -0
- data/lib/openai/models/vector_store_search_params.rb +116 -0
- data/lib/openai/models/vector_store_search_response.rb +103 -0
- data/lib/openai/models/vector_store_update_params.rb +71 -0
- data/lib/openai/models/vector_stores/file_batch_cancel_params.rb +22 -0
- data/lib/openai/models/vector_stores/file_batch_create_params.rb +67 -0
- data/lib/openai/models/vector_stores/file_batch_list_files_params.rb +99 -0
- data/lib/openai/models/vector_stores/file_batch_retrieve_params.rb +22 -0
- data/lib/openai/models/vector_stores/file_content_params.rb +22 -0
- data/lib/openai/models/vector_stores/file_content_response.rb +27 -0
- data/lib/openai/models/vector_stores/file_create_params.rb +67 -0
- data/lib/openai/models/vector_stores/file_delete_params.rb +22 -0
- data/lib/openai/models/vector_stores/file_list_params.rb +92 -0
- data/lib/openai/models/vector_stores/file_retrieve_params.rb +22 -0
- data/lib/openai/models/vector_stores/file_update_params.rb +55 -0
- data/lib/openai/models/vector_stores/vector_store_file.rb +172 -0
- data/lib/openai/models/vector_stores/vector_store_file_batch.rb +130 -0
- data/lib/openai/models/vector_stores/vector_store_file_deleted.rb +32 -0
- data/lib/openai/models.rb +237 -0
- data/lib/openai/request_options.rb +77 -0
- data/lib/openai/resources/audio/speech.rb +52 -0
- data/lib/openai/resources/audio/transcriptions.rb +116 -0
- data/lib/openai/resources/audio/translations.rb +50 -0
- data/lib/openai/resources/audio.rb +26 -0
- data/lib/openai/resources/batches.rb +109 -0
- data/lib/openai/resources/beta/assistants.rb +180 -0
- data/lib/openai/resources/beta/threads/messages.rb +177 -0
- data/lib/openai/resources/beta/threads/runs/steps.rb +101 -0
- data/lib/openai/resources/beta/threads/runs.rb +374 -0
- data/lib/openai/resources/beta/threads.rb +248 -0
- data/lib/openai/resources/beta.rb +22 -0
- data/lib/openai/resources/chat/completions/messages.rb +51 -0
- data/lib/openai/resources/chat/completions.rb +412 -0
- data/lib/openai/resources/chat.rb +18 -0
- data/lib/openai/resources/completions.rb +143 -0
- data/lib/openai/resources/containers/files/content.rb +43 -0
- data/lib/openai/resources/containers/files.rb +135 -0
- data/lib/openai/resources/containers.rb +113 -0
- data/lib/openai/resources/embeddings.rb +47 -0
- data/lib/openai/resources/evals/runs/output_items.rb +91 -0
- data/lib/openai/resources/evals/runs.rb +168 -0
- data/lib/openai/resources/evals.rb +155 -0
- data/lib/openai/resources/files.rb +155 -0
- data/lib/openai/resources/fine_tuning/alpha/graders.rb +66 -0
- data/lib/openai/resources/fine_tuning/alpha.rb +20 -0
- data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb +125 -0
- data/lib/openai/resources/fine_tuning/checkpoints.rb +20 -0
- data/lib/openai/resources/fine_tuning/jobs/checkpoints.rb +48 -0
- data/lib/openai/resources/fine_tuning/jobs.rb +221 -0
- data/lib/openai/resources/fine_tuning/methods.rb +16 -0
- data/lib/openai/resources/fine_tuning.rb +30 -0
- data/lib/openai/resources/graders/grader_models.rb +16 -0
- data/lib/openai/resources/graders.rb +18 -0
- data/lib/openai/resources/images.rb +143 -0
- data/lib/openai/resources/models.rb +76 -0
- data/lib/openai/resources/moderations.rb +42 -0
- data/lib/openai/resources/responses/input_items.rb +52 -0
- data/lib/openai/resources/responses.rb +323 -0
- data/lib/openai/resources/uploads/parts.rb +54 -0
- data/lib/openai/resources/uploads.rb +125 -0
- data/lib/openai/resources/vector_stores/file_batches.rb +144 -0
- data/lib/openai/resources/vector_stores/files.rb +203 -0
- data/lib/openai/resources/vector_stores.rb +195 -0
- data/lib/openai/structured_output.rb +10 -0
- data/lib/openai/version.rb +3 -1
- data/lib/openai.rb +520 -7
- data/manifest.yaml +15 -0
- data/rbi/openai/client.rbi +109 -0
- data/rbi/openai/errors.rbi +189 -0
- data/rbi/openai/file_part.rbi +37 -0
- data/rbi/openai/helpers/structured_output/array_of.rbi +16 -0
- data/rbi/openai/helpers/structured_output/base_model.rbi +22 -0
- data/rbi/openai/helpers/structured_output/boolean.rbi +11 -0
- data/rbi/openai/helpers/structured_output/enum_of.rbi +30 -0
- data/rbi/openai/helpers/structured_output/json_schema_converter.rbi +83 -0
- data/rbi/openai/helpers/structured_output/union_of.rbi +23 -0
- data/rbi/openai/helpers/structured_output.rbi +16 -0
- data/rbi/openai/internal/cursor_page.rbi +22 -0
- data/rbi/openai/internal/page.rbi +22 -0
- data/rbi/openai/internal/stream.rbi +18 -0
- data/rbi/openai/internal/transport/base_client.rbi +309 -0
- data/rbi/openai/internal/transport/pooled_net_requester.rbi +78 -0
- data/rbi/openai/internal/type/array_of.rbi +104 -0
- data/rbi/openai/internal/type/base_model.rbi +295 -0
- data/rbi/openai/internal/type/base_page.rbi +42 -0
- data/rbi/openai/internal/type/base_stream.rbi +68 -0
- data/rbi/openai/internal/type/boolean.rbi +56 -0
- data/rbi/openai/internal/type/converter.rbi +158 -0
- data/rbi/openai/internal/type/enum.rbi +82 -0
- data/rbi/openai/internal/type/file_input.rbi +59 -0
- data/rbi/openai/internal/type/hash_of.rbi +104 -0
- data/rbi/openai/internal/type/request_parameters.rbi +29 -0
- data/rbi/openai/internal/type/union.rbi +116 -0
- data/rbi/openai/internal/type/unknown.rbi +56 -0
- data/rbi/openai/internal/util.rbi +482 -0
- data/rbi/openai/internal.rbi +16 -0
- data/rbi/openai/models/all_models.rbi +56 -0
- data/rbi/openai/models/audio/speech_create_params.rbi +273 -0
- data/rbi/openai/models/audio/speech_model.rbi +26 -0
- data/rbi/openai/models/audio/transcription.rbi +118 -0
- data/rbi/openai/models/audio/transcription_create_params.rbi +424 -0
- data/rbi/openai/models/audio/transcription_create_response.rbi +31 -0
- data/rbi/openai/models/audio/transcription_include.rbi +26 -0
- data/rbi/openai/models/audio/transcription_segment.rbi +120 -0
- data/rbi/openai/models/audio/transcription_stream_event.rbi +31 -0
- data/rbi/openai/models/audio/transcription_text_delta_event.rbi +142 -0
- data/rbi/openai/models/audio/transcription_text_done_event.rbi +144 -0
- data/rbi/openai/models/audio/transcription_verbose.rbi +90 -0
- data/rbi/openai/models/audio/transcription_word.rbi +45 -0
- data/rbi/openai/models/audio/translation.rbi +25 -0
- data/rbi/openai/models/audio/translation_create_params.rbi +190 -0
- data/rbi/openai/models/audio/translation_create_response.rbi +24 -0
- data/rbi/openai/models/audio/translation_verbose.rbi +72 -0
- data/rbi/openai/models/audio_model.rbi +22 -0
- data/rbi/openai/models/audio_response_format.rbi +28 -0
- data/rbi/openai/models/auto_file_chunking_strategy_param.rbi +32 -0
- data/rbi/openai/models/batch.rbi +290 -0
- data/rbi/openai/models/batch_cancel_params.rbi +27 -0
- data/rbi/openai/models/batch_create_params.rbi +170 -0
- data/rbi/openai/models/batch_error.rbi +65 -0
- data/rbi/openai/models/batch_list_params.rbi +65 -0
- data/rbi/openai/models/batch_request_counts.rbi +48 -0
- data/rbi/openai/models/batch_retrieve_params.rbi +27 -0
- data/rbi/openai/models/beta/assistant.rbi +384 -0
- data/rbi/openai/models/beta/assistant_create_params.rbi +760 -0
- data/rbi/openai/models/beta/assistant_delete_params.rbi +32 -0
- data/rbi/openai/models/beta/assistant_deleted.rbi +37 -0
- data/rbi/openai/models/beta/assistant_list_params.rbi +126 -0
- data/rbi/openai/models/beta/assistant_response_format_option.rbi +49 -0
- data/rbi/openai/models/beta/assistant_retrieve_params.rbi +32 -0
- data/rbi/openai/models/beta/assistant_stream_event.rbi +1170 -0
- data/rbi/openai/models/beta/assistant_tool.rbi +26 -0
- data/rbi/openai/models/beta/assistant_tool_choice.rbi +89 -0
- data/rbi/openai/models/beta/assistant_tool_choice_function.rbi +32 -0
- data/rbi/openai/models/beta/assistant_tool_choice_option.rbi +74 -0
- data/rbi/openai/models/beta/assistant_update_params.rbi +682 -0
- data/rbi/openai/models/beta/code_interpreter_tool.rbi +29 -0
- data/rbi/openai/models/beta/file_search_tool.rbi +246 -0
- data/rbi/openai/models/beta/function_tool.rbi +45 -0
- data/rbi/openai/models/beta/message_stream_event.rbi +263 -0
- data/rbi/openai/models/beta/run_step_stream_event.rbi +362 -0
- data/rbi/openai/models/beta/run_stream_event.rbi +485 -0
- data/rbi/openai/models/beta/thread.rbi +233 -0
- data/rbi/openai/models/beta/thread_create_and_run_params.rbi +1535 -0
- data/rbi/openai/models/beta/thread_create_params.rbi +847 -0
- data/rbi/openai/models/beta/thread_delete_params.rbi +29 -0
- data/rbi/openai/models/beta/thread_deleted.rbi +37 -0
- data/rbi/openai/models/beta/thread_retrieve_params.rbi +29 -0
- data/rbi/openai/models/beta/thread_stream_event.rbi +60 -0
- data/rbi/openai/models/beta/thread_update_params.rbi +225 -0
- data/rbi/openai/models/beta/threads/annotation.rbi +32 -0
- data/rbi/openai/models/beta/threads/annotation_delta.rbi +32 -0
- data/rbi/openai/models/beta/threads/file_citation_annotation.rbi +110 -0
- data/rbi/openai/models/beta/threads/file_citation_delta_annotation.rbi +145 -0
- data/rbi/openai/models/beta/threads/file_path_annotation.rbi +106 -0
- data/rbi/openai/models/beta/threads/file_path_delta_annotation.rbi +133 -0
- data/rbi/openai/models/beta/threads/image_file.rbi +102 -0
- data/rbi/openai/models/beta/threads/image_file_content_block.rbi +54 -0
- data/rbi/openai/models/beta/threads/image_file_delta.rbi +113 -0
- data/rbi/openai/models/beta/threads/image_file_delta_block.rbi +67 -0
- data/rbi/openai/models/beta/threads/image_url.rbi +97 -0
- data/rbi/openai/models/beta/threads/image_url_content_block.rbi +53 -0
- data/rbi/openai/models/beta/threads/image_url_delta.rbi +111 -0
- data/rbi/openai/models/beta/threads/image_url_delta_block.rbi +64 -0
- data/rbi/openai/models/beta/threads/message.rbi +486 -0
- data/rbi/openai/models/beta/threads/message_content.rbi +33 -0
- data/rbi/openai/models/beta/threads/message_content_delta.rbi +33 -0
- data/rbi/openai/models/beta/threads/message_content_part_param.rbi +32 -0
- data/rbi/openai/models/beta/threads/message_create_params.rbi +318 -0
- data/rbi/openai/models/beta/threads/message_delete_params.rbi +42 -0
- data/rbi/openai/models/beta/threads/message_deleted.rbi +44 -0
- data/rbi/openai/models/beta/threads/message_delta.rbi +128 -0
- data/rbi/openai/models/beta/threads/message_delta_event.rbi +67 -0
- data/rbi/openai/models/beta/threads/message_list_params.rbi +157 -0
- data/rbi/openai/models/beta/threads/message_retrieve_params.rbi +42 -0
- data/rbi/openai/models/beta/threads/message_update_params.rbi +66 -0
- data/rbi/openai/models/beta/threads/refusal_content_block.rbi +41 -0
- data/rbi/openai/models/beta/threads/refusal_delta_block.rbi +54 -0
- data/rbi/openai/models/beta/threads/required_action_function_tool_call.rbi +117 -0
- data/rbi/openai/models/beta/threads/run.rbi +870 -0
- data/rbi/openai/models/beta/threads/run_cancel_params.rbi +42 -0
- data/rbi/openai/models/beta/threads/run_create_params.rbi +882 -0
- data/rbi/openai/models/beta/threads/run_list_params.rbi +143 -0
- data/rbi/openai/models/beta/threads/run_retrieve_params.rbi +42 -0
- data/rbi/openai/models/beta/threads/run_status.rbi +50 -0
- data/rbi/openai/models/beta/threads/run_submit_tool_outputs_params.rbi +111 -0
- data/rbi/openai/models/beta/threads/run_update_params.rbi +66 -0
- data/rbi/openai/models/beta/threads/runs/code_interpreter_logs.rbi +58 -0
- data/rbi/openai/models/beta/threads/runs/code_interpreter_output_image.rbi +106 -0
- data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call.rbi +281 -0
- data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbi +196 -0
- data/rbi/openai/models/beta/threads/runs/file_search_tool_call.rbi +432 -0
- data/rbi/openai/models/beta/threads/runs/file_search_tool_call_delta.rbi +75 -0
- data/rbi/openai/models/beta/threads/runs/function_tool_call.rbi +128 -0
- data/rbi/openai/models/beta/threads/runs/function_tool_call_delta.rbi +149 -0
- data/rbi/openai/models/beta/threads/runs/message_creation_step_details.rbi +92 -0
- data/rbi/openai/models/beta/threads/runs/run_step.rbi +485 -0
- data/rbi/openai/models/beta/threads/runs/run_step_delta.rbi +94 -0
- data/rbi/openai/models/beta/threads/runs/run_step_delta_event.rbi +73 -0
- data/rbi/openai/models/beta/threads/runs/run_step_delta_message_delta.rbi +99 -0
- data/rbi/openai/models/beta/threads/runs/run_step_include.rbi +39 -0
- data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +203 -0
- data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +100 -0
- data/rbi/openai/models/beta/threads/runs/tool_call.rbi +33 -0
- data/rbi/openai/models/beta/threads/runs/tool_call_delta.rbi +33 -0
- data/rbi/openai/models/beta/threads/runs/tool_call_delta_object.rbi +89 -0
- data/rbi/openai/models/beta/threads/runs/tool_calls_step_details.rbi +69 -0
- data/rbi/openai/models/beta/threads/text.rbi +54 -0
- data/rbi/openai/models/beta/threads/text_content_block.rbi +51 -0
- data/rbi/openai/models/beta/threads/text_content_block_param.rbi +41 -0
- data/rbi/openai/models/beta/threads/text_delta.rbi +76 -0
- data/rbi/openai/models/beta/threads/text_delta_block.rbi +62 -0
- data/rbi/openai/models/chat/chat_completion.rbi +419 -0
- data/rbi/openai/models/chat/chat_completion_assistant_message_param.rbi +299 -0
- data/rbi/openai/models/chat/chat_completion_audio.rbi +72 -0
- data/rbi/openai/models/chat/chat_completion_audio_param.rbi +213 -0
- data/rbi/openai/models/chat/chat_completion_chunk.rbi +841 -0
- data/rbi/openai/models/chat/chat_completion_content_part.rbi +141 -0
- data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +162 -0
- data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +148 -0
- data/rbi/openai/models/chat/chat_completion_content_part_refusal.rbi +40 -0
- data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +42 -0
- data/rbi/openai/models/chat/chat_completion_deleted.rbi +52 -0
- data/rbi/openai/models/chat/chat_completion_developer_message_param.rbi +106 -0
- data/rbi/openai/models/chat/chat_completion_function_call_option.rbi +36 -0
- data/rbi/openai/models/chat/chat_completion_function_message_param.rbi +57 -0
- data/rbi/openai/models/chat/chat_completion_message.rbi +309 -0
- data/rbi/openai/models/chat/chat_completion_message_param.rbi +36 -0
- data/rbi/openai/models/chat/chat_completion_message_tool_call.rbi +113 -0
- data/rbi/openai/models/chat/chat_completion_modality.rbi +29 -0
- data/rbi/openai/models/chat/chat_completion_named_tool_choice.rbi +86 -0
- data/rbi/openai/models/chat/chat_completion_prediction_content.rbi +99 -0
- data/rbi/openai/models/chat/chat_completion_reasoning_effort.rbi +11 -0
- data/rbi/openai/models/chat/chat_completion_role.rbi +36 -0
- data/rbi/openai/models/chat/chat_completion_store_message.rbi +35 -0
- data/rbi/openai/models/chat/chat_completion_stream_options.rbi +50 -0
- data/rbi/openai/models/chat/chat_completion_system_message_param.rbi +105 -0
- data/rbi/openai/models/chat/chat_completion_token_logprob.rbi +151 -0
- data/rbi/openai/models/chat/chat_completion_tool.rbi +47 -0
- data/rbi/openai/models/chat/chat_completion_tool_choice_option.rbi +77 -0
- data/rbi/openai/models/chat/chat_completion_tool_message_param.rbi +97 -0
- data/rbi/openai/models/chat/chat_completion_user_message_param.rbi +104 -0
- data/rbi/openai/models/chat/completion_create_params.rbi +1351 -0
- data/rbi/openai/models/chat/completion_delete_params.rbi +32 -0
- data/rbi/openai/models/chat/completion_list_params.rbi +131 -0
- data/rbi/openai/models/chat/completion_retrieve_params.rbi +32 -0
- data/rbi/openai/models/chat/completion_update_params.rbi +58 -0
- data/rbi/openai/models/chat/completions/message_list_params.rbi +126 -0
- data/rbi/openai/models/chat_model.rbi +119 -0
- data/rbi/openai/models/comparison_filter.rbi +116 -0
- data/rbi/openai/models/completion.rbi +97 -0
- data/rbi/openai/models/completion_choice.rbi +158 -0
- data/rbi/openai/models/completion_create_params.rbi +445 -0
- data/rbi/openai/models/completion_usage.rbi +215 -0
- data/rbi/openai/models/compound_filter.rbi +81 -0
- data/rbi/openai/models/container_create_params.rbi +145 -0
- data/rbi/openai/models/container_create_response.rbi +192 -0
- data/rbi/openai/models/container_delete_params.rbi +27 -0
- data/rbi/openai/models/container_list_params.rbi +99 -0
- data/rbi/openai/models/container_list_response.rbi +190 -0
- data/rbi/openai/models/container_retrieve_params.rbi +27 -0
- data/rbi/openai/models/container_retrieve_response.rbi +193 -0
- data/rbi/openai/models/containers/file_create_params.rbi +62 -0
- data/rbi/openai/models/containers/file_create_response.rbi +90 -0
- data/rbi/openai/models/containers/file_delete_params.rbi +40 -0
- data/rbi/openai/models/containers/file_list_params.rbi +116 -0
- data/rbi/openai/models/containers/file_list_response.rbi +90 -0
- data/rbi/openai/models/containers/file_retrieve_params.rbi +40 -0
- data/rbi/openai/models/containers/file_retrieve_response.rbi +90 -0
- data/rbi/openai/models/containers/files/content_retrieve_params.rbi +42 -0
- data/rbi/openai/models/create_embedding_response.rbi +102 -0
- data/rbi/openai/models/embedding.rbi +52 -0
- data/rbi/openai/models/embedding_create_params.rbi +231 -0
- data/rbi/openai/models/embedding_model.rbi +23 -0
- data/rbi/openai/models/error_object.rbi +46 -0
- data/rbi/openai/models/eval_create_params.rbi +806 -0
- data/rbi/openai/models/eval_create_response.rbi +330 -0
- data/rbi/openai/models/eval_custom_data_source_config.rbi +47 -0
- data/rbi/openai/models/eval_delete_params.rbi +27 -0
- data/rbi/openai/models/eval_delete_response.rbi +37 -0
- data/rbi/openai/models/eval_list_params.rbi +127 -0
- data/rbi/openai/models/eval_list_response.rbi +328 -0
- data/rbi/openai/models/eval_retrieve_params.rbi +27 -0
- data/rbi/openai/models/eval_retrieve_response.rbi +332 -0
- data/rbi/openai/models/eval_stored_completions_data_source_config.rbi +69 -0
- data/rbi/openai/models/eval_update_params.rbi +64 -0
- data/rbi/openai/models/eval_update_response.rbi +330 -0
- data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +874 -0
- data/rbi/openai/models/evals/create_eval_jsonl_run_data_source.rbi +215 -0
- data/rbi/openai/models/evals/eval_api_error.rbi +38 -0
- data/rbi/openai/models/evals/run_cancel_params.rbi +37 -0
- data/rbi/openai/models/evals/run_cancel_response.rbi +1296 -0
- data/rbi/openai/models/evals/run_create_params.rbi +1064 -0
- data/rbi/openai/models/evals/run_create_response.rbi +1296 -0
- data/rbi/openai/models/evals/run_delete_params.rbi +37 -0
- data/rbi/openai/models/evals/run_delete_response.rbi +51 -0
- data/rbi/openai/models/evals/run_list_params.rbi +149 -0
- data/rbi/openai/models/evals/run_list_response.rbi +1292 -0
- data/rbi/openai/models/evals/run_retrieve_params.rbi +37 -0
- data/rbi/openai/models/evals/run_retrieve_response.rbi +1298 -0
- data/rbi/openai/models/evals/runs/output_item_list_params.rbi +186 -0
- data/rbi/openai/models/evals/runs/output_item_list_response.rbi +411 -0
- data/rbi/openai/models/evals/runs/output_item_retrieve_params.rbi +50 -0
- data/rbi/openai/models/evals/runs/output_item_retrieve_response.rbi +413 -0
- data/rbi/openai/models/file_chunking_strategy.rbi +22 -0
- data/rbi/openai/models/file_chunking_strategy_param.rbi +25 -0
- data/rbi/openai/models/file_content.rbi +7 -0
- data/rbi/openai/models/file_content_params.rbi +27 -0
- data/rbi/openai/models/file_create_params.rbi +57 -0
- data/rbi/openai/models/file_delete_params.rbi +27 -0
- data/rbi/openai/models/file_deleted.rbi +33 -0
- data/rbi/openai/models/file_list_params.rbi +110 -0
- data/rbi/openai/models/file_object.rbi +164 -0
- data/rbi/openai/models/file_purpose.rbi +27 -0
- data/rbi/openai/models/file_retrieve_params.rbi +27 -0
- data/rbi/openai/models/fine_tuning/alpha/grader_run_params.rbi +150 -0
- data/rbi/openai/models/fine_tuning/alpha/grader_run_response.rbi +268 -0
- data/rbi/openai/models/fine_tuning/alpha/grader_validate_params.rbi +100 -0
- data/rbi/openai/models/fine_tuning/alpha/grader_validate_response.rbi +98 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_create_params.rbi +50 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_create_response.rbi +70 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_delete_params.rbi +45 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_delete_response.rbi +54 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbi +134 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rbi +139 -0
- data/rbi/openai/models/fine_tuning/dpo_hyperparameters.rbi +157 -0
- data/rbi/openai/models/fine_tuning/dpo_method.rbi +45 -0
- data/rbi/openai/models/fine_tuning/fine_tuning_job.rbi +625 -0
- data/rbi/openai/models/fine_tuning/fine_tuning_job_event.rbi +181 -0
- data/rbi/openai/models/fine_tuning/fine_tuning_job_integration.rbi +12 -0
- data/rbi/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rbi +85 -0
- data/rbi/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rbi +66 -0
- data/rbi/openai/models/fine_tuning/job_cancel_params.rbi +32 -0
- data/rbi/openai/models/fine_tuning/job_create_params.rbi +665 -0
- data/rbi/openai/models/fine_tuning/job_list_events_params.rbi +62 -0
- data/rbi/openai/models/fine_tuning/job_list_params.rbi +69 -0
- data/rbi/openai/models/fine_tuning/job_pause_params.rbi +29 -0
- data/rbi/openai/models/fine_tuning/job_resume_params.rbi +32 -0
- data/rbi/openai/models/fine_tuning/job_retrieve_params.rbi +32 -0
- data/rbi/openai/models/fine_tuning/jobs/checkpoint_list_params.rbi +64 -0
- data/rbi/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rbi +197 -0
- data/rbi/openai/models/fine_tuning/reinforcement_hyperparameters.rbi +281 -0
- data/rbi/openai/models/fine_tuning/reinforcement_method.rbi +112 -0
- data/rbi/openai/models/fine_tuning/supervised_hyperparameters.rbi +128 -0
- data/rbi/openai/models/fine_tuning/supervised_method.rbi +52 -0
- data/rbi/openai/models/function_definition.rbi +91 -0
- data/rbi/openai/models/function_parameters.rbi +11 -0
- data/rbi/openai/models/graders/label_model_grader.rbi +300 -0
- data/rbi/openai/models/graders/multi_grader.rbi +123 -0
- data/rbi/openai/models/graders/python_grader.rbi +64 -0
- data/rbi/openai/models/graders/score_model_grader.rbi +307 -0
- data/rbi/openai/models/graders/string_check_grader.rbi +118 -0
- data/rbi/openai/models/graders/text_similarity_grader.rbi +161 -0
- data/rbi/openai/models/image.rbi +62 -0
- data/rbi/openai/models/image_create_variation_params.rbi +201 -0
- data/rbi/openai/models/image_edit_params.rbi +336 -0
- data/rbi/openai/models/image_generate_params.rbi +442 -0
- data/rbi/openai/models/image_model.rbi +20 -0
- data/rbi/openai/models/images_response.rbi +165 -0
- data/rbi/openai/models/metadata.rbi +11 -0
- data/rbi/openai/models/model.rbi +54 -0
- data/rbi/openai/models/model_delete_params.rbi +27 -0
- data/rbi/openai/models/model_deleted.rbi +33 -0
- data/rbi/openai/models/model_list_params.rbi +27 -0
- data/rbi/openai/models/model_retrieve_params.rbi +27 -0
- data/rbi/openai/models/moderation.rbi +1061 -0
- data/rbi/openai/models/moderation_create_params.rbi +122 -0
- data/rbi/openai/models/moderation_create_response.rbi +53 -0
- data/rbi/openai/models/moderation_image_url_input.rbi +76 -0
- data/rbi/openai/models/moderation_model.rbi +28 -0
- data/rbi/openai/models/moderation_multi_modal_input.rbi +21 -0
- data/rbi/openai/models/moderation_text_input.rbi +34 -0
- data/rbi/openai/models/other_file_chunking_strategy_object.rbi +33 -0
- data/rbi/openai/models/reasoning.rbi +127 -0
- data/rbi/openai/models/reasoning_effort.rbi +26 -0
- data/rbi/openai/models/response_format_json_object.rbi +30 -0
- data/rbi/openai/models/response_format_json_schema.rbi +150 -0
- data/rbi/openai/models/response_format_text.rbi +28 -0
- data/rbi/openai/models/responses/computer_tool.rbi +113 -0
- data/rbi/openai/models/responses/easy_input_message.rbi +164 -0
- data/rbi/openai/models/responses/file_search_tool.rbi +223 -0
- data/rbi/openai/models/responses/function_tool.rbi +76 -0
- data/rbi/openai/models/responses/input_item_list_params.rbi +157 -0
- data/rbi/openai/models/responses/response.rbi +664 -0
- data/rbi/openai/models/responses/response_audio_delta_event.rbi +53 -0
- data/rbi/openai/models/responses/response_audio_done_event.rbi +43 -0
- data/rbi/openai/models/responses/response_audio_transcript_delta_event.rbi +53 -0
- data/rbi/openai/models/responses/response_audio_transcript_done_event.rbi +43 -0
- data/rbi/openai/models/responses/response_cancel_params.rbi +32 -0
- data/rbi/openai/models/responses/response_code_interpreter_call_code_delta_event.rbi +67 -0
- data/rbi/openai/models/responses/response_code_interpreter_call_code_done_event.rbi +67 -0
- data/rbi/openai/models/responses/response_code_interpreter_call_completed_event.rbi +77 -0
- data/rbi/openai/models/responses/response_code_interpreter_call_in_progress_event.rbi +77 -0
- data/rbi/openai/models/responses/response_code_interpreter_call_interpreting_event.rbi +77 -0
- data/rbi/openai/models/responses/response_code_interpreter_tool_call.rbi +297 -0
- data/rbi/openai/models/responses/response_completed_event.rbi +62 -0
- data/rbi/openai/models/responses/response_computer_tool_call.rbi +795 -0
- data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi +223 -0
- data/rbi/openai/models/responses/response_computer_tool_call_output_screenshot.rbi +59 -0
- data/rbi/openai/models/responses/response_content.rbi +31 -0
- data/rbi/openai/models/responses/response_content_part_added_event.rbi +115 -0
- data/rbi/openai/models/responses/response_content_part_done_event.rbi +115 -0
- data/rbi/openai/models/responses/response_create_params.rbi +688 -0
- data/rbi/openai/models/responses/response_created_event.rbi +62 -0
- data/rbi/openai/models/responses/response_delete_params.rbi +32 -0
- data/rbi/openai/models/responses/response_error.rbi +158 -0
- data/rbi/openai/models/responses/response_error_event.rbi +75 -0
- data/rbi/openai/models/responses/response_failed_event.rbi +62 -0
- data/rbi/openai/models/responses/response_file_search_call_completed_event.rbi +67 -0
- data/rbi/openai/models/responses/response_file_search_call_in_progress_event.rbi +67 -0
- data/rbi/openai/models/responses/response_file_search_call_searching_event.rbi +67 -0
- data/rbi/openai/models/responses/response_file_search_tool_call.rbi +276 -0
- data/rbi/openai/models/responses/response_format_text_config.rbi +41 -0
- data/rbi/openai/models/responses/response_format_text_json_schema_config.rbi +94 -0
- data/rbi/openai/models/responses/response_function_call_arguments_delta_event.rbi +75 -0
- data/rbi/openai/models/responses/response_function_call_arguments_done_event.rbi +73 -0
- data/rbi/openai/models/responses/response_function_tool_call.rbi +148 -0
- data/rbi/openai/models/responses/response_function_tool_call_item.rbi +35 -0
- data/rbi/openai/models/responses/response_function_tool_call_output_item.rbi +133 -0
- data/rbi/openai/models/responses/response_function_web_search.rbi +112 -0
- data/rbi/openai/models/responses/response_image_gen_call_completed_event.rbi +68 -0
- data/rbi/openai/models/responses/response_image_gen_call_generating_event.rbi +68 -0
- data/rbi/openai/models/responses/response_image_gen_call_in_progress_event.rbi +67 -0
- data/rbi/openai/models/responses/response_image_gen_call_partial_image_event.rbi +85 -0
- data/rbi/openai/models/responses/response_in_progress_event.rbi +62 -0
- data/rbi/openai/models/responses/response_includable.rbi +57 -0
- data/rbi/openai/models/responses/response_incomplete_event.rbi +62 -0
- data/rbi/openai/models/responses/response_input.rbi +15 -0
- data/rbi/openai/models/responses/response_input_audio.rbi +91 -0
- data/rbi/openai/models/responses/response_input_content.rbi +29 -0
- data/rbi/openai/models/responses/response_input_file.rbi +73 -0
- data/rbi/openai/models/responses/response_input_image.rbi +110 -0
- data/rbi/openai/models/responses/response_input_item.rbi +1499 -0
- data/rbi/openai/models/responses/response_input_message_content_list.rbi +15 -0
- data/rbi/openai/models/responses/response_input_message_item.rbi +225 -0
- data/rbi/openai/models/responses/response_input_text.rbi +39 -0
- data/rbi/openai/models/responses/response_item.rbi +820 -0
- data/rbi/openai/models/responses/response_item_list.rbi +97 -0
- data/rbi/openai/models/responses/response_mcp_call_arguments_delta_event.rbi +76 -0
- data/rbi/openai/models/responses/response_mcp_call_arguments_done_event.rbi +75 -0
- data/rbi/openai/models/responses/response_mcp_call_completed_event.rbi +43 -0
- data/rbi/openai/models/responses/response_mcp_call_failed_event.rbi +43 -0
- data/rbi/openai/models/responses/response_mcp_call_in_progress_event.rbi +67 -0
- data/rbi/openai/models/responses/response_mcp_list_tools_completed_event.rbi +43 -0
- data/rbi/openai/models/responses/response_mcp_list_tools_failed_event.rbi +43 -0
- data/rbi/openai/models/responses/response_mcp_list_tools_in_progress_event.rbi +44 -0
- data/rbi/openai/models/responses/response_output_audio.rbi +51 -0
- data/rbi/openai/models/responses/response_output_item.rbi +645 -0
- data/rbi/openai/models/responses/response_output_item_added_event.rbi +81 -0
- data/rbi/openai/models/responses/response_output_item_done_event.rbi +81 -0
- data/rbi/openai/models/responses/response_output_message.rbi +162 -0
- data/rbi/openai/models/responses/response_output_refusal.rbi +39 -0
- data/rbi/openai/models/responses/response_output_text.rbi +271 -0
- data/rbi/openai/models/responses/response_output_text_annotation_added_event.rbi +91 -0
- data/rbi/openai/models/responses/response_queued_event.rbi +62 -0
- data/rbi/openai/models/responses/response_reasoning_delta_event.rbi +83 -0
- data/rbi/openai/models/responses/response_reasoning_done_event.rbi +83 -0
- data/rbi/openai/models/responses/response_reasoning_item.rbi +170 -0
- data/rbi/openai/models/responses/response_reasoning_summary_delta_event.rbi +85 -0
- data/rbi/openai/models/responses/response_reasoning_summary_done_event.rbi +83 -0
- data/rbi/openai/models/responses/response_reasoning_summary_part_added_event.rbi +129 -0
- data/rbi/openai/models/responses/response_reasoning_summary_part_done_event.rbi +129 -0
- data/rbi/openai/models/responses/response_reasoning_summary_text_delta_event.rbi +83 -0
- data/rbi/openai/models/responses/response_reasoning_summary_text_done_event.rbi +83 -0
- data/rbi/openai/models/responses/response_refusal_delta_event.rbi +83 -0
- data/rbi/openai/models/responses/response_refusal_done_event.rbi +83 -0
- data/rbi/openai/models/responses/response_retrieve_params.rbi +62 -0
- data/rbi/openai/models/responses/response_status.rbi +36 -0
- data/rbi/openai/models/responses/response_stream_event.rbi +79 -0
- data/rbi/openai/models/responses/response_text_config.rbi +103 -0
- data/rbi/openai/models/responses/response_text_delta_event.rbi +83 -0
- data/rbi/openai/models/responses/response_text_done_event.rbi +83 -0
- data/rbi/openai/models/responses/response_usage.rbi +147 -0
- data/rbi/openai/models/responses/response_web_search_call_completed_event.rbi +67 -0
- data/rbi/openai/models/responses/response_web_search_call_in_progress_event.rbi +67 -0
- data/rbi/openai/models/responses/response_web_search_call_searching_event.rbi +67 -0
- data/rbi/openai/models/responses/tool.rbi +1063 -0
- data/rbi/openai/models/responses/tool_choice_function.rbi +39 -0
- data/rbi/openai/models/responses/tool_choice_options.rbi +36 -0
- data/rbi/openai/models/responses/tool_choice_types.rbi +121 -0
- data/rbi/openai/models/responses/web_search_tool.rbi +231 -0
- data/rbi/openai/models/responses_model.rbi +61 -0
- data/rbi/openai/models/static_file_chunking_strategy.rbi +48 -0
- data/rbi/openai/models/static_file_chunking_strategy_object.rbi +46 -0
- data/rbi/openai/models/static_file_chunking_strategy_object_param.rbi +47 -0
- data/rbi/openai/models/upload.rbi +123 -0
- data/rbi/openai/models/upload_cancel_params.rbi +27 -0
- data/rbi/openai/models/upload_complete_params.rbi +56 -0
- data/rbi/openai/models/upload_create_params.rbi +79 -0
- data/rbi/openai/models/uploads/part_create_params.rbi +45 -0
- data/rbi/openai/models/uploads/upload_part.rbi +66 -0
- data/rbi/openai/models/vector_store.rbi +254 -0
- data/rbi/openai/models/vector_store_create_params.rbi +166 -0
- data/rbi/openai/models/vector_store_delete_params.rbi +27 -0
- data/rbi/openai/models/vector_store_deleted.rbi +35 -0
- data/rbi/openai/models/vector_store_list_params.rbi +116 -0
- data/rbi/openai/models/vector_store_retrieve_params.rbi +27 -0
- data/rbi/openai/models/vector_store_search_params.rbi +242 -0
- data/rbi/openai/models/vector_store_search_response.rbi +202 -0
- data/rbi/openai/models/vector_store_update_params.rbi +113 -0
- data/rbi/openai/models/vector_stores/file_batch_cancel_params.rbi +40 -0
- data/rbi/openai/models/vector_stores/file_batch_create_params.rbi +143 -0
- data/rbi/openai/models/vector_stores/file_batch_list_files_params.rbi +224 -0
- data/rbi/openai/models/vector_stores/file_batch_retrieve_params.rbi +40 -0
- data/rbi/openai/models/vector_stores/file_content_params.rbi +40 -0
- data/rbi/openai/models/vector_stores/file_content_response.rbi +44 -0
- data/rbi/openai/models/vector_stores/file_create_params.rbi +143 -0
- data/rbi/openai/models/vector_stores/file_delete_params.rbi +40 -0
- data/rbi/openai/models/vector_stores/file_list_params.rbi +202 -0
- data/rbi/openai/models/vector_stores/file_retrieve_params.rbi +40 -0
- data/rbi/openai/models/vector_stores/file_update_params.rbi +99 -0
- data/rbi/openai/models/vector_stores/vector_store_file.rbi +337 -0
- data/rbi/openai/models/vector_stores/vector_store_file_batch.rbi +219 -0
- data/rbi/openai/models/vector_stores/vector_store_file_deleted.rbi +42 -0
- data/rbi/openai/models.rbi +202 -0
- data/rbi/openai/request_options.rbi +55 -0
- data/rbi/openai/resources/audio/speech.rbi +52 -0
- data/rbi/openai/resources/audio/transcriptions.rbi +178 -0
- data/rbi/openai/resources/audio/translations.rbi +51 -0
- data/rbi/openai/resources/audio.rbi +21 -0
- data/rbi/openai/resources/batches.rbi +104 -0
- data/rbi/openai/resources/beta/assistants.rbi +294 -0
- data/rbi/openai/resources/beta/threads/messages.rbi +159 -0
- data/rbi/openai/resources/beta/threads/runs/steps.rbi +106 -0
- data/rbi/openai/resources/beta/threads/runs.rbi +546 -0
- data/rbi/openai/resources/beta/threads.rbi +415 -0
- data/rbi/openai/resources/beta.rbi +18 -0
- data/rbi/openai/resources/chat/completions/messages.rbi +46 -0
- data/rbi/openai/resources/chat/completions.rbi +682 -0
- data/rbi/openai/resources/chat.rbi +15 -0
- data/rbi/openai/resources/completions.rbi +292 -0
- data/rbi/openai/resources/containers/files/content.rbi +27 -0
- data/rbi/openai/resources/containers/files.rbi +92 -0
- data/rbi/openai/resources/containers.rbi +86 -0
- data/rbi/openai/resources/embeddings.rbi +55 -0
- data/rbi/openai/resources/evals/runs/output_items.rbi +73 -0
- data/rbi/openai/resources/evals/runs.rbi +133 -0
- data/rbi/openai/resources/evals.rbi +146 -0
- data/rbi/openai/resources/files.rbi +122 -0
- data/rbi/openai/resources/fine_tuning/alpha/graders.rbi +65 -0
- data/rbi/openai/resources/fine_tuning/alpha.rbi +17 -0
- data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi +94 -0
- data/rbi/openai/resources/fine_tuning/checkpoints.rbi +17 -0
- data/rbi/openai/resources/fine_tuning/jobs/checkpoints.rbi +40 -0
- data/rbi/openai/resources/fine_tuning/jobs.rbi +214 -0
- data/rbi/openai/resources/fine_tuning/methods.rbi +14 -0
- data/rbi/openai/resources/fine_tuning.rbi +24 -0
- data/rbi/openai/resources/graders/grader_models.rbi +14 -0
- data/rbi/openai/resources/graders.rbi +15 -0
- data/rbi/openai/resources/images.rbi +205 -0
- data/rbi/openai/resources/models.rbi +52 -0
- data/rbi/openai/resources/moderations.rbi +34 -0
- data/rbi/openai/resources/responses/input_items.rbi +52 -0
- data/rbi/openai/resources/responses.rbi +485 -0
- data/rbi/openai/resources/uploads/parts.rbi +41 -0
- data/rbi/openai/resources/uploads.rbi +109 -0
- data/rbi/openai/resources/vector_stores/file_batches.rbi +134 -0
- data/rbi/openai/resources/vector_stores/files.rbi +183 -0
- data/rbi/openai/resources/vector_stores.rbi +182 -0
- data/rbi/openai/structured_output.rbi +10 -0
- data/rbi/openai/version.rbi +5 -0
- data/sig/openai/client.rbs +64 -0
- data/sig/openai/errors.rbs +107 -0
- data/sig/openai/file_part.rbs +21 -0
- data/sig/openai/internal/cursor_page.rbs +13 -0
- data/sig/openai/internal/page.rbs +13 -0
- data/sig/openai/internal/stream.rbs +9 -0
- data/sig/openai/internal/transport/base_client.rbs +131 -0
- data/sig/openai/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/openai/internal/type/array_of.rbs +48 -0
- data/sig/openai/internal/type/base_model.rbs +102 -0
- data/sig/openai/internal/type/base_page.rbs +24 -0
- data/sig/openai/internal/type/base_stream.rbs +33 -0
- data/sig/openai/internal/type/boolean.rbs +26 -0
- data/sig/openai/internal/type/converter.rbs +56 -0
- data/sig/openai/internal/type/enum.rbs +32 -0
- data/sig/openai/internal/type/file_input.rbs +25 -0
- data/sig/openai/internal/type/hash_of.rbs +48 -0
- data/sig/openai/internal/type/request_parameters.rbs +17 -0
- data/sig/openai/internal/type/union.rbs +52 -0
- data/sig/openai/internal/type/unknown.rbs +26 -0
- data/sig/openai/internal/util.rbs +185 -0
- data/sig/openai/internal.rbs +9 -0
- data/sig/openai/models/all_models.rbs +31 -0
- data/sig/openai/models/audio/speech_create_params.rbs +116 -0
- data/sig/openai/models/audio/speech_model.rbs +17 -0
- data/sig/openai/models/audio/transcription.rbs +59 -0
- data/sig/openai/models/audio/transcription_create_params.rbs +163 -0
- data/sig/openai/models/audio/transcription_create_response.rbs +14 -0
- data/sig/openai/models/audio/transcription_include.rbs +15 -0
- data/sig/openai/models/audio/transcription_segment.rbs +67 -0
- data/sig/openai/models/audio/transcription_stream_event.rbs +15 -0
- data/sig/openai/models/audio/transcription_text_delta_event.rbs +60 -0
- data/sig/openai/models/audio/transcription_text_done_event.rbs +60 -0
- data/sig/openai/models/audio/transcription_verbose.rbs +50 -0
- data/sig/openai/models/audio/transcription_word.rbs +19 -0
- data/sig/openai/models/audio/translation.rbs +15 -0
- data/sig/openai/models/audio/translation_create_params.rbs +78 -0
- data/sig/openai/models/audio/translation_create_response.rbs +14 -0
- data/sig/openai/models/audio/translation_verbose.rbs +41 -0
- data/sig/openai/models/audio_model.rbs +16 -0
- data/sig/openai/models/audio_response_format.rbs +17 -0
- data/sig/openai/models/auto_file_chunking_strategy_param.rbs +13 -0
- data/sig/openai/models/batch.rbs +185 -0
- data/sig/openai/models/batch_cancel_params.rbs +14 -0
- data/sig/openai/models/batch_create_params.rbs +68 -0
- data/sig/openai/models/batch_error.rbs +34 -0
- data/sig/openai/models/batch_list_params.rbs +32 -0
- data/sig/openai/models/batch_request_counts.rbs +22 -0
- data/sig/openai/models/batch_retrieve_params.rbs +15 -0
- data/sig/openai/models/beta/assistant.rbs +136 -0
- data/sig/openai/models/beta/assistant_create_params.rbs +257 -0
- data/sig/openai/models/beta/assistant_delete_params.rbs +17 -0
- data/sig/openai/models/beta/assistant_deleted.rbs +28 -0
- data/sig/openai/models/beta/assistant_list_params.rbs +64 -0
- data/sig/openai/models/beta/assistant_response_format_option.rbs +17 -0
- data/sig/openai/models/beta/assistant_retrieve_params.rbs +17 -0
- data/sig/openai/models/beta/assistant_stream_event.rbs +535 -0
- data/sig/openai/models/beta/assistant_tool.rbs +16 -0
- data/sig/openai/models/beta/assistant_tool_choice.rbs +43 -0
- data/sig/openai/models/beta/assistant_tool_choice_function.rbs +15 -0
- data/sig/openai/models/beta/assistant_tool_choice_option.rbs +27 -0
- data/sig/openai/models/beta/assistant_update_params.rbs +222 -0
- data/sig/openai/models/beta/code_interpreter_tool.rbs +15 -0
- data/sig/openai/models/beta/file_search_tool.rbs +96 -0
- data/sig/openai/models/beta/function_tool.rbs +24 -0
- data/sig/openai/models/beta/message_stream_event.rbs +128 -0
- data/sig/openai/models/beta/run_step_stream_event.rbs +174 -0
- data/sig/openai/models/beta/run_stream_event.rbs +216 -0
- data/sig/openai/models/beta/thread.rbs +96 -0
- data/sig/openai/models/beta/thread_create_and_run_params.rbs +500 -0
- data/sig/openai/models/beta/thread_create_params.rbs +312 -0
- data/sig/openai/models/beta/thread_delete_params.rbs +17 -0
- data/sig/openai/models/beta/thread_deleted.rbs +24 -0
- data/sig/openai/models/beta/thread_retrieve_params.rbs +17 -0
- data/sig/openai/models/beta/thread_stream_event.rbs +30 -0
- data/sig/openai/models/beta/thread_update_params.rbs +87 -0
- data/sig/openai/models/beta/threads/annotation.rbs +17 -0
- data/sig/openai/models/beta/threads/annotation_delta.rbs +17 -0
- data/sig/openai/models/beta/threads/file_citation_annotation.rbs +54 -0
- data/sig/openai/models/beta/threads/file_citation_delta_annotation.rbs +75 -0
- data/sig/openai/models/beta/threads/file_path_annotation.rbs +54 -0
- data/sig/openai/models/beta/threads/file_path_delta_annotation.rbs +71 -0
- data/sig/openai/models/beta/threads/image_file.rbs +45 -0
- data/sig/openai/models/beta/threads/image_file_content_block.rbs +26 -0
- data/sig/openai/models/beta/threads/image_file_delta.rbs +47 -0
- data/sig/openai/models/beta/threads/image_file_delta_block.rbs +38 -0
- data/sig/openai/models/beta/threads/image_url.rbs +45 -0
- data/sig/openai/models/beta/threads/image_url_content_block.rbs +26 -0
- data/sig/openai/models/beta/threads/image_url_delta.rbs +47 -0
- data/sig/openai/models/beta/threads/image_url_delta_block.rbs +38 -0
- data/sig/openai/models/beta/threads/message.rbs +197 -0
- data/sig/openai/models/beta/threads/message_content.rbs +19 -0
- data/sig/openai/models/beta/threads/message_content_delta.rbs +19 -0
- data/sig/openai/models/beta/threads/message_content_part_param.rbs +18 -0
- data/sig/openai/models/beta/threads/message_create_params.rbs +116 -0
- data/sig/openai/models/beta/threads/message_delete_params.rbs +27 -0
- data/sig/openai/models/beta/threads/message_deleted.rbs +30 -0
- data/sig/openai/models/beta/threads/message_delta.rbs +48 -0
- data/sig/openai/models/beta/threads/message_delta_event.rbs +34 -0
- data/sig/openai/models/beta/threads/message_list_params.rbs +73 -0
- data/sig/openai/models/beta/threads/message_retrieve_params.rbs +27 -0
- data/sig/openai/models/beta/threads/message_update_params.rbs +32 -0
- data/sig/openai/models/beta/threads/refusal_content_block.rbs +19 -0
- data/sig/openai/models/beta/threads/refusal_delta_block.rbs +28 -0
- data/sig/openai/models/beta/threads/required_action_function_tool_call.rbs +46 -0
- data/sig/openai/models/beta/threads/run.rbs +319 -0
- data/sig/openai/models/beta/threads/run_cancel_params.rbs +27 -0
- data/sig/openai/models/beta/threads/run_create_params.rbs +260 -0
- data/sig/openai/models/beta/threads/run_list_params.rbs +66 -0
- data/sig/openai/models/beta/threads/run_retrieve_params.rbs +27 -0
- data/sig/openai/models/beta/threads/run_status.rbs +34 -0
- data/sig/openai/models/beta/threads/run_submit_tool_outputs_params.rbs +51 -0
- data/sig/openai/models/beta/threads/run_update_params.rbs +32 -0
- data/sig/openai/models/beta/threads/runs/code_interpreter_logs.rbs +30 -0
- data/sig/openai/models/beta/threads/runs/code_interpreter_output_image.rbs +52 -0
- data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call.rbs +112 -0
- data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbs +85 -0
- data/sig/openai/models/beta/threads/runs/file_search_tool_call.rbs +173 -0
- data/sig/openai/models/beta/threads/runs/file_search_tool_call_delta.rbs +38 -0
- data/sig/openai/models/beta/threads/runs/function_tool_call.rbs +58 -0
- data/sig/openai/models/beta/threads/runs/function_tool_call_delta.rbs +73 -0
- data/sig/openai/models/beta/threads/runs/message_creation_step_details.rbs +41 -0
- data/sig/openai/models/beta/threads/runs/run_step.rbs +199 -0
- data/sig/openai/models/beta/threads/runs/run_step_delta.rbs +42 -0
- data/sig/openai/models/beta/threads/runs/run_step_delta_event.rbs +38 -0
- data/sig/openai/models/beta/threads/runs/run_step_delta_message_delta.rbs +49 -0
- data/sig/openai/models/beta/threads/runs/run_step_include.rbs +22 -0
- data/sig/openai/models/beta/threads/runs/step_list_params.rbs +82 -0
- data/sig/openai/models/beta/threads/runs/step_retrieve_params.rbs +46 -0
- data/sig/openai/models/beta/threads/runs/tool_call.rbs +20 -0
- data/sig/openai/models/beta/threads/runs/tool_call_delta.rbs +20 -0
- data/sig/openai/models/beta/threads/runs/tool_call_delta_object.rbs +35 -0
- data/sig/openai/models/beta/threads/runs/tool_calls_step_details.rbs +31 -0
- data/sig/openai/models/beta/threads/text.rbs +29 -0
- data/sig/openai/models/beta/threads/text_content_block.rbs +23 -0
- data/sig/openai/models/beta/threads/text_content_block_param.rbs +19 -0
- data/sig/openai/models/beta/threads/text_delta.rbs +35 -0
- data/sig/openai/models/beta/threads/text_delta_block.rbs +38 -0
- data/sig/openai/models/chat/chat_completion.rbs +144 -0
- data/sig/openai/models/chat/chat_completion_assistant_message_param.rbs +104 -0
- data/sig/openai/models/chat/chat_completion_audio.rbs +34 -0
- data/sig/openai/models/chat/chat_completion_audio_param.rbs +76 -0
- data/sig/openai/models/chat/chat_completion_chunk.rbs +289 -0
- data/sig/openai/models/chat/chat_completion_content_part.rbs +69 -0
- data/sig/openai/models/chat/chat_completion_content_part_image.rbs +67 -0
- data/sig/openai/models/chat/chat_completion_content_part_input_audio.rbs +62 -0
- data/sig/openai/models/chat/chat_completion_content_part_refusal.rbs +20 -0
- data/sig/openai/models/chat/chat_completion_content_part_text.rbs +19 -0
- data/sig/openai/models/chat/chat_completion_deleted.rbs +30 -0
- data/sig/openai/models/chat/chat_completion_developer_message_param.rbs +47 -0
- data/sig/openai/models/chat/chat_completion_function_call_option.rbs +17 -0
- data/sig/openai/models/chat/chat_completion_function_message_param.rbs +26 -0
- data/sig/openai/models/chat/chat_completion_message.rbs +132 -0
- data/sig/openai/models/chat/chat_completion_message_param.rbs +21 -0
- data/sig/openai/models/chat/chat_completion_message_tool_call.rbs +46 -0
- data/sig/openai/models/chat/chat_completion_modality.rbs +18 -0
- data/sig/openai/models/chat/chat_completion_named_tool_choice.rbs +39 -0
- data/sig/openai/models/chat/chat_completion_prediction_content.rbs +40 -0
- data/sig/openai/models/chat/chat_completion_reasoning_effort.rbs +9 -0
- data/sig/openai/models/chat/chat_completion_role.rbs +23 -0
- data/sig/openai/models/chat/chat_completion_store_message.rbs +19 -0
- data/sig/openai/models/chat/chat_completion_stream_options.rbs +19 -0
- data/sig/openai/models/chat/chat_completion_system_message_param.rbs +47 -0
- data/sig/openai/models/chat/chat_completion_token_logprob.rbs +62 -0
- data/sig/openai/models/chat/chat_completion_tool.rbs +26 -0
- data/sig/openai/models/chat/chat_completion_tool_choice_option.rbs +29 -0
- data/sig/openai/models/chat/chat_completion_tool_message_param.rbs +45 -0
- data/sig/openai/models/chat/chat_completion_user_message_param.rbs +47 -0
- data/sig/openai/models/chat/completion_create_params.rbs +407 -0
- data/sig/openai/models/chat/completion_delete_params.rbs +17 -0
- data/sig/openai/models/chat/completion_list_params.rbs +69 -0
- data/sig/openai/models/chat/completion_retrieve_params.rbs +17 -0
- data/sig/openai/models/chat/completion_update_params.rbs +26 -0
- data/sig/openai/models/chat/completions/message_list_params.rbs +59 -0
- data/sig/openai/models/chat_model.rbs +120 -0
- data/sig/openai/models/comparison_filter.rbs +53 -0
- data/sig/openai/models/completion.rbs +54 -0
- data/sig/openai/models/completion_choice.rbs +89 -0
- data/sig/openai/models/completion_create_params.rbs +146 -0
- data/sig/openai/models/completion_usage.rbs +108 -0
- data/sig/openai/models/compound_filter.rbs +44 -0
- data/sig/openai/models/container_create_params.rbs +74 -0
- data/sig/openai/models/container_create_response.rbs +87 -0
- data/sig/openai/models/container_delete_params.rbs +15 -0
- data/sig/openai/models/container_list_params.rbs +55 -0
- data/sig/openai/models/container_list_response.rbs +87 -0
- data/sig/openai/models/container_retrieve_params.rbs +15 -0
- data/sig/openai/models/container_retrieve_response.rbs +87 -0
- data/sig/openai/models/containers/file_create_params.rbs +36 -0
- data/sig/openai/models/containers/file_create_response.rbs +52 -0
- data/sig/openai/models/containers/file_delete_params.rbs +25 -0
- data/sig/openai/models/containers/file_list_params.rbs +57 -0
- data/sig/openai/models/containers/file_list_response.rbs +52 -0
- data/sig/openai/models/containers/file_retrieve_params.rbs +25 -0
- data/sig/openai/models/containers/file_retrieve_response.rbs +52 -0
- data/sig/openai/models/containers/files/content_retrieve_params.rbs +27 -0
- data/sig/openai/models/create_embedding_response.rbs +47 -0
- data/sig/openai/models/embedding.rbs +26 -0
- data/sig/openai/models/embedding_create_params.rbs +88 -0
- data/sig/openai/models/embedding_model.rbs +18 -0
- data/sig/openai/models/error_object.rbs +30 -0
- data/sig/openai/models/eval_create_params.rbs +308 -0
- data/sig/openai/models/eval_create_response.rbs +137 -0
- data/sig/openai/models/eval_custom_data_source_config.rbs +16 -0
- data/sig/openai/models/eval_delete_params.rbs +14 -0
- data/sig/openai/models/eval_delete_response.rbs +18 -0
- data/sig/openai/models/eval_list_params.rbs +75 -0
- data/sig/openai/models/eval_list_response.rbs +137 -0
- data/sig/openai/models/eval_retrieve_params.rbs +15 -0
- data/sig/openai/models/eval_retrieve_response.rbs +137 -0
- data/sig/openai/models/eval_stored_completions_data_source_config.rbs +30 -0
- data/sig/openai/models/eval_update_params.rbs +30 -0
- data/sig/openai/models/eval_update_response.rbs +137 -0
- data/sig/openai/models/evals/create_eval_completions_run_data_source.rbs +345 -0
- data/sig/openai/models/evals/create_eval_jsonl_run_data_source.rbs +92 -0
- data/sig/openai/models/evals/eval_api_error.rbs +19 -0
- data/sig/openai/models/evals/run_cancel_params.rbs +25 -0
- data/sig/openai/models/evals/run_cancel_response.rbs +563 -0
- data/sig/openai/models/evals/run_create_params.rbs +434 -0
- data/sig/openai/models/evals/run_create_response.rbs +563 -0
- data/sig/openai/models/evals/run_delete_params.rbs +25 -0
- data/sig/openai/models/evals/run_delete_response.rbs +30 -0
- data/sig/openai/models/evals/run_list_params.rbs +80 -0
- data/sig/openai/models/evals/run_list_response.rbs +563 -0
- data/sig/openai/models/evals/run_retrieve_params.rbs +25 -0
- data/sig/openai/models/evals/run_retrieve_response.rbs +563 -0
- data/sig/openai/models/evals/runs/output_item_list_params.rbs +84 -0
- data/sig/openai/models/evals/runs/output_item_list_response.rbs +191 -0
- data/sig/openai/models/evals/runs/output_item_retrieve_params.rbs +32 -0
- data/sig/openai/models/evals/runs/output_item_retrieve_response.rbs +191 -0
- data/sig/openai/models/file_chunking_strategy.rbs +13 -0
- data/sig/openai/models/file_chunking_strategy_param.rbs +13 -0
- data/sig/openai/models/file_content.rbs +5 -0
- data/sig/openai/models/file_content_params.rbs +14 -0
- data/sig/openai/models/file_create_params.rbs +31 -0
- data/sig/openai/models/file_delete_params.rbs +14 -0
- data/sig/openai/models/file_deleted.rbs +17 -0
- data/sig/openai/models/file_list_params.rbs +62 -0
- data/sig/openai/models/file_object.rbs +99 -0
- data/sig/openai/models/file_purpose.rbs +19 -0
- data/sig/openai/models/file_retrieve_params.rbs +15 -0
- data/sig/openai/models/fine_tuning/alpha/grader_run_params.rbs +63 -0
- data/sig/openai/models/fine_tuning/alpha/grader_run_response.rbs +168 -0
- data/sig/openai/models/fine_tuning/alpha/grader_validate_params.rbs +43 -0
- data/sig/openai/models/fine_tuning/alpha/grader_validate_response.rbs +41 -0
- data/sig/openai/models/fine_tuning/checkpoints/permission_create_params.rbs +28 -0
- data/sig/openai/models/fine_tuning/checkpoints/permission_create_response.rbs +39 -0
- data/sig/openai/models/fine_tuning/checkpoints/permission_delete_params.rbs +28 -0
- data/sig/openai/models/fine_tuning/checkpoints/permission_delete_response.rbs +30 -0
- data/sig/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbs +66 -0
- data/sig/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rbs +76 -0
- data/sig/openai/models/fine_tuning/dpo_hyperparameters.rbs +85 -0
- data/sig/openai/models/fine_tuning/dpo_method.rbs +24 -0
- data/sig/openai/models/fine_tuning/fine_tuning_job.rbs +272 -0
- data/sig/openai/models/fine_tuning/fine_tuning_job_event.rbs +83 -0
- data/sig/openai/models/fine_tuning/fine_tuning_job_integration.rbs +9 -0
- data/sig/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rbs +41 -0
- data/sig/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rbs +29 -0
- data/sig/openai/models/fine_tuning/job_cancel_params.rbs +16 -0
- data/sig/openai/models/fine_tuning/job_create_params.rbs +269 -0
- data/sig/openai/models/fine_tuning/job_list_events_params.rbs +34 -0
- data/sig/openai/models/fine_tuning/job_list_params.rbs +38 -0
- data/sig/openai/models/fine_tuning/job_pause_params.rbs +16 -0
- data/sig/openai/models/fine_tuning/job_resume_params.rbs +16 -0
- data/sig/openai/models/fine_tuning/job_retrieve_params.rbs +17 -0
- data/sig/openai/models/fine_tuning/jobs/checkpoint_list_params.rbs +36 -0
- data/sig/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rbs +115 -0
- data/sig/openai/models/fine_tuning/reinforcement_hyperparameters.rbs +141 -0
- data/sig/openai/models/fine_tuning/reinforcement_method.rbs +44 -0
- data/sig/openai/models/fine_tuning/supervised_hyperparameters.rbs +68 -0
- data/sig/openai/models/fine_tuning/supervised_method.rbs +24 -0
- data/sig/openai/models/function_definition.rbs +41 -0
- data/sig/openai/models/function_parameters.rbs +7 -0
- data/sig/openai/models/graders/label_model_grader.rbs +126 -0
- data/sig/openai/models/graders/multi_grader.rbs +52 -0
- data/sig/openai/models/graders/python_grader.rbs +36 -0
- data/sig/openai/models/graders/score_model_grader.rbs +130 -0
- data/sig/openai/models/graders/string_check_grader.rbs +57 -0
- data/sig/openai/models/graders/text_similarity_grader.rbs +73 -0
- data/sig/openai/models/image.rbs +31 -0
- data/sig/openai/models/image_create_variation_params.rbs +84 -0
- data/sig/openai/models/image_edit_params.rbs +152 -0
- data/sig/openai/models/image_generate_params.rbs +188 -0
- data/sig/openai/models/image_model.rbs +15 -0
- data/sig/openai/models/images_response.rbs +81 -0
- data/sig/openai/models/metadata.rbs +7 -0
- data/sig/openai/models/model.rbs +30 -0
- data/sig/openai/models/model_delete_params.rbs +14 -0
- data/sig/openai/models/model_deleted.rbs +17 -0
- data/sig/openai/models/model_list_params.rbs +14 -0
- data/sig/openai/models/model_retrieve_params.rbs +15 -0
- data/sig/openai/models/moderation.rbs +402 -0
- data/sig/openai/models/moderation_create_params.rbs +58 -0
- data/sig/openai/models/moderation_create_response.rbs +26 -0
- data/sig/openai/models/moderation_image_url_input.rbs +32 -0
- data/sig/openai/models/moderation_model.rbs +20 -0
- data/sig/openai/models/moderation_multi_modal_input.rbs +12 -0
- data/sig/openai/models/moderation_text_input.rbs +15 -0
- data/sig/openai/models/other_file_chunking_strategy_object.rbs +13 -0
- data/sig/openai/models/reasoning.rbs +54 -0
- data/sig/openai/models/reasoning_effort.rbs +15 -0
- data/sig/openai/models/response_format_json_object.rbs +13 -0
- data/sig/openai/models/response_format_json_schema.rbs +61 -0
- data/sig/openai/models/response_format_text.rbs +13 -0
- data/sig/openai/models/responses/computer_tool.rbs +51 -0
- data/sig/openai/models/responses/easy_input_message.rbs +69 -0
- data/sig/openai/models/responses/file_search_tool.rbs +95 -0
- data/sig/openai/models/responses/function_tool.rbs +42 -0
- data/sig/openai/models/responses/input_item_list_params.rbs +73 -0
- data/sig/openai/models/responses/response.rbs +217 -0
- data/sig/openai/models/responses/response_audio_delta_event.rbs +32 -0
- data/sig/openai/models/responses/response_audio_done_event.rbs +24 -0
- data/sig/openai/models/responses/response_audio_transcript_delta_event.rbs +32 -0
- data/sig/openai/models/responses/response_audio_transcript_done_event.rbs +24 -0
- data/sig/openai/models/responses/response_cancel_params.rbs +17 -0
- data/sig/openai/models/responses/response_code_interpreter_call_code_delta_event.rbs +37 -0
- data/sig/openai/models/responses/response_code_interpreter_call_code_done_event.rbs +37 -0
- data/sig/openai/models/responses/response_code_interpreter_call_completed_event.rbs +37 -0
- data/sig/openai/models/responses/response_code_interpreter_call_in_progress_event.rbs +37 -0
- data/sig/openai/models/responses/response_code_interpreter_call_interpreting_event.rbs +37 -0
- data/sig/openai/models/responses/response_code_interpreter_tool_call.rbs +117 -0
- data/sig/openai/models/responses/response_completed_event.rbs +32 -0
- data/sig/openai/models/responses/response_computer_tool_call.rbs +294 -0
- data/sig/openai/models/responses/response_computer_tool_call_output_item.rbs +82 -0
- data/sig/openai/models/responses/response_computer_tool_call_output_screenshot.rbs +32 -0
- data/sig/openai/models/responses/response_content.rbs +18 -0
- data/sig/openai/models/responses/response_content_part_added_event.rbs +57 -0
- data/sig/openai/models/responses/response_content_part_done_event.rbs +57 -0
- data/sig/openai/models/responses/response_create_params.rbs +174 -0
- data/sig/openai/models/responses/response_created_event.rbs +32 -0
- data/sig/openai/models/responses/response_delete_params.rbs +17 -0
- data/sig/openai/models/responses/response_error.rbs +72 -0
- data/sig/openai/models/responses/response_error_event.rbs +42 -0
- data/sig/openai/models/responses/response_failed_event.rbs +32 -0
- data/sig/openai/models/responses/response_file_search_call_completed_event.rbs +37 -0
- data/sig/openai/models/responses/response_file_search_call_in_progress_event.rbs +37 -0
- data/sig/openai/models/responses/response_file_search_call_searching_event.rbs +37 -0
- data/sig/openai/models/responses/response_file_search_tool_call.rbs +110 -0
- data/sig/openai/models/responses/response_format_text_config.rbs +16 -0
- data/sig/openai/models/responses/response_format_text_json_schema_config.rbs +44 -0
- data/sig/openai/models/responses/response_function_call_arguments_delta_event.rbs +42 -0
- data/sig/openai/models/responses/response_function_call_arguments_done_event.rbs +42 -0
- data/sig/openai/models/responses/response_function_tool_call.rbs +65 -0
- data/sig/openai/models/responses/response_function_tool_call_item.rbs +17 -0
- data/sig/openai/models/responses/response_function_tool_call_output_item.rbs +58 -0
- data/sig/openai/models/responses/response_function_web_search.rbs +45 -0
- data/sig/openai/models/responses/response_image_gen_call_completed_event.rbs +37 -0
- data/sig/openai/models/responses/response_image_gen_call_generating_event.rbs +37 -0
- data/sig/openai/models/responses/response_image_gen_call_in_progress_event.rbs +37 -0
- data/sig/openai/models/responses/response_image_gen_call_partial_image_event.rbs +47 -0
- data/sig/openai/models/responses/response_in_progress_event.rbs +32 -0
- data/sig/openai/models/responses/response_includable.rbs +22 -0
- data/sig/openai/models/responses/response_incomplete_event.rbs +32 -0
- data/sig/openai/models/responses/response_input.rbs +10 -0
- data/sig/openai/models/responses/response_input_audio.rbs +43 -0
- data/sig/openai/models/responses/response_input_content.rbs +16 -0
- data/sig/openai/models/responses/response_input_file.rbs +41 -0
- data/sig/openai/models/responses/response_input_image.rbs +49 -0
- data/sig/openai/models/responses/response_input_item.rbs +630 -0
- data/sig/openai/models/responses/response_input_message_content_list.rbs +10 -0
- data/sig/openai/models/responses/response_input_message_item.rbs +84 -0
- data/sig/openai/models/responses/response_input_text.rbs +17 -0
- data/sig/openai/models/responses/response_item.rbs +399 -0
- data/sig/openai/models/responses/response_item_list.rbs +44 -0
- data/sig/openai/models/responses/response_mcp_call_arguments_delta_event.rbs +42 -0
- data/sig/openai/models/responses/response_mcp_call_arguments_done_event.rbs +42 -0
- data/sig/openai/models/responses/response_mcp_call_completed_event.rbs +24 -0
- data/sig/openai/models/responses/response_mcp_call_failed_event.rbs +24 -0
- data/sig/openai/models/responses/response_mcp_call_in_progress_event.rbs +37 -0
- data/sig/openai/models/responses/response_mcp_list_tools_completed_event.rbs +24 -0
- data/sig/openai/models/responses/response_mcp_list_tools_failed_event.rbs +24 -0
- data/sig/openai/models/responses/response_mcp_list_tools_in_progress_event.rbs +27 -0
- data/sig/openai/models/responses/response_output_audio.rbs +28 -0
- data/sig/openai/models/responses/response_output_item.rbs +314 -0
- data/sig/openai/models/responses/response_output_item_added_event.rbs +37 -0
- data/sig/openai/models/responses/response_output_item_done_event.rbs +37 -0
- data/sig/openai/models/responses/response_output_message.rbs +64 -0
- data/sig/openai/models/responses/response_output_refusal.rbs +17 -0
- data/sig/openai/models/responses/response_output_text.rbs +125 -0
- data/sig/openai/models/responses/response_output_text_annotation_added_event.rbs +52 -0
- data/sig/openai/models/responses/response_queued_event.rbs +32 -0
- data/sig/openai/models/responses/response_reasoning_delta_event.rbs +47 -0
- data/sig/openai/models/responses/response_reasoning_done_event.rbs +47 -0
- data/sig/openai/models/responses/response_reasoning_item.rbs +70 -0
- data/sig/openai/models/responses/response_reasoning_summary_delta_event.rbs +47 -0
- data/sig/openai/models/responses/response_reasoning_summary_done_event.rbs +47 -0
- data/sig/openai/models/responses/response_reasoning_summary_part_added_event.rbs +59 -0
- data/sig/openai/models/responses/response_reasoning_summary_part_done_event.rbs +59 -0
- data/sig/openai/models/responses/response_reasoning_summary_text_delta_event.rbs +47 -0
- data/sig/openai/models/responses/response_reasoning_summary_text_done_event.rbs +47 -0
- data/sig/openai/models/responses/response_refusal_delta_event.rbs +47 -0
- data/sig/openai/models/responses/response_refusal_done_event.rbs +47 -0
- data/sig/openai/models/responses/response_retrieve_params.rbs +30 -0
- data/sig/openai/models/responses/response_status.rbs +21 -0
- data/sig/openai/models/responses/response_stream_event.rbs +66 -0
- data/sig/openai/models/responses/response_text_config.rbs +24 -0
- data/sig/openai/models/responses/response_text_delta_event.rbs +47 -0
- data/sig/openai/models/responses/response_text_done_event.rbs +47 -0
- data/sig/openai/models/responses/response_usage.rbs +62 -0
- data/sig/openai/models/responses/response_web_search_call_completed_event.rbs +37 -0
- data/sig/openai/models/responses/response_web_search_call_in_progress_event.rbs +37 -0
- data/sig/openai/models/responses/response_web_search_call_searching_event.rbs +37 -0
- data/sig/openai/models/responses/tool.rbs +400 -0
- data/sig/openai/models/responses/tool_choice_function.rbs +17 -0
- data/sig/openai/models/responses/tool_choice_options.rbs +17 -0
- data/sig/openai/models/responses/tool_choice_types.rbs +43 -0
- data/sig/openai/models/responses/web_search_tool.rbs +96 -0
- data/sig/openai/models/responses_model.rbs +31 -0
- data/sig/openai/models/static_file_chunking_strategy.rbs +22 -0
- data/sig/openai/models/static_file_chunking_strategy_object.rbs +22 -0
- data/sig/openai/models/static_file_chunking_strategy_object_param.rbs +22 -0
- data/sig/openai/models/upload.rbs +73 -0
- data/sig/openai/models/upload_cancel_params.rbs +15 -0
- data/sig/openai/models/upload_complete_params.rbs +30 -0
- data/sig/openai/models/upload_create_params.rbs +41 -0
- data/sig/openai/models/uploads/part_create_params.rbs +26 -0
- data/sig/openai/models/uploads/upload_part.rbs +39 -0
- data/sig/openai/models/vector_store.rbs +135 -0
- data/sig/openai/models/vector_store_create_params.rbs +70 -0
- data/sig/openai/models/vector_store_delete_params.rbs +15 -0
- data/sig/openai/models/vector_store_deleted.rbs +26 -0
- data/sig/openai/models/vector_store_list_params.rbs +62 -0
- data/sig/openai/models/vector_store_retrieve_params.rbs +15 -0
- data/sig/openai/models/vector_store_search_params.rbs +115 -0
- data/sig/openai/models/vector_store_search_response.rbs +80 -0
- data/sig/openai/models/vector_store_update_params.rbs +48 -0
- data/sig/openai/models/vector_stores/file_batch_cancel_params.rbs +25 -0
- data/sig/openai/models/vector_stores/file_batch_create_params.rbs +50 -0
- data/sig/openai/models/vector_stores/file_batch_list_files_params.rbs +91 -0
- data/sig/openai/models/vector_stores/file_batch_retrieve_params.rbs +25 -0
- data/sig/openai/models/vector_stores/file_content_params.rbs +25 -0
- data/sig/openai/models/vector_stores/file_content_response.rbs +21 -0
- data/sig/openai/models/vector_stores/file_create_params.rbs +50 -0
- data/sig/openai/models/vector_stores/file_delete_params.rbs +25 -0
- data/sig/openai/models/vector_stores/file_list_params.rbs +86 -0
- data/sig/openai/models/vector_stores/file_retrieve_params.rbs +25 -0
- data/sig/openai/models/vector_stores/file_update_params.rbs +41 -0
- data/sig/openai/models/vector_stores/vector_store_file.rbs +123 -0
- data/sig/openai/models/vector_stores/vector_store_file_batch.rbs +99 -0
- data/sig/openai/models/vector_stores/vector_store_file_deleted.rbs +30 -0
- data/sig/openai/models.rbs +195 -0
- data/sig/openai/request_options.rbs +34 -0
- data/sig/openai/resources/audio/speech.rbs +19 -0
- data/sig/openai/resources/audio/transcriptions.rbs +35 -0
- data/sig/openai/resources/audio/translations.rbs +18 -0
- data/sig/openai/resources/audio.rbs +13 -0
- data/sig/openai/resources/batches.rbs +31 -0
- data/sig/openai/resources/beta/assistants.rbs +58 -0
- data/sig/openai/resources/beta/threads/messages.rbs +49 -0
- data/sig/openai/resources/beta/threads/runs/steps.rbs +32 -0
- data/sig/openai/resources/beta/threads/runs.rbs +99 -0
- data/sig/openai/resources/beta/threads.rbs +75 -0
- data/sig/openai/resources/beta.rbs +11 -0
- data/sig/openai/resources/chat/completions/messages.rbs +19 -0
- data/sig/openai/resources/chat/completions.rbs +104 -0
- data/sig/openai/resources/chat.rbs +9 -0
- data/sig/openai/resources/completions.rbs +49 -0
- data/sig/openai/resources/containers/files/content.rbs +17 -0
- data/sig/openai/resources/containers/files.rbs +38 -0
- data/sig/openai/resources/containers.rbs +33 -0
- data/sig/openai/resources/embeddings.rbs +16 -0
- data/sig/openai/resources/evals/runs/output_items.rbs +28 -0
- data/sig/openai/resources/evals/runs.rbs +46 -0
- data/sig/openai/resources/evals.rbs +42 -0
- data/sig/openai/resources/files.rbs +36 -0
- data/sig/openai/resources/fine_tuning/alpha/graders.rbs +23 -0
- data/sig/openai/resources/fine_tuning/alpha.rbs +11 -0
- data/sig/openai/resources/fine_tuning/checkpoints/permissions.rbs +32 -0
- data/sig/openai/resources/fine_tuning/checkpoints.rbs +11 -0
- data/sig/openai/resources/fine_tuning/jobs/checkpoints.rbs +18 -0
- data/sig/openai/resources/fine_tuning/jobs.rbs +58 -0
- data/sig/openai/resources/fine_tuning/methods.rbs +9 -0
- data/sig/openai/resources/fine_tuning.rbs +15 -0
- data/sig/openai/resources/graders/grader_models.rbs +9 -0
- data/sig/openai/resources/graders.rbs +9 -0
- data/sig/openai/resources/images.rbs +47 -0
- data/sig/openai/resources/models.rbs +21 -0
- data/sig/openai/resources/moderations.rbs +13 -0
- data/sig/openai/resources/responses/input_items.rbs +19 -0
- data/sig/openai/resources/responses.rbs +71 -0
- data/sig/openai/resources/uploads/parts.rbs +15 -0
- data/sig/openai/resources/uploads.rbs +29 -0
- data/sig/openai/resources/vector_stores/file_batches.rbs +40 -0
- data/sig/openai/resources/vector_stores/files.rbs +52 -0
- data/sig/openai/resources/vector_stores.rbs +56 -0
- data/sig/openai/version.rbs +3 -0
- metadata +1498 -80
- data/.gitignore +0 -9
- data/.travis.yml +0 -6
- data/Gemfile +0 -4
- data/LICENSE.txt +0 -21
- data/Rakefile +0 -6
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/lib/openai/choice.rb +0 -3
- data/lib/openai/completion.rb +0 -7
- data/lib/openai/engine.rb +0 -3
- data/lib/openai/logprobs.rb +0 -3
- data/lib/openai/search_result.rb +0 -3
- data/openai.gemspec +0 -32
@@ -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::Models::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
|