openai 0.80.0 → 0.82.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +103 -0
- data/README.md +229 -2
- data/SECURITY.md +34 -5
- data/bedrock.md +1 -0
- data/examples/realtime/README.md +220 -0
- data/examples/realtime/function_calling.rb +158 -0
- data/examples/realtime/image_input.rb +105 -0
- data/examples/realtime/mcp_approval.rb +346 -0
- data/examples/realtime/sideband.rb +64 -0
- data/examples/realtime/websocket_text.rb +83 -0
- data/examples/realtime/websocket_transcription.rb +127 -0
- data/examples/realtime/websocket_voice_turn.rb +152 -0
- data/examples/x509_workload_identity.rb +81 -0
- data/lib/openai/auth/subject_token_providers/azure_managed_identity_token_provider.rb +27 -19
- data/lib/openai/auth/subject_token_providers/gcp_id_token_provider.rb +21 -16
- data/lib/openai/auth/subject_token_providers/k8s_service_account_token_provider.rb +12 -8
- data/lib/openai/auth/workload_identity.rb +8 -5
- data/lib/openai/auth/workload_identity_auth.rb +278 -60
- data/lib/openai/auth/x509_token_exchange.rb +184 -0
- data/lib/openai/auth/x509_transport.rb +318 -0
- data/lib/openai/auth/x509_workload_identity.rb +85 -0
- data/lib/openai/client.rb +444 -31
- data/lib/openai/errors.rb +279 -23
- data/lib/openai/file_part.rb +79 -12
- data/lib/openai/helpers/client_options.rb +87 -0
- data/lib/openai/helpers/data_residency.rb +38 -0
- data/lib/openai/helpers/realtime/client_extension.rb +186 -0
- data/lib/openai/helpers/realtime/connection.rb +199 -0
- data/lib/openai/helpers/realtime/connection_manager.rb +107 -0
- data/lib/openai/helpers/realtime/connection_resources.rb +130 -0
- data/lib/openai/helpers/realtime/conversation_item_variant_resolver.rb +40 -0
- data/lib/openai/helpers/realtime/errors.rb +73 -0
- data/lib/openai/helpers/realtime/resources/realtime_extension.rb +84 -0
- data/lib/openai/helpers/realtime/sideband_connection.rb +17 -0
- data/lib/openai/helpers/realtime/transports/async_websocket.rb +388 -0
- data/lib/openai/helpers/realtime/unknown_server_event.rb +44 -0
- data/lib/openai/helpers/realtime.rb +15 -0
- data/lib/openai/helpers/resource_polling.rb +154 -0
- data/lib/openai/helpers/sorbet.rb +324 -0
- data/lib/openai/helpers/streaming/chat_completion_stream.rb +191 -83
- data/lib/openai/helpers/streaming/chat_events.rb +6 -3
- data/lib/openai/helpers/streaming/exceptions.rb +2 -1
- data/lib/openai/helpers/streaming/response_event_decoder.rb +44 -0
- data/lib/openai/helpers/streaming/response_stream.rb +49 -36
- data/lib/openai/helpers/streaming/unknown_stream_event.rb +51 -0
- data/lib/openai/helpers/structured_output/base_model.rb +1 -3
- data/lib/openai/helpers/structured_output/chat_completion_parser.rb +132 -0
- data/lib/openai/helpers/structured_output/enum_of.rb +14 -13
- data/lib/openai/helpers/structured_output/json_schema_converter.rb +19 -12
- data/lib/openai/helpers/structured_output/response_parser.rb +145 -0
- data/lib/openai/helpers/structured_output/union_of.rb +1 -0
- data/lib/openai/http_client.rb +15 -3
- data/lib/openai/internal/conversation_cursor_page.rb +2 -2
- data/lib/openai/internal/cursor_page.rb +1 -0
- data/lib/openai/internal/logging.rb +140 -50
- data/lib/openai/internal/next_cursor_page.rb +2 -2
- data/lib/openai/internal/page.rb +2 -1
- data/lib/openai/internal/poller.rb +175 -0
- data/lib/openai/internal/read_io_adapter.rb +28 -24
- data/lib/openai/internal/request_options_scope.rb +60 -0
- data/lib/openai/internal/stream.rb +16 -10
- data/lib/openai/internal/transport/base_client.rb +236 -89
- data/lib/openai/internal/type/array_of.rb +33 -15
- data/lib/openai/internal/type/base_model.rb +62 -49
- data/lib/openai/internal/type/base_page.rb +12 -1
- data/lib/openai/internal/type/base_stream.rb +12 -10
- data/lib/openai/internal/type/converter.rb +28 -1
- data/lib/openai/internal/type/enum.rb +1 -1
- data/lib/openai/internal/type/hash_of.rb +27 -20
- data/lib/openai/internal/type/union.rb +14 -12
- data/lib/openai/internal/util.rb +52 -28
- data/lib/openai/internal/vector_store_file_uploader.rb +225 -0
- data/lib/openai/internal.rb +5 -3
- data/lib/openai/models/admin/organization/admin_api_key_create_response.rb +17 -1
- data/lib/openai/models/admin/organization/audit_log_list_params.rb +6 -4
- data/lib/openai/models/admin/organization/audit_log_list_response.rb +355 -217
- data/lib/openai/models/admin/organization/certificate_activate_response.rb +4 -2
- data/lib/openai/models/admin/organization/certificate_deactivate_response.rb +4 -2
- data/lib/openai/models/admin/organization/certificate_list_response.rb +4 -2
- data/lib/openai/models/admin/organization/certificate_retrieve_params.rb +6 -2
- data/lib/openai/models/admin/organization/cost_quantity_unit.rb +53 -0
- data/lib/openai/models/admin/organization/data_retention_update_params.rb +4 -2
- data/lib/openai/models/admin/organization/groups/role_list_response.rb +14 -10
- data/lib/openai/models/admin/organization/groups/role_retrieve_response.rb +14 -10
- data/lib/openai/models/admin/organization/groups/user_retrieve_response.rb +4 -2
- data/lib/openai/models/admin/organization/invite_create_params.rb +4 -2
- data/lib/openai/models/admin/organization/organization_spend_alert.rb +4 -2
- data/lib/openai/models/admin/organization/organization_spend_limit.rb +19 -5
- data/lib/openai/models/admin/organization/organization_user.rb +4 -2
- data/lib/openai/models/admin/organization/project.rb +9 -1
- data/lib/openai/models/admin/organization/project_create_params.rb +17 -2
- data/lib/openai/models/admin/organization/project_residency.rb +29 -0
- data/lib/openai/models/admin/organization/project_update_params.rb +7 -1
- data/lib/openai/models/admin/organization/projects/api_key_list_params.rb +4 -2
- data/lib/openai/models/admin/organization/projects/certificate_activate_response.rb +4 -2
- data/lib/openai/models/admin/organization/projects/certificate_deactivate_response.rb +4 -2
- data/lib/openai/models/admin/organization/projects/certificate_list_response.rb +4 -2
- data/lib/openai/models/admin/organization/projects/data_retention_update_params.rb +4 -2
- data/lib/openai/models/admin/organization/projects/groups/role_list_response.rb +14 -11
- data/lib/openai/models/admin/organization/projects/groups/role_retrieve_response.rb +14 -11
- data/lib/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rb +33 -23
- data/lib/openai/models/admin/organization/projects/project_api_key.rb +8 -4
- data/lib/openai/models/admin/organization/projects/project_hosted_tool_permissions.rb +16 -8
- data/lib/openai/models/admin/organization/projects/project_spend_alert.rb +4 -2
- data/lib/openai/models/admin/organization/projects/project_spend_limit.rb +26 -7
- data/lib/openai/models/admin/organization/projects/service_account_create_response.rb +9 -7
- data/lib/openai/models/admin/organization/projects/spend_alert_create_params.rb +4 -2
- data/lib/openai/models/admin/organization/projects/spend_alert_update_params.rb +4 -2
- data/lib/openai/models/admin/organization/projects/users/role_list_response.rb +14 -11
- data/lib/openai/models/admin/organization/projects/users/role_retrieve_response.rb +14 -11
- data/lib/openai/models/admin/organization/spend_alert_create_params.rb +4 -2
- data/lib/openai/models/admin/organization/spend_alert_update_params.rb +4 -2
- data/lib/openai/models/admin/organization/usage_audio_speeches_params.rb +6 -2
- data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +102 -29
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_params.rb +12 -4
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +104 -29
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_params.rb +12 -4
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +104 -29
- data/lib/openai/models/admin/organization/usage_completions_params.rb +4 -2
- data/lib/openai/models/admin/organization/usage_completions_response.rb +100 -29
- data/lib/openai/models/admin/organization/usage_costs_params.rb +4 -2
- data/lib/openai/models/admin/organization/usage_costs_response.rb +98 -29
- data/lib/openai/models/admin/organization/usage_embeddings_params.rb +4 -2
- data/lib/openai/models/admin/organization/usage_embeddings_response.rb +100 -29
- data/lib/openai/models/admin/organization/usage_file_search_calls_params.rb +6 -2
- data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +102 -29
- data/lib/openai/models/admin/organization/usage_images_params.rb +12 -6
- data/lib/openai/models/admin/organization/usage_images_response.rb +98 -29
- data/lib/openai/models/admin/organization/usage_moderations_params.rb +4 -2
- data/lib/openai/models/admin/organization/usage_moderations_response.rb +100 -29
- data/lib/openai/models/admin/organization/usage_vector_stores_params.rb +4 -2
- data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +102 -29
- data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +14 -4
- data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +102 -29
- data/lib/openai/models/admin/organization/users/role_list_response.rb +14 -10
- data/lib/openai/models/admin/organization/users/role_retrieve_response.rb +14 -10
- data/lib/openai/models/audio/transcription_create_params.rb +9 -5
- data/lib/openai/models/audio/transcription_diarized.rb +4 -2
- data/lib/openai/models/audio/transcription_text_delta_event.rb +4 -2
- data/lib/openai/models/audio/transcription_text_done_event.rb +4 -2
- data/lib/openai/models/beta/assistant_create_params.rb +33 -11
- data/lib/openai/models/beta/beta_apply_patch_tool.rb +7 -5
- data/lib/openai/models/beta/beta_container_network_policy_allowlist.rb +4 -2
- data/lib/openai/models/beta/beta_custom_tool.rb +5 -3
- data/lib/openai/models/beta/beta_file_search_tool.rb +37 -15
- data/lib/openai/models/beta/beta_function_shell_tool.rb +7 -5
- data/lib/openai/models/beta/beta_function_tool.rb +5 -3
- data/lib/openai/models/beta/beta_namespace_tool.rb +12 -8
- data/lib/openai/models/beta/beta_response.rb +33 -20
- data/lib/openai/models/beta/beta_response_apply_patch_tool_call.rb +6 -4
- data/lib/openai/models/beta/beta_response_apply_patch_tool_call_output.rb +6 -4
- data/lib/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rb +7 -5
- data/lib/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rb +7 -5
- data/lib/openai/models/beta/beta_response_code_interpreter_tool_call.rb +7 -5
- data/lib/openai/models/beta/beta_response_computer_tool_call.rb +4 -2
- data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +8 -2
- data/lib/openai/models/beta/beta_response_custom_tool_call.rb +6 -4
- data/lib/openai/models/beta/beta_response_custom_tool_call_item.rb +15 -1
- data/lib/openai/models/beta/beta_response_custom_tool_call_output.rb +10 -7
- data/lib/openai/models/beta/beta_response_custom_tool_call_output_item.rb +11 -1
- data/lib/openai/models/beta/beta_response_file_search_tool_call.rb +12 -8
- data/lib/openai/models/beta/beta_response_function_call_output_item_list.rb +3 -2
- data/lib/openai/models/beta/beta_response_function_shell_tool_call.rb +11 -7
- data/lib/openai/models/beta/beta_response_function_shell_tool_call_output.rb +10 -6
- data/lib/openai/models/beta/beta_response_function_tool_call.rb +6 -4
- data/lib/openai/models/beta/beta_response_function_tool_call_item.rb +15 -1
- data/lib/openai/models/beta/beta_response_function_tool_call_output_item.rb +19 -16
- data/lib/openai/models/beta/beta_response_function_web_search.rb +6 -2
- data/lib/openai/models/beta/beta_response_image_gen_call_partial_image_event.rb +33 -1
- data/lib/openai/models/beta/beta_response_input_audio.rb +5 -3
- data/lib/openai/models/beta/beta_response_input_file_content.rb +5 -3
- data/lib/openai/models/beta/beta_response_input_image_content.rb +5 -3
- data/lib/openai/models/beta/beta_response_input_item.rb +129 -79
- data/lib/openai/models/beta/beta_response_input_message_content_list.rb +3 -2
- data/lib/openai/models/beta/beta_response_input_text_content.rb +5 -3
- data/lib/openai/models/beta/beta_response_item.rb +27 -15
- data/lib/openai/models/beta/beta_response_output_item.rb +38 -20
- data/lib/openai/models/beta/beta_response_output_message.rb +4 -2
- data/lib/openai/models/beta/beta_response_output_text.rb +12 -6
- data/lib/openai/models/beta/beta_response_output_text_annotation_added_event.rb +17 -9
- data/lib/openai/models/beta/beta_response_prompt.rb +5 -3
- data/lib/openai/models/beta/beta_response_reasoning_item.rb +8 -4
- data/lib/openai/models/beta/beta_response_shell_call_command_added_event.rb +76 -0
- data/lib/openai/models/beta/beta_response_shell_call_command_delta_event.rb +84 -0
- data/lib/openai/models/beta/beta_response_shell_call_command_done_event.rb +76 -0
- data/lib/openai/models/beta/beta_response_shell_call_output_content_delta_event.rb +106 -0
- data/lib/openai/models/beta/beta_response_shell_call_output_content_done_event.rb +188 -0
- data/lib/openai/models/beta/beta_response_stream_event.rb +122 -51
- data/lib/openai/models/beta/beta_response_text_delta_event.rb +8 -4
- data/lib/openai/models/beta/beta_response_text_done_event.rb +8 -4
- data/lib/openai/models/beta/beta_responses_client_event.rb +386 -156
- data/lib/openai/models/beta/beta_responses_server_event.rb +1004 -144
- data/lib/openai/models/beta/beta_tool.rb +51 -45
- data/lib/openai/models/beta/beta_tool_choice_allowed.rb +4 -2
- data/lib/openai/models/beta/beta_web_search_preview_tool.rb +4 -2
- data/lib/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rb +4 -2
- data/lib/openai/models/beta/chatkit/chat_session_workflow_param.rb +6 -2
- data/lib/openai/models/beta/chatkit/chatkit_response_output_text.rb +4 -2
- data/lib/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rb +4 -2
- data/lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb +28 -12
- data/lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb +14 -8
- data/lib/openai/models/beta/chatkit_workflow.rb +5 -3
- data/lib/openai/models/beta/response_compact_params.rb +21 -12
- data/lib/openai/models/beta/response_create_params.rb +32 -20
- data/lib/openai/models/beta/responses/input_item_list_params.rb +4 -2
- data/lib/openai/models/beta/responses/input_token_count_params.rb +50 -27
- data/lib/openai/models/beta/thread_create_and_run_params.rb +87 -40
- data/lib/openai/models/beta/thread_create_params.rb +49 -20
- data/lib/openai/models/beta/threads/message.rb +9 -5
- data/lib/openai/models/beta/threads/message_create_params.rb +16 -9
- data/lib/openai/models/beta/threads/message_delta.rb +4 -2
- data/lib/openai/models/beta/threads/run.rb +4 -2
- data/lib/openai/models/beta/threads/run_create_params.rb +50 -27
- data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +4 -2
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +20 -7
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +12 -4
- data/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +26 -10
- data/lib/openai/models/beta/threads/runs/message_creation_step_details.rb +4 -2
- data/lib/openai/models/beta/threads/runs/run_step_include.rb +1 -2
- data/lib/openai/models/beta/threads/runs/step_list_params.rb +4 -2
- data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +4 -2
- data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb +4 -2
- data/lib/openai/models/beta/threads/text_delta.rb +4 -2
- data/lib/openai/models/chat/chat_completion.rb +60 -25
- data/lib/openai/models/chat/chat_completion_allowed_tools.rb +4 -2
- data/lib/openai/models/chat/chat_completion_assistant_message_param.rb +20 -13
- data/lib/openai/models/chat/chat_completion_chunk.rb +76 -38
- data/lib/openai/models/chat/chat_completion_content_part.rb +4 -2
- data/lib/openai/models/chat/chat_completion_content_part_image.rb +4 -2
- data/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +9 -5
- data/lib/openai/models/chat/chat_completion_content_part_text.rb +4 -2
- data/lib/openai/models/chat/chat_completion_custom_tool.rb +11 -7
- data/lib/openai/models/chat/chat_completion_developer_message_param.rb +8 -3
- data/lib/openai/models/chat/chat_completion_message.rb +8 -4
- data/lib/openai/models/chat/chat_completion_prediction_content.rb +6 -3
- data/lib/openai/models/chat/chat_completion_store_message.rb +22 -6
- data/lib/openai/models/chat/chat_completion_system_message_param.rb +6 -3
- data/lib/openai/models/chat/chat_completion_token_logprob.rb +4 -2
- data/lib/openai/models/chat/chat_completion_tool_message_param.rb +6 -3
- data/lib/openai/models/chat/chat_completion_user_message_param.rb +3 -2
- data/lib/openai/models/chat/completion_create_params.rb +56 -33
- data/lib/openai/models/comparison_filter.rb +3 -2
- data/lib/openai/models/conversations/computer_screenshot_content.rb +4 -2
- data/lib/openai/models/conversations/conversation_create_params.rb +5 -3
- data/lib/openai/models/conversations/conversation_item.rb +9 -5
- data/lib/openai/models/eval_create_params.rb +69 -13
- data/lib/openai/models/eval_create_response.rb +45 -5
- data/lib/openai/models/eval_list_response.rb +45 -5
- data/lib/openai/models/eval_retrieve_response.rb +45 -5
- data/lib/openai/models/eval_update_response.rb +45 -5
- data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +59 -19
- data/lib/openai/models/evals/create_eval_jsonl_run_data_source.rb +8 -2
- data/lib/openai/models/evals/run_cancel_response.rb +97 -37
- data/lib/openai/models/evals/run_create_params.rb +109 -43
- data/lib/openai/models/evals/run_create_response.rb +97 -37
- data/lib/openai/models/evals/run_list_response.rb +97 -36
- data/lib/openai/models/evals/run_retrieve_response.rb +101 -42
- data/lib/openai/models/evals/runs/output_item_list_response.rb +16 -6
- data/lib/openai/models/evals/runs/output_item_retrieve_response.rb +16 -6
- data/lib/openai/models/fine_tuning/alpha/grader_run_response.rb +4 -2
- data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rb +6 -2
- data/lib/openai/models/fine_tuning/dpo_hyperparameters.rb +4 -2
- data/lib/openai/models/fine_tuning/fine_tuning_job.rb +16 -10
- data/lib/openai/models/fine_tuning/job_create_params.rb +9 -5
- data/lib/openai/models/fine_tuning/reinforcement_hyperparameters.rb +8 -4
- data/lib/openai/models/fine_tuning/supervised_hyperparameters.rb +4 -2
- data/lib/openai/models/image_edit_params.rb +12 -22
- data/lib/openai/models/image_generate_params.rb +12 -22
- data/lib/openai/models/moderation.rb +76 -50
- data/lib/openai/models/moderation_create_params.rb +3 -2
- data/lib/openai/models/realtime/call_accept_params.rb +33 -1
- data/lib/openai/models/realtime/call_create_params.rb +32 -0
- data/lib/openai/models/realtime/conversation_item_input_audio_transcription_completed_event.rb +25 -9
- data/lib/openai/models/realtime/conversation_item_input_audio_transcription_delta_event.rb +5 -3
- data/lib/openai/models/realtime/conversation_item_with_reference.rb +4 -2
- data/lib/openai/models/realtime/rate_limits_updated_event.rb +4 -2
- data/lib/openai/models/realtime/realtime_audio_input_turn_detection.rb +4 -2
- data/lib/openai/models/realtime/realtime_conversation_item_assistant_message.rb +4 -2
- data/lib/openai/models/realtime/realtime_conversation_item_system_message.rb +4 -2
- data/lib/openai/models/realtime/realtime_conversation_item_user_message.rb +4 -2
- data/lib/openai/models/realtime/realtime_response.rb +4 -2
- data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +25 -15
- data/lib/openai/models/realtime/realtime_response_create_params.rb +8 -4
- data/lib/openai/models/realtime/realtime_response_usage_input_token_details.rb +4 -2
- data/lib/openai/models/realtime/realtime_server_event.rb +52 -26
- data/lib/openai/models/realtime/realtime_session.rb +16 -8
- data/lib/openai/models/realtime/realtime_session_create_request.rb +47 -17
- data/lib/openai/models/realtime/realtime_session_create_response.rb +161 -67
- data/lib/openai/models/realtime/realtime_tools_config.rb +1 -2
- data/lib/openai/models/realtime/realtime_tools_config_union.rb +28 -16
- data/lib/openai/models/realtime/realtime_transcription_session_audio_input.rb +5 -3
- data/lib/openai/models/realtime/realtime_transcription_session_audio_input_turn_detection.rb +12 -6
- data/lib/openai/models/realtime/realtime_transcription_session_create_request.rb +6 -2
- data/lib/openai/models/realtime/realtime_transcription_session_create_response.rb +17 -9
- data/lib/openai/models/realtime/realtime_translation_client_event.rb +4 -2
- data/lib/openai/models/realtime/realtime_translation_client_secret_create_request.rb +8 -4
- data/lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb +8 -5
- data/lib/openai/models/realtime/realtime_translation_server_event.rb +12 -7
- data/lib/openai/models/realtime/realtime_translation_session.rb +10 -6
- data/lib/openai/models/realtime/realtime_translation_session_create_request.rb +14 -10
- data/lib/openai/models/realtime/realtime_translation_session_update_request.rb +14 -10
- data/lib/openai/models/realtime/transcription_session_update.rb +14 -6
- data/lib/openai/models/realtime/transcription_session_updated_event.rb +12 -4
- data/lib/openai/models/response_format_json_schema.rb +9 -7
- data/lib/openai/models/responses/apply_patch_tool.rb +7 -5
- data/lib/openai/models/responses/container_network_policy_allowlist.rb +4 -2
- data/lib/openai/models/responses/custom_tool.rb +5 -3
- data/lib/openai/models/responses/function_shell_tool.rb +7 -5
- data/lib/openai/models/responses/function_tool.rb +13 -9
- data/lib/openai/models/responses/input_token_count_params.rb +15 -12
- data/lib/openai/models/responses/namespace_tool.rb +12 -8
- data/lib/openai/models/responses/response.rb +26 -17
- data/lib/openai/models/responses/response_apply_patch_tool_call.rb +6 -4
- data/lib/openai/models/responses/response_apply_patch_tool_call_output.rb +6 -4
- data/lib/openai/models/responses/response_code_interpreter_tool_call.rb +7 -5
- data/lib/openai/models/responses/response_compact_params.rb +37 -16
- data/lib/openai/models/responses/response_computer_tool_call.rb +8 -4
- data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +8 -2
- data/lib/openai/models/responses/response_create_params.rb +47 -33
- data/lib/openai/models/responses/response_custom_tool_call.rb +6 -4
- data/lib/openai/models/responses/response_custom_tool_call_item.rb +13 -1
- data/lib/openai/models/responses/response_custom_tool_call_output.rb +10 -7
- data/lib/openai/models/responses/response_custom_tool_call_output_item.rb +9 -1
- data/lib/openai/models/responses/response_file_search_tool_call.rb +14 -10
- data/lib/openai/models/responses/response_format_text_json_schema_config.rb +9 -6
- data/lib/openai/models/responses/response_function_call_output_item_list.rb +3 -2
- data/lib/openai/models/responses/response_function_shell_tool_call.rb +11 -7
- data/lib/openai/models/responses/response_function_shell_tool_call_output.rb +10 -6
- data/lib/openai/models/responses/response_function_tool_call.rb +6 -4
- data/lib/openai/models/responses/response_function_tool_call_item.rb +13 -1
- data/lib/openai/models/responses/response_function_tool_call_output_item.rb +19 -16
- data/lib/openai/models/responses/response_function_web_search.rb +6 -2
- data/lib/openai/models/responses/response_image_gen_call_partial_image_event.rb +33 -1
- data/lib/openai/models/responses/response_input_audio.rb +5 -3
- data/lib/openai/models/responses/response_input_file_content.rb +5 -3
- data/lib/openai/models/responses/response_input_image_content.rb +5 -3
- data/lib/openai/models/responses/response_input_item.rb +90 -60
- data/lib/openai/models/responses/response_input_message_content_list.rb +3 -2
- data/lib/openai/models/responses/response_input_text_content.rb +5 -3
- data/lib/openai/models/responses/response_item.rb +11 -7
- data/lib/openai/models/responses/response_output_item.rb +9 -5
- data/lib/openai/models/responses/response_output_message.rb +4 -2
- data/lib/openai/models/responses/response_output_text.rb +12 -6
- data/lib/openai/models/responses/response_output_text_annotation_added_event.rb +17 -9
- data/lib/openai/models/responses/response_prompt.rb +5 -3
- data/lib/openai/models/responses/response_reasoning_item.rb +8 -4
- data/lib/openai/models/responses/response_shell_call_command_added_event.rb +52 -0
- data/lib/openai/models/responses/response_shell_call_command_delta_event.rb +60 -0
- data/lib/openai/models/responses/response_shell_call_command_done_event.rb +52 -0
- data/lib/openai/models/responses/response_shell_call_output_content_delta_event.rb +82 -0
- data/lib/openai/models/responses/response_shell_call_output_content_done_event.rb +164 -0
- data/lib/openai/models/responses/response_stream_event.rb +122 -51
- data/lib/openai/models/responses/response_text_delta_event.rb +8 -4
- data/lib/openai/models/responses/response_text_done_event.rb +8 -4
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +7 -5
- data/lib/openai/models/responses/responses_client_event.rb +38 -26
- data/lib/openai/models/responses/responses_server_event.rb +871 -133
- data/lib/openai/models/responses/tool.rb +51 -45
- data/lib/openai/models/responses/tool_choice_allowed.rb +4 -2
- data/lib/openai/models/responses/web_search_preview_tool.rb +4 -2
- data/lib/openai/models/vector_store_search_response.rb +9 -7
- data/lib/openai/models/vector_stores/file_batch_create_params.rb +14 -10
- data/lib/openai/models/vector_stores/file_create_params.rb +7 -5
- data/lib/openai/models/vector_stores/file_update_params.rb +7 -5
- data/lib/openai/models/vector_stores/vector_store_file.rb +7 -5
- data/lib/openai/models/webhooks/live_call_incoming_webhook_event.rb +4 -2
- data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb +4 -2
- data/lib/openai/models.rb +12 -12
- data/lib/openai/net_http_client.rb +90 -38
- data/lib/openai/providers/azure.rb +61 -48
- data/lib/openai/providers/bedrock.rb +126 -96
- data/lib/openai/resources/admin/organization/groups/roles.rb +8 -8
- data/lib/openai/resources/admin/organization/groups/users.rb +8 -8
- data/lib/openai/resources/admin/organization/projects/api_keys.rb +8 -8
- data/lib/openai/resources/admin/organization/projects/groups/roles.rb +24 -24
- data/lib/openai/resources/admin/organization/projects/groups.rb +8 -8
- data/lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb +3 -2
- data/lib/openai/resources/admin/organization/projects/rate_limits.rb +10 -8
- data/lib/openai/resources/admin/organization/projects/roles.rb +12 -12
- data/lib/openai/resources/admin/organization/projects/service_accounts/api_keys.rb +6 -6
- data/lib/openai/resources/admin/organization/projects/service_accounts.rb +14 -16
- data/lib/openai/resources/admin/organization/projects/spend_alerts.rb +12 -12
- data/lib/openai/resources/admin/organization/projects/users/roles.rb +24 -24
- data/lib/openai/resources/admin/organization/projects/users.rb +12 -12
- data/lib/openai/resources/admin/organization/projects.rb +12 -9
- data/lib/openai/resources/admin/organization/users/roles.rb +8 -8
- data/lib/openai/resources/audio/transcriptions.rb +2 -0
- data/lib/openai/resources/beta/responses.rb +6 -2
- data/lib/openai/resources/beta/threads/messages.rb +12 -12
- data/lib/openai/resources/beta/threads/runs/steps.rb +12 -12
- data/lib/openai/resources/beta/threads/runs.rb +24 -20
- data/lib/openai/resources/beta/threads.rb +2 -0
- data/lib/openai/resources/chat/completions.rb +6 -97
- data/lib/openai/resources/completions.rb +2 -0
- data/lib/openai/resources/containers/files/content.rb +4 -4
- data/lib/openai/resources/containers/files.rb +8 -8
- data/lib/openai/resources/conversations/items.rb +8 -8
- data/lib/openai/resources/evals/runs/output_items.rb +12 -12
- data/lib/openai/resources/evals/runs.rb +12 -12
- data/lib/openai/resources/files.rb +39 -0
- data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb +4 -4
- data/lib/openai/resources/images.rb +4 -0
- data/lib/openai/resources/realtime/calls.rb +54 -0
- data/lib/openai/resources/responses.rb +14 -140
- data/lib/openai/resources/skills/versions/content.rb +4 -4
- data/lib/openai/resources/skills/versions.rb +8 -8
- data/lib/openai/resources/vector_stores/file_batches.rb +197 -13
- data/lib/openai/resources/vector_stores/files.rb +211 -17
- data/lib/openai/resources/webhooks.rb +12 -15
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +24 -4
- data/manifest.yaml +0 -2
- data/rbi/openai/auth/x509_token_exchange.rbi +29 -0
- data/rbi/openai/auth/x509_transport.rbi +57 -0
- data/rbi/openai/auth/x509_workload_identity.rbi +45 -0
- data/rbi/openai/auth.rbi +24 -1
- data/rbi/openai/client.rbi +107 -2
- data/rbi/openai/errors.rbi +35 -6
- data/rbi/openai/file_part.rbi +33 -1
- data/rbi/openai/helpers/client_options.rbi +33 -0
- data/rbi/openai/helpers/data_residency.rbi +25 -0
- data/rbi/openai/helpers/realtime/connection.rbi +93 -0
- data/rbi/openai/helpers/realtime/connection_manager.rbi +46 -0
- data/rbi/openai/helpers/realtime/connection_resources.rbi +109 -0
- data/rbi/openai/helpers/realtime/extensions.rbi +169 -0
- data/rbi/openai/helpers/realtime/sideband_connection.rbi +24 -0
- data/rbi/openai/helpers/realtime/transports/async_websocket.rbi +70 -0
- data/rbi/openai/helpers/realtime/unknown_server_event.rbi +26 -0
- data/rbi/openai/helpers/resource_polling.rbi +63 -0
- data/rbi/openai/helpers/sorbet.rbi +55 -0
- data/rbi/openai/helpers/streaming/response_event_decoder.rbi +28 -0
- data/rbi/openai/helpers/streaming/response_stream.rbi +24 -17
- data/rbi/openai/helpers/streaming/unknown_stream_event.rbi +29 -0
- data/rbi/openai/helpers/structured_output/chat_completion_parser.rbi +42 -0
- data/rbi/openai/helpers/structured_output/enum_of.rbi +3 -1
- data/rbi/openai/helpers/structured_output/json_schema_converter.rbi +27 -27
- data/rbi/openai/helpers/structured_output/response_parser.rbi +33 -0
- data/rbi/openai/helpers/structured_output/union_of.rbi +3 -3
- data/rbi/openai/http_client.rbi +6 -3
- data/rbi/openai/internal/logging.rbi +15 -8
- data/rbi/openai/internal/poller.rbi +55 -0
- data/rbi/openai/internal/provider.rbi +3 -6
- data/rbi/openai/internal/read_io_adapter.rbi +4 -2
- data/rbi/openai/internal/request_options_scope.rbi +21 -0
- data/rbi/openai/internal/stream.rbi +1 -2
- data/rbi/openai/internal/transport/base_client.rbi +161 -137
- data/rbi/openai/internal/type/array_of.rbi +14 -14
- data/rbi/openai/internal/type/base_model.rbi +61 -65
- data/rbi/openai/internal/type/base_page.rbi +2 -1
- data/rbi/openai/internal/type/base_stream.rbi +11 -11
- data/rbi/openai/internal/type/converter.rbi +83 -81
- data/rbi/openai/internal/type/hash_of.rbi +14 -14
- data/rbi/openai/internal/type/union.rbi +13 -14
- data/rbi/openai/internal/util.rbi +73 -72
- data/rbi/openai/internal/vector_store_file_uploader.rbi +31 -0
- data/rbi/openai/internal.rbi +1 -2
- data/rbi/openai/models/admin/organization/admin_api_key.rbi +57 -29
- data/rbi/openai/models/admin/organization/admin_api_key_create_params.rbi +23 -13
- data/rbi/openai/models/admin/organization/admin_api_key_create_response.rbi +78 -10
- data/rbi/openai/models/admin/organization/admin_api_key_delete_params.rbi +21 -9
- data/rbi/openai/models/admin/organization/admin_api_key_delete_response.rbi +26 -10
- data/rbi/openai/models/admin/organization/admin_api_key_list_params.rbi +33 -50
- data/rbi/openai/models/admin/organization/admin_api_key_retrieve_params.rbi +21 -9
- data/rbi/openai/models/admin/organization/audit_log_list_params.rbi +648 -793
- data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +3003 -2915
- data/rbi/openai/models/admin/organization/certificate.rbi +66 -67
- data/rbi/openai/models/admin/organization/certificate_activate_params.rbi +25 -13
- data/rbi/openai/models/admin/organization/certificate_activate_response.rbi +58 -32
- data/rbi/openai/models/admin/organization/certificate_create_params.rbi +23 -13
- data/rbi/openai/models/admin/organization/certificate_deactivate_params.rbi +25 -13
- data/rbi/openai/models/admin/organization/certificate_deactivate_response.rbi +58 -32
- data/rbi/openai/models/admin/organization/certificate_delete_params.rbi +25 -13
- data/rbi/openai/models/admin/organization/certificate_delete_response.rbi +31 -9
- data/rbi/openai/models/admin/organization/certificate_list_params.rbi +33 -50
- data/rbi/openai/models/admin/organization/certificate_list_response.rbi +58 -32
- data/rbi/openai/models/admin/organization/certificate_retrieve_params.rbi +38 -53
- data/rbi/openai/models/admin/organization/certificate_update_params.rbi +23 -13
- data/rbi/openai/models/admin/organization/cost_quantity_unit.rbi +51 -0
- data/rbi/openai/models/admin/organization/data_retention_retrieve_params.rbi +15 -8
- data/rbi/openai/models/admin/organization/data_retention_update_params.rbi +45 -49
- data/rbi/openai/models/admin/organization/group.rbi +35 -37
- data/rbi/openai/models/admin/organization/group_create_params.rbi +21 -9
- data/rbi/openai/models/admin/organization/group_delete_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/group_delete_response.rbi +27 -10
- data/rbi/openai/models/admin/organization/group_list_params.rbi +33 -50
- data/rbi/openai/models/admin/organization/group_retrieve_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/group_update_params.rbi +23 -13
- data/rbi/openai/models/admin/organization/group_update_response.rbi +26 -14
- data/rbi/openai/models/admin/organization/groups/organization_group_user.rbi +26 -9
- data/rbi/openai/models/admin/organization/groups/role_create_params.rbi +25 -13
- data/rbi/openai/models/admin/organization/groups/role_create_response.rbi +49 -37
- data/rbi/openai/models/admin/organization/groups/role_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/groups/role_delete_response.rbi +30 -10
- data/rbi/openai/models/admin/organization/groups/role_list_params.rbi +39 -50
- data/rbi/openai/models/admin/organization/groups/role_list_response.rbi +72 -38
- data/rbi/openai/models/admin/organization/groups/role_retrieve_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/groups/role_retrieve_response.rbi +72 -38
- data/rbi/openai/models/admin/organization/groups/user_create_params.rbi +25 -13
- data/rbi/openai/models/admin/organization/groups/user_create_response.rbi +29 -10
- data/rbi/openai/models/admin/organization/groups/user_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/groups/user_delete_response.rbi +30 -10
- data/rbi/openai/models/admin/organization/groups/user_list_params.rbi +39 -50
- data/rbi/openai/models/admin/organization/groups/user_retrieve_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/groups/user_retrieve_response.rbi +48 -39
- data/rbi/openai/models/admin/organization/invite.rbi +71 -115
- data/rbi/openai/models/admin/organization/invite_create_params.rbi +60 -111
- data/rbi/openai/models/admin/organization/invite_delete_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/invite_delete_response.rbi +27 -10
- data/rbi/openai/models/admin/organization/invite_list_params.rbi +23 -13
- data/rbi/openai/models/admin/organization/invite_retrieve_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/organization_data_retention.rbi +45 -55
- data/rbi/openai/models/admin/organization/organization_spend_alert.rbi +74 -91
- data/rbi/openai/models/admin/organization/organization_spend_alert_deleted.rbi +28 -12
- data/rbi/openai/models/admin/organization/organization_spend_limit.rbi +92 -149
- data/rbi/openai/models/admin/organization/organization_spend_limit_deleted.rbi +29 -12
- data/rbi/openai/models/admin/organization/organization_user.rbi +119 -87
- data/rbi/openai/models/admin/organization/project.rbi +44 -8
- data/rbi/openai/models/admin/organization/project_archive_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/project_create_params.rbi +46 -10
- data/rbi/openai/models/admin/organization/project_list_params.rbi +25 -14
- data/rbi/openai/models/admin/organization/project_residency.rbi +48 -0
- data/rbi/openai/models/admin/organization/project_retrieve_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/project_update_params.rbi +30 -10
- data/rbi/openai/models/admin/organization/projects/api_key_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/api_key_delete_response.rbi +28 -10
- data/rbi/openai/models/admin/organization/projects/api_key_list_params.rbi +56 -51
- data/rbi/openai/models/admin/organization/projects/api_key_retrieve_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/certificate_activate_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/certificate_activate_response.rbi +60 -32
- data/rbi/openai/models/admin/organization/projects/certificate_deactivate_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/certificate_deactivate_response.rbi +60 -32
- data/rbi/openai/models/admin/organization/projects/certificate_list_params.rbi +40 -47
- data/rbi/openai/models/admin/organization/projects/certificate_list_response.rbi +58 -32
- data/rbi/openai/models/admin/organization/projects/data_retention_retrieve_params.rbi +27 -10
- data/rbi/openai/models/admin/organization/projects/data_retention_update_params.rbi +56 -56
- data/rbi/openai/models/admin/organization/projects/group_create_params.rbi +27 -14
- data/rbi/openai/models/admin/organization/projects/group_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/group_delete_response.rbi +30 -10
- data/rbi/openai/models/admin/organization/projects/group_list_params.rbi +41 -50
- data/rbi/openai/models/admin/organization/projects/group_retrieve_params.rbi +43 -47
- data/rbi/openai/models/admin/organization/projects/groups/role_create_params.rbi +29 -14
- data/rbi/openai/models/admin/organization/projects/groups/role_create_response.rbi +55 -40
- data/rbi/openai/models/admin/organization/projects/groups/role_delete_params.rbi +29 -14
- data/rbi/openai/models/admin/organization/projects/groups/role_delete_response.rbi +32 -10
- data/rbi/openai/models/admin/organization/projects/groups/role_list_params.rbi +48 -47
- data/rbi/openai/models/admin/organization/projects/groups/role_list_response.rbi +78 -36
- data/rbi/openai/models/admin/organization/projects/groups/role_retrieve_params.rbi +29 -14
- data/rbi/openai/models/admin/organization/projects/groups/role_retrieve_response.rbi +77 -33
- data/rbi/openai/models/admin/organization/projects/hosted_tool_permission_retrieve_params.rbi +27 -10
- data/rbi/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rbi +209 -159
- data/rbi/openai/models/admin/organization/projects/model_permission_delete_params.rbi +27 -10
- data/rbi/openai/models/admin/organization/projects/model_permission_retrieve_params.rbi +27 -10
- data/rbi/openai/models/admin/organization/projects/model_permission_update_params.rbi +43 -39
- data/rbi/openai/models/admin/organization/projects/project_api_key.rbi +140 -163
- data/rbi/openai/models/admin/organization/projects/project_data_retention.rbi +53 -62
- data/rbi/openai/models/admin/organization/projects/project_group.rbi +46 -42
- data/rbi/openai/models/admin/organization/projects/project_hosted_tool_permissions.rbi +168 -124
- data/rbi/openai/models/admin/organization/projects/project_model_permissions.rbi +41 -38
- data/rbi/openai/models/admin/organization/projects/project_model_permissions_deleted.rbi +31 -12
- data/rbi/openai/models/admin/organization/projects/project_rate_limit.rbi +37 -8
- data/rbi/openai/models/admin/organization/projects/project_service_account.rbi +41 -44
- data/rbi/openai/models/admin/organization/projects/project_spend_alert.rbi +76 -87
- data/rbi/openai/models/admin/organization/projects/project_spend_alert_deleted.rbi +29 -10
- data/rbi/openai/models/admin/organization/projects/project_spend_limit.rbi +103 -149
- data/rbi/openai/models/admin/organization/projects/project_spend_limit_deleted.rbi +30 -10
- data/rbi/openai/models/admin/organization/projects/project_user.rbi +31 -8
- data/rbi/openai/models/admin/organization/projects/rate_limit_list_rate_limits_params.rbi +28 -8
- data/rbi/openai/models/admin/organization/projects/rate_limit_update_rate_limit_params.rbi +36 -8
- data/rbi/openai/models/admin/organization/projects/role_create_params.rbi +28 -8
- data/rbi/openai/models/admin/organization/projects/role_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/role_delete_response.rbi +29 -10
- data/rbi/openai/models/admin/organization/projects/role_list_params.rbi +41 -50
- data/rbi/openai/models/admin/organization/projects/role_retrieve_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/role_update_params.rbi +30 -8
- data/rbi/openai/models/admin/organization/projects/service_account_create_params.rbi +26 -8
- data/rbi/openai/models/admin/organization/projects/service_account_create_response.rbi +85 -73
- data/rbi/openai/models/admin/organization/projects/service_account_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/service_account_delete_response.rbi +28 -10
- data/rbi/openai/models/admin/organization/projects/service_account_list_params.rbi +27 -14
- data/rbi/openai/models/admin/organization/projects/service_account_retrieve_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/service_account_update_params.rbi +50 -47
- data/rbi/openai/models/admin/organization/projects/service_accounts/api_key_create_params.rbi +30 -8
- data/rbi/openai/models/admin/organization/projects/service_accounts/api_key_create_response.rbi +32 -15
- data/rbi/openai/models/admin/organization/projects/spend_alert_create_params.rbi +78 -87
- data/rbi/openai/models/admin/organization/projects/spend_alert_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/spend_alert_list_params.rbi +42 -47
- data/rbi/openai/models/admin/organization/projects/spend_alert_retrieve_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/spend_alert_update_params.rbi +80 -87
- data/rbi/openai/models/admin/organization/projects/spend_limit_delete_params.rbi +27 -10
- data/rbi/openai/models/admin/organization/projects/spend_limit_retrieve_params.rbi +27 -10
- data/rbi/openai/models/admin/organization/projects/spend_limit_update_params.rbi +51 -60
- data/rbi/openai/models/admin/organization/projects/user_create_params.rbi +28 -8
- data/rbi/openai/models/admin/organization/projects/user_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/user_delete_response.rbi +28 -10
- data/rbi/openai/models/admin/organization/projects/user_list_params.rbi +27 -14
- data/rbi/openai/models/admin/organization/projects/user_retrieve_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/projects/user_update_params.rbi +27 -14
- data/rbi/openai/models/admin/organization/projects/users/role_create_params.rbi +29 -14
- data/rbi/openai/models/admin/organization/projects/users/role_create_response.rbi +29 -16
- data/rbi/openai/models/admin/organization/projects/users/role_delete_params.rbi +35 -15
- data/rbi/openai/models/admin/organization/projects/users/role_delete_response.rbi +32 -10
- data/rbi/openai/models/admin/organization/projects/users/role_list_params.rbi +44 -47
- data/rbi/openai/models/admin/organization/projects/users/role_list_response.rbi +76 -36
- data/rbi/openai/models/admin/organization/projects/users/role_retrieve_params.rbi +35 -15
- data/rbi/openai/models/admin/organization/projects/users/role_retrieve_response.rbi +77 -33
- data/rbi/openai/models/admin/organization/role.rbi +31 -8
- data/rbi/openai/models/admin/organization/role_create_params.rbi +24 -8
- data/rbi/openai/models/admin/organization/role_delete_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/role_delete_response.rbi +27 -10
- data/rbi/openai/models/admin/organization/role_list_params.rbi +33 -50
- data/rbi/openai/models/admin/organization/role_retrieve_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/role_update_params.rbi +26 -8
- data/rbi/openai/models/admin/organization/spend_alert_create_params.rbi +71 -91
- data/rbi/openai/models/admin/organization/spend_alert_delete_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/spend_alert_list_params.rbi +35 -50
- data/rbi/openai/models/admin/organization/spend_alert_retrieve_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/spend_alert_update_params.rbi +73 -91
- data/rbi/openai/models/admin/organization/spend_limit_delete_params.rbi +15 -8
- data/rbi/openai/models/admin/organization/spend_limit_retrieve_params.rbi +15 -8
- data/rbi/openai/models/admin/organization/spend_limit_update_params.rbi +46 -66
- data/rbi/openai/models/admin/organization/usage_audio_speeches_params.rbi +86 -111
- data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +404 -197
- data/rbi/openai/models/admin/organization/usage_audio_transcriptions_params.rbi +93 -109
- data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +403 -192
- data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_params.rbi +79 -91
- data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +402 -189
- data/rbi/openai/models/admin/organization/usage_completions_params.rbi +83 -125
- data/rbi/openai/models/admin/organization/usage_completions_response.rbi +404 -197
- data/rbi/openai/models/admin/organization/usage_costs_params.rbi +54 -100
- data/rbi/openai/models/admin/organization/usage_costs_response.rbi +400 -197
- data/rbi/openai/models/admin/organization/usage_embeddings_params.rbi +76 -115
- data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +404 -197
- data/rbi/openai/models/admin/organization/usage_file_search_calls_params.rbi +89 -111
- data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +404 -195
- data/rbi/openai/models/admin/organization/usage_images_params.rbi +95 -245
- data/rbi/openai/models/admin/organization/usage_images_response.rbi +400 -197
- data/rbi/openai/models/admin/organization/usage_moderations_params.rbi +76 -115
- data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +404 -197
- data/rbi/openai/models/admin/organization/usage_vector_stores_params.rbi +69 -96
- data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +404 -197
- data/rbi/openai/models/admin/organization/usage_web_search_calls_params.rbi +111 -167
- data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +404 -195
- data/rbi/openai/models/admin/organization/user_delete_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/user_delete_response.rbi +31 -11
- data/rbi/openai/models/admin/organization/user_list_params.rbi +25 -14
- data/rbi/openai/models/admin/organization/user_retrieve_params.rbi +25 -10
- data/rbi/openai/models/admin/organization/user_update_params.rbi +28 -8
- data/rbi/openai/models/admin/organization/users/role_create_params.rbi +25 -13
- data/rbi/openai/models/admin/organization/users/role_create_response.rbi +26 -13
- data/rbi/openai/models/admin/organization/users/role_delete_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/users/role_delete_response.rbi +30 -10
- data/rbi/openai/models/admin/organization/users/role_list_params.rbi +39 -50
- data/rbi/openai/models/admin/organization/users/role_list_response.rbi +72 -38
- data/rbi/openai/models/admin/organization/users/role_retrieve_params.rbi +30 -14
- data/rbi/openai/models/admin/organization/users/role_retrieve_response.rbi +72 -38
- data/rbi/openai/models/all_models.rbi +43 -104
- data/rbi/openai/models/audio/speech_create_params.rbi +108 -188
- data/rbi/openai/models/audio/speech_model.rbi +9 -13
- data/rbi/openai/models/audio/transcription.rbi +124 -100
- data/rbi/openai/models/audio/transcription_create_params.rbi +107 -149
- data/rbi/openai/models/audio/transcription_create_response.rbi +12 -14
- data/rbi/openai/models/audio/transcription_diarized.rbi +111 -81
- data/rbi/openai/models/audio/transcription_diarized_segment.rbi +28 -16
- data/rbi/openai/models/audio/transcription_include.rbi +7 -9
- data/rbi/openai/models/audio/transcription_language.rbi +26 -9
- data/rbi/openai/models/audio/transcription_segment.rbi +35 -8
- data/rbi/openai/models/audio/transcription_stream_event.rbi +12 -12
- data/rbi/openai/models/audio/transcription_text_delta_event.rbi +44 -38
- data/rbi/openai/models/audio/transcription_text_done_event.rbi +95 -89
- data/rbi/openai/models/audio/transcription_text_segment_event.rbi +28 -16
- data/rbi/openai/models/audio/transcription_verbose.rbi +55 -31
- data/rbi/openai/models/audio/transcription_word.rbi +29 -7
- data/rbi/openai/models/audio/translation.rbi +28 -7
- data/rbi/openai/models/audio/translation_create_params.rbi +41 -72
- data/rbi/openai/models/audio/translation_create_response.rbi +11 -8
- data/rbi/openai/models/audio/translation_verbose.rbi +26 -19
- data/rbi/openai/models/audio_model.rbi +7 -13
- data/rbi/openai/models/audio_response_format.rbi +5 -7
- data/rbi/openai/models/auto_file_chunking_strategy_param.rbi +24 -9
- data/rbi/openai/models/batch.rbi +72 -8
- data/rbi/openai/models/batch_cancel_params.rbi +21 -7
- data/rbi/openai/models/batch_create_params.rbi +63 -87
- data/rbi/openai/models/batch_error.rbi +22 -9
- data/rbi/openai/models/batch_list_params.rbi +19 -10
- data/rbi/openai/models/batch_request_counts.rbi +23 -7
- data/rbi/openai/models/batch_retrieve_params.rbi +21 -7
- data/rbi/openai/models/batch_usage.rbi +68 -33
- data/rbi/openai/models/beta/assistant.rbi +121 -94
- data/rbi/openai/models/beta/assistant_create_params.rbi +258 -244
- data/rbi/openai/models/beta/assistant_delete_params.rbi +23 -10
- data/rbi/openai/models/beta/assistant_deleted.rbi +31 -8
- data/rbi/openai/models/beta/assistant_list_params.rbi +30 -24
- data/rbi/openai/models/beta/assistant_response_format_option.rbi +13 -13
- data/rbi/openai/models/beta/assistant_retrieve_params.rbi +23 -10
- data/rbi/openai/models/beta/assistant_stream_event.rbi +388 -279
- data/rbi/openai/models/beta/assistant_tool.rbi +13 -11
- data/rbi/openai/models/beta/assistant_tool_choice.rbi +25 -35
- data/rbi/openai/models/beta/assistant_tool_choice_function.rbi +26 -9
- data/rbi/openai/models/beta/assistant_tool_choice_option.rbi +17 -38
- data/rbi/openai/models/beta/assistant_update_params.rbi +230 -392
- data/rbi/openai/models/beta/beta_apply_patch_tool.rbi +27 -48
- data/rbi/openai/models/beta/beta_compacted_response.rbi +61 -47
- data/rbi/openai/models/beta/beta_computer_action.rbi +233 -159
- data/rbi/openai/models/beta/beta_computer_action_list.rbi +9 -9
- data/rbi/openai/models/beta/beta_computer_tool.rbi +26 -6
- data/rbi/openai/models/beta/beta_computer_use_preview_tool.rbi +34 -57
- data/rbi/openai/models/beta/beta_container_auto.rbi +70 -132
- data/rbi/openai/models/beta/beta_container_network_policy_allowlist.rbi +26 -31
- data/rbi/openai/models/beta/beta_container_network_policy_disabled.rbi +27 -11
- data/rbi/openai/models/beta/beta_container_network_policy_domain_secret.rbi +28 -12
- data/rbi/openai/models/beta/beta_container_reference.rbi +27 -9
- data/rbi/openai/models/beta/beta_custom_tool.rbi +97 -130
- data/rbi/openai/models/beta/beta_easy_input_message.rbi +47 -94
- data/rbi/openai/models/beta/beta_file_search_tool.rbi +283 -390
- data/rbi/openai/models/beta/beta_function_shell_tool.rbi +52 -82
- data/rbi/openai/models/beta/beta_function_tool.rbi +39 -46
- data/rbi/openai/models/beta/beta_inline_skill.rbi +24 -11
- data/rbi/openai/models/beta/beta_inline_skill_source.rbi +27 -10
- data/rbi/openai/models/beta/beta_local_environment.rbi +21 -9
- data/rbi/openai/models/beta/beta_local_skill.rbi +27 -7
- data/rbi/openai/models/beta/beta_mcp_tool_call_error.rbi +88 -43
- data/rbi/openai/models/beta/beta_namespace_tool.rbi +76 -93
- data/rbi/openai/models/beta/beta_response.rbi +728 -1318
- data/rbi/openai/models/beta/beta_response_apply_patch_tool_call.rbi +201 -164
- data/rbi/openai/models/beta/beta_response_apply_patch_tool_call_output.rbi +121 -114
- data/rbi/openai/models/beta/beta_response_audio_delta_event.rbi +47 -32
- data/rbi/openai/models/beta/beta_response_audio_done_event.rbi +46 -35
- data/rbi/openai/models/beta/beta_response_audio_transcript_delta_event.rbi +49 -42
- data/rbi/openai/models/beta/beta_response_audio_transcript_done_event.rbi +47 -40
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rbi +55 -42
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rbi +55 -42
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_completed_event.rbi +53 -42
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rbi +53 -42
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rbi +53 -42
- data/rbi/openai/models/beta/beta_response_code_interpreter_tool_call.rbi +137 -138
- data/rbi/openai/models/beta/beta_response_compaction_item.rbi +48 -25
- data/rbi/openai/models/beta/beta_response_compaction_item_param.rbi +48 -36
- data/rbi/openai/models/beta/beta_response_completed_event.rbi +47 -30
- data/rbi/openai/models/beta/beta_response_computer_tool_call.rbi +151 -181
- data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +105 -135
- data/rbi/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rbi +28 -12
- data/rbi/openai/models/beta/beta_response_container_reference.rbi +27 -9
- data/rbi/openai/models/beta/beta_response_content.rbi +39 -24
- data/rbi/openai/models/beta/beta_response_content_part_added_event.rbi +93 -74
- data/rbi/openai/models/beta/beta_response_content_part_done_event.rbi +93 -72
- data/rbi/openai/models/beta/beta_response_conversation_param.rbi +26 -9
- data/rbi/openai/models/beta/beta_response_created_event.rbi +47 -28
- data/rbi/openai/models/beta/beta_response_custom_tool_call.rbi +119 -77
- data/rbi/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rbi +53 -42
- data/rbi/openai/models/beta/beta_response_custom_tool_call_input_done_event.rbi +53 -42
- data/rbi/openai/models/beta/beta_response_custom_tool_call_item.rbi +84 -49
- data/rbi/openai/models/beta/beta_response_custom_tool_call_output.rbi +139 -129
- data/rbi/openai/models/beta/beta_response_custom_tool_call_output_item.rbi +74 -51
- data/rbi/openai/models/beta/beta_response_error.rbi +52 -119
- data/rbi/openai/models/beta/beta_response_error_event.rbi +50 -25
- data/rbi/openai/models/beta/beta_response_failed_event.rbi +46 -25
- data/rbi/openai/models/beta/beta_response_file_search_call_completed_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_file_search_call_in_progress_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_file_search_call_searching_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_file_search_tool_call.rbi +97 -138
- data/rbi/openai/models/beta/beta_response_format_text_config.rbi +53 -29
- data/rbi/openai/models/beta/beta_response_format_text_json_schema_config.rbi +26 -10
- data/rbi/openai/models/beta/beta_response_function_call_arguments_delta_event.rbi +53 -42
- data/rbi/openai/models/beta/beta_response_function_call_arguments_done_event.rbi +54 -42
- data/rbi/openai/models/beta/beta_response_function_call_output_item.rbi +13 -14
- data/rbi/openai/models/beta/beta_response_function_call_output_item_list.rbi +11 -11
- data/rbi/openai/models/beta/beta_response_function_shell_call_output_content.rbi +83 -52
- data/rbi/openai/models/beta/beta_response_function_shell_tool_call.rbi +155 -170
- data/rbi/openai/models/beta/beta_response_function_shell_tool_call_output.rbi +203 -187
- data/rbi/openai/models/beta/beta_response_function_tool_call.rbi +131 -123
- data/rbi/openai/models/beta/beta_response_function_tool_call_item.rbi +84 -49
- data/rbi/openai/models/beta/beta_response_function_tool_call_output_item.rbi +166 -181
- data/rbi/openai/models/beta/beta_response_function_web_search.rbi +167 -161
- data/rbi/openai/models/beta/beta_response_image_gen_call_completed_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_image_gen_call_generating_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_image_gen_call_in_progress_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbi +107 -42
- data/rbi/openai/models/beta/beta_response_in_progress_event.rbi +47 -32
- data/rbi/openai/models/beta/beta_response_includable.rbi +35 -47
- data/rbi/openai/models/beta/beta_response_incomplete_event.rbi +47 -32
- data/rbi/openai/models/beta/beta_response_inject_created_event.rbi +24 -14
- data/rbi/openai/models/beta/beta_response_inject_event.rbi +101 -90
- data/rbi/openai/models/beta/beta_response_inject_failed_event.rbi +134 -139
- data/rbi/openai/models/beta/beta_response_input.rbi +9 -9
- data/rbi/openai/models/beta/beta_response_input_audio.rbi +43 -65
- data/rbi/openai/models/beta/beta_response_input_content.rbi +12 -12
- data/rbi/openai/models/beta/beta_response_input_file.rbi +63 -70
- data/rbi/openai/models/beta/beta_response_input_file_content.rbi +71 -81
- data/rbi/openai/models/beta/beta_response_input_image.rbi +58 -65
- data/rbi/openai/models/beta/beta_response_input_image_content.rbi +67 -85
- data/rbi/openai/models/beta/beta_response_input_item.rbi +2142 -2457
- data/rbi/openai/models/beta/beta_response_input_message_content_list.rbi +11 -11
- data/rbi/openai/models/beta/beta_response_input_message_item.rbi +77 -122
- data/rbi/openai/models/beta/beta_response_input_text.rbi +48 -34
- data/rbi/openai/models/beta/beta_response_input_text_content.rbi +54 -39
- data/rbi/openai/models/beta/beta_response_item.rbi +1016 -1093
- data/rbi/openai/models/beta/beta_response_local_environment.rbi +26 -9
- data/rbi/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rbi +53 -42
- data/rbi/openai/models/beta/beta_response_mcp_call_arguments_done_event.rbi +53 -42
- data/rbi/openai/models/beta/beta_response_mcp_call_completed_event.rbi +50 -38
- data/rbi/openai/models/beta/beta_response_mcp_call_failed_event.rbi +50 -36
- data/rbi/openai/models/beta/beta_response_mcp_call_in_progress_event.rbi +51 -40
- data/rbi/openai/models/beta/beta_response_mcp_list_tools_completed_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_mcp_list_tools_failed_event.rbi +51 -40
- data/rbi/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_output_audio.rbi +27 -10
- data/rbi/openai/models/beta/beta_response_output_item.rbi +1080 -1127
- data/rbi/openai/models/beta/beta_response_output_item_added_event.rbi +83 -70
- data/rbi/openai/models/beta/beta_response_output_item_done_event.rbi +83 -70
- data/rbi/openai/models/beta/beta_response_output_message.rbi +76 -129
- data/rbi/openai/models/beta/beta_response_output_refusal.rbi +29 -9
- data/rbi/openai/models/beta/beta_response_output_text.rbi +180 -136
- data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi +158 -122
- data/rbi/openai/models/beta/beta_response_prompt.rbi +55 -45
- data/rbi/openai/models/beta/beta_response_queued_event.rbi +46 -25
- data/rbi/openai/models/beta/beta_response_reasoning_item.rbi +115 -110
- data/rbi/openai/models/beta/beta_response_reasoning_summary_part_added_event.rbi +83 -66
- data/rbi/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbi +96 -100
- data/rbi/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rbi +55 -42
- data/rbi/openai/models/beta/beta_response_reasoning_summary_text_done_event.rbi +55 -42
- data/rbi/openai/models/beta/beta_response_reasoning_text_delta_event.rbi +55 -40
- data/rbi/openai/models/beta/beta_response_reasoning_text_done_event.rbi +55 -40
- data/rbi/openai/models/beta/beta_response_refusal_delta_event.rbi +54 -34
- data/rbi/openai/models/beta/beta_response_refusal_done_event.rbi +54 -34
- data/rbi/openai/models/beta/beta_response_shell_call_command_added_event.rbi +145 -0
- data/rbi/openai/models/beta/beta_response_shell_call_command_delta_event.rbi +158 -0
- data/rbi/openai/models/beta/beta_response_shell_call_command_done_event.rbi +145 -0
- data/rbi/openai/models/beta/beta_response_shell_call_output_content_delta_event.rbi +211 -0
- data/rbi/openai/models/beta/beta_response_shell_call_output_content_done_event.rbi +339 -0
- data/rbi/openai/models/beta/beta_response_status.rbi +10 -15
- data/rbi/openai/models/beta/beta_response_stream_event.rbi +67 -62
- data/rbi/openai/models/beta/beta_response_text_config.rbi +48 -70
- data/rbi/openai/models/beta/beta_response_text_delta_event.rbi +101 -81
- data/rbi/openai/models/beta/beta_response_text_done_event.rbi +101 -79
- data/rbi/openai/models/beta/beta_response_tool_search_call.rbi +68 -88
- data/rbi/openai/models/beta/beta_response_tool_search_output_item.rbi +90 -121
- data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +115 -171
- data/rbi/openai/models/beta/beta_response_usage.rbi +69 -44
- data/rbi/openai/models/beta/beta_response_web_search_call_completed_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_web_search_call_in_progress_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_response_web_search_call_searching_event.rbi +51 -42
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +1110 -1552
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +2308 -1353
- data/rbi/openai/models/beta/beta_skill_reference.rbi +27 -7
- data/rbi/openai/models/beta/beta_tool.rbi +531 -931
- data/rbi/openai/models/beta/beta_tool_choice_allowed.rbi +26 -28
- data/rbi/openai/models/beta/beta_tool_choice_apply_patch.rbi +26 -9
- data/rbi/openai/models/beta/beta_tool_choice_custom.rbi +29 -6
- data/rbi/openai/models/beta/beta_tool_choice_function.rbi +29 -9
- data/rbi/openai/models/beta/beta_tool_choice_mcp.rbi +22 -6
- data/rbi/openai/models/beta/beta_tool_choice_options.rbi +7 -9
- data/rbi/openai/models/beta/beta_tool_choice_shell.rbi +26 -6
- data/rbi/openai/models/beta/beta_tool_choice_types.rbi +32 -56
- data/rbi/openai/models/beta/beta_tool_search_tool.rbi +30 -37
- data/rbi/openai/models/beta/beta_web_search_preview_tool.rbi +74 -151
- data/rbi/openai/models/beta/beta_web_search_tool.rbi +87 -142
- data/rbi/openai/models/beta/chatkit/chat_session.rbi +43 -29
- data/rbi/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rbi +28 -9
- data/rbi/openai/models/beta/chatkit/chat_session_chatkit_configuration.rbi +31 -31
- data/rbi/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rbi +100 -90
- data/rbi/openai/models/beta/chatkit/chat_session_expires_after_param.rbi +29 -9
- data/rbi/openai/models/beta/chatkit/chat_session_file_upload.rbi +24 -13
- data/rbi/openai/models/beta/chatkit/chat_session_history.rbi +22 -9
- data/rbi/openai/models/beta/chatkit/chat_session_rate_limits.rbi +26 -9
- data/rbi/openai/models/beta/chatkit/chat_session_rate_limits_param.rbi +26 -9
- data/rbi/openai/models/beta/chatkit/chat_session_status.rbi +12 -25
- data/rbi/openai/models/beta/chatkit/chat_session_workflow_param.rbi +67 -67
- data/rbi/openai/models/beta/chatkit/chatkit_attachment.rbi +34 -37
- data/rbi/openai/models/beta/chatkit/chatkit_response_output_text.rbi +117 -108
- data/rbi/openai/models/beta/chatkit/chatkit_thread.rbi +101 -57
- data/rbi/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rbi +33 -19
- data/rbi/openai/models/beta/chatkit/chatkit_thread_item_list.rbi +193 -176
- data/rbi/openai/models/beta/chatkit/chatkit_thread_user_message_item.rbi +153 -119
- data/rbi/openai/models/beta/chatkit/chatkit_widget_item.rbi +30 -16
- data/rbi/openai/models/beta/chatkit/session_cancel_params.rbi +25 -10
- data/rbi/openai/models/beta/chatkit/session_create_params.rbi +42 -58
- data/rbi/openai/models/beta/chatkit/thread_delete_params.rbi +25 -10
- data/rbi/openai/models/beta/chatkit/thread_delete_response.rbi +27 -10
- data/rbi/openai/models/beta/chatkit/thread_list_items_params.rbi +37 -50
- data/rbi/openai/models/beta/chatkit/thread_list_params.rbi +35 -42
- data/rbi/openai/models/beta/chatkit/thread_retrieve_params.rbi +25 -10
- data/rbi/openai/models/beta/chatkit_workflow.rbi +50 -46
- data/rbi/openai/models/beta/code_interpreter_tool.rbi +26 -6
- data/rbi/openai/models/beta/file_search_tool.rbi +66 -89
- data/rbi/openai/models/beta/function_tool.rbi +20 -6
- data/rbi/openai/models/beta/message_stream_event.rbi +84 -59
- data/rbi/openai/models/beta/response_cancel_params.rbi +34 -34
- data/rbi/openai/models/beta/response_compact_params.rbi +321 -808
- data/rbi/openai/models/beta/response_create_params.rbi +738 -1545
- data/rbi/openai/models/beta/response_delete_params.rbi +34 -34
- data/rbi/openai/models/beta/response_retrieve_params.rbi +38 -49
- data/rbi/openai/models/beta/responses/beta_response_item_list.rbi +63 -45
- data/rbi/openai/models/beta/responses/input_item_list_params.rbi +53 -109
- data/rbi/openai/models/beta/responses/input_token_count_params.rbi +378 -691
- data/rbi/openai/models/beta/responses/input_token_count_response.rbi +31 -11
- data/rbi/openai/models/beta/run_step_stream_event.rbi +120 -102
- data/rbi/openai/models/beta/run_stream_event.rbi +158 -106
- data/rbi/openai/models/beta/thread.rbi +88 -66
- data/rbi/openai/models/beta/thread_create_and_run_params.rbi +512 -593
- data/rbi/openai/models/beta/thread_create_params.rbi +302 -330
- data/rbi/openai/models/beta/thread_delete_params.rbi +23 -7
- data/rbi/openai/models/beta/thread_deleted.rbi +31 -8
- data/rbi/openai/models/beta/thread_retrieve_params.rbi +23 -7
- data/rbi/openai/models/beta/thread_stream_event.rbi +21 -6
- data/rbi/openai/models/beta/thread_update_params.rbi +90 -81
- data/rbi/openai/models/beta/threads/annotation.rbi +13 -11
- data/rbi/openai/models/beta/threads/annotation_delta.rbi +13 -11
- data/rbi/openai/models/beta/threads/file_citation_annotation.rbi +52 -30
- data/rbi/openai/models/beta/threads/file_citation_delta_annotation.rbi +55 -34
- data/rbi/openai/models/beta/threads/file_path_annotation.rbi +50 -25
- data/rbi/openai/models/beta/threads/file_path_delta_annotation.rbi +54 -34
- data/rbi/openai/models/beta/threads/image_file.rbi +30 -44
- data/rbi/openai/models/beta/threads/image_file_content_block.rbi +23 -12
- data/rbi/openai/models/beta/threads/image_file_delta.rbi +30 -52
- data/rbi/openai/models/beta/threads/image_file_delta_block.rbi +25 -18
- data/rbi/openai/models/beta/threads/image_url.rbi +30 -41
- data/rbi/openai/models/beta/threads/image_url_content_block.rbi +23 -12
- data/rbi/openai/models/beta/threads/image_url_delta.rbi +30 -52
- data/rbi/openai/models/beta/threads/image_url_delta_block.rbi +25 -16
- data/rbi/openai/models/beta/threads/message.rbi +159 -212
- data/rbi/openai/models/beta/threads/message_content.rbi +15 -13
- data/rbi/openai/models/beta/threads/message_content_delta.rbi +15 -13
- data/rbi/openai/models/beta/threads/message_content_part_param.rbi +14 -12
- data/rbi/openai/models/beta/threads/message_create_params.rbi +116 -141
- data/rbi/openai/models/beta/threads/message_delete_params.rbi +28 -14
- data/rbi/openai/models/beta/threads/message_deleted.rbi +31 -11
- data/rbi/openai/models/beta/threads/message_delta.rbi +49 -71
- data/rbi/openai/models/beta/threads/message_delta_event.rbi +25 -16
- data/rbi/openai/models/beta/threads/message_list_params.rbi +38 -44
- data/rbi/openai/models/beta/threads/message_retrieve_params.rbi +28 -14
- data/rbi/openai/models/beta/threads/message_update_params.rbi +24 -8
- data/rbi/openai/models/beta/threads/refusal_content_block.rbi +29 -9
- data/rbi/openai/models/beta/threads/refusal_delta_block.rbi +29 -10
- data/rbi/openai/models/beta/threads/required_action_function_tool_call.rbi +49 -36
- data/rbi/openai/models/beta/threads/run.rbi +229 -298
- data/rbi/openai/models/beta/threads/run_cancel_params.rbi +28 -14
- data/rbi/openai/models/beta/threads/run_create_params.rbi +264 -330
- data/rbi/openai/models/beta/threads/run_list_params.rbi +35 -40
- data/rbi/openai/models/beta/threads/run_retrieve_params.rbi +28 -14
- data/rbi/openai/models/beta/threads/run_status.rbi +18 -29
- data/rbi/openai/models/beta/threads/run_submit_tool_outputs_params.rbi +48 -33
- data/rbi/openai/models/beta/threads/run_update_params.rbi +24 -8
- data/rbi/openai/models/beta/threads/runs/code_interpreter_logs.rbi +31 -10
- data/rbi/openai/models/beta/threads/runs/code_interpreter_output_image.rbi +50 -38
- data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call.rbi +130 -96
- data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbi +78 -64
- data/rbi/openai/models/beta/threads/runs/file_search_tool_call.rbi +149 -172
- data/rbi/openai/models/beta/threads/runs/file_search_tool_call_delta.rbi +28 -14
- data/rbi/openai/models/beta/threads/runs/function_tool_call.rbi +46 -34
- data/rbi/openai/models/beta/threads/runs/function_tool_call_delta.rbi +48 -34
- data/rbi/openai/models/beta/threads/runs/message_creation_step_details.rbi +49 -30
- data/rbi/openai/models/beta/threads/runs/run_step.rbi +128 -193
- data/rbi/openai/models/beta/threads/runs/run_step_delta.rbi +42 -45
- data/rbi/openai/models/beta/threads/runs/run_step_delta_event.rbi +27 -18
- data/rbi/openai/models/beta/threads/runs/run_step_delta_message_delta.rbi +51 -37
- data/rbi/openai/models/beta/threads/runs/run_step_include.rbi +15 -17
- data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +47 -75
- data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +32 -33
- data/rbi/openai/models/beta/threads/runs/tool_call.rbi +16 -12
- data/rbi/openai/models/beta/threads/runs/tool_call_delta.rbi +16 -12
- data/rbi/openai/models/beta/threads/runs/tool_call_delta_object.rbi +43 -41
- data/rbi/openai/models/beta/threads/runs/tool_calls_step_details.rbi +32 -24
- data/rbi/openai/models/beta/threads/text.rbi +28 -17
- data/rbi/openai/models/beta/threads/text_content_block.rbi +22 -9
- data/rbi/openai/models/beta/threads/text_content_block_param.rbi +31 -9
- data/rbi/openai/models/beta/threads/text_delta.rbi +37 -32
- data/rbi/openai/models/beta/threads/text_delta_block.rbi +24 -13
- data/rbi/openai/models/chat/chat_completion.rbi +333 -377
- data/rbi/openai/models/chat/chat_completion_allowed_tool_choice.rbi +21 -17
- data/rbi/openai/models/chat/chat_completion_allowed_tools.rbi +25 -33
- data/rbi/openai/models/chat/chat_completion_assistant_message_param.rbi +131 -149
- data/rbi/openai/models/chat/chat_completion_audio.rbi +24 -11
- data/rbi/openai/models/chat/chat_completion_audio_param.rbi +83 -141
- data/rbi/openai/models/chat/chat_completion_chunk.rbi +464 -589
- data/rbi/openai/models/chat/chat_completion_content_part.rbi +75 -60
- data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +78 -100
- data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +78 -89
- data/rbi/openai/models/chat/chat_completion_content_part_refusal.rbi +29 -9
- data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +49 -34
- data/rbi/openai/models/chat/chat_completion_custom_tool.rbi +131 -128
- data/rbi/openai/models/chat/chat_completion_deleted.rbi +27 -10
- data/rbi/openai/models/chat/chat_completion_developer_message_param.rbi +32 -44
- data/rbi/openai/models/chat/chat_completion_function_call_option.rbi +26 -9
- data/rbi/openai/models/chat/chat_completion_function_message_param.rbi +23 -11
- data/rbi/openai/models/chat/chat_completion_function_tool.rbi +20 -9
- data/rbi/openai/models/chat/chat_completion_message.rbi +113 -114
- data/rbi/openai/models/chat/chat_completion_message_custom_tool_call.rbi +50 -35
- data/rbi/openai/models/chat/chat_completion_message_function_tool_call.rbi +48 -36
- data/rbi/openai/models/chat/chat_completion_message_param.rbi +15 -15
- data/rbi/openai/models/chat/chat_completion_message_tool_call.rbi +11 -11
- data/rbi/openai/models/chat/chat_completion_modality.rbi +7 -9
- data/rbi/openai/models/chat/chat_completion_named_tool_choice.rbi +43 -29
- data/rbi/openai/models/chat/chat_completion_named_tool_choice_custom.rbi +44 -33
- data/rbi/openai/models/chat/chat_completion_prediction_content.rbi +30 -42
- data/rbi/openai/models/chat/chat_completion_reasoning_effort.rbi +4 -0
- data/rbi/openai/models/chat/chat_completion_role.rbi +9 -13
- data/rbi/openai/models/chat/chat_completion_store_message.rbi +85 -46
- data/rbi/openai/models/chat/chat_completion_stream_options.rbi +20 -9
- data/rbi/openai/models/chat/chat_completion_system_message_param.rbi +31 -42
- data/rbi/openai/models/chat/chat_completion_token_logprob.rbi +43 -32
- data/rbi/openai/models/chat/chat_completion_tool.rbi +12 -10
- data/rbi/openai/models/chat/chat_completion_tool_choice_option.rbi +19 -40
- data/rbi/openai/models/chat/chat_completion_tool_message_param.rbi +31 -38
- data/rbi/openai/models/chat/chat_completion_user_message_param.rbi +31 -42
- data/rbi/openai/models/chat/completion_create_params.rbi +514 -824
- data/rbi/openai/models/chat/completion_delete_params.rbi +23 -10
- data/rbi/openai/models/chat/completion_list_params.rbi +33 -32
- data/rbi/openai/models/chat/completion_retrieve_params.rbi +23 -10
- data/rbi/openai/models/chat/completion_update_params.rbi +20 -8
- data/rbi/openai/models/chat/completions/message_list_params.rbi +35 -50
- data/rbi/openai/models/chat_model.rbi +55 -112
- data/rbi/openai/models/comparison_filter.rbi +32 -36
- data/rbi/openai/models/completion.rbi +27 -3
- data/rbi/openai/models/completion_choice.rbi +43 -31
- data/rbi/openai/models/completion_create_params.rbi +88 -93
- data/rbi/openai/models/completion_usage.rbi +69 -42
- data/rbi/openai/models/compound_filter.rbi +23 -19
- data/rbi/openai/models/container_create_params.rbi +89 -160
- data/rbi/openai/models/container_create_response.rbi +98 -176
- data/rbi/openai/models/container_delete_params.rbi +21 -7
- data/rbi/openai/models/container_list_params.rbi +24 -12
- data/rbi/openai/models/container_list_response.rbi +92 -168
- data/rbi/openai/models/container_retrieve_params.rbi +21 -7
- data/rbi/openai/models/container_retrieve_response.rbi +100 -179
- data/rbi/openai/models/containers/file_create_params.rbi +22 -8
- data/rbi/openai/models/containers/file_create_response.rbi +29 -8
- data/rbi/openai/models/containers/file_delete_params.rbi +26 -14
- data/rbi/openai/models/containers/file_list_params.rbi +31 -32
- data/rbi/openai/models/containers/file_list_response.rbi +29 -8
- data/rbi/openai/models/containers/file_retrieve_params.rbi +26 -14
- data/rbi/openai/models/containers/file_retrieve_response.rbi +29 -8
- data/rbi/openai/models/containers/files/content_retrieve_params.rbi +28 -14
- data/rbi/openai/models/content_provenance_check.rbi +106 -165
- data/rbi/openai/models/content_provenance_check_create_params.rbi +17 -12
- data/rbi/openai/models/conversations/computer_screenshot_content.rbi +63 -76
- data/rbi/openai/models/conversations/conversation.rbi +24 -14
- data/rbi/openai/models/conversations/conversation_create_params.rbi +98 -88
- data/rbi/openai/models/conversations/conversation_delete_params.rbi +23 -10
- data/rbi/openai/models/conversations/conversation_deleted.rbi +31 -11
- data/rbi/openai/models/conversations/conversation_deleted_resource.rbi +31 -11
- data/rbi/openai/models/conversations/conversation_item.rbi +417 -488
- data/rbi/openai/models/conversations/conversation_item_list.rbi +58 -44
- data/rbi/openai/models/conversations/conversation_retrieve_params.rbi +23 -10
- data/rbi/openai/models/conversations/conversation_update_params.rbi +20 -8
- data/rbi/openai/models/conversations/input_file_content.rbi +4 -0
- data/rbi/openai/models/conversations/input_image_content.rbi +4 -0
- data/rbi/openai/models/conversations/input_text_content.rbi +4 -0
- data/rbi/openai/models/conversations/item_create_params.rbi +99 -96
- data/rbi/openai/models/conversations/item_delete_params.rbi +26 -14
- data/rbi/openai/models/conversations/item_list_params.rbi +36 -52
- data/rbi/openai/models/conversations/item_retrieve_params.rbi +25 -20
- data/rbi/openai/models/conversations/message.rbi +100 -132
- data/rbi/openai/models/conversations/output_text_content.rbi +4 -0
- data/rbi/openai/models/conversations/refusal_content.rbi +4 -0
- data/rbi/openai/models/conversations/summary_text_content.rbi +29 -9
- data/rbi/openai/models/conversations/text_content.rbi +32 -7
- data/rbi/openai/models/create_embedding_response.rbi +40 -15
- data/rbi/openai/models/custom_tool_input_format.rbi +51 -55
- data/rbi/openai/models/deleted_skill.rbi +29 -6
- data/rbi/openai/models/embedding.rbi +20 -4
- data/rbi/openai/models/embedding_create_params.rbi +54 -83
- data/rbi/openai/models/embedding_model.rbi +5 -6
- data/rbi/openai/models/error_object.rbi +27 -10
- data/rbi/openai/models/eval_create_params.rbi +482 -314
- data/rbi/openai/models/eval_create_response.rbi +236 -108
- data/rbi/openai/models/eval_custom_data_source_config.rbi +22 -7
- data/rbi/openai/models/eval_delete_params.rbi +21 -7
- data/rbi/openai/models/eval_delete_response.rbi +27 -8
- data/rbi/openai/models/eval_list_params.rbi +28 -23
- data/rbi/openai/models/eval_list_response.rbi +236 -106
- data/rbi/openai/models/eval_retrieve_params.rbi +21 -7
- data/rbi/openai/models/eval_retrieve_response.rbi +236 -110
- data/rbi/openai/models/eval_stored_completions_data_source_config.rbi +20 -13
- data/rbi/openai/models/eval_update_params.rbi +20 -5
- data/rbi/openai/models/eval_update_response.rbi +236 -108
- data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +418 -400
- data/rbi/openai/models/evals/create_eval_jsonl_run_data_source.rbi +93 -77
- data/rbi/openai/models/evals/eval_api_error.rbi +29 -6
- data/rbi/openai/models/evals/run_cancel_params.rbi +26 -11
- data/rbi/openai/models/evals/run_cancel_response.rbi +601 -512
- data/rbi/openai/models/evals/run_create_params.rbi +580 -484
- data/rbi/openai/models/evals/run_create_response.rbi +601 -512
- data/rbi/openai/models/evals/run_delete_params.rbi +26 -11
- data/rbi/openai/models/evals/run_delete_response.rbi +29 -11
- data/rbi/openai/models/evals/run_list_params.rbi +40 -48
- data/rbi/openai/models/evals/run_list_response.rbi +601 -512
- data/rbi/openai/models/evals/run_retrieve_params.rbi +26 -11
- data/rbi/openai/models/evals/run_retrieve_response.rbi +606 -515
- data/rbi/openai/models/evals/runs/output_item_list_params.rbi +47 -83
- data/rbi/openai/models/evals/runs/output_item_list_response.rbi +166 -129
- data/rbi/openai/models/evals/runs/output_item_retrieve_params.rbi +31 -15
- data/rbi/openai/models/evals/runs/output_item_retrieve_response.rbi +166 -131
- data/rbi/openai/models/file_chunking_strategy.rbi +9 -7
- data/rbi/openai/models/file_chunking_strategy_param.rbi +10 -10
- data/rbi/openai/models/file_content.rbi +2 -0
- data/rbi/openai/models/file_content_params.rbi +21 -7
- data/rbi/openai/models/file_create_params.rbi +43 -19
- data/rbi/openai/models/file_delete_params.rbi +21 -7
- data/rbi/openai/models/file_deleted.rbi +29 -6
- data/rbi/openai/models/file_list_params.rbi +24 -12
- data/rbi/openai/models/file_object.rbi +40 -23
- data/rbi/openai/models/file_purpose.rbi +2 -0
- data/rbi/openai/models/file_retrieve_params.rbi +21 -7
- data/rbi/openai/models/fine_tuning/alpha/grader_run_params.rbi +51 -43
- data/rbi/openai/models/fine_tuning/alpha/grader_run_response.rbi +88 -51
- data/rbi/openai/models/fine_tuning/alpha/grader_validate_params.rbi +47 -43
- data/rbi/openai/models/fine_tuning/alpha/grader_validate_response.rbi +51 -54
- data/rbi/openai/models/fine_tuning/checkpoints/permission_create_params.rbi +22 -8
- data/rbi/openai/models/fine_tuning/checkpoints/permission_create_response.rbi +26 -14
- data/rbi/openai/models/fine_tuning/checkpoints/permission_delete_params.rbi +23 -13
- data/rbi/openai/models/fine_tuning/checkpoints/permission_delete_response.rbi +27 -10
- data/rbi/openai/models/fine_tuning/checkpoints/permission_list_params.rbi +39 -50
- data/rbi/openai/models/fine_tuning/checkpoints/permission_list_response.rbi +26 -14
- data/rbi/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbi +47 -50
- data/rbi/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rbi +46 -35
- data/rbi/openai/models/fine_tuning/dpo_hyperparameters.rbi +31 -34
- data/rbi/openai/models/fine_tuning/dpo_method.rbi +19 -11
- data/rbi/openai/models/fine_tuning/fine_tuning_job.rbi +143 -199
- data/rbi/openai/models/fine_tuning/fine_tuning_job_event.rbi +44 -74
- data/rbi/openai/models/fine_tuning/fine_tuning_job_integration.rbi +5 -2
- data/rbi/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rbi +24 -14
- data/rbi/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rbi +22 -19
- data/rbi/openai/models/fine_tuning/job_cancel_params.rbi +23 -13
- data/rbi/openai/models/fine_tuning/job_create_params.rbi +143 -209
- data/rbi/openai/models/fine_tuning/job_list_events_params.rbi +23 -14
- data/rbi/openai/models/fine_tuning/job_list_params.rbi +22 -5
- data/rbi/openai/models/fine_tuning/job_pause_params.rbi +23 -10
- data/rbi/openai/models/fine_tuning/job_resume_params.rbi +23 -13
- data/rbi/openai/models/fine_tuning/job_retrieve_params.rbi +23 -13
- data/rbi/openai/models/fine_tuning/jobs/checkpoint_list_params.rbi +25 -14
- data/rbi/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rbi +58 -29
- data/rbi/openai/models/fine_tuning/reinforcement_hyperparameters.rbi +61 -99
- data/rbi/openai/models/fine_tuning/reinforcement_method.rbi +49 -54
- data/rbi/openai/models/fine_tuning/supervised_hyperparameters.rbi +29 -29
- data/rbi/openai/models/fine_tuning/supervised_method.rbi +21 -20
- data/rbi/openai/models/function_definition.rbi +22 -11
- data/rbi/openai/models/function_parameters.rbi +6 -5
- data/rbi/openai/models/graders/grader_input_item.rbi +57 -30
- data/rbi/openai/models/graders/grader_inputs.rbi +9 -9
- data/rbi/openai/models/graders/label_model_grader.rbi +140 -146
- data/rbi/openai/models/graders/multi_grader.rbi +50 -38
- data/rbi/openai/models/graders/python_grader.rbi +24 -6
- data/rbi/openai/models/graders/score_model_grader.rbi +163 -165
- data/rbi/openai/models/graders/string_check_grader.rbi +33 -39
- data/rbi/openai/models/graders/text_similarity_grader.rbi +42 -87
- data/rbi/openai/models/image.rbi +23 -4
- data/rbi/openai/models/image_create_variation_params.rbi +44 -77
- data/rbi/openai/models/image_edit_completed_event.rbi +94 -134
- data/rbi/openai/models/image_edit_params.rbi +110 -153
- data/rbi/openai/models/image_edit_partial_image_event.rbi +60 -125
- data/rbi/openai/models/image_edit_stream_event.rbi +9 -7
- data/rbi/openai/models/image_gen_completed_event.rbi +92 -125
- data/rbi/openai/models/image_gen_partial_image_event.rbi +60 -119
- data/rbi/openai/models/image_gen_stream_event.rbi +9 -7
- data/rbi/openai/models/image_generate_params.rbi +117 -196
- data/rbi/openai/models/image_input_reference_param.rbi +25 -6
- data/rbi/openai/models/image_model.rbi +5 -6
- data/rbi/openai/models/images_response.rbi +108 -103
- data/rbi/openai/models/metadata.rbi +6 -5
- data/rbi/openai/models/model.rbi +24 -9
- data/rbi/openai/models/model_delete_params.rbi +21 -7
- data/rbi/openai/models/model_deleted.rbi +29 -6
- data/rbi/openai/models/model_list_params.rbi +11 -5
- data/rbi/openai/models/model_retrieve_params.rbi +21 -7
- data/rbi/openai/models/moderation.rbi +240 -501
- data/rbi/openai/models/moderation_create_params.rbi +38 -45
- data/rbi/openai/models/moderation_create_response.rbi +20 -9
- data/rbi/openai/models/moderation_image_url_input.rbi +40 -20
- data/rbi/openai/models/moderation_model.rbi +6 -11
- data/rbi/openai/models/moderation_multi_modal_input.rbi +10 -7
- data/rbi/openai/models/moderation_text_input.rbi +27 -6
- data/rbi/openai/models/oauth_error_code.rbi +15 -7
- data/rbi/openai/models/other_file_chunking_strategy_object.rbi +24 -9
- data/rbi/openai/models/realtime/audio_transcription.rbi +69 -141
- data/rbi/openai/models/realtime/call_accept_params.rbi +175 -7
- data/rbi/openai/models/realtime/call_create_params.rbi +71 -0
- data/rbi/openai/models/realtime/call_hangup_params.rbi +23 -7
- data/rbi/openai/models/realtime/call_refer_params.rbi +21 -10
- data/rbi/openai/models/realtime/call_reject_params.rbi +21 -10
- data/rbi/openai/models/realtime/client_secret_create_params.rbi +77 -104
- data/rbi/openai/models/realtime/client_secret_create_response.rbi +35 -34
- data/rbi/openai/models/realtime/conversation_created_event.rbi +53 -73
- data/rbi/openai/models/realtime/conversation_item.rbi +18 -18
- data/rbi/openai/models/realtime/conversation_item_added.rbi +47 -34
- data/rbi/openai/models/realtime/conversation_item_create_event.rbi +47 -34
- data/rbi/openai/models/realtime/conversation_item_created_event.rbi +47 -34
- data/rbi/openai/models/realtime/conversation_item_delete_event.rbi +27 -10
- data/rbi/openai/models/realtime/conversation_item_deleted_event.rbi +27 -10
- data/rbi/openai/models/realtime/conversation_item_done.rbi +47 -34
- data/rbi/openai/models/realtime/conversation_item_input_audio_transcription_completed_event.rbi +120 -81
- data/rbi/openai/models/realtime/conversation_item_input_audio_transcription_delta_event.rbi +29 -13
- data/rbi/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rbi +48 -32
- data/rbi/openai/models/realtime/conversation_item_input_audio_transcription_segment.rbi +33 -8
- data/rbi/openai/models/realtime/conversation_item_retrieve_event.rbi +27 -10
- data/rbi/openai/models/realtime/conversation_item_truncate_event.rbi +26 -15
- data/rbi/openai/models/realtime/conversation_item_truncated_event.rbi +26 -15
- data/rbi/openai/models/realtime/conversation_item_with_reference.rbi +120 -270
- data/rbi/openai/models/realtime/input_audio_buffer_append_event.rbi +27 -10
- data/rbi/openai/models/realtime/input_audio_buffer_clear_event.rbi +29 -9
- data/rbi/openai/models/realtime/input_audio_buffer_cleared_event.rbi +29 -9
- data/rbi/openai/models/realtime/input_audio_buffer_commit_event.rbi +29 -9
- data/rbi/openai/models/realtime/input_audio_buffer_committed_event.rbi +24 -14
- data/rbi/openai/models/realtime/input_audio_buffer_dtmf_event_received_event.rbi +25 -10
- data/rbi/openai/models/realtime/input_audio_buffer_speech_started_event.rbi +24 -14
- data/rbi/openai/models/realtime/input_audio_buffer_speech_stopped_event.rbi +24 -14
- data/rbi/openai/models/realtime/input_audio_buffer_timeout_triggered.rbi +26 -15
- data/rbi/openai/models/realtime/log_prob_properties.rbi +22 -9
- data/rbi/openai/models/realtime/mcp_list_tools_completed.rbi +27 -10
- data/rbi/openai/models/realtime/mcp_list_tools_failed.rbi +27 -10
- data/rbi/openai/models/realtime/mcp_list_tools_in_progress.rbi +27 -10
- data/rbi/openai/models/realtime/noise_reduction_type.rbi +8 -11
- data/rbi/openai/models/realtime/output_audio_buffer_clear_event.rbi +29 -9
- data/rbi/openai/models/realtime/rate_limits_updated_event.rbi +50 -71
- data/rbi/openai/models/realtime/realtime_audio_config.rbi +25 -21
- data/rbi/openai/models/realtime/realtime_audio_config_input.rbi +76 -82
- data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +106 -131
- data/rbi/openai/models/realtime/realtime_audio_formats.rbi +78 -187
- data/rbi/openai/models/realtime/realtime_audio_input_turn_detection.rbi +72 -77
- data/rbi/openai/models/realtime/realtime_client_event.rbi +20 -20
- data/rbi/openai/models/realtime/realtime_conversation_item_assistant_message.rbi +104 -151
- data/rbi/openai/models/realtime/realtime_conversation_item_function_call.rbi +57 -92
- data/rbi/openai/models/realtime/realtime_conversation_item_function_call_output.rbi +63 -86
- data/rbi/openai/models/realtime/realtime_conversation_item_system_message.rbi +86 -149
- data/rbi/openai/models/realtime/realtime_conversation_item_user_message.rbi +108 -200
- data/rbi/openai/models/realtime/realtime_error.rbi +25 -5
- data/rbi/openai/models/realtime/realtime_error_event.rbi +22 -13
- data/rbi/openai/models/realtime/realtime_function_tool.rbi +29 -35
- data/rbi/openai/models/realtime/realtime_mcp_approval_request.rbi +26 -15
- data/rbi/openai/models/realtime/realtime_mcp_approval_response.rbi +26 -15
- data/rbi/openai/models/realtime/realtime_mcp_list_tools.rbi +42 -18
- data/rbi/openai/models/realtime/realtime_mcp_protocol_error.rbi +31 -11
- data/rbi/openai/models/realtime/realtime_mcp_tool_call.rbi +56 -39
- data/rbi/openai/models/realtime/realtime_mcp_tool_execution_error.rbi +32 -10
- data/rbi/openai/models/realtime/realtime_mcphttp_error.rbi +31 -11
- data/rbi/openai/models/realtime/realtime_reasoning.rbi +20 -19
- data/rbi/openai/models/realtime/realtime_reasoning_effort.rbi +12 -26
- data/rbi/openai/models/realtime/realtime_response.rbi +185 -334
- data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +121 -160
- data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +226 -266
- data/rbi/openai/models/realtime/realtime_response_create_params.rbi +176 -269
- data/rbi/openai/models/realtime/realtime_response_status.rbi +64 -111
- data/rbi/openai/models/realtime/realtime_response_usage.rbi +33 -38
- data/rbi/openai/models/realtime/realtime_response_usage_input_token_details.rbi +50 -37
- data/rbi/openai/models/realtime/realtime_response_usage_output_token_details.rbi +24 -10
- data/rbi/openai/models/realtime/realtime_server_event.rbi +154 -118
- data/rbi/openai/models/realtime/realtime_session.rbi +313 -579
- data/rbi/openai/models/realtime/realtime_session_create_request.rbi +211 -362
- data/rbi/openai/models/realtime/realtime_session_create_response.rbi +736 -979
- data/rbi/openai/models/realtime/realtime_tool_choice_config.rbi +12 -12
- data/rbi/openai/models/realtime/realtime_tools_config.rbi +8 -7
- data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +235 -277
- data/rbi/openai/models/realtime/realtime_tracing_config.rbi +28 -20
- data/rbi/openai/models/realtime/realtime_transcription_session_audio.rbi +21 -21
- data/rbi/openai/models/realtime/realtime_transcription_session_audio_input.rbi +78 -82
- data/rbi/openai/models/realtime/realtime_transcription_session_audio_input_turn_detection.rbi +86 -68
- data/rbi/openai/models/realtime/realtime_transcription_session_create_request.rbi +41 -60
- data/rbi/openai/models/realtime/realtime_transcription_session_create_response.rbi +134 -183
- data/rbi/openai/models/realtime/realtime_transcription_session_turn_detection.rbi +25 -16
- data/rbi/openai/models/realtime/realtime_translation_client_event.rbi +12 -12
- data/rbi/openai/models/realtime/realtime_translation_client_secret_create_request.rbi +62 -74
- data/rbi/openai/models/realtime/realtime_translation_client_secret_create_response.rbi +23 -18
- data/rbi/openai/models/realtime/realtime_translation_input_audio_buffer_append_event.rbi +27 -10
- data/rbi/openai/models/realtime/realtime_translation_input_transcript_delta_event.rbi +24 -14
- data/rbi/openai/models/realtime/realtime_translation_output_audio_delta_event.rbi +44 -47
- data/rbi/openai/models/realtime/realtime_translation_output_transcript_delta_event.rbi +24 -14
- data/rbi/openai/models/realtime/realtime_translation_server_event.rbi +16 -16
- data/rbi/openai/models/realtime/realtime_translation_session.rbi +141 -134
- data/rbi/openai/models/realtime/realtime_translation_session_close_event.rbi +29 -9
- data/rbi/openai/models/realtime/realtime_translation_session_closed_event.rbi +29 -9
- data/rbi/openai/models/realtime/realtime_translation_session_create_request.rbi +146 -147
- data/rbi/openai/models/realtime/realtime_translation_session_created_event.rbi +23 -18
- data/rbi/openai/models/realtime/realtime_translation_session_update_event.rbi +25 -25
- data/rbi/openai/models/realtime/realtime_translation_session_update_request.rbi +143 -145
- data/rbi/openai/models/realtime/realtime_translation_session_updated_event.rbi +23 -18
- data/rbi/openai/models/realtime/realtime_truncation.rbi +20 -36
- data/rbi/openai/models/realtime/realtime_truncation_retention_ratio.rbi +46 -34
- data/rbi/openai/models/realtime/response_audio_delta_event.rbi +29 -8
- data/rbi/openai/models/realtime/response_audio_done_event.rbi +27 -8
- data/rbi/openai/models/realtime/response_audio_transcript_delta_event.rbi +29 -8
- data/rbi/openai/models/realtime/response_audio_transcript_done_event.rbi +29 -8
- data/rbi/openai/models/realtime/response_cancel_event.rbi +25 -10
- data/rbi/openai/models/realtime/response_content_part_added_event.rbi +58 -63
- data/rbi/openai/models/realtime/response_content_part_done_event.rbi +58 -63
- data/rbi/openai/models/realtime/response_create_event.rbi +24 -21
- data/rbi/openai/models/realtime/response_created_event.rbi +23 -16
- data/rbi/openai/models/realtime/response_done_event.rbi +23 -16
- data/rbi/openai/models/realtime/response_function_call_arguments_delta_event.rbi +29 -8
- data/rbi/openai/models/realtime/response_function_call_arguments_done_event.rbi +31 -8
- data/rbi/openai/models/realtime/response_mcp_call_arguments_delta.rbi +29 -8
- data/rbi/openai/models/realtime/response_mcp_call_arguments_done.rbi +27 -8
- data/rbi/openai/models/realtime/response_mcp_call_completed.rbi +24 -14
- data/rbi/openai/models/realtime/response_mcp_call_failed.rbi +24 -14
- data/rbi/openai/models/realtime/response_mcp_call_in_progress.rbi +24 -14
- data/rbi/openai/models/realtime/response_output_item_added_event.rbi +49 -34
- data/rbi/openai/models/realtime/response_output_item_done_event.rbi +49 -34
- data/rbi/openai/models/realtime/response_text_delta_event.rbi +29 -8
- data/rbi/openai/models/realtime/response_text_done_event.rbi +29 -8
- data/rbi/openai/models/realtime/session_created_event.rbi +39 -32
- data/rbi/openai/models/realtime/session_update_event.rbi +39 -32
- data/rbi/openai/models/realtime/session_updated_event.rbi +39 -32
- data/rbi/openai/models/realtime/transcription_session_update.rbi +150 -214
- data/rbi/openai/models/realtime/transcription_session_updated_event.rbi +118 -141
- data/rbi/openai/models/reasoning.rbi +43 -40
- data/rbi/openai/models/reasoning_effort.rbi +2 -0
- data/rbi/openai/models/response_format_json_object.rbi +24 -6
- data/rbi/openai/models/response_format_json_schema.rbi +42 -34
- data/rbi/openai/models/response_format_text.rbi +24 -6
- data/rbi/openai/models/response_format_text_grammar.rbi +27 -6
- data/rbi/openai/models/response_format_text_python.rbi +24 -6
- data/rbi/openai/models/responses/apply_patch_tool.rbi +27 -48
- data/rbi/openai/models/responses/compacted_response.rbi +58 -44
- data/rbi/openai/models/responses/computer_action.rbi +234 -163
- data/rbi/openai/models/responses/computer_action_list.rbi +8 -7
- data/rbi/openai/models/responses/computer_tool.rbi +26 -6
- data/rbi/openai/models/responses/computer_use_preview_tool.rbi +34 -57
- data/rbi/openai/models/responses/container_auto.rbi +68 -131
- data/rbi/openai/models/responses/container_network_policy_allowlist.rbi +25 -29
- data/rbi/openai/models/responses/container_network_policy_disabled.rbi +26 -9
- data/rbi/openai/models/responses/container_network_policy_domain_secret.rbi +27 -10
- data/rbi/openai/models/responses/container_reference.rbi +27 -9
- data/rbi/openai/models/responses/custom_tool.rbi +43 -72
- data/rbi/openai/models/responses/easy_input_message.rbi +47 -102
- data/rbi/openai/models/responses/file_search_tool.rbi +83 -117
- data/rbi/openai/models/responses/function_shell_tool.rbi +52 -82
- data/rbi/openai/models/responses/function_tool.rbi +39 -46
- data/rbi/openai/models/responses/inline_skill.rbi +25 -14
- data/rbi/openai/models/responses/inline_skill_source.rbi +27 -10
- data/rbi/openai/models/responses/input_item_list_params.rbi +36 -52
- data/rbi/openai/models/responses/input_token_count_params.rbi +230 -360
- data/rbi/openai/models/responses/input_token_count_response.rbi +29 -11
- data/rbi/openai/models/responses/local_environment.rbi +21 -12
- data/rbi/openai/models/responses/local_skill.rbi +27 -7
- data/rbi/openai/models/responses/mcp_tool_call_error.rbi +88 -43
- data/rbi/openai/models/responses/namespace_tool.rbi +77 -90
- data/rbi/openai/models/responses/response.rbi +487 -583
- data/rbi/openai/models/responses/response_apply_patch_tool_call.rbi +175 -144
- data/rbi/openai/models/responses/response_apply_patch_tool_call_output.rbi +94 -90
- data/rbi/openai/models/responses/response_audio_delta_event.rbi +25 -10
- data/rbi/openai/models/responses/response_audio_done_event.rbi +26 -10
- data/rbi/openai/models/responses/response_audio_transcript_delta_event.rbi +25 -10
- data/rbi/openai/models/responses/response_audio_transcript_done_event.rbi +26 -10
- data/rbi/openai/models/responses/response_cancel_params.rbi +23 -10
- data/rbi/openai/models/responses/response_code_interpreter_call_code_delta_event.rbi +26 -15
- data/rbi/openai/models/responses/response_code_interpreter_call_code_done_event.rbi +26 -15
- data/rbi/openai/models/responses/response_code_interpreter_call_completed_event.rbi +24 -14
- data/rbi/openai/models/responses/response_code_interpreter_call_in_progress_event.rbi +24 -14
- data/rbi/openai/models/responses/response_code_interpreter_call_interpreting_event.rbi +24 -14
- data/rbi/openai/models/responses/response_code_interpreter_tool_call.rbi +109 -106
- data/rbi/openai/models/responses/response_compact_params.rbi +371 -791
- data/rbi/openai/models/responses/response_compaction_item.rbi +24 -14
- data/rbi/openai/models/responses/response_compaction_item_param.rbi +22 -9
- data/rbi/openai/models/responses/response_completed_event.rbi +22 -13
- data/rbi/openai/models/responses/response_computer_tool_call.rbi +381 -352
- data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi +77 -101
- data/rbi/openai/models/responses/response_computer_tool_call_output_screenshot.rbi +27 -10
- data/rbi/openai/models/responses/response_container_reference.rbi +27 -9
- data/rbi/openai/models/responses/response_content.rbi +39 -24
- data/rbi/openai/models/responses/response_content_part_added_event.rbi +66 -44
- data/rbi/openai/models/responses/response_content_part_done_event.rbi +66 -44
- data/rbi/openai/models/responses/response_conversation_param.rbi +26 -9
- data/rbi/openai/models/responses/response_create_params.rbi +464 -737
- data/rbi/openai/models/responses/response_created_event.rbi +22 -13
- data/rbi/openai/models/responses/response_custom_tool_call.rbi +93 -55
- data/rbi/openai/models/responses/response_custom_tool_call_input_delta_event.rbi +26 -15
- data/rbi/openai/models/responses/response_custom_tool_call_input_done_event.rbi +26 -15
- data/rbi/openai/models/responses/response_custom_tool_call_item.rbi +78 -49
- data/rbi/openai/models/responses/response_custom_tool_call_output.rbi +115 -99
- data/rbi/openai/models/responses/response_custom_tool_call_output_item.rbi +67 -49
- data/rbi/openai/models/responses/response_delete_params.rbi +23 -10
- data/rbi/openai/models/responses/response_error.rbi +55 -119
- data/rbi/openai/models/responses/response_error_event.rbi +26 -15
- data/rbi/openai/models/responses/response_failed_event.rbi +22 -13
- data/rbi/openai/models/responses/response_file_search_call_completed_event.rbi +24 -14
- data/rbi/openai/models/responses/response_file_search_call_in_progress_event.rbi +24 -14
- data/rbi/openai/models/responses/response_file_search_call_searching_event.rbi +24 -14
- data/rbi/openai/models/responses/response_file_search_tool_call.rbi +70 -112
- data/rbi/openai/models/responses/response_format_text_config.rbi +12 -12
- data/rbi/openai/models/responses/response_format_text_json_schema_config.rbi +25 -8
- data/rbi/openai/models/responses/response_function_call_arguments_delta_event.rbi +26 -15
- data/rbi/openai/models/responses/response_function_call_arguments_done_event.rbi +26 -8
- data/rbi/openai/models/responses/response_function_call_output_item.rbi +12 -14
- data/rbi/openai/models/responses/response_function_call_output_item_list.rbi +8 -7
- data/rbi/openai/models/responses/response_function_shell_call_output_content.rbi +82 -50
- data/rbi/openai/models/responses/response_function_shell_tool_call.rbi +130 -151
- data/rbi/openai/models/responses/response_function_shell_tool_call_output.rbi +178 -159
- data/rbi/openai/models/responses/response_function_tool_call.rbi +104 -98
- data/rbi/openai/models/responses/response_function_tool_call_item.rbi +78 -49
- data/rbi/openai/models/responses/response_function_tool_call_output_item.rbi +138 -147
- data/rbi/openai/models/responses/response_function_web_search.rbi +127 -131
- data/rbi/openai/models/responses/response_image_gen_call_completed_event.rbi +24 -14
- data/rbi/openai/models/responses/response_image_gen_call_generating_event.rbi +24 -14
- data/rbi/openai/models/responses/response_image_gen_call_in_progress_event.rbi +24 -14
- data/rbi/openai/models/responses/response_image_gen_call_partial_image_event.rbi +80 -9
- data/rbi/openai/models/responses/response_in_progress_event.rbi +22 -13
- data/rbi/openai/models/responses/response_includable.rbi +35 -47
- data/rbi/openai/models/responses/response_incomplete_event.rbi +22 -13
- data/rbi/openai/models/responses/response_input.rbi +8 -7
- data/rbi/openai/models/responses/response_input_audio.rbi +43 -65
- data/rbi/openai/models/responses/response_input_content.rbi +12 -12
- data/rbi/openai/models/responses/response_input_file.rbi +63 -70
- data/rbi/openai/models/responses/response_input_file_content.rbi +71 -82
- data/rbi/openai/models/responses/response_input_image.rbi +58 -65
- data/rbi/openai/models/responses/response_input_image_content.rbi +67 -88
- data/rbi/openai/models/responses/response_input_item.rbi +1275 -1478
- data/rbi/openai/models/responses/response_input_message_content_list.rbi +8 -7
- data/rbi/openai/models/responses/response_input_message_item.rbi +52 -99
- data/rbi/openai/models/responses/response_input_text.rbi +48 -34
- data/rbi/openai/models/responses/response_input_text_content.rbi +54 -39
- data/rbi/openai/models/responses/response_item.rbi +385 -486
- data/rbi/openai/models/responses/response_item_list.rbi +58 -42
- data/rbi/openai/models/responses/response_local_environment.rbi +26 -9
- data/rbi/openai/models/responses/response_mcp_call_arguments_delta_event.rbi +26 -15
- data/rbi/openai/models/responses/response_mcp_call_arguments_done_event.rbi +26 -15
- data/rbi/openai/models/responses/response_mcp_call_completed_event.rbi +24 -14
- data/rbi/openai/models/responses/response_mcp_call_failed_event.rbi +24 -14
- data/rbi/openai/models/responses/response_mcp_call_in_progress_event.rbi +24 -14
- data/rbi/openai/models/responses/response_mcp_list_tools_completed_event.rbi +24 -14
- data/rbi/openai/models/responses/response_mcp_list_tools_failed_event.rbi +24 -14
- data/rbi/openai/models/responses/response_mcp_list_tools_in_progress_event.rbi +24 -14
- data/rbi/openai/models/responses/response_output_audio.rbi +27 -10
- data/rbi/openai/models/responses/response_output_item.rbi +413 -495
- data/rbi/openai/models/responses/response_output_item_added_event.rbi +53 -39
- data/rbi/openai/models/responses/response_output_item_done_event.rbi +53 -39
- data/rbi/openai/models/responses/response_output_message.rbi +56 -114
- data/rbi/openai/models/responses/response_output_refusal.rbi +29 -9
- data/rbi/openai/models/responses/response_output_text.rbi +180 -136
- data/rbi/openai/models/responses/response_output_text_annotation_added_event.rbi +130 -88
- data/rbi/openai/models/responses/response_prompt.rbi +55 -45
- data/rbi/openai/models/responses/response_queued_event.rbi +22 -13
- data/rbi/openai/models/responses/response_reasoning_item.rbi +89 -94
- data/rbi/openai/models/responses/response_reasoning_summary_part_added_event.rbi +55 -32
- data/rbi/openai/models/responses/response_reasoning_summary_part_done_event.rbi +71 -68
- data/rbi/openai/models/responses/response_reasoning_summary_text_delta_event.rbi +27 -8
- data/rbi/openai/models/responses/response_reasoning_summary_text_done_event.rbi +27 -8
- data/rbi/openai/models/responses/response_reasoning_text_delta_event.rbi +27 -8
- data/rbi/openai/models/responses/response_reasoning_text_done_event.rbi +27 -8
- data/rbi/openai/models/responses/response_refusal_delta_event.rbi +27 -8
- data/rbi/openai/models/responses/response_refusal_done_event.rbi +27 -8
- data/rbi/openai/models/responses/response_retrieve_params.rbi +27 -20
- data/rbi/openai/models/responses/response_shell_call_command_added_event.rbi +86 -0
- data/rbi/openai/models/responses/response_shell_call_command_delta_event.rbi +105 -0
- data/rbi/openai/models/responses/response_shell_call_command_done_event.rbi +86 -0
- data/rbi/openai/models/responses/response_shell_call_output_content_delta_event.rbi +158 -0
- data/rbi/openai/models/responses/response_shell_call_output_content_done_event.rbi +286 -0
- data/rbi/openai/models/responses/response_status.rbi +10 -15
- data/rbi/openai/models/responses/response_stream_event.rbi +67 -62
- data/rbi/openai/models/responses/response_text_config.rbi +48 -72
- data/rbi/openai/models/responses/response_text_delta_event.rbi +75 -59
- data/rbi/openai/models/responses/response_text_done_event.rbi +75 -59
- data/rbi/openai/models/responses/response_tool_search_call.rbi +45 -76
- data/rbi/openai/models/responses/response_tool_search_output_item.rbi +66 -102
- data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +93 -139
- data/rbi/openai/models/responses/response_usage.rbi +69 -44
- data/rbi/openai/models/responses/response_web_search_call_completed_event.rbi +24 -14
- data/rbi/openai/models/responses/response_web_search_call_in_progress_event.rbi +24 -14
- data/rbi/openai/models/responses/response_web_search_call_searching_event.rbi +24 -14
- data/rbi/openai/models/responses/responses_client_event.rbi +462 -731
- data/rbi/openai/models/responses/responses_server_event.rbi +2060 -1103
- data/rbi/openai/models/responses/skill_reference.rbi +27 -7
- data/rbi/openai/models/responses/tool.rbi +535 -941
- data/rbi/openai/models/responses/tool_choice_allowed.rbi +26 -28
- data/rbi/openai/models/responses/tool_choice_apply_patch.rbi +26 -9
- data/rbi/openai/models/responses/tool_choice_custom.rbi +29 -9
- data/rbi/openai/models/responses/tool_choice_function.rbi +29 -9
- data/rbi/openai/models/responses/tool_choice_mcp.rbi +22 -6
- data/rbi/openai/models/responses/tool_choice_options.rbi +7 -9
- data/rbi/openai/models/responses/tool_choice_shell.rbi +26 -6
- data/rbi/openai/models/responses/tool_choice_types.rbi +32 -56
- data/rbi/openai/models/responses/tool_search_tool.rbi +30 -37
- data/rbi/openai/models/responses/web_search_preview_tool.rbi +74 -151
- data/rbi/openai/models/responses/web_search_tool.rbi +87 -143
- data/rbi/openai/models/responses_model.rbi +52 -112
- data/rbi/openai/models/skill.rbi +27 -2
- data/rbi/openai/models/skill_create_params.rbi +23 -17
- data/rbi/openai/models/skill_delete_params.rbi +21 -7
- data/rbi/openai/models/skill_list.rbi +23 -3
- data/rbi/openai/models/skill_list_params.rbi +22 -12
- data/rbi/openai/models/skill_retrieve_params.rbi +21 -7
- data/rbi/openai/models/skill_update_params.rbi +19 -10
- data/rbi/openai/models/skills/content_retrieve_params.rbi +23 -10
- data/rbi/openai/models/skills/deleted_skill_version.rbi +23 -9
- data/rbi/openai/models/skills/skill_version.rbi +29 -5
- data/rbi/openai/models/skills/skill_version_list.rbi +25 -5
- data/rbi/openai/models/skills/version_create_params.rbi +30 -30
- data/rbi/openai/models/skills/version_delete_params.rbi +21 -13
- data/rbi/openai/models/skills/version_list_params.rbi +30 -24
- data/rbi/openai/models/skills/version_retrieve_params.rbi +21 -13
- data/rbi/openai/models/skills/versions/content_retrieve_params.rbi +23 -13
- data/rbi/openai/models/static_file_chunking_strategy.rbi +18 -6
- data/rbi/openai/models/static_file_chunking_strategy_object.rbi +18 -9
- data/rbi/openai/models/static_file_chunking_strategy_object_param.rbi +18 -9
- data/rbi/openai/models/upload.rbi +31 -2
- data/rbi/openai/models/upload_cancel_params.rbi +21 -7
- data/rbi/openai/models/upload_complete_params.rbi +21 -11
- data/rbi/openai/models/upload_create_params.rbi +47 -19
- data/rbi/openai/models/uploads/part_create_params.rbi +21 -10
- data/rbi/openai/models/uploads/upload_part.rbi +24 -11
- data/rbi/openai/models/vector_store.rbi +84 -31
- data/rbi/openai/models/vector_store_create_params.rbi +70 -47
- data/rbi/openai/models/vector_store_delete_params.rbi +21 -7
- data/rbi/openai/models/vector_store_deleted.rbi +29 -8
- data/rbi/openai/models/vector_store_list_params.rbi +24 -12
- data/rbi/openai/models/vector_store_retrieve_params.rbi +21 -7
- data/rbi/openai/models/vector_store_search_params.rbi +66 -112
- data/rbi/openai/models/vector_store_search_response.rbi +51 -88
- data/rbi/openai/models/vector_store_update_params.rbi +49 -24
- data/rbi/openai/models/vector_stores/file_batch_cancel_params.rbi +26 -14
- data/rbi/openai/models/vector_stores/file_batch_create_params.rbi +99 -151
- data/rbi/openai/models/vector_stores/file_batch_list_files_params.rbi +50 -102
- data/rbi/openai/models/vector_stores/file_batch_retrieve_params.rbi +26 -14
- data/rbi/openai/models/vector_stores/file_content_params.rbi +26 -14
- data/rbi/openai/models/vector_stores/file_content_response.rbi +29 -9
- data/rbi/openai/models/vector_stores/file_create_params.rbi +48 -65
- data/rbi/openai/models/vector_stores/file_delete_params.rbi +26 -14
- data/rbi/openai/models/vector_stores/file_list_params.rbi +44 -82
- data/rbi/openai/models/vector_stores/file_retrieve_params.rbi +26 -14
- data/rbi/openai/models/vector_stores/file_update_params.rbi +27 -39
- data/rbi/openai/models/vector_stores/vector_store_file.rbi +87 -155
- data/rbi/openai/models/vector_stores/vector_store_file_batch.rbi +60 -73
- data/rbi/openai/models/vector_stores/vector_store_file_deleted.rbi +31 -11
- data/rbi/openai/models/video.rbi +41 -4
- data/rbi/openai/models/video_create_character_params.rbi +19 -10
- data/rbi/openai/models/video_create_character_response.rbi +20 -13
- data/rbi/openai/models/video_create_error.rbi +27 -6
- data/rbi/openai/models/video_create_params.rbi +33 -38
- data/rbi/openai/models/video_delete_params.rbi +21 -7
- data/rbi/openai/models/video_delete_response.rbi +25 -7
- data/rbi/openai/models/video_download_content_params.rbi +26 -40
- data/rbi/openai/models/video_edit_params.rbi +44 -41
- data/rbi/openai/models/video_extend_params.rbi +46 -41
- data/rbi/openai/models/video_get_character_params.rbi +21 -7
- data/rbi/openai/models/video_get_character_response.rbi +20 -13
- data/rbi/openai/models/video_list_params.rbi +22 -12
- data/rbi/openai/models/video_model.rbi +16 -9
- data/rbi/openai/models/video_remix_params.rbi +19 -10
- data/rbi/openai/models/video_retrieve_params.rbi +21 -7
- data/rbi/openai/models/video_seconds.rbi +2 -0
- data/rbi/openai/models/video_size.rbi +4 -4
- data/rbi/openai/models/webhooks/batch_cancelled_webhook_event.rbi +54 -58
- data/rbi/openai/models/webhooks/batch_completed_webhook_event.rbi +54 -58
- data/rbi/openai/models/webhooks/batch_expired_webhook_event.rbi +54 -54
- data/rbi/openai/models/webhooks/batch_failed_webhook_event.rbi +53 -52
- data/rbi/openai/models/webhooks/eval_run_canceled_webhook_event.rbi +54 -58
- data/rbi/openai/models/webhooks/eval_run_failed_webhook_event.rbi +54 -55
- data/rbi/openai/models/webhooks/eval_run_succeeded_webhook_event.rbi +54 -58
- data/rbi/openai/models/webhooks/fine_tuning_job_cancelled_webhook_event.rbi +58 -64
- data/rbi/openai/models/webhooks/fine_tuning_job_failed_webhook_event.rbi +55 -61
- data/rbi/openai/models/webhooks/fine_tuning_job_succeeded_webhook_event.rbi +58 -64
- data/rbi/openai/models/webhooks/live_call_incoming_webhook_event.rbi +71 -81
- data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi +73 -87
- data/rbi/openai/models/webhooks/response_cancelled_webhook_event.rbi +54 -58
- data/rbi/openai/models/webhooks/response_completed_webhook_event.rbi +54 -58
- data/rbi/openai/models/webhooks/response_failed_webhook_event.rbi +54 -58
- data/rbi/openai/models/webhooks/response_incomplete_webhook_event.rbi +55 -60
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +25 -25
- data/rbi/openai/models/webhooks/webhook_unwrap_params.rbi +13 -8
- data/rbi/openai/models.rbi +8 -12
- data/rbi/openai/net_http_client.rbi +25 -9
- data/rbi/openai/providers.rbi +6 -3
- data/rbi/openai/request_options.rbi +2 -2
- data/rbi/openai/resources/admin/organization/admin_api_keys.rbi +22 -27
- data/rbi/openai/resources/admin/organization/audit_logs.rbi +14 -12
- data/rbi/openai/resources/admin/organization/certificates.rbi +39 -53
- data/rbi/openai/resources/admin/organization/data_retention.rbi +14 -7
- data/rbi/openai/resources/admin/organization/groups/roles.rbi +24 -29
- data/rbi/openai/resources/admin/organization/groups/users.rbi +22 -29
- data/rbi/openai/resources/admin/organization/groups.rbi +31 -33
- data/rbi/openai/resources/admin/organization/invites.rbi +27 -31
- data/rbi/openai/resources/admin/organization/projects/api_keys.rbi +21 -22
- data/rbi/openai/resources/admin/organization/projects/certificates.rbi +27 -20
- data/rbi/openai/resources/admin/organization/projects/data_retention.rbi +16 -12
- data/rbi/openai/resources/admin/organization/projects/groups/roles.rbi +28 -20
- data/rbi/openai/resources/admin/organization/projects/groups.rbi +26 -28
- data/rbi/openai/resources/admin/organization/projects/hosted_tool_permissions.rbi +28 -30
- data/rbi/openai/resources/admin/organization/projects/model_permissions.rbi +19 -18
- data/rbi/openai/resources/admin/organization/projects/rate_limits.rbi +18 -9
- data/rbi/openai/resources/admin/organization/projects/roles.rbi +29 -28
- data/rbi/openai/resources/admin/organization/projects/service_accounts/api_keys.rbi +14 -4
- data/rbi/openai/resources/admin/organization/projects/service_accounts.rbi +31 -45
- data/rbi/openai/resources/admin/organization/projects/spend_alerts.rbi +33 -42
- data/rbi/openai/resources/admin/organization/projects/spend_limit.rbi +20 -20
- data/rbi/openai/resources/admin/organization/projects/users/roles.rbi +28 -20
- data/rbi/openai/resources/admin/organization/projects/users.rbi +30 -37
- data/rbi/openai/resources/admin/organization/projects.rbi +51 -78
- data/rbi/openai/resources/admin/organization/roles.rbi +29 -26
- data/rbi/openai/resources/admin/organization/spend_alerts.rbi +33 -38
- data/rbi/openai/resources/admin/organization/spend_limit.rbi +17 -11
- data/rbi/openai/resources/admin/organization/usage.rbi +67 -120
- data/rbi/openai/resources/admin/organization/users/roles.rbi +22 -29
- data/rbi/openai/resources/admin/organization/users.rbi +24 -21
- data/rbi/openai/resources/admin/organization.rbi +5 -0
- data/rbi/openai/resources/admin.rbi +3 -0
- data/rbi/openai/resources/audio/speech.rbi +16 -13
- data/rbi/openai/resources/audio/transcriptions.rbi +19 -32
- data/rbi/openai/resources/audio/translations.rbi +10 -5
- data/rbi/openai/resources/audio.rbi +3 -0
- data/rbi/openai/resources/batches.rbi +16 -26
- data/rbi/openai/resources/beta/assistants.rbi +58 -68
- data/rbi/openai/resources/beta/chatkit/sessions.rbi +19 -15
- data/rbi/openai/resources/beta/chatkit/threads.rbi +26 -26
- data/rbi/openai/resources/beta/chatkit.rbi +5 -0
- data/rbi/openai/resources/beta/responses/input_items.rbi +12 -12
- data/rbi/openai/resources/beta/responses/input_tokens.rbi +51 -68
- data/rbi/openai/resources/beta/responses.rbi +131 -210
- data/rbi/openai/resources/beta/threads/messages.rbi +30 -32
- data/rbi/openai/resources/beta/threads/runs/steps.rbi +19 -19
- data/rbi/openai/resources/beta/threads/runs.rbi +93 -118
- data/rbi/openai/resources/beta/threads.rbi +71 -101
- data/rbi/openai/resources/beta.rbi +3 -0
- data/rbi/openai/resources/chat/completions/messages.rbi +11 -8
- data/rbi/openai/resources/chat/completions.rbi +99 -147
- data/rbi/openai/resources/chat.rbi +3 -0
- data/rbi/openai/resources/completions.rbi +13 -10
- data/rbi/openai/resources/containers/files/content.rbi +12 -7
- data/rbi/openai/resources/containers/files.rbi +18 -23
- data/rbi/openai/resources/containers.rbi +21 -31
- data/rbi/openai/resources/content_provenance_checks.rbi +8 -6
- data/rbi/openai/resources/conversations/items.rbi +57 -56
- data/rbi/openai/resources/conversations.rbi +59 -57
- data/rbi/openai/resources/embeddings.rbi +8 -5
- data/rbi/openai/resources/evals/runs/output_items.rbi +15 -11
- data/rbi/openai/resources/evals/runs.rbi +32 -34
- data/rbi/openai/resources/evals.rbi +37 -37
- data/rbi/openai/resources/files.rbi +29 -21
- data/rbi/openai/resources/fine_tuning/alpha/graders.rbi +29 -22
- data/rbi/openai/resources/fine_tuning/alpha.rbi +5 -0
- data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi +25 -24
- data/rbi/openai/resources/fine_tuning/checkpoints.rbi +5 -0
- data/rbi/openai/resources/fine_tuning/jobs/checkpoints.rbi +10 -6
- data/rbi/openai/resources/fine_tuning/jobs.rbi +38 -48
- data/rbi/openai/resources/fine_tuning/methods.rbi +5 -0
- data/rbi/openai/resources/fine_tuning.rbi +3 -0
- data/rbi/openai/resources/graders/grader_models.rbi +5 -0
- data/rbi/openai/resources/graders.rbi +3 -0
- data/rbi/openai/resources/images.rbi +64 -105
- data/rbi/openai/resources/models.rbi +6 -17
- data/rbi/openai/resources/moderations.rbi +7 -3
- data/rbi/openai/resources/realtime/calls.rbi +49 -60
- data/rbi/openai/resources/realtime/client_secrets.rbi +14 -10
- data/rbi/openai/resources/realtime.rbi +3 -0
- data/rbi/openai/resources/responses/input_items.rbi +8 -6
- data/rbi/openai/resources/responses/input_tokens.rbi +47 -58
- data/rbi/openai/resources/responses.rbi +162 -259
- data/rbi/openai/resources/skills/content.rbi +6 -6
- data/rbi/openai/resources/skills/versions/content.rbi +10 -7
- data/rbi/openai/resources/skills/versions.rbi +23 -20
- data/rbi/openai/resources/skills.rbi +18 -28
- data/rbi/openai/resources/uploads/parts.rbi +9 -7
- data/rbi/openai/resources/uploads.rbi +12 -12
- data/rbi/openai/resources/vector_stores/file_batches.rbi +119 -37
- data/rbi/openai/resources/vector_stores/files.rbi +138 -42
- data/rbi/openai/resources/vector_stores.rbi +33 -39
- data/rbi/openai/resources/videos.rbi +44 -62
- data/rbi/openai/resources/webhooks.rbi +35 -30
- data/rbi/openai/streaming.rbi +8 -14
- data/realtime.md +499 -0
- data/sig/openai/auth/x509_token_exchange.rbs +19 -0
- data/sig/openai/auth/x509_transport.rbs +34 -0
- data/sig/openai/auth/x509_workload_identity.rbs +24 -0
- data/sig/openai/auth.rbs +42 -0
- data/sig/openai/client.rbs +48 -2
- data/sig/openai/errors.rbs +11 -0
- data/sig/openai/file_part.rbs +9 -0
- data/sig/openai/helpers/client_options.rbs +19 -0
- data/sig/openai/helpers/data_residency.rbs +16 -0
- data/sig/openai/helpers/realtime/connection.rbs +45 -0
- data/sig/openai/helpers/realtime/connection_manager.rbs +21 -0
- data/sig/openai/helpers/realtime/connection_resources.rbs +50 -0
- data/sig/openai/helpers/realtime/extensions.rbs +83 -0
- data/sig/openai/helpers/realtime/sideband_connection.rbs +12 -0
- data/sig/openai/helpers/realtime/transports/async_websocket.rbs +37 -0
- data/sig/openai/helpers/realtime/unknown_server_event.rbs +14 -0
- data/sig/openai/helpers/resource_polling.rbs +31 -0
- data/sig/openai/helpers/sorbet.rbs +54 -0
- data/sig/openai/helpers/streaming/response_event_decoder.rbs +16 -0
- data/sig/openai/helpers/streaming/unknown_stream_event.rbs +15 -0
- data/sig/openai/helpers/structured_output/chat_completion_parser.rbs +21 -0
- data/sig/openai/helpers/structured_output/response_parser.rbs +17 -0
- data/sig/openai/internal/poller.rbs +31 -0
- data/sig/openai/internal/provider.rbs +1 -3
- data/sig/openai/internal/request_options_scope.rbs +9 -0
- data/sig/openai/internal/transport/base_client.rbs +10 -0
- data/sig/openai/internal/type/converter.rbs +7 -1
- data/sig/openai/internal/vector_store_file_uploader.rbs +18 -0
- data/sig/openai/models/admin/organization/admin_api_key_create_response.rbs +34 -3
- data/sig/openai/models/admin/organization/audit_log_list_params.rbs +2 -0
- data/sig/openai/models/admin/organization/audit_log_list_response.rbs +2 -0
- data/sig/openai/models/admin/organization/cost_quantity_unit.rbs +33 -0
- data/sig/openai/models/admin/organization/project.rbs +9 -0
- data/sig/openai/models/admin/organization/project_create_params.rbs +10 -1
- data/sig/openai/models/admin/organization/project_residency.rbs +40 -0
- data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_completions_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_costs_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_images_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_moderations_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +7 -2
- data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +7 -2
- data/sig/openai/models/beta/beta_response_custom_tool_call_item.rbs +22 -1
- data/sig/openai/models/beta/beta_response_custom_tool_call_output_item.rbs +16 -1
- data/sig/openai/models/beta/beta_response_function_tool_call_item.rbs +22 -1
- data/sig/openai/models/beta/beta_response_function_tool_call_output_item.rbs +7 -5
- data/sig/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbs +30 -2
- data/sig/openai/models/beta/beta_response_input_item.rbs +5 -5
- data/sig/openai/models/beta/beta_response_shell_call_command_added_event.rbs +63 -0
- data/sig/openai/models/beta/beta_response_shell_call_command_delta_event.rbs +70 -0
- data/sig/openai/models/beta/beta_response_shell_call_command_done_event.rbs +63 -0
- data/sig/openai/models/beta/beta_response_shell_call_output_content_delta_event.rbs +84 -0
- data/sig/openai/models/beta/beta_response_shell_call_output_content_done_event.rbs +134 -0
- data/sig/openai/models/beta/beta_response_stream_event.rbs +5 -0
- data/sig/openai/models/beta/beta_responses_server_event.rbs +318 -107
- data/sig/openai/models/chat/chat_completion.rbs +5 -0
- data/sig/openai/models/chat/chat_completion_chunk.rbs +7 -0
- data/sig/openai/models/chat/chat_completion_store_message.rbs +22 -1
- data/sig/openai/models/eval_create_params.rbs +75 -9
- data/sig/openai/models/eval_create_response.rbs +75 -9
- data/sig/openai/models/eval_list_response.rbs +75 -9
- data/sig/openai/models/eval_retrieve_response.rbs +75 -9
- data/sig/openai/models/eval_update_response.rbs +75 -9
- data/sig/openai/models/realtime/call_accept_params.rbs +46 -1
- data/sig/openai/models/realtime/call_create_params.rbs +34 -0
- data/sig/openai/models/responses/response.rbs +2 -0
- data/sig/openai/models/responses/response_custom_tool_call_item.rbs +19 -1
- data/sig/openai/models/responses/response_custom_tool_call_output_item.rbs +13 -1
- data/sig/openai/models/responses/response_function_tool_call_item.rbs +19 -1
- data/sig/openai/models/responses/response_function_tool_call_output_item.rbs +7 -5
- data/sig/openai/models/responses/response_image_gen_call_partial_image_event.rbs +30 -2
- data/sig/openai/models/responses/response_input_item.rbs +5 -5
- data/sig/openai/models/responses/response_shell_call_command_added_event.rbs +42 -0
- data/sig/openai/models/responses/response_shell_call_command_delta_event.rbs +49 -0
- data/sig/openai/models/responses/response_shell_call_command_done_event.rbs +42 -0
- data/sig/openai/models/responses/response_shell_call_output_content_delta_event.rbs +63 -0
- data/sig/openai/models/responses/response_shell_call_output_content_done_event.rbs +113 -0
- data/sig/openai/models/responses/response_stream_event.rbs +5 -0
- data/sig/openai/models/responses/responses_server_event.rbs +303 -107
- data/sig/openai/net_http_client.rbs +11 -3
- data/sig/openai/resources/admin/organization/projects.rbs +1 -0
- data/sig/openai/resources/beta/responses.rbs +4 -2
- data/sig/openai/resources/files.rbs +7 -0
- data/sig/openai/resources/realtime/calls.rbs +6 -0
- data/sig/openai/resources/responses.rbs +6 -3
- data/sig/openai/resources/vector_stores/file_batches.rbs +31 -0
- data/sig/openai/resources/vector_stores/files.rbs +36 -0
- data/sig/openai/streaming.rbs +5 -0
- metadata +121 -29
|
@@ -2,18 +2,20 @@
|
|
|
2
2
|
|
|
3
3
|
module OpenAI
|
|
4
4
|
module Models
|
|
5
|
+
|
|
5
6
|
module Chat
|
|
7
|
+
|
|
6
8
|
class CompletionCreateParams < OpenAI::Internal::Type::BaseModel
|
|
9
|
+
|
|
7
10
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
8
11
|
include OpenAI::Internal::Type::RequestParameters
|
|
9
12
|
|
|
10
|
-
OrHash =
|
|
11
|
-
T.
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
end
|
|
13
|
+
OrHash = T.type_alias do
|
|
14
|
+
T.any(
|
|
15
|
+
OpenAI::Chat::CompletionCreateParams,
|
|
16
|
+
OpenAI::Internal::AnyHash
|
|
17
|
+
)
|
|
18
|
+
end
|
|
17
19
|
|
|
18
20
|
# A list of messages comprising the conversation so far. Depending on the
|
|
19
21
|
# [model](https://platform.openai.com/docs/models) you use, different message
|
|
@@ -35,6 +37,7 @@ module OpenAI
|
|
|
35
37
|
]
|
|
36
38
|
)
|
|
37
39
|
end
|
|
40
|
+
|
|
38
41
|
attr_accessor :messages
|
|
39
42
|
|
|
40
43
|
# Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
|
|
@@ -51,11 +54,7 @@ module OpenAI
|
|
|
51
54
|
sig { returns(T.nilable(OpenAI::Chat::ChatCompletionAudioParam)) }
|
|
52
55
|
attr_reader :audio
|
|
53
56
|
|
|
54
|
-
sig
|
|
55
|
-
params(
|
|
56
|
-
audio: T.nilable(OpenAI::Chat::ChatCompletionAudioParam::OrHash)
|
|
57
|
-
).void
|
|
58
|
-
end
|
|
57
|
+
sig { params(audio: T.nilable(OpenAI::Chat::ChatCompletionAudioParam::OrHash)).void }
|
|
59
58
|
attr_writer :audio
|
|
60
59
|
|
|
61
60
|
# Number between -2.0 and 2.0. Positive values penalize new tokens based on their
|
|
@@ -88,35 +87,28 @@ module OpenAI
|
|
|
88
87
|
)
|
|
89
88
|
)
|
|
90
89
|
end
|
|
90
|
+
|
|
91
91
|
attr_reader :function_call
|
|
92
92
|
|
|
93
93
|
sig do
|
|
94
94
|
params(
|
|
95
|
-
function_call:
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
95
|
+
function_call: T.any(
|
|
96
|
+
OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::OrSymbol,
|
|
97
|
+
OpenAI::Chat::ChatCompletionFunctionCallOption::OrHash
|
|
98
|
+
)
|
|
99
|
+
)
|
|
100
|
+
.void
|
|
101
101
|
end
|
|
102
|
+
|
|
102
103
|
attr_writer :function_call
|
|
103
104
|
|
|
104
105
|
# Deprecated in favor of `tools`.
|
|
105
106
|
#
|
|
106
107
|
# A list of functions the model may generate JSON inputs for.
|
|
107
|
-
sig
|
|
108
|
-
returns(
|
|
109
|
-
T.nilable(T::Array[OpenAI::Chat::CompletionCreateParams::Function])
|
|
110
|
-
)
|
|
111
|
-
end
|
|
108
|
+
sig { returns(T.nilable(T::Array[OpenAI::Chat::CompletionCreateParams::Function])) }
|
|
112
109
|
attr_reader :functions
|
|
113
110
|
|
|
114
|
-
sig
|
|
115
|
-
params(
|
|
116
|
-
functions:
|
|
117
|
-
T::Array[OpenAI::Chat::CompletionCreateParams::Function::OrHash]
|
|
118
|
-
).void
|
|
119
|
-
end
|
|
111
|
+
sig { params(functions: T::Array[OpenAI::Chat::CompletionCreateParams::Function::OrHash]).void }
|
|
120
112
|
attr_writer :functions
|
|
121
113
|
|
|
122
114
|
# Modify the likelihood of specified tokens appearing in the completion.
|
|
@@ -171,29 +163,14 @@ module OpenAI
|
|
|
171
163
|
# this model generate both text and audio responses, you can use:
|
|
172
164
|
#
|
|
173
165
|
# `["text", "audio"]`
|
|
174
|
-
sig
|
|
175
|
-
returns(
|
|
176
|
-
T.nilable(
|
|
177
|
-
T::Array[OpenAI::Chat::CompletionCreateParams::Modality::OrSymbol]
|
|
178
|
-
)
|
|
179
|
-
)
|
|
180
|
-
end
|
|
166
|
+
sig { returns(T.nilable(T::Array[OpenAI::Chat::CompletionCreateParams::Modality::OrSymbol])) }
|
|
181
167
|
attr_accessor :modalities
|
|
182
168
|
|
|
183
169
|
# Configuration for running moderation on the request input and generated output.
|
|
184
|
-
sig
|
|
185
|
-
returns(T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation))
|
|
186
|
-
end
|
|
170
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation)) }
|
|
187
171
|
attr_reader :moderation
|
|
188
172
|
|
|
189
|
-
sig
|
|
190
|
-
params(
|
|
191
|
-
moderation:
|
|
192
|
-
T.nilable(
|
|
193
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::OrHash
|
|
194
|
-
)
|
|
195
|
-
).void
|
|
196
|
-
end
|
|
173
|
+
sig { params(moderation: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::OrHash)).void }
|
|
197
174
|
attr_writer :moderation
|
|
198
175
|
|
|
199
176
|
# How many chat completion choices to generate for each input message. Note that
|
|
@@ -213,17 +190,10 @@ module OpenAI
|
|
|
213
190
|
|
|
214
191
|
# Static predicted output content, such as the content of a text file that is
|
|
215
192
|
# being regenerated.
|
|
216
|
-
sig
|
|
217
|
-
returns(T.nilable(OpenAI::Chat::ChatCompletionPredictionContent))
|
|
218
|
-
end
|
|
193
|
+
sig { returns(T.nilable(OpenAI::Chat::ChatCompletionPredictionContent)) }
|
|
219
194
|
attr_reader :prediction
|
|
220
195
|
|
|
221
|
-
sig
|
|
222
|
-
params(
|
|
223
|
-
prediction:
|
|
224
|
-
T.nilable(OpenAI::Chat::ChatCompletionPredictionContent::OrHash)
|
|
225
|
-
).void
|
|
226
|
-
end
|
|
196
|
+
sig { params(prediction: T.nilable(OpenAI::Chat::ChatCompletionPredictionContent::OrHash)).void }
|
|
227
197
|
attr_writer :prediction
|
|
228
198
|
|
|
229
199
|
# Number between -2.0 and 2.0. Positive values penalize new tokens based on
|
|
@@ -247,19 +217,10 @@ module OpenAI
|
|
|
247
217
|
# `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
248
218
|
# [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching)
|
|
249
219
|
# for current details.
|
|
250
|
-
sig
|
|
251
|
-
returns(
|
|
252
|
-
T.nilable(OpenAI::Chat::CompletionCreateParams::PromptCacheOptions)
|
|
253
|
-
)
|
|
254
|
-
end
|
|
220
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::PromptCacheOptions)) }
|
|
255
221
|
attr_reader :prompt_cache_options
|
|
256
222
|
|
|
257
|
-
sig
|
|
258
|
-
params(
|
|
259
|
-
prompt_cache_options:
|
|
260
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::OrHash
|
|
261
|
-
).void
|
|
262
|
-
end
|
|
223
|
+
sig { params(prompt_cache_options: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::OrHash).void }
|
|
263
224
|
attr_writer :prompt_cache_options
|
|
264
225
|
|
|
265
226
|
# Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
@@ -279,13 +240,7 @@ module OpenAI
|
|
|
279
240
|
# - Organizations without ZDR enabled default to `24h`.
|
|
280
241
|
# - Organizations with ZDR enabled default to `in_memory` when
|
|
281
242
|
# `prompt_cache_retention` is not specified.
|
|
282
|
-
sig
|
|
283
|
-
returns(
|
|
284
|
-
T.nilable(
|
|
285
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::OrSymbol
|
|
286
|
-
)
|
|
287
|
-
)
|
|
288
|
-
end
|
|
243
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::OrSymbol)) }
|
|
289
244
|
attr_accessor :prompt_cache_retention
|
|
290
245
|
|
|
291
246
|
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
@@ -319,19 +274,21 @@ module OpenAI
|
|
|
319
274
|
)
|
|
320
275
|
)
|
|
321
276
|
end
|
|
277
|
+
|
|
322
278
|
attr_reader :response_format
|
|
323
279
|
|
|
324
280
|
sig do
|
|
325
281
|
params(
|
|
326
|
-
response_format:
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
282
|
+
response_format: T.any(
|
|
283
|
+
OpenAI::ResponseFormatText::OrHash,
|
|
284
|
+
OpenAI::ResponseFormatJSONSchema::OrHash,
|
|
285
|
+
OpenAI::StructuredOutput::JsonSchemaConverter,
|
|
286
|
+
OpenAI::ResponseFormatJSONObject::OrHash
|
|
287
|
+
)
|
|
288
|
+
)
|
|
289
|
+
.void
|
|
334
290
|
end
|
|
291
|
+
|
|
335
292
|
attr_writer :response_format
|
|
336
293
|
|
|
337
294
|
# A stable identifier used to help detect users of your application that may be
|
|
@@ -371,24 +328,14 @@ module OpenAI
|
|
|
371
328
|
# `service_tier` value based on the processing mode actually used to serve the
|
|
372
329
|
# request. This response value may be different from the value set in the
|
|
373
330
|
# parameter.
|
|
374
|
-
sig
|
|
375
|
-
returns(
|
|
376
|
-
T.nilable(
|
|
377
|
-
OpenAI::Chat::CompletionCreateParams::ServiceTier::OrSymbol
|
|
378
|
-
)
|
|
379
|
-
)
|
|
380
|
-
end
|
|
331
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::ServiceTier::OrSymbol)) }
|
|
381
332
|
attr_accessor :service_tier
|
|
382
333
|
|
|
383
334
|
# Not supported with latest reasoning models `o3` and `o4-mini`.
|
|
384
335
|
#
|
|
385
336
|
# Up to 4 sequences where the API will stop generating further tokens. The
|
|
386
337
|
# returned text will not contain the stop sequence.
|
|
387
|
-
sig
|
|
388
|
-
returns(
|
|
389
|
-
T.nilable(OpenAI::Chat::CompletionCreateParams::Stop::Variants)
|
|
390
|
-
)
|
|
391
|
-
end
|
|
338
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::Stop::Variants)) }
|
|
392
339
|
attr_accessor :stop
|
|
393
340
|
|
|
394
341
|
# Whether or not to store the output of this chat completion request for use in
|
|
@@ -403,12 +350,7 @@ module OpenAI
|
|
|
403
350
|
sig { returns(T.nilable(OpenAI::Chat::ChatCompletionStreamOptions)) }
|
|
404
351
|
attr_reader :stream_options
|
|
405
352
|
|
|
406
|
-
sig
|
|
407
|
-
params(
|
|
408
|
-
stream_options:
|
|
409
|
-
T.nilable(OpenAI::Chat::ChatCompletionStreamOptions::OrHash)
|
|
410
|
-
).void
|
|
411
|
-
end
|
|
353
|
+
sig { params(stream_options: T.nilable(OpenAI::Chat::ChatCompletionStreamOptions::OrHash)).void }
|
|
412
354
|
attr_writer :stream_options
|
|
413
355
|
|
|
414
356
|
# What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
|
@@ -439,19 +381,21 @@ module OpenAI
|
|
|
439
381
|
)
|
|
440
382
|
)
|
|
441
383
|
end
|
|
384
|
+
|
|
442
385
|
attr_reader :tool_choice
|
|
443
386
|
|
|
444
387
|
sig do
|
|
445
388
|
params(
|
|
446
|
-
tool_choice:
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
389
|
+
tool_choice: T.any(
|
|
390
|
+
OpenAI::Chat::ChatCompletionToolChoiceOption::Auto::OrSymbol,
|
|
391
|
+
OpenAI::Chat::ChatCompletionAllowedToolChoice::OrHash,
|
|
392
|
+
OpenAI::Chat::ChatCompletionNamedToolChoice::OrHash,
|
|
393
|
+
OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::OrHash
|
|
394
|
+
)
|
|
395
|
+
)
|
|
396
|
+
.void
|
|
454
397
|
end
|
|
398
|
+
|
|
455
399
|
attr_writer :tool_choice
|
|
456
400
|
|
|
457
401
|
# A list of tools the model may call. You can provide either
|
|
@@ -459,30 +403,25 @@ module OpenAI
|
|
|
459
403
|
# or [function tools](https://platform.openai.com/docs/guides/function-calling).
|
|
460
404
|
sig do
|
|
461
405
|
returns(
|
|
462
|
-
T.nilable(
|
|
463
|
-
T::Array[
|
|
464
|
-
T.any(
|
|
465
|
-
OpenAI::Chat::ChatCompletionFunctionTool,
|
|
466
|
-
OpenAI::Chat::ChatCompletionCustomTool
|
|
467
|
-
)
|
|
468
|
-
]
|
|
469
|
-
)
|
|
406
|
+
T.nilable(T::Array[T.any(OpenAI::Chat::ChatCompletionFunctionTool, OpenAI::Chat::ChatCompletionCustomTool)])
|
|
470
407
|
)
|
|
471
408
|
end
|
|
409
|
+
|
|
472
410
|
attr_reader :tools
|
|
473
411
|
|
|
474
412
|
sig do
|
|
475
413
|
params(
|
|
476
|
-
tools:
|
|
477
|
-
T
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
414
|
+
tools: T::Array[
|
|
415
|
+
T.any(
|
|
416
|
+
OpenAI::StructuredOutput::JsonSchemaConverter,
|
|
417
|
+
OpenAI::Chat::ChatCompletionFunctionTool::OrHash,
|
|
418
|
+
OpenAI::Chat::ChatCompletionCustomTool::OrHash
|
|
419
|
+
)
|
|
420
|
+
]
|
|
421
|
+
)
|
|
422
|
+
.void
|
|
485
423
|
end
|
|
424
|
+
|
|
486
425
|
attr_writer :tools
|
|
487
426
|
|
|
488
427
|
# An integer between 0 and 20 specifying the maximum number of most likely tokens
|
|
@@ -515,129 +454,127 @@ module OpenAI
|
|
|
515
454
|
# more concise responses, while higher values will result in more verbose
|
|
516
455
|
# responses. Currently supported values are `low`, `medium`, and `high`. The
|
|
517
456
|
# default is `medium`.
|
|
518
|
-
sig
|
|
519
|
-
returns(
|
|
520
|
-
T.nilable(OpenAI::Chat::CompletionCreateParams::Verbosity::OrSymbol)
|
|
521
|
-
)
|
|
522
|
-
end
|
|
457
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::Verbosity::OrSymbol)) }
|
|
523
458
|
attr_accessor :verbosity
|
|
524
459
|
|
|
525
460
|
# This tool searches the web for relevant results to use in a response. Learn more
|
|
526
461
|
# about the
|
|
527
462
|
# [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
|
|
528
|
-
sig
|
|
529
|
-
returns(
|
|
530
|
-
T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions)
|
|
531
|
-
)
|
|
532
|
-
end
|
|
463
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions)) }
|
|
533
464
|
attr_reader :web_search_options
|
|
534
465
|
|
|
535
|
-
sig
|
|
536
|
-
params(
|
|
537
|
-
web_search_options:
|
|
538
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::OrHash
|
|
539
|
-
).void
|
|
540
|
-
end
|
|
466
|
+
sig { params(web_search_options: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::OrHash).void }
|
|
541
467
|
attr_writer :web_search_options
|
|
542
468
|
|
|
543
469
|
sig do
|
|
544
470
|
params(
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
471
|
+
|
|
472
|
+
messages: T::Array[
|
|
473
|
+
T.any(
|
|
474
|
+
OpenAI::Chat::ChatCompletionDeveloperMessageParam::OrHash,
|
|
475
|
+
OpenAI::Chat::ChatCompletionSystemMessageParam::OrHash,
|
|
476
|
+
OpenAI::Chat::ChatCompletionUserMessageParam::OrHash,
|
|
477
|
+
OpenAI::Chat::ChatCompletionAssistantMessageParam::OrHash,
|
|
478
|
+
OpenAI::Chat::ChatCompletionToolMessageParam::OrHash,
|
|
479
|
+
OpenAI::Chat::ChatCompletionFunctionMessageParam::OrHash
|
|
480
|
+
)
|
|
481
|
+
],
|
|
482
|
+
|
|
556
483
|
model: T.any(String, OpenAI::ChatModel::OrSymbol),
|
|
484
|
+
|
|
557
485
|
audio: T.nilable(OpenAI::Chat::ChatCompletionAudioParam::OrHash),
|
|
486
|
+
|
|
558
487
|
frequency_penalty: T.nilable(Float),
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
488
|
+
|
|
489
|
+
function_call: T.any(
|
|
490
|
+
OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::OrSymbol,
|
|
491
|
+
OpenAI::Chat::ChatCompletionFunctionCallOption::OrHash
|
|
492
|
+
),
|
|
493
|
+
|
|
494
|
+
functions: T::Array[OpenAI::Chat::CompletionCreateParams::Function::OrHash],
|
|
495
|
+
|
|
566
496
|
logit_bias: T.nilable(T::Hash[Symbol, Integer]),
|
|
497
|
+
|
|
567
498
|
logprobs: T.nilable(T::Boolean),
|
|
499
|
+
|
|
568
500
|
max_completion_tokens: T.nilable(Integer),
|
|
501
|
+
|
|
569
502
|
max_tokens: T.nilable(Integer),
|
|
503
|
+
|
|
570
504
|
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
),
|
|
577
|
-
moderation:
|
|
578
|
-
T.nilable(
|
|
579
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::OrHash
|
|
580
|
-
),
|
|
505
|
+
|
|
506
|
+
modalities: T.nilable(T::Array[OpenAI::Chat::CompletionCreateParams::Modality::OrSymbol]),
|
|
507
|
+
|
|
508
|
+
moderation: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::OrHash),
|
|
509
|
+
|
|
581
510
|
n: T.nilable(Integer),
|
|
511
|
+
|
|
582
512
|
parallel_tool_calls: T::Boolean,
|
|
583
|
-
|
|
584
|
-
|
|
513
|
+
|
|
514
|
+
prediction: T.nilable(OpenAI::Chat::ChatCompletionPredictionContent::OrHash),
|
|
515
|
+
|
|
585
516
|
presence_penalty: T.nilable(Float),
|
|
517
|
+
|
|
586
518
|
prompt_cache_key: T.nilable(String),
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
),
|
|
519
|
+
|
|
520
|
+
prompt_cache_options: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::OrHash,
|
|
521
|
+
|
|
522
|
+
prompt_cache_retention: T.nilable(OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::OrSymbol),
|
|
523
|
+
|
|
593
524
|
reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
525
|
+
|
|
526
|
+
response_format: T.any(
|
|
527
|
+
OpenAI::ResponseFormatText::OrHash,
|
|
528
|
+
OpenAI::ResponseFormatJSONSchema::OrHash,
|
|
529
|
+
OpenAI::StructuredOutput::JsonSchemaConverter,
|
|
530
|
+
OpenAI::ResponseFormatJSONObject::OrHash
|
|
531
|
+
),
|
|
532
|
+
|
|
601
533
|
safety_identifier: T.nilable(String),
|
|
534
|
+
|
|
602
535
|
seed: T.nilable(Integer),
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
T.nilable(OpenAI::Chat::CompletionCreateParams::Stop::Variants),
|
|
536
|
+
|
|
537
|
+
service_tier: T.nilable(OpenAI::Chat::CompletionCreateParams::ServiceTier::OrSymbol),
|
|
538
|
+
|
|
539
|
+
stop: T.nilable(OpenAI::Chat::CompletionCreateParams::Stop::Variants),
|
|
540
|
+
|
|
609
541
|
store: T.nilable(T::Boolean),
|
|
610
|
-
|
|
611
|
-
|
|
542
|
+
|
|
543
|
+
stream_options: T.nilable(OpenAI::Chat::ChatCompletionStreamOptions::OrHash),
|
|
544
|
+
|
|
612
545
|
temperature: T.nilable(Float),
|
|
613
|
-
|
|
546
|
+
|
|
547
|
+
tool_choice: T.any(
|
|
548
|
+
OpenAI::Chat::ChatCompletionToolChoiceOption::Auto::OrSymbol,
|
|
549
|
+
OpenAI::Chat::ChatCompletionAllowedToolChoice::OrHash,
|
|
550
|
+
OpenAI::Chat::ChatCompletionNamedToolChoice::OrHash,
|
|
551
|
+
OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::OrHash
|
|
552
|
+
),
|
|
553
|
+
|
|
554
|
+
tools: T::Array[
|
|
614
555
|
T.any(
|
|
615
|
-
OpenAI::
|
|
616
|
-
OpenAI::Chat::
|
|
617
|
-
OpenAI::Chat::
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
T::Array[
|
|
622
|
-
T.any(
|
|
623
|
-
OpenAI::StructuredOutput::JsonSchemaConverter,
|
|
624
|
-
OpenAI::Chat::ChatCompletionFunctionTool::OrHash,
|
|
625
|
-
OpenAI::Chat::ChatCompletionCustomTool::OrHash
|
|
626
|
-
)
|
|
627
|
-
],
|
|
556
|
+
OpenAI::StructuredOutput::JsonSchemaConverter,
|
|
557
|
+
OpenAI::Chat::ChatCompletionFunctionTool::OrHash,
|
|
558
|
+
OpenAI::Chat::ChatCompletionCustomTool::OrHash
|
|
559
|
+
)
|
|
560
|
+
],
|
|
561
|
+
|
|
628
562
|
top_logprobs: T.nilable(Integer),
|
|
563
|
+
|
|
629
564
|
top_p: T.nilable(Float),
|
|
565
|
+
|
|
630
566
|
user: String,
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::OrHash,
|
|
567
|
+
|
|
568
|
+
verbosity: T.nilable(OpenAI::Chat::CompletionCreateParams::Verbosity::OrSymbol),
|
|
569
|
+
|
|
570
|
+
web_search_options: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::OrHash,
|
|
571
|
+
|
|
637
572
|
request_options: OpenAI::RequestOptions::OrHash
|
|
638
|
-
)
|
|
573
|
+
)
|
|
574
|
+
.returns(T.attached_class)
|
|
639
575
|
end
|
|
640
576
|
def self.new(
|
|
577
|
+
|
|
641
578
|
# A list of messages comprising the conversation so far. Depending on the
|
|
642
579
|
# [model](https://platform.openai.com/docs/models) you use, different message
|
|
643
580
|
# types (modalities) are supported, like
|
|
@@ -645,20 +582,24 @@ module OpenAI
|
|
|
645
582
|
# [images](https://platform.openai.com/docs/guides/vision), and
|
|
646
583
|
# [audio](https://platform.openai.com/docs/guides/audio).
|
|
647
584
|
messages:,
|
|
585
|
+
|
|
648
586
|
# Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
|
|
649
587
|
# wide range of models with different capabilities, performance characteristics,
|
|
650
588
|
# and price points. Refer to the
|
|
651
589
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
652
590
|
# available models.
|
|
653
591
|
model:,
|
|
592
|
+
|
|
654
593
|
# Parameters for audio output. Required when audio output is requested with
|
|
655
594
|
# `modalities: ["audio"]`.
|
|
656
595
|
# [Learn more](https://platform.openai.com/docs/guides/audio).
|
|
657
596
|
audio: nil,
|
|
597
|
+
|
|
658
598
|
# Number between -2.0 and 2.0. Positive values penalize new tokens based on their
|
|
659
599
|
# existing frequency in the text so far, decreasing the model's likelihood to
|
|
660
600
|
# repeat the same line verbatim.
|
|
661
601
|
frequency_penalty: nil,
|
|
602
|
+
|
|
662
603
|
# Deprecated in favor of `tool_choice`.
|
|
663
604
|
#
|
|
664
605
|
# Controls which (if any) function is called by the model.
|
|
@@ -674,10 +615,12 @@ module OpenAI
|
|
|
674
615
|
# `none` is the default when no functions are present. `auto` is the default if
|
|
675
616
|
# functions are present.
|
|
676
617
|
function_call: nil,
|
|
618
|
+
|
|
677
619
|
# Deprecated in favor of `tools`.
|
|
678
620
|
#
|
|
679
621
|
# A list of functions the model may generate JSON inputs for.
|
|
680
622
|
functions: nil,
|
|
623
|
+
|
|
681
624
|
# Modify the likelihood of specified tokens appearing in the completion.
|
|
682
625
|
#
|
|
683
626
|
# Accepts a JSON object that maps tokens (specified by their token ID in the
|
|
@@ -687,14 +630,17 @@ module OpenAI
|
|
|
687
630
|
# increase likelihood of selection; values like -100 or 100 should result in a ban
|
|
688
631
|
# or exclusive selection of the relevant token.
|
|
689
632
|
logit_bias: nil,
|
|
633
|
+
|
|
690
634
|
# Whether to return log probabilities of the output tokens or not. If true,
|
|
691
635
|
# returns the log probabilities of each output token returned in the `content` of
|
|
692
636
|
# `message`.
|
|
693
637
|
logprobs: nil,
|
|
638
|
+
|
|
694
639
|
# An upper bound for the number of tokens that can be generated for a completion,
|
|
695
640
|
# including visible output tokens and
|
|
696
641
|
# [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
|
|
697
642
|
max_completion_tokens: nil,
|
|
643
|
+
|
|
698
644
|
# The maximum number of [tokens](/tokenizer) that can be generated in the chat
|
|
699
645
|
# completion. This value can be used to control
|
|
700
646
|
# [costs](https://openai.com/api/pricing/) for text generated via API.
|
|
@@ -703,6 +649,7 @@ module OpenAI
|
|
|
703
649
|
# compatible with
|
|
704
650
|
# [o-series models](https://platform.openai.com/docs/guides/reasoning).
|
|
705
651
|
max_tokens: nil,
|
|
652
|
+
|
|
706
653
|
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
707
654
|
# for storing additional information about the object in a structured format, and
|
|
708
655
|
# querying for objects via API or the dashboard.
|
|
@@ -710,6 +657,7 @@ module OpenAI
|
|
|
710
657
|
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
711
658
|
# a maximum length of 512 characters.
|
|
712
659
|
metadata: nil,
|
|
660
|
+
|
|
713
661
|
# Output types that you would like the model to generate. Most models are capable
|
|
714
662
|
# of generating text, which is the default:
|
|
715
663
|
#
|
|
@@ -721,27 +669,34 @@ module OpenAI
|
|
|
721
669
|
#
|
|
722
670
|
# `["text", "audio"]`
|
|
723
671
|
modalities: nil,
|
|
672
|
+
|
|
724
673
|
# Configuration for running moderation on the request input and generated output.
|
|
725
674
|
moderation: nil,
|
|
675
|
+
|
|
726
676
|
# How many chat completion choices to generate for each input message. Note that
|
|
727
677
|
# you will be charged based on the number of generated tokens across all of the
|
|
728
678
|
# choices. Keep `n` as `1` to minimize costs.
|
|
729
679
|
n: nil,
|
|
680
|
+
|
|
730
681
|
# Whether to enable
|
|
731
682
|
# [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
|
|
732
683
|
# during tool use.
|
|
733
684
|
parallel_tool_calls: nil,
|
|
685
|
+
|
|
734
686
|
# Static predicted output content, such as the content of a text file that is
|
|
735
687
|
# being regenerated.
|
|
736
688
|
prediction: nil,
|
|
689
|
+
|
|
737
690
|
# Number between -2.0 and 2.0. Positive values penalize new tokens based on
|
|
738
691
|
# whether they appear in the text so far, increasing the model's likelihood to
|
|
739
692
|
# talk about new topics.
|
|
740
693
|
presence_penalty: nil,
|
|
694
|
+
|
|
741
695
|
# Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
742
696
|
# hit rates. Replaces the `user` field.
|
|
743
697
|
# [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
|
|
744
698
|
prompt_cache_key: nil,
|
|
699
|
+
|
|
745
700
|
# Options for prompt caching. Supported for `gpt-5.6` and later models. By
|
|
746
701
|
# default, OpenAI automatically chooses one implicit cache breakpoint. You can add
|
|
747
702
|
# explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
|
|
@@ -752,6 +707,7 @@ module OpenAI
|
|
|
752
707
|
# [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching)
|
|
753
708
|
# for current details.
|
|
754
709
|
prompt_cache_options: nil,
|
|
710
|
+
|
|
755
711
|
# Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
756
712
|
#
|
|
757
713
|
# The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
@@ -770,6 +726,7 @@ module OpenAI
|
|
|
770
726
|
# - Organizations with ZDR enabled default to `in_memory` when
|
|
771
727
|
# `prompt_cache_retention` is not specified.
|
|
772
728
|
prompt_cache_retention: nil,
|
|
729
|
+
|
|
773
730
|
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
774
731
|
# are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
775
732
|
# reasoning effort can result in faster responses and fewer tokens used on
|
|
@@ -777,6 +734,7 @@ module OpenAI
|
|
|
777
734
|
# [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
|
|
778
735
|
# model-specific support.
|
|
779
736
|
reasoning_effort: nil,
|
|
737
|
+
|
|
780
738
|
# An object specifying the format that the model must output.
|
|
781
739
|
#
|
|
782
740
|
# Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
@@ -788,6 +746,7 @@ module OpenAI
|
|
|
788
746
|
# ensures the message the model generates is valid JSON. Using `json_schema` is
|
|
789
747
|
# preferred for models that support it.
|
|
790
748
|
response_format: nil,
|
|
749
|
+
|
|
791
750
|
# A stable identifier used to help detect users of your application that may be
|
|
792
751
|
# violating OpenAI's usage policies. The IDs should be a string that uniquely
|
|
793
752
|
# identifies each user, with a maximum length of 64 characters. We recommend
|
|
@@ -795,12 +754,14 @@ module OpenAI
|
|
|
795
754
|
# identifying information.
|
|
796
755
|
# [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
|
|
797
756
|
safety_identifier: nil,
|
|
757
|
+
|
|
798
758
|
# This feature is in Beta. If specified, our system will make a best effort to
|
|
799
759
|
# sample deterministically, such that repeated requests with the same `seed` and
|
|
800
760
|
# parameters should return the same result. Determinism is not guaranteed, and you
|
|
801
761
|
# should refer to the `system_fingerprint` response parameter to monitor changes
|
|
802
762
|
# in the backend.
|
|
803
763
|
seed: nil,
|
|
764
|
+
|
|
804
765
|
# Specifies the processing type used for serving the request.
|
|
805
766
|
#
|
|
806
767
|
# - If set to 'auto', then the request will be processed with the service tier
|
|
@@ -822,24 +783,29 @@ module OpenAI
|
|
|
822
783
|
# request. This response value may be different from the value set in the
|
|
823
784
|
# parameter.
|
|
824
785
|
service_tier: nil,
|
|
786
|
+
|
|
825
787
|
# Not supported with latest reasoning models `o3` and `o4-mini`.
|
|
826
788
|
#
|
|
827
789
|
# Up to 4 sequences where the API will stop generating further tokens. The
|
|
828
790
|
# returned text will not contain the stop sequence.
|
|
829
791
|
stop: nil,
|
|
792
|
+
|
|
830
793
|
# Whether or not to store the output of this chat completion request for use in
|
|
831
794
|
# our [model distillation](https://platform.openai.com/docs/guides/distillation)
|
|
832
795
|
# or [evals](https://platform.openai.com/docs/guides/evals) products.
|
|
833
796
|
#
|
|
834
797
|
# Supports text and image inputs. Note: image inputs over 8MB will be dropped.
|
|
835
798
|
store: nil,
|
|
799
|
+
|
|
836
800
|
# Options for streaming response. Only set this when you set `stream: true`.
|
|
837
801
|
stream_options: nil,
|
|
802
|
+
|
|
838
803
|
# What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
|
839
804
|
# make the output more random, while lower values like 0.2 will make it more
|
|
840
805
|
# focused and deterministic. We generally recommend altering this or `top_p` but
|
|
841
806
|
# not both.
|
|
842
807
|
temperature: nil,
|
|
808
|
+
|
|
843
809
|
# Controls which (if any) tool is called by the model. `none` means the model will
|
|
844
810
|
# not call any tool and instead generates a message. `auto` means the model can
|
|
845
811
|
# pick between generating a message or calling one or more tools. `required` means
|
|
@@ -850,36 +816,43 @@ module OpenAI
|
|
|
850
816
|
# `none` is the default when no tools are present. `auto` is the default if tools
|
|
851
817
|
# are present.
|
|
852
818
|
tool_choice: nil,
|
|
819
|
+
|
|
853
820
|
# A list of tools the model may call. You can provide either
|
|
854
821
|
# [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)
|
|
855
822
|
# or [function tools](https://platform.openai.com/docs/guides/function-calling).
|
|
856
823
|
tools: nil,
|
|
824
|
+
|
|
857
825
|
# An integer between 0 and 20 specifying the maximum number of most likely tokens
|
|
858
826
|
# to return at each token position, each with an associated log probability. In
|
|
859
827
|
# some cases, the number of returned tokens may be fewer than requested.
|
|
860
828
|
# `logprobs` must be set to `true` if this parameter is used.
|
|
861
829
|
top_logprobs: nil,
|
|
830
|
+
|
|
862
831
|
# An alternative to sampling with temperature, called nucleus sampling, where the
|
|
863
832
|
# model considers the results of the tokens with top_p probability mass. So 0.1
|
|
864
833
|
# means only the tokens comprising the top 10% probability mass are considered.
|
|
865
834
|
#
|
|
866
835
|
# We generally recommend altering this or `temperature` but not both.
|
|
867
836
|
top_p: nil,
|
|
837
|
+
|
|
868
838
|
# This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
|
|
869
839
|
# `prompt_cache_key` instead to maintain caching optimizations. A stable
|
|
870
840
|
# identifier for your end-users. Used to boost cache hit rates by better bucketing
|
|
871
841
|
# similar requests and to help OpenAI detect and prevent abuse.
|
|
872
842
|
# [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
|
|
873
843
|
user: nil,
|
|
844
|
+
|
|
874
845
|
# Constrains the verbosity of the model's response. Lower values will result in
|
|
875
846
|
# more concise responses, while higher values will result in more verbose
|
|
876
847
|
# responses. Currently supported values are `low`, `medium`, and `high`. The
|
|
877
848
|
# default is `medium`.
|
|
878
849
|
verbosity: nil,
|
|
850
|
+
|
|
879
851
|
# This tool searches the web for relevant results to use in a response. Learn more
|
|
880
852
|
# about the
|
|
881
853
|
# [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
|
|
882
854
|
web_search_options: nil,
|
|
855
|
+
|
|
883
856
|
request_options: {}
|
|
884
857
|
)
|
|
885
858
|
end
|
|
@@ -887,95 +860,69 @@ module OpenAI
|
|
|
887
860
|
sig do
|
|
888
861
|
override.returns(
|
|
889
862
|
{
|
|
890
|
-
messages:
|
|
891
|
-
T
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
],
|
|
863
|
+
messages: T::Array[
|
|
864
|
+
T.any(
|
|
865
|
+
OpenAI::Chat::ChatCompletionDeveloperMessageParam,
|
|
866
|
+
OpenAI::Chat::ChatCompletionSystemMessageParam,
|
|
867
|
+
OpenAI::Chat::ChatCompletionUserMessageParam,
|
|
868
|
+
OpenAI::Chat::ChatCompletionAssistantMessageParam,
|
|
869
|
+
OpenAI::Chat::ChatCompletionToolMessageParam,
|
|
870
|
+
OpenAI::Chat::ChatCompletionFunctionMessageParam
|
|
871
|
+
)
|
|
872
|
+
],
|
|
901
873
|
model: T.any(String, OpenAI::ChatModel::OrSymbol),
|
|
902
874
|
audio: T.nilable(OpenAI::Chat::ChatCompletionAudioParam),
|
|
903
875
|
frequency_penalty: T.nilable(Float),
|
|
904
|
-
function_call:
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
functions:
|
|
910
|
-
T::Array[OpenAI::Chat::CompletionCreateParams::Function],
|
|
876
|
+
function_call: T.any(
|
|
877
|
+
OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::OrSymbol,
|
|
878
|
+
OpenAI::Chat::ChatCompletionFunctionCallOption
|
|
879
|
+
),
|
|
880
|
+
functions: T::Array[OpenAI::Chat::CompletionCreateParams::Function],
|
|
911
881
|
logit_bias: T.nilable(T::Hash[Symbol, Integer]),
|
|
912
882
|
logprobs: T.nilable(T::Boolean),
|
|
913
883
|
max_completion_tokens: T.nilable(Integer),
|
|
914
884
|
max_tokens: T.nilable(Integer),
|
|
915
885
|
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
916
|
-
modalities:
|
|
917
|
-
|
|
918
|
-
T::Array[
|
|
919
|
-
OpenAI::Chat::CompletionCreateParams::Modality::OrSymbol
|
|
920
|
-
]
|
|
921
|
-
),
|
|
922
|
-
moderation:
|
|
923
|
-
T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation),
|
|
886
|
+
modalities: T.nilable(T::Array[OpenAI::Chat::CompletionCreateParams::Modality::OrSymbol]),
|
|
887
|
+
moderation: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation),
|
|
924
888
|
n: T.nilable(Integer),
|
|
925
889
|
parallel_tool_calls: T::Boolean,
|
|
926
|
-
prediction:
|
|
927
|
-
T.nilable(OpenAI::Chat::ChatCompletionPredictionContent),
|
|
890
|
+
prediction: T.nilable(OpenAI::Chat::ChatCompletionPredictionContent),
|
|
928
891
|
presence_penalty: T.nilable(Float),
|
|
929
892
|
prompt_cache_key: T.nilable(String),
|
|
930
|
-
prompt_cache_options:
|
|
931
|
-
|
|
932
|
-
prompt_cache_retention:
|
|
933
|
-
T.nilable(
|
|
934
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::OrSymbol
|
|
935
|
-
),
|
|
893
|
+
prompt_cache_options: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions,
|
|
894
|
+
prompt_cache_retention: T.nilable(OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::OrSymbol),
|
|
936
895
|
reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
|
|
937
|
-
response_format:
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
),
|
|
896
|
+
response_format: T.any(
|
|
897
|
+
OpenAI::ResponseFormatText,
|
|
898
|
+
OpenAI::ResponseFormatJSONSchema,
|
|
899
|
+
OpenAI::ResponseFormatJSONObject
|
|
900
|
+
),
|
|
943
901
|
safety_identifier: T.nilable(String),
|
|
944
902
|
seed: T.nilable(Integer),
|
|
945
|
-
service_tier:
|
|
946
|
-
|
|
947
|
-
OpenAI::Chat::CompletionCreateParams::ServiceTier::OrSymbol
|
|
948
|
-
),
|
|
949
|
-
stop:
|
|
950
|
-
T.nilable(OpenAI::Chat::CompletionCreateParams::Stop::Variants),
|
|
903
|
+
service_tier: T.nilable(OpenAI::Chat::CompletionCreateParams::ServiceTier::OrSymbol),
|
|
904
|
+
stop: T.nilable(OpenAI::Chat::CompletionCreateParams::Stop::Variants),
|
|
951
905
|
store: T.nilable(T::Boolean),
|
|
952
|
-
stream_options:
|
|
953
|
-
T.nilable(OpenAI::Chat::ChatCompletionStreamOptions),
|
|
906
|
+
stream_options: T.nilable(OpenAI::Chat::ChatCompletionStreamOptions),
|
|
954
907
|
temperature: T.nilable(Float),
|
|
955
|
-
tool_choice:
|
|
908
|
+
tool_choice: T.any(
|
|
909
|
+
OpenAI::Chat::ChatCompletionToolChoiceOption::Auto::OrSymbol,
|
|
910
|
+
OpenAI::Chat::ChatCompletionAllowedToolChoice,
|
|
911
|
+
OpenAI::Chat::ChatCompletionNamedToolChoice,
|
|
912
|
+
OpenAI::Chat::ChatCompletionNamedToolChoiceCustom
|
|
913
|
+
),
|
|
914
|
+
tools: T::Array[
|
|
956
915
|
T.any(
|
|
957
|
-
OpenAI::
|
|
958
|
-
OpenAI::Chat::
|
|
959
|
-
OpenAI::Chat::
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
tools:
|
|
963
|
-
T::Array[
|
|
964
|
-
T.any(
|
|
965
|
-
OpenAI::StructuredOutput::JsonSchemaConverter,
|
|
966
|
-
OpenAI::Chat::ChatCompletionFunctionTool,
|
|
967
|
-
OpenAI::Chat::ChatCompletionCustomTool
|
|
968
|
-
)
|
|
969
|
-
],
|
|
916
|
+
OpenAI::StructuredOutput::JsonSchemaConverter,
|
|
917
|
+
OpenAI::Chat::ChatCompletionFunctionTool,
|
|
918
|
+
OpenAI::Chat::ChatCompletionCustomTool
|
|
919
|
+
)
|
|
920
|
+
],
|
|
970
921
|
top_logprobs: T.nilable(Integer),
|
|
971
922
|
top_p: T.nilable(Float),
|
|
972
923
|
user: String,
|
|
973
|
-
verbosity:
|
|
974
|
-
|
|
975
|
-
OpenAI::Chat::CompletionCreateParams::Verbosity::OrSymbol
|
|
976
|
-
),
|
|
977
|
-
web_search_options:
|
|
978
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions,
|
|
924
|
+
verbosity: T.nilable(OpenAI::Chat::CompletionCreateParams::Verbosity::OrSymbol),
|
|
925
|
+
web_search_options: OpenAI::Chat::CompletionCreateParams::WebSearchOptions,
|
|
979
926
|
request_options: OpenAI::RequestOptions
|
|
980
927
|
}
|
|
981
928
|
)
|
|
@@ -991,16 +938,12 @@ module OpenAI
|
|
|
991
938
|
module Model
|
|
992
939
|
extend OpenAI::Internal::Type::Union
|
|
993
940
|
|
|
994
|
-
Variants =
|
|
995
|
-
T.type_alias { T.any(String, OpenAI::ChatModel::TaggedSymbol) }
|
|
941
|
+
Variants = T.type_alias { T.any(String, OpenAI::ChatModel::TaggedSymbol) }
|
|
996
942
|
|
|
997
|
-
sig
|
|
998
|
-
override.returns(
|
|
999
|
-
T::Array[OpenAI::Chat::CompletionCreateParams::Model::Variants]
|
|
1000
|
-
)
|
|
1001
|
-
end
|
|
943
|
+
sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::Model::Variants]) }
|
|
1002
944
|
def self.variants
|
|
1003
945
|
end
|
|
946
|
+
|
|
1004
947
|
end
|
|
1005
948
|
|
|
1006
949
|
# Deprecated in favor of `tool_choice`.
|
|
@@ -1020,13 +963,12 @@ module OpenAI
|
|
|
1020
963
|
module FunctionCall
|
|
1021
964
|
extend OpenAI::Internal::Type::Union
|
|
1022
965
|
|
|
1023
|
-
Variants =
|
|
1024
|
-
T.
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
end
|
|
966
|
+
Variants = T.type_alias do
|
|
967
|
+
T.any(
|
|
968
|
+
OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol,
|
|
969
|
+
OpenAI::Chat::ChatCompletionFunctionCallOption
|
|
970
|
+
)
|
|
971
|
+
end
|
|
1030
972
|
|
|
1031
973
|
# `none` means the model will not call a function and instead generates a message.
|
|
1032
974
|
# `auto` means the model can pick between generating a message or calling a
|
|
@@ -1034,56 +976,36 @@ module OpenAI
|
|
|
1034
976
|
module FunctionCallMode
|
|
1035
977
|
extend OpenAI::Internal::Type::Enum
|
|
1036
978
|
|
|
1037
|
-
TaggedSymbol =
|
|
1038
|
-
T.
|
|
1039
|
-
|
|
1040
|
-
Symbol,
|
|
1041
|
-
OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode
|
|
1042
|
-
)
|
|
1043
|
-
end
|
|
979
|
+
TaggedSymbol = T.type_alias {
|
|
980
|
+
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode)
|
|
981
|
+
}
|
|
1044
982
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1045
983
|
|
|
1046
|
-
NONE =
|
|
1047
|
-
|
|
1048
|
-
:none,
|
|
1049
|
-
OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol
|
|
1050
|
-
)
|
|
1051
|
-
AUTO =
|
|
1052
|
-
T.let(
|
|
1053
|
-
:auto,
|
|
1054
|
-
OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol
|
|
1055
|
-
)
|
|
984
|
+
NONE = T.let(:none, OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol)
|
|
985
|
+
AUTO = T.let(:auto, OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol)
|
|
1056
986
|
|
|
1057
987
|
sig do
|
|
1058
988
|
override.returns(
|
|
1059
|
-
T::Array[
|
|
1060
|
-
OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol
|
|
1061
|
-
]
|
|
989
|
+
T::Array[OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol]
|
|
1062
990
|
)
|
|
1063
991
|
end
|
|
1064
992
|
def self.values
|
|
1065
993
|
end
|
|
1066
994
|
end
|
|
1067
995
|
|
|
1068
|
-
sig
|
|
1069
|
-
override.returns(
|
|
1070
|
-
T::Array[
|
|
1071
|
-
OpenAI::Chat::CompletionCreateParams::FunctionCall::Variants
|
|
1072
|
-
]
|
|
1073
|
-
)
|
|
1074
|
-
end
|
|
996
|
+
sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::FunctionCall::Variants]) }
|
|
1075
997
|
def self.variants
|
|
1076
998
|
end
|
|
999
|
+
|
|
1077
1000
|
end
|
|
1078
1001
|
|
|
1079
1002
|
class Function < OpenAI::Internal::Type::BaseModel
|
|
1080
|
-
OrHash =
|
|
1081
|
-
T.
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
end
|
|
1003
|
+
OrHash = T.type_alias do
|
|
1004
|
+
T.any(
|
|
1005
|
+
OpenAI::Chat::CompletionCreateParams::Function,
|
|
1006
|
+
OpenAI::Internal::AnyHash
|
|
1007
|
+
)
|
|
1008
|
+
end
|
|
1087
1009
|
|
|
1088
1010
|
# The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
|
|
1089
1011
|
# underscores and dashes, with a maximum length of 64.
|
|
@@ -1113,18 +1035,25 @@ module OpenAI
|
|
|
1113
1035
|
|
|
1114
1036
|
sig do
|
|
1115
1037
|
params(
|
|
1038
|
+
|
|
1116
1039
|
name: String,
|
|
1040
|
+
|
|
1117
1041
|
description: String,
|
|
1042
|
+
|
|
1118
1043
|
parameters: T::Hash[Symbol, T.anything]
|
|
1119
|
-
)
|
|
1044
|
+
)
|
|
1045
|
+
.returns(T.attached_class)
|
|
1120
1046
|
end
|
|
1121
1047
|
def self.new(
|
|
1048
|
+
|
|
1122
1049
|
# The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
|
|
1123
1050
|
# underscores and dashes, with a maximum length of 64.
|
|
1124
1051
|
name:,
|
|
1052
|
+
|
|
1125
1053
|
# A description of what the function does, used by the model to choose when and
|
|
1126
1054
|
# how to call the function.
|
|
1127
1055
|
description: nil,
|
|
1056
|
+
|
|
1128
1057
|
# The parameters the functions accepts, described as a JSON Schema object. See the
|
|
1129
1058
|
# [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
|
|
1130
1059
|
# and the
|
|
@@ -1132,62 +1061,42 @@ module OpenAI
|
|
|
1132
1061
|
# documentation about the format.
|
|
1133
1062
|
#
|
|
1134
1063
|
# Omitting `parameters` defines a function with an empty parameter list.
|
|
1064
|
+
|
|
1135
1065
|
parameters: nil
|
|
1136
1066
|
)
|
|
1137
1067
|
end
|
|
1138
1068
|
|
|
1139
1069
|
sig do
|
|
1140
1070
|
override.returns(
|
|
1141
|
-
{
|
|
1142
|
-
name: String,
|
|
1143
|
-
description: String,
|
|
1144
|
-
parameters: T::Hash[Symbol, T.anything]
|
|
1145
|
-
}
|
|
1071
|
+
{name: String, description: String, parameters: T::Hash[Symbol, T.anything]}
|
|
1146
1072
|
)
|
|
1147
1073
|
end
|
|
1148
1074
|
def to_hash
|
|
1149
1075
|
end
|
|
1076
|
+
|
|
1150
1077
|
end
|
|
1151
1078
|
|
|
1152
1079
|
module Modality
|
|
1153
1080
|
extend OpenAI::Internal::Type::Enum
|
|
1154
1081
|
|
|
1155
|
-
TaggedSymbol =
|
|
1156
|
-
T.type_alias do
|
|
1157
|
-
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::Modality)
|
|
1158
|
-
end
|
|
1082
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Chat::CompletionCreateParams::Modality) }
|
|
1159
1083
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1160
1084
|
|
|
1161
|
-
TEXT =
|
|
1162
|
-
|
|
1163
|
-
:text,
|
|
1164
|
-
OpenAI::Chat::CompletionCreateParams::Modality::TaggedSymbol
|
|
1165
|
-
)
|
|
1166
|
-
AUDIO =
|
|
1167
|
-
T.let(
|
|
1168
|
-
:audio,
|
|
1169
|
-
OpenAI::Chat::CompletionCreateParams::Modality::TaggedSymbol
|
|
1170
|
-
)
|
|
1085
|
+
TEXT = T.let(:text, OpenAI::Chat::CompletionCreateParams::Modality::TaggedSymbol)
|
|
1086
|
+
AUDIO = T.let(:audio, OpenAI::Chat::CompletionCreateParams::Modality::TaggedSymbol)
|
|
1171
1087
|
|
|
1172
|
-
sig
|
|
1173
|
-
override.returns(
|
|
1174
|
-
T::Array[
|
|
1175
|
-
OpenAI::Chat::CompletionCreateParams::Modality::TaggedSymbol
|
|
1176
|
-
]
|
|
1177
|
-
)
|
|
1178
|
-
end
|
|
1088
|
+
sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::Modality::TaggedSymbol]) }
|
|
1179
1089
|
def self.values
|
|
1180
1090
|
end
|
|
1181
1091
|
end
|
|
1182
1092
|
|
|
1183
1093
|
class Moderation < OpenAI::Internal::Type::BaseModel
|
|
1184
|
-
OrHash =
|
|
1185
|
-
T.
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
end
|
|
1094
|
+
OrHash = T.type_alias do
|
|
1095
|
+
T.any(
|
|
1096
|
+
OpenAI::Chat::CompletionCreateParams::Moderation,
|
|
1097
|
+
OpenAI::Internal::AnyHash
|
|
1098
|
+
)
|
|
1099
|
+
end
|
|
1191
1100
|
|
|
1192
1101
|
# The moderation model to use for moderated completions, e.g.
|
|
1193
1102
|
# 'omni-moderation-latest'.
|
|
@@ -1195,124 +1104,85 @@ module OpenAI
|
|
|
1195
1104
|
attr_accessor :model
|
|
1196
1105
|
|
|
1197
1106
|
# The policy to apply to moderated response input and output.
|
|
1198
|
-
sig
|
|
1199
|
-
returns(
|
|
1200
|
-
T.nilable(
|
|
1201
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy
|
|
1202
|
-
)
|
|
1203
|
-
)
|
|
1204
|
-
end
|
|
1107
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy)) }
|
|
1205
1108
|
attr_reader :policy
|
|
1206
1109
|
|
|
1207
|
-
sig
|
|
1208
|
-
params(
|
|
1209
|
-
policy:
|
|
1210
|
-
T.nilable(
|
|
1211
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::OrHash
|
|
1212
|
-
)
|
|
1213
|
-
).void
|
|
1214
|
-
end
|
|
1110
|
+
sig { params(policy: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::OrHash)).void }
|
|
1215
1111
|
attr_writer :policy
|
|
1216
1112
|
|
|
1217
1113
|
# Configuration for running moderation on the request input and generated output.
|
|
1218
1114
|
sig do
|
|
1219
1115
|
params(
|
|
1116
|
+
|
|
1220
1117
|
model: String,
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
).returns(T.attached_class)
|
|
1118
|
+
|
|
1119
|
+
policy: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::OrHash)
|
|
1120
|
+
)
|
|
1121
|
+
.returns(T.attached_class)
|
|
1226
1122
|
end
|
|
1227
1123
|
def self.new(
|
|
1124
|
+
|
|
1228
1125
|
# The moderation model to use for moderated completions, e.g.
|
|
1229
1126
|
# 'omni-moderation-latest'.
|
|
1230
1127
|
model:,
|
|
1128
|
+
|
|
1231
1129
|
# The policy to apply to moderated response input and output.
|
|
1130
|
+
|
|
1232
1131
|
policy: nil
|
|
1233
1132
|
)
|
|
1234
1133
|
end
|
|
1235
1134
|
|
|
1236
1135
|
sig do
|
|
1237
1136
|
override.returns(
|
|
1238
|
-
{
|
|
1239
|
-
model: String,
|
|
1240
|
-
policy:
|
|
1241
|
-
T.nilable(
|
|
1242
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy
|
|
1243
|
-
)
|
|
1244
|
-
}
|
|
1137
|
+
{model: String, policy: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy)}
|
|
1245
1138
|
)
|
|
1246
1139
|
end
|
|
1247
1140
|
def to_hash
|
|
1248
1141
|
end
|
|
1249
1142
|
|
|
1250
1143
|
class Policy < OpenAI::Internal::Type::BaseModel
|
|
1251
|
-
OrHash =
|
|
1252
|
-
T.
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
OpenAI::Internal::AnyHash
|
|
1256
|
-
)
|
|
1257
|
-
end
|
|
1258
|
-
|
|
1259
|
-
# The moderation policy for the response input.
|
|
1260
|
-
sig do
|
|
1261
|
-
returns(
|
|
1262
|
-
T.nilable(
|
|
1263
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input
|
|
1264
|
-
)
|
|
1144
|
+
OrHash = T.type_alias do
|
|
1145
|
+
T.any(
|
|
1146
|
+
OpenAI::Chat::CompletionCreateParams::Moderation::Policy,
|
|
1147
|
+
OpenAI::Internal::AnyHash
|
|
1265
1148
|
)
|
|
1266
1149
|
end
|
|
1150
|
+
|
|
1151
|
+
# The moderation policy for the response input.
|
|
1152
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input)) }
|
|
1267
1153
|
attr_reader :input
|
|
1268
1154
|
|
|
1269
|
-
sig
|
|
1270
|
-
params(
|
|
1271
|
-
|
|
1272
|
-
T.nilable(
|
|
1273
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::OrHash
|
|
1274
|
-
)
|
|
1275
|
-
).void
|
|
1276
|
-
end
|
|
1155
|
+
sig {
|
|
1156
|
+
params(input: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::OrHash)).void
|
|
1157
|
+
}
|
|
1277
1158
|
attr_writer :input
|
|
1278
1159
|
|
|
1279
1160
|
# The moderation policy for the response output.
|
|
1280
|
-
sig
|
|
1281
|
-
returns(
|
|
1282
|
-
T.nilable(
|
|
1283
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output
|
|
1284
|
-
)
|
|
1285
|
-
)
|
|
1286
|
-
end
|
|
1161
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output)) }
|
|
1287
1162
|
attr_reader :output
|
|
1288
1163
|
|
|
1289
|
-
sig
|
|
1290
|
-
params(
|
|
1291
|
-
|
|
1292
|
-
T.nilable(
|
|
1293
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::OrHash
|
|
1294
|
-
)
|
|
1295
|
-
).void
|
|
1296
|
-
end
|
|
1164
|
+
sig {
|
|
1165
|
+
params(output: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::OrHash)).void
|
|
1166
|
+
}
|
|
1297
1167
|
attr_writer :output
|
|
1298
1168
|
|
|
1299
1169
|
# The policy to apply to moderated response input and output.
|
|
1300
1170
|
sig do
|
|
1301
1171
|
params(
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::OrHash
|
|
1309
|
-
)
|
|
1310
|
-
).returns(T.attached_class)
|
|
1172
|
+
|
|
1173
|
+
input: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::OrHash),
|
|
1174
|
+
|
|
1175
|
+
output: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::OrHash)
|
|
1176
|
+
)
|
|
1177
|
+
.returns(T.attached_class)
|
|
1311
1178
|
end
|
|
1312
1179
|
def self.new(
|
|
1180
|
+
|
|
1313
1181
|
# The moderation policy for the response input.
|
|
1314
1182
|
input: nil,
|
|
1183
|
+
|
|
1315
1184
|
# The moderation policy for the response output.
|
|
1185
|
+
|
|
1316
1186
|
output: nil
|
|
1317
1187
|
)
|
|
1318
1188
|
end
|
|
@@ -1320,14 +1190,8 @@ module OpenAI
|
|
|
1320
1190
|
sig do
|
|
1321
1191
|
override.returns(
|
|
1322
1192
|
{
|
|
1323
|
-
input:
|
|
1324
|
-
|
|
1325
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input
|
|
1326
|
-
),
|
|
1327
|
-
output:
|
|
1328
|
-
T.nilable(
|
|
1329
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output
|
|
1330
|
-
)
|
|
1193
|
+
input: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input),
|
|
1194
|
+
output: T.nilable(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output)
|
|
1331
1195
|
}
|
|
1332
1196
|
)
|
|
1333
1197
|
end
|
|
@@ -1335,37 +1199,33 @@ module OpenAI
|
|
|
1335
1199
|
end
|
|
1336
1200
|
|
|
1337
1201
|
class Input < OpenAI::Internal::Type::BaseModel
|
|
1338
|
-
OrHash =
|
|
1339
|
-
T.
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
OpenAI::Internal::AnyHash
|
|
1343
|
-
)
|
|
1344
|
-
end
|
|
1345
|
-
|
|
1346
|
-
sig do
|
|
1347
|
-
returns(
|
|
1348
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::OrSymbol
|
|
1202
|
+
OrHash = T.type_alias do
|
|
1203
|
+
T.any(
|
|
1204
|
+
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input,
|
|
1205
|
+
OpenAI::Internal::AnyHash
|
|
1349
1206
|
)
|
|
1350
1207
|
end
|
|
1208
|
+
|
|
1209
|
+
sig { returns(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::OrSymbol) }
|
|
1351
1210
|
attr_accessor :mode
|
|
1352
1211
|
|
|
1353
1212
|
# The moderation policy for the response input.
|
|
1354
1213
|
sig do
|
|
1355
1214
|
params(
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
)
|
|
1215
|
+
|
|
1216
|
+
mode: OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::OrSymbol
|
|
1217
|
+
)
|
|
1218
|
+
.returns(T.attached_class)
|
|
1359
1219
|
end
|
|
1360
|
-
def self.new(
|
|
1220
|
+
def self.new(
|
|
1221
|
+
|
|
1222
|
+
mode:
|
|
1223
|
+
)
|
|
1361
1224
|
end
|
|
1362
1225
|
|
|
1363
1226
|
sig do
|
|
1364
1227
|
override.returns(
|
|
1365
|
-
{
|
|
1366
|
-
mode:
|
|
1367
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::OrSymbol
|
|
1368
|
-
}
|
|
1228
|
+
{mode: OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::OrSymbol}
|
|
1369
1229
|
)
|
|
1370
1230
|
end
|
|
1371
1231
|
def to_hash
|
|
@@ -1374,31 +1234,23 @@ module OpenAI
|
|
|
1374
1234
|
module Mode
|
|
1375
1235
|
extend OpenAI::Internal::Type::Enum
|
|
1376
1236
|
|
|
1377
|
-
TaggedSymbol =
|
|
1378
|
-
T.
|
|
1379
|
-
|
|
1380
|
-
Symbol,
|
|
1381
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode
|
|
1382
|
-
)
|
|
1383
|
-
end
|
|
1237
|
+
TaggedSymbol = T.type_alias {
|
|
1238
|
+
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode)
|
|
1239
|
+
}
|
|
1384
1240
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1385
1241
|
|
|
1386
|
-
SCORE =
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::TaggedSymbol
|
|
1395
|
-
)
|
|
1242
|
+
SCORE = T.let(
|
|
1243
|
+
:score,
|
|
1244
|
+
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::TaggedSymbol
|
|
1245
|
+
)
|
|
1246
|
+
BLOCK = T.let(
|
|
1247
|
+
:block,
|
|
1248
|
+
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::TaggedSymbol
|
|
1249
|
+
)
|
|
1396
1250
|
|
|
1397
1251
|
sig do
|
|
1398
1252
|
override.returns(
|
|
1399
|
-
T::Array[
|
|
1400
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::TaggedSymbol
|
|
1401
|
-
]
|
|
1253
|
+
T::Array[OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::TaggedSymbol]
|
|
1402
1254
|
)
|
|
1403
1255
|
end
|
|
1404
1256
|
def self.values
|
|
@@ -1407,37 +1259,33 @@ module OpenAI
|
|
|
1407
1259
|
end
|
|
1408
1260
|
|
|
1409
1261
|
class Output < OpenAI::Internal::Type::BaseModel
|
|
1410
|
-
OrHash =
|
|
1411
|
-
T.
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
OpenAI::Internal::AnyHash
|
|
1415
|
-
)
|
|
1416
|
-
end
|
|
1417
|
-
|
|
1418
|
-
sig do
|
|
1419
|
-
returns(
|
|
1420
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::OrSymbol
|
|
1262
|
+
OrHash = T.type_alias do
|
|
1263
|
+
T.any(
|
|
1264
|
+
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output,
|
|
1265
|
+
OpenAI::Internal::AnyHash
|
|
1421
1266
|
)
|
|
1422
1267
|
end
|
|
1268
|
+
|
|
1269
|
+
sig { returns(OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::OrSymbol) }
|
|
1423
1270
|
attr_accessor :mode
|
|
1424
1271
|
|
|
1425
1272
|
# The moderation policy for the response output.
|
|
1426
1273
|
sig do
|
|
1427
1274
|
params(
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
)
|
|
1275
|
+
|
|
1276
|
+
mode: OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::OrSymbol
|
|
1277
|
+
)
|
|
1278
|
+
.returns(T.attached_class)
|
|
1431
1279
|
end
|
|
1432
|
-
def self.new(
|
|
1280
|
+
def self.new(
|
|
1281
|
+
|
|
1282
|
+
mode:
|
|
1283
|
+
)
|
|
1433
1284
|
end
|
|
1434
1285
|
|
|
1435
1286
|
sig do
|
|
1436
1287
|
override.returns(
|
|
1437
|
-
{
|
|
1438
|
-
mode:
|
|
1439
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::OrSymbol
|
|
1440
|
-
}
|
|
1288
|
+
{mode: OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::OrSymbol}
|
|
1441
1289
|
)
|
|
1442
1290
|
end
|
|
1443
1291
|
def to_hash
|
|
@@ -1446,31 +1294,23 @@ module OpenAI
|
|
|
1446
1294
|
module Mode
|
|
1447
1295
|
extend OpenAI::Internal::Type::Enum
|
|
1448
1296
|
|
|
1449
|
-
TaggedSymbol =
|
|
1450
|
-
T.
|
|
1451
|
-
|
|
1452
|
-
Symbol,
|
|
1453
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode
|
|
1454
|
-
)
|
|
1455
|
-
end
|
|
1297
|
+
TaggedSymbol = T.type_alias {
|
|
1298
|
+
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode)
|
|
1299
|
+
}
|
|
1456
1300
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1457
1301
|
|
|
1458
|
-
SCORE =
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::TaggedSymbol
|
|
1467
|
-
)
|
|
1302
|
+
SCORE = T.let(
|
|
1303
|
+
:score,
|
|
1304
|
+
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::TaggedSymbol
|
|
1305
|
+
)
|
|
1306
|
+
BLOCK = T.let(
|
|
1307
|
+
:block,
|
|
1308
|
+
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::TaggedSymbol
|
|
1309
|
+
)
|
|
1468
1310
|
|
|
1469
1311
|
sig do
|
|
1470
1312
|
override.returns(
|
|
1471
|
-
T::Array[
|
|
1472
|
-
OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::TaggedSymbol
|
|
1473
|
-
]
|
|
1313
|
+
T::Array[OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::TaggedSymbol]
|
|
1474
1314
|
)
|
|
1475
1315
|
end
|
|
1476
1316
|
def self.values
|
|
@@ -1481,13 +1321,12 @@ module OpenAI
|
|
|
1481
1321
|
end
|
|
1482
1322
|
|
|
1483
1323
|
class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
|
|
1484
|
-
OrHash =
|
|
1485
|
-
T.
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
end
|
|
1324
|
+
OrHash = T.type_alias do
|
|
1325
|
+
T.any(
|
|
1326
|
+
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions,
|
|
1327
|
+
OpenAI::Internal::AnyHash
|
|
1328
|
+
)
|
|
1329
|
+
end
|
|
1491
1330
|
|
|
1492
1331
|
# Controls whether OpenAI automatically creates an implicit cache breakpoint.
|
|
1493
1332
|
# Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
|
|
@@ -1495,41 +1334,19 @@ module OpenAI
|
|
|
1495
1334
|
# `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
|
|
1496
1335
|
# latest four explicit breakpoints. If there are no explicit breakpoints, the
|
|
1497
1336
|
# request does not use prompt caching.
|
|
1498
|
-
sig
|
|
1499
|
-
returns(
|
|
1500
|
-
T.nilable(
|
|
1501
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::OrSymbol
|
|
1502
|
-
)
|
|
1503
|
-
)
|
|
1504
|
-
end
|
|
1337
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::OrSymbol)) }
|
|
1505
1338
|
attr_reader :mode
|
|
1506
1339
|
|
|
1507
|
-
sig
|
|
1508
|
-
params(
|
|
1509
|
-
mode:
|
|
1510
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::OrSymbol
|
|
1511
|
-
).void
|
|
1512
|
-
end
|
|
1340
|
+
sig { params(mode: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::OrSymbol).void }
|
|
1513
1341
|
attr_writer :mode
|
|
1514
1342
|
|
|
1515
1343
|
# The minimum lifetime applied to every implicit and explicit cache breakpoint
|
|
1516
1344
|
# written by the request. Defaults to `30m`, which is currently the only supported
|
|
1517
1345
|
# value. The backend may retain cache entries for longer.
|
|
1518
|
-
sig
|
|
1519
|
-
returns(
|
|
1520
|
-
T.nilable(
|
|
1521
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::OrSymbol
|
|
1522
|
-
)
|
|
1523
|
-
)
|
|
1524
|
-
end
|
|
1346
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::OrSymbol)) }
|
|
1525
1347
|
attr_reader :ttl
|
|
1526
1348
|
|
|
1527
|
-
sig
|
|
1528
|
-
params(
|
|
1529
|
-
ttl:
|
|
1530
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::OrSymbol
|
|
1531
|
-
).void
|
|
1532
|
-
end
|
|
1349
|
+
sig { params(ttl: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::OrSymbol).void }
|
|
1533
1350
|
attr_writer :ttl
|
|
1534
1351
|
|
|
1535
1352
|
# Options for prompt caching. Supported for `gpt-5.6` and later models. By
|
|
@@ -1543,13 +1360,15 @@ module OpenAI
|
|
|
1543
1360
|
# for current details.
|
|
1544
1361
|
sig do
|
|
1545
1362
|
params(
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
)
|
|
1363
|
+
|
|
1364
|
+
mode: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::OrSymbol,
|
|
1365
|
+
|
|
1366
|
+
ttl: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::OrSymbol
|
|
1367
|
+
)
|
|
1368
|
+
.returns(T.attached_class)
|
|
1551
1369
|
end
|
|
1552
1370
|
def self.new(
|
|
1371
|
+
|
|
1553
1372
|
# Controls whether OpenAI automatically creates an implicit cache breakpoint.
|
|
1554
1373
|
# Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
|
|
1555
1374
|
# and writes up to the latest three explicit breakpoints in the request. With
|
|
@@ -1557,9 +1376,11 @@ module OpenAI
|
|
|
1557
1376
|
# latest four explicit breakpoints. If there are no explicit breakpoints, the
|
|
1558
1377
|
# request does not use prompt caching.
|
|
1559
1378
|
mode: nil,
|
|
1379
|
+
|
|
1560
1380
|
# The minimum lifetime applied to every implicit and explicit cache breakpoint
|
|
1561
1381
|
# written by the request. Defaults to `30m`, which is currently the only supported
|
|
1562
1382
|
# value. The backend may retain cache entries for longer.
|
|
1383
|
+
|
|
1563
1384
|
ttl: nil
|
|
1564
1385
|
)
|
|
1565
1386
|
end
|
|
@@ -1567,10 +1388,8 @@ module OpenAI
|
|
|
1567
1388
|
sig do
|
|
1568
1389
|
override.returns(
|
|
1569
1390
|
{
|
|
1570
|
-
mode:
|
|
1571
|
-
|
|
1572
|
-
ttl:
|
|
1573
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::OrSymbol
|
|
1391
|
+
mode: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::OrSymbol,
|
|
1392
|
+
ttl: OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::OrSymbol
|
|
1574
1393
|
}
|
|
1575
1394
|
)
|
|
1576
1395
|
end
|
|
@@ -1586,33 +1405,17 @@ module OpenAI
|
|
|
1586
1405
|
module Mode
|
|
1587
1406
|
extend OpenAI::Internal::Type::Enum
|
|
1588
1407
|
|
|
1589
|
-
TaggedSymbol =
|
|
1590
|
-
T.
|
|
1591
|
-
|
|
1592
|
-
Symbol,
|
|
1593
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode
|
|
1594
|
-
)
|
|
1595
|
-
end
|
|
1408
|
+
TaggedSymbol = T.type_alias {
|
|
1409
|
+
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode)
|
|
1410
|
+
}
|
|
1596
1411
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1597
1412
|
|
|
1598
|
-
IMPLICIT =
|
|
1599
|
-
|
|
1600
|
-
:implicit,
|
|
1601
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::TaggedSymbol
|
|
1602
|
-
)
|
|
1603
|
-
EXPLICIT =
|
|
1604
|
-
T.let(
|
|
1605
|
-
:explicit,
|
|
1606
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::TaggedSymbol
|
|
1607
|
-
)
|
|
1413
|
+
IMPLICIT = T.let(:implicit, OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::TaggedSymbol)
|
|
1414
|
+
EXPLICIT = T.let(:explicit, OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::TaggedSymbol)
|
|
1608
1415
|
|
|
1609
|
-
sig
|
|
1610
|
-
override.returns(
|
|
1611
|
-
|
|
1612
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::TaggedSymbol
|
|
1613
|
-
]
|
|
1614
|
-
)
|
|
1615
|
-
end
|
|
1416
|
+
sig {
|
|
1417
|
+
override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Mode::TaggedSymbol])
|
|
1418
|
+
}
|
|
1616
1419
|
def self.values
|
|
1617
1420
|
end
|
|
1618
1421
|
end
|
|
@@ -1623,28 +1426,16 @@ module OpenAI
|
|
|
1623
1426
|
module Ttl
|
|
1624
1427
|
extend OpenAI::Internal::Type::Enum
|
|
1625
1428
|
|
|
1626
|
-
TaggedSymbol =
|
|
1627
|
-
T.
|
|
1628
|
-
|
|
1629
|
-
Symbol,
|
|
1630
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl
|
|
1631
|
-
)
|
|
1632
|
-
end
|
|
1429
|
+
TaggedSymbol = T.type_alias {
|
|
1430
|
+
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl)
|
|
1431
|
+
}
|
|
1633
1432
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1634
1433
|
|
|
1635
|
-
TTL_30M =
|
|
1636
|
-
T.let(
|
|
1637
|
-
:"30m",
|
|
1638
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::TaggedSymbol
|
|
1639
|
-
)
|
|
1434
|
+
TTL_30M = T.let(:"30m", OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::TaggedSymbol)
|
|
1640
1435
|
|
|
1641
|
-
sig
|
|
1642
|
-
override.returns(
|
|
1643
|
-
|
|
1644
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::TaggedSymbol
|
|
1645
|
-
]
|
|
1646
|
-
)
|
|
1647
|
-
end
|
|
1436
|
+
sig {
|
|
1437
|
+
override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::PromptCacheOptions::Ttl::TaggedSymbol])
|
|
1438
|
+
}
|
|
1648
1439
|
def self.values
|
|
1649
1440
|
end
|
|
1650
1441
|
end
|
|
@@ -1670,33 +1461,16 @@ module OpenAI
|
|
|
1670
1461
|
module PromptCacheRetention
|
|
1671
1462
|
extend OpenAI::Internal::Type::Enum
|
|
1672
1463
|
|
|
1673
|
-
TaggedSymbol =
|
|
1674
|
-
T.type_alias do
|
|
1675
|
-
T.all(
|
|
1676
|
-
Symbol,
|
|
1677
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheRetention
|
|
1678
|
-
)
|
|
1679
|
-
end
|
|
1464
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Chat::CompletionCreateParams::PromptCacheRetention) }
|
|
1680
1465
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1681
1466
|
|
|
1682
|
-
IN_MEMORY =
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
PROMPT_CACHE_RETENTION_24H =
|
|
1688
|
-
T.let(
|
|
1689
|
-
:"24h",
|
|
1690
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::TaggedSymbol
|
|
1691
|
-
)
|
|
1467
|
+
IN_MEMORY = T.let(:in_memory, OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::TaggedSymbol)
|
|
1468
|
+
PROMPT_CACHE_RETENTION_24H = T.let(
|
|
1469
|
+
:"24h",
|
|
1470
|
+
OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::TaggedSymbol
|
|
1471
|
+
)
|
|
1692
1472
|
|
|
1693
|
-
sig
|
|
1694
|
-
override.returns(
|
|
1695
|
-
T::Array[
|
|
1696
|
-
OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::TaggedSymbol
|
|
1697
|
-
]
|
|
1698
|
-
)
|
|
1699
|
-
end
|
|
1473
|
+
sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::TaggedSymbol]) }
|
|
1700
1474
|
def self.values
|
|
1701
1475
|
end
|
|
1702
1476
|
end
|
|
@@ -1714,25 +1488,19 @@ module OpenAI
|
|
|
1714
1488
|
module ResponseFormat
|
|
1715
1489
|
extend OpenAI::Internal::Type::Union
|
|
1716
1490
|
|
|
1717
|
-
Variants =
|
|
1718
|
-
T.
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
OpenAI::ResponseFormatJSONObject
|
|
1724
|
-
)
|
|
1725
|
-
end
|
|
1726
|
-
|
|
1727
|
-
sig do
|
|
1728
|
-
override.returns(
|
|
1729
|
-
T::Array[
|
|
1730
|
-
OpenAI::Chat::CompletionCreateParams::ResponseFormat::Variants
|
|
1731
|
-
]
|
|
1491
|
+
Variants = T.type_alias do
|
|
1492
|
+
T.any(
|
|
1493
|
+
OpenAI::ResponseFormatText,
|
|
1494
|
+
OpenAI::ResponseFormatJSONSchema,
|
|
1495
|
+
OpenAI::StructuredOutput::JsonSchemaConverter,
|
|
1496
|
+
OpenAI::ResponseFormatJSONObject
|
|
1732
1497
|
)
|
|
1733
1498
|
end
|
|
1499
|
+
|
|
1500
|
+
sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::ResponseFormat::Variants]) }
|
|
1734
1501
|
def self.variants
|
|
1735
1502
|
end
|
|
1503
|
+
|
|
1736
1504
|
end
|
|
1737
1505
|
|
|
1738
1506
|
# Specifies the processing type used for serving the request.
|
|
@@ -1758,50 +1526,17 @@ module OpenAI
|
|
|
1758
1526
|
module ServiceTier
|
|
1759
1527
|
extend OpenAI::Internal::Type::Enum
|
|
1760
1528
|
|
|
1761
|
-
TaggedSymbol =
|
|
1762
|
-
T.type_alias do
|
|
1763
|
-
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::ServiceTier)
|
|
1764
|
-
end
|
|
1529
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Chat::CompletionCreateParams::ServiceTier) }
|
|
1765
1530
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1766
1531
|
|
|
1767
|
-
AUTO =
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
T.let(
|
|
1774
|
-
:default,
|
|
1775
|
-
OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
|
|
1776
|
-
)
|
|
1777
|
-
FLEX =
|
|
1778
|
-
T.let(
|
|
1779
|
-
:flex,
|
|
1780
|
-
OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
|
|
1781
|
-
)
|
|
1782
|
-
SCALE =
|
|
1783
|
-
T.let(
|
|
1784
|
-
:scale,
|
|
1785
|
-
OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
|
|
1786
|
-
)
|
|
1787
|
-
PRIORITY =
|
|
1788
|
-
T.let(
|
|
1789
|
-
:priority,
|
|
1790
|
-
OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
|
|
1791
|
-
)
|
|
1792
|
-
FAST =
|
|
1793
|
-
T.let(
|
|
1794
|
-
:fast,
|
|
1795
|
-
OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
|
|
1796
|
-
)
|
|
1532
|
+
AUTO = T.let(:auto, OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol)
|
|
1533
|
+
DEFAULT = T.let(:default, OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol)
|
|
1534
|
+
FLEX = T.let(:flex, OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol)
|
|
1535
|
+
SCALE = T.let(:scale, OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol)
|
|
1536
|
+
PRIORITY = T.let(:priority, OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol)
|
|
1537
|
+
FAST = T.let(:fast, OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol)
|
|
1797
1538
|
|
|
1798
|
-
sig
|
|
1799
|
-
override.returns(
|
|
1800
|
-
T::Array[
|
|
1801
|
-
OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
|
|
1802
|
-
]
|
|
1803
|
-
)
|
|
1804
|
-
end
|
|
1539
|
+
sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol]) }
|
|
1805
1540
|
def self.values
|
|
1806
1541
|
end
|
|
1807
1542
|
end
|
|
@@ -1815,19 +1550,15 @@ module OpenAI
|
|
|
1815
1550
|
|
|
1816
1551
|
Variants = T.type_alias { T.nilable(T.any(String, T::Array[String])) }
|
|
1817
1552
|
|
|
1818
|
-
sig
|
|
1819
|
-
override.returns(
|
|
1820
|
-
T::Array[OpenAI::Chat::CompletionCreateParams::Stop::Variants]
|
|
1821
|
-
)
|
|
1822
|
-
end
|
|
1553
|
+
sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::Stop::Variants]) }
|
|
1823
1554
|
def self.variants
|
|
1824
1555
|
end
|
|
1825
1556
|
|
|
1826
|
-
StringArray =
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1557
|
+
StringArray = T.let(
|
|
1558
|
+
OpenAI::Internal::Type::ArrayOf[String],
|
|
1559
|
+
OpenAI::Internal::Type::Converter
|
|
1560
|
+
)
|
|
1561
|
+
|
|
1831
1562
|
end
|
|
1832
1563
|
|
|
1833
1564
|
# Constrains the verbosity of the model's response. Lower values will result in
|
|
@@ -1837,85 +1568,53 @@ module OpenAI
|
|
|
1837
1568
|
module Verbosity
|
|
1838
1569
|
extend OpenAI::Internal::Type::Enum
|
|
1839
1570
|
|
|
1840
|
-
TaggedSymbol =
|
|
1841
|
-
T.type_alias do
|
|
1842
|
-
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::Verbosity)
|
|
1843
|
-
end
|
|
1571
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Chat::CompletionCreateParams::Verbosity) }
|
|
1844
1572
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1845
1573
|
|
|
1846
|
-
LOW =
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
OpenAI::Chat::CompletionCreateParams::Verbosity::TaggedSymbol
|
|
1850
|
-
)
|
|
1851
|
-
MEDIUM =
|
|
1852
|
-
T.let(
|
|
1853
|
-
:medium,
|
|
1854
|
-
OpenAI::Chat::CompletionCreateParams::Verbosity::TaggedSymbol
|
|
1855
|
-
)
|
|
1856
|
-
HIGH =
|
|
1857
|
-
T.let(
|
|
1858
|
-
:high,
|
|
1859
|
-
OpenAI::Chat::CompletionCreateParams::Verbosity::TaggedSymbol
|
|
1860
|
-
)
|
|
1574
|
+
LOW = T.let(:low, OpenAI::Chat::CompletionCreateParams::Verbosity::TaggedSymbol)
|
|
1575
|
+
MEDIUM = T.let(:medium, OpenAI::Chat::CompletionCreateParams::Verbosity::TaggedSymbol)
|
|
1576
|
+
HIGH = T.let(:high, OpenAI::Chat::CompletionCreateParams::Verbosity::TaggedSymbol)
|
|
1861
1577
|
|
|
1862
|
-
sig
|
|
1863
|
-
override.returns(
|
|
1864
|
-
T::Array[
|
|
1865
|
-
OpenAI::Chat::CompletionCreateParams::Verbosity::TaggedSymbol
|
|
1866
|
-
]
|
|
1867
|
-
)
|
|
1868
|
-
end
|
|
1578
|
+
sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::Verbosity::TaggedSymbol]) }
|
|
1869
1579
|
def self.values
|
|
1870
1580
|
end
|
|
1871
1581
|
end
|
|
1872
1582
|
|
|
1873
1583
|
class WebSearchOptions < OpenAI::Internal::Type::BaseModel
|
|
1874
|
-
OrHash =
|
|
1875
|
-
T.
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
end
|
|
1584
|
+
OrHash = T.type_alias do
|
|
1585
|
+
T.any(
|
|
1586
|
+
OpenAI::Chat::CompletionCreateParams::WebSearchOptions,
|
|
1587
|
+
OpenAI::Internal::AnyHash
|
|
1588
|
+
)
|
|
1589
|
+
end
|
|
1881
1590
|
|
|
1882
1591
|
# High level guidance for the amount of context window space to use for the
|
|
1883
1592
|
# search. One of `low`, `medium`, or `high`. `medium` is the default.
|
|
1884
|
-
sig
|
|
1885
|
-
returns(
|
|
1886
|
-
|
|
1887
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::OrSymbol
|
|
1888
|
-
)
|
|
1889
|
-
)
|
|
1890
|
-
end
|
|
1593
|
+
sig {
|
|
1594
|
+
returns(T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::OrSymbol))
|
|
1595
|
+
}
|
|
1891
1596
|
attr_reader :search_context_size
|
|
1892
1597
|
|
|
1893
1598
|
sig do
|
|
1894
1599
|
params(
|
|
1895
|
-
search_context_size:
|
|
1896
|
-
|
|
1897
|
-
|
|
1600
|
+
search_context_size: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::OrSymbol
|
|
1601
|
+
)
|
|
1602
|
+
.void
|
|
1898
1603
|
end
|
|
1604
|
+
|
|
1899
1605
|
attr_writer :search_context_size
|
|
1900
1606
|
|
|
1901
1607
|
# Approximate location parameters for the search.
|
|
1902
|
-
sig
|
|
1903
|
-
returns(
|
|
1904
|
-
T.nilable(
|
|
1905
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation
|
|
1906
|
-
)
|
|
1907
|
-
)
|
|
1908
|
-
end
|
|
1608
|
+
sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation)) }
|
|
1909
1609
|
attr_reader :user_location
|
|
1910
1610
|
|
|
1911
1611
|
sig do
|
|
1912
1612
|
params(
|
|
1913
|
-
user_location:
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
)
|
|
1917
|
-
).void
|
|
1613
|
+
user_location: T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::OrHash)
|
|
1614
|
+
)
|
|
1615
|
+
.void
|
|
1918
1616
|
end
|
|
1617
|
+
|
|
1919
1618
|
attr_writer :user_location
|
|
1920
1619
|
|
|
1921
1620
|
# This tool searches the web for relevant results to use in a response. Learn more
|
|
@@ -1923,19 +1622,21 @@ module OpenAI
|
|
|
1923
1622
|
# [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
|
|
1924
1623
|
sig do
|
|
1925
1624
|
params(
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
).returns(T.attached_class)
|
|
1625
|
+
|
|
1626
|
+
search_context_size: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::OrSymbol,
|
|
1627
|
+
|
|
1628
|
+
user_location: T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::OrHash)
|
|
1629
|
+
)
|
|
1630
|
+
.returns(T.attached_class)
|
|
1933
1631
|
end
|
|
1934
1632
|
def self.new(
|
|
1633
|
+
|
|
1935
1634
|
# High level guidance for the amount of context window space to use for the
|
|
1936
1635
|
# search. One of `low`, `medium`, or `high`. `medium` is the default.
|
|
1937
1636
|
search_context_size: nil,
|
|
1637
|
+
|
|
1938
1638
|
# Approximate location parameters for the search.
|
|
1639
|
+
|
|
1939
1640
|
user_location: nil
|
|
1940
1641
|
)
|
|
1941
1642
|
end
|
|
@@ -1943,12 +1644,8 @@ module OpenAI
|
|
|
1943
1644
|
sig do
|
|
1944
1645
|
override.returns(
|
|
1945
1646
|
{
|
|
1946
|
-
search_context_size:
|
|
1947
|
-
|
|
1948
|
-
user_location:
|
|
1949
|
-
T.nilable(
|
|
1950
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation
|
|
1951
|
-
)
|
|
1647
|
+
search_context_size: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::OrSymbol,
|
|
1648
|
+
user_location: T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation)
|
|
1952
1649
|
}
|
|
1953
1650
|
)
|
|
1954
1651
|
end
|
|
@@ -1960,36 +1657,21 @@ module OpenAI
|
|
|
1960
1657
|
module SearchContextSize
|
|
1961
1658
|
extend OpenAI::Internal::Type::Enum
|
|
1962
1659
|
|
|
1963
|
-
TaggedSymbol =
|
|
1964
|
-
T.
|
|
1965
|
-
|
|
1966
|
-
Symbol,
|
|
1967
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize
|
|
1968
|
-
)
|
|
1969
|
-
end
|
|
1660
|
+
TaggedSymbol = T.type_alias {
|
|
1661
|
+
T.all(Symbol, OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize)
|
|
1662
|
+
}
|
|
1970
1663
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1971
1664
|
|
|
1972
|
-
LOW =
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
|
|
1978
|
-
T.let(
|
|
1979
|
-
:medium,
|
|
1980
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol
|
|
1981
|
-
)
|
|
1982
|
-
HIGH =
|
|
1983
|
-
T.let(
|
|
1984
|
-
:high,
|
|
1985
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol
|
|
1986
|
-
)
|
|
1665
|
+
LOW = T.let(:low, OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol)
|
|
1666
|
+
MEDIUM = T.let(
|
|
1667
|
+
:medium,
|
|
1668
|
+
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol
|
|
1669
|
+
)
|
|
1670
|
+
HIGH = T.let(:high, OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol)
|
|
1987
1671
|
|
|
1988
1672
|
sig do
|
|
1989
1673
|
override.returns(
|
|
1990
|
-
T::Array[
|
|
1991
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol
|
|
1992
|
-
]
|
|
1674
|
+
T::Array[OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol]
|
|
1993
1675
|
)
|
|
1994
1676
|
end
|
|
1995
1677
|
def self.values
|
|
@@ -1997,28 +1679,24 @@ module OpenAI
|
|
|
1997
1679
|
end
|
|
1998
1680
|
|
|
1999
1681
|
class UserLocation < OpenAI::Internal::Type::BaseModel
|
|
2000
|
-
OrHash =
|
|
2001
|
-
T.
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
OpenAI::Internal::AnyHash
|
|
2005
|
-
)
|
|
2006
|
-
end
|
|
2007
|
-
|
|
2008
|
-
# Approximate location parameters for the search.
|
|
2009
|
-
sig do
|
|
2010
|
-
returns(
|
|
2011
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate
|
|
1682
|
+
OrHash = T.type_alias do
|
|
1683
|
+
T.any(
|
|
1684
|
+
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation,
|
|
1685
|
+
OpenAI::Internal::AnyHash
|
|
2012
1686
|
)
|
|
2013
1687
|
end
|
|
1688
|
+
|
|
1689
|
+
# Approximate location parameters for the search.
|
|
1690
|
+
sig { returns(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate) }
|
|
2014
1691
|
attr_reader :approximate
|
|
2015
1692
|
|
|
2016
1693
|
sig do
|
|
2017
1694
|
params(
|
|
2018
|
-
approximate:
|
|
2019
|
-
|
|
2020
|
-
|
|
1695
|
+
approximate: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate::OrHash
|
|
1696
|
+
)
|
|
1697
|
+
.void
|
|
2021
1698
|
end
|
|
1699
|
+
|
|
2022
1700
|
attr_writer :approximate
|
|
2023
1701
|
|
|
2024
1702
|
# The type of location approximation. Always `approximate`.
|
|
@@ -2028,15 +1706,20 @@ module OpenAI
|
|
|
2028
1706
|
# Approximate location parameters for the search.
|
|
2029
1707
|
sig do
|
|
2030
1708
|
params(
|
|
2031
|
-
|
|
2032
|
-
|
|
1709
|
+
|
|
1710
|
+
approximate: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate::OrHash,
|
|
1711
|
+
|
|
2033
1712
|
type: Symbol
|
|
2034
|
-
)
|
|
1713
|
+
)
|
|
1714
|
+
.returns(T.attached_class)
|
|
2035
1715
|
end
|
|
2036
1716
|
def self.new(
|
|
1717
|
+
|
|
2037
1718
|
# Approximate location parameters for the search.
|
|
2038
1719
|
approximate:,
|
|
1720
|
+
|
|
2039
1721
|
# The type of location approximation. Always `approximate`.
|
|
1722
|
+
|
|
2040
1723
|
type: :approximate
|
|
2041
1724
|
)
|
|
2042
1725
|
end
|
|
@@ -2044,8 +1727,7 @@ module OpenAI
|
|
|
2044
1727
|
sig do
|
|
2045
1728
|
override.returns(
|
|
2046
1729
|
{
|
|
2047
|
-
approximate:
|
|
2048
|
-
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate,
|
|
1730
|
+
approximate: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate,
|
|
2049
1731
|
type: Symbol
|
|
2050
1732
|
}
|
|
2051
1733
|
)
|
|
@@ -2054,13 +1736,12 @@ module OpenAI
|
|
|
2054
1736
|
end
|
|
2055
1737
|
|
|
2056
1738
|
class Approximate < OpenAI::Internal::Type::BaseModel
|
|
2057
|
-
OrHash =
|
|
2058
|
-
T.
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
|
|
2062
|
-
|
|
2063
|
-
end
|
|
1739
|
+
OrHash = T.type_alias do
|
|
1740
|
+
T.any(
|
|
1741
|
+
OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate,
|
|
1742
|
+
OpenAI::Internal::AnyHash
|
|
1743
|
+
)
|
|
1744
|
+
end
|
|
2064
1745
|
|
|
2065
1746
|
# Free text input for the city of the user, e.g. `San Francisco`.
|
|
2066
1747
|
sig { returns(T.nilable(String)) }
|
|
@@ -2095,42 +1776,51 @@ module OpenAI
|
|
|
2095
1776
|
# Approximate location parameters for the search.
|
|
2096
1777
|
sig do
|
|
2097
1778
|
params(
|
|
1779
|
+
|
|
2098
1780
|
city: String,
|
|
1781
|
+
|
|
2099
1782
|
country: String,
|
|
1783
|
+
|
|
2100
1784
|
region: String,
|
|
1785
|
+
|
|
2101
1786
|
timezone: String
|
|
2102
|
-
)
|
|
1787
|
+
)
|
|
1788
|
+
.returns(T.attached_class)
|
|
2103
1789
|
end
|
|
2104
1790
|
def self.new(
|
|
1791
|
+
|
|
2105
1792
|
# Free text input for the city of the user, e.g. `San Francisco`.
|
|
2106
1793
|
city: nil,
|
|
1794
|
+
|
|
2107
1795
|
# The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
|
|
2108
1796
|
# the user, e.g. `US`.
|
|
2109
1797
|
country: nil,
|
|
1798
|
+
|
|
2110
1799
|
# Free text input for the region of the user, e.g. `California`.
|
|
2111
1800
|
region: nil,
|
|
1801
|
+
|
|
2112
1802
|
# The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
|
|
2113
1803
|
# user, e.g. `America/Los_Angeles`.
|
|
1804
|
+
|
|
2114
1805
|
timezone: nil
|
|
2115
1806
|
)
|
|
2116
1807
|
end
|
|
2117
1808
|
|
|
2118
1809
|
sig do
|
|
2119
1810
|
override.returns(
|
|
2120
|
-
{
|
|
2121
|
-
city: String,
|
|
2122
|
-
country: String,
|
|
2123
|
-
region: String,
|
|
2124
|
-
timezone: String
|
|
2125
|
-
}
|
|
1811
|
+
{city: String, country: String, region: String, timezone: String}
|
|
2126
1812
|
)
|
|
2127
1813
|
end
|
|
2128
1814
|
def to_hash
|
|
2129
1815
|
end
|
|
1816
|
+
|
|
2130
1817
|
end
|
|
2131
1818
|
end
|
|
2132
1819
|
end
|
|
1820
|
+
|
|
2133
1821
|
end
|
|
1822
|
+
|
|
2134
1823
|
end
|
|
1824
|
+
|
|
2135
1825
|
end
|
|
2136
1826
|
end
|