openai 0.87.0 → 0.89.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 +19 -0
- data/README.md +1 -1
- data/lib/openai/client.rb +4 -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 +570 -294
- 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 +340 -153
- 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 +338 -158
- 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 +399 -163
- 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 +170 -95
- 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 +380 -150
- 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 +228 -103
- 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 +29 -20
- data/lib/openai/models/image_edit_params.rb +108 -31
- data/lib/openai/models/image_edit_partial_image_event.rb +16 -11
- data/lib/openai/models/image_gen_completed_event.rb +29 -20
- data/lib/openai/models/image_gen_partial_image_event.rb +16 -11
- data/lib/openai/models/image_generate_params.rb +92 -29
- data/lib/openai/models/image_input_reference_param.rb +2 -1
- data/lib/openai/models/images_response.rb +34 -19
- data/lib/openai/models/live/audio_format.rb +109 -0
- data/lib/openai/models/live/built_in_voice.rb +38 -0
- data/lib/openai/models/live/client_config.rb +22 -0
- data/lib/openai/models/live/client_delegation.rb +22 -0
- data/lib/openai/models/live/client_event.rb +54 -0
- data/lib/openai/models/live/commentary_append_event.rb +59 -0
- data/lib/openai/models/live/commentary_appended_event.rb +65 -0
- data/lib/openai/models/live/custom_voice.rb +17 -0
- data/lib/openai/models/live/data_channel_config.rb +81 -0
- data/lib/openai/models/live/delegation_created_event.rb +140 -0
- data/lib/openai/models/live/error.rb +60 -0
- data/lib/openai/models/live/error_event.rb +52 -0
- data/lib/openai/models/live/fork_client_event.rb +53 -0
- data/lib/openai/models/live/fork_server_event.rb +295 -0
- data/lib/openai/models/live/fork_session_config.rb +107 -0
- data/lib/openai/models/live/fork_session_start_event.rb +48 -0
- data/lib/openai/models/live/function_tool.rb +60 -0
- data/lib/openai/models/live/info_event.rb +60 -0
- data/lib/openai/models/live/initial_item.rb +419 -0
- data/lib/openai/models/live/input_audio_append_event.rb +50 -0
- data/lib/openai/models/live/input_audio_mute_event.rb +33 -0
- data/lib/openai/models/live/input_audio_muted_event.rb +42 -0
- data/lib/openai/models/live/input_audio_unmute_event.rb +33 -0
- data/lib/openai/models/live/input_audio_unmuted_event.rb +42 -0
- data/lib/openai/models/live/input_transcript_delta_event.rb +76 -0
- data/lib/openai/models/live/instructions_append_event.rb +57 -0
- data/lib/openai/models/live/instructions_appended_event.rb +65 -0
- data/lib/openai/models/live/live_create_params.rb +57 -0
- data/lib/openai/models/live/live_create_response.rb +77 -0
- data/lib/openai/models/live/media_session_config.rb +227 -0
- data/lib/openai/models/live/media_session_fork_config.rb +75 -0
- data/lib/openai/models/live/output_audio_delta_event.rb +58 -0
- data/lib/openai/models/live/output_transcript_delta_event.rb +76 -0
- data/lib/openai/models/live/response_create_event.rb +33 -0
- data/lib/openai/models/live/response_event.rb +67 -0
- data/lib/openai/models/live/response_item_create_event.rb +44 -0
- data/lib/openai/models/live/responses_delegation_config.rb +332 -0
- data/lib/openai/models/live/responses_delegation_update_config.rb +332 -0
- data/lib/openai/models/live/server_event.rb +295 -0
- data/lib/openai/models/live/server_event_selector.rb +32 -0
- data/lib/openai/models/live/session_accept_params.rb +257 -0
- data/lib/openai/models/live/session_close_event.rb +33 -0
- data/lib/openai/models/live/session_closed_event.rb +113 -0
- data/lib/openai/models/live/session_config.rb +236 -0
- data/lib/openai/models/live/session_download_recording_params.rb +27 -0
- data/lib/openai/models/live/session_fork_params.rb +66 -0
- data/lib/openai/models/live/session_fork_response.rb +77 -0
- data/lib/openai/models/live/session_hangup_params.rb +22 -0
- data/lib/openai/models/live/session_refer_params.rb +34 -0
- data/lib/openai/models/live/session_reject_params.rb +32 -0
- data/lib/openai/models/live/session_resource.rb +268 -0
- data/lib/openai/models/live/session_start_event.rb +46 -0
- data/lib/openai/models/live/session_started_event.rb +51 -0
- data/lib/openai/models/live/session_update_config.rb +69 -0
- data/lib/openai/models/live/session_update_event.rb +46 -0
- data/lib/openai/models/live/session_updated_event.rb +51 -0
- data/lib/openai/models/live/session_usage.rb +24 -0
- data/lib/openai/models/live/session_usage_updated_event.rb +81 -0
- data/lib/openai/models/live/thinking_append_event.rb +59 -0
- data/lib/openai/models/live/thinking_appended_event.rb +65 -0
- 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 +332 -131
- 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 +407 -212
- 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 +229 -96
- 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 +227 -101
- 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 +351 -141
- 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 +170 -95
- 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 +34 -26
- data/lib/openai/models/webhooks/live_transport_incoming_webhook_event.rb +137 -0
- data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb +29 -25
- 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/models/webhooks/unwrap_webhook_event.rb +9 -2
- data/lib/openai/models.rb +2 -0
- 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 +421 -127
- data/lib/openai/resources/live/forks.rb +16 -0
- data/lib/openai/resources/live/sessions.rb +180 -0
- data/lib/openai/resources/live/sideband.rb +16 -0
- data/lib/openai/resources/live.rb +54 -0
- 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/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +65 -0
- data/rbi/openai/client.rbi +3 -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 +109 -0
- data/rbi/openai/models/beta/beta_response_item.rbi +105 -0
- data/rbi/openai/models/beta/beta_response_output_item.rbi +119 -0
- 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 +94 -86
- data/rbi/openai/models/beta/beta_tool.rbi +4 -4
- 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 +92 -84
- 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 +134 -1
- 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_params.rbi +2 -2
- data/rbi/openai/models/image_generate_params.rbi +2 -2
- data/rbi/openai/models/live/audio_format.rbi +185 -0
- data/rbi/openai/models/live/built_in_voice.rbi +46 -0
- data/rbi/openai/models/live/client_config.rbi +54 -0
- data/rbi/openai/models/live/client_delegation.rbi +51 -0
- data/rbi/openai/models/live/client_event.rbi +41 -0
- data/rbi/openai/models/live/commentary_append_event.rbi +88 -0
- data/rbi/openai/models/live/commentary_appended_event.rbi +97 -0
- data/rbi/openai/models/live/custom_voice.rbi +46 -0
- data/rbi/openai/models/live/data_channel_config.rbi +119 -0
- data/rbi/openai/models/live/delegation_created_event.rbi +207 -0
- data/rbi/openai/models/live/error.rbi +95 -0
- data/rbi/openai/models/live/error_event.rbi +87 -0
- data/rbi/openai/models/live/fork_client_event.rbi +40 -0
- data/rbi/openai/models/live/fork_server_event.rbi +436 -0
- data/rbi/openai/models/live/fork_session_config.rbi +234 -0
- data/rbi/openai/models/live/fork_session_start_event.rbi +80 -0
- data/rbi/openai/models/live/function_tool.rbi +95 -0
- data/rbi/openai/models/live/info_event.rbi +92 -0
- data/rbi/openai/models/live/initial_item.rbi +661 -0
- data/rbi/openai/models/live/input_audio_append_event.rbi +79 -0
- data/rbi/openai/models/live/input_audio_mute_event.rbi +62 -0
- data/rbi/openai/models/live/input_audio_muted_event.rbi +74 -0
- data/rbi/openai/models/live/input_audio_unmute_event.rbi +62 -0
- data/rbi/openai/models/live/input_audio_unmuted_event.rbi +74 -0
- data/rbi/openai/models/live/input_transcript_delta_event.rbi +115 -0
- data/rbi/openai/models/live/instructions_append_event.rbi +86 -0
- data/rbi/openai/models/live/instructions_appended_event.rbi +97 -0
- data/rbi/openai/models/live/live_create_params.rbi +121 -0
- data/rbi/openai/models/live/live_create_response.rbi +160 -0
- data/rbi/openai/models/live/media_session_config.rbi +390 -0
- data/rbi/openai/models/live/media_session_fork_config.rbi +143 -0
- data/rbi/openai/models/live/output_audio_delta_event.rbi +93 -0
- data/rbi/openai/models/live/output_transcript_delta_event.rbi +115 -0
- data/rbi/openai/models/live/response_create_event.rbi +62 -0
- data/rbi/openai/models/live/response_event.rbi +105 -0
- data/rbi/openai/models/live/response_item_create_event.rbi +183 -0
- data/rbi/openai/models/live/responses_delegation_config.rbi +562 -0
- data/rbi/openai/models/live/responses_delegation_update_config.rbi +585 -0
- data/rbi/openai/models/live/server_event.rbi +436 -0
- data/rbi/openai/models/live/server_event_selector.rbi +64 -0
- data/rbi/openai/models/live/session_accept_params.rbi +451 -0
- data/rbi/openai/models/live/session_close_event.rbi +62 -0
- data/rbi/openai/models/live/session_closed_event.rbi +148 -0
- data/rbi/openai/models/live/session_config.rbi +427 -0
- data/rbi/openai/models/live/session_download_recording_params.rbi +57 -0
- data/rbi/openai/models/live/session_fork_params.rbi +131 -0
- data/rbi/openai/models/live/session_fork_response.rbi +160 -0
- data/rbi/openai/models/live/session_hangup_params.rbi +53 -0
- data/rbi/openai/models/live/session_refer_params.rbi +64 -0
- data/rbi/openai/models/live/session_reject_params.rbi +62 -0
- data/rbi/openai/models/live/session_resource.rbi +461 -0
- data/rbi/openai/models/live/session_start_event.rbi +78 -0
- data/rbi/openai/models/live/session_started_event.rbi +86 -0
- data/rbi/openai/models/live/session_update_config.rbi +134 -0
- data/rbi/openai/models/live/session_update_event.rbi +78 -0
- data/rbi/openai/models/live/session_updated_event.rbi +86 -0
- data/rbi/openai/models/live/session_usage.rbi +53 -0
- data/rbi/openai/models/live/session_usage_updated_event.rbi +148 -0
- data/rbi/openai/models/live/thinking_append_event.rbi +88 -0
- data/rbi/openai/models/live/thinking_appended_event.rbi +97 -0
- 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 +86 -78
- 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 +113 -0
- data/rbi/openai/models/responses/response_item.rbi +105 -0
- data/rbi/openai/models/responses/response_output_item.rbi +125 -0
- 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 +88 -80
- data/rbi/openai/models/responses/tool.rbi +4 -4
- 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 +17 -9
- data/rbi/openai/models/webhooks/live_transport_incoming_webhook_event.rbi +226 -0
- data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi +10 -6
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +1 -0
- data/rbi/openai/models.rbi +2 -0
- 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 +108 -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 +7 -7
- data/rbi/openai/resources/live/forks.rbi +19 -0
- data/rbi/openai/resources/live/sessions.rbi +110 -0
- data/rbi/openai/resources/live/sideband.rbi +19 -0
- data/rbi/openai/resources/live.rbi +43 -0
- 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 +183 -140
- 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/rbi/openai/resources/webhooks.rbi +1 -0
- data/sig/openai/client.rbs +2 -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 +56 -0
- data/sig/openai/models/beta/beta_response_item.rbs +56 -0
- data/sig/openai/models/beta/beta_response_output_item.rbs +56 -0
- data/sig/openai/models/conversations/conversation_item.rbs +56 -0
- data/sig/openai/models/live/audio_format.rbs +73 -0
- data/sig/openai/models/live/built_in_voice.rbs +58 -0
- data/sig/openai/models/live/client_config.rbs +15 -0
- data/sig/openai/models/live/client_delegation.rbs +15 -0
- data/sig/openai/models/live/client_event.rbs +24 -0
- data/sig/openai/models/live/commentary_append_event.rbs +37 -0
- data/sig/openai/models/live/commentary_appended_event.rbs +44 -0
- data/sig/openai/models/live/custom_voice.rbs +15 -0
- data/sig/openai/models/live/data_channel_config.rbs +56 -0
- data/sig/openai/models/live/delegation_created_event.rbs +89 -0
- data/sig/openai/models/live/error.rbs +46 -0
- data/sig/openai/models/live/error_event.rbs +39 -0
- data/sig/openai/models/live/fork_client_event.rbs +24 -0
- data/sig/openai/models/live/fork_server_event.rbs +212 -0
- data/sig/openai/models/live/fork_session_config.rbs +89 -0
- data/sig/openai/models/live/fork_session_start_event.rbs +32 -0
- data/sig/openai/models/live/function_tool.rbs +42 -0
- data/sig/openai/models/live/info_event.rbs +44 -0
- data/sig/openai/models/live/initial_item.rbs +332 -0
- data/sig/openai/models/live/input_audio_append_event.rbs +32 -0
- data/sig/openai/models/live/input_audio_mute_event.rbs +24 -0
- data/sig/openai/models/live/input_audio_muted_event.rbs +34 -0
- data/sig/openai/models/live/input_audio_unmute_event.rbs +24 -0
- data/sig/openai/models/live/input_audio_unmuted_event.rbs +34 -0
- data/sig/openai/models/live/input_transcript_delta_event.rbs +49 -0
- data/sig/openai/models/live/instructions_append_event.rbs +37 -0
- data/sig/openai/models/live/instructions_appended_event.rbs +44 -0
- data/sig/openai/models/live/live_create_params.rbs +45 -0
- data/sig/openai/models/live/live_create_response.rbs +49 -0
- data/sig/openai/models/live/media_session_config.rbs +157 -0
- data/sig/openai/models/live/media_session_fork_config.rbs +66 -0
- data/sig/openai/models/live/output_audio_delta_event.rbs +41 -0
- data/sig/openai/models/live/output_transcript_delta_event.rbs +49 -0
- data/sig/openai/models/live/response_create_event.rbs +18 -0
- data/sig/openai/models/live/response_event.rbs +44 -0
- data/sig/openai/models/live/response_item_create_event.rbs +32 -0
- data/sig/openai/models/live/responses_delegation_config.rbs +244 -0
- data/sig/openai/models/live/responses_delegation_update_config.rbs +246 -0
- data/sig/openai/models/live/server_event.rbs +212 -0
- data/sig/openai/models/live/server_event_selector.rbs +19 -0
- data/sig/openai/models/live/session_accept_params.rbs +185 -0
- data/sig/openai/models/live/session_close_event.rbs +17 -0
- data/sig/openai/models/live/session_closed_event.rbs +68 -0
- data/sig/openai/models/live/session_config.rbs +168 -0
- data/sig/openai/models/live/session_download_recording_params.rbs +25 -0
- data/sig/openai/models/live/session_fork_params.rbs +54 -0
- data/sig/openai/models/live/session_fork_response.rbs +49 -0
- data/sig/openai/models/live/session_hangup_params.rbs +25 -0
- data/sig/openai/models/live/session_refer_params.rbs +33 -0
- data/sig/openai/models/live/session_reject_params.rbs +33 -0
- data/sig/openai/models/live/session_resource.rbs +183 -0
- data/sig/openai/models/live/session_start_event.rbs +32 -0
- data/sig/openai/models/live/session_started_event.rbs +39 -0
- data/sig/openai/models/live/session_update_config.rbs +56 -0
- data/sig/openai/models/live/session_update_event.rbs +32 -0
- data/sig/openai/models/live/session_updated_event.rbs +39 -0
- data/sig/openai/models/live/session_usage.rbs +15 -0
- data/sig/openai/models/live/session_usage_updated_event.rbs +58 -0
- data/sig/openai/models/live/thinking_append_event.rbs +37 -0
- data/sig/openai/models/live/thinking_appended_event.rbs +44 -0
- data/sig/openai/models/responses/response_input_item.rbs +56 -0
- data/sig/openai/models/responses/response_item.rbs +56 -0
- data/sig/openai/models/responses/response_output_item.rbs +56 -0
- data/sig/openai/models/webhooks/live_transport_incoming_webhook_event.rbs +95 -0
- data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
- data/sig/openai/models.rbs +2 -0
- data/sig/openai/resources/admin/organization/projects/service_accounts.rbs +1 -0
- data/sig/openai/resources/live/forks.rbs +9 -0
- data/sig/openai/resources/live/sessions.rbs +44 -0
- data/sig/openai/resources/live/sideband.rbs +9 -0
- data/sig/openai/resources/live.rbs +19 -0
- data/sig/openai/resources/webhooks.rbs +1 -0
- metadata +196 -1
|
@@ -389,21 +389,23 @@ module OpenAI
|
|
|
389
389
|
optional :stream_id, String
|
|
390
390
|
|
|
391
391
|
# @!method initialize(delta:, sequence_number:, agent: nil, stream_id: nil, type: :"response.audio.delta")
|
|
392
|
-
# Some parameter documentations has been truncated, see
|
|
393
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseAudioWsDelta} for
|
|
394
|
-
# more details.
|
|
395
|
-
#
|
|
396
392
|
# Emitted when there is a partial audio response.
|
|
397
393
|
#
|
|
398
|
-
# @param delta [String]
|
|
394
|
+
# @param delta [String]
|
|
395
|
+
# A chunk of Base64 encoded response audio bytes.
|
|
399
396
|
#
|
|
400
|
-
# @param sequence_number [Integer]
|
|
397
|
+
# @param sequence_number [Integer]
|
|
398
|
+
# A sequence number for this chunk of the stream response.
|
|
401
399
|
#
|
|
402
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseAudioDeltaEvent::Agent, nil]
|
|
400
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseAudioDeltaEvent::Agent, nil]
|
|
401
|
+
# The agent that owns this multi-agent streaming event.
|
|
403
402
|
#
|
|
404
|
-
# @param stream_id [String]
|
|
403
|
+
# @param stream_id [String]
|
|
404
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
405
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
405
406
|
#
|
|
406
|
-
# @param type [Symbol, :"response.audio.delta"]
|
|
407
|
+
# @param type [Symbol, :"response.audio.delta"]
|
|
408
|
+
# The type of the event. Always `response.audio.delta`.
|
|
407
409
|
end
|
|
408
410
|
|
|
409
411
|
class BetaResponseAudioWsDone < OpenAI::Models::Beta::BetaResponseAudioDoneEvent
|
|
@@ -415,19 +417,20 @@ module OpenAI
|
|
|
415
417
|
optional :stream_id, String
|
|
416
418
|
|
|
417
419
|
# @!method initialize(sequence_number:, agent: nil, stream_id: nil, type: :"response.audio.done")
|
|
418
|
-
# Some parameter documentations has been truncated, see
|
|
419
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseAudioWsDone} for
|
|
420
|
-
# more details.
|
|
421
|
-
#
|
|
422
420
|
# Emitted when the audio response is complete.
|
|
423
421
|
#
|
|
424
|
-
# @param sequence_number [Integer]
|
|
422
|
+
# @param sequence_number [Integer]
|
|
423
|
+
# The sequence number of the delta.
|
|
425
424
|
#
|
|
426
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseAudioDoneEvent::Agent, nil]
|
|
425
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseAudioDoneEvent::Agent, nil]
|
|
426
|
+
# The agent that owns this multi-agent streaming event.
|
|
427
427
|
#
|
|
428
|
-
# @param stream_id [String]
|
|
428
|
+
# @param stream_id [String]
|
|
429
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
430
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
429
431
|
#
|
|
430
|
-
# @param type [Symbol, :"response.audio.done"]
|
|
432
|
+
# @param type [Symbol, :"response.audio.done"]
|
|
433
|
+
# The type of the event. Always `response.audio.done`.
|
|
431
434
|
end
|
|
432
435
|
|
|
433
436
|
class BetaResponseAudioTranscriptWsDelta < OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent
|
|
@@ -439,21 +442,23 @@ module OpenAI
|
|
|
439
442
|
optional :stream_id, String
|
|
440
443
|
|
|
441
444
|
# @!method initialize(delta:, sequence_number:, agent: nil, stream_id: nil, type: :"response.audio.transcript.delta")
|
|
442
|
-
# Some parameter documentations has been truncated, see
|
|
443
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseAudioTranscriptWsDelta}
|
|
444
|
-
# for more details.
|
|
445
|
-
#
|
|
446
445
|
# Emitted when there is a partial transcript of audio.
|
|
447
446
|
#
|
|
448
|
-
# @param delta [String]
|
|
447
|
+
# @param delta [String]
|
|
448
|
+
# The partial transcript of the audio response.
|
|
449
449
|
#
|
|
450
|
-
# @param sequence_number [Integer]
|
|
450
|
+
# @param sequence_number [Integer]
|
|
451
|
+
# The sequence number of this event.
|
|
451
452
|
#
|
|
452
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent::Agent, nil]
|
|
453
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent::Agent, nil]
|
|
454
|
+
# The agent that owns this multi-agent streaming event.
|
|
453
455
|
#
|
|
454
|
-
# @param stream_id [String]
|
|
456
|
+
# @param stream_id [String]
|
|
457
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
458
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
455
459
|
#
|
|
456
|
-
# @param type [Symbol, :"response.audio.transcript.delta"]
|
|
460
|
+
# @param type [Symbol, :"response.audio.transcript.delta"]
|
|
461
|
+
# The type of the event. Always `response.audio.transcript.delta`.
|
|
457
462
|
end
|
|
458
463
|
|
|
459
464
|
class BetaResponseAudioTranscriptWsDone < OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent
|
|
@@ -465,19 +470,20 @@ module OpenAI
|
|
|
465
470
|
optional :stream_id, String
|
|
466
471
|
|
|
467
472
|
# @!method initialize(sequence_number:, agent: nil, stream_id: nil, type: :"response.audio.transcript.done")
|
|
468
|
-
# Some parameter documentations has been truncated, see
|
|
469
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseAudioTranscriptWsDone}
|
|
470
|
-
# for more details.
|
|
471
|
-
#
|
|
472
473
|
# Emitted when the full audio transcript is completed.
|
|
473
474
|
#
|
|
474
|
-
# @param sequence_number [Integer]
|
|
475
|
+
# @param sequence_number [Integer]
|
|
476
|
+
# The sequence number of this event.
|
|
475
477
|
#
|
|
476
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent::Agent, nil]
|
|
478
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent::Agent, nil]
|
|
479
|
+
# The agent that owns this multi-agent streaming event.
|
|
477
480
|
#
|
|
478
|
-
# @param stream_id [String]
|
|
481
|
+
# @param stream_id [String]
|
|
482
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
483
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
479
484
|
#
|
|
480
|
-
# @param type [Symbol, :"response.audio.transcript.done"]
|
|
485
|
+
# @param type [Symbol, :"response.audio.transcript.done"]
|
|
486
|
+
# The type of the event. Always `response.audio.transcript.done`.
|
|
481
487
|
end
|
|
482
488
|
|
|
483
489
|
class BetaResponseCodeInterpreterCallCodeWsDelta < OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent
|
|
@@ -489,25 +495,30 @@ module OpenAI
|
|
|
489
495
|
optional :stream_id, String
|
|
490
496
|
|
|
491
497
|
# @!method initialize(delta:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.code_interpreter_call_code.delta")
|
|
492
|
-
# Some parameter documentations has been truncated, see
|
|
493
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseCodeInterpreterCallCodeWsDelta}
|
|
494
|
-
# for more details.
|
|
495
|
-
#
|
|
496
498
|
# Emitted when a partial code snippet is streamed by the code interpreter.
|
|
497
499
|
#
|
|
498
|
-
# @param delta [String]
|
|
500
|
+
# @param delta [String]
|
|
501
|
+
# The partial code snippet being streamed by the code interpreter.
|
|
499
502
|
#
|
|
500
|
-
# @param item_id [String]
|
|
503
|
+
# @param item_id [String]
|
|
504
|
+
# The unique identifier of the code interpreter tool call item.
|
|
501
505
|
#
|
|
502
|
-
# @param output_index [Integer]
|
|
506
|
+
# @param output_index [Integer]
|
|
507
|
+
# The index of the output item in the response for which the code is being
|
|
508
|
+
# streamed.
|
|
503
509
|
#
|
|
504
|
-
# @param sequence_number [Integer]
|
|
510
|
+
# @param sequence_number [Integer]
|
|
511
|
+
# The sequence number of this event, used to order streaming events.
|
|
505
512
|
#
|
|
506
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent::Agent, nil]
|
|
513
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent::Agent, nil]
|
|
514
|
+
# The agent that owns this multi-agent streaming event.
|
|
507
515
|
#
|
|
508
|
-
# @param stream_id [String]
|
|
516
|
+
# @param stream_id [String]
|
|
517
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
518
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
509
519
|
#
|
|
510
|
-
# @param type [Symbol, :"response.code_interpreter_call_code.delta"]
|
|
520
|
+
# @param type [Symbol, :"response.code_interpreter_call_code.delta"]
|
|
521
|
+
# The type of the event. Always `response.code_interpreter_call_code.delta`.
|
|
511
522
|
end
|
|
512
523
|
|
|
513
524
|
class BetaResponseCodeInterpreterCallCodeWsDone < OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent
|
|
@@ -519,25 +530,29 @@ module OpenAI
|
|
|
519
530
|
optional :stream_id, String
|
|
520
531
|
|
|
521
532
|
# @!method initialize(code:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.code_interpreter_call_code.done")
|
|
522
|
-
# Some parameter documentations has been truncated, see
|
|
523
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseCodeInterpreterCallCodeWsDone}
|
|
524
|
-
# for more details.
|
|
525
|
-
#
|
|
526
533
|
# Emitted when the code snippet is finalized by the code interpreter.
|
|
527
534
|
#
|
|
528
|
-
# @param code [String]
|
|
535
|
+
# @param code [String]
|
|
536
|
+
# The final code snippet output by the code interpreter.
|
|
529
537
|
#
|
|
530
|
-
# @param item_id [String]
|
|
538
|
+
# @param item_id [String]
|
|
539
|
+
# The unique identifier of the code interpreter tool call item.
|
|
531
540
|
#
|
|
532
|
-
# @param output_index [Integer]
|
|
541
|
+
# @param output_index [Integer]
|
|
542
|
+
# The index of the output item in the response for which the code is finalized.
|
|
533
543
|
#
|
|
534
|
-
# @param sequence_number [Integer]
|
|
544
|
+
# @param sequence_number [Integer]
|
|
545
|
+
# The sequence number of this event, used to order streaming events.
|
|
535
546
|
#
|
|
536
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent::Agent, nil]
|
|
547
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent::Agent, nil]
|
|
548
|
+
# The agent that owns this multi-agent streaming event.
|
|
537
549
|
#
|
|
538
|
-
# @param stream_id [String]
|
|
550
|
+
# @param stream_id [String]
|
|
551
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
552
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
539
553
|
#
|
|
540
|
-
# @param type [Symbol, :"response.code_interpreter_call_code.done"]
|
|
554
|
+
# @param type [Symbol, :"response.code_interpreter_call_code.done"]
|
|
555
|
+
# The type of the event. Always `response.code_interpreter_call_code.done`.
|
|
541
556
|
end
|
|
542
557
|
|
|
543
558
|
class BetaResponseCodeInterpreterCallWsCompleted < OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent
|
|
@@ -549,23 +564,27 @@ module OpenAI
|
|
|
549
564
|
optional :stream_id, String
|
|
550
565
|
|
|
551
566
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.code_interpreter_call.completed")
|
|
552
|
-
# Some parameter documentations has been truncated, see
|
|
553
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseCodeInterpreterCallWsCompleted}
|
|
554
|
-
# for more details.
|
|
555
|
-
#
|
|
556
567
|
# Emitted when the code interpreter call is completed.
|
|
557
568
|
#
|
|
558
|
-
# @param item_id [String]
|
|
569
|
+
# @param item_id [String]
|
|
570
|
+
# The unique identifier of the code interpreter tool call item.
|
|
559
571
|
#
|
|
560
|
-
# @param output_index [Integer]
|
|
572
|
+
# @param output_index [Integer]
|
|
573
|
+
# The index of the output item in the response for which the code interpreter call
|
|
574
|
+
# is completed.
|
|
561
575
|
#
|
|
562
|
-
# @param sequence_number [Integer]
|
|
576
|
+
# @param sequence_number [Integer]
|
|
577
|
+
# The sequence number of this event, used to order streaming events.
|
|
563
578
|
#
|
|
564
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent::Agent, nil]
|
|
579
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent::Agent, nil]
|
|
580
|
+
# The agent that owns this multi-agent streaming event.
|
|
565
581
|
#
|
|
566
|
-
# @param stream_id [String]
|
|
582
|
+
# @param stream_id [String]
|
|
583
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
584
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
567
585
|
#
|
|
568
|
-
# @param type [Symbol, :"response.code_interpreter_call.completed"]
|
|
586
|
+
# @param type [Symbol, :"response.code_interpreter_call.completed"]
|
|
587
|
+
# The type of the event. Always `response.code_interpreter_call.completed`.
|
|
569
588
|
end
|
|
570
589
|
|
|
571
590
|
class BetaResponseCodeInterpreterCallInWsProgress < OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent
|
|
@@ -577,23 +596,27 @@ module OpenAI
|
|
|
577
596
|
optional :stream_id, String
|
|
578
597
|
|
|
579
598
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.code_interpreter_call.in_progress")
|
|
580
|
-
# Some parameter documentations has been truncated, see
|
|
581
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseCodeInterpreterCallInWsProgress}
|
|
582
|
-
# for more details.
|
|
583
|
-
#
|
|
584
599
|
# Emitted when a code interpreter call is in progress.
|
|
585
600
|
#
|
|
586
|
-
# @param item_id [String]
|
|
601
|
+
# @param item_id [String]
|
|
602
|
+
# The unique identifier of the code interpreter tool call item.
|
|
587
603
|
#
|
|
588
|
-
# @param output_index [Integer]
|
|
604
|
+
# @param output_index [Integer]
|
|
605
|
+
# The index of the output item in the response for which the code interpreter call
|
|
606
|
+
# is in progress.
|
|
589
607
|
#
|
|
590
|
-
# @param sequence_number [Integer]
|
|
608
|
+
# @param sequence_number [Integer]
|
|
609
|
+
# The sequence number of this event, used to order streaming events.
|
|
591
610
|
#
|
|
592
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent::Agent, nil]
|
|
611
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent::Agent, nil]
|
|
612
|
+
# The agent that owns this multi-agent streaming event.
|
|
593
613
|
#
|
|
594
|
-
# @param stream_id [String]
|
|
614
|
+
# @param stream_id [String]
|
|
615
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
616
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
595
617
|
#
|
|
596
|
-
# @param type [Symbol, :"response.code_interpreter_call.in_progress"]
|
|
618
|
+
# @param type [Symbol, :"response.code_interpreter_call.in_progress"]
|
|
619
|
+
# The type of the event. Always `response.code_interpreter_call.in_progress`.
|
|
597
620
|
end
|
|
598
621
|
|
|
599
622
|
class BetaResponseCodeInterpreterCallWsInterpreting < OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent
|
|
@@ -605,23 +628,27 @@ module OpenAI
|
|
|
605
628
|
optional :stream_id, String
|
|
606
629
|
|
|
607
630
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.code_interpreter_call.interpreting")
|
|
608
|
-
# Some parameter documentations has been truncated, see
|
|
609
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseCodeInterpreterCallWsInterpreting}
|
|
610
|
-
# for more details.
|
|
611
|
-
#
|
|
612
631
|
# Emitted when the code interpreter is actively interpreting the code snippet.
|
|
613
632
|
#
|
|
614
|
-
# @param item_id [String]
|
|
633
|
+
# @param item_id [String]
|
|
634
|
+
# The unique identifier of the code interpreter tool call item.
|
|
615
635
|
#
|
|
616
|
-
# @param output_index [Integer]
|
|
636
|
+
# @param output_index [Integer]
|
|
637
|
+
# The index of the output item in the response for which the code interpreter is
|
|
638
|
+
# interpreting code.
|
|
617
639
|
#
|
|
618
|
-
# @param sequence_number [Integer]
|
|
640
|
+
# @param sequence_number [Integer]
|
|
641
|
+
# The sequence number of this event, used to order streaming events.
|
|
619
642
|
#
|
|
620
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent::Agent, nil]
|
|
643
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent::Agent, nil]
|
|
644
|
+
# The agent that owns this multi-agent streaming event.
|
|
621
645
|
#
|
|
622
|
-
# @param stream_id [String]
|
|
646
|
+
# @param stream_id [String]
|
|
647
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
648
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
623
649
|
#
|
|
624
|
-
# @param type [Symbol, :"response.code_interpreter_call.interpreting"]
|
|
650
|
+
# @param type [Symbol, :"response.code_interpreter_call.interpreting"]
|
|
651
|
+
# The type of the event. Always `response.code_interpreter_call.interpreting`.
|
|
625
652
|
end
|
|
626
653
|
|
|
627
654
|
class BetaResponseWsCompleted < OpenAI::Models::Beta::BetaResponseCompletedEvent
|
|
@@ -633,21 +660,23 @@ module OpenAI
|
|
|
633
660
|
optional :stream_id, String
|
|
634
661
|
|
|
635
662
|
# @!method initialize(response:, sequence_number:, agent: nil, stream_id: nil, type: :"response.completed")
|
|
636
|
-
# Some parameter documentations has been truncated, see
|
|
637
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsCompleted} for
|
|
638
|
-
# more details.
|
|
639
|
-
#
|
|
640
663
|
# Emitted when the model response is complete.
|
|
641
664
|
#
|
|
642
|
-
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
665
|
+
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
666
|
+
# Properties of the completed response.
|
|
643
667
|
#
|
|
644
|
-
# @param sequence_number [Integer]
|
|
668
|
+
# @param sequence_number [Integer]
|
|
669
|
+
# The sequence number for this event.
|
|
645
670
|
#
|
|
646
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCompletedEvent::Agent, nil]
|
|
671
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCompletedEvent::Agent, nil]
|
|
672
|
+
# The agent that owns this multi-agent streaming event.
|
|
647
673
|
#
|
|
648
|
-
# @param stream_id [String]
|
|
674
|
+
# @param stream_id [String]
|
|
675
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
676
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
649
677
|
#
|
|
650
|
-
# @param type [Symbol, :"response.completed"]
|
|
678
|
+
# @param type [Symbol, :"response.completed"]
|
|
679
|
+
# The type of the event. Always `response.completed`.
|
|
651
680
|
end
|
|
652
681
|
|
|
653
682
|
class BetaResponseContentPartWsAdded < OpenAI::Models::Beta::BetaResponseContentPartAddedEvent
|
|
@@ -659,27 +688,32 @@ module OpenAI
|
|
|
659
688
|
optional :stream_id, String
|
|
660
689
|
|
|
661
690
|
# @!method initialize(content_index:, item_id:, output_index:, part:, sequence_number:, agent: nil, stream_id: nil, type: :"response.content_part.added")
|
|
662
|
-
# Some parameter documentations has been truncated, see
|
|
663
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseContentPartWsAdded}
|
|
664
|
-
# for more details.
|
|
665
|
-
#
|
|
666
691
|
# Emitted when a new content part is added.
|
|
667
692
|
#
|
|
668
|
-
# @param content_index [Integer]
|
|
693
|
+
# @param content_index [Integer]
|
|
694
|
+
# The index of the content part that was added.
|
|
669
695
|
#
|
|
670
|
-
# @param item_id [String]
|
|
696
|
+
# @param item_id [String]
|
|
697
|
+
# The ID of the output item that the content part was added to.
|
|
671
698
|
#
|
|
672
|
-
# @param output_index [Integer]
|
|
699
|
+
# @param output_index [Integer]
|
|
700
|
+
# The index of the output item that the content part was added to.
|
|
673
701
|
#
|
|
674
|
-
# @param part [OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent::Part::ReasoningText]
|
|
702
|
+
# @param part [OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent::Part::ReasoningText]
|
|
703
|
+
# The content part that was added.
|
|
675
704
|
#
|
|
676
|
-
# @param sequence_number [Integer]
|
|
705
|
+
# @param sequence_number [Integer]
|
|
706
|
+
# The sequence number of this event.
|
|
677
707
|
#
|
|
678
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseContentPartAddedEvent::Agent, nil]
|
|
708
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseContentPartAddedEvent::Agent, nil]
|
|
709
|
+
# The agent that owns this multi-agent streaming event.
|
|
679
710
|
#
|
|
680
|
-
# @param stream_id [String]
|
|
711
|
+
# @param stream_id [String]
|
|
712
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
713
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
681
714
|
#
|
|
682
|
-
# @param type [Symbol, :"response.content_part.added"]
|
|
715
|
+
# @param type [Symbol, :"response.content_part.added"]
|
|
716
|
+
# The type of the event. Always `response.content_part.added`.
|
|
683
717
|
end
|
|
684
718
|
|
|
685
719
|
class BetaResponseContentPartWsDone < OpenAI::Models::Beta::BetaResponseContentPartDoneEvent
|
|
@@ -691,27 +725,32 @@ module OpenAI
|
|
|
691
725
|
optional :stream_id, String
|
|
692
726
|
|
|
693
727
|
# @!method initialize(content_index:, item_id:, output_index:, part:, sequence_number:, agent: nil, stream_id: nil, type: :"response.content_part.done")
|
|
694
|
-
# Some parameter documentations has been truncated, see
|
|
695
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseContentPartWsDone}
|
|
696
|
-
# for more details.
|
|
697
|
-
#
|
|
698
728
|
# Emitted when a content part is done.
|
|
699
729
|
#
|
|
700
|
-
# @param content_index [Integer]
|
|
730
|
+
# @param content_index [Integer]
|
|
731
|
+
# The index of the content part that is done.
|
|
701
732
|
#
|
|
702
|
-
# @param item_id [String]
|
|
733
|
+
# @param item_id [String]
|
|
734
|
+
# The ID of the output item that the content part was added to.
|
|
703
735
|
#
|
|
704
|
-
# @param output_index [Integer]
|
|
736
|
+
# @param output_index [Integer]
|
|
737
|
+
# The index of the output item that the content part was added to.
|
|
705
738
|
#
|
|
706
|
-
# @param part [OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Part::ReasoningText]
|
|
739
|
+
# @param part [OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Part::ReasoningText]
|
|
740
|
+
# The content part that is done.
|
|
707
741
|
#
|
|
708
|
-
# @param sequence_number [Integer]
|
|
742
|
+
# @param sequence_number [Integer]
|
|
743
|
+
# The sequence number of this event.
|
|
709
744
|
#
|
|
710
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Agent, nil]
|
|
745
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Agent, nil]
|
|
746
|
+
# The agent that owns this multi-agent streaming event.
|
|
711
747
|
#
|
|
712
|
-
# @param stream_id [String]
|
|
748
|
+
# @param stream_id [String]
|
|
749
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
750
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
713
751
|
#
|
|
714
|
-
# @param type [Symbol, :"response.content_part.done"]
|
|
752
|
+
# @param type [Symbol, :"response.content_part.done"]
|
|
753
|
+
# The type of the event. Always `response.content_part.done`.
|
|
715
754
|
end
|
|
716
755
|
|
|
717
756
|
class BetaResponseWsCreated < OpenAI::Models::Beta::BetaResponseCreatedEvent
|
|
@@ -723,21 +762,23 @@ module OpenAI
|
|
|
723
762
|
optional :stream_id, String
|
|
724
763
|
|
|
725
764
|
# @!method initialize(response:, sequence_number:, agent: nil, stream_id: nil, type: :"response.created")
|
|
726
|
-
# Some parameter documentations has been truncated, see
|
|
727
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsCreated} for more
|
|
728
|
-
# details.
|
|
729
|
-
#
|
|
730
765
|
# An event that is emitted when a response is created.
|
|
731
766
|
#
|
|
732
|
-
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
767
|
+
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
768
|
+
# The response that was created.
|
|
733
769
|
#
|
|
734
|
-
# @param sequence_number [Integer]
|
|
770
|
+
# @param sequence_number [Integer]
|
|
771
|
+
# The sequence number for this event.
|
|
735
772
|
#
|
|
736
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCreatedEvent::Agent, nil]
|
|
773
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCreatedEvent::Agent, nil]
|
|
774
|
+
# The agent that owns this multi-agent streaming event.
|
|
737
775
|
#
|
|
738
|
-
# @param stream_id [String]
|
|
776
|
+
# @param stream_id [String]
|
|
777
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
778
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
739
779
|
#
|
|
740
|
-
# @param type [Symbol, :"response.created"]
|
|
780
|
+
# @param type [Symbol, :"response.created"]
|
|
781
|
+
# The type of the event. Always `response.created`.
|
|
741
782
|
end
|
|
742
783
|
|
|
743
784
|
class BetaResponseFileSearchCallWsCompleted < OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent
|
|
@@ -749,23 +790,26 @@ module OpenAI
|
|
|
749
790
|
optional :stream_id, String
|
|
750
791
|
|
|
751
792
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.file_search_call.completed")
|
|
752
|
-
# Some parameter documentations has been truncated, see
|
|
753
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseFileSearchCallWsCompleted}
|
|
754
|
-
# for more details.
|
|
755
|
-
#
|
|
756
793
|
# Emitted when a file search call is completed (results found).
|
|
757
794
|
#
|
|
758
|
-
# @param item_id [String]
|
|
795
|
+
# @param item_id [String]
|
|
796
|
+
# The ID of the output item that the file search call is initiated.
|
|
759
797
|
#
|
|
760
|
-
# @param output_index [Integer]
|
|
798
|
+
# @param output_index [Integer]
|
|
799
|
+
# The index of the output item that the file search call is initiated.
|
|
761
800
|
#
|
|
762
|
-
# @param sequence_number [Integer]
|
|
801
|
+
# @param sequence_number [Integer]
|
|
802
|
+
# The sequence number of this event.
|
|
763
803
|
#
|
|
764
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent::Agent, nil]
|
|
804
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent::Agent, nil]
|
|
805
|
+
# The agent that owns this multi-agent streaming event.
|
|
765
806
|
#
|
|
766
|
-
# @param stream_id [String]
|
|
807
|
+
# @param stream_id [String]
|
|
808
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
809
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
767
810
|
#
|
|
768
|
-
# @param type [Symbol, :"response.file_search_call.completed"]
|
|
811
|
+
# @param type [Symbol, :"response.file_search_call.completed"]
|
|
812
|
+
# The type of the event. Always `response.file_search_call.completed`.
|
|
769
813
|
end
|
|
770
814
|
|
|
771
815
|
class BetaResponseFileSearchCallInWsProgress < OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent
|
|
@@ -777,23 +821,26 @@ module OpenAI
|
|
|
777
821
|
optional :stream_id, String
|
|
778
822
|
|
|
779
823
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.file_search_call.in_progress")
|
|
780
|
-
# Some parameter documentations has been truncated, see
|
|
781
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseFileSearchCallInWsProgress}
|
|
782
|
-
# for more details.
|
|
783
|
-
#
|
|
784
824
|
# Emitted when a file search call is initiated.
|
|
785
825
|
#
|
|
786
|
-
# @param item_id [String]
|
|
826
|
+
# @param item_id [String]
|
|
827
|
+
# The ID of the output item that the file search call is initiated.
|
|
787
828
|
#
|
|
788
|
-
# @param output_index [Integer]
|
|
829
|
+
# @param output_index [Integer]
|
|
830
|
+
# The index of the output item that the file search call is initiated.
|
|
789
831
|
#
|
|
790
|
-
# @param sequence_number [Integer]
|
|
832
|
+
# @param sequence_number [Integer]
|
|
833
|
+
# The sequence number of this event.
|
|
791
834
|
#
|
|
792
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent::Agent, nil]
|
|
835
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent::Agent, nil]
|
|
836
|
+
# The agent that owns this multi-agent streaming event.
|
|
793
837
|
#
|
|
794
|
-
# @param stream_id [String]
|
|
838
|
+
# @param stream_id [String]
|
|
839
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
840
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
795
841
|
#
|
|
796
|
-
# @param type [Symbol, :"response.file_search_call.in_progress"]
|
|
842
|
+
# @param type [Symbol, :"response.file_search_call.in_progress"]
|
|
843
|
+
# The type of the event. Always `response.file_search_call.in_progress`.
|
|
797
844
|
end
|
|
798
845
|
|
|
799
846
|
class BetaResponseFileSearchCallWsSearching < OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent
|
|
@@ -805,23 +852,26 @@ module OpenAI
|
|
|
805
852
|
optional :stream_id, String
|
|
806
853
|
|
|
807
854
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.file_search_call.searching")
|
|
808
|
-
# Some parameter documentations has been truncated, see
|
|
809
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseFileSearchCallWsSearching}
|
|
810
|
-
# for more details.
|
|
811
|
-
#
|
|
812
855
|
# Emitted when a file search is currently searching.
|
|
813
856
|
#
|
|
814
|
-
# @param item_id [String]
|
|
857
|
+
# @param item_id [String]
|
|
858
|
+
# The ID of the output item that the file search call is initiated.
|
|
815
859
|
#
|
|
816
|
-
# @param output_index [Integer]
|
|
860
|
+
# @param output_index [Integer]
|
|
861
|
+
# The index of the output item that the file search call is searching.
|
|
817
862
|
#
|
|
818
|
-
# @param sequence_number [Integer]
|
|
863
|
+
# @param sequence_number [Integer]
|
|
864
|
+
# The sequence number of this event.
|
|
819
865
|
#
|
|
820
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent::Agent, nil]
|
|
866
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent::Agent, nil]
|
|
867
|
+
# The agent that owns this multi-agent streaming event.
|
|
821
868
|
#
|
|
822
|
-
# @param stream_id [String]
|
|
869
|
+
# @param stream_id [String]
|
|
870
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
871
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
823
872
|
#
|
|
824
|
-
# @param type [Symbol, :"response.file_search_call.searching"]
|
|
873
|
+
# @param type [Symbol, :"response.file_search_call.searching"]
|
|
874
|
+
# The type of the event. Always `response.file_search_call.searching`.
|
|
825
875
|
end
|
|
826
876
|
|
|
827
877
|
class BetaResponseFunctionCallArgumentsWsDelta < OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent
|
|
@@ -833,25 +883,29 @@ module OpenAI
|
|
|
833
883
|
optional :stream_id, String
|
|
834
884
|
|
|
835
885
|
# @!method initialize(delta:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.function_call_arguments.delta")
|
|
836
|
-
# Some parameter documentations has been truncated, see
|
|
837
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseFunctionCallArgumentsWsDelta}
|
|
838
|
-
# for more details.
|
|
839
|
-
#
|
|
840
886
|
# Emitted when there is a partial function-call arguments delta.
|
|
841
887
|
#
|
|
842
|
-
# @param delta [String]
|
|
888
|
+
# @param delta [String]
|
|
889
|
+
# The function-call arguments delta that is added.
|
|
843
890
|
#
|
|
844
|
-
# @param item_id [String]
|
|
891
|
+
# @param item_id [String]
|
|
892
|
+
# The ID of the output item that the function-call arguments delta is added to.
|
|
845
893
|
#
|
|
846
|
-
# @param output_index [Integer]
|
|
894
|
+
# @param output_index [Integer]
|
|
895
|
+
# The index of the output item that the function-call arguments delta is added to.
|
|
847
896
|
#
|
|
848
|
-
# @param sequence_number [Integer]
|
|
897
|
+
# @param sequence_number [Integer]
|
|
898
|
+
# The sequence number of this event.
|
|
849
899
|
#
|
|
850
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent, nil]
|
|
900
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent, nil]
|
|
901
|
+
# The agent that owns this multi-agent streaming event.
|
|
851
902
|
#
|
|
852
|
-
# @param stream_id [String]
|
|
903
|
+
# @param stream_id [String]
|
|
904
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
905
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
853
906
|
#
|
|
854
|
-
# @param type [Symbol, :"response.function_call_arguments.delta"]
|
|
907
|
+
# @param type [Symbol, :"response.function_call_arguments.delta"]
|
|
908
|
+
# The type of the event. Always `response.function_call_arguments.delta`.
|
|
855
909
|
end
|
|
856
910
|
|
|
857
911
|
class BetaResponseFunctionCallArgumentsWsDone < OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent
|
|
@@ -863,23 +917,26 @@ module OpenAI
|
|
|
863
917
|
optional :stream_id, String
|
|
864
918
|
|
|
865
919
|
# @!method initialize(arguments:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.function_call_arguments.done")
|
|
866
|
-
# Some parameter documentations has been truncated, see
|
|
867
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseFunctionCallArgumentsWsDone}
|
|
868
|
-
# for more details.
|
|
869
|
-
#
|
|
870
920
|
# Emitted when function-call arguments are finalized.
|
|
871
921
|
#
|
|
872
|
-
# @param arguments [String]
|
|
922
|
+
# @param arguments [String]
|
|
923
|
+
# The function-call arguments.
|
|
873
924
|
#
|
|
874
|
-
# @param item_id [String]
|
|
925
|
+
# @param item_id [String]
|
|
926
|
+
# The ID of the item.
|
|
875
927
|
#
|
|
876
|
-
# @param output_index [Integer]
|
|
928
|
+
# @param output_index [Integer]
|
|
929
|
+
# The index of the output item.
|
|
877
930
|
#
|
|
878
|
-
# @param sequence_number [Integer]
|
|
931
|
+
# @param sequence_number [Integer]
|
|
932
|
+
# The sequence number of this event.
|
|
879
933
|
#
|
|
880
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent::Agent, nil]
|
|
934
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent::Agent, nil]
|
|
935
|
+
# The agent that owns this multi-agent streaming event.
|
|
881
936
|
#
|
|
882
|
-
# @param stream_id [String]
|
|
937
|
+
# @param stream_id [String]
|
|
938
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
939
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
883
940
|
#
|
|
884
941
|
# @param type [Symbol, :"response.function_call_arguments.done"]
|
|
885
942
|
end
|
|
@@ -893,25 +950,29 @@ module OpenAI
|
|
|
893
950
|
optional :stream_id, String
|
|
894
951
|
|
|
895
952
|
# @!method initialize(command:, command_index:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.shell_call_command.added")
|
|
896
|
-
# Some parameter documentations has been truncated, see
|
|
897
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseShellCallCommandWsAdded}
|
|
898
|
-
# for more details.
|
|
899
|
-
#
|
|
900
953
|
# A streaming event that indicated a shell command was added to a tool call.
|
|
901
954
|
#
|
|
902
|
-
# @param command [String]
|
|
955
|
+
# @param command [String]
|
|
956
|
+
# The shell command that was added.
|
|
903
957
|
#
|
|
904
|
-
# @param command_index [Integer]
|
|
958
|
+
# @param command_index [Integer]
|
|
959
|
+
# The index of the shell command that was added.
|
|
905
960
|
#
|
|
906
|
-
# @param output_index [Integer]
|
|
961
|
+
# @param output_index [Integer]
|
|
962
|
+
# The index of the output item that was updated.
|
|
907
963
|
#
|
|
908
|
-
# @param sequence_number [Integer]
|
|
964
|
+
# @param sequence_number [Integer]
|
|
965
|
+
# The sequence number of the event that was emitted.
|
|
909
966
|
#
|
|
910
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent::Agent]
|
|
967
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent::Agent]
|
|
968
|
+
# The agent that owns this multi-agent streaming event.
|
|
911
969
|
#
|
|
912
|
-
# @param stream_id [String]
|
|
970
|
+
# @param stream_id [String]
|
|
971
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
972
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
913
973
|
#
|
|
914
|
-
# @param type [Symbol, :"response.shell_call_command.added"]
|
|
974
|
+
# @param type [Symbol, :"response.shell_call_command.added"]
|
|
975
|
+
# The type of the event, always `response.shell_call_command.added`.
|
|
915
976
|
end
|
|
916
977
|
|
|
917
978
|
class BetaResponseShellCallCommandWsDelta < OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent
|
|
@@ -923,27 +984,32 @@ module OpenAI
|
|
|
923
984
|
optional :stream_id, String
|
|
924
985
|
|
|
925
986
|
# @!method initialize(command_index:, delta:, output_index:, sequence_number:, agent: nil, obfuscation: nil, stream_id: nil, type: :"response.shell_call_command.delta")
|
|
926
|
-
# Some parameter documentations has been truncated, see
|
|
927
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseShellCallCommandWsDelta}
|
|
928
|
-
# for more details.
|
|
929
|
-
#
|
|
930
987
|
# A streaming event that indicated a shell command was incrementally updated.
|
|
931
988
|
#
|
|
932
|
-
# @param command_index [Integer]
|
|
989
|
+
# @param command_index [Integer]
|
|
990
|
+
# The index of the shell command that was updated.
|
|
933
991
|
#
|
|
934
|
-
# @param delta [String]
|
|
992
|
+
# @param delta [String]
|
|
993
|
+
# The shell command delta that was appended.
|
|
935
994
|
#
|
|
936
|
-
# @param output_index [Integer]
|
|
995
|
+
# @param output_index [Integer]
|
|
996
|
+
# The index of the output item that was updated.
|
|
937
997
|
#
|
|
938
|
-
# @param sequence_number [Integer]
|
|
998
|
+
# @param sequence_number [Integer]
|
|
999
|
+
# The sequence number of the event that was emitted.
|
|
939
1000
|
#
|
|
940
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent::Agent]
|
|
1001
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent::Agent]
|
|
1002
|
+
# The agent that owns this multi-agent streaming event.
|
|
941
1003
|
#
|
|
942
|
-
# @param obfuscation [String]
|
|
1004
|
+
# @param obfuscation [String]
|
|
1005
|
+
# An obfuscation string that was added to pad the event payload.
|
|
943
1006
|
#
|
|
944
|
-
# @param stream_id [String]
|
|
1007
|
+
# @param stream_id [String]
|
|
1008
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1009
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
945
1010
|
#
|
|
946
|
-
# @param type [Symbol, :"response.shell_call_command.delta"]
|
|
1011
|
+
# @param type [Symbol, :"response.shell_call_command.delta"]
|
|
1012
|
+
# The type of the event, always `response.shell_call_command.delta`.
|
|
947
1013
|
end
|
|
948
1014
|
|
|
949
1015
|
class BetaResponseShellCallCommandWsDone < OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent
|
|
@@ -955,25 +1021,29 @@ module OpenAI
|
|
|
955
1021
|
optional :stream_id, String
|
|
956
1022
|
|
|
957
1023
|
# @!method initialize(command:, command_index:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.shell_call_command.done")
|
|
958
|
-
# Some parameter documentations has been truncated, see
|
|
959
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseShellCallCommandWsDone}
|
|
960
|
-
# for more details.
|
|
961
|
-
#
|
|
962
1024
|
# A streaming event that indicated a shell command was completed.
|
|
963
1025
|
#
|
|
964
|
-
# @param command [String]
|
|
1026
|
+
# @param command [String]
|
|
1027
|
+
# The final shell command that was emitted.
|
|
965
1028
|
#
|
|
966
|
-
# @param command_index [Integer]
|
|
1029
|
+
# @param command_index [Integer]
|
|
1030
|
+
# The index of the shell command that was completed.
|
|
967
1031
|
#
|
|
968
|
-
# @param output_index [Integer]
|
|
1032
|
+
# @param output_index [Integer]
|
|
1033
|
+
# The index of the output item that was updated.
|
|
969
1034
|
#
|
|
970
|
-
# @param sequence_number [Integer]
|
|
1035
|
+
# @param sequence_number [Integer]
|
|
1036
|
+
# The sequence number of the event that was emitted.
|
|
971
1037
|
#
|
|
972
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent::Agent]
|
|
1038
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent::Agent]
|
|
1039
|
+
# The agent that owns this multi-agent streaming event.
|
|
973
1040
|
#
|
|
974
|
-
# @param stream_id [String]
|
|
1041
|
+
# @param stream_id [String]
|
|
1042
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1043
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
975
1044
|
#
|
|
976
|
-
# @param type [Symbol, :"response.shell_call_command.done"]
|
|
1045
|
+
# @param type [Symbol, :"response.shell_call_command.done"]
|
|
1046
|
+
# The type of the event, always `response.shell_call_command.done`.
|
|
977
1047
|
end
|
|
978
1048
|
|
|
979
1049
|
class BetaResponseShellCallOutputContentWsDelta < OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent
|
|
@@ -985,27 +1055,32 @@ module OpenAI
|
|
|
985
1055
|
optional :stream_id, String
|
|
986
1056
|
|
|
987
1057
|
# @!method initialize(command_index:, delta:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.shell_call_output_content.delta")
|
|
988
|
-
# Some parameter documentations has been truncated, see
|
|
989
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseShellCallOutputContentWsDelta}
|
|
990
|
-
# for more details.
|
|
991
|
-
#
|
|
992
1058
|
# A streaming event that indicated shell call output was incrementally added.
|
|
993
1059
|
#
|
|
994
|
-
# @param command_index [Integer]
|
|
1060
|
+
# @param command_index [Integer]
|
|
1061
|
+
# The index of the shell command that produced output.
|
|
995
1062
|
#
|
|
996
|
-
# @param delta [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent::Delta]
|
|
1063
|
+
# @param delta [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent::Delta]
|
|
1064
|
+
# The stdout/stderr delta that was emitted.
|
|
997
1065
|
#
|
|
998
|
-
# @param item_id [String]
|
|
1066
|
+
# @param item_id [String]
|
|
1067
|
+
# The ID of the output item that was updated.
|
|
999
1068
|
#
|
|
1000
|
-
# @param output_index [Integer]
|
|
1069
|
+
# @param output_index [Integer]
|
|
1070
|
+
# The index of the output item that was updated.
|
|
1001
1071
|
#
|
|
1002
|
-
# @param sequence_number [Integer]
|
|
1072
|
+
# @param sequence_number [Integer]
|
|
1073
|
+
# The sequence number of the event that was emitted.
|
|
1003
1074
|
#
|
|
1004
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent::Agent]
|
|
1075
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent::Agent]
|
|
1076
|
+
# The agent that owns this multi-agent streaming event.
|
|
1005
1077
|
#
|
|
1006
|
-
# @param stream_id [String]
|
|
1078
|
+
# @param stream_id [String]
|
|
1079
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1080
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1007
1081
|
#
|
|
1008
|
-
# @param type [Symbol, :"response.shell_call_output_content.delta"]
|
|
1082
|
+
# @param type [Symbol, :"response.shell_call_output_content.delta"]
|
|
1083
|
+
# The type of the event, always `response.shell_call_output_content.delta`.
|
|
1009
1084
|
end
|
|
1010
1085
|
|
|
1011
1086
|
class BetaResponseShellCallOutputContentWsDone < OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent
|
|
@@ -1017,27 +1092,32 @@ module OpenAI
|
|
|
1017
1092
|
optional :stream_id, String
|
|
1018
1093
|
|
|
1019
1094
|
# @!method initialize(command_index:, item_id:, output:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.shell_call_output_content.done")
|
|
1020
|
-
# Some parameter documentations has been truncated, see
|
|
1021
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseShellCallOutputContentWsDone}
|
|
1022
|
-
# for more details.
|
|
1023
|
-
#
|
|
1024
1095
|
# A streaming event that indicated shell call output was completed.
|
|
1025
1096
|
#
|
|
1026
|
-
# @param command_index [Integer]
|
|
1097
|
+
# @param command_index [Integer]
|
|
1098
|
+
# The index of the shell command that produced output.
|
|
1027
1099
|
#
|
|
1028
|
-
# @param item_id [String]
|
|
1100
|
+
# @param item_id [String]
|
|
1101
|
+
# The ID of the output item that was updated.
|
|
1029
1102
|
#
|
|
1030
|
-
# @param output [Array<OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output>]
|
|
1103
|
+
# @param output [Array<OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output>]
|
|
1104
|
+
# The output contents emitted for the shell command.
|
|
1031
1105
|
#
|
|
1032
|
-
# @param output_index [Integer]
|
|
1106
|
+
# @param output_index [Integer]
|
|
1107
|
+
# The index of the output item that was updated.
|
|
1033
1108
|
#
|
|
1034
|
-
# @param sequence_number [Integer]
|
|
1109
|
+
# @param sequence_number [Integer]
|
|
1110
|
+
# The sequence number of the event that was emitted.
|
|
1035
1111
|
#
|
|
1036
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Agent]
|
|
1112
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Agent]
|
|
1113
|
+
# The agent that owns this multi-agent streaming event.
|
|
1037
1114
|
#
|
|
1038
|
-
# @param stream_id [String]
|
|
1115
|
+
# @param stream_id [String]
|
|
1116
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1117
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1039
1118
|
#
|
|
1040
|
-
# @param type [Symbol, :"response.shell_call_output_content.done"]
|
|
1119
|
+
# @param type [Symbol, :"response.shell_call_output_content.done"]
|
|
1120
|
+
# The type of the event, always `response.shell_call_output_content.done`.
|
|
1041
1121
|
end
|
|
1042
1122
|
|
|
1043
1123
|
class BetaResponseInWsProgress < OpenAI::Models::Beta::BetaResponseInProgressEvent
|
|
@@ -1049,21 +1129,23 @@ module OpenAI
|
|
|
1049
1129
|
optional :stream_id, String
|
|
1050
1130
|
|
|
1051
1131
|
# @!method initialize(response:, sequence_number:, agent: nil, stream_id: nil, type: :"response.in_progress")
|
|
1052
|
-
# Some parameter documentations has been truncated, see
|
|
1053
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseInWsProgress} for
|
|
1054
|
-
# more details.
|
|
1055
|
-
#
|
|
1056
1132
|
# Emitted when the response is in progress.
|
|
1057
1133
|
#
|
|
1058
|
-
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
1134
|
+
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
1135
|
+
# The response that is in progress.
|
|
1059
1136
|
#
|
|
1060
|
-
# @param sequence_number [Integer]
|
|
1137
|
+
# @param sequence_number [Integer]
|
|
1138
|
+
# The sequence number of this event.
|
|
1061
1139
|
#
|
|
1062
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseInProgressEvent::Agent, nil]
|
|
1140
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseInProgressEvent::Agent, nil]
|
|
1141
|
+
# The agent that owns this multi-agent streaming event.
|
|
1063
1142
|
#
|
|
1064
|
-
# @param stream_id [String]
|
|
1143
|
+
# @param stream_id [String]
|
|
1144
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1145
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1065
1146
|
#
|
|
1066
|
-
# @param type [Symbol, :"response.in_progress"]
|
|
1147
|
+
# @param type [Symbol, :"response.in_progress"]
|
|
1148
|
+
# The type of the event. Always `response.in_progress`.
|
|
1067
1149
|
end
|
|
1068
1150
|
|
|
1069
1151
|
class BetaResponseWsFailed < OpenAI::Models::Beta::BetaResponseFailedEvent
|
|
@@ -1075,21 +1157,23 @@ module OpenAI
|
|
|
1075
1157
|
optional :stream_id, String
|
|
1076
1158
|
|
|
1077
1159
|
# @!method initialize(response:, sequence_number:, agent: nil, stream_id: nil, type: :"response.failed")
|
|
1078
|
-
# Some parameter documentations has been truncated, see
|
|
1079
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsFailed} for more
|
|
1080
|
-
# details.
|
|
1081
|
-
#
|
|
1082
1160
|
# An event that is emitted when a response fails.
|
|
1083
1161
|
#
|
|
1084
|
-
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
1162
|
+
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
1163
|
+
# The response that failed.
|
|
1085
1164
|
#
|
|
1086
|
-
# @param sequence_number [Integer]
|
|
1165
|
+
# @param sequence_number [Integer]
|
|
1166
|
+
# The sequence number of this event.
|
|
1087
1167
|
#
|
|
1088
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseFailedEvent::Agent, nil]
|
|
1168
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseFailedEvent::Agent, nil]
|
|
1169
|
+
# The agent that owns this multi-agent streaming event.
|
|
1089
1170
|
#
|
|
1090
|
-
# @param stream_id [String]
|
|
1171
|
+
# @param stream_id [String]
|
|
1172
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1173
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1091
1174
|
#
|
|
1092
|
-
# @param type [Symbol, :"response.failed"]
|
|
1175
|
+
# @param type [Symbol, :"response.failed"]
|
|
1176
|
+
# The type of the event. Always `response.failed`.
|
|
1093
1177
|
end
|
|
1094
1178
|
|
|
1095
1179
|
class BetaResponseWsIncomplete < OpenAI::Models::Beta::BetaResponseIncompleteEvent
|
|
@@ -1101,25 +1185,27 @@ module OpenAI
|
|
|
1101
1185
|
optional :stream_id, String
|
|
1102
1186
|
|
|
1103
1187
|
# @!method initialize(response:, sequence_number:, agent: nil, stream_id: nil, type: :"response.incomplete")
|
|
1104
|
-
# Some parameter documentations has been truncated, see
|
|
1105
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsIncomplete} for
|
|
1106
|
-
# more details.
|
|
1107
|
-
#
|
|
1108
1188
|
# An event that is emitted when a response finishes as incomplete.
|
|
1109
1189
|
#
|
|
1110
1190
|
# Over WebSocket, steering can finish a response with
|
|
1111
1191
|
# `response.incomplete_details.reason` set to `steered`, followed automatically by
|
|
1112
1192
|
# a successor `response.created` that commits the queued steering input.
|
|
1113
1193
|
#
|
|
1114
|
-
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
1194
|
+
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
1195
|
+
# The response that was incomplete.
|
|
1115
1196
|
#
|
|
1116
|
-
# @param sequence_number [Integer]
|
|
1197
|
+
# @param sequence_number [Integer]
|
|
1198
|
+
# The sequence number of this event.
|
|
1117
1199
|
#
|
|
1118
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseIncompleteEvent::Agent, nil]
|
|
1200
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseIncompleteEvent::Agent, nil]
|
|
1201
|
+
# The agent that owns this multi-agent streaming event.
|
|
1119
1202
|
#
|
|
1120
|
-
# @param stream_id [String]
|
|
1203
|
+
# @param stream_id [String]
|
|
1204
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1205
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1121
1206
|
#
|
|
1122
|
-
# @param type [Symbol, :"response.incomplete"]
|
|
1207
|
+
# @param type [Symbol, :"response.incomplete"]
|
|
1208
|
+
# The type of the event. Always `response.incomplete`.
|
|
1123
1209
|
end
|
|
1124
1210
|
|
|
1125
1211
|
class BetaResponseOutputItemWsAdded < OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent
|
|
@@ -1131,23 +1217,29 @@ module OpenAI
|
|
|
1131
1217
|
optional :stream_id, String
|
|
1132
1218
|
|
|
1133
1219
|
# @!method initialize(item:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.output_item.added")
|
|
1134
|
-
# Some parameter documentations has been truncated, see
|
|
1135
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseOutputItemWsAdded}
|
|
1136
|
-
# for more details.
|
|
1137
|
-
#
|
|
1138
1220
|
# Emitted when a new output item is added.
|
|
1139
1221
|
#
|
|
1140
|
-
# @param item [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem]
|
|
1222
|
+
# @param item [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem]
|
|
1223
|
+
# The output item that was added. For reasoning items, `encrypted_content` may be
|
|
1224
|
+
# incomplete while the item is in progress. Use the reasoning item from the
|
|
1225
|
+
# corresponding `response.output_item.done` event when passing it as input to a
|
|
1226
|
+
# subsequent request.
|
|
1141
1227
|
#
|
|
1142
|
-
# @param output_index [Integer]
|
|
1228
|
+
# @param output_index [Integer]
|
|
1229
|
+
# The index of the output item that was added.
|
|
1143
1230
|
#
|
|
1144
|
-
# @param sequence_number [Integer]
|
|
1231
|
+
# @param sequence_number [Integer]
|
|
1232
|
+
# The sequence number of this event.
|
|
1145
1233
|
#
|
|
1146
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent::Agent, nil]
|
|
1234
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent::Agent, nil]
|
|
1235
|
+
# The agent that owns this multi-agent streaming event.
|
|
1147
1236
|
#
|
|
1148
|
-
# @param stream_id [String]
|
|
1237
|
+
# @param stream_id [String]
|
|
1238
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1239
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1149
1240
|
#
|
|
1150
|
-
# @param type [Symbol, :"response.output_item.added"]
|
|
1241
|
+
# @param type [Symbol, :"response.output_item.added"]
|
|
1242
|
+
# The type of the event. Always `response.output_item.added`.
|
|
1151
1243
|
end
|
|
1152
1244
|
|
|
1153
1245
|
class BetaResponseOutputItemWsDone < OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent
|
|
@@ -1159,23 +1251,26 @@ module OpenAI
|
|
|
1159
1251
|
optional :stream_id, String
|
|
1160
1252
|
|
|
1161
1253
|
# @!method initialize(item:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.output_item.done")
|
|
1162
|
-
# Some parameter documentations has been truncated, see
|
|
1163
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseOutputItemWsDone}
|
|
1164
|
-
# for more details.
|
|
1165
|
-
#
|
|
1166
1254
|
# Emitted when an output item is marked done.
|
|
1167
1255
|
#
|
|
1168
|
-
# @param item [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem]
|
|
1256
|
+
# @param item [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem]
|
|
1257
|
+
# The output item that was marked done.
|
|
1169
1258
|
#
|
|
1170
|
-
# @param output_index [Integer]
|
|
1259
|
+
# @param output_index [Integer]
|
|
1260
|
+
# The index of the output item that was marked done.
|
|
1171
1261
|
#
|
|
1172
|
-
# @param sequence_number [Integer]
|
|
1262
|
+
# @param sequence_number [Integer]
|
|
1263
|
+
# The sequence number of this event.
|
|
1173
1264
|
#
|
|
1174
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent::Agent, nil]
|
|
1265
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent::Agent, nil]
|
|
1266
|
+
# The agent that owns this multi-agent streaming event.
|
|
1175
1267
|
#
|
|
1176
|
-
# @param stream_id [String]
|
|
1268
|
+
# @param stream_id [String]
|
|
1269
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1270
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1177
1271
|
#
|
|
1178
|
-
# @param type [Symbol, :"response.output_item.done"]
|
|
1272
|
+
# @param type [Symbol, :"response.output_item.done"]
|
|
1273
|
+
# The type of the event. Always `response.output_item.done`.
|
|
1179
1274
|
end
|
|
1180
1275
|
|
|
1181
1276
|
class BetaResponseReasoningSummaryPartWsAdded < OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent
|
|
@@ -1187,27 +1282,32 @@ module OpenAI
|
|
|
1187
1282
|
optional :stream_id, String
|
|
1188
1283
|
|
|
1189
1284
|
# @!method initialize(item_id:, output_index:, part:, sequence_number:, summary_index:, agent: nil, stream_id: nil, type: :"response.reasoning_summary_part.added")
|
|
1190
|
-
# Some parameter documentations has been truncated, see
|
|
1191
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseReasoningSummaryPartWsAdded}
|
|
1192
|
-
# for more details.
|
|
1193
|
-
#
|
|
1194
1285
|
# Emitted when a new reasoning summary part is added.
|
|
1195
1286
|
#
|
|
1196
|
-
# @param item_id [String]
|
|
1287
|
+
# @param item_id [String]
|
|
1288
|
+
# The ID of the item this summary part is associated with.
|
|
1197
1289
|
#
|
|
1198
|
-
# @param output_index [Integer]
|
|
1290
|
+
# @param output_index [Integer]
|
|
1291
|
+
# The index of the output item this summary part is associated with.
|
|
1199
1292
|
#
|
|
1200
|
-
# @param part [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent::Part]
|
|
1293
|
+
# @param part [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent::Part]
|
|
1294
|
+
# The summary part that was added.
|
|
1201
1295
|
#
|
|
1202
|
-
# @param sequence_number [Integer]
|
|
1296
|
+
# @param sequence_number [Integer]
|
|
1297
|
+
# The sequence number of this event.
|
|
1203
1298
|
#
|
|
1204
|
-
# @param summary_index [Integer]
|
|
1299
|
+
# @param summary_index [Integer]
|
|
1300
|
+
# The index of the summary part within the reasoning summary.
|
|
1205
1301
|
#
|
|
1206
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent::Agent, nil]
|
|
1302
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent::Agent, nil]
|
|
1303
|
+
# The agent that owns this multi-agent streaming event.
|
|
1207
1304
|
#
|
|
1208
|
-
# @param stream_id [String]
|
|
1305
|
+
# @param stream_id [String]
|
|
1306
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1307
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1209
1308
|
#
|
|
1210
|
-
# @param type [Symbol, :"response.reasoning_summary_part.added"]
|
|
1309
|
+
# @param type [Symbol, :"response.reasoning_summary_part.added"]
|
|
1310
|
+
# The type of the event. Always `response.reasoning_summary_part.added`.
|
|
1211
1311
|
end
|
|
1212
1312
|
|
|
1213
1313
|
class BetaResponseReasoningSummaryPartWsDone < OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent
|
|
@@ -1219,29 +1319,36 @@ module OpenAI
|
|
|
1219
1319
|
optional :stream_id, String
|
|
1220
1320
|
|
|
1221
1321
|
# @!method initialize(item_id:, output_index:, part:, sequence_number:, summary_index:, agent: nil, status: nil, stream_id: nil, type: :"response.reasoning_summary_part.done")
|
|
1222
|
-
# Some parameter documentations has been truncated, see
|
|
1223
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseReasoningSummaryPartWsDone}
|
|
1224
|
-
# for more details.
|
|
1225
|
-
#
|
|
1226
1322
|
# Emitted when a reasoning summary part is completed.
|
|
1227
1323
|
#
|
|
1228
|
-
# @param item_id [String]
|
|
1324
|
+
# @param item_id [String]
|
|
1325
|
+
# The ID of the item this summary part is associated with.
|
|
1229
1326
|
#
|
|
1230
|
-
# @param output_index [Integer]
|
|
1327
|
+
# @param output_index [Integer]
|
|
1328
|
+
# The index of the output item this summary part is associated with.
|
|
1231
1329
|
#
|
|
1232
|
-
# @param part [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part]
|
|
1330
|
+
# @param part [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part]
|
|
1331
|
+
# The completed summary part.
|
|
1233
1332
|
#
|
|
1234
|
-
# @param sequence_number [Integer]
|
|
1333
|
+
# @param sequence_number [Integer]
|
|
1334
|
+
# The sequence number of this event.
|
|
1235
1335
|
#
|
|
1236
|
-
# @param summary_index [Integer]
|
|
1336
|
+
# @param summary_index [Integer]
|
|
1337
|
+
# The index of the summary part within the reasoning summary.
|
|
1237
1338
|
#
|
|
1238
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Agent, nil]
|
|
1339
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Agent, nil]
|
|
1340
|
+
# The agent that owns this multi-agent streaming event.
|
|
1239
1341
|
#
|
|
1240
|
-
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Status]
|
|
1342
|
+
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Status]
|
|
1343
|
+
# The completion status of the summary part. Omitted when the part completed
|
|
1344
|
+
# normally and set to `incomplete` when generation was interrupted.
|
|
1241
1345
|
#
|
|
1242
|
-
# @param stream_id [String]
|
|
1346
|
+
# @param stream_id [String]
|
|
1347
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1348
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1243
1349
|
#
|
|
1244
|
-
# @param type [Symbol, :"response.reasoning_summary_part.done"]
|
|
1350
|
+
# @param type [Symbol, :"response.reasoning_summary_part.done"]
|
|
1351
|
+
# The type of the event. Always `response.reasoning_summary_part.done`.
|
|
1245
1352
|
end
|
|
1246
1353
|
|
|
1247
1354
|
class BetaResponseReasoningSummaryTextWsDelta < OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent
|
|
@@ -1253,27 +1360,32 @@ module OpenAI
|
|
|
1253
1360
|
optional :stream_id, String
|
|
1254
1361
|
|
|
1255
1362
|
# @!method initialize(delta:, item_id:, output_index:, sequence_number:, summary_index:, agent: nil, stream_id: nil, type: :"response.reasoning_summary_text.delta")
|
|
1256
|
-
# Some parameter documentations has been truncated, see
|
|
1257
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseReasoningSummaryTextWsDelta}
|
|
1258
|
-
# for more details.
|
|
1259
|
-
#
|
|
1260
1363
|
# Emitted when a delta is added to a reasoning summary text.
|
|
1261
1364
|
#
|
|
1262
|
-
# @param delta [String]
|
|
1365
|
+
# @param delta [String]
|
|
1366
|
+
# The text delta that was added to the summary.
|
|
1263
1367
|
#
|
|
1264
|
-
# @param item_id [String]
|
|
1368
|
+
# @param item_id [String]
|
|
1369
|
+
# The ID of the item this summary text delta is associated with.
|
|
1265
1370
|
#
|
|
1266
|
-
# @param output_index [Integer]
|
|
1371
|
+
# @param output_index [Integer]
|
|
1372
|
+
# The index of the output item this summary text delta is associated with.
|
|
1267
1373
|
#
|
|
1268
|
-
# @param sequence_number [Integer]
|
|
1374
|
+
# @param sequence_number [Integer]
|
|
1375
|
+
# The sequence number of this event.
|
|
1269
1376
|
#
|
|
1270
|
-
# @param summary_index [Integer]
|
|
1377
|
+
# @param summary_index [Integer]
|
|
1378
|
+
# The index of the summary part within the reasoning summary.
|
|
1271
1379
|
#
|
|
1272
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent::Agent, nil]
|
|
1380
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent::Agent, nil]
|
|
1381
|
+
# The agent that owns this multi-agent streaming event.
|
|
1273
1382
|
#
|
|
1274
|
-
# @param stream_id [String]
|
|
1383
|
+
# @param stream_id [String]
|
|
1384
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1385
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1275
1386
|
#
|
|
1276
|
-
# @param type [Symbol, :"response.reasoning_summary_text.delta"]
|
|
1387
|
+
# @param type [Symbol, :"response.reasoning_summary_text.delta"]
|
|
1388
|
+
# The type of the event. Always `response.reasoning_summary_text.delta`.
|
|
1277
1389
|
end
|
|
1278
1390
|
|
|
1279
1391
|
class BetaResponseReasoningSummaryTextWsDone < OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent
|
|
@@ -1285,27 +1397,32 @@ module OpenAI
|
|
|
1285
1397
|
optional :stream_id, String
|
|
1286
1398
|
|
|
1287
1399
|
# @!method initialize(item_id:, output_index:, sequence_number:, summary_index:, text:, agent: nil, stream_id: nil, type: :"response.reasoning_summary_text.done")
|
|
1288
|
-
# Some parameter documentations has been truncated, see
|
|
1289
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseReasoningSummaryTextWsDone}
|
|
1290
|
-
# for more details.
|
|
1291
|
-
#
|
|
1292
1400
|
# Emitted when a reasoning summary text is completed.
|
|
1293
1401
|
#
|
|
1294
|
-
# @param item_id [String]
|
|
1402
|
+
# @param item_id [String]
|
|
1403
|
+
# The ID of the item this summary text is associated with.
|
|
1295
1404
|
#
|
|
1296
|
-
# @param output_index [Integer]
|
|
1405
|
+
# @param output_index [Integer]
|
|
1406
|
+
# The index of the output item this summary text is associated with.
|
|
1297
1407
|
#
|
|
1298
|
-
# @param sequence_number [Integer]
|
|
1408
|
+
# @param sequence_number [Integer]
|
|
1409
|
+
# The sequence number of this event.
|
|
1299
1410
|
#
|
|
1300
|
-
# @param summary_index [Integer]
|
|
1411
|
+
# @param summary_index [Integer]
|
|
1412
|
+
# The index of the summary part within the reasoning summary.
|
|
1301
1413
|
#
|
|
1302
|
-
# @param text [String]
|
|
1414
|
+
# @param text [String]
|
|
1415
|
+
# The full text of the completed reasoning summary.
|
|
1303
1416
|
#
|
|
1304
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent::Agent, nil]
|
|
1417
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent::Agent, nil]
|
|
1418
|
+
# The agent that owns this multi-agent streaming event.
|
|
1305
1419
|
#
|
|
1306
|
-
# @param stream_id [String]
|
|
1420
|
+
# @param stream_id [String]
|
|
1421
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1422
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1307
1423
|
#
|
|
1308
|
-
# @param type [Symbol, :"response.reasoning_summary_text.done"]
|
|
1424
|
+
# @param type [Symbol, :"response.reasoning_summary_text.done"]
|
|
1425
|
+
# The type of the event. Always `response.reasoning_summary_text.done`.
|
|
1309
1426
|
end
|
|
1310
1427
|
|
|
1311
1428
|
class BetaResponseReasoningTextWsDelta < OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent
|
|
@@ -1317,27 +1434,32 @@ module OpenAI
|
|
|
1317
1434
|
optional :stream_id, String
|
|
1318
1435
|
|
|
1319
1436
|
# @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.reasoning_text.delta")
|
|
1320
|
-
# Some parameter documentations has been truncated, see
|
|
1321
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseReasoningTextWsDelta}
|
|
1322
|
-
# for more details.
|
|
1323
|
-
#
|
|
1324
1437
|
# Emitted when a delta is added to a reasoning text.
|
|
1325
1438
|
#
|
|
1326
|
-
# @param content_index [Integer]
|
|
1439
|
+
# @param content_index [Integer]
|
|
1440
|
+
# The index of the reasoning content part this delta is associated with.
|
|
1327
1441
|
#
|
|
1328
|
-
# @param delta [String]
|
|
1442
|
+
# @param delta [String]
|
|
1443
|
+
# The text delta that was added to the reasoning content.
|
|
1329
1444
|
#
|
|
1330
|
-
# @param item_id [String]
|
|
1445
|
+
# @param item_id [String]
|
|
1446
|
+
# The ID of the item this reasoning text delta is associated with.
|
|
1331
1447
|
#
|
|
1332
|
-
# @param output_index [Integer]
|
|
1448
|
+
# @param output_index [Integer]
|
|
1449
|
+
# The index of the output item this reasoning text delta is associated with.
|
|
1333
1450
|
#
|
|
1334
|
-
# @param sequence_number [Integer]
|
|
1451
|
+
# @param sequence_number [Integer]
|
|
1452
|
+
# The sequence number of this event.
|
|
1335
1453
|
#
|
|
1336
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent::Agent, nil]
|
|
1454
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent::Agent, nil]
|
|
1455
|
+
# The agent that owns this multi-agent streaming event.
|
|
1337
1456
|
#
|
|
1338
|
-
# @param stream_id [String]
|
|
1457
|
+
# @param stream_id [String]
|
|
1458
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1459
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1339
1460
|
#
|
|
1340
|
-
# @param type [Symbol, :"response.reasoning_text.delta"]
|
|
1461
|
+
# @param type [Symbol, :"response.reasoning_text.delta"]
|
|
1462
|
+
# The type of the event. Always `response.reasoning_text.delta`.
|
|
1341
1463
|
end
|
|
1342
1464
|
|
|
1343
1465
|
class BetaResponseReasoningTextWsDone < OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent
|
|
@@ -1349,27 +1471,32 @@ module OpenAI
|
|
|
1349
1471
|
optional :stream_id, String
|
|
1350
1472
|
|
|
1351
1473
|
# @!method initialize(content_index:, item_id:, output_index:, sequence_number:, text:, agent: nil, stream_id: nil, type: :"response.reasoning_text.done")
|
|
1352
|
-
# Some parameter documentations has been truncated, see
|
|
1353
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseReasoningTextWsDone}
|
|
1354
|
-
# for more details.
|
|
1355
|
-
#
|
|
1356
1474
|
# Emitted when a reasoning text is completed.
|
|
1357
1475
|
#
|
|
1358
|
-
# @param content_index [Integer]
|
|
1476
|
+
# @param content_index [Integer]
|
|
1477
|
+
# The index of the reasoning content part.
|
|
1359
1478
|
#
|
|
1360
|
-
# @param item_id [String]
|
|
1479
|
+
# @param item_id [String]
|
|
1480
|
+
# The ID of the item this reasoning text is associated with.
|
|
1361
1481
|
#
|
|
1362
|
-
# @param output_index [Integer]
|
|
1482
|
+
# @param output_index [Integer]
|
|
1483
|
+
# The index of the output item this reasoning text is associated with.
|
|
1363
1484
|
#
|
|
1364
|
-
# @param sequence_number [Integer]
|
|
1485
|
+
# @param sequence_number [Integer]
|
|
1486
|
+
# The sequence number of this event.
|
|
1365
1487
|
#
|
|
1366
|
-
# @param text [String]
|
|
1488
|
+
# @param text [String]
|
|
1489
|
+
# The full text of the completed reasoning content.
|
|
1367
1490
|
#
|
|
1368
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent::Agent, nil]
|
|
1491
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent::Agent, nil]
|
|
1492
|
+
# The agent that owns this multi-agent streaming event.
|
|
1369
1493
|
#
|
|
1370
|
-
# @param stream_id [String]
|
|
1494
|
+
# @param stream_id [String]
|
|
1495
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1496
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1371
1497
|
#
|
|
1372
|
-
# @param type [Symbol, :"response.reasoning_text.done"]
|
|
1498
|
+
# @param type [Symbol, :"response.reasoning_text.done"]
|
|
1499
|
+
# The type of the event. Always `response.reasoning_text.done`.
|
|
1373
1500
|
end
|
|
1374
1501
|
|
|
1375
1502
|
class BetaResponseRefusalWsDelta < OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent
|
|
@@ -1381,27 +1508,32 @@ module OpenAI
|
|
|
1381
1508
|
optional :stream_id, String
|
|
1382
1509
|
|
|
1383
1510
|
# @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.refusal.delta")
|
|
1384
|
-
# Some parameter documentations has been truncated, see
|
|
1385
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseRefusalWsDelta} for
|
|
1386
|
-
# more details.
|
|
1387
|
-
#
|
|
1388
1511
|
# Emitted when there is a partial refusal text.
|
|
1389
1512
|
#
|
|
1390
|
-
# @param content_index [Integer]
|
|
1513
|
+
# @param content_index [Integer]
|
|
1514
|
+
# The index of the content part that the refusal text is added to.
|
|
1391
1515
|
#
|
|
1392
|
-
# @param delta [String]
|
|
1516
|
+
# @param delta [String]
|
|
1517
|
+
# The refusal text that is added.
|
|
1393
1518
|
#
|
|
1394
|
-
# @param item_id [String]
|
|
1519
|
+
# @param item_id [String]
|
|
1520
|
+
# The ID of the output item that the refusal text is added to.
|
|
1395
1521
|
#
|
|
1396
|
-
# @param output_index [Integer]
|
|
1522
|
+
# @param output_index [Integer]
|
|
1523
|
+
# The index of the output item that the refusal text is added to.
|
|
1397
1524
|
#
|
|
1398
|
-
# @param sequence_number [Integer]
|
|
1525
|
+
# @param sequence_number [Integer]
|
|
1526
|
+
# The sequence number of this event.
|
|
1399
1527
|
#
|
|
1400
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent::Agent, nil]
|
|
1528
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent::Agent, nil]
|
|
1529
|
+
# The agent that owns this multi-agent streaming event.
|
|
1401
1530
|
#
|
|
1402
|
-
# @param stream_id [String]
|
|
1531
|
+
# @param stream_id [String]
|
|
1532
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1533
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1403
1534
|
#
|
|
1404
|
-
# @param type [Symbol, :"response.refusal.delta"]
|
|
1535
|
+
# @param type [Symbol, :"response.refusal.delta"]
|
|
1536
|
+
# The type of the event. Always `response.refusal.delta`.
|
|
1405
1537
|
end
|
|
1406
1538
|
|
|
1407
1539
|
class BetaResponseRefusalWsDone < OpenAI::Models::Beta::BetaResponseRefusalDoneEvent
|
|
@@ -1413,27 +1545,32 @@ module OpenAI
|
|
|
1413
1545
|
optional :stream_id, String
|
|
1414
1546
|
|
|
1415
1547
|
# @!method initialize(content_index:, item_id:, output_index:, refusal:, sequence_number:, agent: nil, stream_id: nil, type: :"response.refusal.done")
|
|
1416
|
-
# Some parameter documentations has been truncated, see
|
|
1417
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseRefusalWsDone} for
|
|
1418
|
-
# more details.
|
|
1419
|
-
#
|
|
1420
1548
|
# Emitted when refusal text is finalized.
|
|
1421
1549
|
#
|
|
1422
|
-
# @param content_index [Integer]
|
|
1550
|
+
# @param content_index [Integer]
|
|
1551
|
+
# The index of the content part that the refusal text is finalized.
|
|
1423
1552
|
#
|
|
1424
|
-
# @param item_id [String]
|
|
1553
|
+
# @param item_id [String]
|
|
1554
|
+
# The ID of the output item that the refusal text is finalized.
|
|
1425
1555
|
#
|
|
1426
|
-
# @param output_index [Integer]
|
|
1556
|
+
# @param output_index [Integer]
|
|
1557
|
+
# The index of the output item that the refusal text is finalized.
|
|
1427
1558
|
#
|
|
1428
|
-
# @param refusal [String]
|
|
1559
|
+
# @param refusal [String]
|
|
1560
|
+
# The refusal text that is finalized.
|
|
1429
1561
|
#
|
|
1430
|
-
# @param sequence_number [Integer]
|
|
1562
|
+
# @param sequence_number [Integer]
|
|
1563
|
+
# The sequence number of this event.
|
|
1431
1564
|
#
|
|
1432
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseRefusalDoneEvent::Agent, nil]
|
|
1565
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseRefusalDoneEvent::Agent, nil]
|
|
1566
|
+
# The agent that owns this multi-agent streaming event.
|
|
1433
1567
|
#
|
|
1434
|
-
# @param stream_id [String]
|
|
1568
|
+
# @param stream_id [String]
|
|
1569
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1570
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1435
1571
|
#
|
|
1436
|
-
# @param type [Symbol, :"response.refusal.done"]
|
|
1572
|
+
# @param type [Symbol, :"response.refusal.done"]
|
|
1573
|
+
# The type of the event. Always `response.refusal.done`.
|
|
1437
1574
|
end
|
|
1438
1575
|
|
|
1439
1576
|
class BetaResponseTextWsDelta < OpenAI::Models::Beta::BetaResponseTextDeltaEvent
|
|
@@ -1445,29 +1582,35 @@ module OpenAI
|
|
|
1445
1582
|
optional :stream_id, String
|
|
1446
1583
|
|
|
1447
1584
|
# @!method initialize(content_index:, delta:, item_id:, logprobs:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.output_text.delta")
|
|
1448
|
-
# Some parameter documentations has been truncated, see
|
|
1449
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseTextWsDelta} for
|
|
1450
|
-
# more details.
|
|
1451
|
-
#
|
|
1452
1585
|
# Emitted when there is an additional text delta.
|
|
1453
1586
|
#
|
|
1454
|
-
# @param content_index [Integer]
|
|
1587
|
+
# @param content_index [Integer]
|
|
1588
|
+
# The index of the content part that the text delta was added to.
|
|
1455
1589
|
#
|
|
1456
|
-
# @param delta [String]
|
|
1590
|
+
# @param delta [String]
|
|
1591
|
+
# The text delta that was added.
|
|
1457
1592
|
#
|
|
1458
|
-
# @param item_id [String]
|
|
1593
|
+
# @param item_id [String]
|
|
1594
|
+
# The ID of the output item that the text delta was added to.
|
|
1459
1595
|
#
|
|
1460
|
-
# @param logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob>]
|
|
1596
|
+
# @param logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob>]
|
|
1597
|
+
# The log probabilities of the tokens in the delta.
|
|
1461
1598
|
#
|
|
1462
|
-
# @param output_index [Integer]
|
|
1599
|
+
# @param output_index [Integer]
|
|
1600
|
+
# The index of the output item that the text delta was added to.
|
|
1463
1601
|
#
|
|
1464
|
-
# @param sequence_number [Integer]
|
|
1602
|
+
# @param sequence_number [Integer]
|
|
1603
|
+
# The sequence number for this event.
|
|
1465
1604
|
#
|
|
1466
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Agent, nil]
|
|
1605
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Agent, nil]
|
|
1606
|
+
# The agent that owns this multi-agent streaming event.
|
|
1467
1607
|
#
|
|
1468
|
-
# @param stream_id [String]
|
|
1608
|
+
# @param stream_id [String]
|
|
1609
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1610
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1469
1611
|
#
|
|
1470
|
-
# @param type [Symbol, :"response.output_text.delta"]
|
|
1612
|
+
# @param type [Symbol, :"response.output_text.delta"]
|
|
1613
|
+
# The type of the event. Always `response.output_text.delta`.
|
|
1471
1614
|
end
|
|
1472
1615
|
|
|
1473
1616
|
class BetaResponseTextWsDone < OpenAI::Models::Beta::BetaResponseTextDoneEvent
|
|
@@ -1479,29 +1622,35 @@ module OpenAI
|
|
|
1479
1622
|
optional :stream_id, String
|
|
1480
1623
|
|
|
1481
1624
|
# @!method initialize(content_index:, item_id:, logprobs:, output_index:, sequence_number:, text:, agent: nil, stream_id: nil, type: :"response.output_text.done")
|
|
1482
|
-
# Some parameter documentations has been truncated, see
|
|
1483
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseTextWsDone} for
|
|
1484
|
-
# more details.
|
|
1485
|
-
#
|
|
1486
1625
|
# Emitted when text content is finalized.
|
|
1487
1626
|
#
|
|
1488
|
-
# @param content_index [Integer]
|
|
1627
|
+
# @param content_index [Integer]
|
|
1628
|
+
# The index of the content part that the text content is finalized.
|
|
1489
1629
|
#
|
|
1490
|
-
# @param item_id [String]
|
|
1630
|
+
# @param item_id [String]
|
|
1631
|
+
# The ID of the output item that the text content is finalized.
|
|
1491
1632
|
#
|
|
1492
|
-
# @param logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDoneEvent::Logprob>]
|
|
1633
|
+
# @param logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDoneEvent::Logprob>]
|
|
1634
|
+
# The log probabilities of the tokens in the delta.
|
|
1493
1635
|
#
|
|
1494
|
-
# @param output_index [Integer]
|
|
1636
|
+
# @param output_index [Integer]
|
|
1637
|
+
# The index of the output item that the text content is finalized.
|
|
1495
1638
|
#
|
|
1496
|
-
# @param sequence_number [Integer]
|
|
1639
|
+
# @param sequence_number [Integer]
|
|
1640
|
+
# The sequence number for this event.
|
|
1497
1641
|
#
|
|
1498
|
-
# @param text [String]
|
|
1642
|
+
# @param text [String]
|
|
1643
|
+
# The text content that is finalized.
|
|
1499
1644
|
#
|
|
1500
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseTextDoneEvent::Agent, nil]
|
|
1645
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseTextDoneEvent::Agent, nil]
|
|
1646
|
+
# The agent that owns this multi-agent streaming event.
|
|
1501
1647
|
#
|
|
1502
|
-
# @param stream_id [String]
|
|
1648
|
+
# @param stream_id [String]
|
|
1649
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1650
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1503
1651
|
#
|
|
1504
|
-
# @param type [Symbol, :"response.output_text.done"]
|
|
1652
|
+
# @param type [Symbol, :"response.output_text.done"]
|
|
1653
|
+
# The type of the event. Always `response.output_text.done`.
|
|
1505
1654
|
end
|
|
1506
1655
|
|
|
1507
1656
|
class BetaResponseWebSearchCallWsCompleted < OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent
|
|
@@ -1513,23 +1662,26 @@ module OpenAI
|
|
|
1513
1662
|
optional :stream_id, String
|
|
1514
1663
|
|
|
1515
1664
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.web_search_call.completed")
|
|
1516
|
-
# Some parameter documentations has been truncated, see
|
|
1517
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWebSearchCallWsCompleted}
|
|
1518
|
-
# for more details.
|
|
1519
|
-
#
|
|
1520
1665
|
# Emitted when a web search call is completed.
|
|
1521
1666
|
#
|
|
1522
|
-
# @param item_id [String]
|
|
1667
|
+
# @param item_id [String]
|
|
1668
|
+
# Unique ID for the output item associated with the web search call.
|
|
1523
1669
|
#
|
|
1524
|
-
# @param output_index [Integer]
|
|
1670
|
+
# @param output_index [Integer]
|
|
1671
|
+
# The index of the output item that the web search call is associated with.
|
|
1525
1672
|
#
|
|
1526
|
-
# @param sequence_number [Integer]
|
|
1673
|
+
# @param sequence_number [Integer]
|
|
1674
|
+
# The sequence number of the web search call being processed.
|
|
1527
1675
|
#
|
|
1528
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent::Agent, nil]
|
|
1676
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent::Agent, nil]
|
|
1677
|
+
# The agent that owns this multi-agent streaming event.
|
|
1529
1678
|
#
|
|
1530
|
-
# @param stream_id [String]
|
|
1679
|
+
# @param stream_id [String]
|
|
1680
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1681
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1531
1682
|
#
|
|
1532
|
-
# @param type [Symbol, :"response.web_search_call.completed"]
|
|
1683
|
+
# @param type [Symbol, :"response.web_search_call.completed"]
|
|
1684
|
+
# The type of the event. Always `response.web_search_call.completed`.
|
|
1533
1685
|
end
|
|
1534
1686
|
|
|
1535
1687
|
class BetaResponseWebSearchCallInWsProgress < OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent
|
|
@@ -1541,23 +1693,26 @@ module OpenAI
|
|
|
1541
1693
|
optional :stream_id, String
|
|
1542
1694
|
|
|
1543
1695
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.web_search_call.in_progress")
|
|
1544
|
-
# Some parameter documentations has been truncated, see
|
|
1545
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWebSearchCallInWsProgress}
|
|
1546
|
-
# for more details.
|
|
1547
|
-
#
|
|
1548
1696
|
# Emitted when a web search call is initiated.
|
|
1549
1697
|
#
|
|
1550
|
-
# @param item_id [String]
|
|
1698
|
+
# @param item_id [String]
|
|
1699
|
+
# Unique ID for the output item associated with the web search call.
|
|
1551
1700
|
#
|
|
1552
|
-
# @param output_index [Integer]
|
|
1701
|
+
# @param output_index [Integer]
|
|
1702
|
+
# The index of the output item that the web search call is associated with.
|
|
1553
1703
|
#
|
|
1554
|
-
# @param sequence_number [Integer]
|
|
1704
|
+
# @param sequence_number [Integer]
|
|
1705
|
+
# The sequence number of the web search call being processed.
|
|
1555
1706
|
#
|
|
1556
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent::Agent, nil]
|
|
1707
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent::Agent, nil]
|
|
1708
|
+
# The agent that owns this multi-agent streaming event.
|
|
1557
1709
|
#
|
|
1558
|
-
# @param stream_id [String]
|
|
1710
|
+
# @param stream_id [String]
|
|
1711
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1712
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1559
1713
|
#
|
|
1560
|
-
# @param type [Symbol, :"response.web_search_call.in_progress"]
|
|
1714
|
+
# @param type [Symbol, :"response.web_search_call.in_progress"]
|
|
1715
|
+
# The type of the event. Always `response.web_search_call.in_progress`.
|
|
1561
1716
|
end
|
|
1562
1717
|
|
|
1563
1718
|
class BetaResponseWebSearchCallWsSearching < OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent
|
|
@@ -1569,23 +1724,26 @@ module OpenAI
|
|
|
1569
1724
|
optional :stream_id, String
|
|
1570
1725
|
|
|
1571
1726
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.web_search_call.searching")
|
|
1572
|
-
# Some parameter documentations has been truncated, see
|
|
1573
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWebSearchCallWsSearching}
|
|
1574
|
-
# for more details.
|
|
1575
|
-
#
|
|
1576
1727
|
# Emitted when a web search call is executing.
|
|
1577
1728
|
#
|
|
1578
|
-
# @param item_id [String]
|
|
1729
|
+
# @param item_id [String]
|
|
1730
|
+
# Unique ID for the output item associated with the web search call.
|
|
1579
1731
|
#
|
|
1580
|
-
# @param output_index [Integer]
|
|
1732
|
+
# @param output_index [Integer]
|
|
1733
|
+
# The index of the output item that the web search call is associated with.
|
|
1581
1734
|
#
|
|
1582
|
-
# @param sequence_number [Integer]
|
|
1735
|
+
# @param sequence_number [Integer]
|
|
1736
|
+
# The sequence number of the web search call being processed.
|
|
1583
1737
|
#
|
|
1584
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent::Agent, nil]
|
|
1738
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent::Agent, nil]
|
|
1739
|
+
# The agent that owns this multi-agent streaming event.
|
|
1585
1740
|
#
|
|
1586
|
-
# @param stream_id [String]
|
|
1741
|
+
# @param stream_id [String]
|
|
1742
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1743
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1587
1744
|
#
|
|
1588
|
-
# @param type [Symbol, :"response.web_search_call.searching"]
|
|
1745
|
+
# @param type [Symbol, :"response.web_search_call.searching"]
|
|
1746
|
+
# The type of the event. Always `response.web_search_call.searching`.
|
|
1589
1747
|
end
|
|
1590
1748
|
|
|
1591
1749
|
class BetaResponseImageGenCallWsCompleted < OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent
|
|
@@ -1597,24 +1755,27 @@ module OpenAI
|
|
|
1597
1755
|
optional :stream_id, String
|
|
1598
1756
|
|
|
1599
1757
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.image_generation_call.completed")
|
|
1600
|
-
# Some parameter documentations has been truncated, see
|
|
1601
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseImageGenCallWsCompleted}
|
|
1602
|
-
# for more details.
|
|
1603
|
-
#
|
|
1604
1758
|
# Emitted when an image generation tool call has completed and the final image is
|
|
1605
1759
|
# available.
|
|
1606
1760
|
#
|
|
1607
|
-
# @param item_id [String]
|
|
1761
|
+
# @param item_id [String]
|
|
1762
|
+
# The unique identifier of the image generation item being processed.
|
|
1608
1763
|
#
|
|
1609
|
-
# @param output_index [Integer]
|
|
1764
|
+
# @param output_index [Integer]
|
|
1765
|
+
# The index of the output item in the response's output array.
|
|
1610
1766
|
#
|
|
1611
|
-
# @param sequence_number [Integer]
|
|
1767
|
+
# @param sequence_number [Integer]
|
|
1768
|
+
# The sequence number of this event.
|
|
1612
1769
|
#
|
|
1613
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent::Agent, nil]
|
|
1770
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent::Agent, nil]
|
|
1771
|
+
# The agent that owns this multi-agent streaming event.
|
|
1614
1772
|
#
|
|
1615
|
-
# @param stream_id [String]
|
|
1773
|
+
# @param stream_id [String]
|
|
1774
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1775
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1616
1776
|
#
|
|
1617
|
-
# @param type [Symbol, :"response.image_generation_call.completed"]
|
|
1777
|
+
# @param type [Symbol, :"response.image_generation_call.completed"]
|
|
1778
|
+
# The type of the event. Always 'response.image_generation_call.completed'.
|
|
1618
1779
|
end
|
|
1619
1780
|
|
|
1620
1781
|
class BetaResponseImageGenCallWsGenerating < OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent
|
|
@@ -1626,24 +1787,27 @@ module OpenAI
|
|
|
1626
1787
|
optional :stream_id, String
|
|
1627
1788
|
|
|
1628
1789
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.image_generation_call.generating")
|
|
1629
|
-
# Some parameter documentations has been truncated, see
|
|
1630
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseImageGenCallWsGenerating}
|
|
1631
|
-
# for more details.
|
|
1632
|
-
#
|
|
1633
1790
|
# Emitted when an image generation tool call is actively generating an image
|
|
1634
1791
|
# (intermediate state).
|
|
1635
1792
|
#
|
|
1636
|
-
# @param item_id [String]
|
|
1793
|
+
# @param item_id [String]
|
|
1794
|
+
# The unique identifier of the image generation item being processed.
|
|
1637
1795
|
#
|
|
1638
|
-
# @param output_index [Integer]
|
|
1796
|
+
# @param output_index [Integer]
|
|
1797
|
+
# The index of the output item in the response's output array.
|
|
1639
1798
|
#
|
|
1640
|
-
# @param sequence_number [Integer]
|
|
1799
|
+
# @param sequence_number [Integer]
|
|
1800
|
+
# The sequence number of the image generation item being processed.
|
|
1641
1801
|
#
|
|
1642
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent::Agent, nil]
|
|
1802
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent::Agent, nil]
|
|
1803
|
+
# The agent that owns this multi-agent streaming event.
|
|
1643
1804
|
#
|
|
1644
|
-
# @param stream_id [String]
|
|
1805
|
+
# @param stream_id [String]
|
|
1806
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1807
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1645
1808
|
#
|
|
1646
|
-
# @param type [Symbol, :"response.image_generation_call.generating"]
|
|
1809
|
+
# @param type [Symbol, :"response.image_generation_call.generating"]
|
|
1810
|
+
# The type of the event. Always 'response.image_generation_call.generating'.
|
|
1647
1811
|
end
|
|
1648
1812
|
|
|
1649
1813
|
class BetaResponseImageGenCallInWsProgress < OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent
|
|
@@ -1655,23 +1819,26 @@ module OpenAI
|
|
|
1655
1819
|
optional :stream_id, String
|
|
1656
1820
|
|
|
1657
1821
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.image_generation_call.in_progress")
|
|
1658
|
-
# Some parameter documentations has been truncated, see
|
|
1659
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseImageGenCallInWsProgress}
|
|
1660
|
-
# for more details.
|
|
1661
|
-
#
|
|
1662
1822
|
# Emitted when an image generation tool call is in progress.
|
|
1663
1823
|
#
|
|
1664
|
-
# @param item_id [String]
|
|
1824
|
+
# @param item_id [String]
|
|
1825
|
+
# The unique identifier of the image generation item being processed.
|
|
1665
1826
|
#
|
|
1666
|
-
# @param output_index [Integer]
|
|
1827
|
+
# @param output_index [Integer]
|
|
1828
|
+
# The index of the output item in the response's output array.
|
|
1667
1829
|
#
|
|
1668
|
-
# @param sequence_number [Integer]
|
|
1830
|
+
# @param sequence_number [Integer]
|
|
1831
|
+
# The sequence number of the image generation item being processed.
|
|
1669
1832
|
#
|
|
1670
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent::Agent, nil]
|
|
1833
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent::Agent, nil]
|
|
1834
|
+
# The agent that owns this multi-agent streaming event.
|
|
1671
1835
|
#
|
|
1672
|
-
# @param stream_id [String]
|
|
1836
|
+
# @param stream_id [String]
|
|
1837
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1838
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1673
1839
|
#
|
|
1674
|
-
# @param type [Symbol, :"response.image_generation_call.in_progress"]
|
|
1840
|
+
# @param type [Symbol, :"response.image_generation_call.in_progress"]
|
|
1841
|
+
# The type of the event. Always 'response.image_generation_call.in_progress'.
|
|
1675
1842
|
end
|
|
1676
1843
|
|
|
1677
1844
|
class BetaResponseImageGenCallPartialWsImage < OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent
|
|
@@ -1683,35 +1850,45 @@ module OpenAI
|
|
|
1683
1850
|
optional :stream_id, String
|
|
1684
1851
|
|
|
1685
1852
|
# @!method initialize(item_id:, output_index:, partial_image_b64:, partial_image_index:, sequence_number:, agent: nil, background: nil, output_format: nil, quality: nil, size: nil, stream_id: nil, type: :"response.image_generation_call.partial_image")
|
|
1686
|
-
# Some parameter documentations has been truncated, see
|
|
1687
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseImageGenCallPartialWsImage}
|
|
1688
|
-
# for more details.
|
|
1689
|
-
#
|
|
1690
1853
|
# Emitted when a partial image is available during image generation streaming.
|
|
1691
1854
|
#
|
|
1692
|
-
# @param item_id [String]
|
|
1855
|
+
# @param item_id [String]
|
|
1856
|
+
# The unique identifier of the image generation item being processed.
|
|
1693
1857
|
#
|
|
1694
|
-
# @param output_index [Integer]
|
|
1858
|
+
# @param output_index [Integer]
|
|
1859
|
+
# The index of the output item in the response's output array.
|
|
1695
1860
|
#
|
|
1696
|
-
# @param partial_image_b64 [String]
|
|
1861
|
+
# @param partial_image_b64 [String]
|
|
1862
|
+
# Base64-encoded partial image data, suitable for rendering as an image.
|
|
1697
1863
|
#
|
|
1698
|
-
# @param partial_image_index [Integer]
|
|
1864
|
+
# @param partial_image_index [Integer]
|
|
1865
|
+
# 0-based index for the partial image (backend is 1-based, but this is 0-based for
|
|
1866
|
+
# the user).
|
|
1699
1867
|
#
|
|
1700
|
-
# @param sequence_number [Integer]
|
|
1868
|
+
# @param sequence_number [Integer]
|
|
1869
|
+
# The sequence number of the image generation item being processed.
|
|
1701
1870
|
#
|
|
1702
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent::Agent, nil]
|
|
1871
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent::Agent, nil]
|
|
1872
|
+
# The agent that owns this multi-agent streaming event.
|
|
1703
1873
|
#
|
|
1704
|
-
# @param background [String]
|
|
1874
|
+
# @param background [String]
|
|
1875
|
+
# The background setting that was used.
|
|
1705
1876
|
#
|
|
1706
|
-
# @param output_format [String]
|
|
1877
|
+
# @param output_format [String]
|
|
1878
|
+
# The output format that was used.
|
|
1707
1879
|
#
|
|
1708
|
-
# @param quality [String]
|
|
1880
|
+
# @param quality [String]
|
|
1881
|
+
# The image quality that was used.
|
|
1709
1882
|
#
|
|
1710
|
-
# @param size [String]
|
|
1883
|
+
# @param size [String]
|
|
1884
|
+
# The image size that was used.
|
|
1711
1885
|
#
|
|
1712
|
-
# @param stream_id [String]
|
|
1886
|
+
# @param stream_id [String]
|
|
1887
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1888
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1713
1889
|
#
|
|
1714
|
-
# @param type [Symbol, :"response.image_generation_call.partial_image"]
|
|
1890
|
+
# @param type [Symbol, :"response.image_generation_call.partial_image"]
|
|
1891
|
+
# The type of the event. Always 'response.image_generation_call.partial_image'.
|
|
1715
1892
|
end
|
|
1716
1893
|
|
|
1717
1894
|
class BetaResponseMcpCallArgumentsWsDelta < OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent
|
|
@@ -1723,26 +1900,31 @@ module OpenAI
|
|
|
1723
1900
|
optional :stream_id, String
|
|
1724
1901
|
|
|
1725
1902
|
# @!method initialize(delta:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.mcp_call_arguments.delta")
|
|
1726
|
-
# Some parameter documentations has been truncated, see
|
|
1727
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseMcpCallArgumentsWsDelta}
|
|
1728
|
-
# for more details.
|
|
1729
|
-
#
|
|
1730
1903
|
# Emitted when there is a delta (partial update) to the arguments of an MCP tool
|
|
1731
1904
|
# call.
|
|
1732
1905
|
#
|
|
1733
|
-
# @param delta [String]
|
|
1906
|
+
# @param delta [String]
|
|
1907
|
+
# A JSON string containing the partial update to the arguments for the MCP tool
|
|
1908
|
+
# call.
|
|
1734
1909
|
#
|
|
1735
|
-
# @param item_id [String]
|
|
1910
|
+
# @param item_id [String]
|
|
1911
|
+
# The unique identifier of the MCP tool call item being processed.
|
|
1736
1912
|
#
|
|
1737
|
-
# @param output_index [Integer]
|
|
1913
|
+
# @param output_index [Integer]
|
|
1914
|
+
# The index of the output item in the response's output array.
|
|
1738
1915
|
#
|
|
1739
|
-
# @param sequence_number [Integer]
|
|
1916
|
+
# @param sequence_number [Integer]
|
|
1917
|
+
# The sequence number of this event.
|
|
1740
1918
|
#
|
|
1741
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent::Agent, nil]
|
|
1919
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent::Agent, nil]
|
|
1920
|
+
# The agent that owns this multi-agent streaming event.
|
|
1742
1921
|
#
|
|
1743
|
-
# @param stream_id [String]
|
|
1922
|
+
# @param stream_id [String]
|
|
1923
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1924
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1744
1925
|
#
|
|
1745
|
-
# @param type [Symbol, :"response.mcp_call_arguments.delta"]
|
|
1926
|
+
# @param type [Symbol, :"response.mcp_call_arguments.delta"]
|
|
1927
|
+
# The type of the event. Always 'response.mcp_call_arguments.delta'.
|
|
1746
1928
|
end
|
|
1747
1929
|
|
|
1748
1930
|
class BetaResponseMcpCallArgumentsWsDone < OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent
|
|
@@ -1754,25 +1936,29 @@ module OpenAI
|
|
|
1754
1936
|
optional :stream_id, String
|
|
1755
1937
|
|
|
1756
1938
|
# @!method initialize(arguments:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.mcp_call_arguments.done")
|
|
1757
|
-
# Some parameter documentations has been truncated, see
|
|
1758
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseMcpCallArgumentsWsDone}
|
|
1759
|
-
# for more details.
|
|
1760
|
-
#
|
|
1761
1939
|
# Emitted when the arguments for an MCP tool call are finalized.
|
|
1762
1940
|
#
|
|
1763
|
-
# @param arguments [String]
|
|
1941
|
+
# @param arguments [String]
|
|
1942
|
+
# A JSON string containing the finalized arguments for the MCP tool call.
|
|
1764
1943
|
#
|
|
1765
|
-
# @param item_id [String]
|
|
1944
|
+
# @param item_id [String]
|
|
1945
|
+
# The unique identifier of the MCP tool call item being processed.
|
|
1766
1946
|
#
|
|
1767
|
-
# @param output_index [Integer]
|
|
1947
|
+
# @param output_index [Integer]
|
|
1948
|
+
# The index of the output item in the response's output array.
|
|
1768
1949
|
#
|
|
1769
|
-
# @param sequence_number [Integer]
|
|
1950
|
+
# @param sequence_number [Integer]
|
|
1951
|
+
# The sequence number of this event.
|
|
1770
1952
|
#
|
|
1771
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent::Agent, nil]
|
|
1953
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent::Agent, nil]
|
|
1954
|
+
# The agent that owns this multi-agent streaming event.
|
|
1772
1955
|
#
|
|
1773
|
-
# @param stream_id [String]
|
|
1956
|
+
# @param stream_id [String]
|
|
1957
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1958
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1774
1959
|
#
|
|
1775
|
-
# @param type [Symbol, :"response.mcp_call_arguments.done"]
|
|
1960
|
+
# @param type [Symbol, :"response.mcp_call_arguments.done"]
|
|
1961
|
+
# The type of the event. Always 'response.mcp_call_arguments.done'.
|
|
1776
1962
|
end
|
|
1777
1963
|
|
|
1778
1964
|
class BetaResponseMcpCallWsCompleted < OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent
|
|
@@ -1784,23 +1970,26 @@ module OpenAI
|
|
|
1784
1970
|
optional :stream_id, String
|
|
1785
1971
|
|
|
1786
1972
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.mcp_call.completed")
|
|
1787
|
-
# Some parameter documentations has been truncated, see
|
|
1788
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseMcpCallWsCompleted}
|
|
1789
|
-
# for more details.
|
|
1790
|
-
#
|
|
1791
1973
|
# Emitted when an MCP tool call has completed successfully.
|
|
1792
1974
|
#
|
|
1793
|
-
# @param item_id [String]
|
|
1975
|
+
# @param item_id [String]
|
|
1976
|
+
# The ID of the MCP tool call item that completed.
|
|
1794
1977
|
#
|
|
1795
|
-
# @param output_index [Integer]
|
|
1978
|
+
# @param output_index [Integer]
|
|
1979
|
+
# The index of the output item that completed.
|
|
1796
1980
|
#
|
|
1797
|
-
# @param sequence_number [Integer]
|
|
1981
|
+
# @param sequence_number [Integer]
|
|
1982
|
+
# The sequence number of this event.
|
|
1798
1983
|
#
|
|
1799
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent::Agent, nil]
|
|
1984
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent::Agent, nil]
|
|
1985
|
+
# The agent that owns this multi-agent streaming event.
|
|
1800
1986
|
#
|
|
1801
|
-
# @param stream_id [String]
|
|
1987
|
+
# @param stream_id [String]
|
|
1988
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
1989
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1802
1990
|
#
|
|
1803
|
-
# @param type [Symbol, :"response.mcp_call.completed"]
|
|
1991
|
+
# @param type [Symbol, :"response.mcp_call.completed"]
|
|
1992
|
+
# The type of the event. Always 'response.mcp_call.completed'.
|
|
1804
1993
|
end
|
|
1805
1994
|
|
|
1806
1995
|
class BetaResponseMcpCallWsFailed < OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent
|
|
@@ -1812,23 +2001,26 @@ module OpenAI
|
|
|
1812
2001
|
optional :stream_id, String
|
|
1813
2002
|
|
|
1814
2003
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.mcp_call.failed")
|
|
1815
|
-
# Some parameter documentations has been truncated, see
|
|
1816
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseMcpCallWsFailed}
|
|
1817
|
-
# for more details.
|
|
1818
|
-
#
|
|
1819
2004
|
# Emitted when an MCP tool call has failed.
|
|
1820
2005
|
#
|
|
1821
|
-
# @param item_id [String]
|
|
2006
|
+
# @param item_id [String]
|
|
2007
|
+
# The ID of the MCP tool call item that failed.
|
|
1822
2008
|
#
|
|
1823
|
-
# @param output_index [Integer]
|
|
2009
|
+
# @param output_index [Integer]
|
|
2010
|
+
# The index of the output item that failed.
|
|
1824
2011
|
#
|
|
1825
|
-
# @param sequence_number [Integer]
|
|
2012
|
+
# @param sequence_number [Integer]
|
|
2013
|
+
# The sequence number of this event.
|
|
1826
2014
|
#
|
|
1827
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent::Agent, nil]
|
|
2015
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent::Agent, nil]
|
|
2016
|
+
# The agent that owns this multi-agent streaming event.
|
|
1828
2017
|
#
|
|
1829
|
-
# @param stream_id [String]
|
|
2018
|
+
# @param stream_id [String]
|
|
2019
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2020
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1830
2021
|
#
|
|
1831
|
-
# @param type [Symbol, :"response.mcp_call.failed"]
|
|
2022
|
+
# @param type [Symbol, :"response.mcp_call.failed"]
|
|
2023
|
+
# The type of the event. Always 'response.mcp_call.failed'.
|
|
1832
2024
|
end
|
|
1833
2025
|
|
|
1834
2026
|
class BetaResponseMcpCallInWsProgress < OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent
|
|
@@ -1840,23 +2032,26 @@ module OpenAI
|
|
|
1840
2032
|
optional :stream_id, String
|
|
1841
2033
|
|
|
1842
2034
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.mcp_call.in_progress")
|
|
1843
|
-
# Some parameter documentations has been truncated, see
|
|
1844
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseMcpCallInWsProgress}
|
|
1845
|
-
# for more details.
|
|
1846
|
-
#
|
|
1847
2035
|
# Emitted when an MCP tool call is in progress.
|
|
1848
2036
|
#
|
|
1849
|
-
# @param item_id [String]
|
|
2037
|
+
# @param item_id [String]
|
|
2038
|
+
# The unique identifier of the MCP tool call item being processed.
|
|
1850
2039
|
#
|
|
1851
|
-
# @param output_index [Integer]
|
|
2040
|
+
# @param output_index [Integer]
|
|
2041
|
+
# The index of the output item in the response's output array.
|
|
1852
2042
|
#
|
|
1853
|
-
# @param sequence_number [Integer]
|
|
2043
|
+
# @param sequence_number [Integer]
|
|
2044
|
+
# The sequence number of this event.
|
|
1854
2045
|
#
|
|
1855
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent::Agent, nil]
|
|
2046
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent::Agent, nil]
|
|
2047
|
+
# The agent that owns this multi-agent streaming event.
|
|
1856
2048
|
#
|
|
1857
|
-
# @param stream_id [String]
|
|
2049
|
+
# @param stream_id [String]
|
|
2050
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2051
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1858
2052
|
#
|
|
1859
|
-
# @param type [Symbol, :"response.mcp_call.in_progress"]
|
|
2053
|
+
# @param type [Symbol, :"response.mcp_call.in_progress"]
|
|
2054
|
+
# The type of the event. Always 'response.mcp_call.in_progress'.
|
|
1860
2055
|
end
|
|
1861
2056
|
|
|
1862
2057
|
class BetaResponseMcpListToolsWsCompleted < OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent
|
|
@@ -1868,23 +2063,26 @@ module OpenAI
|
|
|
1868
2063
|
optional :stream_id, String
|
|
1869
2064
|
|
|
1870
2065
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.mcp_list_tools.completed")
|
|
1871
|
-
# Some parameter documentations has been truncated, see
|
|
1872
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseMcpListToolsWsCompleted}
|
|
1873
|
-
# for more details.
|
|
1874
|
-
#
|
|
1875
2066
|
# Emitted when the list of available MCP tools has been successfully retrieved.
|
|
1876
2067
|
#
|
|
1877
|
-
# @param item_id [String]
|
|
2068
|
+
# @param item_id [String]
|
|
2069
|
+
# The ID of the MCP tool call item that produced this output.
|
|
1878
2070
|
#
|
|
1879
|
-
# @param output_index [Integer]
|
|
2071
|
+
# @param output_index [Integer]
|
|
2072
|
+
# The index of the output item that was processed.
|
|
1880
2073
|
#
|
|
1881
|
-
# @param sequence_number [Integer]
|
|
2074
|
+
# @param sequence_number [Integer]
|
|
2075
|
+
# The sequence number of this event.
|
|
1882
2076
|
#
|
|
1883
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent::Agent, nil]
|
|
2077
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent::Agent, nil]
|
|
2078
|
+
# The agent that owns this multi-agent streaming event.
|
|
1884
2079
|
#
|
|
1885
|
-
# @param stream_id [String]
|
|
2080
|
+
# @param stream_id [String]
|
|
2081
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2082
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1886
2083
|
#
|
|
1887
|
-
# @param type [Symbol, :"response.mcp_list_tools.completed"]
|
|
2084
|
+
# @param type [Symbol, :"response.mcp_list_tools.completed"]
|
|
2085
|
+
# The type of the event. Always 'response.mcp_list_tools.completed'.
|
|
1888
2086
|
end
|
|
1889
2087
|
|
|
1890
2088
|
class BetaResponseMcpListToolsWsFailed < OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent
|
|
@@ -1896,23 +2094,26 @@ module OpenAI
|
|
|
1896
2094
|
optional :stream_id, String
|
|
1897
2095
|
|
|
1898
2096
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.mcp_list_tools.failed")
|
|
1899
|
-
# Some parameter documentations has been truncated, see
|
|
1900
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseMcpListToolsWsFailed}
|
|
1901
|
-
# for more details.
|
|
1902
|
-
#
|
|
1903
2097
|
# Emitted when the attempt to list available MCP tools has failed.
|
|
1904
2098
|
#
|
|
1905
|
-
# @param item_id [String]
|
|
2099
|
+
# @param item_id [String]
|
|
2100
|
+
# The ID of the MCP tool call item that failed.
|
|
1906
2101
|
#
|
|
1907
|
-
# @param output_index [Integer]
|
|
2102
|
+
# @param output_index [Integer]
|
|
2103
|
+
# The index of the output item that failed.
|
|
1908
2104
|
#
|
|
1909
|
-
# @param sequence_number [Integer]
|
|
2105
|
+
# @param sequence_number [Integer]
|
|
2106
|
+
# The sequence number of this event.
|
|
1910
2107
|
#
|
|
1911
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent::Agent, nil]
|
|
2108
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent::Agent, nil]
|
|
2109
|
+
# The agent that owns this multi-agent streaming event.
|
|
1912
2110
|
#
|
|
1913
|
-
# @param stream_id [String]
|
|
2111
|
+
# @param stream_id [String]
|
|
2112
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2113
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1914
2114
|
#
|
|
1915
|
-
# @param type [Symbol, :"response.mcp_list_tools.failed"]
|
|
2115
|
+
# @param type [Symbol, :"response.mcp_list_tools.failed"]
|
|
2116
|
+
# The type of the event. Always 'response.mcp_list_tools.failed'.
|
|
1916
2117
|
end
|
|
1917
2118
|
|
|
1918
2119
|
class BetaResponseMcpListToolsInWsProgress < OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent
|
|
@@ -1924,24 +2125,27 @@ module OpenAI
|
|
|
1924
2125
|
optional :stream_id, String
|
|
1925
2126
|
|
|
1926
2127
|
# @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.mcp_list_tools.in_progress")
|
|
1927
|
-
# Some parameter documentations has been truncated, see
|
|
1928
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseMcpListToolsInWsProgress}
|
|
1929
|
-
# for more details.
|
|
1930
|
-
#
|
|
1931
2128
|
# Emitted when the system is in the process of retrieving the list of available
|
|
1932
2129
|
# MCP tools.
|
|
1933
2130
|
#
|
|
1934
|
-
# @param item_id [String]
|
|
2131
|
+
# @param item_id [String]
|
|
2132
|
+
# The ID of the MCP tool call item that is being processed.
|
|
1935
2133
|
#
|
|
1936
|
-
# @param output_index [Integer]
|
|
2134
|
+
# @param output_index [Integer]
|
|
2135
|
+
# The index of the output item that is being processed.
|
|
1937
2136
|
#
|
|
1938
|
-
# @param sequence_number [Integer]
|
|
2137
|
+
# @param sequence_number [Integer]
|
|
2138
|
+
# The sequence number of this event.
|
|
1939
2139
|
#
|
|
1940
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent::Agent, nil]
|
|
2140
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent::Agent, nil]
|
|
2141
|
+
# The agent that owns this multi-agent streaming event.
|
|
1941
2142
|
#
|
|
1942
|
-
# @param stream_id [String]
|
|
2143
|
+
# @param stream_id [String]
|
|
2144
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2145
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1943
2146
|
#
|
|
1944
|
-
# @param type [Symbol, :"response.mcp_list_tools.in_progress"]
|
|
2147
|
+
# @param type [Symbol, :"response.mcp_list_tools.in_progress"]
|
|
2148
|
+
# The type of the event. Always 'response.mcp_list_tools.in_progress'.
|
|
1945
2149
|
end
|
|
1946
2150
|
|
|
1947
2151
|
class BetaResponseOutputTextAnnotationWsAdded < OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent
|
|
@@ -1953,29 +2157,35 @@ module OpenAI
|
|
|
1953
2157
|
optional :stream_id, String
|
|
1954
2158
|
|
|
1955
2159
|
# @!method initialize(annotation:, annotation_index:, content_index:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.output_text.annotation.added")
|
|
1956
|
-
# Some parameter documentations has been truncated, see
|
|
1957
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseOutputTextAnnotationWsAdded}
|
|
1958
|
-
# for more details.
|
|
1959
|
-
#
|
|
1960
2160
|
# Emitted when an annotation is added to output text content.
|
|
1961
2161
|
#
|
|
1962
|
-
# @param annotation [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil]
|
|
2162
|
+
# @param annotation [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil]
|
|
2163
|
+
# An annotation that applies to a span of output text.
|
|
1963
2164
|
#
|
|
1964
|
-
# @param annotation_index [Integer]
|
|
2165
|
+
# @param annotation_index [Integer]
|
|
2166
|
+
# The index of the annotation within the content part.
|
|
1965
2167
|
#
|
|
1966
|
-
# @param content_index [Integer]
|
|
2168
|
+
# @param content_index [Integer]
|
|
2169
|
+
# The index of the content part within the output item.
|
|
1967
2170
|
#
|
|
1968
|
-
# @param item_id [String]
|
|
2171
|
+
# @param item_id [String]
|
|
2172
|
+
# The unique identifier of the item to which the annotation is being added.
|
|
1969
2173
|
#
|
|
1970
|
-
# @param output_index [Integer]
|
|
2174
|
+
# @param output_index [Integer]
|
|
2175
|
+
# The index of the output item in the response's output array.
|
|
1971
2176
|
#
|
|
1972
|
-
# @param sequence_number [Integer]
|
|
2177
|
+
# @param sequence_number [Integer]
|
|
2178
|
+
# The sequence number of this event.
|
|
1973
2179
|
#
|
|
1974
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Agent, nil]
|
|
2180
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Agent, nil]
|
|
2181
|
+
# The agent that owns this multi-agent streaming event.
|
|
1975
2182
|
#
|
|
1976
|
-
# @param stream_id [String]
|
|
2183
|
+
# @param stream_id [String]
|
|
2184
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2185
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
1977
2186
|
#
|
|
1978
|
-
# @param type [Symbol, :"response.output_text.annotation.added"]
|
|
2187
|
+
# @param type [Symbol, :"response.output_text.annotation.added"]
|
|
2188
|
+
# The type of the event. Always 'response.output_text.annotation.added'.
|
|
1979
2189
|
end
|
|
1980
2190
|
|
|
1981
2191
|
class BetaResponseWsQueued < OpenAI::Models::Beta::BetaResponseQueuedEvent
|
|
@@ -1987,21 +2197,23 @@ module OpenAI
|
|
|
1987
2197
|
optional :stream_id, String
|
|
1988
2198
|
|
|
1989
2199
|
# @!method initialize(response:, sequence_number:, agent: nil, stream_id: nil, type: :"response.queued")
|
|
1990
|
-
# Some parameter documentations has been truncated, see
|
|
1991
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsQueued} for more
|
|
1992
|
-
# details.
|
|
1993
|
-
#
|
|
1994
2200
|
# Emitted when a response is queued and waiting to be processed.
|
|
1995
2201
|
#
|
|
1996
|
-
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
2202
|
+
# @param response [OpenAI::Models::Beta::BetaResponse]
|
|
2203
|
+
# The full response object that is queued.
|
|
1997
2204
|
#
|
|
1998
|
-
# @param sequence_number [Integer]
|
|
2205
|
+
# @param sequence_number [Integer]
|
|
2206
|
+
# The sequence number for this event.
|
|
1999
2207
|
#
|
|
2000
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseQueuedEvent::Agent, nil]
|
|
2208
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseQueuedEvent::Agent, nil]
|
|
2209
|
+
# The agent that owns this multi-agent streaming event.
|
|
2001
2210
|
#
|
|
2002
|
-
# @param stream_id [String]
|
|
2211
|
+
# @param stream_id [String]
|
|
2212
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2213
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
2003
2214
|
#
|
|
2004
|
-
# @param type [Symbol, :"response.queued"]
|
|
2215
|
+
# @param type [Symbol, :"response.queued"]
|
|
2216
|
+
# The type of the event. Always 'response.queued'.
|
|
2005
2217
|
end
|
|
2006
2218
|
|
|
2007
2219
|
class BetaResponseCustomToolCallInputWsDelta < OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent
|
|
@@ -2013,25 +2225,29 @@ module OpenAI
|
|
|
2013
2225
|
optional :stream_id, String
|
|
2014
2226
|
|
|
2015
2227
|
# @!method initialize(delta:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.custom_tool_call_input.delta")
|
|
2016
|
-
# Some parameter documentations has been truncated, see
|
|
2017
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseCustomToolCallInputWsDelta}
|
|
2018
|
-
# for more details.
|
|
2019
|
-
#
|
|
2020
2228
|
# Event representing a delta (partial update) to the input of a custom tool call.
|
|
2021
2229
|
#
|
|
2022
|
-
# @param delta [String]
|
|
2230
|
+
# @param delta [String]
|
|
2231
|
+
# The incremental input data (delta) for the custom tool call.
|
|
2023
2232
|
#
|
|
2024
|
-
# @param item_id [String]
|
|
2233
|
+
# @param item_id [String]
|
|
2234
|
+
# Unique identifier for the API item associated with this event.
|
|
2025
2235
|
#
|
|
2026
|
-
# @param output_index [Integer]
|
|
2236
|
+
# @param output_index [Integer]
|
|
2237
|
+
# The index of the output this delta applies to.
|
|
2027
2238
|
#
|
|
2028
|
-
# @param sequence_number [Integer]
|
|
2239
|
+
# @param sequence_number [Integer]
|
|
2240
|
+
# The sequence number of this event.
|
|
2029
2241
|
#
|
|
2030
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent::Agent, nil]
|
|
2242
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent::Agent, nil]
|
|
2243
|
+
# The agent that owns this multi-agent streaming event.
|
|
2031
2244
|
#
|
|
2032
|
-
# @param stream_id [String]
|
|
2245
|
+
# @param stream_id [String]
|
|
2246
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2247
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
2033
2248
|
#
|
|
2034
|
-
# @param type [Symbol, :"response.custom_tool_call_input.delta"]
|
|
2249
|
+
# @param type [Symbol, :"response.custom_tool_call_input.delta"]
|
|
2250
|
+
# The event type identifier.
|
|
2035
2251
|
end
|
|
2036
2252
|
|
|
2037
2253
|
class BetaResponseCustomToolCallInputWsDone < OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent
|
|
@@ -2043,25 +2259,29 @@ module OpenAI
|
|
|
2043
2259
|
optional :stream_id, String
|
|
2044
2260
|
|
|
2045
2261
|
# @!method initialize(input:, item_id:, output_index:, sequence_number:, agent: nil, stream_id: nil, type: :"response.custom_tool_call_input.done")
|
|
2046
|
-
# Some parameter documentations has been truncated, see
|
|
2047
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseCustomToolCallInputWsDone}
|
|
2048
|
-
# for more details.
|
|
2049
|
-
#
|
|
2050
2262
|
# Event indicating that input for a custom tool call is complete.
|
|
2051
2263
|
#
|
|
2052
|
-
# @param input [String]
|
|
2264
|
+
# @param input [String]
|
|
2265
|
+
# The complete input data for the custom tool call.
|
|
2053
2266
|
#
|
|
2054
|
-
# @param item_id [String]
|
|
2267
|
+
# @param item_id [String]
|
|
2268
|
+
# Unique identifier for the API item associated with this event.
|
|
2055
2269
|
#
|
|
2056
|
-
# @param output_index [Integer]
|
|
2270
|
+
# @param output_index [Integer]
|
|
2271
|
+
# The index of the output this event applies to.
|
|
2057
2272
|
#
|
|
2058
|
-
# @param sequence_number [Integer]
|
|
2273
|
+
# @param sequence_number [Integer]
|
|
2274
|
+
# The sequence number of this event.
|
|
2059
2275
|
#
|
|
2060
|
-
# @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent::Agent, nil]
|
|
2276
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent::Agent, nil]
|
|
2277
|
+
# The agent that owns this multi-agent streaming event.
|
|
2061
2278
|
#
|
|
2062
|
-
# @param stream_id [String]
|
|
2279
|
+
# @param stream_id [String]
|
|
2280
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2281
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
2063
2282
|
#
|
|
2064
|
-
# @param type [Symbol, :"response.custom_tool_call_input.done"]
|
|
2283
|
+
# @param type [Symbol, :"response.custom_tool_call_input.done"]
|
|
2284
|
+
# The event type identifier.
|
|
2065
2285
|
end
|
|
2066
2286
|
|
|
2067
2287
|
class BetaResponseWsError < OpenAI::Internal::Type::BaseModel
|
|
@@ -2109,23 +2329,26 @@ module OpenAI
|
|
|
2109
2329
|
optional :stream_id, String
|
|
2110
2330
|
|
|
2111
2331
|
# @!method initialize(error:, agent: nil, sequence_number: nil, status: nil, stream_id: nil, type: :error)
|
|
2112
|
-
# Some parameter documentations has been truncated, see
|
|
2113
|
-
# {OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError} for more
|
|
2114
|
-
# details.
|
|
2115
|
-
#
|
|
2116
2332
|
# Emitted when an error occurs while processing a Responses WebSocket request.
|
|
2117
2333
|
#
|
|
2118
|
-
# @param error [OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error]
|
|
2334
|
+
# @param error [OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error]
|
|
2335
|
+
# Details about the error.
|
|
2119
2336
|
#
|
|
2120
|
-
# @param agent [OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Agent, nil]
|
|
2337
|
+
# @param agent [OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Agent, nil]
|
|
2338
|
+
# The agent that owns this multi-agent streaming event.
|
|
2121
2339
|
#
|
|
2122
|
-
# @param sequence_number [Integer]
|
|
2340
|
+
# @param sequence_number [Integer]
|
|
2341
|
+
# The sequence number of an error emitted by the response stream.
|
|
2123
2342
|
#
|
|
2124
|
-
# @param status [Integer]
|
|
2343
|
+
# @param status [Integer]
|
|
2344
|
+
# The HTTP status code associated with a WebSocket protocol error.
|
|
2125
2345
|
#
|
|
2126
|
-
# @param stream_id [String]
|
|
2346
|
+
# @param stream_id [String]
|
|
2347
|
+
# The WebSocket lane that emitted this event. This field is present when the
|
|
2348
|
+
# originating `response.create` event supplied a `stream_id`.
|
|
2127
2349
|
#
|
|
2128
|
-
# @param type [Symbol, :error]
|
|
2350
|
+
# @param type [Symbol, :error]
|
|
2351
|
+
# The type of the event. Always `error`.
|
|
2129
2352
|
|
|
2130
2353
|
# @see OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError#error
|
|
2131
2354
|
class Error < OpenAI::Internal::Type::BaseModel
|
|
@@ -2170,15 +2393,20 @@ module OpenAI
|
|
|
2170
2393
|
# @!method initialize(code:, message:, param:, type:, headers: nil, misalignment: nil)
|
|
2171
2394
|
# Details about the error.
|
|
2172
2395
|
#
|
|
2173
|
-
# @param code [String, nil]
|
|
2396
|
+
# @param code [String, nil]
|
|
2397
|
+
# The error code that was emitted, if any.
|
|
2174
2398
|
#
|
|
2175
|
-
# @param message [String]
|
|
2399
|
+
# @param message [String]
|
|
2400
|
+
# The human-readable error message that was emitted.
|
|
2176
2401
|
#
|
|
2177
|
-
# @param param [String, nil]
|
|
2402
|
+
# @param param [String, nil]
|
|
2403
|
+
# The parameter name that was associated with the error, if any.
|
|
2178
2404
|
#
|
|
2179
|
-
# @param type [String]
|
|
2405
|
+
# @param type [String]
|
|
2406
|
+
# The error type that was emitted.
|
|
2180
2407
|
#
|
|
2181
|
-
# @param headers [Hash{Symbol=>String}]
|
|
2408
|
+
# @param headers [Hash{Symbol=>String}]
|
|
2409
|
+
# The response headers that were emitted with the error, if any.
|
|
2182
2410
|
#
|
|
2183
2411
|
# @param misalignment [OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment]
|
|
2184
2412
|
|
|
@@ -2211,11 +2439,14 @@ module OpenAI
|
|
|
2211
2439
|
)
|
|
2212
2440
|
|
|
2213
2441
|
# @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
|
|
2214
|
-
# @param detailed_explanation [String]
|
|
2442
|
+
# @param detailed_explanation [String]
|
|
2443
|
+
# The public explanation for this block.
|
|
2215
2444
|
#
|
|
2216
|
-
# @param error_type [String, Symbol, OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::ErrorType]
|
|
2445
|
+
# @param error_type [String, Symbol, OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::ErrorType]
|
|
2446
|
+
# An optional classification; clients must accept additional values.
|
|
2217
2447
|
#
|
|
2218
|
-
# @param steer [OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer]
|
|
2448
|
+
# @param steer [OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer]
|
|
2449
|
+
# An optional public continuation instruction.
|
|
2219
2450
|
|
|
2220
2451
|
# An optional classification; clients must accept additional values.
|
|
2221
2452
|
#
|
|
@@ -2282,7 +2513,8 @@ module OpenAI
|
|
|
2282
2513
|
# @!method initialize(message:)
|
|
2283
2514
|
# An optional public continuation instruction.
|
|
2284
2515
|
#
|
|
2285
|
-
# @param message [String]
|
|
2516
|
+
# @param message [String]
|
|
2517
|
+
# The public continuation instruction.
|
|
2286
2518
|
end
|
|
2287
2519
|
end
|
|
2288
2520
|
end
|
|
@@ -2298,7 +2530,8 @@ module OpenAI
|
|
|
2298
2530
|
# @!method initialize(agent_name:)
|
|
2299
2531
|
# The agent that owns this multi-agent streaming event.
|
|
2300
2532
|
#
|
|
2301
|
-
# @param agent_name [String]
|
|
2533
|
+
# @param agent_name [String]
|
|
2534
|
+
# The canonical name of the agent that produced this item.
|
|
2302
2535
|
end
|
|
2303
2536
|
end
|
|
2304
2537
|
|