openai 0.86.0 → 0.88.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 +16 -0
- data/README.md +10 -1
- data/examples/audio/record_and_play.rb +19 -0
- data/examples/responses/websocket_workflows.rb +159 -0
- data/lib/openai/helpers/local_audio/errors.rb +27 -0
- data/lib/openai/helpers/local_audio/process.rb +158 -0
- data/lib/openai/helpers/local_audio.rb +157 -0
- data/lib/openai/helpers/realtime/connection.rb +20 -2
- data/lib/openai/helpers/realtime/errors.rb +18 -0
- data/lib/openai/helpers/realtime/recovery.rb +489 -0
- data/lib/openai/helpers/realtime/resources/realtime_extension.rb +26 -1
- data/lib/openai/helpers/realtime.rb +1 -0
- data/lib/openai/models/admin/organization/admin_api_key.rb +26 -13
- data/lib/openai/models/admin/organization/admin_api_key_create_params.rb +3 -4
- data/lib/openai/models/admin/organization/admin_api_key_create_response.rb +16 -8
- data/lib/openai/models/admin/organization/admin_api_key_delete_params.rb +2 -1
- data/lib/openai/models/admin/organization/admin_api_key_list_params.rb +6 -3
- data/lib/openai/models/admin/organization/admin_api_key_retrieve_params.rb +2 -1
- data/lib/openai/models/admin/organization/audit_log_list_params.rb +47 -22
- data/lib/openai/models/admin/organization/audit_log_list_response.rb +486 -254
- data/lib/openai/models/admin/organization/certificate.rb +24 -11
- data/lib/openai/models/admin/organization/certificate_activate_response.rb +14 -7
- data/lib/openai/models/admin/organization/certificate_create_params.rb +4 -2
- data/lib/openai/models/admin/organization/certificate_deactivate_response.rb +14 -7
- data/lib/openai/models/admin/organization/certificate_delete_response.rb +4 -2
- data/lib/openai/models/admin/organization/certificate_list_params.rb +11 -6
- data/lib/openai/models/admin/organization/certificate_list_response.rb +14 -7
- data/lib/openai/models/admin/organization/certificate_retrieve_params.rb +3 -5
- data/lib/openai/models/admin/organization/certificate_update_params.rb +2 -1
- data/lib/openai/models/admin/organization/data_retention_update_params.rb +2 -1
- data/lib/openai/models/admin/organization/group.rb +11 -8
- data/lib/openai/models/admin/organization/group_create_params.rb +2 -1
- data/lib/openai/models/admin/organization/group_delete_response.rb +6 -3
- data/lib/openai/models/admin/organization/group_list_params.rb +10 -6
- data/lib/openai/models/admin/organization/group_update_params.rb +2 -1
- data/lib/openai/models/admin/organization/group_update_response.rb +9 -7
- data/lib/openai/models/admin/organization/groups/organization_group_user.rb +6 -3
- data/lib/openai/models/admin/organization/groups/role_create_params.rb +2 -1
- data/lib/openai/models/admin/organization/groups/role_create_response.rb +16 -8
- data/lib/openai/models/admin/organization/groups/role_delete_response.rb +5 -6
- data/lib/openai/models/admin/organization/groups/role_list_params.rb +7 -6
- data/lib/openai/models/admin/organization/groups/role_list_response.rb +24 -13
- data/lib/openai/models/admin/organization/groups/role_retrieve_response.rb +24 -13
- data/lib/openai/models/admin/organization/groups/user_create_params.rb +2 -1
- data/lib/openai/models/admin/organization/groups/user_create_response.rb +6 -3
- data/lib/openai/models/admin/organization/groups/user_delete_response.rb +4 -2
- data/lib/openai/models/admin/organization/groups/user_list_params.rb +8 -6
- data/lib/openai/models/admin/organization/groups/user_retrieve_response.rb +12 -6
- data/lib/openai/models/admin/organization/invite.rb +22 -12
- data/lib/openai/models/admin/organization/invite_create_params.rb +13 -8
- data/lib/openai/models/admin/organization/invite_delete_response.rb +2 -1
- data/lib/openai/models/admin/organization/invite_list_params.rb +8 -5
- data/lib/openai/models/admin/organization/organization_data_retention.rb +4 -2
- data/lib/openai/models/admin/organization/organization_spend_alert.rb +18 -9
- data/lib/openai/models/admin/organization/organization_spend_alert_deleted.rb +6 -3
- data/lib/openai/models/admin/organization/organization_spend_limit.rb +13 -9
- data/lib/openai/models/admin/organization/organization_spend_limit_deleted.rb +4 -2
- data/lib/openai/models/admin/organization/organization_user.rb +32 -16
- data/lib/openai/models/admin/organization/project.rb +16 -8
- data/lib/openai/models/admin/organization/project_create_params.rb +18 -9
- data/lib/openai/models/admin/organization/project_list_params.rb +11 -6
- data/lib/openai/models/admin/organization/project_update_params.rb +7 -6
- data/lib/openai/models/admin/organization/projects/api_key_list_params.rb +14 -7
- data/lib/openai/models/admin/organization/projects/certificate_activate_response.rb +14 -7
- data/lib/openai/models/admin/organization/projects/certificate_deactivate_response.rb +14 -7
- data/lib/openai/models/admin/organization/projects/certificate_list_params.rb +11 -7
- data/lib/openai/models/admin/organization/projects/certificate_list_response.rb +14 -7
- data/lib/openai/models/admin/organization/projects/data_retention_update_params.rb +2 -1
- data/lib/openai/models/admin/organization/projects/group_create_params.rb +4 -2
- data/lib/openai/models/admin/organization/projects/group_delete_response.rb +4 -2
- data/lib/openai/models/admin/organization/projects/group_list_params.rb +7 -7
- data/lib/openai/models/admin/organization/projects/group_retrieve_params.rb +2 -1
- data/lib/openai/models/admin/organization/projects/groups/role_create_params.rb +2 -1
- data/lib/openai/models/admin/organization/projects/groups/role_create_response.rb +16 -8
- data/lib/openai/models/admin/organization/projects/groups/role_delete_response.rb +5 -6
- data/lib/openai/models/admin/organization/projects/groups/role_list_params.rb +7 -7
- data/lib/openai/models/admin/organization/projects/groups/role_list_response.rb +24 -13
- data/lib/openai/models/admin/organization/projects/groups/role_retrieve_response.rb +24 -13
- data/lib/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rb +20 -10
- data/lib/openai/models/admin/organization/projects/model_permission_update_params.rb +4 -2
- data/lib/openai/models/admin/organization/projects/project_api_key.rb +50 -20
- data/lib/openai/models/admin/organization/projects/project_data_retention.rb +4 -2
- data/lib/openai/models/admin/organization/projects/project_group.rb +12 -6
- data/lib/openai/models/admin/organization/projects/project_hosted_tool_permissions.rb +20 -10
- data/lib/openai/models/admin/organization/projects/project_model_permissions.rb +6 -3
- data/lib/openai/models/admin/organization/projects/project_model_permissions_deleted.rb +4 -2
- data/lib/openai/models/admin/organization/projects/project_rate_limit.rb +18 -9
- data/lib/openai/models/admin/organization/projects/project_service_account.rb +10 -5
- data/lib/openai/models/admin/organization/projects/project_spend_alert.rb +18 -9
- data/lib/openai/models/admin/organization/projects/project_spend_alert_deleted.rb +6 -3
- data/lib/openai/models/admin/organization/projects/project_spend_limit.rb +13 -10
- data/lib/openai/models/admin/organization/projects/project_spend_limit_deleted.rb +4 -2
- data/lib/openai/models/admin/organization/projects/project_user.rb +12 -6
- data/lib/openai/models/admin/organization/projects/rate_limit_list_rate_limits_params.rb +12 -7
- data/lib/openai/models/admin/organization/projects/rate_limit_update_rate_limit_params.rb +12 -6
- data/lib/openai/models/admin/organization/projects/role_create_params.rb +6 -3
- data/lib/openai/models/admin/organization/projects/role_delete_response.rb +6 -3
- data/lib/openai/models/admin/organization/projects/role_list_params.rb +7 -7
- data/lib/openai/models/admin/organization/projects/role_update_params.rb +6 -3
- data/lib/openai/models/admin/organization/projects/service_account_create_params.rb +22 -3
- data/lib/openai/models/admin/organization/projects/service_account_create_response.rb +17 -7
- data/lib/openai/models/admin/organization/projects/service_account_list_params.rb +8 -6
- data/lib/openai/models/admin/organization/projects/service_account_update_params.rb +4 -2
- data/lib/openai/models/admin/organization/projects/service_accounts/api_key_create_params.rb +10 -5
- data/lib/openai/models/admin/organization/projects/service_accounts/api_key_create_response.rb +13 -10
- data/lib/openai/models/admin/organization/projects/spend_alert_create_params.rb +14 -7
- data/lib/openai/models/admin/organization/projects/spend_alert_list_params.rb +10 -8
- data/lib/openai/models/admin/organization/projects/spend_alert_update_params.rb +14 -7
- data/lib/openai/models/admin/organization/projects/spend_limit_update_params.rb +7 -7
- data/lib/openai/models/admin/organization/projects/user_create_params.rb +6 -3
- data/lib/openai/models/admin/organization/projects/user_list_params.rb +8 -6
- data/lib/openai/models/admin/organization/projects/user_update_params.rb +2 -1
- data/lib/openai/models/admin/organization/projects/users/role_create_params.rb +2 -1
- data/lib/openai/models/admin/organization/projects/users/role_create_response.rb +6 -3
- data/lib/openai/models/admin/organization/projects/users/role_delete_response.rb +5 -6
- data/lib/openai/models/admin/organization/projects/users/role_list_params.rb +7 -7
- data/lib/openai/models/admin/organization/projects/users/role_list_response.rb +24 -13
- data/lib/openai/models/admin/organization/projects/users/role_retrieve_response.rb +24 -13
- data/lib/openai/models/admin/organization/role.rb +15 -10
- data/lib/openai/models/admin/organization/role_create_params.rb +6 -3
- data/lib/openai/models/admin/organization/role_delete_response.rb +6 -3
- data/lib/openai/models/admin/organization/role_list_params.rb +7 -6
- data/lib/openai/models/admin/organization/role_update_params.rb +6 -3
- data/lib/openai/models/admin/organization/spend_alert_create_params.rb +14 -7
- data/lib/openai/models/admin/organization/spend_alert_list_params.rb +10 -7
- data/lib/openai/models/admin/organization/spend_alert_update_params.rb +14 -7
- data/lib/openai/models/admin/organization/spend_limit_update_params.rb +7 -6
- data/lib/openai/models/admin/organization/usage_audio_speeches_params.rb +26 -13
- data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_params.rb +26 -13
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_params.rb +20 -10
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_completions_params.rb +30 -13
- data/lib/openai/models/admin/organization/usage_completions_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_costs_params.rb +23 -12
- data/lib/openai/models/admin/organization/usage_costs_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_embeddings_params.rb +26 -12
- data/lib/openai/models/admin/organization/usage_embeddings_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_file_search_calls_params.rb +27 -13
- data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_images_params.rb +33 -14
- data/lib/openai/models/admin/organization/usage_images_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_moderations_params.rb +26 -12
- data/lib/openai/models/admin/organization/usage_moderations_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_vector_stores_params.rb +20 -9
- data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +205 -121
- data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +29 -14
- data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +205 -121
- data/lib/openai/models/admin/organization/user_list_params.rb +10 -6
- data/lib/openai/models/admin/organization/user_update_params.rb +8 -4
- data/lib/openai/models/admin/organization/users/role_create_params.rb +2 -1
- data/lib/openai/models/admin/organization/users/role_create_response.rb +6 -3
- data/lib/openai/models/admin/organization/users/role_delete_response.rb +5 -6
- data/lib/openai/models/admin/organization/users/role_list_params.rb +7 -6
- data/lib/openai/models/admin/organization/users/role_list_response.rb +24 -13
- data/lib/openai/models/admin/organization/users/role_retrieve_response.rb +24 -13
- data/lib/openai/models/audio/speech_create_params.rb +34 -16
- data/lib/openai/models/audio/transcription.rb +35 -20
- data/lib/openai/models/audio/transcription_create_params.rb +86 -24
- data/lib/openai/models/audio/transcription_diarized.rb +28 -14
- data/lib/openai/models/audio/transcription_diarized_segment.rb +14 -9
- data/lib/openai/models/audio/transcription_language.rb +2 -1
- data/lib/openai/models/audio/transcription_segment.rb +23 -13
- data/lib/openai/models/audio/transcription_stream_event.rb +4 -4
- data/lib/openai/models/audio/transcription_text_delta_event.rb +19 -16
- data/lib/openai/models/audio/transcription_text_done_event.rb +36 -24
- data/lib/openai/models/audio/transcription_text_segment_event.rb +13 -7
- data/lib/openai/models/audio/transcription_verbose.rb +16 -8
- data/lib/openai/models/audio/transcription_word.rb +6 -3
- data/lib/openai/models/audio/translation_create_params.rb +26 -8
- data/lib/openai/models/audio/translation_verbose.rb +8 -4
- data/lib/openai/models/auto_file_chunking_strategy_param.rb +2 -1
- data/lib/openai/models/batch.rb +55 -26
- data/lib/openai/models/batch_create_params.rb +40 -14
- data/lib/openai/models/batch_error.rb +8 -4
- data/lib/openai/models/batch_list_params.rb +8 -5
- data/lib/openai/models/batch_request_counts.rb +6 -3
- data/lib/openai/models/batch_usage.rb +16 -11
- data/lib/openai/models/beta/assistant.rb +99 -49
- data/lib/openai/models/beta/assistant_create_params.rb +127 -61
- data/lib/openai/models/beta/assistant_list_params.rb +16 -7
- data/lib/openai/models/beta/assistant_response_format_option.rb +5 -5
- data/lib/openai/models/beta/assistant_stream_event.rb +137 -185
- data/lib/openai/models/beta/assistant_tool_choice.rb +2 -1
- data/lib/openai/models/beta/assistant_tool_choice_function.rb +2 -1
- data/lib/openai/models/beta/assistant_update_params.rb +94 -41
- data/lib/openai/models/beta/beta_apply_patch_tool.rb +4 -3
- data/lib/openai/models/beta/beta_compacted_response.rb +12 -8
- data/lib/openai/models/beta/beta_computer_action.rb +78 -58
- data/lib/openai/models/beta/beta_computer_tool.rb +3 -2
- data/lib/openai/models/beta/beta_computer_use_preview_tool.rb +9 -5
- data/lib/openai/models/beta/beta_container_auto.rb +10 -5
- data/lib/openai/models/beta/beta_container_network_policy_allowlist.rb +6 -3
- data/lib/openai/models/beta/beta_container_network_policy_disabled.rb +2 -1
- data/lib/openai/models/beta/beta_container_network_policy_domain_secret.rb +6 -3
- data/lib/openai/models/beta/beta_container_reference.rb +4 -2
- data/lib/openai/models/beta/beta_custom_tool.rb +24 -16
- data/lib/openai/models/beta/beta_easy_input_message.rb +13 -7
- data/lib/openai/models/beta/beta_file_search_tool.rb +64 -37
- data/lib/openai/models/beta/beta_function_shell_tool.rb +4 -3
- data/lib/openai/models/beta/beta_function_tool.rb +19 -13
- data/lib/openai/models/beta/beta_inline_skill.rb +8 -4
- data/lib/openai/models/beta/beta_inline_skill_source.rb +6 -3
- data/lib/openai/models/beta/beta_local_environment.rb +4 -2
- data/lib/openai/models/beta/beta_local_skill.rb +6 -3
- data/lib/openai/models/beta/beta_namespace_tool.rb +23 -13
- data/lib/openai/models/beta/beta_response.rb +372 -165
- data/lib/openai/models/beta/beta_response_apply_patch_tool_call.rb +38 -21
- data/lib/openai/models/beta/beta_response_apply_patch_tool_call_output.rb +21 -13
- data/lib/openai/models/beta/beta_response_audio_delta_event.rb +10 -8
- data/lib/openai/models/beta/beta_response_audio_done_event.rb +8 -7
- data/lib/openai/models/beta/beta_response_audio_transcript_delta_event.rb +10 -8
- data/lib/openai/models/beta/beta_response_audio_transcript_done_event.rb +8 -7
- data/lib/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rb +15 -11
- data/lib/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rb +14 -7
- data/lib/openai/models/beta/beta_response_code_interpreter_call_completed_event.rb +13 -10
- data/lib/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rb +13 -10
- data/lib/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rb +13 -10
- data/lib/openai/models/beta/beta_response_code_interpreter_tool_call.rb +26 -15
- data/lib/openai/models/beta/beta_response_compaction_item.rb +13 -7
- data/lib/openai/models/beta/beta_response_compaction_item_param.rb +11 -6
- data/lib/openai/models/beta/beta_response_completed_event.rb +10 -8
- data/lib/openai/models/beta/beta_response_computer_tool_call.rb +27 -17
- data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +26 -15
- data/lib/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rb +7 -7
- data/lib/openai/models/beta/beta_response_configuration_update_item.rb +13 -10
- data/lib/openai/models/beta/beta_response_configuration_update_item_param.rb +13 -10
- data/lib/openai/models/beta/beta_response_container_reference.rb +2 -1
- data/lib/openai/models/beta/beta_response_content.rb +5 -3
- data/lib/openai/models/beta/beta_response_content_part_added_event.rb +20 -13
- data/lib/openai/models/beta/beta_response_content_part_done_event.rb +20 -13
- data/lib/openai/models/beta/beta_response_conversation_param.rb +2 -1
- data/lib/openai/models/beta/beta_response_created_event.rb +10 -8
- data/lib/openai/models/beta/beta_response_custom_tool_call.rb +22 -14
- data/lib/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rb +14 -7
- data/lib/openai/models/beta/beta_response_custom_tool_call_input_done_event.rb +14 -7
- data/lib/openai/models/beta/beta_response_custom_tool_call_item.rb +23 -14
- data/lib/openai/models/beta/beta_response_custom_tool_call_output.rb +22 -14
- data/lib/openai/models/beta/beta_response_custom_tool_call_output_item.rb +18 -11
- data/lib/openai/models/beta/beta_response_error.rb +12 -9
- data/lib/openai/models/beta/beta_response_error_event.rb +14 -10
- data/lib/openai/models/beta/beta_response_failed_event.rb +10 -8
- data/lib/openai/models/beta/beta_response_file_search_call_completed_event.rb +12 -10
- data/lib/openai/models/beta/beta_response_file_search_call_in_progress_event.rb +12 -10
- data/lib/openai/models/beta/beta_response_file_search_call_searching_event.rb +12 -10
- data/lib/openai/models/beta/beta_response_file_search_tool_call.rb +30 -20
- data/lib/openai/models/beta/beta_response_format_text_config.rb +6 -4
- data/lib/openai/models/beta/beta_response_format_text_json_schema_config.rb +19 -10
- data/lib/openai/models/beta/beta_response_function_call_arguments_delta_event.rb +14 -11
- data/lib/openai/models/beta/beta_response_function_call_arguments_done_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_function_call_output_item.rb +1 -1
- data/lib/openai/models/beta/beta_response_function_shell_call_output_content.rb +12 -6
- data/lib/openai/models/beta/beta_response_function_shell_tool_call.rb +28 -16
- data/lib/openai/models/beta/beta_response_function_shell_tool_call_output.rb +40 -27
- data/lib/openai/models/beta/beta_response_function_tool_call.rb +26 -16
- data/lib/openai/models/beta/beta_response_function_tool_call_item.rb +24 -15
- data/lib/openai/models/beta/beta_response_function_tool_call_output_item.rb +31 -18
- data/lib/openai/models/beta/beta_response_function_web_search.rb +37 -39
- data/lib/openai/models/beta/beta_response_image_gen_call_completed_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_image_gen_call_generating_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_image_gen_call_in_progress_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_image_gen_call_partial_image_event.rb +25 -16
- data/lib/openai/models/beta/beta_response_in_progress_event.rb +10 -8
- data/lib/openai/models/beta/beta_response_incomplete_event.rb +10 -8
- data/lib/openai/models/beta/beta_response_inject_created_event.rb +9 -7
- data/lib/openai/models/beta/beta_response_inject_event.rb +6 -3
- data/lib/openai/models/beta/beta_response_inject_failed_event.rb +17 -11
- data/lib/openai/models/beta/beta_response_input_audio.rb +6 -9
- data/lib/openai/models/beta/beta_response_input_content.rb +1 -1
- data/lib/openai/models/beta/beta_response_input_file.rb +22 -11
- data/lib/openai/models/beta/beta_response_input_file_content.rb +22 -11
- data/lib/openai/models/beta/beta_response_input_image.rb +17 -10
- data/lib/openai/models/beta/beta_response_input_image_content.rb +17 -10
- data/lib/openai/models/beta/beta_response_input_item.rb +560 -291
- data/lib/openai/models/beta/beta_response_input_message_item.rb +16 -10
- data/lib/openai/models/beta/beta_response_input_text.rb +10 -7
- data/lib/openai/models/beta/beta_response_input_text_content.rb +10 -7
- data/lib/openai/models/beta/beta_response_item.rb +316 -150
- data/lib/openai/models/beta/beta_response_local_environment.rb +2 -1
- data/lib/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rb +15 -10
- data/lib/openai/models/beta/beta_response_mcp_call_arguments_done_event.rb +14 -10
- data/lib/openai/models/beta/beta_response_mcp_call_completed_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_mcp_call_failed_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_mcp_call_in_progress_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_mcp_list_tools_completed_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_mcp_list_tools_failed_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rb +12 -6
- data/lib/openai/models/beta/beta_response_output_audio.rb +6 -6
- data/lib/openai/models/beta/beta_response_output_item.rb +328 -155
- data/lib/openai/models/beta/beta_response_output_item_added_event.rb +15 -9
- data/lib/openai/models/beta/beta_response_output_item_done_event.rb +12 -9
- data/lib/openai/models/beta/beta_response_output_message.rb +20 -11
- data/lib/openai/models/beta/beta_response_output_refusal.rb +4 -2
- data/lib/openai/models/beta/beta_response_output_text.rb +42 -25
- data/lib/openai/models/beta/beta_response_output_text_annotation_added_event.rb +54 -31
- data/lib/openai/models/beta/beta_response_prompt.rb +10 -8
- data/lib/openai/models/beta/beta_response_queued_event.rb +10 -5
- data/lib/openai/models/beta/beta_response_reasoning_item.rb +33 -17
- data/lib/openai/models/beta/beta_response_reasoning_summary_part_added_event.rb +20 -14
- data/lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb +23 -15
- data/lib/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rb +16 -12
- data/lib/openai/models/beta/beta_response_reasoning_summary_text_done_event.rb +16 -12
- data/lib/openai/models/beta/beta_response_reasoning_text_delta_event.rb +16 -11
- data/lib/openai/models/beta/beta_response_reasoning_text_done_event.rb +16 -11
- data/lib/openai/models/beta/beta_response_refusal_delta_event.rb +16 -11
- data/lib/openai/models/beta/beta_response_refusal_done_event.rb +16 -11
- data/lib/openai/models/beta/beta_response_shell_call_command_added_event.rb +14 -7
- data/lib/openai/models/beta/beta_response_shell_call_command_delta_event.rb +16 -8
- data/lib/openai/models/beta/beta_response_shell_call_command_done_event.rb +14 -7
- data/lib/openai/models/beta/beta_response_shell_call_output_content_delta_event.rb +20 -10
- data/lib/openai/models/beta/beta_response_shell_call_output_content_done_event.rb +31 -20
- data/lib/openai/models/beta/beta_response_steer_accepted_event.rb +13 -9
- data/lib/openai/models/beta/beta_response_steer_event.rb +14 -6
- data/lib/openai/models/beta/beta_response_steer_failed_event.rb +45 -22
- data/lib/openai/models/beta/beta_response_steer_input.rb +42 -24
- data/lib/openai/models/beta/beta_response_steer_input_content.rb +1 -1
- data/lib/openai/models/beta/beta_response_steer_pending_event.rb +24 -11
- data/lib/openai/models/beta/beta_response_text_config.rb +22 -8
- data/lib/openai/models/beta/beta_response_text_delta_event.rb +28 -22
- data/lib/openai/models/beta/beta_response_text_done_event.rb +28 -22
- data/lib/openai/models/beta/beta_response_tool_search_call.rb +18 -9
- data/lib/openai/models/beta/beta_response_tool_search_output_item.rb +18 -9
- data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +16 -8
- data/lib/openai/models/beta/beta_response_usage.rb +18 -12
- data/lib/openai/models/beta/beta_response_web_search_call_completed_event.rb +12 -10
- data/lib/openai/models/beta/beta_response_web_search_call_in_progress_event.rb +12 -10
- data/lib/openai/models/beta/beta_response_web_search_call_searching_event.rb +12 -10
- data/lib/openai/models/beta/beta_responses_client_event.rb +401 -162
- data/lib/openai/models/beta/beta_responses_server_event.rb +862 -629
- data/lib/openai/models/beta/beta_skill_reference.rb +6 -3
- data/lib/openai/models/beta/beta_tool.rb +236 -129
- data/lib/openai/models/beta/beta_tool_choice_allowed.rb +21 -6
- data/lib/openai/models/beta/beta_tool_choice_apply_patch.rb +2 -1
- data/lib/openai/models/beta/beta_tool_choice_custom.rb +4 -2
- data/lib/openai/models/beta/beta_tool_choice_function.rb +4 -2
- data/lib/openai/models/beta/beta_tool_choice_mcp.rb +6 -6
- data/lib/openai/models/beta/beta_tool_choice_shell.rb +2 -1
- data/lib/openai/models/beta/beta_tool_choice_types.rb +16 -7
- data/lib/openai/models/beta/beta_tool_search_tool.rb +8 -4
- data/lib/openai/models/beta/beta_web_search_preview_tool.rb +21 -15
- data/lib/openai/models/beta/beta_web_search_tool.rb +31 -21
- data/lib/openai/models/beta/chatkit/chat_session.rb +20 -10
- data/lib/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rb +2 -1
- data/lib/openai/models/beta/chatkit/chat_session_chatkit_configuration.rb +6 -3
- data/lib/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rb +23 -21
- data/lib/openai/models/beta/chatkit/chat_session_expires_after_param.rb +4 -2
- data/lib/openai/models/beta/chatkit/chat_session_file_upload.rb +6 -3
- data/lib/openai/models/beta/chatkit/chat_session_history.rb +5 -5
- data/lib/openai/models/beta/chatkit/chat_session_rate_limits.rb +2 -1
- data/lib/openai/models/beta/chatkit/chat_session_rate_limits_param.rb +2 -1
- data/lib/openai/models/beta/chatkit/chat_session_workflow_param.rb +12 -9
- data/lib/openai/models/beta/chatkit/chatkit_attachment.rb +10 -5
- data/lib/openai/models/beta/chatkit/chatkit_response_output_text.rb +22 -11
- data/lib/openai/models/beta/chatkit/chatkit_thread.rb +23 -14
- data/lib/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rb +12 -6
- data/lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb +65 -41
- data/lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb +29 -18
- data/lib/openai/models/beta/chatkit/chatkit_widget_item.rb +12 -6
- data/lib/openai/models/beta/chatkit/session_create_params.rb +12 -8
- data/lib/openai/models/beta/chatkit/thread_delete_response.rb +6 -3
- data/lib/openai/models/beta/chatkit/thread_list_items_params.rb +10 -7
- data/lib/openai/models/beta/chatkit/thread_list_params.rb +13 -8
- data/lib/openai/models/beta/chatkit_workflow.rb +12 -9
- data/lib/openai/models/beta/code_interpreter_tool.rb +2 -1
- data/lib/openai/models/beta/file_search_tool.rb +29 -16
- data/lib/openai/models/beta/function_tool.rb +2 -1
- data/lib/openai/models/beta/message_stream_event.rb +32 -41
- data/lib/openai/models/beta/response_compact_params.rb +89 -46
- data/lib/openai/models/beta/response_create_params.rb +382 -149
- data/lib/openai/models/beta/response_retrieve_params.rb +12 -6
- data/lib/openai/models/beta/responses/beta_response_item_list.rb +10 -5
- data/lib/openai/models/beta/responses/input_item_list_params.rb +13 -7
- data/lib/openai/models/beta/responses/input_token_count_params.rb +113 -42
- data/lib/openai/models/beta/run_step_stream_event.rb +36 -57
- data/lib/openai/models/beta/run_stream_event.rb +61 -72
- data/lib/openai/models/beta/thread.rb +32 -21
- data/lib/openai/models/beta/thread_create_and_run_params.rb +232 -123
- data/lib/openai/models/beta/thread_create_params.rb +89 -52
- data/lib/openai/models/beta/thread_stream_event.rb +7 -7
- data/lib/openai/models/beta/thread_update_params.rb +25 -19
- data/lib/openai/models/beta/threads/file_citation_annotation.rb +6 -3
- data/lib/openai/models/beta/threads/file_citation_delta_annotation.rb +10 -5
- data/lib/openai/models/beta/threads/file_path_annotation.rb +6 -3
- data/lib/openai/models/beta/threads/file_path_delta_annotation.rb +8 -4
- data/lib/openai/models/beta/threads/image_file.rb +10 -8
- data/lib/openai/models/beta/threads/image_file_content_block.rb +5 -3
- data/lib/openai/models/beta/threads/image_file_delta.rb +10 -8
- data/lib/openai/models/beta/threads/image_file_delta_block.rb +7 -4
- data/lib/openai/models/beta/threads/image_url.rb +6 -5
- data/lib/openai/models/beta/threads/image_url_content_block.rb +2 -1
- data/lib/openai/models/beta/threads/image_url_delta.rb +6 -5
- data/lib/openai/models/beta/threads/image_url_delta_block.rb +4 -2
- data/lib/openai/models/beta/threads/message.rb +52 -28
- data/lib/openai/models/beta/threads/message_content.rb +4 -3
- data/lib/openai/models/beta/threads/message_content_delta.rb +4 -3
- data/lib/openai/models/beta/threads/message_content_part_param.rb +4 -3
- data/lib/openai/models/beta/threads/message_create_params.rb +25 -12
- data/lib/openai/models/beta/threads/message_delta.rb +4 -2
- data/lib/openai/models/beta/threads/message_delta_event.rb +6 -3
- data/lib/openai/models/beta/threads/message_list_params.rb +18 -8
- data/lib/openai/models/beta/threads/message_update_params.rb +7 -4
- data/lib/openai/models/beta/threads/refusal_content_block.rb +2 -1
- data/lib/openai/models/beta/threads/refusal_delta_block.rb +4 -2
- data/lib/openai/models/beta/threads/required_action_function_tool_call.rb +15 -10
- data/lib/openai/models/beta/threads/run.rb +174 -89
- data/lib/openai/models/beta/threads/run_create_params.rb +173 -74
- data/lib/openai/models/beta/threads/run_list_params.rb +16 -7
- data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +7 -7
- data/lib/openai/models/beta/threads/run_update_params.rb +7 -4
- data/lib/openai/models/beta/threads/runs/code_interpreter_logs.rb +6 -3
- data/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb +9 -9
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +24 -22
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +15 -14
- data/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +31 -25
- data/lib/openai/models/beta/threads/runs/file_search_tool_call_delta.rb +9 -7
- data/lib/openai/models/beta/threads/runs/function_tool_call.rb +15 -15
- data/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb +17 -16
- data/lib/openai/models/beta/threads/runs/message_creation_step_details.rb +4 -2
- data/lib/openai/models/beta/threads/runs/run_step.rb +62 -29
- data/lib/openai/models/beta/threads/runs/run_step_delta.rb +2 -1
- data/lib/openai/models/beta/threads/runs/run_step_delta_event.rb +6 -3
- data/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb +4 -2
- data/lib/openai/models/beta/threads/runs/step_list_params.rb +29 -13
- data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +9 -5
- data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb +6 -5
- data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb +6 -5
- data/lib/openai/models/beta/threads/text.rb +2 -1
- data/lib/openai/models/beta/threads/text_content_block.rb +2 -1
- data/lib/openai/models/beta/threads/text_content_block_param.rb +4 -2
- data/lib/openai/models/beta/threads/text_delta.rb +2 -1
- data/lib/openai/models/beta/threads/text_delta_block.rb +4 -2
- data/lib/openai/models/chat/chat_completion.rb +143 -75
- data/lib/openai/models/chat/chat_completion_allowed_tool_choice.rb +4 -5
- data/lib/openai/models/chat/chat_completion_allowed_tools.rb +18 -5
- data/lib/openai/models/chat/chat_completion_assistant_message_param.rb +31 -26
- data/lib/openai/models/chat/chat_completion_audio.rb +11 -8
- data/lib/openai/models/chat/chat_completion_audio_param.rb +11 -7
- data/lib/openai/models/chat/chat_completion_chunk.rb +174 -97
- data/lib/openai/models/chat/chat_completion_content_part.rb +22 -20
- data/lib/openai/models/chat/chat_completion_content_part_image.rb +17 -15
- data/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +13 -13
- data/lib/openai/models/chat/chat_completion_content_part_refusal.rb +4 -2
- data/lib/openai/models/chat/chat_completion_content_part_text.rb +11 -9
- data/lib/openai/models/chat/chat_completion_custom_tool.rb +20 -16
- data/lib/openai/models/chat/chat_completion_deleted.rb +6 -3
- data/lib/openai/models/chat/chat_completion_developer_message_param.rb +7 -6
- data/lib/openai/models/chat/chat_completion_function_call_option.rb +2 -1
- data/lib/openai/models/chat/chat_completion_function_message_param.rb +6 -3
- data/lib/openai/models/chat/chat_completion_function_tool.rb +2 -1
- data/lib/openai/models/chat/chat_completion_message.rb +39 -24
- data/lib/openai/models/chat/chat_completion_message_custom_tool_call.rb +10 -5
- data/lib/openai/models/chat/chat_completion_message_function_tool_call.rb +13 -9
- data/lib/openai/models/chat/chat_completion_named_tool_choice.rb +4 -2
- data/lib/openai/models/chat/chat_completion_named_tool_choice_custom.rb +4 -2
- data/lib/openai/models/chat/chat_completion_prediction_content.rb +8 -6
- data/lib/openai/models/chat/chat_completion_store_message.rb +26 -16
- data/lib/openai/models/chat/chat_completion_stream_options.rb +15 -5
- data/lib/openai/models/chat/chat_completion_system_message_param.rb +7 -6
- data/lib/openai/models/chat/chat_completion_token_logprob.rb +25 -14
- data/lib/openai/models/chat/chat_completion_tool_message_param.rb +6 -3
- data/lib/openai/models/chat/chat_completion_user_message_param.rb +8 -7
- data/lib/openai/models/chat/completion_create_params.rb +388 -161
- data/lib/openai/models/chat/completion_list_params.rb +12 -7
- data/lib/openai/models/chat/completion_update_params.rb +7 -4
- data/lib/openai/models/chat/completions/message_list_params.rb +7 -6
- data/lib/openai/models/comparison_filter.rb +17 -6
- data/lib/openai/models/completion.rb +17 -10
- data/lib/openai/models/completion_choice.rb +5 -4
- data/lib/openai/models/completion_create_params.rb +124 -37
- data/lib/openai/models/completion_usage.rb +34 -18
- data/lib/openai/models/compound_filter.rb +5 -5
- data/lib/openai/models/container_create_params.rb +15 -10
- data/lib/openai/models/container_create_response.rb +28 -16
- data/lib/openai/models/container_list_params.rb +13 -7
- data/lib/openai/models/container_list_response.rb +28 -16
- data/lib/openai/models/container_retrieve_response.rb +28 -16
- data/lib/openai/models/containers/file_create_params.rb +8 -5
- data/lib/openai/models/containers/file_create_response.rb +14 -7
- data/lib/openai/models/containers/file_list_params.rb +11 -6
- data/lib/openai/models/containers/file_list_response.rb +14 -7
- data/lib/openai/models/containers/file_retrieve_response.rb +14 -7
- data/lib/openai/models/content_provenance_check.rb +44 -25
- data/lib/openai/models/content_provenance_check_create_params.rb +6 -1
- data/lib/openai/models/conversations/computer_screenshot_content.rb +16 -9
- data/lib/openai/models/conversations/conversation.rb +16 -10
- data/lib/openai/models/conversations/conversation_create_params.rb +9 -4
- data/lib/openai/models/conversations/conversation_item.rb +216 -100
- data/lib/openai/models/conversations/conversation_item_list.rb +10 -5
- data/lib/openai/models/conversations/conversation_update_params.rb +7 -4
- data/lib/openai/models/conversations/item_create_params.rb +7 -6
- data/lib/openai/models/conversations/item_list_params.rb +29 -7
- data/lib/openai/models/conversations/item_retrieve_params.rb +5 -5
- data/lib/openai/models/conversations/message.rb +22 -12
- data/lib/openai/models/conversations/summary_text_content.rb +4 -2
- data/lib/openai/models/create_embedding_response.rb +12 -6
- data/lib/openai/models/custom_tool_input_format.rb +8 -4
- data/lib/openai/models/embedding.rb +9 -7
- data/lib/openai/models/embedding_create_params.rb +36 -18
- data/lib/openai/models/error_object.rb +8 -4
- data/lib/openai/models/eval_create_params.rb +105 -74
- data/lib/openai/models/eval_create_response.rb +69 -42
- data/lib/openai/models/eval_custom_data_source_config.rb +5 -5
- data/lib/openai/models/eval_list_params.rb +10 -7
- data/lib/openai/models/eval_list_response.rb +69 -42
- data/lib/openai/models/eval_retrieve_response.rb +69 -42
- data/lib/openai/models/eval_stored_completions_data_source_config.rb +12 -6
- data/lib/openai/models/eval_update_params.rb +9 -5
- data/lib/openai/models/eval_update_response.rb +69 -42
- data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +97 -64
- data/lib/openai/models/evals/create_eval_jsonl_run_data_source.rb +12 -7
- data/lib/openai/models/evals/eval_api_error.rb +4 -2
- data/lib/openai/models/evals/run_cancel_response.rb +204 -114
- data/lib/openai/models/evals/run_create_params.rb +156 -90
- data/lib/openai/models/evals/run_create_response.rb +204 -114
- data/lib/openai/models/evals/run_list_params.rb +10 -7
- data/lib/openai/models/evals/run_list_response.rb +204 -114
- data/lib/openai/models/evals/run_retrieve_response.rb +204 -114
- data/lib/openai/models/evals/runs/output_item_list_params.rb +10 -7
- data/lib/openai/models/evals/runs/output_item_list_response.rb +66 -38
- data/lib/openai/models/evals/runs/output_item_retrieve_response.rb +66 -39
- data/lib/openai/models/file_create_params.rb +23 -10
- data/lib/openai/models/file_list_params.rb +13 -7
- data/lib/openai/models/file_object.rb +22 -12
- data/lib/openai/models/fine_tuning/alpha/grader_run_params.rb +18 -10
- data/lib/openai/models/fine_tuning/alpha/grader_validate_params.rb +2 -1
- data/lib/openai/models/fine_tuning/alpha/grader_validate_response.rb +2 -1
- data/lib/openai/models/fine_tuning/checkpoints/permission_create_params.rb +2 -1
- data/lib/openai/models/fine_tuning/checkpoints/permission_create_response.rb +8 -4
- data/lib/openai/models/fine_tuning/checkpoints/permission_delete_response.rb +6 -3
- data/lib/openai/models/fine_tuning/checkpoints/permission_list_params.rb +8 -4
- data/lib/openai/models/fine_tuning/checkpoints/permission_list_response.rb +8 -4
- data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rb +8 -4
- data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rb +8 -4
- data/lib/openai/models/fine_tuning/dpo_hyperparameters.rb +12 -7
- data/lib/openai/models/fine_tuning/dpo_method.rb +2 -1
- data/lib/openai/models/fine_tuning/fine_tuning_job.rb +82 -41
- data/lib/openai/models/fine_tuning/fine_tuning_job_event.rb +14 -7
- data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rb +13 -7
- data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rb +7 -6
- data/lib/openai/models/fine_tuning/job_create_params.rb +107 -42
- data/lib/openai/models/fine_tuning/job_list_events_params.rb +4 -2
- data/lib/openai/models/fine_tuning/job_list_params.rb +7 -6
- data/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb +4 -2
- data/lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb +14 -7
- data/lib/openai/models/fine_tuning/reinforcement_hyperparameters.rb +17 -10
- data/lib/openai/models/fine_tuning/reinforcement_method.rb +4 -2
- data/lib/openai/models/fine_tuning/supervised_hyperparameters.rb +9 -6
- data/lib/openai/models/fine_tuning/supervised_method.rb +2 -1
- data/lib/openai/models/function_definition.rb +22 -9
- data/lib/openai/models/graders/grader_input_item.rb +11 -11
- data/lib/openai/models/graders/label_model_grader.rb +29 -25
- data/lib/openai/models/graders/multi_grader.rb +9 -7
- data/lib/openai/models/graders/python_grader.rb +8 -4
- data/lib/openai/models/graders/score_model_grader.rb +48 -38
- data/lib/openai/models/graders/string_check_grader.rb +10 -5
- data/lib/openai/models/graders/text_similarity_grader.rb +11 -8
- data/lib/openai/models/image.rb +10 -6
- data/lib/openai/models/image_create_variation_params.rb +23 -9
- data/lib/openai/models/image_edit_completed_event.rb +62 -27
- data/lib/openai/models/image_edit_params.rb +169 -72
- data/lib/openai/models/image_edit_partial_image_event.rb +49 -18
- data/lib/openai/models/image_gen_completed_event.rb +62 -27
- data/lib/openai/models/image_gen_partial_image_event.rb +49 -18
- data/lib/openai/models/image_generate_params.rb +141 -62
- data/lib/openai/models/image_input_reference_param.rb +2 -1
- data/lib/openai/models/image_model.rb +4 -0
- data/lib/openai/models/images_response.rb +69 -30
- data/lib/openai/models/model.rb +10 -5
- data/lib/openai/models/moderation.rb +115 -62
- data/lib/openai/models/moderation_create_params.rb +16 -13
- data/lib/openai/models/moderation_create_response.rb +6 -3
- data/lib/openai/models/moderation_image_url_input.rb +6 -3
- data/lib/openai/models/moderation_text_input.rb +4 -2
- data/lib/openai/models/other_file_chunking_strategy_object.rb +2 -1
- data/lib/openai/models/realtime/audio_transcription.rb +29 -10
- data/lib/openai/models/realtime/call_accept_params.rb +85 -30
- data/lib/openai/models/realtime/call_create_params.rb +4 -2
- data/lib/openai/models/realtime/call_refer_params.rb +3 -4
- data/lib/openai/models/realtime/call_reject_params.rb +3 -4
- data/lib/openai/models/realtime/client_secret_create_params.rb +16 -11
- data/lib/openai/models/realtime/client_secret_create_response.rb +6 -6
- data/lib/openai/models/realtime/conversation_created_event.rb +10 -5
- data/lib/openai/models/realtime/conversation_item_added.rb +9 -7
- data/lib/openai/models/realtime/conversation_item_create_event.rb +16 -7
- data/lib/openai/models/realtime/conversation_item_created_event.rb +10 -7
- data/lib/openai/models/realtime/conversation_item_delete_event.rb +6 -3
- data/lib/openai/models/realtime/conversation_item_deleted_event.rb +6 -3
- data/lib/openai/models/realtime/conversation_item_done.rb +9 -7
- data/lib/openai/models/realtime/conversation_item_input_audio_transcription_completed_event.rb +36 -21
- data/lib/openai/models/realtime/conversation_item_input_audio_transcription_delta_event.rb +17 -10
- data/lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb +18 -13
- data/lib/openai/models/realtime/conversation_item_input_audio_transcription_segment.rb +18 -9
- data/lib/openai/models/realtime/conversation_item_retrieve_event.rb +6 -3
- data/lib/openai/models/realtime/conversation_item_truncate_event.rb +13 -8
- data/lib/openai/models/realtime/conversation_item_truncated_event.rb +10 -8
- data/lib/openai/models/realtime/conversation_item_with_reference.rb +47 -24
- data/lib/openai/models/realtime/input_audio_buffer_append_event.rb +7 -6
- data/lib/openai/models/realtime/input_audio_buffer_clear_event.rb +4 -2
- data/lib/openai/models/realtime/input_audio_buffer_cleared_event.rb +4 -2
- data/lib/openai/models/realtime/input_audio_buffer_commit_event.rb +4 -2
- data/lib/openai/models/realtime/input_audio_buffer_committed_event.rb +9 -7
- data/lib/openai/models/realtime/input_audio_buffer_dtmf_event_received_event.rb +6 -7
- data/lib/openai/models/realtime/input_audio_buffer_speech_started_event.rb +11 -7
- data/lib/openai/models/realtime/input_audio_buffer_speech_stopped_event.rb +10 -7
- data/lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb +12 -8
- data/lib/openai/models/realtime/log_prob_properties.rb +6 -6
- data/lib/openai/models/realtime/mcp_list_tools_completed.rb +6 -3
- data/lib/openai/models/realtime/mcp_list_tools_failed.rb +6 -3
- data/lib/openai/models/realtime/mcp_list_tools_in_progress.rb +6 -3
- data/lib/openai/models/realtime/output_audio_buffer_clear_event.rb +5 -3
- data/lib/openai/models/realtime/rate_limits_updated_event.rb +14 -11
- data/lib/openai/models/realtime/realtime_audio_config_input.rb +38 -12
- data/lib/openai/models/realtime/realtime_audio_config_output.rb +18 -6
- data/lib/openai/models/realtime/realtime_audio_formats.rb +8 -4
- data/lib/openai/models/realtime/realtime_audio_input_turn_detection.rb +61 -25
- data/lib/openai/models/realtime/realtime_client_event.rb +1 -1
- data/lib/openai/models/realtime/realtime_conversation_item_assistant_message.rb +26 -19
- data/lib/openai/models/realtime/realtime_conversation_item_function_call.rb +18 -11
- data/lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb +15 -10
- data/lib/openai/models/realtime/realtime_conversation_item_system_message.rb +18 -13
- data/lib/openai/models/realtime/realtime_conversation_item_user_message.rb +32 -21
- data/lib/openai/models/realtime/realtime_error.rb +10 -8
- data/lib/openai/models/realtime/realtime_error_event.rb +6 -3
- data/lib/openai/models/realtime/realtime_function_tool.rb +9 -7
- data/lib/openai/models/realtime/realtime_mcp_approval_request.rb +10 -5
- data/lib/openai/models/realtime/realtime_mcp_approval_response.rb +10 -5
- data/lib/openai/models/realtime/realtime_mcp_list_tools.rb +16 -12
- data/lib/openai/models/realtime/realtime_mcp_tool_call.rb +16 -8
- data/lib/openai/models/realtime/realtime_reasoning.rb +3 -4
- data/lib/openai/models/realtime/realtime_response.rb +47 -19
- data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +11 -7
- data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +71 -43
- data/lib/openai/models/realtime/realtime_response_create_params.rb +56 -18
- data/lib/openai/models/realtime/realtime_response_status.rb +16 -8
- data/lib/openai/models/realtime/realtime_response_usage.rb +16 -8
- data/lib/openai/models/realtime/realtime_response_usage_input_token_details.rb +16 -8
- data/lib/openai/models/realtime/realtime_response_usage_output_token_details.rb +4 -2
- data/lib/openai/models/realtime/realtime_server_event.rb +30 -18
- data/lib/openai/models/realtime/realtime_session.rb +191 -82
- data/lib/openai/models/realtime/realtime_session_create_request.rb +86 -32
- data/lib/openai/models/realtime/realtime_session_create_response.rb +256 -110
- data/lib/openai/models/realtime/realtime_tools_config_union.rb +73 -45
- data/lib/openai/models/realtime/realtime_tracing_config.rb +9 -7
- data/lib/openai/models/realtime/realtime_transcription_session_audio_input.rb +38 -13
- data/lib/openai/models/realtime/realtime_transcription_session_audio_input_turn_detection.rb +61 -25
- data/lib/openai/models/realtime/realtime_transcription_session_create_request.rb +10 -8
- data/lib/openai/models/realtime/realtime_transcription_session_create_response.rb +28 -22
- data/lib/openai/models/realtime/realtime_transcription_session_turn_detection.rb +13 -8
- data/lib/openai/models/realtime/realtime_translation_client_secret_create_request.rb +16 -12
- data/lib/openai/models/realtime/realtime_translation_client_secret_create_response.rb +7 -7
- data/lib/openai/models/realtime/realtime_translation_input_audio_buffer_append_event.rb +6 -3
- data/lib/openai/models/realtime/realtime_translation_input_transcript_delta_event.rb +11 -8
- data/lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb +16 -11
- data/lib/openai/models/realtime/realtime_translation_output_transcript_delta_event.rb +11 -8
- data/lib/openai/models/realtime/realtime_translation_session.rb +25 -25
- data/lib/openai/models/realtime/realtime_translation_session_close_event.rb +4 -2
- data/lib/openai/models/realtime/realtime_translation_session_closed_event.rb +4 -2
- data/lib/openai/models/realtime/realtime_translation_session_create_request.rb +18 -23
- data/lib/openai/models/realtime/realtime_translation_session_created_event.rb +6 -3
- data/lib/openai/models/realtime/realtime_translation_session_update_event.rb +7 -7
- data/lib/openai/models/realtime/realtime_translation_session_update_request.rb +16 -22
- data/lib/openai/models/realtime/realtime_translation_session_updated_event.rb +6 -3
- data/lib/openai/models/realtime/realtime_truncation_retention_ratio.rb +16 -11
- data/lib/openai/models/realtime/response_audio_delta_event.rb +14 -7
- data/lib/openai/models/realtime/response_audio_done_event.rb +12 -6
- data/lib/openai/models/realtime/response_audio_transcript_delta_event.rb +14 -7
- data/lib/openai/models/realtime/response_audio_transcript_done_event.rb +14 -7
- data/lib/openai/models/realtime/response_cancel_event.rb +7 -6
- data/lib/openai/models/realtime/response_content_part_added_event.rb +22 -11
- data/lib/openai/models/realtime/response_content_part_done_event.rb +22 -11
- data/lib/openai/models/realtime/response_create_event.rb +6 -3
- data/lib/openai/models/realtime/response_created_event.rb +6 -3
- data/lib/openai/models/realtime/response_done_event.rb +6 -3
- data/lib/openai/models/realtime/response_function_call_arguments_delta_event.rb +14 -11
- data/lib/openai/models/realtime/response_function_call_arguments_done_event.rb +16 -12
- data/lib/openai/models/realtime/response_mcp_call_arguments_delta.rb +14 -7
- data/lib/openai/models/realtime/response_mcp_call_arguments_done.rb +12 -6
- data/lib/openai/models/realtime/response_mcp_call_completed.rb +8 -4
- data/lib/openai/models/realtime/response_mcp_call_failed.rb +8 -4
- data/lib/openai/models/realtime/response_mcp_call_in_progress.rb +8 -4
- data/lib/openai/models/realtime/response_output_item_added_event.rb +10 -5
- data/lib/openai/models/realtime/response_output_item_done_event.rb +10 -5
- data/lib/openai/models/realtime/response_text_delta_event.rb +14 -7
- data/lib/openai/models/realtime/response_text_done_event.rb +14 -7
- data/lib/openai/models/realtime/session_created_event.rb +6 -3
- data/lib/openai/models/realtime/session_update_event.rb +10 -6
- data/lib/openai/models/realtime/session_updated_event.rb +6 -3
- data/lib/openai/models/realtime/transcription_session_update.rb +45 -26
- data/lib/openai/models/realtime/transcription_session_updated_event.rb +42 -28
- data/lib/openai/models/reasoning.rb +33 -10
- data/lib/openai/models/reasoning_effort.rb +1 -1
- data/lib/openai/models/response_format_json_object.rb +2 -1
- data/lib/openai/models/response_format_json_schema.rb +21 -14
- data/lib/openai/models/response_format_text.rb +2 -1
- data/lib/openai/models/response_format_text_grammar.rb +5 -3
- data/lib/openai/models/response_format_text_python.rb +3 -2
- data/lib/openai/models/responses/apply_patch_tool.rb +4 -3
- data/lib/openai/models/responses/compacted_response.rb +12 -8
- data/lib/openai/models/responses/computer_action.rb +78 -58
- data/lib/openai/models/responses/computer_tool.rb +3 -2
- data/lib/openai/models/responses/computer_use_preview_tool.rb +9 -5
- data/lib/openai/models/responses/container_auto.rb +10 -5
- data/lib/openai/models/responses/container_network_policy_allowlist.rb +6 -3
- data/lib/openai/models/responses/container_network_policy_disabled.rb +2 -1
- data/lib/openai/models/responses/container_network_policy_domain_secret.rb +6 -3
- data/lib/openai/models/responses/container_reference.rb +4 -2
- data/lib/openai/models/responses/custom_tool.rb +16 -12
- data/lib/openai/models/responses/easy_input_message.rb +13 -7
- data/lib/openai/models/responses/file_search_tool.rb +25 -17
- data/lib/openai/models/responses/function_shell_tool.rb +4 -3
- data/lib/openai/models/responses/function_tool.rb +19 -13
- data/lib/openai/models/responses/inline_skill.rb +8 -4
- data/lib/openai/models/responses/inline_skill_source.rb +6 -3
- data/lib/openai/models/responses/input_item_list_params.rb +13 -7
- data/lib/openai/models/responses/input_token_count_params.rb +79 -30
- data/lib/openai/models/responses/local_environment.rb +4 -2
- data/lib/openai/models/responses/local_skill.rb +6 -3
- data/lib/openai/models/responses/namespace_tool.rb +23 -13
- data/lib/openai/models/responses/response.rb +336 -152
- data/lib/openai/models/responses/response_apply_patch_tool_call.rb +34 -19
- data/lib/openai/models/responses/response_apply_patch_tool_call_output.rb +17 -11
- data/lib/openai/models/responses/response_audio_delta_event.rb +6 -6
- data/lib/openai/models/responses/response_audio_done_event.rb +4 -5
- data/lib/openai/models/responses/response_audio_transcript_delta_event.rb +6 -6
- data/lib/openai/models/responses/response_audio_transcript_done_event.rb +4 -5
- data/lib/openai/models/responses/response_code_interpreter_call_code_delta_event.rb +11 -9
- data/lib/openai/models/responses/response_code_interpreter_call_code_done_event.rb +10 -5
- data/lib/openai/models/responses/response_code_interpreter_call_completed_event.rb +9 -8
- data/lib/openai/models/responses/response_code_interpreter_call_in_progress_event.rb +9 -8
- data/lib/openai/models/responses/response_code_interpreter_call_interpreting_event.rb +9 -8
- data/lib/openai/models/responses/response_code_interpreter_tool_call.rb +22 -13
- data/lib/openai/models/responses/response_compact_params.rb +89 -46
- data/lib/openai/models/responses/response_compaction_item.rb +9 -5
- data/lib/openai/models/responses/response_compaction_item_param.rb +7 -4
- data/lib/openai/models/responses/response_completed_event.rb +6 -6
- data/lib/openai/models/responses/response_computer_tool_call.rb +101 -82
- data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +22 -14
- data/lib/openai/models/responses/response_computer_tool_call_output_screenshot.rb +7 -7
- data/lib/openai/models/responses/response_configuration_update_item.rb +9 -8
- data/lib/openai/models/responses/response_configuration_update_item_param.rb +9 -8
- data/lib/openai/models/responses/response_container_reference.rb +2 -1
- data/lib/openai/models/responses/response_content.rb +5 -3
- data/lib/openai/models/responses/response_content_part_added_event.rb +16 -11
- data/lib/openai/models/responses/response_content_part_done_event.rb +16 -11
- data/lib/openai/models/responses/response_conversation_param.rb +2 -1
- data/lib/openai/models/responses/response_create_params.rb +334 -130
- data/lib/openai/models/responses/response_created_event.rb +6 -6
- data/lib/openai/models/responses/response_custom_tool_call.rb +18 -12
- data/lib/openai/models/responses/response_custom_tool_call_input_delta_event.rb +10 -5
- data/lib/openai/models/responses/response_custom_tool_call_input_done_event.rb +10 -5
- data/lib/openai/models/responses/response_custom_tool_call_item.rb +21 -13
- data/lib/openai/models/responses/response_custom_tool_call_output.rb +18 -12
- data/lib/openai/models/responses/response_custom_tool_call_output_item.rb +16 -10
- data/lib/openai/models/responses/response_error.rb +12 -9
- data/lib/openai/models/responses/response_error_event.rb +10 -8
- data/lib/openai/models/responses/response_failed_event.rb +6 -6
- data/lib/openai/models/responses/response_file_search_call_completed_event.rb +8 -8
- data/lib/openai/models/responses/response_file_search_call_in_progress_event.rb +8 -8
- data/lib/openai/models/responses/response_file_search_call_searching_event.rb +8 -8
- data/lib/openai/models/responses/response_file_search_tool_call.rb +26 -19
- data/lib/openai/models/responses/response_format_text_config.rb +2 -2
- data/lib/openai/models/responses/response_format_text_json_schema_config.rb +19 -11
- data/lib/openai/models/responses/response_function_call_arguments_delta_event.rb +10 -9
- data/lib/openai/models/responses/response_function_call_arguments_done_event.rb +8 -4
- data/lib/openai/models/responses/response_function_call_output_item.rb +1 -1
- data/lib/openai/models/responses/response_function_shell_call_output_content.rb +12 -6
- data/lib/openai/models/responses/response_function_shell_tool_call.rb +24 -14
- data/lib/openai/models/responses/response_function_shell_tool_call_output.rb +36 -25
- data/lib/openai/models/responses/response_function_tool_call.rb +22 -14
- data/lib/openai/models/responses/response_function_tool_call_item.rb +22 -14
- data/lib/openai/models/responses/response_function_tool_call_output_item.rb +27 -17
- data/lib/openai/models/responses/response_function_web_search.rb +33 -37
- data/lib/openai/models/responses/response_image_gen_call_completed_event.rb +8 -4
- data/lib/openai/models/responses/response_image_gen_call_generating_event.rb +8 -4
- data/lib/openai/models/responses/response_image_gen_call_in_progress_event.rb +8 -4
- data/lib/openai/models/responses/response_image_gen_call_partial_image_event.rb +21 -14
- data/lib/openai/models/responses/response_in_progress_event.rb +6 -6
- data/lib/openai/models/responses/response_incomplete_event.rb +6 -6
- data/lib/openai/models/responses/response_input_audio.rb +6 -9
- data/lib/openai/models/responses/response_input_content.rb +1 -1
- data/lib/openai/models/responses/response_input_file.rb +22 -11
- data/lib/openai/models/responses/response_input_file_content.rb +22 -11
- data/lib/openai/models/responses/response_input_image.rb +17 -10
- data/lib/openai/models/responses/response_input_image_content.rb +17 -10
- data/lib/openai/models/responses/response_input_item.rb +397 -209
- data/lib/openai/models/responses/response_input_message_item.rb +12 -8
- data/lib/openai/models/responses/response_input_text.rb +10 -7
- data/lib/openai/models/responses/response_input_text_content.rb +10 -7
- data/lib/openai/models/responses/response_item.rb +205 -93
- data/lib/openai/models/responses/response_item_list.rb +10 -5
- data/lib/openai/models/responses/response_local_environment.rb +2 -1
- data/lib/openai/models/responses/response_mcp_call_arguments_delta_event.rb +11 -9
- data/lib/openai/models/responses/response_mcp_call_arguments_done_event.rb +10 -8
- data/lib/openai/models/responses/response_mcp_call_completed_event.rb +8 -4
- data/lib/openai/models/responses/response_mcp_call_failed_event.rb +8 -4
- data/lib/openai/models/responses/response_mcp_call_in_progress_event.rb +8 -4
- data/lib/openai/models/responses/response_mcp_list_tools_completed_event.rb +8 -4
- data/lib/openai/models/responses/response_mcp_list_tools_failed_event.rb +8 -4
- data/lib/openai/models/responses/response_mcp_list_tools_in_progress_event.rb +8 -4
- data/lib/openai/models/responses/response_output_audio.rb +6 -6
- data/lib/openai/models/responses/response_output_item.rb +217 -98
- data/lib/openai/models/responses/response_output_item_added_event.rb +11 -7
- data/lib/openai/models/responses/response_output_item_done_event.rb +8 -7
- data/lib/openai/models/responses/response_output_message.rb +16 -9
- data/lib/openai/models/responses/response_output_refusal.rb +4 -2
- data/lib/openai/models/responses/response_output_text.rb +42 -25
- data/lib/openai/models/responses/response_output_text_annotation_added_event.rb +50 -29
- data/lib/openai/models/responses/response_prompt.rb +10 -8
- data/lib/openai/models/responses/response_queued_event.rb +6 -3
- data/lib/openai/models/responses/response_reasoning_item.rb +29 -15
- data/lib/openai/models/responses/response_reasoning_summary_part_added_event.rb +16 -12
- data/lib/openai/models/responses/response_reasoning_summary_part_done_event.rb +19 -13
- data/lib/openai/models/responses/response_reasoning_summary_text_delta_event.rb +12 -10
- data/lib/openai/models/responses/response_reasoning_summary_text_done_event.rb +12 -10
- data/lib/openai/models/responses/response_reasoning_text_delta_event.rb +12 -9
- data/lib/openai/models/responses/response_reasoning_text_done_event.rb +12 -9
- data/lib/openai/models/responses/response_refusal_delta_event.rb +12 -9
- data/lib/openai/models/responses/response_refusal_done_event.rb +12 -9
- data/lib/openai/models/responses/response_retrieve_params.rb +12 -6
- data/lib/openai/models/responses/response_shell_call_command_added_event.rb +10 -5
- data/lib/openai/models/responses/response_shell_call_command_delta_event.rb +12 -6
- data/lib/openai/models/responses/response_shell_call_command_done_event.rb +10 -5
- data/lib/openai/models/responses/response_shell_call_output_content_delta_event.rb +16 -8
- data/lib/openai/models/responses/response_shell_call_output_content_done_event.rb +27 -18
- data/lib/openai/models/responses/response_steer_accepted_event.rb +13 -9
- data/lib/openai/models/responses/response_steer_event.rb +14 -6
- data/lib/openai/models/responses/response_steer_failed_event.rb +45 -22
- data/lib/openai/models/responses/response_steer_input.rb +34 -20
- data/lib/openai/models/responses/response_steer_input_content.rb +1 -1
- data/lib/openai/models/responses/response_steer_pending_event.rb +24 -11
- data/lib/openai/models/responses/response_text_config.rb +22 -8
- data/lib/openai/models/responses/response_text_delta_event.rb +24 -20
- data/lib/openai/models/responses/response_text_done_event.rb +24 -20
- data/lib/openai/models/responses/response_tool_search_call.rb +14 -7
- data/lib/openai/models/responses/response_tool_search_output_item.rb +14 -7
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +12 -6
- data/lib/openai/models/responses/response_usage.rb +18 -12
- data/lib/openai/models/responses/response_web_search_call_completed_event.rb +8 -8
- data/lib/openai/models/responses/response_web_search_call_in_progress_event.rb +8 -8
- data/lib/openai/models/responses/response_web_search_call_searching_event.rb +8 -8
- data/lib/openai/models/responses/responses_client_event.rb +353 -140
- data/lib/openai/models/responses/responses_server_event.rb +744 -570
- data/lib/openai/models/responses/skill_reference.rb +6 -3
- data/lib/openai/models/responses/tool.rb +236 -129
- data/lib/openai/models/responses/tool_choice_allowed.rb +21 -6
- data/lib/openai/models/responses/tool_choice_apply_patch.rb +2 -1
- data/lib/openai/models/responses/tool_choice_custom.rb +4 -2
- data/lib/openai/models/responses/tool_choice_function.rb +4 -2
- data/lib/openai/models/responses/tool_choice_mcp.rb +6 -6
- data/lib/openai/models/responses/tool_choice_shell.rb +2 -1
- data/lib/openai/models/responses/tool_choice_types.rb +16 -7
- data/lib/openai/models/responses/tool_search_tool.rb +8 -4
- data/lib/openai/models/responses/web_search_preview_tool.rb +21 -16
- data/lib/openai/models/responses/web_search_tool.rb +31 -21
- data/lib/openai/models/safety/alert_retrieve_params.rb +2 -1
- data/lib/openai/models/safety/safety_alert.rb +6 -5
- data/lib/openai/models/skill.rb +14 -7
- data/lib/openai/models/skill_create_params.rb +6 -1
- data/lib/openai/models/skill_list.rb +10 -5
- data/lib/openai/models/skill_list_params.rb +7 -6
- data/lib/openai/models/skill_update_params.rb +2 -1
- data/lib/openai/models/skills/deleted_skill_version.rb +2 -1
- data/lib/openai/models/skills/skill_version.rb +14 -7
- data/lib/openai/models/skills/skill_version_list.rb +10 -5
- data/lib/openai/models/skills/version_create_params.rb +8 -2
- data/lib/openai/models/skills/version_delete_params.rb +2 -1
- data/lib/openai/models/skills/version_list_params.rb +6 -3
- data/lib/openai/models/skills/version_retrieve_params.rb +2 -1
- data/lib/openai/models/skills/versions/content_retrieve_params.rb +2 -1
- data/lib/openai/models/static_file_chunking_strategy.rb +6 -4
- data/lib/openai/models/static_file_chunking_strategy_object.rb +2 -1
- data/lib/openai/models/static_file_chunking_strategy_object_param.rb +2 -1
- data/lib/openai/models/upload.rb +21 -13
- data/lib/openai/models/upload_complete_params.rb +5 -5
- data/lib/openai/models/upload_create_params.rb +23 -13
- data/lib/openai/models/uploads/part_create_params.rb +6 -4
- data/lib/openai/models/uploads/upload_part.rb +8 -4
- data/lib/openai/models/vector_store.rb +42 -23
- data/lib/openai/models/vector_store_create_params.rb +28 -16
- data/lib/openai/models/vector_store_list_params.rb +16 -7
- data/lib/openai/models/vector_store_search_params.rb +13 -9
- data/lib/openai/models/vector_store_search_response.rb +18 -11
- data/lib/openai/models/vector_store_update_params.rb +16 -11
- data/lib/openai/models/vector_stores/file_batch_create_params.rb +47 -23
- data/lib/openai/models/vector_stores/file_batch_list_files_params.rb +18 -8
- data/lib/openai/models/vector_stores/file_content_response.rb +4 -2
- data/lib/openai/models/vector_stores/file_create_params.rb +18 -9
- data/lib/openai/models/vector_stores/file_list_params.rb +18 -8
- data/lib/openai/models/vector_stores/file_update_params.rb +6 -4
- data/lib/openai/models/vector_stores/vector_store_file.rb +35 -16
- data/lib/openai/models/vector_stores/vector_store_file_batch.rb +27 -15
- data/lib/openai/models/video.rb +27 -16
- data/lib/openai/models/video_create_character_params.rb +8 -2
- data/lib/openai/models/video_create_character_response.rb +6 -3
- data/lib/openai/models/video_create_error.rb +12 -6
- data/lib/openai/models/video_create_params.rb +15 -7
- data/lib/openai/models/video_delete_response.rb +6 -3
- data/lib/openai/models/video_download_content_params.rb +2 -1
- data/lib/openai/models/video_edit_params.rb +10 -3
- data/lib/openai/models/video_extend_params.rb +12 -6
- data/lib/openai/models/video_get_character_response.rb +6 -3
- data/lib/openai/models/video_list_params.rb +7 -6
- data/lib/openai/models/video_remix_params.rb +2 -1
- data/lib/openai/models/webhooks/batch_cancelled_webhook_event.rb +12 -12
- data/lib/openai/models/webhooks/batch_completed_webhook_event.rb +12 -12
- data/lib/openai/models/webhooks/batch_expired_webhook_event.rb +12 -12
- data/lib/openai/models/webhooks/batch_failed_webhook_event.rb +12 -12
- data/lib/openai/models/webhooks/eval_run_canceled_webhook_event.rb +12 -12
- data/lib/openai/models/webhooks/eval_run_failed_webhook_event.rb +12 -12
- data/lib/openai/models/webhooks/eval_run_succeeded_webhook_event.rb +12 -12
- data/lib/openai/models/webhooks/fine_tuning_job_cancelled_webhook_event.rb +12 -13
- data/lib/openai/models/webhooks/fine_tuning_job_failed_webhook_event.rb +12 -13
- data/lib/openai/models/webhooks/fine_tuning_job_succeeded_webhook_event.rb +12 -13
- data/lib/openai/models/webhooks/live_call_incoming_webhook_event.rb +26 -23
- data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb +30 -24
- data/lib/openai/models/webhooks/response_cancelled_webhook_event.rb +12 -13
- data/lib/openai/models/webhooks/response_completed_webhook_event.rb +12 -13
- data/lib/openai/models/webhooks/response_failed_webhook_event.rb +12 -12
- data/lib/openai/models/webhooks/response_incomplete_webhook_event.rb +12 -13
- data/lib/openai/models/webhooks/safety_alert_created_webhook_event.rb +10 -5
- data/lib/openai/models/webhooks/safety_org_alert_created_webhook_event.rb +10 -5
- data/lib/openai/resources/admin/organization/admin_api_keys.rb +13 -9
- data/lib/openai/resources/admin/organization/audit_logs.rb +44 -22
- data/lib/openai/resources/admin/organization/certificates.rb +26 -17
- data/lib/openai/resources/admin/organization/data_retention.rb +2 -1
- data/lib/openai/resources/admin/organization/groups/roles.rb +21 -13
- data/lib/openai/resources/admin/organization/groups/users.rb +22 -13
- data/lib/openai/resources/admin/organization/groups.rb +20 -11
- data/lib/openai/resources/admin/organization/invites.rb +21 -13
- data/lib/openai/resources/admin/organization/projects/api_keys.rb +24 -12
- data/lib/openai/resources/admin/organization/projects/certificates.rb +17 -10
- data/lib/openai/resources/admin/organization/projects/data_retention.rb +6 -3
- data/lib/openai/resources/admin/organization/projects/groups/roles.rb +29 -18
- data/lib/openai/resources/admin/organization/projects/groups.rb +25 -16
- data/lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb +14 -7
- data/lib/openai/resources/admin/organization/projects/model_permissions.rb +10 -5
- data/lib/openai/resources/admin/organization/projects/rate_limits.rb +32 -20
- data/lib/openai/resources/admin/organization/projects/roles.rb +35 -21
- data/lib/openai/resources/admin/organization/projects/service_accounts/api_keys.rb +10 -5
- data/lib/openai/resources/admin/organization/projects/service_accounts.rb +40 -19
- data/lib/openai/resources/admin/organization/projects/spend_alerts.rb +42 -24
- data/lib/openai/resources/admin/organization/projects/spend_limit.rb +13 -10
- data/lib/openai/resources/admin/organization/projects/users/roles.rb +29 -18
- data/lib/openai/resources/admin/organization/projects/users.rb +32 -18
- data/lib/openai/resources/admin/organization/projects.rb +40 -22
- data/lib/openai/resources/admin/organization/roles.rb +25 -15
- data/lib/openai/resources/admin/organization/spend_alerts.rb +32 -18
- data/lib/openai/resources/admin/organization/spend_limit.rb +7 -6
- data/lib/openai/resources/admin/organization/usage.rb +296 -145
- data/lib/openai/resources/admin/organization/users/roles.rb +21 -13
- data/lib/openai/resources/admin/organization/users.rb +24 -13
- data/lib/openai/resources/audio/speech.rb +25 -10
- data/lib/openai/resources/audio/transcriptions.rb +172 -56
- data/lib/openai/resources/audio/translations.rb +26 -8
- data/lib/openai/resources/batches.rb +43 -15
- data/lib/openai/resources/beta/assistants.rb +177 -59
- data/lib/openai/resources/beta/chatkit/sessions.rb +14 -9
- data/lib/openai/resources/beta/chatkit/threads.rb +29 -18
- data/lib/openai/resources/beta/responses/input_items.rb +17 -9
- data/lib/openai/resources/beta/responses/input_tokens.rb +65 -28
- data/lib/openai/resources/beta/responses.rb +640 -195
- data/lib/openai/resources/beta/threads/messages.rb +65 -30
- data/lib/openai/resources/beta/threads/runs/steps.rb +50 -23
- data/lib/openai/resources/beta/threads/runs.rb +309 -109
- data/lib/openai/resources/beta/threads.rb +240 -78
- data/lib/openai/resources/chat/completions/messages.rb +9 -7
- data/lib/openai/resources/chat/completions.rb +594 -169
- data/lib/openai/resources/completions.rb +212 -40
- data/lib/openai/resources/containers/files.rb +19 -11
- data/lib/openai/resources/containers.rb +27 -14
- data/lib/openai/resources/content_provenance_checks.rb +7 -2
- data/lib/openai/resources/conversations/items.rb +58 -26
- data/lib/openai/resources/conversations.rb +23 -12
- data/lib/openai/resources/embeddings.rb +26 -8
- data/lib/openai/resources/evals/runs/output_items.rb +21 -12
- data/lib/openai/resources/evals/runs.rb +37 -21
- data/lib/openai/resources/evals.rb +43 -23
- data/lib/openai/resources/files.rb +42 -21
- data/lib/openai/resources/fine_tuning/alpha/graders.rb +15 -7
- data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb +36 -34
- data/lib/openai/resources/fine_tuning/jobs/checkpoints.rb +6 -6
- data/lib/openai/resources/fine_tuning/jobs.rb +84 -42
- data/lib/openai/resources/images.rb +423 -131
- data/lib/openai/resources/models.rb +4 -2
- data/lib/openai/resources/moderations.rb +10 -6
- data/lib/openai/resources/realtime/calls.rb +114 -48
- data/lib/openai/resources/realtime/client_secrets.rb +9 -6
- data/lib/openai/resources/responses/input_items.rb +15 -8
- data/lib/openai/resources/responses/input_tokens.rb +60 -26
- data/lib/openai/resources/responses.rb +601 -262
- data/lib/openai/resources/safety/alerts.rb +2 -1
- data/lib/openai/resources/skills/content.rb +2 -1
- data/lib/openai/resources/skills/versions/content.rb +4 -2
- data/lib/openai/resources/skills/versions.rb +26 -11
- data/lib/openai/resources/skills.rb +21 -11
- data/lib/openai/resources/uploads/parts.rb +13 -9
- data/lib/openai/resources/uploads.rb +35 -27
- data/lib/openai/resources/vector_stores/file_batches.rb +60 -26
- data/lib/openai/resources/vector_stores/files.rb +62 -31
- data/lib/openai/resources/vector_stores.rb +67 -34
- data/lib/openai/resources/videos.rb +64 -31
- data/lib/openai/version.rb +1 -1
- data/local-audio.md +146 -0
- data/rbi/openai/helpers/local_audio/interface.rbi +110 -0
- data/rbi/openai/helpers/realtime/connection.rbi +18 -2
- data/rbi/openai/helpers/realtime/extensions.rbi +8 -0
- data/rbi/openai/helpers/realtime/recovery.rbi +27 -0
- data/rbi/openai/models/admin/organization/audit_log_list_params.rbi +2 -2
- data/rbi/openai/models/admin/organization/project_create_params.rbi +4 -4
- data/rbi/openai/models/admin/organization/projects/project_api_key.rbi +13 -1
- data/rbi/openai/models/admin/organization/projects/service_account_create_params.rbi +18 -0
- data/rbi/openai/models/admin/organization/projects/service_account_create_response.rbi +19 -1
- data/rbi/openai/models/audio/speech_create_params.rbi +9 -6
- data/rbi/openai/models/audio/transcription_create_params.rbi +2 -2
- data/rbi/openai/models/audio/transcription_stream_event.rbi +1 -1
- data/rbi/openai/models/audio/transcription_text_delta_event.rbi +3 -3
- data/rbi/openai/models/audio/transcription_text_done_event.rbi +3 -3
- data/rbi/openai/models/audio/transcription_text_segment_event.rbi +1 -1
- data/rbi/openai/models/audio/translation_create_params.rbi +2 -2
- data/rbi/openai/models/batch.rbi +4 -4
- data/rbi/openai/models/batch_create_params.rbi +6 -4
- data/rbi/openai/models/batch_usage.rbi +2 -2
- data/rbi/openai/models/beta/assistant.rbi +24 -24
- data/rbi/openai/models/beta/assistant_create_params.rbi +40 -40
- data/rbi/openai/models/beta/assistant_response_format_option.rbi +4 -4
- data/rbi/openai/models/beta/assistant_stream_event.rbi +63 -65
- data/rbi/openai/models/beta/assistant_update_params.rbi +30 -30
- data/rbi/openai/models/beta/beta_computer_tool.rbi +1 -1
- data/rbi/openai/models/beta/beta_computer_use_preview_tool.rbi +1 -1
- data/rbi/openai/models/beta/beta_custom_tool.rbi +1 -1
- data/rbi/openai/models/beta/beta_file_search_tool.rbi +1 -1
- data/rbi/openai/models/beta/beta_function_tool.rbi +1 -1
- data/rbi/openai/models/beta/beta_response.rbi +72 -64
- data/rbi/openai/models/beta/beta_response_compaction_item.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_compaction_item_param.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_computer_tool_call.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_file_search_tool_call.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_format_text_config.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_format_text_json_schema_config.rbi +3 -3
- data/rbi/openai/models/beta/beta_response_function_tool_call.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_function_tool_call_item.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_function_web_search.rbi +2 -2
- data/rbi/openai/models/beta/beta_response_input_image.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_input_image_content.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_input_item.rbi +86 -1
- data/rbi/openai/models/beta/beta_response_item.rbi +78 -1
- data/rbi/openai/models/beta/beta_response_output_item.rbi +84 -1
- data/rbi/openai/models/beta/beta_response_prompt.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_reasoning_item.rbi +1 -1
- data/rbi/openai/models/beta/beta_response_text_config.rbi +4 -4
- data/rbi/openai/models/beta/beta_response_usage.rbi +2 -2
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +98 -84
- data/rbi/openai/models/beta/beta_tool.rbi +94 -55
- data/rbi/openai/models/beta/beta_tool_choice_types.rbi +4 -4
- data/rbi/openai/models/beta/beta_web_search_preview_tool.rbi +1 -1
- data/rbi/openai/models/beta/beta_web_search_tool.rbi +1 -1
- data/rbi/openai/models/beta/file_search_tool.rbi +5 -5
- data/rbi/openai/models/beta/message_stream_event.rbi +16 -16
- data/rbi/openai/models/beta/response_compact_params.rbi +44 -44
- data/rbi/openai/models/beta/response_create_params.rbi +96 -82
- data/rbi/openai/models/beta/responses/input_token_count_params.rbi +20 -20
- data/rbi/openai/models/beta/run_step_stream_event.rbi +14 -16
- data/rbi/openai/models/beta/run_stream_event.rbi +31 -31
- data/rbi/openai/models/beta/thread.rbi +9 -9
- data/rbi/openai/models/beta/thread_create_and_run_params.rbi +61 -56
- data/rbi/openai/models/beta/thread_create_params.rbi +24 -22
- data/rbi/openai/models/beta/thread_stream_event.rbi +3 -3
- data/rbi/openai/models/beta/thread_update_params.rbi +8 -8
- data/rbi/openai/models/beta/threads/image_file.rbi +6 -6
- data/rbi/openai/models/beta/threads/image_file_content_block.rbi +3 -2
- data/rbi/openai/models/beta/threads/image_file_delta.rbi +6 -6
- data/rbi/openai/models/beta/threads/image_file_delta_block.rbi +3 -2
- data/rbi/openai/models/beta/threads/message.rbi +9 -9
- data/rbi/openai/models/beta/threads/message_content.rbi +3 -2
- data/rbi/openai/models/beta/threads/message_content_delta.rbi +3 -2
- data/rbi/openai/models/beta/threads/message_content_part_param.rbi +3 -2
- data/rbi/openai/models/beta/threads/required_action_function_tool_call.rbi +2 -2
- data/rbi/openai/models/beta/threads/run.rbi +33 -31
- data/rbi/openai/models/beta/threads/run_create_params.rbi +37 -34
- data/rbi/openai/models/beta/threads/runs/code_interpreter_output_image.rbi +4 -4
- data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call.rbi +4 -4
- data/rbi/openai/models/beta/threads/runs/function_tool_call.rbi +2 -4
- data/rbi/openai/models/beta/threads/runs/function_tool_call_delta.rbi +2 -4
- data/rbi/openai/models/beta/threads/runs/run_step.rbi +12 -10
- data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +2 -2
- data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +2 -2
- data/rbi/openai/models/chat/chat_completion.rbi +27 -21
- data/rbi/openai/models/chat/chat_completion_assistant_message_param.rbi +4 -5
- data/rbi/openai/models/chat/chat_completion_audio.rbi +1 -1
- data/rbi/openai/models/chat/chat_completion_audio_param.rbi +1 -1
- data/rbi/openai/models/chat/chat_completion_chunk.rbi +28 -22
- data/rbi/openai/models/chat/chat_completion_content_part.rbi +3 -4
- data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +5 -4
- data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +1 -1
- data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +1 -2
- data/rbi/openai/models/chat/chat_completion_message.rbi +4 -4
- data/rbi/openai/models/chat/chat_completion_store_message.rbi +3 -4
- data/rbi/openai/models/chat/completion_create_params.rbi +95 -85
- data/rbi/openai/models/completion_create_params.rbi +34 -32
- data/rbi/openai/models/conversations/conversation_item.rbi +89 -2
- data/rbi/openai/models/conversations/item_create_params.rbi +2 -2
- data/rbi/openai/models/conversations/item_retrieve_params.rbi +2 -2
- data/rbi/openai/models/embedding.rbi +2 -2
- data/rbi/openai/models/embedding_create_params.rbi +14 -14
- data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +5 -5
- data/rbi/openai/models/evals/run_cancel_response.rbi +22 -20
- data/rbi/openai/models/evals/run_create_params.rbi +22 -20
- data/rbi/openai/models/evals/run_create_response.rbi +22 -20
- data/rbi/openai/models/evals/run_list_response.rbi +22 -20
- data/rbi/openai/models/evals/run_retrieve_response.rbi +22 -20
- data/rbi/openai/models/fine_tuning/alpha/grader_run_params.rbi +10 -8
- data/rbi/openai/models/fine_tuning/fine_tuning_job.rbi +6 -6
- data/rbi/openai/models/fine_tuning/job_create_params.rbi +17 -15
- data/rbi/openai/models/function_definition.rbi +6 -6
- data/rbi/openai/models/graders/score_model_grader.rbi +2 -2
- data/rbi/openai/models/image_create_variation_params.rbi +2 -2
- data/rbi/openai/models/image_edit_completed_event.rbi +20 -9
- data/rbi/openai/models/image_edit_params.rbi +91 -62
- data/rbi/openai/models/image_edit_partial_image_event.rbi +20 -9
- data/rbi/openai/models/image_gen_completed_event.rbi +20 -9
- data/rbi/openai/models/image_gen_partial_image_event.rbi +20 -9
- data/rbi/openai/models/image_generate_params.rbi +73 -50
- data/rbi/openai/models/image_model.rbi +4 -0
- data/rbi/openai/models/images_response.rbi +27 -16
- data/rbi/openai/models/moderation_create_params.rbi +9 -9
- data/rbi/openai/models/realtime/audio_transcription.rbi +2 -2
- data/rbi/openai/models/realtime/call_accept_params.rbi +1 -1
- data/rbi/openai/models/realtime/output_audio_buffer_clear_event.rbi +1 -1
- data/rbi/openai/models/realtime/realtime_audio_config_input.rbi +2 -2
- data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +4 -4
- data/rbi/openai/models/realtime/realtime_response_create_params.rbi +3 -3
- data/rbi/openai/models/realtime/realtime_server_event.rbi +3 -3
- data/rbi/openai/models/realtime/realtime_session.rbi +4 -4
- data/rbi/openai/models/realtime/realtime_session_create_request.rbi +2 -2
- data/rbi/openai/models/realtime/realtime_session_create_response.rbi +7 -7
- data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +5 -5
- data/rbi/openai/models/realtime/realtime_transcription_session_audio_input.rbi +2 -2
- data/rbi/openai/models/reasoning.rbi +3 -3
- data/rbi/openai/models/reasoning_effort.rbi +1 -1
- data/rbi/openai/models/response_format_json_schema.rbi +3 -3
- data/rbi/openai/models/response_format_text_grammar.rbi +1 -1
- data/rbi/openai/models/response_format_text_python.rbi +1 -1
- data/rbi/openai/models/responses/computer_tool.rbi +1 -1
- data/rbi/openai/models/responses/computer_use_preview_tool.rbi +1 -1
- data/rbi/openai/models/responses/custom_tool.rbi +1 -1
- data/rbi/openai/models/responses/file_search_tool.rbi +1 -1
- data/rbi/openai/models/responses/function_tool.rbi +1 -1
- data/rbi/openai/models/responses/input_token_count_params.rbi +16 -16
- data/rbi/openai/models/responses/response.rbi +66 -58
- data/rbi/openai/models/responses/response_compact_params.rbi +44 -44
- data/rbi/openai/models/responses/response_compaction_item.rbi +1 -1
- data/rbi/openai/models/responses/response_compaction_item_param.rbi +1 -1
- data/rbi/openai/models/responses/response_computer_tool_call.rbi +1 -1
- data/rbi/openai/models/responses/response_create_params.rbi +90 -76
- data/rbi/openai/models/responses/response_file_search_tool_call.rbi +1 -1
- data/rbi/openai/models/responses/response_format_text_config.rbi +1 -1
- data/rbi/openai/models/responses/response_format_text_json_schema_config.rbi +3 -3
- data/rbi/openai/models/responses/response_function_tool_call.rbi +1 -1
- data/rbi/openai/models/responses/response_function_tool_call_item.rbi +1 -1
- data/rbi/openai/models/responses/response_function_web_search.rbi +2 -2
- data/rbi/openai/models/responses/response_input_image.rbi +1 -1
- data/rbi/openai/models/responses/response_input_image_content.rbi +1 -1
- data/rbi/openai/models/responses/response_input_item.rbi +88 -1
- data/rbi/openai/models/responses/response_item.rbi +80 -1
- data/rbi/openai/models/responses/response_output_item.rbi +84 -1
- data/rbi/openai/models/responses/response_prompt.rbi +1 -1
- data/rbi/openai/models/responses/response_reasoning_item.rbi +1 -1
- data/rbi/openai/models/responses/response_text_config.rbi +4 -4
- data/rbi/openai/models/responses/response_usage.rbi +2 -2
- data/rbi/openai/models/responses/responses_client_event.rbi +92 -78
- data/rbi/openai/models/responses/tool.rbi +94 -55
- data/rbi/openai/models/responses/tool_choice_types.rbi +4 -4
- data/rbi/openai/models/responses/web_search_preview_tool.rbi +1 -1
- data/rbi/openai/models/responses/web_search_tool.rbi +1 -1
- data/rbi/openai/models/upload.rbi +2 -2
- data/rbi/openai/models/upload_create_params.rbi +2 -2
- data/rbi/openai/models/vector_store_create_params.rbi +6 -6
- data/rbi/openai/models/vector_stores/file_batch_create_params.rbi +18 -18
- data/rbi/openai/models/vector_stores/file_create_params.rbi +6 -6
- data/rbi/openai/models/vector_stores/vector_store_file.rbi +4 -4
- data/rbi/openai/models/vector_stores/vector_store_file_batch.rbi +4 -4
- data/rbi/openai/models/webhooks/live_call_incoming_webhook_event.rbi +10 -6
- data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi +14 -6
- data/rbi/openai/resources/admin/organization/audit_logs.rbi +1 -1
- data/rbi/openai/resources/admin/organization/projects/service_accounts.rbi +7 -0
- data/rbi/openai/resources/admin/organization/projects.rbi +2 -2
- data/rbi/openai/resources/audio/speech.rbi +3 -2
- data/rbi/openai/resources/audio/transcriptions.rbi +2 -2
- data/rbi/openai/resources/audio/translations.rbi +1 -1
- data/rbi/openai/resources/batches.rbi +3 -2
- data/rbi/openai/resources/beta/assistants.rbi +18 -18
- data/rbi/openai/resources/beta/responses/input_tokens.rbi +6 -6
- data/rbi/openai/resources/beta/responses.rbi +112 -102
- data/rbi/openai/resources/beta/threads/messages.rbi +9 -6
- data/rbi/openai/resources/beta/threads/runs/steps.rbi +2 -2
- data/rbi/openai/resources/beta/threads/runs.rbi +37 -33
- data/rbi/openai/resources/beta/threads.rbi +27 -24
- data/rbi/openai/resources/chat/completions.rbi +90 -82
- data/rbi/openai/resources/completions.rbi +30 -28
- data/rbi/openai/resources/content_provenance_checks.rbi +1 -1
- data/rbi/openai/resources/conversations/items.rbi +2 -2
- data/rbi/openai/resources/embeddings.rbi +5 -5
- data/rbi/openai/resources/evals.rbi +1 -1
- data/rbi/openai/resources/files.rbi +5 -5
- data/rbi/openai/resources/fine_tuning/alpha/graders.rbi +5 -4
- data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi +8 -4
- data/rbi/openai/resources/fine_tuning/jobs.rbi +10 -9
- data/rbi/openai/resources/images.rbi +113 -83
- data/rbi/openai/resources/moderations.rbi +5 -4
- data/rbi/openai/resources/realtime/calls.rbi +6 -6
- data/rbi/openai/resources/realtime/client_secrets.rbi +1 -1
- data/rbi/openai/resources/responses/input_tokens.rbi +6 -6
- data/rbi/openai/resources/responses.rbi +112 -100
- data/rbi/openai/resources/uploads/parts.rbi +5 -4
- data/rbi/openai/resources/uploads.rbi +10 -10
- data/rbi/openai/resources/vector_stores/file_batches.rbi +6 -6
- data/rbi/openai/resources/vector_stores/files.rbi +6 -6
- data/rbi/openai/resources/vector_stores.rbi +3 -3
- data/realtime.md +101 -0
- data/responses-websocket.md +182 -0
- data/sig/openai/helpers/local_audio/interface.rbs +62 -0
- data/sig/openai/helpers/realtime/connection.rbs +9 -1
- data/sig/openai/helpers/realtime/extensions.rbs +4 -0
- data/sig/openai/helpers/realtime/recovery.rbs +19 -0
- data/sig/openai/models/admin/organization/projects/project_api_key.rbs +7 -2
- data/sig/openai/models/admin/organization/projects/service_account_create_params.rbs +5 -0
- data/sig/openai/models/admin/organization/projects/service_account_create_response.rbs +7 -2
- data/sig/openai/models/beta/beta_response_input_item.rbs +39 -2
- data/sig/openai/models/beta/beta_response_item.rbs +39 -2
- data/sig/openai/models/beta/beta_response_output_item.rbs +39 -2
- data/sig/openai/models/beta/beta_tool.rbs +11 -1
- data/sig/openai/models/conversations/conversation_item.rbs +39 -2
- data/sig/openai/models/image_edit_completed_event.rbs +11 -4
- data/sig/openai/models/image_edit_params.rbs +3 -1
- data/sig/openai/models/image_edit_partial_image_event.rbs +11 -4
- data/sig/openai/models/image_gen_completed_event.rbs +11 -4
- data/sig/openai/models/image_gen_partial_image_event.rbs +11 -4
- data/sig/openai/models/image_generate_params.rbs +4 -1
- data/sig/openai/models/image_model.rbs +8 -0
- data/sig/openai/models/images_response.rbs +10 -4
- data/sig/openai/models/responses/response_input_item.rbs +39 -2
- data/sig/openai/models/responses/response_item.rbs +39 -2
- data/sig/openai/models/responses/response_output_item.rbs +39 -2
- data/sig/openai/models/responses/tool.rbs +11 -1
- data/sig/openai/resources/admin/organization/projects/service_accounts.rbs +1 -0
- metadata +15 -1
|
@@ -13,11 +13,11 @@ module OpenAI
|
|
|
13
13
|
variant :message, -> { OpenAI::Beta::BetaResponseOutputMessage }
|
|
14
14
|
|
|
15
15
|
# The results of a file search tool call. See the
|
|
16
|
-
# [file search guide](https://
|
|
16
|
+
# [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.
|
|
17
17
|
variant :file_search_call, -> { OpenAI::Beta::BetaResponseFileSearchToolCall }
|
|
18
18
|
|
|
19
19
|
# A tool call to run a function. See the
|
|
20
|
-
# [function calling guide](https://
|
|
20
|
+
# [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.
|
|
21
21
|
variant :function_call, -> { OpenAI::Beta::BetaResponseFunctionToolCall }
|
|
22
22
|
|
|
23
23
|
variant :function_call_output, -> { OpenAI::Beta::BetaResponseFunctionToolCallOutputItem }
|
|
@@ -29,11 +29,11 @@ module OpenAI
|
|
|
29
29
|
variant :multi_agent_call_output, -> { OpenAI::Beta::BetaResponseOutputItem::MultiAgentCallOutput }
|
|
30
30
|
|
|
31
31
|
# The results of a web search tool call. See the
|
|
32
|
-
# [web search guide](https://
|
|
32
|
+
# [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.
|
|
33
33
|
variant :web_search_call, -> { OpenAI::Beta::BetaResponseFunctionWebSearch }
|
|
34
34
|
|
|
35
35
|
# A tool call to a computer use tool. See the
|
|
36
|
-
# [computer use guide](https://
|
|
36
|
+
# [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.
|
|
37
37
|
variant :computer_call, -> { OpenAI::Beta::BetaResponseComputerToolCall }
|
|
38
38
|
|
|
39
39
|
variant :computer_call_output, -> { OpenAI::Beta::BetaResponseComputerToolCallOutputItem }
|
|
@@ -41,7 +41,7 @@ module OpenAI
|
|
|
41
41
|
# A description of the chain of thought used by a reasoning model while generating
|
|
42
42
|
# a response. Be sure to include these items in your `input` to the Responses API
|
|
43
43
|
# for subsequent turns of a conversation if you are manually
|
|
44
|
-
# [managing context](https://
|
|
44
|
+
# [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
45
45
|
variant :reasoning, -> { OpenAI::Beta::BetaResponseReasoningItem }
|
|
46
46
|
|
|
47
47
|
variant :program, -> { OpenAI::Beta::BetaResponseOutputItem::Program }
|
|
@@ -54,7 +54,7 @@ module OpenAI
|
|
|
54
54
|
|
|
55
55
|
variant :additional_tools, -> { OpenAI::Beta::BetaResponseOutputItem::AdditionalTools }
|
|
56
56
|
|
|
57
|
-
# A compaction item generated by the [`v1/responses/compact` API](https://
|
|
57
|
+
# A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
58
58
|
variant :compaction, -> { OpenAI::Beta::BetaResponseCompactionItem }
|
|
59
59
|
|
|
60
60
|
# An image generation request made by the model.
|
|
@@ -140,17 +140,23 @@ module OpenAI
|
|
|
140
140
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::AgentMessage::Agent }
|
|
141
141
|
|
|
142
142
|
# @!method initialize(id:, author:, content:, recipient:, agent: nil, type: :agent_message)
|
|
143
|
-
# @param id [String]
|
|
143
|
+
# @param id [String]
|
|
144
|
+
# The unique ID of the agent message.
|
|
144
145
|
#
|
|
145
|
-
# @param author [String]
|
|
146
|
+
# @param author [String]
|
|
147
|
+
# The sending agent identity.
|
|
146
148
|
#
|
|
147
|
-
# @param content [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::Text, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::SummaryText, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ReasoningText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ComputerScreenshot, OpenAI::Models::Beta::BetaResponseInputFile, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::EncryptedContent>]
|
|
149
|
+
# @param content [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::Text, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::SummaryText, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ReasoningText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ComputerScreenshot, OpenAI::Models::Beta::BetaResponseInputFile, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::EncryptedContent>]
|
|
150
|
+
# Encrypted content sent between agents.
|
|
148
151
|
#
|
|
149
|
-
# @param recipient [String]
|
|
152
|
+
# @param recipient [String]
|
|
153
|
+
# The destination agent identity.
|
|
150
154
|
#
|
|
151
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Agent]
|
|
155
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Agent]
|
|
156
|
+
# The agent that produced this item.
|
|
152
157
|
#
|
|
153
|
-
# @param type [Symbol, :agent_message]
|
|
158
|
+
# @param type [Symbol, :agent_message]
|
|
159
|
+
# The type of the item. Always `agent_message`.
|
|
154
160
|
|
|
155
161
|
# A content part that makes up an input or output item.
|
|
156
162
|
module Content
|
|
@@ -176,7 +182,7 @@ module OpenAI
|
|
|
176
182
|
# A refusal from the model.
|
|
177
183
|
variant :refusal, -> { OpenAI::Beta::BetaResponseOutputRefusal }
|
|
178
184
|
|
|
179
|
-
# An image input to the model. Learn about [image inputs](https://
|
|
185
|
+
# An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
180
186
|
variant :input_image, -> { OpenAI::Beta::BetaResponseInputImage }
|
|
181
187
|
|
|
182
188
|
# A screenshot of a computer.
|
|
@@ -228,9 +234,11 @@ module OpenAI
|
|
|
228
234
|
# @!method initialize(text:, type: :summary_text)
|
|
229
235
|
# A summary text from the model.
|
|
230
236
|
#
|
|
231
|
-
# @param text [String]
|
|
237
|
+
# @param text [String]
|
|
238
|
+
# A summary of the reasoning output from the model so far.
|
|
232
239
|
#
|
|
233
|
-
# @param type [Symbol, :summary_text]
|
|
240
|
+
# @param type [Symbol, :summary_text]
|
|
241
|
+
# The type of the object. Always `summary_text`.
|
|
234
242
|
end
|
|
235
243
|
|
|
236
244
|
class ReasoningText < OpenAI::Internal::Type::BaseModel
|
|
@@ -249,9 +257,11 @@ module OpenAI
|
|
|
249
257
|
# @!method initialize(text:, type: :reasoning_text)
|
|
250
258
|
# Reasoning text from the model.
|
|
251
259
|
#
|
|
252
|
-
# @param text [String]
|
|
260
|
+
# @param text [String]
|
|
261
|
+
# The reasoning text from the model.
|
|
253
262
|
#
|
|
254
|
-
# @param type [Symbol, :reasoning_text]
|
|
263
|
+
# @param type [Symbol, :reasoning_text]
|
|
264
|
+
# The type of the reasoning text. Always `reasoning_text`.
|
|
255
265
|
end
|
|
256
266
|
|
|
257
267
|
class ComputerScreenshot < OpenAI::Internal::Type::BaseModel
|
|
@@ -298,21 +308,26 @@ module OpenAI
|
|
|
298
308
|
)
|
|
299
309
|
|
|
300
310
|
# @!method initialize(detail:, file_id:, image_url:, prompt_cache_breakpoint: nil, type: :computer_screenshot)
|
|
301
|
-
# Some parameter documentations has been truncated, see
|
|
302
|
-
# {OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ComputerScreenshot}
|
|
303
|
-
# for more details.
|
|
304
|
-
#
|
|
305
311
|
# A screenshot of a computer.
|
|
306
312
|
#
|
|
307
|
-
# @param detail [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ComputerScreenshot::Detail]
|
|
313
|
+
# @param detail [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ComputerScreenshot::Detail]
|
|
314
|
+
# The detail level of the screenshot image to be sent to the model. One of `high`,
|
|
315
|
+
# `low`, `auto`, or `original`. Defaults to `auto`.
|
|
308
316
|
#
|
|
309
|
-
# @param file_id [String, nil]
|
|
317
|
+
# @param file_id [String, nil]
|
|
318
|
+
# The identifier of an uploaded file that contains the screenshot.
|
|
310
319
|
#
|
|
311
|
-
# @param image_url [String, nil]
|
|
320
|
+
# @param image_url [String, nil]
|
|
321
|
+
# The URL of the screenshot image.
|
|
312
322
|
#
|
|
313
|
-
# @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ComputerScreenshot::PromptCacheBreakpoint]
|
|
323
|
+
# @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage::Content::ComputerScreenshot::PromptCacheBreakpoint]
|
|
324
|
+
# Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
|
|
325
|
+
# from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
|
|
326
|
+
# token block.
|
|
314
327
|
#
|
|
315
|
-
# @param type [Symbol, :computer_screenshot]
|
|
328
|
+
# @param type [Symbol, :computer_screenshot]
|
|
329
|
+
# Specifies the event type. For a computer screenshot, this property is always set
|
|
330
|
+
# to `computer_screenshot`.
|
|
316
331
|
|
|
317
332
|
# The detail level of the screenshot image to be sent to the model. One of `high`,
|
|
318
333
|
# `low`, `auto`, or `original`. Defaults to `auto`.
|
|
@@ -343,7 +358,8 @@ module OpenAI
|
|
|
343
358
|
# from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
|
|
344
359
|
# token block.
|
|
345
360
|
#
|
|
346
|
-
# @param mode [Symbol, :explicit]
|
|
361
|
+
# @param mode [Symbol, :explicit]
|
|
362
|
+
# The breakpoint mode. Always `explicit`.
|
|
347
363
|
end
|
|
348
364
|
end
|
|
349
365
|
|
|
@@ -364,9 +380,11 @@ module OpenAI
|
|
|
364
380
|
# Opaque encrypted content that Responses API decrypts inside trusted model
|
|
365
381
|
# execution.
|
|
366
382
|
#
|
|
367
|
-
# @param encrypted_content [String]
|
|
383
|
+
# @param encrypted_content [String]
|
|
384
|
+
# Opaque encrypted content.
|
|
368
385
|
#
|
|
369
|
-
# @param type [Symbol, :encrypted_content]
|
|
386
|
+
# @param type [Symbol, :encrypted_content]
|
|
387
|
+
# The type of the input item. Always `encrypted_content`.
|
|
370
388
|
end
|
|
371
389
|
|
|
372
390
|
# @!method self.variants
|
|
@@ -384,7 +402,8 @@ module OpenAI
|
|
|
384
402
|
# @!method initialize(agent_name:)
|
|
385
403
|
# The agent that produced this item.
|
|
386
404
|
#
|
|
387
|
-
# @param agent_name [String]
|
|
405
|
+
# @param agent_name [String]
|
|
406
|
+
# The canonical name of the agent that produced this item.
|
|
388
407
|
end
|
|
389
408
|
end
|
|
390
409
|
|
|
@@ -426,17 +445,23 @@ module OpenAI
|
|
|
426
445
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::MultiAgentCall::Agent }
|
|
427
446
|
|
|
428
447
|
# @!method initialize(id:, action:, arguments:, call_id:, agent: nil, type: :multi_agent_call)
|
|
429
|
-
# @param id [String]
|
|
448
|
+
# @param id [String]
|
|
449
|
+
# The unique ID of the multi-agent call item.
|
|
430
450
|
#
|
|
431
|
-
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall::Action]
|
|
451
|
+
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall::Action]
|
|
452
|
+
# The multi-agent action to execute.
|
|
432
453
|
#
|
|
433
|
-
# @param arguments [String]
|
|
454
|
+
# @param arguments [String]
|
|
455
|
+
# The JSON string of arguments generated for the action.
|
|
434
456
|
#
|
|
435
|
-
# @param call_id [String]
|
|
457
|
+
# @param call_id [String]
|
|
458
|
+
# The unique ID linking this call to its output.
|
|
436
459
|
#
|
|
437
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall::Agent]
|
|
460
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall::Agent]
|
|
461
|
+
# The agent that produced this item.
|
|
438
462
|
#
|
|
439
|
-
# @param type [Symbol, :multi_agent_call]
|
|
463
|
+
# @param type [Symbol, :multi_agent_call]
|
|
464
|
+
# The type of the multi-agent call. Always `multi_agent_call`.
|
|
440
465
|
|
|
441
466
|
# The multi-agent action to execute.
|
|
442
467
|
#
|
|
@@ -466,7 +491,8 @@ module OpenAI
|
|
|
466
491
|
# @!method initialize(agent_name:)
|
|
467
492
|
# The agent that produced this item.
|
|
468
493
|
#
|
|
469
|
-
# @param agent_name [String]
|
|
494
|
+
# @param agent_name [String]
|
|
495
|
+
# The canonical name of the agent that produced this item.
|
|
470
496
|
end
|
|
471
497
|
end
|
|
472
498
|
|
|
@@ -508,17 +534,23 @@ module OpenAI
|
|
|
508
534
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::MultiAgentCallOutput::Agent }
|
|
509
535
|
|
|
510
536
|
# @!method initialize(id:, action:, call_id:, output:, agent: nil, type: :multi_agent_call_output)
|
|
511
|
-
# @param id [String]
|
|
537
|
+
# @param id [String]
|
|
538
|
+
# The unique ID of the multi-agent call output item.
|
|
512
539
|
#
|
|
513
|
-
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput::Action]
|
|
540
|
+
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput::Action]
|
|
541
|
+
# The multi-agent action that produced this result.
|
|
514
542
|
#
|
|
515
|
-
# @param call_id [String]
|
|
543
|
+
# @param call_id [String]
|
|
544
|
+
# The unique ID of the multi-agent call.
|
|
516
545
|
#
|
|
517
|
-
# @param output [Array<OpenAI::Models::Beta::BetaResponseOutputText>]
|
|
546
|
+
# @param output [Array<OpenAI::Models::Beta::BetaResponseOutputText>]
|
|
547
|
+
# Text output returned by the multi-agent action.
|
|
518
548
|
#
|
|
519
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput::Agent]
|
|
549
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput::Agent]
|
|
550
|
+
# The agent that produced this item.
|
|
520
551
|
#
|
|
521
|
-
# @param type [Symbol, :multi_agent_call_output]
|
|
552
|
+
# @param type [Symbol, :multi_agent_call_output]
|
|
553
|
+
# The type of the multi-agent result. Always `multi_agent_call_output`.
|
|
522
554
|
|
|
523
555
|
# The multi-agent action that produced this result.
|
|
524
556
|
#
|
|
@@ -548,7 +580,8 @@ module OpenAI
|
|
|
548
580
|
# @!method initialize(agent_name:)
|
|
549
581
|
# The agent that produced this item.
|
|
550
582
|
#
|
|
551
|
-
# @param agent_name [String]
|
|
583
|
+
# @param agent_name [String]
|
|
584
|
+
# The canonical name of the agent that produced this item.
|
|
552
585
|
end
|
|
553
586
|
end
|
|
554
587
|
|
|
@@ -590,17 +623,23 @@ module OpenAI
|
|
|
590
623
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::Program::Agent }
|
|
591
624
|
|
|
592
625
|
# @!method initialize(id:, call_id:, code:, fingerprint:, agent: nil, type: :program)
|
|
593
|
-
# @param id [String]
|
|
626
|
+
# @param id [String]
|
|
627
|
+
# The unique ID of the program item.
|
|
594
628
|
#
|
|
595
|
-
# @param call_id [String]
|
|
629
|
+
# @param call_id [String]
|
|
630
|
+
# The stable call ID of the program item.
|
|
596
631
|
#
|
|
597
|
-
# @param code [String]
|
|
632
|
+
# @param code [String]
|
|
633
|
+
# The JavaScript source executed by programmatic tool calling.
|
|
598
634
|
#
|
|
599
|
-
# @param fingerprint [String]
|
|
635
|
+
# @param fingerprint [String]
|
|
636
|
+
# Opaque program replay fingerprint that must be round-tripped.
|
|
600
637
|
#
|
|
601
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::Program::Agent]
|
|
638
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::Program::Agent]
|
|
639
|
+
# The agent that produced this item.
|
|
602
640
|
#
|
|
603
|
-
# @param type [Symbol, :program]
|
|
641
|
+
# @param type [Symbol, :program]
|
|
642
|
+
# The type of the item. Always `program`.
|
|
604
643
|
|
|
605
644
|
# @see OpenAI::Models::Beta::BetaResponseOutputItem::Program#agent
|
|
606
645
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -613,7 +652,8 @@ module OpenAI
|
|
|
613
652
|
# @!method initialize(agent_name:)
|
|
614
653
|
# The agent that produced this item.
|
|
615
654
|
#
|
|
616
|
-
# @param agent_name [String]
|
|
655
|
+
# @param agent_name [String]
|
|
656
|
+
# The canonical name of the agent that produced this item.
|
|
617
657
|
end
|
|
618
658
|
end
|
|
619
659
|
|
|
@@ -655,17 +695,23 @@ module OpenAI
|
|
|
655
695
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::ProgramOutput::Agent }
|
|
656
696
|
|
|
657
697
|
# @!method initialize(id:, call_id:, result:, status:, agent: nil, type: :program_output)
|
|
658
|
-
# @param id [String]
|
|
698
|
+
# @param id [String]
|
|
699
|
+
# The unique ID of the program output item.
|
|
659
700
|
#
|
|
660
|
-
# @param call_id [String]
|
|
701
|
+
# @param call_id [String]
|
|
702
|
+
# The call ID of the program item.
|
|
661
703
|
#
|
|
662
|
-
# @param result [String]
|
|
704
|
+
# @param result [String]
|
|
705
|
+
# The result produced by the program item.
|
|
663
706
|
#
|
|
664
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput::Status]
|
|
707
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput::Status]
|
|
708
|
+
# The terminal status of the program output item.
|
|
665
709
|
#
|
|
666
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput::Agent]
|
|
710
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput::Agent]
|
|
711
|
+
# The agent that produced this item.
|
|
667
712
|
#
|
|
668
|
-
# @param type [Symbol, :program_output]
|
|
713
|
+
# @param type [Symbol, :program_output]
|
|
714
|
+
# The type of the item. Always `program_output`.
|
|
669
715
|
|
|
670
716
|
# The terminal status of the program output item.
|
|
671
717
|
#
|
|
@@ -691,7 +737,8 @@ module OpenAI
|
|
|
691
737
|
# @!method initialize(agent_name:)
|
|
692
738
|
# The agent that produced this item.
|
|
693
739
|
#
|
|
694
|
-
# @param agent_name [String]
|
|
740
|
+
# @param agent_name [String]
|
|
741
|
+
# The canonical name of the agent that produced this item.
|
|
695
742
|
end
|
|
696
743
|
end
|
|
697
744
|
|
|
@@ -727,15 +774,20 @@ module OpenAI
|
|
|
727
774
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::AdditionalTools::Agent }
|
|
728
775
|
|
|
729
776
|
# @!method initialize(id:, role:, tools:, agent: nil, type: :additional_tools)
|
|
730
|
-
# @param id [String]
|
|
777
|
+
# @param id [String]
|
|
778
|
+
# The unique ID of the additional tools item.
|
|
731
779
|
#
|
|
732
|
-
# @param role [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools::Role]
|
|
780
|
+
# @param role [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools::Role]
|
|
781
|
+
# The role that provided the additional tools.
|
|
733
782
|
#
|
|
734
|
-
# @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>]
|
|
783
|
+
# @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>]
|
|
784
|
+
# The additional tool definitions made available at this item.
|
|
735
785
|
#
|
|
736
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools::Agent]
|
|
786
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools::Agent]
|
|
787
|
+
# The agent that produced this item.
|
|
737
788
|
#
|
|
738
|
-
# @param type [Symbol, :additional_tools]
|
|
789
|
+
# @param type [Symbol, :additional_tools]
|
|
790
|
+
# The type of the item. Always `additional_tools`.
|
|
739
791
|
|
|
740
792
|
# The role that provided the additional tools.
|
|
741
793
|
#
|
|
@@ -767,7 +819,8 @@ module OpenAI
|
|
|
767
819
|
# @!method initialize(agent_name:)
|
|
768
820
|
# The agent that produced this item.
|
|
769
821
|
#
|
|
770
|
-
# @param agent_name [String]
|
|
822
|
+
# @param agent_name [String]
|
|
823
|
+
# The canonical name of the agent that produced this item.
|
|
771
824
|
end
|
|
772
825
|
end
|
|
773
826
|
|
|
@@ -802,22 +855,53 @@ module OpenAI
|
|
|
802
855
|
# @return [OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent, nil]
|
|
803
856
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent }, nil?: true
|
|
804
857
|
|
|
805
|
-
# @!
|
|
806
|
-
#
|
|
807
|
-
#
|
|
808
|
-
# details.
|
|
858
|
+
# @!attribute quality
|
|
859
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
860
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
809
861
|
#
|
|
862
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Quality, nil]
|
|
863
|
+
optional(
|
|
864
|
+
:quality,
|
|
865
|
+
enum: -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Quality },
|
|
866
|
+
nil?: true
|
|
867
|
+
)
|
|
868
|
+
|
|
869
|
+
# @!attribute size
|
|
870
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
871
|
+
#
|
|
872
|
+
# @return [String, Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size, nil]
|
|
873
|
+
optional(
|
|
874
|
+
:size,
|
|
875
|
+
union: -> {
|
|
876
|
+
OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Size
|
|
877
|
+
},
|
|
878
|
+
nil?: true
|
|
879
|
+
)
|
|
880
|
+
|
|
881
|
+
# @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
|
|
810
882
|
# An image generation request made by the model.
|
|
811
883
|
#
|
|
812
|
-
# @param id [String]
|
|
884
|
+
# @param id [String]
|
|
885
|
+
# The unique ID of the image generation call.
|
|
813
886
|
#
|
|
814
|
-
# @param result [String, nil]
|
|
887
|
+
# @param result [String, nil]
|
|
888
|
+
# The generated image encoded in base64.
|
|
815
889
|
#
|
|
816
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Status]
|
|
890
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Status]
|
|
891
|
+
# The status of the image generation call.
|
|
817
892
|
#
|
|
818
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent, nil]
|
|
893
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent, nil]
|
|
894
|
+
# The agent that produced this item.
|
|
819
895
|
#
|
|
820
|
-
# @param
|
|
896
|
+
# @param quality [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Quality, nil]
|
|
897
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
898
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
899
|
+
#
|
|
900
|
+
# @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size, nil]
|
|
901
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
902
|
+
#
|
|
903
|
+
# @param type [Symbol, :image_generation_call]
|
|
904
|
+
# The type of the image generation call. Always `image_generation_call`.
|
|
821
905
|
|
|
822
906
|
# The status of the image generation call.
|
|
823
907
|
#
|
|
@@ -845,7 +929,64 @@ module OpenAI
|
|
|
845
929
|
# @!method initialize(agent_name:)
|
|
846
930
|
# The agent that produced this item.
|
|
847
931
|
#
|
|
848
|
-
# @param agent_name [String]
|
|
932
|
+
# @param agent_name [String]
|
|
933
|
+
# The canonical name of the agent that produced this item.
|
|
934
|
+
end
|
|
935
|
+
|
|
936
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
937
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
938
|
+
#
|
|
939
|
+
# @see OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall#quality
|
|
940
|
+
module Quality
|
|
941
|
+
extend OpenAI::Internal::Type::Enum
|
|
942
|
+
|
|
943
|
+
LOW = :low
|
|
944
|
+
MEDIUM = :medium
|
|
945
|
+
HIGH = :high
|
|
946
|
+
XHIGH = :xhigh
|
|
947
|
+
MAX = :max
|
|
948
|
+
AUTO = :auto
|
|
949
|
+
|
|
950
|
+
# @!method self.values
|
|
951
|
+
# @return [Array<Symbol>]
|
|
952
|
+
end
|
|
953
|
+
|
|
954
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
955
|
+
#
|
|
956
|
+
# @see OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall#size
|
|
957
|
+
module Size
|
|
958
|
+
extend OpenAI::Internal::Type::Union
|
|
959
|
+
|
|
960
|
+
variant String
|
|
961
|
+
|
|
962
|
+
variant(
|
|
963
|
+
const: -> { OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size::SIZE_1024X1024 }
|
|
964
|
+
)
|
|
965
|
+
|
|
966
|
+
variant(
|
|
967
|
+
const: -> { OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size::SIZE_1024X1536 }
|
|
968
|
+
)
|
|
969
|
+
|
|
970
|
+
variant(
|
|
971
|
+
const: -> { OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size::SIZE_1536X1024 }
|
|
972
|
+
)
|
|
973
|
+
|
|
974
|
+
# @!method self.variants
|
|
975
|
+
# @return [Array(String, Symbol)]
|
|
976
|
+
|
|
977
|
+
define_sorbet_constant!(:Variants) do
|
|
978
|
+
T.type_alias {
|
|
979
|
+
T.any(String, OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol)
|
|
980
|
+
}
|
|
981
|
+
end
|
|
982
|
+
|
|
983
|
+
# @!group
|
|
984
|
+
|
|
985
|
+
SIZE_1024X1024 = :"1024x1024"
|
|
986
|
+
SIZE_1024X1536 = :"1024x1536"
|
|
987
|
+
SIZE_1536X1024 = :"1536x1024"
|
|
988
|
+
|
|
989
|
+
# @!endgroup
|
|
849
990
|
end
|
|
850
991
|
end
|
|
851
992
|
|
|
@@ -887,22 +1028,25 @@ module OpenAI
|
|
|
887
1028
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::LocalShellCall::Agent }, nil?: true
|
|
888
1029
|
|
|
889
1030
|
# @!method initialize(id:, action:, call_id:, status:, agent: nil, type: :local_shell_call)
|
|
890
|
-
# Some parameter documentations has been truncated, see
|
|
891
|
-
# {OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall} for more details.
|
|
892
|
-
#
|
|
893
1031
|
# A tool call to run a command on the local shell.
|
|
894
1032
|
#
|
|
895
|
-
# @param id [String]
|
|
1033
|
+
# @param id [String]
|
|
1034
|
+
# The unique ID of the local shell call.
|
|
896
1035
|
#
|
|
897
|
-
# @param action [OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall::Action]
|
|
1036
|
+
# @param action [OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall::Action]
|
|
1037
|
+
# Execute a shell command on the server.
|
|
898
1038
|
#
|
|
899
|
-
# @param call_id [String]
|
|
1039
|
+
# @param call_id [String]
|
|
1040
|
+
# The unique ID of the local shell tool call generated by the model.
|
|
900
1041
|
#
|
|
901
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall::Status]
|
|
1042
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall::Status]
|
|
1043
|
+
# The status of the local shell call.
|
|
902
1044
|
#
|
|
903
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall::Agent, nil]
|
|
1045
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall::Agent, nil]
|
|
1046
|
+
# The agent that produced this item.
|
|
904
1047
|
#
|
|
905
|
-
# @param type [Symbol, :local_shell_call]
|
|
1048
|
+
# @param type [Symbol, :local_shell_call]
|
|
1049
|
+
# The type of the local shell call. Always `local_shell_call`.
|
|
906
1050
|
|
|
907
1051
|
# @see OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall#action
|
|
908
1052
|
class Action < OpenAI::Internal::Type::BaseModel
|
|
@@ -945,17 +1089,23 @@ module OpenAI
|
|
|
945
1089
|
# @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
|
|
946
1090
|
# Execute a shell command on the server.
|
|
947
1091
|
#
|
|
948
|
-
# @param command [Array<String>]
|
|
1092
|
+
# @param command [Array<String>]
|
|
1093
|
+
# The command to run.
|
|
949
1094
|
#
|
|
950
|
-
# @param env [Hash{Symbol=>String}]
|
|
1095
|
+
# @param env [Hash{Symbol=>String}]
|
|
1096
|
+
# Environment variables to set for the command.
|
|
951
1097
|
#
|
|
952
|
-
# @param timeout_ms [Integer, nil]
|
|
1098
|
+
# @param timeout_ms [Integer, nil]
|
|
1099
|
+
# Optional timeout in milliseconds for the command.
|
|
953
1100
|
#
|
|
954
|
-
# @param user [String, nil]
|
|
1101
|
+
# @param user [String, nil]
|
|
1102
|
+
# Optional user to run the command as.
|
|
955
1103
|
#
|
|
956
|
-
# @param working_directory [String, nil]
|
|
1104
|
+
# @param working_directory [String, nil]
|
|
1105
|
+
# Optional working directory to run the command in.
|
|
957
1106
|
#
|
|
958
|
-
# @param type [Symbol, :exec]
|
|
1107
|
+
# @param type [Symbol, :exec]
|
|
1108
|
+
# The type of the local shell action. Always `exec`.
|
|
959
1109
|
end
|
|
960
1110
|
|
|
961
1111
|
# The status of the local shell call.
|
|
@@ -983,7 +1133,8 @@ module OpenAI
|
|
|
983
1133
|
# @!method initialize(agent_name:)
|
|
984
1134
|
# The agent that produced this item.
|
|
985
1135
|
#
|
|
986
|
-
# @param agent_name [String]
|
|
1136
|
+
# @param agent_name [String]
|
|
1137
|
+
# The canonical name of the agent that produced this item.
|
|
987
1138
|
end
|
|
988
1139
|
end
|
|
989
1140
|
|
|
@@ -1029,21 +1180,22 @@ module OpenAI
|
|
|
1029
1180
|
)
|
|
1030
1181
|
|
|
1031
1182
|
# @!method initialize(id:, output:, agent: nil, status: nil, type: :local_shell_call_output)
|
|
1032
|
-
# Some parameter documentations has been truncated, see
|
|
1033
|
-
# {OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput} for more
|
|
1034
|
-
# details.
|
|
1035
|
-
#
|
|
1036
1183
|
# The output of a local shell tool call.
|
|
1037
1184
|
#
|
|
1038
|
-
# @param id [String]
|
|
1185
|
+
# @param id [String]
|
|
1186
|
+
# The unique ID of the local shell tool call generated by the model.
|
|
1039
1187
|
#
|
|
1040
|
-
# @param output [String]
|
|
1188
|
+
# @param output [String]
|
|
1189
|
+
# A JSON string of the output of the local shell tool call.
|
|
1041
1190
|
#
|
|
1042
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput::Agent, nil]
|
|
1191
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput::Agent, nil]
|
|
1192
|
+
# The agent that produced this item.
|
|
1043
1193
|
#
|
|
1044
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput::Status, nil]
|
|
1194
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput::Status, nil]
|
|
1195
|
+
# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
1045
1196
|
#
|
|
1046
|
-
# @param type [Symbol, :local_shell_call_output]
|
|
1197
|
+
# @param type [Symbol, :local_shell_call_output]
|
|
1198
|
+
# The type of the local shell tool call output. Always `local_shell_call_output`.
|
|
1047
1199
|
|
|
1048
1200
|
# @see OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput#agent
|
|
1049
1201
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -1056,7 +1208,8 @@ module OpenAI
|
|
|
1056
1208
|
# @!method initialize(agent_name:)
|
|
1057
1209
|
# The agent that produced this item.
|
|
1058
1210
|
#
|
|
1059
|
-
# @param agent_name [String]
|
|
1211
|
+
# @param agent_name [String]
|
|
1212
|
+
# The canonical name of the agent that produced this item.
|
|
1060
1213
|
end
|
|
1061
1214
|
|
|
1062
1215
|
# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
@@ -1139,30 +1292,40 @@ module OpenAI
|
|
|
1139
1292
|
optional :status, enum: -> { OpenAI::Beta::BetaResponseOutputItem::McpCall::Status }
|
|
1140
1293
|
|
|
1141
1294
|
# @!method initialize(id:, arguments:, name:, server_label:, agent: nil, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
|
|
1142
|
-
# Some parameter documentations has been truncated, see
|
|
1143
|
-
# {OpenAI::Models::Beta::BetaResponseOutputItem::McpCall} for more details.
|
|
1144
|
-
#
|
|
1145
1295
|
# An invocation of a tool on an MCP server.
|
|
1146
1296
|
#
|
|
1147
|
-
# @param id [String]
|
|
1297
|
+
# @param id [String]
|
|
1298
|
+
# The unique ID of the tool call.
|
|
1148
1299
|
#
|
|
1149
|
-
# @param arguments [String]
|
|
1300
|
+
# @param arguments [String]
|
|
1301
|
+
# A JSON string of the arguments passed to the tool.
|
|
1150
1302
|
#
|
|
1151
|
-
# @param name [String]
|
|
1303
|
+
# @param name [String]
|
|
1304
|
+
# The name of the tool that was run.
|
|
1152
1305
|
#
|
|
1153
|
-
# @param server_label [String]
|
|
1306
|
+
# @param server_label [String]
|
|
1307
|
+
# The label of the MCP server running the tool.
|
|
1154
1308
|
#
|
|
1155
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::McpCall::Agent, nil]
|
|
1309
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::McpCall::Agent, nil]
|
|
1310
|
+
# The agent that produced this item.
|
|
1156
1311
|
#
|
|
1157
|
-
# @param approval_request_id [String, nil]
|
|
1312
|
+
# @param approval_request_id [String, nil]
|
|
1313
|
+
# Unique identifier for the MCP tool call approval request. Include this value in
|
|
1314
|
+
# a subsequent `mcp_approval_response` input to approve or reject the
|
|
1315
|
+
# corresponding tool call.
|
|
1158
1316
|
#
|
|
1159
|
-
# @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil]
|
|
1317
|
+
# @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil]
|
|
1318
|
+
# The error from the tool call, if any.
|
|
1160
1319
|
#
|
|
1161
|
-
# @param output [String, nil]
|
|
1320
|
+
# @param output [String, nil]
|
|
1321
|
+
# The output from the tool call.
|
|
1162
1322
|
#
|
|
1163
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall::Status]
|
|
1323
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall::Status]
|
|
1324
|
+
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
|
|
1325
|
+
# `calling`, or `failed`.
|
|
1164
1326
|
#
|
|
1165
|
-
# @param type [Symbol, :mcp_call]
|
|
1327
|
+
# @param type [Symbol, :mcp_call]
|
|
1328
|
+
# The type of the item. Always `mcp_call`.
|
|
1166
1329
|
|
|
1167
1330
|
# @see OpenAI::Models::Beta::BetaResponseOutputItem::McpCall#agent
|
|
1168
1331
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -1175,7 +1338,8 @@ module OpenAI
|
|
|
1175
1338
|
# @!method initialize(agent_name:)
|
|
1176
1339
|
# The agent that produced this item.
|
|
1177
1340
|
#
|
|
1178
|
-
# @param agent_name [String]
|
|
1341
|
+
# @param agent_name [String]
|
|
1342
|
+
# The canonical name of the agent that produced this item.
|
|
1179
1343
|
end
|
|
1180
1344
|
|
|
1181
1345
|
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
|
|
@@ -1237,23 +1401,25 @@ module OpenAI
|
|
|
1237
1401
|
optional :error, String, nil?: true
|
|
1238
1402
|
|
|
1239
1403
|
# @!method initialize(id:, server_label:, tools:, agent: nil, error: nil, type: :mcp_list_tools)
|
|
1240
|
-
# Some parameter documentations has been truncated, see
|
|
1241
|
-
# {OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools} for more details.
|
|
1242
|
-
#
|
|
1243
1404
|
# A list of tools available on an MCP server.
|
|
1244
1405
|
#
|
|
1245
|
-
# @param id [String]
|
|
1406
|
+
# @param id [String]
|
|
1407
|
+
# The unique ID of the list.
|
|
1246
1408
|
#
|
|
1247
|
-
# @param server_label [String]
|
|
1409
|
+
# @param server_label [String]
|
|
1410
|
+
# The label of the MCP server.
|
|
1248
1411
|
#
|
|
1249
|
-
# @param tools [Array<OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools::Tool>]
|
|
1412
|
+
# @param tools [Array<OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools::Tool>]
|
|
1413
|
+
# The tools available on the server.
|
|
1250
1414
|
#
|
|
1251
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools::Agent, nil]
|
|
1415
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools::Agent, nil]
|
|
1416
|
+
# The agent that produced this item.
|
|
1252
1417
|
#
|
|
1253
|
-
# @param error [String, nil]
|
|
1418
|
+
# @param error [String, nil]
|
|
1419
|
+
# Error message if the server could not list tools.
|
|
1254
1420
|
#
|
|
1255
|
-
# @param type [Symbol, :mcp_list_tools]
|
|
1256
|
-
|
|
1421
|
+
# @param type [Symbol, :mcp_list_tools]
|
|
1422
|
+
# The type of the item. Always `mcp_list_tools`.
|
|
1257
1423
|
class Tool < OpenAI::Internal::Type::BaseModel
|
|
1258
1424
|
# @!attribute input_schema
|
|
1259
1425
|
# The JSON schema describing the tool's input.
|
|
@@ -1280,19 +1446,19 @@ module OpenAI
|
|
|
1280
1446
|
optional :description, String, nil?: true
|
|
1281
1447
|
|
|
1282
1448
|
# @!method initialize(input_schema:, name:, annotations: nil, description: nil)
|
|
1283
|
-
# Some parameter documentations has been truncated, see
|
|
1284
|
-
# {OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools::Tool} for more
|
|
1285
|
-
# details.
|
|
1286
|
-
#
|
|
1287
1449
|
# A tool available on an MCP server.
|
|
1288
1450
|
#
|
|
1289
|
-
# @param input_schema [Object]
|
|
1451
|
+
# @param input_schema [Object]
|
|
1452
|
+
# The JSON schema describing the tool's input.
|
|
1290
1453
|
#
|
|
1291
|
-
# @param name [String]
|
|
1454
|
+
# @param name [String]
|
|
1455
|
+
# The name of the tool.
|
|
1292
1456
|
#
|
|
1293
|
-
# @param annotations [Object, nil]
|
|
1457
|
+
# @param annotations [Object, nil]
|
|
1458
|
+
# Additional annotations about the tool.
|
|
1294
1459
|
#
|
|
1295
|
-
# @param description [String, nil]
|
|
1460
|
+
# @param description [String, nil]
|
|
1461
|
+
# The description of the tool.
|
|
1296
1462
|
end
|
|
1297
1463
|
|
|
1298
1464
|
# @see OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools#agent
|
|
@@ -1306,7 +1472,8 @@ module OpenAI
|
|
|
1306
1472
|
# @!method initialize(agent_name:)
|
|
1307
1473
|
# The agent that produced this item.
|
|
1308
1474
|
#
|
|
1309
|
-
# @param agent_name [String]
|
|
1475
|
+
# @param agent_name [String]
|
|
1476
|
+
# The canonical name of the agent that produced this item.
|
|
1310
1477
|
end
|
|
1311
1478
|
end
|
|
1312
1479
|
|
|
@@ -1348,23 +1515,25 @@ module OpenAI
|
|
|
1348
1515
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::McpApprovalRequest::Agent }, nil?: true
|
|
1349
1516
|
|
|
1350
1517
|
# @!method initialize(id:, arguments:, name:, server_label:, agent: nil, type: :mcp_approval_request)
|
|
1351
|
-
# Some parameter documentations has been truncated, see
|
|
1352
|
-
# {OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest} for more
|
|
1353
|
-
# details.
|
|
1354
|
-
#
|
|
1355
1518
|
# A request for human approval of a tool invocation.
|
|
1356
1519
|
#
|
|
1357
|
-
# @param id [String]
|
|
1520
|
+
# @param id [String]
|
|
1521
|
+
# The unique ID of the approval request.
|
|
1358
1522
|
#
|
|
1359
|
-
# @param arguments [String]
|
|
1523
|
+
# @param arguments [String]
|
|
1524
|
+
# A JSON string of arguments for the tool.
|
|
1360
1525
|
#
|
|
1361
|
-
# @param name [String]
|
|
1526
|
+
# @param name [String]
|
|
1527
|
+
# The name of the tool to run.
|
|
1362
1528
|
#
|
|
1363
|
-
# @param server_label [String]
|
|
1529
|
+
# @param server_label [String]
|
|
1530
|
+
# The label of the MCP server making the request.
|
|
1364
1531
|
#
|
|
1365
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest::Agent, nil]
|
|
1532
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest::Agent, nil]
|
|
1533
|
+
# The agent that produced this item.
|
|
1366
1534
|
#
|
|
1367
|
-
# @param type [Symbol, :mcp_approval_request]
|
|
1535
|
+
# @param type [Symbol, :mcp_approval_request]
|
|
1536
|
+
# The type of the item. Always `mcp_approval_request`.
|
|
1368
1537
|
|
|
1369
1538
|
# @see OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest#agent
|
|
1370
1539
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -1377,7 +1546,8 @@ module OpenAI
|
|
|
1377
1546
|
# @!method initialize(agent_name:)
|
|
1378
1547
|
# The agent that produced this item.
|
|
1379
1548
|
#
|
|
1380
|
-
# @param agent_name [String]
|
|
1549
|
+
# @param agent_name [String]
|
|
1550
|
+
# The canonical name of the agent that produced this item.
|
|
1381
1551
|
end
|
|
1382
1552
|
end
|
|
1383
1553
|
|
|
@@ -1419,23 +1589,25 @@ module OpenAI
|
|
|
1419
1589
|
optional :reason, String, nil?: true
|
|
1420
1590
|
|
|
1421
1591
|
# @!method initialize(id:, approval_request_id:, approve:, agent: nil, reason: nil, type: :mcp_approval_response)
|
|
1422
|
-
# Some parameter documentations has been truncated, see
|
|
1423
|
-
# {OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse} for more
|
|
1424
|
-
# details.
|
|
1425
|
-
#
|
|
1426
1592
|
# A response to an MCP approval request.
|
|
1427
1593
|
#
|
|
1428
|
-
# @param id [String]
|
|
1594
|
+
# @param id [String]
|
|
1595
|
+
# The unique ID of the approval response
|
|
1429
1596
|
#
|
|
1430
|
-
# @param approval_request_id [String]
|
|
1597
|
+
# @param approval_request_id [String]
|
|
1598
|
+
# The ID of the approval request being answered.
|
|
1431
1599
|
#
|
|
1432
|
-
# @param approve [Boolean]
|
|
1600
|
+
# @param approve [Boolean]
|
|
1601
|
+
# Whether the request was approved.
|
|
1433
1602
|
#
|
|
1434
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse::Agent, nil]
|
|
1603
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse::Agent, nil]
|
|
1604
|
+
# The agent that produced this item.
|
|
1435
1605
|
#
|
|
1436
|
-
# @param reason [String, nil]
|
|
1606
|
+
# @param reason [String, nil]
|
|
1607
|
+
# Optional reason for the decision.
|
|
1437
1608
|
#
|
|
1438
|
-
# @param type [Symbol, :mcp_approval_response]
|
|
1609
|
+
# @param type [Symbol, :mcp_approval_response]
|
|
1610
|
+
# The type of the item. Always `mcp_approval_response`.
|
|
1439
1611
|
|
|
1440
1612
|
# @see OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse#agent
|
|
1441
1613
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -1448,7 +1620,8 @@ module OpenAI
|
|
|
1448
1620
|
# @!method initialize(agent_name:)
|
|
1449
1621
|
# The agent that produced this item.
|
|
1450
1622
|
#
|
|
1451
|
-
# @param agent_name [String]
|
|
1623
|
+
# @param agent_name [String]
|
|
1624
|
+
# The canonical name of the agent that produced this item.
|
|
1452
1625
|
end
|
|
1453
1626
|
end
|
|
1454
1627
|
|