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
|
@@ -29,22 +29,22 @@ module OpenAI
|
|
|
29
29
|
variant :message, -> { OpenAI::Responses::ResponseOutputMessage }
|
|
30
30
|
|
|
31
31
|
# The results of a file search tool call. See the
|
|
32
|
-
# [file search guide](https://
|
|
32
|
+
# [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.
|
|
33
33
|
variant :file_search_call, -> { OpenAI::Responses::ResponseFileSearchToolCall }
|
|
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::Responses::ResponseComputerToolCall }
|
|
38
38
|
|
|
39
39
|
# The output of a computer tool call.
|
|
40
40
|
variant :computer_call_output, -> { OpenAI::Responses::ResponseInputItem::ComputerCallOutput }
|
|
41
41
|
|
|
42
42
|
# The results of a web search tool call. See the
|
|
43
|
-
# [web search guide](https://
|
|
43
|
+
# [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.
|
|
44
44
|
variant :web_search_call, -> { OpenAI::Responses::ResponseFunctionWebSearch }
|
|
45
45
|
|
|
46
46
|
# A tool call to run a function. See the
|
|
47
|
-
# [function calling guide](https://
|
|
47
|
+
# [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.
|
|
48
48
|
variant :function_call, -> { OpenAI::Responses::ResponseFunctionToolCall }
|
|
49
49
|
|
|
50
50
|
# The output of a function tool call.
|
|
@@ -64,10 +64,10 @@ module OpenAI
|
|
|
64
64
|
# A description of the chain of thought used by a reasoning model while generating
|
|
65
65
|
# a response. Be sure to include these items in your `input` to the Responses API
|
|
66
66
|
# for subsequent turns of a conversation if you are manually
|
|
67
|
-
# [managing context](https://
|
|
67
|
+
# [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
68
68
|
variant :reasoning, -> { OpenAI::Responses::ResponseReasoningItem }
|
|
69
69
|
|
|
70
|
-
# A compaction item generated by the [`v1/responses/compact` API](https://
|
|
70
|
+
# A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
71
71
|
variant :compaction, -> { OpenAI::Responses::ResponseCompactionItemParam }
|
|
72
72
|
|
|
73
73
|
# An image generation request made by the model.
|
|
@@ -150,20 +150,23 @@ module OpenAI
|
|
|
150
150
|
optional :type, enum: -> { OpenAI::Responses::ResponseInputItem::Message::Type }
|
|
151
151
|
|
|
152
152
|
# @!method initialize(content:, role:, status: nil, type: nil)
|
|
153
|
-
# Some parameter documentations has been truncated, see
|
|
154
|
-
# {OpenAI::Models::Responses::ResponseInputItem::Message} for more details.
|
|
155
|
-
#
|
|
156
153
|
# A message input to the model with a role indicating instruction following
|
|
157
154
|
# hierarchy. Instructions given with the `developer` or `system` role take
|
|
158
155
|
# precedence over instructions given with the `user` role.
|
|
159
156
|
#
|
|
160
|
-
# @param content [Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>]
|
|
157
|
+
# @param content [Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>]
|
|
158
|
+
# A list of one or many input items to the model, containing different content
|
|
159
|
+
# types.
|
|
161
160
|
#
|
|
162
|
-
# @param role [Symbol, OpenAI::Models::Responses::ResponseInputItem::Message::Role]
|
|
161
|
+
# @param role [Symbol, OpenAI::Models::Responses::ResponseInputItem::Message::Role]
|
|
162
|
+
# The role of the message input. One of `user`, `system`, or `developer`.
|
|
163
163
|
#
|
|
164
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::Message::Status]
|
|
164
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::Message::Status]
|
|
165
|
+
# The status of item. One of `in_progress`, `completed`, or `incomplete`.
|
|
166
|
+
# Populated when items are returned via API.
|
|
165
167
|
#
|
|
166
|
-
# @param type [Symbol, OpenAI::Models::Responses::ResponseInputItem::Message::Type]
|
|
168
|
+
# @param type [Symbol, OpenAI::Models::Responses::ResponseInputItem::Message::Type]
|
|
169
|
+
# The type of the message input. Always set to `message`.
|
|
167
170
|
|
|
168
171
|
# The role of the message input. One of `user`, `system`, or `developer`.
|
|
169
172
|
#
|
|
@@ -259,24 +262,27 @@ module OpenAI
|
|
|
259
262
|
)
|
|
260
263
|
|
|
261
264
|
# @!method initialize(call_id:, output:, id: nil, acknowledged_safety_checks: nil, status: nil, type: :computer_call_output)
|
|
262
|
-
# Some parameter documentations has been truncated, see
|
|
263
|
-
# {OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput} for more
|
|
264
|
-
# details.
|
|
265
|
-
#
|
|
266
265
|
# The output of a computer tool call.
|
|
267
266
|
#
|
|
268
|
-
# @param call_id [String]
|
|
267
|
+
# @param call_id [String]
|
|
268
|
+
# The ID of the computer tool call that produced the output.
|
|
269
269
|
#
|
|
270
|
-
# @param output [OpenAI::Models::Responses::ResponseComputerToolCallOutputScreenshot]
|
|
270
|
+
# @param output [OpenAI::Models::Responses::ResponseComputerToolCallOutputScreenshot]
|
|
271
|
+
# A computer screenshot image used with the computer use tool.
|
|
271
272
|
#
|
|
272
|
-
# @param id [String, nil]
|
|
273
|
+
# @param id [String, nil]
|
|
274
|
+
# The ID of the computer tool call output.
|
|
273
275
|
#
|
|
274
|
-
# @param acknowledged_safety_checks [Array<OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput::AcknowledgedSafetyCheck>, nil]
|
|
276
|
+
# @param acknowledged_safety_checks [Array<OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput::AcknowledgedSafetyCheck>, nil]
|
|
277
|
+
# The safety checks reported by the API that have been acknowledged by the
|
|
278
|
+
# developer.
|
|
275
279
|
#
|
|
276
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput::Status, nil]
|
|
280
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput::Status, nil]
|
|
281
|
+
# The status of the message input. One of `in_progress`, `completed`, or
|
|
282
|
+
# `incomplete`. Populated when input items are returned via API.
|
|
277
283
|
#
|
|
278
|
-
# @param type [Symbol, :computer_call_output]
|
|
279
|
-
|
|
284
|
+
# @param type [Symbol, :computer_call_output]
|
|
285
|
+
# The type of the computer tool call output. Always `computer_call_output`.
|
|
280
286
|
class AcknowledgedSafetyCheck < OpenAI::Internal::Type::BaseModel
|
|
281
287
|
# @!attribute id
|
|
282
288
|
# The ID of the pending safety check.
|
|
@@ -299,11 +305,14 @@ module OpenAI
|
|
|
299
305
|
# @!method initialize(id:, code: nil, message: nil)
|
|
300
306
|
# A pending safety check for the computer call.
|
|
301
307
|
#
|
|
302
|
-
# @param id [String]
|
|
308
|
+
# @param id [String]
|
|
309
|
+
# The ID of the pending safety check.
|
|
303
310
|
#
|
|
304
|
-
# @param code [String, nil]
|
|
311
|
+
# @param code [String, nil]
|
|
312
|
+
# The type of the pending safety check.
|
|
305
313
|
#
|
|
306
|
-
# @param message [String, nil]
|
|
314
|
+
# @param message [String, nil]
|
|
315
|
+
# Details about the pending safety check.
|
|
307
316
|
end
|
|
308
317
|
|
|
309
318
|
# The status of the message input. One of `in_progress`, `completed`, or
|
|
@@ -383,27 +392,33 @@ module OpenAI
|
|
|
383
392
|
)
|
|
384
393
|
|
|
385
394
|
# @!method initialize(output:, id: nil, call_id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
|
|
386
|
-
# Some parameter documentations has been truncated, see
|
|
387
|
-
# {OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput} for more
|
|
388
|
-
# details.
|
|
389
|
-
#
|
|
390
395
|
# The output of a function tool call.
|
|
391
396
|
#
|
|
392
|
-
# @param output [String, Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>]
|
|
397
|
+
# @param output [String, Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>]
|
|
398
|
+
# Text, image, or file output of the function tool call.
|
|
393
399
|
#
|
|
394
|
-
# @param id [String, nil]
|
|
400
|
+
# @param id [String, nil]
|
|
401
|
+
# The unique ID of the function tool call output. Populated when this item is
|
|
402
|
+
# returned via API.
|
|
395
403
|
#
|
|
396
|
-
# @param call_id [String, nil]
|
|
404
|
+
# @param call_id [String, nil]
|
|
405
|
+
# The unique ID of the function tool call generated by the model.
|
|
397
406
|
#
|
|
398
|
-
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Caller::Program, nil]
|
|
407
|
+
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Caller::Program, nil]
|
|
408
|
+
# The execution context that produced this tool call.
|
|
399
409
|
#
|
|
400
|
-
# @param name [String, nil]
|
|
410
|
+
# @param name [String, nil]
|
|
411
|
+
# The name of the tool that produced the output.
|
|
401
412
|
#
|
|
402
|
-
# @param namespace [String, nil]
|
|
413
|
+
# @param namespace [String, nil]
|
|
414
|
+
# The namespace of the tool that produced the output.
|
|
403
415
|
#
|
|
404
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Status, nil]
|
|
416
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Status, nil]
|
|
417
|
+
# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
418
|
+
# Populated when items are returned via API.
|
|
405
419
|
#
|
|
406
|
-
# @param type [Symbol, :function_call_output]
|
|
420
|
+
# @param type [Symbol, :function_call_output]
|
|
421
|
+
# The type of the function tool call output. Always `function_call_output`.
|
|
407
422
|
|
|
408
423
|
# Text, image, or file output of the function tool call.
|
|
409
424
|
#
|
|
@@ -441,7 +456,8 @@ module OpenAI
|
|
|
441
456
|
required :type, const: :direct
|
|
442
457
|
|
|
443
458
|
# @!method initialize(type: :direct)
|
|
444
|
-
# @param type [Symbol, :direct]
|
|
459
|
+
# @param type [Symbol, :direct]
|
|
460
|
+
# The caller type. Always `direct`.
|
|
445
461
|
end
|
|
446
462
|
|
|
447
463
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -458,9 +474,11 @@ module OpenAI
|
|
|
458
474
|
required :type, const: :program
|
|
459
475
|
|
|
460
476
|
# @!method initialize(caller_id:, type: :program)
|
|
461
|
-
# @param caller_id [String]
|
|
477
|
+
# @param caller_id [String]
|
|
478
|
+
# The call ID of the program item that produced this tool call.
|
|
462
479
|
#
|
|
463
|
-
# @param type [Symbol, :program]
|
|
480
|
+
# @param type [Symbol, :program]
|
|
481
|
+
# The caller type. Always `program`.
|
|
464
482
|
end
|
|
465
483
|
|
|
466
484
|
# @!method self.variants
|
|
@@ -527,17 +545,23 @@ module OpenAI
|
|
|
527
545
|
)
|
|
528
546
|
|
|
529
547
|
# @!method initialize(arguments:, id: nil, call_id: nil, execution: nil, status: nil, type: :tool_search_call)
|
|
530
|
-
# @param arguments [Object]
|
|
548
|
+
# @param arguments [Object]
|
|
549
|
+
# The arguments supplied to the tool search call.
|
|
531
550
|
#
|
|
532
|
-
# @param id [String, nil]
|
|
551
|
+
# @param id [String, nil]
|
|
552
|
+
# The unique ID of this tool search call.
|
|
533
553
|
#
|
|
534
|
-
# @param call_id [String, nil]
|
|
554
|
+
# @param call_id [String, nil]
|
|
555
|
+
# The unique ID of the tool search call generated by the model.
|
|
535
556
|
#
|
|
536
|
-
# @param execution [Symbol, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::Execution]
|
|
557
|
+
# @param execution [Symbol, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::Execution]
|
|
558
|
+
# Whether tool search was executed by the server or by the client.
|
|
537
559
|
#
|
|
538
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::Status, nil]
|
|
560
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::Status, nil]
|
|
561
|
+
# The status of the tool search call.
|
|
539
562
|
#
|
|
540
|
-
# @param type [Symbol, :tool_search_call]
|
|
563
|
+
# @param type [Symbol, :tool_search_call]
|
|
564
|
+
# The item type. Always `tool_search_call`.
|
|
541
565
|
|
|
542
566
|
# Whether tool search was executed by the server or by the client.
|
|
543
567
|
#
|
|
@@ -593,13 +617,17 @@ module OpenAI
|
|
|
593
617
|
optional :id, String, nil?: true
|
|
594
618
|
|
|
595
619
|
# @!method initialize(tools:, id: nil, role: :developer, type: :additional_tools)
|
|
596
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
620
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
621
|
+
# A list of additional tools made available at this item.
|
|
597
622
|
#
|
|
598
|
-
# @param id [String, nil]
|
|
623
|
+
# @param id [String, nil]
|
|
624
|
+
# The unique ID of this additional tools item.
|
|
599
625
|
#
|
|
600
|
-
# @param role [Symbol, :developer]
|
|
626
|
+
# @param role [Symbol, :developer]
|
|
627
|
+
# The role that provided the additional tools. Only `developer` is supported.
|
|
601
628
|
#
|
|
602
|
-
# @param type [Symbol, :additional_tools]
|
|
629
|
+
# @param type [Symbol, :additional_tools]
|
|
630
|
+
# The item type. Always `additional_tools`.
|
|
603
631
|
end
|
|
604
632
|
|
|
605
633
|
class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
|
|
@@ -627,20 +655,50 @@ module OpenAI
|
|
|
627
655
|
# @return [Symbol, :image_generation_call]
|
|
628
656
|
required :type, const: :image_generation_call
|
|
629
657
|
|
|
630
|
-
# @!
|
|
631
|
-
#
|
|
632
|
-
#
|
|
633
|
-
#
|
|
658
|
+
# @!attribute quality
|
|
659
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
660
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
661
|
+
#
|
|
662
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Quality, nil]
|
|
663
|
+
optional(
|
|
664
|
+
:quality,
|
|
665
|
+
enum: -> { OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Quality },
|
|
666
|
+
nil?: true
|
|
667
|
+
)
|
|
668
|
+
|
|
669
|
+
# @!attribute size
|
|
670
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
634
671
|
#
|
|
672
|
+
# @return [String, Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Size, nil]
|
|
673
|
+
optional(
|
|
674
|
+
:size,
|
|
675
|
+
union: -> {
|
|
676
|
+
OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Size
|
|
677
|
+
},
|
|
678
|
+
nil?: true
|
|
679
|
+
)
|
|
680
|
+
|
|
681
|
+
# @!method initialize(id:, result:, status:, quality: nil, size: nil, type: :image_generation_call)
|
|
635
682
|
# An image generation request made by the model.
|
|
636
683
|
#
|
|
637
|
-
# @param id [String]
|
|
684
|
+
# @param id [String]
|
|
685
|
+
# The unique ID of the image generation call.
|
|
638
686
|
#
|
|
639
|
-
# @param result [String, nil]
|
|
687
|
+
# @param result [String, nil]
|
|
688
|
+
# The generated image encoded in base64.
|
|
640
689
|
#
|
|
641
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Status]
|
|
690
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Status]
|
|
691
|
+
# The status of the image generation call.
|
|
642
692
|
#
|
|
643
|
-
# @param
|
|
693
|
+
# @param quality [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Quality, nil]
|
|
694
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
695
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
696
|
+
#
|
|
697
|
+
# @param size [String, Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Size, nil]
|
|
698
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
699
|
+
#
|
|
700
|
+
# @param type [Symbol, :image_generation_call]
|
|
701
|
+
# The type of the image generation call. Always `image_generation_call`.
|
|
644
702
|
|
|
645
703
|
# The status of the image generation call.
|
|
646
704
|
#
|
|
@@ -656,6 +714,62 @@ module OpenAI
|
|
|
656
714
|
# @!method self.values
|
|
657
715
|
# @return [Array<Symbol>]
|
|
658
716
|
end
|
|
717
|
+
|
|
718
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
719
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
720
|
+
#
|
|
721
|
+
# @see OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall#quality
|
|
722
|
+
module Quality
|
|
723
|
+
extend OpenAI::Internal::Type::Enum
|
|
724
|
+
|
|
725
|
+
LOW = :low
|
|
726
|
+
MEDIUM = :medium
|
|
727
|
+
HIGH = :high
|
|
728
|
+
XHIGH = :xhigh
|
|
729
|
+
MAX = :max
|
|
730
|
+
AUTO = :auto
|
|
731
|
+
|
|
732
|
+
# @!method self.values
|
|
733
|
+
# @return [Array<Symbol>]
|
|
734
|
+
end
|
|
735
|
+
|
|
736
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
737
|
+
#
|
|
738
|
+
# @see OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall#size
|
|
739
|
+
module Size
|
|
740
|
+
extend OpenAI::Internal::Type::Union
|
|
741
|
+
|
|
742
|
+
variant String
|
|
743
|
+
|
|
744
|
+
variant(
|
|
745
|
+
const: -> { OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Size::SIZE_1024X1024 }
|
|
746
|
+
)
|
|
747
|
+
|
|
748
|
+
variant(
|
|
749
|
+
const: -> { OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Size::SIZE_1024X1536 }
|
|
750
|
+
)
|
|
751
|
+
|
|
752
|
+
variant(
|
|
753
|
+
const: -> { OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Size::SIZE_1536X1024 }
|
|
754
|
+
)
|
|
755
|
+
|
|
756
|
+
# @!method self.variants
|
|
757
|
+
# @return [Array(String, Symbol)]
|
|
758
|
+
|
|
759
|
+
define_sorbet_constant!(:Variants) do
|
|
760
|
+
T.type_alias {
|
|
761
|
+
T.any(String, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Size::TaggedSymbol)
|
|
762
|
+
}
|
|
763
|
+
end
|
|
764
|
+
|
|
765
|
+
# @!group
|
|
766
|
+
|
|
767
|
+
SIZE_1024X1024 = :"1024x1024"
|
|
768
|
+
SIZE_1024X1536 = :"1024x1536"
|
|
769
|
+
SIZE_1536X1024 = :"1536x1024"
|
|
770
|
+
|
|
771
|
+
# @!endgroup
|
|
772
|
+
end
|
|
659
773
|
end
|
|
660
774
|
|
|
661
775
|
class LocalShellCall < OpenAI::Internal::Type::BaseModel
|
|
@@ -690,20 +804,22 @@ module OpenAI
|
|
|
690
804
|
required :type, const: :local_shell_call
|
|
691
805
|
|
|
692
806
|
# @!method initialize(id:, action:, call_id:, status:, type: :local_shell_call)
|
|
693
|
-
# Some parameter documentations has been truncated, see
|
|
694
|
-
# {OpenAI::Models::Responses::ResponseInputItem::LocalShellCall} for more details.
|
|
695
|
-
#
|
|
696
807
|
# A tool call to run a command on the local shell.
|
|
697
808
|
#
|
|
698
|
-
# @param id [String]
|
|
809
|
+
# @param id [String]
|
|
810
|
+
# The unique ID of the local shell call.
|
|
699
811
|
#
|
|
700
|
-
# @param action [OpenAI::Models::Responses::ResponseInputItem::LocalShellCall::Action]
|
|
812
|
+
# @param action [OpenAI::Models::Responses::ResponseInputItem::LocalShellCall::Action]
|
|
813
|
+
# Execute a shell command on the server.
|
|
701
814
|
#
|
|
702
|
-
# @param call_id [String]
|
|
815
|
+
# @param call_id [String]
|
|
816
|
+
# The unique ID of the local shell tool call generated by the model.
|
|
703
817
|
#
|
|
704
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall::Status]
|
|
818
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall::Status]
|
|
819
|
+
# The status of the local shell call.
|
|
705
820
|
#
|
|
706
|
-
# @param type [Symbol, :local_shell_call]
|
|
821
|
+
# @param type [Symbol, :local_shell_call]
|
|
822
|
+
# The type of the local shell call. Always `local_shell_call`.
|
|
707
823
|
|
|
708
824
|
# @see OpenAI::Models::Responses::ResponseInputItem::LocalShellCall#action
|
|
709
825
|
class Action < OpenAI::Internal::Type::BaseModel
|
|
@@ -746,17 +862,23 @@ module OpenAI
|
|
|
746
862
|
# @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
|
|
747
863
|
# Execute a shell command on the server.
|
|
748
864
|
#
|
|
749
|
-
# @param command [Array<String>]
|
|
865
|
+
# @param command [Array<String>]
|
|
866
|
+
# The command to run.
|
|
750
867
|
#
|
|
751
|
-
# @param env [Hash{Symbol=>String}]
|
|
868
|
+
# @param env [Hash{Symbol=>String}]
|
|
869
|
+
# Environment variables to set for the command.
|
|
752
870
|
#
|
|
753
|
-
# @param timeout_ms [Integer, nil]
|
|
871
|
+
# @param timeout_ms [Integer, nil]
|
|
872
|
+
# Optional timeout in milliseconds for the command.
|
|
754
873
|
#
|
|
755
|
-
# @param user [String, nil]
|
|
874
|
+
# @param user [String, nil]
|
|
875
|
+
# Optional user to run the command as.
|
|
756
876
|
#
|
|
757
|
-
# @param working_directory [String, nil]
|
|
877
|
+
# @param working_directory [String, nil]
|
|
878
|
+
# Optional working directory to run the command in.
|
|
758
879
|
#
|
|
759
|
-
# @param type [Symbol, :exec]
|
|
880
|
+
# @param type [Symbol, :exec]
|
|
881
|
+
# The type of the local shell action. Always `exec`.
|
|
760
882
|
end
|
|
761
883
|
|
|
762
884
|
# The status of the local shell call.
|
|
@@ -804,19 +926,19 @@ module OpenAI
|
|
|
804
926
|
)
|
|
805
927
|
|
|
806
928
|
# @!method initialize(id:, output:, status: nil, type: :local_shell_call_output)
|
|
807
|
-
# Some parameter documentations has been truncated, see
|
|
808
|
-
# {OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput} for more
|
|
809
|
-
# details.
|
|
810
|
-
#
|
|
811
929
|
# The output of a local shell tool call.
|
|
812
930
|
#
|
|
813
|
-
# @param id [String]
|
|
931
|
+
# @param id [String]
|
|
932
|
+
# The unique ID of the local shell tool call generated by the model.
|
|
814
933
|
#
|
|
815
|
-
# @param output [String]
|
|
934
|
+
# @param output [String]
|
|
935
|
+
# A JSON string of the output of the local shell tool call.
|
|
816
936
|
#
|
|
817
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput::Status, nil]
|
|
937
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput::Status, nil]
|
|
938
|
+
# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
818
939
|
#
|
|
819
|
-
# @param type [Symbol, :local_shell_call_output]
|
|
940
|
+
# @param type [Symbol, :local_shell_call_output]
|
|
941
|
+
# The type of the local shell tool call output. Always `local_shell_call_output`.
|
|
820
942
|
|
|
821
943
|
# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
822
944
|
#
|
|
@@ -888,24 +1010,30 @@ module OpenAI
|
|
|
888
1010
|
optional :status, enum: -> { OpenAI::Responses::ResponseInputItem::ShellCall::Status }, nil?: true
|
|
889
1011
|
|
|
890
1012
|
# @!method initialize(action:, call_id:, id: nil, caller_: nil, environment: nil, status: nil, type: :shell_call)
|
|
891
|
-
# Some parameter documentations has been truncated, see
|
|
892
|
-
# {OpenAI::Models::Responses::ResponseInputItem::ShellCall} for more details.
|
|
893
|
-
#
|
|
894
1013
|
# A tool representing a request to execute one or more shell commands.
|
|
895
1014
|
#
|
|
896
|
-
# @param action [OpenAI::Models::Responses::ResponseInputItem::ShellCall::Action]
|
|
1015
|
+
# @param action [OpenAI::Models::Responses::ResponseInputItem::ShellCall::Action]
|
|
1016
|
+
# The shell commands and limits that describe how to run the tool call.
|
|
897
1017
|
#
|
|
898
|
-
# @param call_id [String]
|
|
1018
|
+
# @param call_id [String]
|
|
1019
|
+
# The unique ID of the shell tool call generated by the model.
|
|
899
1020
|
#
|
|
900
|
-
# @param id [String, nil]
|
|
1021
|
+
# @param id [String, nil]
|
|
1022
|
+
# The unique ID of the shell tool call. Populated when this item is returned via
|
|
1023
|
+
# API.
|
|
901
1024
|
#
|
|
902
|
-
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::ShellCall::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::ShellCall::Caller::Program, nil]
|
|
1025
|
+
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::ShellCall::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::ShellCall::Caller::Program, nil]
|
|
1026
|
+
# The execution context that produced this tool call.
|
|
903
1027
|
#
|
|
904
|
-
# @param environment [OpenAI::Models::Responses::LocalEnvironment, OpenAI::Models::Responses::ContainerReference, nil]
|
|
1028
|
+
# @param environment [OpenAI::Models::Responses::LocalEnvironment, OpenAI::Models::Responses::ContainerReference, nil]
|
|
1029
|
+
# The environment to execute the shell commands in.
|
|
905
1030
|
#
|
|
906
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ShellCall::Status, nil]
|
|
1031
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ShellCall::Status, nil]
|
|
1032
|
+
# The status of the shell call. One of `in_progress`, `completed`, or
|
|
1033
|
+
# `incomplete`.
|
|
907
1034
|
#
|
|
908
|
-
# @param type [Symbol, :shell_call]
|
|
1035
|
+
# @param type [Symbol, :shell_call]
|
|
1036
|
+
# The type of the item. Always `shell_call`.
|
|
909
1037
|
|
|
910
1038
|
# @see OpenAI::Models::Responses::ResponseInputItem::ShellCall#action
|
|
911
1039
|
class Action < OpenAI::Internal::Type::BaseModel
|
|
@@ -929,17 +1057,17 @@ module OpenAI
|
|
|
929
1057
|
optional :timeout_ms, Integer, nil?: true
|
|
930
1058
|
|
|
931
1059
|
# @!method initialize(commands:, max_output_length: nil, timeout_ms: nil)
|
|
932
|
-
# Some parameter documentations has been truncated, see
|
|
933
|
-
# {OpenAI::Models::Responses::ResponseInputItem::ShellCall::Action} for more
|
|
934
|
-
# details.
|
|
935
|
-
#
|
|
936
1060
|
# The shell commands and limits that describe how to run the tool call.
|
|
937
1061
|
#
|
|
938
|
-
# @param commands [Array<String>]
|
|
1062
|
+
# @param commands [Array<String>]
|
|
1063
|
+
# Ordered shell commands for the execution environment to run.
|
|
939
1064
|
#
|
|
940
|
-
# @param max_output_length [Integer, nil]
|
|
1065
|
+
# @param max_output_length [Integer, nil]
|
|
1066
|
+
# Maximum number of UTF-8 characters to capture from combined stdout and stderr
|
|
1067
|
+
# output.
|
|
941
1068
|
#
|
|
942
|
-
# @param timeout_ms [Integer, nil]
|
|
1069
|
+
# @param timeout_ms [Integer, nil]
|
|
1070
|
+
# Maximum wall-clock time in milliseconds to allow the shell commands to run.
|
|
943
1071
|
end
|
|
944
1072
|
|
|
945
1073
|
# The execution context that produced this tool call.
|
|
@@ -962,7 +1090,8 @@ module OpenAI
|
|
|
962
1090
|
required :type, const: :direct
|
|
963
1091
|
|
|
964
1092
|
# @!method initialize(type: :direct)
|
|
965
|
-
# @param type [Symbol, :direct]
|
|
1093
|
+
# @param type [Symbol, :direct]
|
|
1094
|
+
# The caller type. Always `direct`.
|
|
966
1095
|
end
|
|
967
1096
|
|
|
968
1097
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -979,9 +1108,11 @@ module OpenAI
|
|
|
979
1108
|
required :type, const: :program
|
|
980
1109
|
|
|
981
1110
|
# @!method initialize(caller_id:, type: :program)
|
|
982
|
-
# @param caller_id [String]
|
|
1111
|
+
# @param caller_id [String]
|
|
1112
|
+
# The call ID of the program item that produced this tool call.
|
|
983
1113
|
#
|
|
984
|
-
# @param type [Symbol, :program]
|
|
1114
|
+
# @param type [Symbol, :program]
|
|
1115
|
+
# The caller type. Always `program`.
|
|
985
1116
|
end
|
|
986
1117
|
|
|
987
1118
|
# @!method self.variants
|
|
@@ -1081,25 +1212,31 @@ module OpenAI
|
|
|
1081
1212
|
)
|
|
1082
1213
|
|
|
1083
1214
|
# @!method initialize(call_id:, output:, id: nil, caller_: nil, max_output_length: nil, status: nil, type: :shell_call_output)
|
|
1084
|
-
# Some parameter documentations has been truncated, see
|
|
1085
|
-
# {OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput} for more
|
|
1086
|
-
# details.
|
|
1087
|
-
#
|
|
1088
1215
|
# The streamed output items emitted by a shell tool call.
|
|
1089
1216
|
#
|
|
1090
|
-
# @param call_id [String]
|
|
1217
|
+
# @param call_id [String]
|
|
1218
|
+
# The unique ID of the shell tool call generated by the model.
|
|
1091
1219
|
#
|
|
1092
|
-
# @param output [Array<OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent>]
|
|
1220
|
+
# @param output [Array<OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent>]
|
|
1221
|
+
# Captured chunks of stdout and stderr output, along with their associated
|
|
1222
|
+
# outcomes.
|
|
1093
1223
|
#
|
|
1094
|
-
# @param id [String, nil]
|
|
1224
|
+
# @param id [String, nil]
|
|
1225
|
+
# The unique ID of the shell tool call output. Populated when this item is
|
|
1226
|
+
# returned via API.
|
|
1095
1227
|
#
|
|
1096
|
-
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput::Caller::Program, nil]
|
|
1228
|
+
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput::Caller::Program, nil]
|
|
1229
|
+
# The execution context that produced this tool call.
|
|
1097
1230
|
#
|
|
1098
|
-
# @param max_output_length [Integer, nil]
|
|
1231
|
+
# @param max_output_length [Integer, nil]
|
|
1232
|
+
# The maximum number of UTF-8 characters captured for this shell call's combined
|
|
1233
|
+
# output.
|
|
1099
1234
|
#
|
|
1100
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput::Status, nil]
|
|
1235
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput::Status, nil]
|
|
1236
|
+
# The status of the shell call output.
|
|
1101
1237
|
#
|
|
1102
|
-
# @param type [Symbol, :shell_call_output]
|
|
1238
|
+
# @param type [Symbol, :shell_call_output]
|
|
1239
|
+
# The type of the item. Always `shell_call_output`.
|
|
1103
1240
|
|
|
1104
1241
|
# The execution context that produced this tool call.
|
|
1105
1242
|
#
|
|
@@ -1121,7 +1258,8 @@ module OpenAI
|
|
|
1121
1258
|
required :type, const: :direct
|
|
1122
1259
|
|
|
1123
1260
|
# @!method initialize(type: :direct)
|
|
1124
|
-
# @param type [Symbol, :direct]
|
|
1261
|
+
# @param type [Symbol, :direct]
|
|
1262
|
+
# The caller type. Always `direct`.
|
|
1125
1263
|
end
|
|
1126
1264
|
|
|
1127
1265
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -1138,9 +1276,11 @@ module OpenAI
|
|
|
1138
1276
|
required :type, const: :program
|
|
1139
1277
|
|
|
1140
1278
|
# @!method initialize(caller_id:, type: :program)
|
|
1141
|
-
# @param caller_id [String]
|
|
1279
|
+
# @param caller_id [String]
|
|
1280
|
+
# The call ID of the program item that produced this tool call.
|
|
1142
1281
|
#
|
|
1143
|
-
# @param type [Symbol, :program]
|
|
1282
|
+
# @param type [Symbol, :program]
|
|
1283
|
+
# The caller type. Always `program`.
|
|
1144
1284
|
end
|
|
1145
1285
|
|
|
1146
1286
|
# @!method self.variants
|
|
@@ -1207,23 +1347,28 @@ module OpenAI
|
|
|
1207
1347
|
)
|
|
1208
1348
|
|
|
1209
1349
|
# @!method initialize(call_id:, operation:, status:, id: nil, caller_: nil, type: :apply_patch_call)
|
|
1210
|
-
# Some parameter documentations has been truncated, see
|
|
1211
|
-
# {OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall} for more details.
|
|
1212
|
-
#
|
|
1213
1350
|
# A tool call representing a request to create, delete, or update files using diff
|
|
1214
1351
|
# patches.
|
|
1215
1352
|
#
|
|
1216
|
-
# @param call_id [String]
|
|
1353
|
+
# @param call_id [String]
|
|
1354
|
+
# The unique ID of the apply patch tool call generated by the model.
|
|
1217
1355
|
#
|
|
1218
|
-
# @param operation [OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Operation::UpdateFile]
|
|
1356
|
+
# @param operation [OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Operation::UpdateFile]
|
|
1357
|
+
# The specific create, delete, or update instruction for the apply_patch tool
|
|
1358
|
+
# call.
|
|
1219
1359
|
#
|
|
1220
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Status]
|
|
1360
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Status]
|
|
1361
|
+
# The status of the apply patch tool call. One of `in_progress` or `completed`.
|
|
1221
1362
|
#
|
|
1222
|
-
# @param id [String, nil]
|
|
1363
|
+
# @param id [String, nil]
|
|
1364
|
+
# The unique ID of the apply patch tool call. Populated when this item is returned
|
|
1365
|
+
# via API.
|
|
1223
1366
|
#
|
|
1224
|
-
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Caller::Program, nil]
|
|
1367
|
+
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::Caller::Program, nil]
|
|
1368
|
+
# The execution context that produced this tool call.
|
|
1225
1369
|
#
|
|
1226
|
-
# @param type [Symbol, :apply_patch_call]
|
|
1370
|
+
# @param type [Symbol, :apply_patch_call]
|
|
1371
|
+
# The type of the item. Always `apply_patch_call`.
|
|
1227
1372
|
|
|
1228
1373
|
# The specific create, delete, or update instruction for the apply_patch tool
|
|
1229
1374
|
# call.
|
|
@@ -1265,11 +1410,14 @@ module OpenAI
|
|
|
1265
1410
|
# @!method initialize(diff:, path:, type: :create_file)
|
|
1266
1411
|
# Instruction for creating a new file via the apply_patch tool.
|
|
1267
1412
|
#
|
|
1268
|
-
# @param diff [String]
|
|
1413
|
+
# @param diff [String]
|
|
1414
|
+
# Unified diff content to apply when creating the file.
|
|
1269
1415
|
#
|
|
1270
|
-
# @param path [String]
|
|
1416
|
+
# @param path [String]
|
|
1417
|
+
# Path of the file to create relative to the workspace root.
|
|
1271
1418
|
#
|
|
1272
|
-
# @param type [Symbol, :create_file]
|
|
1419
|
+
# @param type [Symbol, :create_file]
|
|
1420
|
+
# The operation type. Always `create_file`.
|
|
1273
1421
|
end
|
|
1274
1422
|
|
|
1275
1423
|
class DeleteFile < OpenAI::Internal::Type::BaseModel
|
|
@@ -1288,9 +1436,11 @@ module OpenAI
|
|
|
1288
1436
|
# @!method initialize(path:, type: :delete_file)
|
|
1289
1437
|
# Instruction for deleting an existing file via the apply_patch tool.
|
|
1290
1438
|
#
|
|
1291
|
-
# @param path [String]
|
|
1439
|
+
# @param path [String]
|
|
1440
|
+
# Path of the file to delete relative to the workspace root.
|
|
1292
1441
|
#
|
|
1293
|
-
# @param type [Symbol, :delete_file]
|
|
1442
|
+
# @param type [Symbol, :delete_file]
|
|
1443
|
+
# The operation type. Always `delete_file`.
|
|
1294
1444
|
end
|
|
1295
1445
|
|
|
1296
1446
|
class UpdateFile < OpenAI::Internal::Type::BaseModel
|
|
@@ -1315,11 +1465,14 @@ module OpenAI
|
|
|
1315
1465
|
# @!method initialize(diff:, path:, type: :update_file)
|
|
1316
1466
|
# Instruction for updating an existing file via the apply_patch tool.
|
|
1317
1467
|
#
|
|
1318
|
-
# @param diff [String]
|
|
1468
|
+
# @param diff [String]
|
|
1469
|
+
# Unified diff content to apply to the existing file.
|
|
1319
1470
|
#
|
|
1320
|
-
# @param path [String]
|
|
1471
|
+
# @param path [String]
|
|
1472
|
+
# Path of the file to update relative to the workspace root.
|
|
1321
1473
|
#
|
|
1322
|
-
# @param type [Symbol, :update_file]
|
|
1474
|
+
# @param type [Symbol, :update_file]
|
|
1475
|
+
# The operation type. Always `update_file`.
|
|
1323
1476
|
end
|
|
1324
1477
|
|
|
1325
1478
|
# @!method self.variants
|
|
@@ -1359,7 +1512,8 @@ module OpenAI
|
|
|
1359
1512
|
required :type, const: :direct
|
|
1360
1513
|
|
|
1361
1514
|
# @!method initialize(type: :direct)
|
|
1362
|
-
# @param type [Symbol, :direct]
|
|
1515
|
+
# @param type [Symbol, :direct]
|
|
1516
|
+
# The caller type. Always `direct`.
|
|
1363
1517
|
end
|
|
1364
1518
|
|
|
1365
1519
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -1376,9 +1530,11 @@ module OpenAI
|
|
|
1376
1530
|
required :type, const: :program
|
|
1377
1531
|
|
|
1378
1532
|
# @!method initialize(caller_id:, type: :program)
|
|
1379
|
-
# @param caller_id [String]
|
|
1533
|
+
# @param caller_id [String]
|
|
1534
|
+
# The call ID of the program item that produced this tool call.
|
|
1380
1535
|
#
|
|
1381
|
-
# @param type [Symbol, :program]
|
|
1536
|
+
# @param type [Symbol, :program]
|
|
1537
|
+
# The caller type. Always `program`.
|
|
1382
1538
|
end
|
|
1383
1539
|
|
|
1384
1540
|
# @!method self.variants
|
|
@@ -1431,23 +1587,27 @@ module OpenAI
|
|
|
1431
1587
|
optional :output, String, nil?: true
|
|
1432
1588
|
|
|
1433
1589
|
# @!method initialize(call_id:, status:, id: nil, caller_: nil, output: nil, type: :apply_patch_call_output)
|
|
1434
|
-
# Some parameter documentations has been truncated, see
|
|
1435
|
-
# {OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput} for more
|
|
1436
|
-
# details.
|
|
1437
|
-
#
|
|
1438
1590
|
# The streamed output emitted by an apply patch tool call.
|
|
1439
1591
|
#
|
|
1440
|
-
# @param call_id [String]
|
|
1592
|
+
# @param call_id [String]
|
|
1593
|
+
# The unique ID of the apply patch tool call generated by the model.
|
|
1441
1594
|
#
|
|
1442
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::Status]
|
|
1595
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::Status]
|
|
1596
|
+
# The status of the apply patch tool call output. One of `completed` or `failed`.
|
|
1443
1597
|
#
|
|
1444
|
-
# @param id [String, nil]
|
|
1598
|
+
# @param id [String, nil]
|
|
1599
|
+
# The unique ID of the apply patch tool call output. Populated when this item is
|
|
1600
|
+
# returned via API.
|
|
1445
1601
|
#
|
|
1446
|
-
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::Caller::Program, nil]
|
|
1602
|
+
# @param caller_ [OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::Caller::Program, nil]
|
|
1603
|
+
# The execution context that produced this tool call.
|
|
1447
1604
|
#
|
|
1448
|
-
# @param output [String, nil]
|
|
1605
|
+
# @param output [String, nil]
|
|
1606
|
+
# Optional human-readable log text from the apply patch tool (e.g., patch results
|
|
1607
|
+
# or errors).
|
|
1449
1608
|
#
|
|
1450
|
-
# @param type [Symbol, :apply_patch_call_output]
|
|
1609
|
+
# @param type [Symbol, :apply_patch_call_output]
|
|
1610
|
+
# The type of the item. Always `apply_patch_call_output`.
|
|
1451
1611
|
|
|
1452
1612
|
# The status of the apply patch tool call output. One of `completed` or `failed`.
|
|
1453
1613
|
#
|
|
@@ -1482,7 +1642,8 @@ module OpenAI
|
|
|
1482
1642
|
required :type, const: :direct
|
|
1483
1643
|
|
|
1484
1644
|
# @!method initialize(type: :direct)
|
|
1485
|
-
# @param type [Symbol, :direct]
|
|
1645
|
+
# @param type [Symbol, :direct]
|
|
1646
|
+
# The caller type. Always `direct`.
|
|
1486
1647
|
end
|
|
1487
1648
|
|
|
1488
1649
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -1499,9 +1660,11 @@ module OpenAI
|
|
|
1499
1660
|
required :type, const: :program
|
|
1500
1661
|
|
|
1501
1662
|
# @!method initialize(caller_id:, type: :program)
|
|
1502
|
-
# @param caller_id [String]
|
|
1663
|
+
# @param caller_id [String]
|
|
1664
|
+
# The call ID of the program item that produced this tool call.
|
|
1503
1665
|
#
|
|
1504
|
-
# @param type [Symbol, :program]
|
|
1666
|
+
# @param type [Symbol, :program]
|
|
1667
|
+
# The caller type. Always `program`.
|
|
1505
1668
|
end
|
|
1506
1669
|
|
|
1507
1670
|
# @!method self.variants
|
|
@@ -1544,21 +1707,22 @@ module OpenAI
|
|
|
1544
1707
|
optional :error, String, nil?: true
|
|
1545
1708
|
|
|
1546
1709
|
# @!method initialize(id:, server_label:, tools:, error: nil, type: :mcp_list_tools)
|
|
1547
|
-
# Some parameter documentations has been truncated, see
|
|
1548
|
-
# {OpenAI::Models::Responses::ResponseInputItem::McpListTools} for more details.
|
|
1549
|
-
#
|
|
1550
1710
|
# A list of tools available on an MCP server.
|
|
1551
1711
|
#
|
|
1552
|
-
# @param id [String]
|
|
1712
|
+
# @param id [String]
|
|
1713
|
+
# The unique ID of the list.
|
|
1553
1714
|
#
|
|
1554
|
-
# @param server_label [String]
|
|
1715
|
+
# @param server_label [String]
|
|
1716
|
+
# The label of the MCP server.
|
|
1555
1717
|
#
|
|
1556
|
-
# @param tools [Array<OpenAI::Models::Responses::ResponseInputItem::McpListTools::Tool>]
|
|
1718
|
+
# @param tools [Array<OpenAI::Models::Responses::ResponseInputItem::McpListTools::Tool>]
|
|
1719
|
+
# The tools available on the server.
|
|
1557
1720
|
#
|
|
1558
|
-
# @param error [String, nil]
|
|
1721
|
+
# @param error [String, nil]
|
|
1722
|
+
# Error message if the server could not list tools.
|
|
1559
1723
|
#
|
|
1560
|
-
# @param type [Symbol, :mcp_list_tools]
|
|
1561
|
-
|
|
1724
|
+
# @param type [Symbol, :mcp_list_tools]
|
|
1725
|
+
# The type of the item. Always `mcp_list_tools`.
|
|
1562
1726
|
class Tool < OpenAI::Internal::Type::BaseModel
|
|
1563
1727
|
# @!attribute input_schema
|
|
1564
1728
|
# The JSON schema describing the tool's input.
|
|
@@ -1585,19 +1749,19 @@ module OpenAI
|
|
|
1585
1749
|
optional :description, String, nil?: true
|
|
1586
1750
|
|
|
1587
1751
|
# @!method initialize(input_schema:, name:, annotations: nil, description: nil)
|
|
1588
|
-
# Some parameter documentations has been truncated, see
|
|
1589
|
-
# {OpenAI::Models::Responses::ResponseInputItem::McpListTools::Tool} for more
|
|
1590
|
-
# details.
|
|
1591
|
-
#
|
|
1592
1752
|
# A tool available on an MCP server.
|
|
1593
1753
|
#
|
|
1594
|
-
# @param input_schema [Object]
|
|
1754
|
+
# @param input_schema [Object]
|
|
1755
|
+
# The JSON schema describing the tool's input.
|
|
1595
1756
|
#
|
|
1596
|
-
# @param name [String]
|
|
1757
|
+
# @param name [String]
|
|
1758
|
+
# The name of the tool.
|
|
1597
1759
|
#
|
|
1598
|
-
# @param annotations [Object, nil]
|
|
1760
|
+
# @param annotations [Object, nil]
|
|
1761
|
+
# Additional annotations about the tool.
|
|
1599
1762
|
#
|
|
1600
|
-
# @param description [String, nil]
|
|
1763
|
+
# @param description [String, nil]
|
|
1764
|
+
# The description of the tool.
|
|
1601
1765
|
end
|
|
1602
1766
|
end
|
|
1603
1767
|
|
|
@@ -1633,21 +1797,22 @@ module OpenAI
|
|
|
1633
1797
|
required :type, const: :mcp_approval_request
|
|
1634
1798
|
|
|
1635
1799
|
# @!method initialize(id:, arguments:, name:, server_label:, type: :mcp_approval_request)
|
|
1636
|
-
# Some parameter documentations has been truncated, see
|
|
1637
|
-
# {OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest} for more
|
|
1638
|
-
# details.
|
|
1639
|
-
#
|
|
1640
1800
|
# A request for human approval of a tool invocation.
|
|
1641
1801
|
#
|
|
1642
|
-
# @param id [String]
|
|
1802
|
+
# @param id [String]
|
|
1803
|
+
# The unique ID of the approval request.
|
|
1643
1804
|
#
|
|
1644
|
-
# @param arguments [String]
|
|
1805
|
+
# @param arguments [String]
|
|
1806
|
+
# A JSON string of arguments for the tool.
|
|
1645
1807
|
#
|
|
1646
|
-
# @param name [String]
|
|
1808
|
+
# @param name [String]
|
|
1809
|
+
# The name of the tool to run.
|
|
1647
1810
|
#
|
|
1648
|
-
# @param server_label [String]
|
|
1811
|
+
# @param server_label [String]
|
|
1812
|
+
# The label of the MCP server making the request.
|
|
1649
1813
|
#
|
|
1650
|
-
# @param type [Symbol, :mcp_approval_request]
|
|
1814
|
+
# @param type [Symbol, :mcp_approval_request]
|
|
1815
|
+
# The type of the item. Always `mcp_approval_request`.
|
|
1651
1816
|
end
|
|
1652
1817
|
|
|
1653
1818
|
class McpApprovalResponse < OpenAI::Internal::Type::BaseModel
|
|
@@ -1682,21 +1847,22 @@ module OpenAI
|
|
|
1682
1847
|
optional :reason, String, nil?: true
|
|
1683
1848
|
|
|
1684
1849
|
# @!method initialize(approval_request_id:, approve:, id: nil, reason: nil, type: :mcp_approval_response)
|
|
1685
|
-
# Some parameter documentations has been truncated, see
|
|
1686
|
-
# {OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse} for more
|
|
1687
|
-
# details.
|
|
1688
|
-
#
|
|
1689
1850
|
# A response to an MCP approval request.
|
|
1690
1851
|
#
|
|
1691
|
-
# @param approval_request_id [String]
|
|
1852
|
+
# @param approval_request_id [String]
|
|
1853
|
+
# The ID of the approval request being answered.
|
|
1692
1854
|
#
|
|
1693
|
-
# @param approve [Boolean]
|
|
1855
|
+
# @param approve [Boolean]
|
|
1856
|
+
# Whether the request was approved.
|
|
1694
1857
|
#
|
|
1695
|
-
# @param id [String, nil]
|
|
1858
|
+
# @param id [String, nil]
|
|
1859
|
+
# The unique ID of the approval response
|
|
1696
1860
|
#
|
|
1697
|
-
# @param reason [String, nil]
|
|
1861
|
+
# @param reason [String, nil]
|
|
1862
|
+
# Optional reason for the decision.
|
|
1698
1863
|
#
|
|
1699
|
-
# @param type [Symbol, :mcp_approval_response]
|
|
1864
|
+
# @param type [Symbol, :mcp_approval_response]
|
|
1865
|
+
# The type of the item. Always `mcp_approval_response`.
|
|
1700
1866
|
end
|
|
1701
1867
|
|
|
1702
1868
|
class McpCall < OpenAI::Internal::Type::BaseModel
|
|
@@ -1758,28 +1924,37 @@ module OpenAI
|
|
|
1758
1924
|
optional :status, enum: -> { OpenAI::Responses::ResponseInputItem::McpCall::Status }
|
|
1759
1925
|
|
|
1760
1926
|
# @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
|
|
1761
|
-
# Some parameter documentations has been truncated, see
|
|
1762
|
-
# {OpenAI::Models::Responses::ResponseInputItem::McpCall} for more details.
|
|
1763
|
-
#
|
|
1764
1927
|
# An invocation of a tool on an MCP server.
|
|
1765
1928
|
#
|
|
1766
|
-
# @param id [String]
|
|
1929
|
+
# @param id [String]
|
|
1930
|
+
# The unique ID of the tool call.
|
|
1767
1931
|
#
|
|
1768
|
-
# @param arguments [String]
|
|
1932
|
+
# @param arguments [String]
|
|
1933
|
+
# A JSON string of the arguments passed to the tool.
|
|
1769
1934
|
#
|
|
1770
|
-
# @param name [String]
|
|
1935
|
+
# @param name [String]
|
|
1936
|
+
# The name of the tool that was run.
|
|
1771
1937
|
#
|
|
1772
|
-
# @param server_label [String]
|
|
1938
|
+
# @param server_label [String]
|
|
1939
|
+
# The label of the MCP server running the tool.
|
|
1773
1940
|
#
|
|
1774
|
-
# @param approval_request_id [String, nil]
|
|
1941
|
+
# @param approval_request_id [String, nil]
|
|
1942
|
+
# Unique identifier for the MCP tool call approval request. Include this value in
|
|
1943
|
+
# a subsequent `mcp_approval_response` input to approve or reject the
|
|
1944
|
+
# corresponding tool call.
|
|
1775
1945
|
#
|
|
1776
|
-
# @param error [OpenAI::Models::Responses::McpToolCallError::McpProtocolError, OpenAI::Models::Responses::McpToolCallError::McpToolExecutionError, OpenAI::Models::Responses::McpToolCallError::HTTPError, nil]
|
|
1946
|
+
# @param error [OpenAI::Models::Responses::McpToolCallError::McpProtocolError, OpenAI::Models::Responses::McpToolCallError::McpToolExecutionError, OpenAI::Models::Responses::McpToolCallError::HTTPError, nil]
|
|
1947
|
+
# The error from the tool call, if any.
|
|
1777
1948
|
#
|
|
1778
|
-
# @param output [String, nil]
|
|
1949
|
+
# @param output [String, nil]
|
|
1950
|
+
# The output from the tool call.
|
|
1779
1951
|
#
|
|
1780
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::McpCall::Status]
|
|
1952
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::McpCall::Status]
|
|
1953
|
+
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
|
|
1954
|
+
# `calling`, or `failed`.
|
|
1781
1955
|
#
|
|
1782
|
-
# @param type [Symbol, :mcp_call]
|
|
1956
|
+
# @param type [Symbol, :mcp_call]
|
|
1957
|
+
# The type of the item. Always `mcp_call`.
|
|
1783
1958
|
|
|
1784
1959
|
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
|
|
1785
1960
|
# `calling`, or `failed`.
|
|
@@ -1809,7 +1984,8 @@ module OpenAI
|
|
|
1809
1984
|
# @!method initialize(type: :compaction_trigger)
|
|
1810
1985
|
# Compacts the current context. Must be the final input item.
|
|
1811
1986
|
#
|
|
1812
|
-
# @param type [Symbol, :compaction_trigger]
|
|
1987
|
+
# @param type [Symbol, :compaction_trigger]
|
|
1988
|
+
# The type of the item. Always `compaction_trigger`.
|
|
1813
1989
|
end
|
|
1814
1990
|
|
|
1815
1991
|
class ItemReference < OpenAI::Internal::Type::BaseModel
|
|
@@ -1828,9 +2004,11 @@ module OpenAI
|
|
|
1828
2004
|
# @!method initialize(id:, type: nil)
|
|
1829
2005
|
# An internal identifier for an item to reference.
|
|
1830
2006
|
#
|
|
1831
|
-
# @param id [String]
|
|
2007
|
+
# @param id [String]
|
|
2008
|
+
# The ID of the item to reference.
|
|
1832
2009
|
#
|
|
1833
|
-
# @param type [Symbol, OpenAI::Models::Responses::ResponseInputItem::ItemReference::Type, nil]
|
|
2010
|
+
# @param type [Symbol, OpenAI::Models::Responses::ResponseInputItem::ItemReference::Type, nil]
|
|
2011
|
+
# The type of item to reference. Always `item_reference`.
|
|
1834
2012
|
|
|
1835
2013
|
# The type of item to reference. Always `item_reference`.
|
|
1836
2014
|
#
|
|
@@ -1877,15 +2055,20 @@ module OpenAI
|
|
|
1877
2055
|
required :type, const: :program
|
|
1878
2056
|
|
|
1879
2057
|
# @!method initialize(id:, call_id:, code:, fingerprint:, type: :program)
|
|
1880
|
-
# @param id [String]
|
|
2058
|
+
# @param id [String]
|
|
2059
|
+
# The unique ID of this program item.
|
|
1881
2060
|
#
|
|
1882
|
-
# @param call_id [String]
|
|
2061
|
+
# @param call_id [String]
|
|
2062
|
+
# The stable call ID of the program item.
|
|
1883
2063
|
#
|
|
1884
|
-
# @param code [String]
|
|
2064
|
+
# @param code [String]
|
|
2065
|
+
# The JavaScript source executed by programmatic tool calling.
|
|
1885
2066
|
#
|
|
1886
|
-
# @param fingerprint [String]
|
|
2067
|
+
# @param fingerprint [String]
|
|
2068
|
+
# Opaque program replay fingerprint that must be round-tripped.
|
|
1887
2069
|
#
|
|
1888
|
-
# @param type [Symbol, :program]
|
|
2070
|
+
# @param type [Symbol, :program]
|
|
2071
|
+
# The item type. Always `program`.
|
|
1889
2072
|
end
|
|
1890
2073
|
|
|
1891
2074
|
class ProgramOutput < OpenAI::Internal::Type::BaseModel
|
|
@@ -1920,15 +2103,20 @@ module OpenAI
|
|
|
1920
2103
|
required :type, const: :program_output
|
|
1921
2104
|
|
|
1922
2105
|
# @!method initialize(id:, call_id:, result:, status:, type: :program_output)
|
|
1923
|
-
# @param id [String]
|
|
2106
|
+
# @param id [String]
|
|
2107
|
+
# The unique ID of this program output item.
|
|
1924
2108
|
#
|
|
1925
|
-
# @param call_id [String]
|
|
2109
|
+
# @param call_id [String]
|
|
2110
|
+
# The call ID of the program item.
|
|
1926
2111
|
#
|
|
1927
|
-
# @param result [String]
|
|
2112
|
+
# @param result [String]
|
|
2113
|
+
# The result produced by the program item.
|
|
1928
2114
|
#
|
|
1929
|
-
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput::Status]
|
|
2115
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput::Status]
|
|
2116
|
+
# The terminal status of the program output.
|
|
1930
2117
|
#
|
|
1931
|
-
# @param type [Symbol, :program_output]
|
|
2118
|
+
# @param type [Symbol, :program_output]
|
|
2119
|
+
# The item type. Always `program_output`.
|
|
1932
2120
|
|
|
1933
2121
|
# The terminal status of the program output.
|
|
1934
2122
|
#
|