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::Beta::BetaResponseOutputMessage }
|
|
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::Beta::BetaResponseFileSearchToolCall }
|
|
34
34
|
|
|
35
35
|
# A tool call to a computer use tool. See the
|
|
36
|
-
# [computer use guide](https://
|
|
36
|
+
# [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.
|
|
37
37
|
variant :computer_call, -> { OpenAI::Beta::BetaResponseComputerToolCall }
|
|
38
38
|
|
|
39
39
|
# The output of a computer tool call.
|
|
40
40
|
variant :computer_call_output, -> { OpenAI::Beta::BetaResponseInputItem::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::Beta::BetaResponseFunctionWebSearch }
|
|
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::Beta::BetaResponseFunctionToolCall }
|
|
49
49
|
|
|
50
50
|
# The output of a function tool call.
|
|
@@ -71,10 +71,10 @@ module OpenAI
|
|
|
71
71
|
# A description of the chain of thought used by a reasoning model while generating
|
|
72
72
|
# a response. Be sure to include these items in your `input` to the Responses API
|
|
73
73
|
# for subsequent turns of a conversation if you are manually
|
|
74
|
-
# [managing context](https://
|
|
74
|
+
# [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
75
75
|
variant :reasoning, -> { OpenAI::Beta::BetaResponseReasoningItem }
|
|
76
76
|
|
|
77
|
-
# A compaction item generated by the [`v1/responses/compact` API](https://
|
|
77
|
+
# A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
78
78
|
variant :compaction, -> { OpenAI::Beta::BetaResponseCompactionItemParam }
|
|
79
79
|
|
|
80
80
|
# An image generation request made by the model.
|
|
@@ -163,22 +163,26 @@ module OpenAI
|
|
|
163
163
|
optional :type, enum: -> { OpenAI::Beta::BetaResponseInputItem::Message::Type }
|
|
164
164
|
|
|
165
165
|
# @!method initialize(content:, role:, agent: nil, status: nil, type: nil)
|
|
166
|
-
# Some parameter documentations has been truncated, see
|
|
167
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::Message} for more details.
|
|
168
|
-
#
|
|
169
166
|
# A message input to the model with a role indicating instruction following
|
|
170
167
|
# hierarchy. Instructions given with the `developer` or `system` role take
|
|
171
168
|
# precedence over instructions given with the `user` role.
|
|
172
169
|
#
|
|
173
|
-
# @param content [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>]
|
|
170
|
+
# @param content [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>]
|
|
171
|
+
# A list of one or many input items to the model, containing different content
|
|
172
|
+
# types.
|
|
174
173
|
#
|
|
175
|
-
# @param role [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Role]
|
|
174
|
+
# @param role [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Role]
|
|
175
|
+
# The role of the message input. One of `user`, `system`, or `developer`.
|
|
176
176
|
#
|
|
177
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::Message::Agent, nil]
|
|
177
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::Message::Agent, nil]
|
|
178
|
+
# The agent that produced this item.
|
|
178
179
|
#
|
|
179
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Status]
|
|
180
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Status]
|
|
181
|
+
# The status of item. One of `in_progress`, `completed`, or `incomplete`.
|
|
182
|
+
# Populated when items are returned via API.
|
|
180
183
|
#
|
|
181
|
-
# @param type [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Type]
|
|
184
|
+
# @param type [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Type]
|
|
185
|
+
# The type of the message input. Always set to `message`.
|
|
182
186
|
|
|
183
187
|
# The role of the message input. One of `user`, `system`, or `developer`.
|
|
184
188
|
#
|
|
@@ -205,7 +209,8 @@ module OpenAI
|
|
|
205
209
|
# @!method initialize(agent_name:)
|
|
206
210
|
# The agent that produced this item.
|
|
207
211
|
#
|
|
208
|
-
# @param agent_name [String]
|
|
212
|
+
# @param agent_name [String]
|
|
213
|
+
# The canonical name of the agent that produced this item.
|
|
209
214
|
end
|
|
210
215
|
|
|
211
216
|
# The status of item. One of `in_progress`, `completed`, or `incomplete`.
|
|
@@ -296,26 +301,30 @@ module OpenAI
|
|
|
296
301
|
)
|
|
297
302
|
|
|
298
303
|
# @!method initialize(call_id:, output:, id: nil, acknowledged_safety_checks: nil, agent: nil, status: nil, type: :computer_call_output)
|
|
299
|
-
# Some parameter documentations has been truncated, see
|
|
300
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput} for more
|
|
301
|
-
# details.
|
|
302
|
-
#
|
|
303
304
|
# The output of a computer tool call.
|
|
304
305
|
#
|
|
305
|
-
# @param call_id [String]
|
|
306
|
+
# @param call_id [String]
|
|
307
|
+
# The ID of the computer tool call that produced the output.
|
|
306
308
|
#
|
|
307
|
-
# @param output [OpenAI::Models::Beta::BetaResponseComputerToolCallOutputScreenshot]
|
|
309
|
+
# @param output [OpenAI::Models::Beta::BetaResponseComputerToolCallOutputScreenshot]
|
|
310
|
+
# A computer screenshot image used with the computer use tool.
|
|
308
311
|
#
|
|
309
|
-
# @param id [String, nil]
|
|
312
|
+
# @param id [String, nil]
|
|
313
|
+
# The ID of the computer tool call output.
|
|
310
314
|
#
|
|
311
|
-
# @param acknowledged_safety_checks [Array<OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::AcknowledgedSafetyCheck>, nil]
|
|
315
|
+
# @param acknowledged_safety_checks [Array<OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::AcknowledgedSafetyCheck>, nil]
|
|
316
|
+
# The safety checks reported by the API that have been acknowledged by the
|
|
317
|
+
# developer.
|
|
312
318
|
#
|
|
313
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::Agent, nil]
|
|
319
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::Agent, nil]
|
|
320
|
+
# The agent that produced this item.
|
|
314
321
|
#
|
|
315
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::Status, nil]
|
|
322
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::Status, nil]
|
|
323
|
+
# The status of the message input. One of `in_progress`, `completed`, or
|
|
324
|
+
# `incomplete`. Populated when input items are returned via API.
|
|
316
325
|
#
|
|
317
|
-
# @param type [Symbol, :computer_call_output]
|
|
318
|
-
|
|
326
|
+
# @param type [Symbol, :computer_call_output]
|
|
327
|
+
# The type of the computer tool call output. Always `computer_call_output`.
|
|
319
328
|
class AcknowledgedSafetyCheck < OpenAI::Internal::Type::BaseModel
|
|
320
329
|
# @!attribute id
|
|
321
330
|
# The ID of the pending safety check.
|
|
@@ -338,11 +347,14 @@ module OpenAI
|
|
|
338
347
|
# @!method initialize(id:, code: nil, message: nil)
|
|
339
348
|
# A pending safety check for the computer call.
|
|
340
349
|
#
|
|
341
|
-
# @param id [String]
|
|
350
|
+
# @param id [String]
|
|
351
|
+
# The ID of the pending safety check.
|
|
342
352
|
#
|
|
343
|
-
# @param code [String, nil]
|
|
353
|
+
# @param code [String, nil]
|
|
354
|
+
# The type of the pending safety check.
|
|
344
355
|
#
|
|
345
|
-
# @param message [String, nil]
|
|
356
|
+
# @param message [String, nil]
|
|
357
|
+
# Details about the pending safety check.
|
|
346
358
|
end
|
|
347
359
|
|
|
348
360
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput#agent
|
|
@@ -356,7 +368,8 @@ module OpenAI
|
|
|
356
368
|
# @!method initialize(agent_name:)
|
|
357
369
|
# The agent that produced this item.
|
|
358
370
|
#
|
|
359
|
-
# @param agent_name [String]
|
|
371
|
+
# @param agent_name [String]
|
|
372
|
+
# The canonical name of the agent that produced this item.
|
|
360
373
|
end
|
|
361
374
|
|
|
362
375
|
# The status of the message input. One of `in_progress`, `completed`, or
|
|
@@ -444,29 +457,36 @@ module OpenAI
|
|
|
444
457
|
)
|
|
445
458
|
|
|
446
459
|
# @!method initialize(output:, id: nil, agent: nil, call_id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
|
|
447
|
-
# Some parameter documentations has been truncated, see
|
|
448
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput} for more
|
|
449
|
-
# details.
|
|
450
|
-
#
|
|
451
460
|
# The output of a function tool call.
|
|
452
461
|
#
|
|
453
|
-
# @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>]
|
|
462
|
+
# @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>]
|
|
463
|
+
# Text, image, or file output of the function tool call.
|
|
454
464
|
#
|
|
455
|
-
# @param id [String, nil]
|
|
465
|
+
# @param id [String, nil]
|
|
466
|
+
# The unique ID of the function tool call output. Populated when this item is
|
|
467
|
+
# returned via API.
|
|
456
468
|
#
|
|
457
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Agent, nil]
|
|
469
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Agent, nil]
|
|
470
|
+
# The agent that produced this item.
|
|
458
471
|
#
|
|
459
|
-
# @param call_id [String, nil]
|
|
472
|
+
# @param call_id [String, nil]
|
|
473
|
+
# The unique ID of the function tool call generated by the model.
|
|
460
474
|
#
|
|
461
|
-
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Program, nil]
|
|
475
|
+
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Program, nil]
|
|
476
|
+
# The execution context that produced this tool call.
|
|
462
477
|
#
|
|
463
|
-
# @param name [String, nil]
|
|
478
|
+
# @param name [String, nil]
|
|
479
|
+
# The name of the tool that produced the output.
|
|
464
480
|
#
|
|
465
|
-
# @param namespace [String, nil]
|
|
481
|
+
# @param namespace [String, nil]
|
|
482
|
+
# The namespace of the tool that produced the output.
|
|
466
483
|
#
|
|
467
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Status, nil]
|
|
484
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Status, nil]
|
|
485
|
+
# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
486
|
+
# Populated when items are returned via API.
|
|
468
487
|
#
|
|
469
|
-
# @param type [Symbol, :function_call_output]
|
|
488
|
+
# @param type [Symbol, :function_call_output]
|
|
489
|
+
# The type of the function tool call output. Always `function_call_output`.
|
|
470
490
|
|
|
471
491
|
# Text, image, or file output of the function tool call.
|
|
472
492
|
#
|
|
@@ -495,7 +515,8 @@ module OpenAI
|
|
|
495
515
|
# @!method initialize(agent_name:)
|
|
496
516
|
# The agent that produced this item.
|
|
497
517
|
#
|
|
498
|
-
# @param agent_name [String]
|
|
518
|
+
# @param agent_name [String]
|
|
519
|
+
# The canonical name of the agent that produced this item.
|
|
499
520
|
end
|
|
500
521
|
|
|
501
522
|
# The execution context that produced this tool call.
|
|
@@ -518,7 +539,8 @@ module OpenAI
|
|
|
518
539
|
required :type, const: :direct
|
|
519
540
|
|
|
520
541
|
# @!method initialize(type: :direct)
|
|
521
|
-
# @param type [Symbol, :direct]
|
|
542
|
+
# @param type [Symbol, :direct]
|
|
543
|
+
# The caller type. Always `direct`.
|
|
522
544
|
end
|
|
523
545
|
|
|
524
546
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -535,9 +557,11 @@ module OpenAI
|
|
|
535
557
|
required :type, const: :program
|
|
536
558
|
|
|
537
559
|
# @!method initialize(caller_id:, type: :program)
|
|
538
|
-
# @param caller_id [String]
|
|
560
|
+
# @param caller_id [String]
|
|
561
|
+
# The call ID of the program item that produced this tool call.
|
|
539
562
|
#
|
|
540
|
-
# @param type [Symbol, :program]
|
|
563
|
+
# @param type [Symbol, :program]
|
|
564
|
+
# The caller type. Always `program`.
|
|
541
565
|
end
|
|
542
566
|
|
|
543
567
|
# @!method self.variants
|
|
@@ -603,17 +627,23 @@ module OpenAI
|
|
|
603
627
|
# @!method initialize(author:, content:, recipient:, id: nil, agent: nil, type: :agent_message)
|
|
604
628
|
# A message routed between agents.
|
|
605
629
|
#
|
|
606
|
-
# @param author [String]
|
|
630
|
+
# @param author [String]
|
|
631
|
+
# The sending agent identity.
|
|
607
632
|
#
|
|
608
|
-
# @param content [Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage::Content::EncryptedContent>]
|
|
633
|
+
# @param content [Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage::Content::EncryptedContent>]
|
|
634
|
+
# Plaintext, image, or encrypted content sent between agents.
|
|
609
635
|
#
|
|
610
|
-
# @param recipient [String]
|
|
636
|
+
# @param recipient [String]
|
|
637
|
+
# The destination agent identity.
|
|
611
638
|
#
|
|
612
|
-
# @param id [String, nil]
|
|
639
|
+
# @param id [String, nil]
|
|
640
|
+
# The unique ID of this agent message item.
|
|
613
641
|
#
|
|
614
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage::Agent, nil]
|
|
642
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage::Agent, nil]
|
|
643
|
+
# The agent that produced this item.
|
|
615
644
|
#
|
|
616
|
-
# @param type [Symbol, :agent_message]
|
|
645
|
+
# @param type [Symbol, :agent_message]
|
|
646
|
+
# The item type. Always `agent_message`.
|
|
617
647
|
|
|
618
648
|
# A plaintext, image, or encrypted agent message content part.
|
|
619
649
|
module Content
|
|
@@ -624,7 +654,7 @@ module OpenAI
|
|
|
624
654
|
# A text input to the model.
|
|
625
655
|
variant :input_text, -> { OpenAI::Beta::BetaResponseInputTextContent }
|
|
626
656
|
|
|
627
|
-
# An image input to the model. Learn about [image inputs](https://
|
|
657
|
+
# An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
628
658
|
variant :input_image, -> { OpenAI::Beta::BetaResponseInputImageContent }
|
|
629
659
|
|
|
630
660
|
# Opaque encrypted content that Responses API decrypts inside trusted model execution.
|
|
@@ -650,9 +680,11 @@ module OpenAI
|
|
|
650
680
|
# Opaque encrypted content that Responses API decrypts inside trusted model
|
|
651
681
|
# execution.
|
|
652
682
|
#
|
|
653
|
-
# @param encrypted_content [String]
|
|
683
|
+
# @param encrypted_content [String]
|
|
684
|
+
# Opaque encrypted content.
|
|
654
685
|
#
|
|
655
|
-
# @param type [Symbol, :encrypted_content]
|
|
686
|
+
# @param type [Symbol, :encrypted_content]
|
|
687
|
+
# The type of the input item. Always `encrypted_content`.
|
|
656
688
|
end
|
|
657
689
|
|
|
658
690
|
# @!method self.variants
|
|
@@ -670,7 +702,8 @@ module OpenAI
|
|
|
670
702
|
# @!method initialize(agent_name:)
|
|
671
703
|
# The agent that produced this item.
|
|
672
704
|
#
|
|
673
|
-
# @param agent_name [String]
|
|
705
|
+
# @param agent_name [String]
|
|
706
|
+
# The canonical name of the agent that produced this item.
|
|
674
707
|
end
|
|
675
708
|
end
|
|
676
709
|
|
|
@@ -712,17 +745,23 @@ module OpenAI
|
|
|
712
745
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::MultiAgentCall::Agent }, nil?: true
|
|
713
746
|
|
|
714
747
|
# @!method initialize(action:, arguments:, call_id:, id: nil, agent: nil, type: :multi_agent_call)
|
|
715
|
-
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall::Action]
|
|
748
|
+
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall::Action]
|
|
749
|
+
# The multi-agent action that was executed.
|
|
716
750
|
#
|
|
717
|
-
# @param arguments [String]
|
|
751
|
+
# @param arguments [String]
|
|
752
|
+
# The action arguments as a JSON string.
|
|
718
753
|
#
|
|
719
|
-
# @param call_id [String]
|
|
754
|
+
# @param call_id [String]
|
|
755
|
+
# The unique ID linking this call to its output.
|
|
720
756
|
#
|
|
721
|
-
# @param id [String, nil]
|
|
757
|
+
# @param id [String, nil]
|
|
758
|
+
# The unique ID of this multi-agent call.
|
|
722
759
|
#
|
|
723
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall::Agent, nil]
|
|
760
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall::Agent, nil]
|
|
761
|
+
# The agent that produced this item.
|
|
724
762
|
#
|
|
725
|
-
# @param type [Symbol, :multi_agent_call]
|
|
763
|
+
# @param type [Symbol, :multi_agent_call]
|
|
764
|
+
# The item type. Always `multi_agent_call`.
|
|
726
765
|
|
|
727
766
|
# The multi-agent action that was executed.
|
|
728
767
|
#
|
|
@@ -752,7 +791,8 @@ module OpenAI
|
|
|
752
791
|
# @!method initialize(agent_name:)
|
|
753
792
|
# The agent that produced this item.
|
|
754
793
|
#
|
|
755
|
-
# @param agent_name [String]
|
|
794
|
+
# @param agent_name [String]
|
|
795
|
+
# The canonical name of the agent that produced this item.
|
|
756
796
|
end
|
|
757
797
|
end
|
|
758
798
|
|
|
@@ -797,17 +837,23 @@ module OpenAI
|
|
|
797
837
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::MultiAgentCallOutput::Agent }, nil?: true
|
|
798
838
|
|
|
799
839
|
# @!method initialize(action:, call_id:, output:, id: nil, agent: nil, type: :multi_agent_call_output)
|
|
800
|
-
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Action]
|
|
840
|
+
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Action]
|
|
841
|
+
# The multi-agent action that produced this result.
|
|
801
842
|
#
|
|
802
|
-
# @param call_id [String]
|
|
843
|
+
# @param call_id [String]
|
|
844
|
+
# The unique ID of the multi-agent call.
|
|
803
845
|
#
|
|
804
|
-
# @param output [Array<OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output>]
|
|
846
|
+
# @param output [Array<OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output>]
|
|
847
|
+
# Text output returned by the multi-agent action.
|
|
805
848
|
#
|
|
806
|
-
# @param id [String, nil]
|
|
849
|
+
# @param id [String, nil]
|
|
850
|
+
# The unique ID of this multi-agent call output.
|
|
807
851
|
#
|
|
808
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Agent, nil]
|
|
852
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Agent, nil]
|
|
853
|
+
# The agent that produced this item.
|
|
809
854
|
#
|
|
810
|
-
# @param type [Symbol, :multi_agent_call_output]
|
|
855
|
+
# @param type [Symbol, :multi_agent_call_output]
|
|
856
|
+
# The item type. Always `multi_agent_call_output`.
|
|
811
857
|
|
|
812
858
|
# The multi-agent action that produced this result.
|
|
813
859
|
#
|
|
@@ -853,12 +899,14 @@ module OpenAI
|
|
|
853
899
|
)
|
|
854
900
|
|
|
855
901
|
# @!method initialize(text:, annotations: nil, type: :output_text)
|
|
856
|
-
# @param text [String]
|
|
902
|
+
# @param text [String]
|
|
903
|
+
# The text content.
|
|
857
904
|
#
|
|
858
|
-
# @param annotations [Array<OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::ContainerFileCitation>]
|
|
905
|
+
# @param annotations [Array<OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::ContainerFileCitation>]
|
|
906
|
+
# Citations associated with the text content.
|
|
859
907
|
#
|
|
860
|
-
# @param type [Symbol, :output_text]
|
|
861
|
-
|
|
908
|
+
# @param type [Symbol, :output_text]
|
|
909
|
+
# The content type. Always `output_text`.
|
|
862
910
|
module Annotation
|
|
863
911
|
extend OpenAI::Internal::Type::Union
|
|
864
912
|
|
|
@@ -907,13 +955,17 @@ module OpenAI
|
|
|
907
955
|
required :type, const: :file_citation
|
|
908
956
|
|
|
909
957
|
# @!method initialize(file_id:, filename:, index:, type: :file_citation)
|
|
910
|
-
# @param file_id [String]
|
|
958
|
+
# @param file_id [String]
|
|
959
|
+
# The ID of the file.
|
|
911
960
|
#
|
|
912
|
-
# @param filename [String]
|
|
961
|
+
# @param filename [String]
|
|
962
|
+
# The filename of the file cited.
|
|
913
963
|
#
|
|
914
|
-
# @param index [Integer]
|
|
964
|
+
# @param index [Integer]
|
|
965
|
+
# The index of the file in the list of files.
|
|
915
966
|
#
|
|
916
|
-
# @param type [Symbol, :file_citation]
|
|
967
|
+
# @param type [Symbol, :file_citation]
|
|
968
|
+
# The citation type. Always `file_citation`.
|
|
917
969
|
end
|
|
918
970
|
|
|
919
971
|
class URLCitation < OpenAI::Internal::Type::BaseModel
|
|
@@ -948,15 +1000,20 @@ module OpenAI
|
|
|
948
1000
|
required :url, String
|
|
949
1001
|
|
|
950
1002
|
# @!method initialize(end_index:, start_index:, title:, url:, type: :url_citation)
|
|
951
|
-
# @param end_index [Integer]
|
|
1003
|
+
# @param end_index [Integer]
|
|
1004
|
+
# The index of the last character of the citation in the message.
|
|
952
1005
|
#
|
|
953
|
-
# @param start_index [Integer]
|
|
1006
|
+
# @param start_index [Integer]
|
|
1007
|
+
# The index of the first character of the citation in the message.
|
|
954
1008
|
#
|
|
955
|
-
# @param title [String]
|
|
1009
|
+
# @param title [String]
|
|
1010
|
+
# The title of the cited resource.
|
|
956
1011
|
#
|
|
957
|
-
# @param url [String]
|
|
1012
|
+
# @param url [String]
|
|
1013
|
+
# The URL of the cited resource.
|
|
958
1014
|
#
|
|
959
|
-
# @param type [Symbol, :url_citation]
|
|
1015
|
+
# @param type [Symbol, :url_citation]
|
|
1016
|
+
# The citation type. Always `url_citation`.
|
|
960
1017
|
end
|
|
961
1018
|
|
|
962
1019
|
class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
|
|
@@ -997,17 +1054,23 @@ module OpenAI
|
|
|
997
1054
|
required :type, const: :container_file_citation
|
|
998
1055
|
|
|
999
1056
|
# @!method initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation)
|
|
1000
|
-
# @param container_id [String]
|
|
1057
|
+
# @param container_id [String]
|
|
1058
|
+
# The ID of the container.
|
|
1001
1059
|
#
|
|
1002
|
-
# @param end_index [Integer]
|
|
1060
|
+
# @param end_index [Integer]
|
|
1061
|
+
# The index of the last character of the citation in the message.
|
|
1003
1062
|
#
|
|
1004
|
-
# @param file_id [String]
|
|
1063
|
+
# @param file_id [String]
|
|
1064
|
+
# The ID of the container file.
|
|
1005
1065
|
#
|
|
1006
|
-
# @param filename [String]
|
|
1066
|
+
# @param filename [String]
|
|
1067
|
+
# The filename of the container file cited.
|
|
1007
1068
|
#
|
|
1008
|
-
# @param start_index [Integer]
|
|
1069
|
+
# @param start_index [Integer]
|
|
1070
|
+
# The index of the first character of the citation in the message.
|
|
1009
1071
|
#
|
|
1010
|
-
# @param type [Symbol, :container_file_citation]
|
|
1072
|
+
# @param type [Symbol, :container_file_citation]
|
|
1073
|
+
# The citation type. Always `container_file_citation`.
|
|
1011
1074
|
end
|
|
1012
1075
|
|
|
1013
1076
|
# @!method self.variants
|
|
@@ -1026,7 +1089,8 @@ module OpenAI
|
|
|
1026
1089
|
# @!method initialize(agent_name:)
|
|
1027
1090
|
# The agent that produced this item.
|
|
1028
1091
|
#
|
|
1029
|
-
# @param agent_name [String]
|
|
1092
|
+
# @param agent_name [String]
|
|
1093
|
+
# The canonical name of the agent that produced this item.
|
|
1030
1094
|
end
|
|
1031
1095
|
end
|
|
1032
1096
|
|
|
@@ -1080,19 +1144,26 @@ module OpenAI
|
|
|
1080
1144
|
)
|
|
1081
1145
|
|
|
1082
1146
|
# @!method initialize(arguments:, id: nil, agent: nil, call_id: nil, execution: nil, status: nil, type: :tool_search_call)
|
|
1083
|
-
# @param arguments [Object]
|
|
1147
|
+
# @param arguments [Object]
|
|
1148
|
+
# The arguments supplied to the tool search call.
|
|
1084
1149
|
#
|
|
1085
|
-
# @param id [String, nil]
|
|
1150
|
+
# @param id [String, nil]
|
|
1151
|
+
# The unique ID of this tool search call.
|
|
1086
1152
|
#
|
|
1087
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Agent, nil]
|
|
1153
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Agent, nil]
|
|
1154
|
+
# The agent that produced this item.
|
|
1088
1155
|
#
|
|
1089
|
-
# @param call_id [String, nil]
|
|
1156
|
+
# @param call_id [String, nil]
|
|
1157
|
+
# The unique ID of the tool search call generated by the model.
|
|
1090
1158
|
#
|
|
1091
|
-
# @param execution [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Execution]
|
|
1159
|
+
# @param execution [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Execution]
|
|
1160
|
+
# Whether tool search was executed by the server or by the client.
|
|
1092
1161
|
#
|
|
1093
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Status, nil]
|
|
1162
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Status, nil]
|
|
1163
|
+
# The status of the tool search call.
|
|
1094
1164
|
#
|
|
1095
|
-
# @param type [Symbol, :tool_search_call]
|
|
1165
|
+
# @param type [Symbol, :tool_search_call]
|
|
1166
|
+
# The item type. Always `tool_search_call`.
|
|
1096
1167
|
|
|
1097
1168
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall#agent
|
|
1098
1169
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -1105,7 +1176,8 @@ module OpenAI
|
|
|
1105
1176
|
# @!method initialize(agent_name:)
|
|
1106
1177
|
# The agent that produced this item.
|
|
1107
1178
|
#
|
|
1108
|
-
# @param agent_name [String]
|
|
1179
|
+
# @param agent_name [String]
|
|
1180
|
+
# The canonical name of the agent that produced this item.
|
|
1109
1181
|
end
|
|
1110
1182
|
|
|
1111
1183
|
# Whether tool search was executed by the server or by the client.
|
|
@@ -1168,15 +1240,20 @@ module OpenAI
|
|
|
1168
1240
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::AdditionalTools::Agent }, nil?: true
|
|
1169
1241
|
|
|
1170
1242
|
# @!method initialize(tools:, id: nil, agent: nil, role: :developer, type: :additional_tools)
|
|
1171
|
-
# @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>]
|
|
1243
|
+
# @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>]
|
|
1244
|
+
# A list of additional tools made available at this item.
|
|
1172
1245
|
#
|
|
1173
|
-
# @param id [String, nil]
|
|
1246
|
+
# @param id [String, nil]
|
|
1247
|
+
# The unique ID of this additional tools item.
|
|
1174
1248
|
#
|
|
1175
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools::Agent, nil]
|
|
1249
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools::Agent, nil]
|
|
1250
|
+
# The agent that produced this item.
|
|
1176
1251
|
#
|
|
1177
|
-
# @param role [Symbol, :developer]
|
|
1252
|
+
# @param role [Symbol, :developer]
|
|
1253
|
+
# The role that provided the additional tools. Only `developer` is supported.
|
|
1178
1254
|
#
|
|
1179
|
-
# @param type [Symbol, :additional_tools]
|
|
1255
|
+
# @param type [Symbol, :additional_tools]
|
|
1256
|
+
# The item type. Always `additional_tools`.
|
|
1180
1257
|
|
|
1181
1258
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools#agent
|
|
1182
1259
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -1189,7 +1266,8 @@ module OpenAI
|
|
|
1189
1266
|
# @!method initialize(agent_name:)
|
|
1190
1267
|
# The agent that produced this item.
|
|
1191
1268
|
#
|
|
1192
|
-
# @param agent_name [String]
|
|
1269
|
+
# @param agent_name [String]
|
|
1270
|
+
# The canonical name of the agent that produced this item.
|
|
1193
1271
|
end
|
|
1194
1272
|
end
|
|
1195
1273
|
|
|
@@ -1224,22 +1302,53 @@ module OpenAI
|
|
|
1224
1302
|
# @return [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil]
|
|
1225
1303
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Agent }, nil?: true
|
|
1226
1304
|
|
|
1227
|
-
# @!
|
|
1228
|
-
#
|
|
1229
|
-
#
|
|
1230
|
-
#
|
|
1305
|
+
# @!attribute quality
|
|
1306
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
1307
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
1308
|
+
#
|
|
1309
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Quality, nil]
|
|
1310
|
+
optional(
|
|
1311
|
+
:quality,
|
|
1312
|
+
enum: -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Quality },
|
|
1313
|
+
nil?: true
|
|
1314
|
+
)
|
|
1315
|
+
|
|
1316
|
+
# @!attribute size
|
|
1317
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
1231
1318
|
#
|
|
1319
|
+
# @return [String, Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size, nil]
|
|
1320
|
+
optional(
|
|
1321
|
+
:size,
|
|
1322
|
+
union: -> {
|
|
1323
|
+
OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Size
|
|
1324
|
+
},
|
|
1325
|
+
nil?: true
|
|
1326
|
+
)
|
|
1327
|
+
|
|
1328
|
+
# @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
|
|
1232
1329
|
# An image generation request made by the model.
|
|
1233
1330
|
#
|
|
1234
|
-
# @param id [String]
|
|
1331
|
+
# @param id [String]
|
|
1332
|
+
# The unique ID of the image generation call.
|
|
1333
|
+
#
|
|
1334
|
+
# @param result [String, nil]
|
|
1335
|
+
# The generated image encoded in base64.
|
|
1235
1336
|
#
|
|
1236
|
-
# @param
|
|
1337
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Status]
|
|
1338
|
+
# The status of the image generation call.
|
|
1237
1339
|
#
|
|
1238
|
-
# @param
|
|
1340
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil]
|
|
1341
|
+
# The agent that produced this item.
|
|
1239
1342
|
#
|
|
1240
|
-
# @param
|
|
1343
|
+
# @param quality [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Quality, nil]
|
|
1344
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
1345
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
1241
1346
|
#
|
|
1242
|
-
# @param
|
|
1347
|
+
# @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size, nil]
|
|
1348
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
1349
|
+
#
|
|
1350
|
+
# @param type [Symbol, :image_generation_call]
|
|
1351
|
+
# The type of the image generation call. Always `image_generation_call`.
|
|
1243
1352
|
|
|
1244
1353
|
# The status of the image generation call.
|
|
1245
1354
|
#
|
|
@@ -1267,7 +1376,64 @@ module OpenAI
|
|
|
1267
1376
|
# @!method initialize(agent_name:)
|
|
1268
1377
|
# The agent that produced this item.
|
|
1269
1378
|
#
|
|
1270
|
-
# @param agent_name [String]
|
|
1379
|
+
# @param agent_name [String]
|
|
1380
|
+
# The canonical name of the agent that produced this item.
|
|
1381
|
+
end
|
|
1382
|
+
|
|
1383
|
+
# The quality of the image generated by the image generation tool call. One of
|
|
1384
|
+
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
1385
|
+
#
|
|
1386
|
+
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#quality
|
|
1387
|
+
module Quality
|
|
1388
|
+
extend OpenAI::Internal::Type::Enum
|
|
1389
|
+
|
|
1390
|
+
LOW = :low
|
|
1391
|
+
MEDIUM = :medium
|
|
1392
|
+
HIGH = :high
|
|
1393
|
+
XHIGH = :xhigh
|
|
1394
|
+
MAX = :max
|
|
1395
|
+
AUTO = :auto
|
|
1396
|
+
|
|
1397
|
+
# @!method self.values
|
|
1398
|
+
# @return [Array<Symbol>]
|
|
1399
|
+
end
|
|
1400
|
+
|
|
1401
|
+
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
1402
|
+
#
|
|
1403
|
+
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#size
|
|
1404
|
+
module Size
|
|
1405
|
+
extend OpenAI::Internal::Type::Union
|
|
1406
|
+
|
|
1407
|
+
variant String
|
|
1408
|
+
|
|
1409
|
+
variant(
|
|
1410
|
+
const: -> { OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size::SIZE_1024X1024 }
|
|
1411
|
+
)
|
|
1412
|
+
|
|
1413
|
+
variant(
|
|
1414
|
+
const: -> { OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size::SIZE_1024X1536 }
|
|
1415
|
+
)
|
|
1416
|
+
|
|
1417
|
+
variant(
|
|
1418
|
+
const: -> { OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size::SIZE_1536X1024 }
|
|
1419
|
+
)
|
|
1420
|
+
|
|
1421
|
+
# @!method self.variants
|
|
1422
|
+
# @return [Array(String, Symbol)]
|
|
1423
|
+
|
|
1424
|
+
define_sorbet_constant!(:Variants) do
|
|
1425
|
+
T.type_alias {
|
|
1426
|
+
T.any(String, OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Size::TaggedSymbol)
|
|
1427
|
+
}
|
|
1428
|
+
end
|
|
1429
|
+
|
|
1430
|
+
# @!group
|
|
1431
|
+
|
|
1432
|
+
SIZE_1024X1024 = :"1024x1024"
|
|
1433
|
+
SIZE_1024X1536 = :"1024x1536"
|
|
1434
|
+
SIZE_1536X1024 = :"1536x1024"
|
|
1435
|
+
|
|
1436
|
+
# @!endgroup
|
|
1271
1437
|
end
|
|
1272
1438
|
end
|
|
1273
1439
|
|
|
@@ -1309,22 +1475,25 @@ module OpenAI
|
|
|
1309
1475
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::LocalShellCall::Agent }, nil?: true
|
|
1310
1476
|
|
|
1311
1477
|
# @!method initialize(id:, action:, call_id:, status:, agent: nil, type: :local_shell_call)
|
|
1312
|
-
# Some parameter documentations has been truncated, see
|
|
1313
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall} for more details.
|
|
1314
|
-
#
|
|
1315
1478
|
# A tool call to run a command on the local shell.
|
|
1316
1479
|
#
|
|
1317
|
-
# @param id [String]
|
|
1480
|
+
# @param id [String]
|
|
1481
|
+
# The unique ID of the local shell call.
|
|
1318
1482
|
#
|
|
1319
|
-
# @param action [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Action]
|
|
1483
|
+
# @param action [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Action]
|
|
1484
|
+
# Execute a shell command on the server.
|
|
1320
1485
|
#
|
|
1321
|
-
# @param call_id [String]
|
|
1486
|
+
# @param call_id [String]
|
|
1487
|
+
# The unique ID of the local shell tool call generated by the model.
|
|
1322
1488
|
#
|
|
1323
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Status]
|
|
1489
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Status]
|
|
1490
|
+
# The status of the local shell call.
|
|
1324
1491
|
#
|
|
1325
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Agent, nil]
|
|
1492
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Agent, nil]
|
|
1493
|
+
# The agent that produced this item.
|
|
1326
1494
|
#
|
|
1327
|
-
# @param type [Symbol, :local_shell_call]
|
|
1495
|
+
# @param type [Symbol, :local_shell_call]
|
|
1496
|
+
# The type of the local shell call. Always `local_shell_call`.
|
|
1328
1497
|
|
|
1329
1498
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall#action
|
|
1330
1499
|
class Action < OpenAI::Internal::Type::BaseModel
|
|
@@ -1367,17 +1536,23 @@ module OpenAI
|
|
|
1367
1536
|
# @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
|
|
1368
1537
|
# Execute a shell command on the server.
|
|
1369
1538
|
#
|
|
1370
|
-
# @param command [Array<String>]
|
|
1539
|
+
# @param command [Array<String>]
|
|
1540
|
+
# The command to run.
|
|
1371
1541
|
#
|
|
1372
|
-
# @param env [Hash{Symbol=>String}]
|
|
1542
|
+
# @param env [Hash{Symbol=>String}]
|
|
1543
|
+
# Environment variables to set for the command.
|
|
1373
1544
|
#
|
|
1374
|
-
# @param timeout_ms [Integer, nil]
|
|
1545
|
+
# @param timeout_ms [Integer, nil]
|
|
1546
|
+
# Optional timeout in milliseconds for the command.
|
|
1375
1547
|
#
|
|
1376
|
-
# @param user [String, nil]
|
|
1548
|
+
# @param user [String, nil]
|
|
1549
|
+
# Optional user to run the command as.
|
|
1377
1550
|
#
|
|
1378
|
-
# @param working_directory [String, nil]
|
|
1551
|
+
# @param working_directory [String, nil]
|
|
1552
|
+
# Optional working directory to run the command in.
|
|
1379
1553
|
#
|
|
1380
|
-
# @param type [Symbol, :exec]
|
|
1554
|
+
# @param type [Symbol, :exec]
|
|
1555
|
+
# The type of the local shell action. Always `exec`.
|
|
1381
1556
|
end
|
|
1382
1557
|
|
|
1383
1558
|
# The status of the local shell call.
|
|
@@ -1405,7 +1580,8 @@ module OpenAI
|
|
|
1405
1580
|
# @!method initialize(agent_name:)
|
|
1406
1581
|
# The agent that produced this item.
|
|
1407
1582
|
#
|
|
1408
|
-
# @param agent_name [String]
|
|
1583
|
+
# @param agent_name [String]
|
|
1584
|
+
# The canonical name of the agent that produced this item.
|
|
1409
1585
|
end
|
|
1410
1586
|
end
|
|
1411
1587
|
|
|
@@ -1445,21 +1621,22 @@ module OpenAI
|
|
|
1445
1621
|
)
|
|
1446
1622
|
|
|
1447
1623
|
# @!method initialize(id:, output:, agent: nil, status: nil, type: :local_shell_call_output)
|
|
1448
|
-
# Some parameter documentations has been truncated, see
|
|
1449
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput} for more
|
|
1450
|
-
# details.
|
|
1451
|
-
#
|
|
1452
1624
|
# The output of a local shell tool call.
|
|
1453
1625
|
#
|
|
1454
|
-
# @param id [String]
|
|
1626
|
+
# @param id [String]
|
|
1627
|
+
# The unique ID of the local shell tool call generated by the model.
|
|
1455
1628
|
#
|
|
1456
|
-
# @param output [String]
|
|
1629
|
+
# @param output [String]
|
|
1630
|
+
# A JSON string of the output of the local shell tool call.
|
|
1457
1631
|
#
|
|
1458
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput::Agent, nil]
|
|
1632
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput::Agent, nil]
|
|
1633
|
+
# The agent that produced this item.
|
|
1459
1634
|
#
|
|
1460
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput::Status, nil]
|
|
1635
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput::Status, nil]
|
|
1636
|
+
# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
1461
1637
|
#
|
|
1462
|
-
# @param type [Symbol, :local_shell_call_output]
|
|
1638
|
+
# @param type [Symbol, :local_shell_call_output]
|
|
1639
|
+
# The type of the local shell tool call output. Always `local_shell_call_output`.
|
|
1463
1640
|
|
|
1464
1641
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput#agent
|
|
1465
1642
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -1472,7 +1649,8 @@ module OpenAI
|
|
|
1472
1649
|
# @!method initialize(agent_name:)
|
|
1473
1650
|
# The agent that produced this item.
|
|
1474
1651
|
#
|
|
1475
|
-
# @param agent_name [String]
|
|
1652
|
+
# @param agent_name [String]
|
|
1653
|
+
# The canonical name of the agent that produced this item.
|
|
1476
1654
|
end
|
|
1477
1655
|
|
|
1478
1656
|
# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
@@ -1551,26 +1729,33 @@ module OpenAI
|
|
|
1551
1729
|
optional :status, enum: -> { OpenAI::Beta::BetaResponseInputItem::ShellCall::Status }, nil?: true
|
|
1552
1730
|
|
|
1553
1731
|
# @!method initialize(action:, call_id:, id: nil, agent: nil, caller_: nil, environment: nil, status: nil, type: :shell_call)
|
|
1554
|
-
# Some parameter documentations has been truncated, see
|
|
1555
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::ShellCall} for more details.
|
|
1556
|
-
#
|
|
1557
1732
|
# A tool representing a request to execute one or more shell commands.
|
|
1558
1733
|
#
|
|
1559
|
-
# @param action [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Action]
|
|
1734
|
+
# @param action [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Action]
|
|
1735
|
+
# The shell commands and limits that describe how to run the tool call.
|
|
1560
1736
|
#
|
|
1561
|
-
# @param call_id [String]
|
|
1737
|
+
# @param call_id [String]
|
|
1738
|
+
# The unique ID of the shell tool call generated by the model.
|
|
1562
1739
|
#
|
|
1563
|
-
# @param id [String, nil]
|
|
1740
|
+
# @param id [String, nil]
|
|
1741
|
+
# The unique ID of the shell tool call. Populated when this item is returned via
|
|
1742
|
+
# API.
|
|
1564
1743
|
#
|
|
1565
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Agent, nil]
|
|
1744
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Agent, nil]
|
|
1745
|
+
# The agent that produced this item.
|
|
1566
1746
|
#
|
|
1567
|
-
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Program, nil]
|
|
1747
|
+
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Program, nil]
|
|
1748
|
+
# The execution context that produced this tool call.
|
|
1568
1749
|
#
|
|
1569
|
-
# @param environment [OpenAI::Models::Beta::BetaLocalEnvironment, OpenAI::Models::Beta::BetaContainerReference, nil]
|
|
1750
|
+
# @param environment [OpenAI::Models::Beta::BetaLocalEnvironment, OpenAI::Models::Beta::BetaContainerReference, nil]
|
|
1751
|
+
# The environment to execute the shell commands in.
|
|
1570
1752
|
#
|
|
1571
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Status, nil]
|
|
1753
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Status, nil]
|
|
1754
|
+
# The status of the shell call. One of `in_progress`, `completed`, or
|
|
1755
|
+
# `incomplete`.
|
|
1572
1756
|
#
|
|
1573
|
-
# @param type [Symbol, :shell_call]
|
|
1757
|
+
# @param type [Symbol, :shell_call]
|
|
1758
|
+
# The type of the item. Always `shell_call`.
|
|
1574
1759
|
|
|
1575
1760
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::ShellCall#action
|
|
1576
1761
|
class Action < OpenAI::Internal::Type::BaseModel
|
|
@@ -1594,17 +1779,17 @@ module OpenAI
|
|
|
1594
1779
|
optional :timeout_ms, Integer, nil?: true
|
|
1595
1780
|
|
|
1596
1781
|
# @!method initialize(commands:, max_output_length: nil, timeout_ms: nil)
|
|
1597
|
-
# Some parameter documentations has been truncated, see
|
|
1598
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Action} for more
|
|
1599
|
-
# details.
|
|
1600
|
-
#
|
|
1601
1782
|
# The shell commands and limits that describe how to run the tool call.
|
|
1602
1783
|
#
|
|
1603
|
-
# @param commands [Array<String>]
|
|
1784
|
+
# @param commands [Array<String>]
|
|
1785
|
+
# Ordered shell commands for the execution environment to run.
|
|
1604
1786
|
#
|
|
1605
|
-
# @param max_output_length [Integer, nil]
|
|
1787
|
+
# @param max_output_length [Integer, nil]
|
|
1788
|
+
# Maximum number of UTF-8 characters to capture from combined stdout and stderr
|
|
1789
|
+
# output.
|
|
1606
1790
|
#
|
|
1607
|
-
# @param timeout_ms [Integer, nil]
|
|
1791
|
+
# @param timeout_ms [Integer, nil]
|
|
1792
|
+
# Maximum wall-clock time in milliseconds to allow the shell commands to run.
|
|
1608
1793
|
end
|
|
1609
1794
|
|
|
1610
1795
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::ShellCall#agent
|
|
@@ -1618,7 +1803,8 @@ module OpenAI
|
|
|
1618
1803
|
# @!method initialize(agent_name:)
|
|
1619
1804
|
# The agent that produced this item.
|
|
1620
1805
|
#
|
|
1621
|
-
# @param agent_name [String]
|
|
1806
|
+
# @param agent_name [String]
|
|
1807
|
+
# The canonical name of the agent that produced this item.
|
|
1622
1808
|
end
|
|
1623
1809
|
|
|
1624
1810
|
# The execution context that produced this tool call.
|
|
@@ -1641,7 +1827,8 @@ module OpenAI
|
|
|
1641
1827
|
required :type, const: :direct
|
|
1642
1828
|
|
|
1643
1829
|
# @!method initialize(type: :direct)
|
|
1644
|
-
# @param type [Symbol, :direct]
|
|
1830
|
+
# @param type [Symbol, :direct]
|
|
1831
|
+
# The caller type. Always `direct`.
|
|
1645
1832
|
end
|
|
1646
1833
|
|
|
1647
1834
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -1658,9 +1845,11 @@ module OpenAI
|
|
|
1658
1845
|
required :type, const: :program
|
|
1659
1846
|
|
|
1660
1847
|
# @!method initialize(caller_id:, type: :program)
|
|
1661
|
-
# @param caller_id [String]
|
|
1848
|
+
# @param caller_id [String]
|
|
1849
|
+
# The call ID of the program item that produced this tool call.
|
|
1662
1850
|
#
|
|
1663
|
-
# @param type [Symbol, :program]
|
|
1851
|
+
# @param type [Symbol, :program]
|
|
1852
|
+
# The caller type. Always `program`.
|
|
1664
1853
|
end
|
|
1665
1854
|
|
|
1666
1855
|
# @!method self.variants
|
|
@@ -1766,26 +1955,34 @@ module OpenAI
|
|
|
1766
1955
|
)
|
|
1767
1956
|
|
|
1768
1957
|
# @!method initialize(call_id:, output:, id: nil, agent: nil, caller_: nil, max_output_length: nil, status: nil, type: :shell_call_output)
|
|
1769
|
-
# Some parameter documentations has been truncated, see
|
|
1770
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput} for more details.
|
|
1771
|
-
#
|
|
1772
1958
|
# The streamed output items emitted by a shell tool call.
|
|
1773
1959
|
#
|
|
1774
|
-
# @param call_id [String]
|
|
1960
|
+
# @param call_id [String]
|
|
1961
|
+
# The unique ID of the shell tool call generated by the model.
|
|
1775
1962
|
#
|
|
1776
|
-
# @param output [Array<OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent>]
|
|
1963
|
+
# @param output [Array<OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent>]
|
|
1964
|
+
# Captured chunks of stdout and stderr output, along with their associated
|
|
1965
|
+
# outcomes.
|
|
1777
1966
|
#
|
|
1778
|
-
# @param id [String, nil]
|
|
1967
|
+
# @param id [String, nil]
|
|
1968
|
+
# The unique ID of the shell tool call output. Populated when this item is
|
|
1969
|
+
# returned via API.
|
|
1779
1970
|
#
|
|
1780
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Agent, nil]
|
|
1971
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Agent, nil]
|
|
1972
|
+
# The agent that produced this item.
|
|
1781
1973
|
#
|
|
1782
|
-
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Caller::Program, nil]
|
|
1974
|
+
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Caller::Program, nil]
|
|
1975
|
+
# The execution context that produced this tool call.
|
|
1783
1976
|
#
|
|
1784
|
-
# @param max_output_length [Integer, nil]
|
|
1977
|
+
# @param max_output_length [Integer, nil]
|
|
1978
|
+
# The maximum number of UTF-8 characters captured for this shell call's combined
|
|
1979
|
+
# output.
|
|
1785
1980
|
#
|
|
1786
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Status, nil]
|
|
1981
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Status, nil]
|
|
1982
|
+
# The status of the shell call output.
|
|
1787
1983
|
#
|
|
1788
|
-
# @param type [Symbol, :shell_call_output]
|
|
1984
|
+
# @param type [Symbol, :shell_call_output]
|
|
1985
|
+
# The type of the item. Always `shell_call_output`.
|
|
1789
1986
|
|
|
1790
1987
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput#agent
|
|
1791
1988
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -1798,7 +1995,8 @@ module OpenAI
|
|
|
1798
1995
|
# @!method initialize(agent_name:)
|
|
1799
1996
|
# The agent that produced this item.
|
|
1800
1997
|
#
|
|
1801
|
-
# @param agent_name [String]
|
|
1998
|
+
# @param agent_name [String]
|
|
1999
|
+
# The canonical name of the agent that produced this item.
|
|
1802
2000
|
end
|
|
1803
2001
|
|
|
1804
2002
|
# The execution context that produced this tool call.
|
|
@@ -1821,7 +2019,8 @@ module OpenAI
|
|
|
1821
2019
|
required :type, const: :direct
|
|
1822
2020
|
|
|
1823
2021
|
# @!method initialize(type: :direct)
|
|
1824
|
-
# @param type [Symbol, :direct]
|
|
2022
|
+
# @param type [Symbol, :direct]
|
|
2023
|
+
# The caller type. Always `direct`.
|
|
1825
2024
|
end
|
|
1826
2025
|
|
|
1827
2026
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -1838,9 +2037,11 @@ module OpenAI
|
|
|
1838
2037
|
required :type, const: :program
|
|
1839
2038
|
|
|
1840
2039
|
# @!method initialize(caller_id:, type: :program)
|
|
1841
|
-
# @param caller_id [String]
|
|
2040
|
+
# @param caller_id [String]
|
|
2041
|
+
# The call ID of the program item that produced this tool call.
|
|
1842
2042
|
#
|
|
1843
|
-
# @param type [Symbol, :program]
|
|
2043
|
+
# @param type [Symbol, :program]
|
|
2044
|
+
# The caller type. Always `program`.
|
|
1844
2045
|
end
|
|
1845
2046
|
|
|
1846
2047
|
# @!method self.variants
|
|
@@ -1913,25 +2114,31 @@ module OpenAI
|
|
|
1913
2114
|
)
|
|
1914
2115
|
|
|
1915
2116
|
# @!method initialize(call_id:, operation:, status:, id: nil, agent: nil, caller_: nil, type: :apply_patch_call)
|
|
1916
|
-
# Some parameter documentations has been truncated, see
|
|
1917
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall} for more details.
|
|
1918
|
-
#
|
|
1919
2117
|
# A tool call representing a request to create, delete, or update files using diff
|
|
1920
2118
|
# patches.
|
|
1921
2119
|
#
|
|
1922
|
-
# @param call_id [String]
|
|
2120
|
+
# @param call_id [String]
|
|
2121
|
+
# The unique ID of the apply patch tool call generated by the model.
|
|
1923
2122
|
#
|
|
1924
|
-
# @param operation [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::CreateFile, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::DeleteFile, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::UpdateFile]
|
|
2123
|
+
# @param operation [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::CreateFile, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::DeleteFile, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::UpdateFile]
|
|
2124
|
+
# The specific create, delete, or update instruction for the apply_patch tool
|
|
2125
|
+
# call.
|
|
1925
2126
|
#
|
|
1926
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Status]
|
|
2127
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Status]
|
|
2128
|
+
# The status of the apply patch tool call. One of `in_progress` or `completed`.
|
|
1927
2129
|
#
|
|
1928
|
-
# @param id [String, nil]
|
|
2130
|
+
# @param id [String, nil]
|
|
2131
|
+
# The unique ID of the apply patch tool call. Populated when this item is returned
|
|
2132
|
+
# via API.
|
|
1929
2133
|
#
|
|
1930
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Agent, nil]
|
|
2134
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Agent, nil]
|
|
2135
|
+
# The agent that produced this item.
|
|
1931
2136
|
#
|
|
1932
|
-
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Caller::Program, nil]
|
|
2137
|
+
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Caller::Program, nil]
|
|
2138
|
+
# The execution context that produced this tool call.
|
|
1933
2139
|
#
|
|
1934
|
-
# @param type [Symbol, :apply_patch_call]
|
|
2140
|
+
# @param type [Symbol, :apply_patch_call]
|
|
2141
|
+
# The type of the item. Always `apply_patch_call`.
|
|
1935
2142
|
|
|
1936
2143
|
# The specific create, delete, or update instruction for the apply_patch tool
|
|
1937
2144
|
# call.
|
|
@@ -1973,11 +2180,14 @@ module OpenAI
|
|
|
1973
2180
|
# @!method initialize(diff:, path:, type: :create_file)
|
|
1974
2181
|
# Instruction for creating a new file via the apply_patch tool.
|
|
1975
2182
|
#
|
|
1976
|
-
# @param diff [String]
|
|
2183
|
+
# @param diff [String]
|
|
2184
|
+
# Unified diff content to apply when creating the file.
|
|
1977
2185
|
#
|
|
1978
|
-
# @param path [String]
|
|
2186
|
+
# @param path [String]
|
|
2187
|
+
# Path of the file to create relative to the workspace root.
|
|
1979
2188
|
#
|
|
1980
|
-
# @param type [Symbol, :create_file]
|
|
2189
|
+
# @param type [Symbol, :create_file]
|
|
2190
|
+
# The operation type. Always `create_file`.
|
|
1981
2191
|
end
|
|
1982
2192
|
|
|
1983
2193
|
class DeleteFile < OpenAI::Internal::Type::BaseModel
|
|
@@ -1996,9 +2206,11 @@ module OpenAI
|
|
|
1996
2206
|
# @!method initialize(path:, type: :delete_file)
|
|
1997
2207
|
# Instruction for deleting an existing file via the apply_patch tool.
|
|
1998
2208
|
#
|
|
1999
|
-
# @param path [String]
|
|
2209
|
+
# @param path [String]
|
|
2210
|
+
# Path of the file to delete relative to the workspace root.
|
|
2000
2211
|
#
|
|
2001
|
-
# @param type [Symbol, :delete_file]
|
|
2212
|
+
# @param type [Symbol, :delete_file]
|
|
2213
|
+
# The operation type. Always `delete_file`.
|
|
2002
2214
|
end
|
|
2003
2215
|
|
|
2004
2216
|
class UpdateFile < OpenAI::Internal::Type::BaseModel
|
|
@@ -2023,11 +2235,14 @@ module OpenAI
|
|
|
2023
2235
|
# @!method initialize(diff:, path:, type: :update_file)
|
|
2024
2236
|
# Instruction for updating an existing file via the apply_patch tool.
|
|
2025
2237
|
#
|
|
2026
|
-
# @param diff [String]
|
|
2238
|
+
# @param diff [String]
|
|
2239
|
+
# Unified diff content to apply to the existing file.
|
|
2027
2240
|
#
|
|
2028
|
-
# @param path [String]
|
|
2241
|
+
# @param path [String]
|
|
2242
|
+
# Path of the file to update relative to the workspace root.
|
|
2029
2243
|
#
|
|
2030
|
-
# @param type [Symbol, :update_file]
|
|
2244
|
+
# @param type [Symbol, :update_file]
|
|
2245
|
+
# The operation type. Always `update_file`.
|
|
2031
2246
|
end
|
|
2032
2247
|
|
|
2033
2248
|
# @!method self.variants
|
|
@@ -2058,7 +2273,8 @@ module OpenAI
|
|
|
2058
2273
|
# @!method initialize(agent_name:)
|
|
2059
2274
|
# The agent that produced this item.
|
|
2060
2275
|
#
|
|
2061
|
-
# @param agent_name [String]
|
|
2276
|
+
# @param agent_name [String]
|
|
2277
|
+
# The canonical name of the agent that produced this item.
|
|
2062
2278
|
end
|
|
2063
2279
|
|
|
2064
2280
|
# The execution context that produced this tool call.
|
|
@@ -2081,7 +2297,8 @@ module OpenAI
|
|
|
2081
2297
|
required :type, const: :direct
|
|
2082
2298
|
|
|
2083
2299
|
# @!method initialize(type: :direct)
|
|
2084
|
-
# @param type [Symbol, :direct]
|
|
2300
|
+
# @param type [Symbol, :direct]
|
|
2301
|
+
# The caller type. Always `direct`.
|
|
2085
2302
|
end
|
|
2086
2303
|
|
|
2087
2304
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -2098,9 +2315,11 @@ module OpenAI
|
|
|
2098
2315
|
required :type, const: :program
|
|
2099
2316
|
|
|
2100
2317
|
# @!method initialize(caller_id:, type: :program)
|
|
2101
|
-
# @param caller_id [String]
|
|
2318
|
+
# @param caller_id [String]
|
|
2319
|
+
# The call ID of the program item that produced this tool call.
|
|
2102
2320
|
#
|
|
2103
|
-
# @param type [Symbol, :program]
|
|
2321
|
+
# @param type [Symbol, :program]
|
|
2322
|
+
# The caller type. Always `program`.
|
|
2104
2323
|
end
|
|
2105
2324
|
|
|
2106
2325
|
# @!method self.variants
|
|
@@ -2159,25 +2378,30 @@ module OpenAI
|
|
|
2159
2378
|
optional :output, String, nil?: true
|
|
2160
2379
|
|
|
2161
2380
|
# @!method initialize(call_id:, status:, id: nil, agent: nil, caller_: nil, output: nil, type: :apply_patch_call_output)
|
|
2162
|
-
# Some parameter documentations has been truncated, see
|
|
2163
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput} for more
|
|
2164
|
-
# details.
|
|
2165
|
-
#
|
|
2166
2381
|
# The streamed output emitted by an apply patch tool call.
|
|
2167
2382
|
#
|
|
2168
|
-
# @param call_id [String]
|
|
2383
|
+
# @param call_id [String]
|
|
2384
|
+
# The unique ID of the apply patch tool call generated by the model.
|
|
2169
2385
|
#
|
|
2170
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Status]
|
|
2386
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Status]
|
|
2387
|
+
# The status of the apply patch tool call output. One of `completed` or `failed`.
|
|
2171
2388
|
#
|
|
2172
|
-
# @param id [String, nil]
|
|
2389
|
+
# @param id [String, nil]
|
|
2390
|
+
# The unique ID of the apply patch tool call output. Populated when this item is
|
|
2391
|
+
# returned via API.
|
|
2173
2392
|
#
|
|
2174
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Agent, nil]
|
|
2393
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Agent, nil]
|
|
2394
|
+
# The agent that produced this item.
|
|
2175
2395
|
#
|
|
2176
|
-
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Caller::Program, nil]
|
|
2396
|
+
# @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Caller::Program, nil]
|
|
2397
|
+
# The execution context that produced this tool call.
|
|
2177
2398
|
#
|
|
2178
|
-
# @param output [String, nil]
|
|
2399
|
+
# @param output [String, nil]
|
|
2400
|
+
# Optional human-readable log text from the apply patch tool (e.g., patch results
|
|
2401
|
+
# or errors).
|
|
2179
2402
|
#
|
|
2180
|
-
# @param type [Symbol, :apply_patch_call_output]
|
|
2403
|
+
# @param type [Symbol, :apply_patch_call_output]
|
|
2404
|
+
# The type of the item. Always `apply_patch_call_output`.
|
|
2181
2405
|
|
|
2182
2406
|
# The status of the apply patch tool call output. One of `completed` or `failed`.
|
|
2183
2407
|
#
|
|
@@ -2203,7 +2427,8 @@ module OpenAI
|
|
|
2203
2427
|
# @!method initialize(agent_name:)
|
|
2204
2428
|
# The agent that produced this item.
|
|
2205
2429
|
#
|
|
2206
|
-
# @param agent_name [String]
|
|
2430
|
+
# @param agent_name [String]
|
|
2431
|
+
# The canonical name of the agent that produced this item.
|
|
2207
2432
|
end
|
|
2208
2433
|
|
|
2209
2434
|
# The execution context that produced this tool call.
|
|
@@ -2226,7 +2451,8 @@ module OpenAI
|
|
|
2226
2451
|
required :type, const: :direct
|
|
2227
2452
|
|
|
2228
2453
|
# @!method initialize(type: :direct)
|
|
2229
|
-
# @param type [Symbol, :direct]
|
|
2454
|
+
# @param type [Symbol, :direct]
|
|
2455
|
+
# The caller type. Always `direct`.
|
|
2230
2456
|
end
|
|
2231
2457
|
|
|
2232
2458
|
class Program < OpenAI::Internal::Type::BaseModel
|
|
@@ -2243,9 +2469,11 @@ module OpenAI
|
|
|
2243
2469
|
required :type, const: :program
|
|
2244
2470
|
|
|
2245
2471
|
# @!method initialize(caller_id:, type: :program)
|
|
2246
|
-
# @param caller_id [String]
|
|
2472
|
+
# @param caller_id [String]
|
|
2473
|
+
# The call ID of the program item that produced this tool call.
|
|
2247
2474
|
#
|
|
2248
|
-
# @param type [Symbol, :program]
|
|
2475
|
+
# @param type [Symbol, :program]
|
|
2476
|
+
# The caller type. Always `program`.
|
|
2249
2477
|
end
|
|
2250
2478
|
|
|
2251
2479
|
# @!method self.variants
|
|
@@ -2294,23 +2522,25 @@ module OpenAI
|
|
|
2294
2522
|
optional :error, String, nil?: true
|
|
2295
2523
|
|
|
2296
2524
|
# @!method initialize(id:, server_label:, tools:, agent: nil, error: nil, type: :mcp_list_tools)
|
|
2297
|
-
# Some parameter documentations has been truncated, see
|
|
2298
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::McpListTools} for more details.
|
|
2299
|
-
#
|
|
2300
2525
|
# A list of tools available on an MCP server.
|
|
2301
2526
|
#
|
|
2302
|
-
# @param id [String]
|
|
2527
|
+
# @param id [String]
|
|
2528
|
+
# The unique ID of the list.
|
|
2303
2529
|
#
|
|
2304
|
-
# @param server_label [String]
|
|
2530
|
+
# @param server_label [String]
|
|
2531
|
+
# The label of the MCP server.
|
|
2305
2532
|
#
|
|
2306
|
-
# @param tools [Array<OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Tool>]
|
|
2533
|
+
# @param tools [Array<OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Tool>]
|
|
2534
|
+
# The tools available on the server.
|
|
2307
2535
|
#
|
|
2308
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Agent, nil]
|
|
2536
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Agent, nil]
|
|
2537
|
+
# The agent that produced this item.
|
|
2309
2538
|
#
|
|
2310
|
-
# @param error [String, nil]
|
|
2539
|
+
# @param error [String, nil]
|
|
2540
|
+
# Error message if the server could not list tools.
|
|
2311
2541
|
#
|
|
2312
|
-
# @param type [Symbol, :mcp_list_tools]
|
|
2313
|
-
|
|
2542
|
+
# @param type [Symbol, :mcp_list_tools]
|
|
2543
|
+
# The type of the item. Always `mcp_list_tools`.
|
|
2314
2544
|
class Tool < OpenAI::Internal::Type::BaseModel
|
|
2315
2545
|
# @!attribute input_schema
|
|
2316
2546
|
# The JSON schema describing the tool's input.
|
|
@@ -2337,19 +2567,19 @@ module OpenAI
|
|
|
2337
2567
|
optional :description, String, nil?: true
|
|
2338
2568
|
|
|
2339
2569
|
# @!method initialize(input_schema:, name:, annotations: nil, description: nil)
|
|
2340
|
-
# Some parameter documentations has been truncated, see
|
|
2341
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Tool} for more
|
|
2342
|
-
# details.
|
|
2343
|
-
#
|
|
2344
2570
|
# A tool available on an MCP server.
|
|
2345
2571
|
#
|
|
2346
|
-
# @param input_schema [Object]
|
|
2572
|
+
# @param input_schema [Object]
|
|
2573
|
+
# The JSON schema describing the tool's input.
|
|
2347
2574
|
#
|
|
2348
|
-
# @param name [String]
|
|
2575
|
+
# @param name [String]
|
|
2576
|
+
# The name of the tool.
|
|
2349
2577
|
#
|
|
2350
|
-
# @param annotations [Object, nil]
|
|
2578
|
+
# @param annotations [Object, nil]
|
|
2579
|
+
# Additional annotations about the tool.
|
|
2351
2580
|
#
|
|
2352
|
-
# @param description [String, nil]
|
|
2581
|
+
# @param description [String, nil]
|
|
2582
|
+
# The description of the tool.
|
|
2353
2583
|
end
|
|
2354
2584
|
|
|
2355
2585
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::McpListTools#agent
|
|
@@ -2363,7 +2593,8 @@ module OpenAI
|
|
|
2363
2593
|
# @!method initialize(agent_name:)
|
|
2364
2594
|
# The agent that produced this item.
|
|
2365
2595
|
#
|
|
2366
|
-
# @param agent_name [String]
|
|
2596
|
+
# @param agent_name [String]
|
|
2597
|
+
# The canonical name of the agent that produced this item.
|
|
2367
2598
|
end
|
|
2368
2599
|
end
|
|
2369
2600
|
|
|
@@ -2405,23 +2636,25 @@ module OpenAI
|
|
|
2405
2636
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::McpApprovalRequest::Agent }, nil?: true
|
|
2406
2637
|
|
|
2407
2638
|
# @!method initialize(id:, arguments:, name:, server_label:, agent: nil, type: :mcp_approval_request)
|
|
2408
|
-
# Some parameter documentations has been truncated, see
|
|
2409
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest} for more
|
|
2410
|
-
# details.
|
|
2411
|
-
#
|
|
2412
2639
|
# A request for human approval of a tool invocation.
|
|
2413
2640
|
#
|
|
2414
|
-
# @param id [String]
|
|
2641
|
+
# @param id [String]
|
|
2642
|
+
# The unique ID of the approval request.
|
|
2415
2643
|
#
|
|
2416
|
-
# @param arguments [String]
|
|
2644
|
+
# @param arguments [String]
|
|
2645
|
+
# A JSON string of arguments for the tool.
|
|
2417
2646
|
#
|
|
2418
|
-
# @param name [String]
|
|
2647
|
+
# @param name [String]
|
|
2648
|
+
# The name of the tool to run.
|
|
2419
2649
|
#
|
|
2420
|
-
# @param server_label [String]
|
|
2650
|
+
# @param server_label [String]
|
|
2651
|
+
# The label of the MCP server making the request.
|
|
2421
2652
|
#
|
|
2422
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest::Agent, nil]
|
|
2653
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest::Agent, nil]
|
|
2654
|
+
# The agent that produced this item.
|
|
2423
2655
|
#
|
|
2424
|
-
# @param type [Symbol, :mcp_approval_request]
|
|
2656
|
+
# @param type [Symbol, :mcp_approval_request]
|
|
2657
|
+
# The type of the item. Always `mcp_approval_request`.
|
|
2425
2658
|
|
|
2426
2659
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest#agent
|
|
2427
2660
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -2434,7 +2667,8 @@ module OpenAI
|
|
|
2434
2667
|
# @!method initialize(agent_name:)
|
|
2435
2668
|
# The agent that produced this item.
|
|
2436
2669
|
#
|
|
2437
|
-
# @param agent_name [String]
|
|
2670
|
+
# @param agent_name [String]
|
|
2671
|
+
# The canonical name of the agent that produced this item.
|
|
2438
2672
|
end
|
|
2439
2673
|
end
|
|
2440
2674
|
|
|
@@ -2476,23 +2710,25 @@ module OpenAI
|
|
|
2476
2710
|
optional :reason, String, nil?: true
|
|
2477
2711
|
|
|
2478
2712
|
# @!method initialize(approval_request_id:, approve:, id: nil, agent: nil, reason: nil, type: :mcp_approval_response)
|
|
2479
|
-
# Some parameter documentations has been truncated, see
|
|
2480
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse} for more
|
|
2481
|
-
# details.
|
|
2482
|
-
#
|
|
2483
2713
|
# A response to an MCP approval request.
|
|
2484
2714
|
#
|
|
2485
|
-
# @param approval_request_id [String]
|
|
2715
|
+
# @param approval_request_id [String]
|
|
2716
|
+
# The ID of the approval request being answered.
|
|
2486
2717
|
#
|
|
2487
|
-
# @param approve [Boolean]
|
|
2718
|
+
# @param approve [Boolean]
|
|
2719
|
+
# Whether the request was approved.
|
|
2488
2720
|
#
|
|
2489
|
-
# @param id [String, nil]
|
|
2721
|
+
# @param id [String, nil]
|
|
2722
|
+
# The unique ID of the approval response
|
|
2490
2723
|
#
|
|
2491
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse::Agent, nil]
|
|
2724
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse::Agent, nil]
|
|
2725
|
+
# The agent that produced this item.
|
|
2492
2726
|
#
|
|
2493
|
-
# @param reason [String, nil]
|
|
2727
|
+
# @param reason [String, nil]
|
|
2728
|
+
# Optional reason for the decision.
|
|
2494
2729
|
#
|
|
2495
|
-
# @param type [Symbol, :mcp_approval_response]
|
|
2730
|
+
# @param type [Symbol, :mcp_approval_response]
|
|
2731
|
+
# The type of the item. Always `mcp_approval_response`.
|
|
2496
2732
|
|
|
2497
2733
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse#agent
|
|
2498
2734
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -2505,7 +2741,8 @@ module OpenAI
|
|
|
2505
2741
|
# @!method initialize(agent_name:)
|
|
2506
2742
|
# The agent that produced this item.
|
|
2507
2743
|
#
|
|
2508
|
-
# @param agent_name [String]
|
|
2744
|
+
# @param agent_name [String]
|
|
2745
|
+
# The canonical name of the agent that produced this item.
|
|
2509
2746
|
end
|
|
2510
2747
|
end
|
|
2511
2748
|
|
|
@@ -2574,30 +2811,40 @@ module OpenAI
|
|
|
2574
2811
|
optional :status, enum: -> { OpenAI::Beta::BetaResponseInputItem::McpCall::Status }
|
|
2575
2812
|
|
|
2576
2813
|
# @!method initialize(id:, arguments:, name:, server_label:, agent: nil, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
|
|
2577
|
-
# Some parameter documentations has been truncated, see
|
|
2578
|
-
# {OpenAI::Models::Beta::BetaResponseInputItem::McpCall} for more details.
|
|
2579
|
-
#
|
|
2580
2814
|
# An invocation of a tool on an MCP server.
|
|
2581
2815
|
#
|
|
2582
|
-
# @param id [String]
|
|
2816
|
+
# @param id [String]
|
|
2817
|
+
# The unique ID of the tool call.
|
|
2583
2818
|
#
|
|
2584
|
-
# @param arguments [String]
|
|
2819
|
+
# @param arguments [String]
|
|
2820
|
+
# A JSON string of the arguments passed to the tool.
|
|
2585
2821
|
#
|
|
2586
|
-
# @param name [String]
|
|
2822
|
+
# @param name [String]
|
|
2823
|
+
# The name of the tool that was run.
|
|
2587
2824
|
#
|
|
2588
|
-
# @param server_label [String]
|
|
2825
|
+
# @param server_label [String]
|
|
2826
|
+
# The label of the MCP server running the tool.
|
|
2589
2827
|
#
|
|
2590
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpCall::Agent, nil]
|
|
2828
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpCall::Agent, nil]
|
|
2829
|
+
# The agent that produced this item.
|
|
2591
2830
|
#
|
|
2592
|
-
# @param approval_request_id [String, nil]
|
|
2831
|
+
# @param approval_request_id [String, nil]
|
|
2832
|
+
# Unique identifier for the MCP tool call approval request. Include this value in
|
|
2833
|
+
# a subsequent `mcp_approval_response` input to approve or reject the
|
|
2834
|
+
# corresponding tool call.
|
|
2593
2835
|
#
|
|
2594
|
-
# @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil]
|
|
2836
|
+
# @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil]
|
|
2837
|
+
# The error from the tool call, if any.
|
|
2595
2838
|
#
|
|
2596
|
-
# @param output [String, nil]
|
|
2839
|
+
# @param output [String, nil]
|
|
2840
|
+
# The output from the tool call.
|
|
2597
2841
|
#
|
|
2598
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::McpCall::Status]
|
|
2842
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::McpCall::Status]
|
|
2843
|
+
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
|
|
2844
|
+
# `calling`, or `failed`.
|
|
2599
2845
|
#
|
|
2600
|
-
# @param type [Symbol, :mcp_call]
|
|
2846
|
+
# @param type [Symbol, :mcp_call]
|
|
2847
|
+
# The type of the item. Always `mcp_call`.
|
|
2601
2848
|
|
|
2602
2849
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::McpCall#agent
|
|
2603
2850
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -2610,7 +2857,8 @@ module OpenAI
|
|
|
2610
2857
|
# @!method initialize(agent_name:)
|
|
2611
2858
|
# The agent that produced this item.
|
|
2612
2859
|
#
|
|
2613
|
-
# @param agent_name [String]
|
|
2860
|
+
# @param agent_name [String]
|
|
2861
|
+
# The canonical name of the agent that produced this item.
|
|
2614
2862
|
end
|
|
2615
2863
|
|
|
2616
2864
|
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
|
|
@@ -2647,9 +2895,11 @@ module OpenAI
|
|
|
2647
2895
|
# @!method initialize(agent: nil, type: :compaction_trigger)
|
|
2648
2896
|
# Compacts the current context. Must be the final input item.
|
|
2649
2897
|
#
|
|
2650
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger::Agent, nil]
|
|
2898
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger::Agent, nil]
|
|
2899
|
+
# The agent that produced this item.
|
|
2651
2900
|
#
|
|
2652
|
-
# @param type [Symbol, :compaction_trigger]
|
|
2901
|
+
# @param type [Symbol, :compaction_trigger]
|
|
2902
|
+
# The type of the item. Always `compaction_trigger`.
|
|
2653
2903
|
|
|
2654
2904
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger#agent
|
|
2655
2905
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -2662,7 +2912,8 @@ module OpenAI
|
|
|
2662
2912
|
# @!method initialize(agent_name:)
|
|
2663
2913
|
# The agent that produced this item.
|
|
2664
2914
|
#
|
|
2665
|
-
# @param agent_name [String]
|
|
2915
|
+
# @param agent_name [String]
|
|
2916
|
+
# The canonical name of the agent that produced this item.
|
|
2666
2917
|
end
|
|
2667
2918
|
end
|
|
2668
2919
|
|
|
@@ -2688,11 +2939,14 @@ module OpenAI
|
|
|
2688
2939
|
# @!method initialize(id:, agent: nil, type: nil)
|
|
2689
2940
|
# An internal identifier for an item to reference.
|
|
2690
2941
|
#
|
|
2691
|
-
# @param id [String]
|
|
2942
|
+
# @param id [String]
|
|
2943
|
+
# The ID of the item to reference.
|
|
2692
2944
|
#
|
|
2693
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ItemReference::Agent, nil]
|
|
2945
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ItemReference::Agent, nil]
|
|
2946
|
+
# The agent that produced this item.
|
|
2694
2947
|
#
|
|
2695
|
-
# @param type [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference::Type, nil]
|
|
2948
|
+
# @param type [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference::Type, nil]
|
|
2949
|
+
# The type of item to reference. Always `item_reference`.
|
|
2696
2950
|
|
|
2697
2951
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::ItemReference#agent
|
|
2698
2952
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -2705,7 +2959,8 @@ module OpenAI
|
|
|
2705
2959
|
# @!method initialize(agent_name:)
|
|
2706
2960
|
# The agent that produced this item.
|
|
2707
2961
|
#
|
|
2708
|
-
# @param agent_name [String]
|
|
2962
|
+
# @param agent_name [String]
|
|
2963
|
+
# The canonical name of the agent that produced this item.
|
|
2709
2964
|
end
|
|
2710
2965
|
|
|
2711
2966
|
# The type of item to reference. Always `item_reference`.
|
|
@@ -2759,17 +3014,23 @@ module OpenAI
|
|
|
2759
3014
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::Program::Agent }, nil?: true
|
|
2760
3015
|
|
|
2761
3016
|
# @!method initialize(id:, call_id:, code:, fingerprint:, agent: nil, type: :program)
|
|
2762
|
-
# @param id [String]
|
|
3017
|
+
# @param id [String]
|
|
3018
|
+
# The unique ID of this program item.
|
|
2763
3019
|
#
|
|
2764
|
-
# @param call_id [String]
|
|
3020
|
+
# @param call_id [String]
|
|
3021
|
+
# The stable call ID of the program item.
|
|
2765
3022
|
#
|
|
2766
|
-
# @param code [String]
|
|
3023
|
+
# @param code [String]
|
|
3024
|
+
# The JavaScript source executed by programmatic tool calling.
|
|
2767
3025
|
#
|
|
2768
|
-
# @param fingerprint [String]
|
|
3026
|
+
# @param fingerprint [String]
|
|
3027
|
+
# Opaque program replay fingerprint that must be round-tripped.
|
|
2769
3028
|
#
|
|
2770
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::Program::Agent, nil]
|
|
3029
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::Program::Agent, nil]
|
|
3030
|
+
# The agent that produced this item.
|
|
2771
3031
|
#
|
|
2772
|
-
# @param type [Symbol, :program]
|
|
3032
|
+
# @param type [Symbol, :program]
|
|
3033
|
+
# The item type. Always `program`.
|
|
2773
3034
|
|
|
2774
3035
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::Program#agent
|
|
2775
3036
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
@@ -2782,7 +3043,8 @@ module OpenAI
|
|
|
2782
3043
|
# @!method initialize(agent_name:)
|
|
2783
3044
|
# The agent that produced this item.
|
|
2784
3045
|
#
|
|
2785
|
-
# @param agent_name [String]
|
|
3046
|
+
# @param agent_name [String]
|
|
3047
|
+
# The canonical name of the agent that produced this item.
|
|
2786
3048
|
end
|
|
2787
3049
|
end
|
|
2788
3050
|
|
|
@@ -2824,17 +3086,23 @@ module OpenAI
|
|
|
2824
3086
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::ProgramOutput::Agent }, nil?: true
|
|
2825
3087
|
|
|
2826
3088
|
# @!method initialize(id:, call_id:, result:, status:, agent: nil, type: :program_output)
|
|
2827
|
-
# @param id [String]
|
|
3089
|
+
# @param id [String]
|
|
3090
|
+
# The unique ID of this program output item.
|
|
2828
3091
|
#
|
|
2829
|
-
# @param call_id [String]
|
|
3092
|
+
# @param call_id [String]
|
|
3093
|
+
# The call ID of the program item.
|
|
2830
3094
|
#
|
|
2831
|
-
# @param result [String]
|
|
3095
|
+
# @param result [String]
|
|
3096
|
+
# The result produced by the program item.
|
|
2832
3097
|
#
|
|
2833
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput::Status]
|
|
3098
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput::Status]
|
|
3099
|
+
# The terminal status of the program output.
|
|
2834
3100
|
#
|
|
2835
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput::Agent, nil]
|
|
3101
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput::Agent, nil]
|
|
3102
|
+
# The agent that produced this item.
|
|
2836
3103
|
#
|
|
2837
|
-
# @param type [Symbol, :program_output]
|
|
3104
|
+
# @param type [Symbol, :program_output]
|
|
3105
|
+
# The item type. Always `program_output`.
|
|
2838
3106
|
|
|
2839
3107
|
# The terminal status of the program output.
|
|
2840
3108
|
#
|
|
@@ -2860,7 +3128,8 @@ module OpenAI
|
|
|
2860
3128
|
# @!method initialize(agent_name:)
|
|
2861
3129
|
# The agent that produced this item.
|
|
2862
3130
|
#
|
|
2863
|
-
# @param agent_name [String]
|
|
3131
|
+
# @param agent_name [String]
|
|
3132
|
+
# The canonical name of the agent that produced this item.
|
|
2864
3133
|
end
|
|
2865
3134
|
end
|
|
2866
3135
|
|