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
|
@@ -13,82 +13,264 @@ module OpenAI
|
|
|
13
13
|
|
|
14
14
|
# See {OpenAI::Resources::Responses#stream_raw} for streaming counterpart.
|
|
15
15
|
#
|
|
16
|
-
# Some parameter documentations has been truncated, see
|
|
17
|
-
# {OpenAI::Models::Responses::ResponseCreateParams} for more details.
|
|
18
|
-
#
|
|
19
16
|
# Creates a model response. Provide
|
|
20
|
-
# [text](https://
|
|
21
|
-
# [image](https://
|
|
22
|
-
# [text](https://
|
|
23
|
-
# [JSON](https://
|
|
24
|
-
# the model call your own
|
|
25
|
-
# [custom code](https://
|
|
26
|
-
# built-in [tools](https://
|
|
27
|
-
# [web search](https://
|
|
28
|
-
# [file search](https://
|
|
29
|
-
# your own data as input for the model's response.
|
|
17
|
+
# [text](https://developers.openai.com/api/docs/guides/text) or
|
|
18
|
+
# [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
19
|
+
# generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
20
|
+
# [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
21
|
+
# outputs. Have the model call your own
|
|
22
|
+
# [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
23
|
+
# use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
24
|
+
# [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
25
|
+
# [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
26
|
+
# to use your own data as input for the model's response.
|
|
30
27
|
#
|
|
31
28
|
# @overload create(background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
32
29
|
#
|
|
33
|
-
# @param background [Boolean, nil]
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
#
|
|
37
|
-
# @param
|
|
38
|
-
#
|
|
39
|
-
#
|
|
40
|
-
#
|
|
41
|
-
#
|
|
42
|
-
#
|
|
43
|
-
#
|
|
44
|
-
#
|
|
45
|
-
#
|
|
46
|
-
#
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
#
|
|
50
|
-
#
|
|
51
|
-
#
|
|
52
|
-
#
|
|
53
|
-
#
|
|
54
|
-
#
|
|
55
|
-
#
|
|
56
|
-
#
|
|
57
|
-
#
|
|
58
|
-
#
|
|
59
|
-
#
|
|
60
|
-
#
|
|
61
|
-
#
|
|
62
|
-
#
|
|
63
|
-
#
|
|
64
|
-
#
|
|
65
|
-
#
|
|
66
|
-
#
|
|
67
|
-
#
|
|
68
|
-
#
|
|
69
|
-
#
|
|
70
|
-
#
|
|
71
|
-
#
|
|
72
|
-
#
|
|
73
|
-
#
|
|
74
|
-
#
|
|
75
|
-
#
|
|
76
|
-
#
|
|
77
|
-
# @param
|
|
78
|
-
#
|
|
79
|
-
#
|
|
80
|
-
#
|
|
81
|
-
#
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
#
|
|
87
|
-
#
|
|
88
|
-
#
|
|
89
|
-
# @param
|
|
90
|
-
#
|
|
91
|
-
#
|
|
30
|
+
# @param background [Boolean, nil]
|
|
31
|
+
# Whether to run the model response in the background.
|
|
32
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
33
|
+
#
|
|
34
|
+
# @param context_management [Array<OpenAI::Models::Responses::ResponseCreateParams::ContextManagement>, nil]
|
|
35
|
+
# Context management configuration for this request.
|
|
36
|
+
#
|
|
37
|
+
# @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil]
|
|
38
|
+
# The conversation that this response belongs to. Items from this conversation are
|
|
39
|
+
# prepended to `input_items` for this response request. Input items and output
|
|
40
|
+
# items from this response are automatically added to this conversation after this
|
|
41
|
+
# response completes.
|
|
42
|
+
#
|
|
43
|
+
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
|
|
44
|
+
# Specify additional output data to include in the model response. Currently
|
|
45
|
+
# supported values are:
|
|
46
|
+
#
|
|
47
|
+
# - `web_search_call.action.sources`: Include the sources of the web search tool
|
|
48
|
+
# call.
|
|
49
|
+
# - `code_interpreter_call.outputs`: Includes the outputs of python code execution
|
|
50
|
+
# in code interpreter tool call items.
|
|
51
|
+
# - `computer_call_output.output.image_url`: Include image urls from the computer
|
|
52
|
+
# call output.
|
|
53
|
+
# - `file_search_call.results`: Include the search results of the file search tool
|
|
54
|
+
# call.
|
|
55
|
+
# - `message.input_image.image_url`: Include image urls from the input message.
|
|
56
|
+
# - `message.output_text.logprobs`: Include logprobs with assistant messages.
|
|
57
|
+
# - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
|
|
58
|
+
# tokens in reasoning item outputs. This enables reasoning items to be used in
|
|
59
|
+
# multi-turn conversations when using the Responses API statelessly (like when
|
|
60
|
+
# the `store` parameter is set to `false`, or when an organization is enrolled
|
|
61
|
+
# in the zero data retention program).
|
|
62
|
+
#
|
|
63
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>]
|
|
64
|
+
# Text, image, or file inputs to the model, used to generate a response.
|
|
65
|
+
#
|
|
66
|
+
# Learn more:
|
|
67
|
+
#
|
|
68
|
+
# - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
69
|
+
# - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
70
|
+
# - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
71
|
+
# - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
72
|
+
# - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
73
|
+
#
|
|
74
|
+
# @param instructions [String, nil]
|
|
75
|
+
# A system (or developer) message inserted into the model's context.
|
|
76
|
+
#
|
|
77
|
+
# When using along with `previous_response_id`, the instructions from a previous
|
|
78
|
+
# response will not be carried over to the next response. This makes it simple to
|
|
79
|
+
# swap out system (or developer) messages in new responses.
|
|
80
|
+
#
|
|
81
|
+
# @param max_output_tokens [Integer, nil]
|
|
82
|
+
# An upper bound for the number of tokens that can be generated for a response,
|
|
83
|
+
# including visible output tokens and
|
|
84
|
+
# [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
85
|
+
#
|
|
86
|
+
# @param max_tool_calls [Integer, nil]
|
|
87
|
+
# The maximum number of total calls to built-in tools that can be processed in a
|
|
88
|
+
# response. This maximum number applies across all built-in tool calls, not per
|
|
89
|
+
# individual tool. Any further attempts to call a tool by the model will be
|
|
90
|
+
# ignored.
|
|
91
|
+
#
|
|
92
|
+
# @param metadata [Hash{Symbol=>String}, nil]
|
|
93
|
+
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
94
|
+
# for storing additional information about the object in a structured format, and
|
|
95
|
+
# querying for objects via API or the dashboard.
|
|
96
|
+
#
|
|
97
|
+
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
98
|
+
# a maximum length of 512 characters.
|
|
99
|
+
#
|
|
100
|
+
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel]
|
|
101
|
+
# Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
102
|
+
# range of models with different capabilities, performance characteristics, and
|
|
103
|
+
# price points. Refer to the
|
|
104
|
+
# [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
105
|
+
# compare available models.
|
|
106
|
+
#
|
|
107
|
+
# @param moderation [OpenAI::Models::Responses::ResponseCreateParams::Moderation, nil]
|
|
108
|
+
# Configuration for running moderation on the input and output of this response.
|
|
109
|
+
#
|
|
110
|
+
# @param parallel_tool_calls [Boolean, nil]
|
|
111
|
+
# Whether to allow the model to run tool calls in parallel.
|
|
112
|
+
#
|
|
113
|
+
# @param previous_response_id [String, nil]
|
|
114
|
+
# The unique ID of the previous response to the model. Use this to create
|
|
115
|
+
# multi-turn conversations. Learn more about
|
|
116
|
+
# [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
117
|
+
# Cannot be used in conjunction with `conversation`.
|
|
118
|
+
#
|
|
119
|
+
# @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil]
|
|
120
|
+
# Reference to a prompt template and its variables.
|
|
121
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
122
|
+
#
|
|
123
|
+
# @param prompt_cache_key [String, nil]
|
|
124
|
+
# Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
125
|
+
# hit rates. Replaces the `user` field.
|
|
126
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
127
|
+
#
|
|
128
|
+
# @param prompt_cache_options [OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions]
|
|
129
|
+
# Options for prompt caching. Supported for `gpt-5.6` and later models. By
|
|
130
|
+
# default, OpenAI automatically chooses one implicit cache breakpoint. You can add
|
|
131
|
+
# explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
|
|
132
|
+
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
133
|
+
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
134
|
+
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
135
|
+
# `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
136
|
+
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
137
|
+
# for current details.
|
|
138
|
+
#
|
|
139
|
+
# @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheRetention, nil]
|
|
140
|
+
# Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
141
|
+
#
|
|
142
|
+
# The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
143
|
+
# prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
144
|
+
# of 24 hours.
|
|
145
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
146
|
+
# This field expresses a maximum retention policy, while
|
|
147
|
+
# `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
148
|
+
# are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
149
|
+
# models, only `24h` is supported.
|
|
150
|
+
#
|
|
151
|
+
# For older models that support both `in_memory` and `24h`, the default depends on
|
|
152
|
+
# your organization's data retention policy:
|
|
153
|
+
#
|
|
154
|
+
# - Organizations without ZDR enabled default to `24h`.
|
|
155
|
+
# - Organizations with ZDR enabled default to `in_memory` when
|
|
156
|
+
# `prompt_cache_retention` is not specified.
|
|
157
|
+
#
|
|
158
|
+
# @param reasoning [OpenAI::Models::Reasoning, nil]
|
|
159
|
+
# Configuration options for
|
|
160
|
+
# [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
161
|
+
#
|
|
162
|
+
# @param safety_identifier [String, nil]
|
|
163
|
+
# A stable identifier used to help detect users of your application that may be
|
|
164
|
+
# violating OpenAI's usage policies. The IDs should be a string that uniquely
|
|
165
|
+
# identifies each user, with a maximum length of 64 characters. We recommend
|
|
166
|
+
# hashing their username or email address, in order to avoid sending us any
|
|
167
|
+
# identifying information.
|
|
168
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
169
|
+
#
|
|
170
|
+
# @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil]
|
|
171
|
+
# Specifies the processing type used for serving the request.
|
|
172
|
+
#
|
|
173
|
+
# - If set to 'auto', then the request will be processed with the service tier
|
|
174
|
+
# configured in the Project settings. Unless otherwise configured, the Project
|
|
175
|
+
# will use 'default'.
|
|
176
|
+
# - If set to 'default', then the request will be processed with the standard
|
|
177
|
+
# pricing and performance for the selected model.
|
|
178
|
+
# - If set to
|
|
179
|
+
# '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
180
|
+
# the request will be processed with the Flex Processing service tier.
|
|
181
|
+
# - To opt-in to
|
|
182
|
+
# [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
183
|
+
# request level, include the `service_tier=fast` or `service_tier=priority`
|
|
184
|
+
# parameter for Responses or Chat Completions. The response will show
|
|
185
|
+
# `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
186
|
+
# `priority` in your request.
|
|
187
|
+
# - If set to 'ultrafast', then the request will be processed with the
|
|
188
|
+
# access-controlled Ultrafast Processing service tier. This tier is currently
|
|
189
|
+
# available for `gpt-5.6-sol`; a response served through it will show
|
|
190
|
+
# `service_tier=ultrafast`.
|
|
191
|
+
# - When not set, the default behavior is 'auto'.
|
|
192
|
+
#
|
|
193
|
+
# When the `service_tier` parameter is set, the response body will include the
|
|
194
|
+
# `service_tier` value based on the processing mode actually used to serve the
|
|
195
|
+
# request. This response value may be different from the value set in the
|
|
196
|
+
# parameter.
|
|
197
|
+
#
|
|
198
|
+
# @param store [Boolean, nil]
|
|
199
|
+
# Whether to store the generated model response for later retrieval via API.
|
|
200
|
+
# Defaults to true when omitted. If set to true, response data will be stored for
|
|
201
|
+
# at least 30 days, subject to the
|
|
202
|
+
# [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
203
|
+
#
|
|
204
|
+
# @param stream_options [OpenAI::Models::Responses::ResponseCreateParams::StreamOptions, nil]
|
|
205
|
+
# Options for streaming responses. Only set this when you set `stream: true`.
|
|
206
|
+
#
|
|
207
|
+
# @param temperature [Float, nil]
|
|
208
|
+
# What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
|
209
|
+
# make the output more random, while lower values like 0.2 will make it more
|
|
210
|
+
# focused and deterministic. We generally recommend altering this or `top_p` but
|
|
211
|
+
# not both.
|
|
212
|
+
#
|
|
213
|
+
# @param text [OpenAI::Models::Responses::ResponseTextConfig]
|
|
214
|
+
# Configuration options for a text response from the model. Can be plain text or
|
|
215
|
+
# structured JSON data. Learn more:
|
|
216
|
+
#
|
|
217
|
+
# - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
218
|
+
# - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
219
|
+
#
|
|
220
|
+
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ResponseCreateParams::ToolChoice::SpecificProgrammaticToolCallingParam, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell]
|
|
221
|
+
# How the model should select which tool (or tools) to use when generating a
|
|
222
|
+
# response. See the `tools` parameter to see how to specify which tools the model
|
|
223
|
+
# can call.
|
|
224
|
+
#
|
|
225
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
226
|
+
# An array of tools the model may call while generating a response. You can
|
|
227
|
+
# specify which tool to use by setting the `tool_choice` parameter.
|
|
228
|
+
#
|
|
229
|
+
# We support the following categories of tools:
|
|
230
|
+
#
|
|
231
|
+
# - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
232
|
+
# capabilities, like
|
|
233
|
+
# [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
234
|
+
# or
|
|
235
|
+
# [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
236
|
+
# Learn more about
|
|
237
|
+
# [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
238
|
+
# - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
239
|
+
# predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
240
|
+
# [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
241
|
+
# - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
242
|
+
# the model to call your own code with strongly typed arguments and outputs.
|
|
243
|
+
# Learn more about
|
|
244
|
+
# [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
245
|
+
# You can also use custom tools to call your own code.
|
|
246
|
+
#
|
|
247
|
+
# @param top_logprobs [Integer, nil]
|
|
248
|
+
# An integer between 0 and 20 specifying the maximum number of most likely tokens
|
|
249
|
+
# to return at each token position, each with an associated log probability. In
|
|
250
|
+
# some cases, the number of returned tokens may be fewer than requested.
|
|
251
|
+
#
|
|
252
|
+
# @param top_p [Float, nil]
|
|
253
|
+
# An alternative to sampling with temperature, called nucleus sampling, where the
|
|
254
|
+
# model considers the results of the tokens with top_p probability mass. So 0.1
|
|
255
|
+
# means only the tokens comprising the top 10% probability mass are considered.
|
|
256
|
+
#
|
|
257
|
+
# We generally recommend altering this or `temperature` but not both.
|
|
258
|
+
#
|
|
259
|
+
# @param truncation [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Truncation, nil]
|
|
260
|
+
# The truncation strategy to use for the model response.
|
|
261
|
+
#
|
|
262
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
263
|
+
# the model will truncate the response to fit the context window by dropping
|
|
264
|
+
# items from the beginning of the conversation.
|
|
265
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
266
|
+
# for a model, the request will fail with a 400 error.
|
|
267
|
+
#
|
|
268
|
+
# @param user [String]
|
|
269
|
+
# This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
|
|
270
|
+
# `prompt_cache_key` instead to maintain caching optimizations. A stable
|
|
271
|
+
# identifier for your end-users. Used to boost cache hit rates by better bucketing
|
|
272
|
+
# similar requests and to help OpenAI detect and prevent abuse.
|
|
273
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
92
274
|
#
|
|
93
275
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
94
276
|
#
|
|
@@ -119,92 +301,7 @@ module OpenAI
|
|
|
119
301
|
)
|
|
120
302
|
end
|
|
121
303
|
|
|
122
|
-
#
|
|
123
|
-
#
|
|
124
|
-
# Some parameter documentations has been truncated, see
|
|
125
|
-
# {OpenAI::Models::Responses::ResponseCreateParams} for more details.
|
|
126
|
-
#
|
|
127
|
-
# Creates a model response. Provide
|
|
128
|
-
# [text](https://platform.openai.com/docs/guides/text) or
|
|
129
|
-
# [image](https://platform.openai.com/docs/guides/images) inputs to generate
|
|
130
|
-
# [text](https://platform.openai.com/docs/guides/text) or
|
|
131
|
-
# [JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have
|
|
132
|
-
# the model call your own
|
|
133
|
-
# [custom code](https://platform.openai.com/docs/guides/function-calling) or use
|
|
134
|
-
# built-in [tools](https://platform.openai.com/docs/guides/tools) like
|
|
135
|
-
# [web search](https://platform.openai.com/docs/guides/tools-web-search) or
|
|
136
|
-
# [file search](https://platform.openai.com/docs/guides/tools-file-search) to use
|
|
137
|
-
# your own data as input for the model's response.
|
|
138
|
-
#
|
|
139
|
-
# @overload stream(background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, response_id: nil, safety_identifier: nil, service_tier: nil, starting_after: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
140
|
-
#
|
|
141
|
-
# @param background [Boolean, nil] Whether to run the model response in the background.
|
|
142
|
-
#
|
|
143
|
-
# @param context_management [Array<OpenAI::Models::Responses::ResponseCreateParams::ContextManagement>, nil] Context management configuration for this request.
|
|
144
|
-
#
|
|
145
|
-
# @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
|
|
146
|
-
#
|
|
147
|
-
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
|
|
148
|
-
#
|
|
149
|
-
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>] Text, image, or file inputs to the model, used to generate a response.
|
|
150
|
-
#
|
|
151
|
-
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
152
|
-
#
|
|
153
|
-
# @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
|
|
154
|
-
#
|
|
155
|
-
# @param max_tool_calls [Integer, nil] The maximum number of total calls to built-in tools that can be processed in a r
|
|
156
|
-
#
|
|
157
|
-
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
158
|
-
#
|
|
159
|
-
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
160
|
-
#
|
|
161
|
-
# @param moderation [OpenAI::Models::Responses::ResponseCreateParams::Moderation, nil] Configuration for running moderation on the input and output of this response.
|
|
162
|
-
#
|
|
163
|
-
# @param parallel_tool_calls [Boolean, nil] Whether to allow the model to run tool calls in parallel.
|
|
164
|
-
#
|
|
165
|
-
# @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to create multi-turn conversations.
|
|
166
|
-
#
|
|
167
|
-
# @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
|
|
168
|
-
#
|
|
169
|
-
# @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
|
|
170
|
-
#
|
|
171
|
-
# @param prompt_cache_options [OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions] Options for prompt caching. Supported for `gpt-5.6` and later models. By default
|
|
172
|
-
#
|
|
173
|
-
# @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
174
|
-
#
|
|
175
|
-
# @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
|
|
176
|
-
#
|
|
177
|
-
# @param response_id [String, nil] The ID of the response whose stream to resume.
|
|
178
|
-
#
|
|
179
|
-
# @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
|
|
180
|
-
#
|
|
181
|
-
# @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
|
|
182
|
-
#
|
|
183
|
-
# @param starting_after [Integer, nil] The sequence number of the event after which to resume streaming. Can only be used with `response_id`.
|
|
184
|
-
#
|
|
185
|
-
# @param store [Boolean, nil] Whether to store the generated model response for later retrieval via
|
|
186
|
-
#
|
|
187
|
-
# @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
|
|
188
|
-
#
|
|
189
|
-
# @param text [OpenAI::Models::Responses::ResponseTextConfig] Configuration options for a text response from the model. Can be plain
|
|
190
|
-
#
|
|
191
|
-
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp] How the model should select which tool (or tools) to use when generating
|
|
192
|
-
#
|
|
193
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::Tool::Custom, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
|
|
194
|
-
#
|
|
195
|
-
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
|
|
196
|
-
#
|
|
197
|
-
# @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
|
|
198
|
-
#
|
|
199
|
-
# @param truncation [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Truncation, nil] The truncation strategy to use for the model response.
|
|
200
|
-
#
|
|
201
|
-
# @param user [String] This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
|
|
202
|
-
#
|
|
203
|
-
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
204
|
-
#
|
|
205
|
-
# @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
|
|
206
|
-
#
|
|
207
|
-
# @see OpenAI::Models::Responses::ResponseCreateParams
|
|
304
|
+
# Creates or resumes a streaming response and parses structured outputs.
|
|
208
305
|
def stream(params)
|
|
209
306
|
parsed, options = OpenAI::Responses::ResponseCreateParams.dump_request(params)
|
|
210
307
|
starting_after, response_id = parsed.values_at(:starting_after, :response_id)
|
|
@@ -257,76 +354,264 @@ module OpenAI
|
|
|
257
354
|
|
|
258
355
|
# See {OpenAI::Resources::Responses#create} for non-streaming counterpart.
|
|
259
356
|
#
|
|
260
|
-
# Some parameter documentations has been truncated, see
|
|
261
|
-
# {OpenAI::Models::Responses::ResponseCreateParams} for more details.
|
|
262
|
-
#
|
|
263
357
|
# Creates a model response. Provide
|
|
264
|
-
# [text](https://
|
|
265
|
-
# [image](https://
|
|
266
|
-
# [text](https://
|
|
267
|
-
# [JSON](https://
|
|
268
|
-
# the model call your own
|
|
269
|
-
# [custom code](https://
|
|
270
|
-
# built-in [tools](https://
|
|
271
|
-
# [web search](https://
|
|
272
|
-
# [file search](https://
|
|
273
|
-
# your own data as input for the model's response.
|
|
274
|
-
#
|
|
275
|
-
# @overload stream_raw(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
276
|
-
#
|
|
277
|
-
# @param background [Boolean, nil] Whether to run the model response in the background.
|
|
278
|
-
#
|
|
279
|
-
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
|
|
280
|
-
#
|
|
281
|
-
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
|
|
282
|
-
#
|
|
283
|
-
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
284
|
-
#
|
|
285
|
-
# @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
|
|
286
|
-
#
|
|
287
|
-
# @param max_tool_calls [Integer, nil] The maximum number of total calls to built-in tools that can be processed in a r
|
|
288
|
-
#
|
|
289
|
-
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
290
|
-
#
|
|
291
|
-
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
|
|
292
|
-
#
|
|
293
|
-
# @param parallel_tool_calls [Boolean, nil] Whether to allow the model to run tool calls in parallel.
|
|
358
|
+
# [text](https://developers.openai.com/api/docs/guides/text) or
|
|
359
|
+
# [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
360
|
+
# generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
361
|
+
# [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
362
|
+
# outputs. Have the model call your own
|
|
363
|
+
# [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
364
|
+
# use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
365
|
+
# [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
366
|
+
# [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
367
|
+
# to use your own data as input for the model's response.
|
|
294
368
|
#
|
|
295
|
-
# @
|
|
296
|
-
#
|
|
297
|
-
# @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
|
|
298
|
-
#
|
|
299
|
-
# @param prompt_cache_key [String, nil] Used by OpenAI to cache responses for similar requests to optimize your cache hi
|
|
300
|
-
#
|
|
301
|
-
# @param prompt_cache_options [OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions] Options for prompt caching. Supported for `gpt-5.6` and later models. By default
|
|
302
|
-
#
|
|
303
|
-
# @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
304
|
-
#
|
|
305
|
-
# @param reasoning [OpenAI::Models::Reasoning, nil] Configuration options for
|
|
306
|
-
#
|
|
307
|
-
# @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
|
|
308
|
-
#
|
|
309
|
-
# @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
|
|
310
|
-
#
|
|
311
|
-
# @param store [Boolean, nil] Whether to store the generated model response for later retrieval via
|
|
312
|
-
#
|
|
313
|
-
# @param stream_options [OpenAI::Models::Responses::ResponseCreateParams::StreamOptions, nil] Options for streaming responses. Only set this when you set `stream: true`.
|
|
314
|
-
#
|
|
315
|
-
# @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
|
|
316
|
-
#
|
|
317
|
-
# @param text [OpenAI::Models::Responses::ResponseTextConfig] Configuration options for a text response from the model. Can be plain
|
|
318
|
-
#
|
|
319
|
-
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ResponseCreateParams::ToolChoice::SpecificProgrammaticToolCallingParam, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell] How the model should select which tool (or tools) to use when generating
|
|
320
|
-
#
|
|
321
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
322
|
-
#
|
|
323
|
-
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the maximum number of most likely
|
|
324
|
-
#
|
|
325
|
-
# @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
|
|
326
|
-
#
|
|
327
|
-
# @param truncation [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Truncation, nil] The truncation strategy to use for the model response.
|
|
369
|
+
# @overload stream(background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, response_id: nil, safety_identifier: nil, service_tier: nil, starting_after: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
328
370
|
#
|
|
329
|
-
# @param
|
|
371
|
+
# @param background [Boolean, nil]
|
|
372
|
+
# Whether to run the model response in the background.
|
|
373
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
374
|
+
#
|
|
375
|
+
# @param context_management [Array<OpenAI::Models::Responses::ResponseCreateParams::ContextManagement>, nil]
|
|
376
|
+
# Context management configuration for this request.
|
|
377
|
+
#
|
|
378
|
+
# @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil]
|
|
379
|
+
# The conversation that this response belongs to. Items from this conversation are
|
|
380
|
+
# prepended to `input_items` for this response request. Input items and output
|
|
381
|
+
# items from this response are automatically added to this conversation after this
|
|
382
|
+
# response completes.
|
|
383
|
+
#
|
|
384
|
+
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
|
|
385
|
+
# Specify additional output data to include in the model response. Currently
|
|
386
|
+
# supported values are:
|
|
387
|
+
#
|
|
388
|
+
# - `web_search_call.action.sources`: Include the sources of the web search tool
|
|
389
|
+
# call.
|
|
390
|
+
# - `code_interpreter_call.outputs`: Includes the outputs of python code execution
|
|
391
|
+
# in code interpreter tool call items.
|
|
392
|
+
# - `computer_call_output.output.image_url`: Include image urls from the computer
|
|
393
|
+
# call output.
|
|
394
|
+
# - `file_search_call.results`: Include the search results of the file search tool
|
|
395
|
+
# call.
|
|
396
|
+
# - `message.input_image.image_url`: Include image urls from the input message.
|
|
397
|
+
# - `message.output_text.logprobs`: Include logprobs with assistant messages.
|
|
398
|
+
# - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
|
|
399
|
+
# tokens in reasoning item outputs. This enables reasoning items to be used in
|
|
400
|
+
# multi-turn conversations when using the Responses API statelessly (like when
|
|
401
|
+
# the `store` parameter is set to `false`, or when an organization is enrolled
|
|
402
|
+
# in the zero data retention program).
|
|
403
|
+
#
|
|
404
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>]
|
|
405
|
+
# Text, image, or file inputs to the model, used to generate a response.
|
|
406
|
+
#
|
|
407
|
+
# Learn more:
|
|
408
|
+
#
|
|
409
|
+
# - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
410
|
+
# - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
411
|
+
# - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
412
|
+
# - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
413
|
+
# - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
414
|
+
#
|
|
415
|
+
# @param instructions [String, nil]
|
|
416
|
+
# A system (or developer) message inserted into the model's context.
|
|
417
|
+
#
|
|
418
|
+
# When using along with `previous_response_id`, the instructions from a previous
|
|
419
|
+
# response will not be carried over to the next response. This makes it simple to
|
|
420
|
+
# swap out system (or developer) messages in new responses.
|
|
421
|
+
#
|
|
422
|
+
# @param max_output_tokens [Integer, nil]
|
|
423
|
+
# An upper bound for the number of tokens that can be generated for a response,
|
|
424
|
+
# including visible output tokens and
|
|
425
|
+
# [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
426
|
+
#
|
|
427
|
+
# @param max_tool_calls [Integer, nil]
|
|
428
|
+
# The maximum number of total calls to built-in tools that can be processed in a
|
|
429
|
+
# response. This maximum number applies across all built-in tool calls, not per
|
|
430
|
+
# individual tool. Any further attempts to call a tool by the model will be
|
|
431
|
+
# ignored.
|
|
432
|
+
#
|
|
433
|
+
# @param metadata [Hash{Symbol=>String}, nil]
|
|
434
|
+
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
435
|
+
# for storing additional information about the object in a structured format, and
|
|
436
|
+
# querying for objects via API or the dashboard.
|
|
437
|
+
#
|
|
438
|
+
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
439
|
+
# a maximum length of 512 characters.
|
|
440
|
+
#
|
|
441
|
+
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel]
|
|
442
|
+
# Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
443
|
+
# range of models with different capabilities, performance characteristics, and
|
|
444
|
+
# price points. Refer to the
|
|
445
|
+
# [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
446
|
+
# compare available models.
|
|
447
|
+
#
|
|
448
|
+
# @param moderation [OpenAI::Models::Responses::ResponseCreateParams::Moderation, nil]
|
|
449
|
+
# Configuration for running moderation on the input and output of this response.
|
|
450
|
+
#
|
|
451
|
+
# @param parallel_tool_calls [Boolean, nil]
|
|
452
|
+
# Whether to allow the model to run tool calls in parallel.
|
|
453
|
+
#
|
|
454
|
+
# @param previous_response_id [String, nil]
|
|
455
|
+
# The unique ID of the previous response to the model. Use this to create
|
|
456
|
+
# multi-turn conversations. Learn more about
|
|
457
|
+
# [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
458
|
+
# Cannot be used in conjunction with `conversation`.
|
|
459
|
+
#
|
|
460
|
+
# @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil]
|
|
461
|
+
# Reference to a prompt template and its variables.
|
|
462
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
463
|
+
#
|
|
464
|
+
# @param prompt_cache_key [String, nil]
|
|
465
|
+
# Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
466
|
+
# hit rates. Replaces the `user` field.
|
|
467
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
468
|
+
#
|
|
469
|
+
# @param prompt_cache_options [OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions]
|
|
470
|
+
# Options for prompt caching. Supported for `gpt-5.6` and later models. By
|
|
471
|
+
# default, OpenAI automatically chooses one implicit cache breakpoint. You can add
|
|
472
|
+
# explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
|
|
473
|
+
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
474
|
+
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
475
|
+
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
476
|
+
# `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
477
|
+
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
478
|
+
# for current details.
|
|
479
|
+
#
|
|
480
|
+
# @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheRetention, nil]
|
|
481
|
+
# Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
482
|
+
#
|
|
483
|
+
# The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
484
|
+
# prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
485
|
+
# of 24 hours.
|
|
486
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
487
|
+
# This field expresses a maximum retention policy, while
|
|
488
|
+
# `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
489
|
+
# are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
490
|
+
# models, only `24h` is supported.
|
|
491
|
+
#
|
|
492
|
+
# For older models that support both `in_memory` and `24h`, the default depends on
|
|
493
|
+
# your organization's data retention policy:
|
|
494
|
+
#
|
|
495
|
+
# - Organizations without ZDR enabled default to `24h`.
|
|
496
|
+
# - Organizations with ZDR enabled default to `in_memory` when
|
|
497
|
+
# `prompt_cache_retention` is not specified.
|
|
498
|
+
#
|
|
499
|
+
# @param reasoning [OpenAI::Models::Reasoning, nil]
|
|
500
|
+
# Configuration options for
|
|
501
|
+
# [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
502
|
+
#
|
|
503
|
+
# @param safety_identifier [String, nil]
|
|
504
|
+
# A stable identifier used to help detect users of your application that may be
|
|
505
|
+
# violating OpenAI's usage policies. The IDs should be a string that uniquely
|
|
506
|
+
# identifies each user, with a maximum length of 64 characters. We recommend
|
|
507
|
+
# hashing their username or email address, in order to avoid sending us any
|
|
508
|
+
# identifying information.
|
|
509
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
510
|
+
#
|
|
511
|
+
# @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil]
|
|
512
|
+
# Specifies the processing type used for serving the request.
|
|
513
|
+
#
|
|
514
|
+
# - If set to 'auto', then the request will be processed with the service tier
|
|
515
|
+
# configured in the Project settings. Unless otherwise configured, the Project
|
|
516
|
+
# will use 'default'.
|
|
517
|
+
# - If set to 'default', then the request will be processed with the standard
|
|
518
|
+
# pricing and performance for the selected model.
|
|
519
|
+
# - If set to
|
|
520
|
+
# '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
521
|
+
# the request will be processed with the Flex Processing service tier.
|
|
522
|
+
# - To opt-in to
|
|
523
|
+
# [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
524
|
+
# request level, include the `service_tier=fast` or `service_tier=priority`
|
|
525
|
+
# parameter for Responses or Chat Completions. The response will show
|
|
526
|
+
# `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
527
|
+
# `priority` in your request.
|
|
528
|
+
# - If set to 'ultrafast', then the request will be processed with the
|
|
529
|
+
# access-controlled Ultrafast Processing service tier. This tier is currently
|
|
530
|
+
# available for `gpt-5.6-sol`; a response served through it will show
|
|
531
|
+
# `service_tier=ultrafast`.
|
|
532
|
+
# - When not set, the default behavior is 'auto'.
|
|
533
|
+
#
|
|
534
|
+
# When the `service_tier` parameter is set, the response body will include the
|
|
535
|
+
# `service_tier` value based on the processing mode actually used to serve the
|
|
536
|
+
# request. This response value may be different from the value set in the
|
|
537
|
+
# parameter.
|
|
538
|
+
#
|
|
539
|
+
# @param store [Boolean, nil]
|
|
540
|
+
# Whether to store the generated model response for later retrieval via API.
|
|
541
|
+
# Defaults to true when omitted. If set to true, response data will be stored for
|
|
542
|
+
# at least 30 days, subject to the
|
|
543
|
+
# [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
544
|
+
#
|
|
545
|
+
# @param stream_options [OpenAI::Models::Responses::ResponseCreateParams::StreamOptions, nil]
|
|
546
|
+
# Options for streaming responses. Only set this when you set `stream: true`.
|
|
547
|
+
#
|
|
548
|
+
# @param temperature [Float, nil]
|
|
549
|
+
# What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
|
550
|
+
# make the output more random, while lower values like 0.2 will make it more
|
|
551
|
+
# focused and deterministic. We generally recommend altering this or `top_p` but
|
|
552
|
+
# not both.
|
|
553
|
+
#
|
|
554
|
+
# @param text [OpenAI::Models::Responses::ResponseTextConfig]
|
|
555
|
+
# Configuration options for a text response from the model. Can be plain text or
|
|
556
|
+
# structured JSON data. Learn more:
|
|
557
|
+
#
|
|
558
|
+
# - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
559
|
+
# - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
560
|
+
#
|
|
561
|
+
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ResponseCreateParams::ToolChoice::SpecificProgrammaticToolCallingParam, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell]
|
|
562
|
+
# How the model should select which tool (or tools) to use when generating a
|
|
563
|
+
# response. See the `tools` parameter to see how to specify which tools the model
|
|
564
|
+
# can call.
|
|
565
|
+
#
|
|
566
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
567
|
+
# An array of tools the model may call while generating a response. You can
|
|
568
|
+
# specify which tool to use by setting the `tool_choice` parameter.
|
|
569
|
+
#
|
|
570
|
+
# We support the following categories of tools:
|
|
571
|
+
#
|
|
572
|
+
# - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
573
|
+
# capabilities, like
|
|
574
|
+
# [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
575
|
+
# or
|
|
576
|
+
# [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
577
|
+
# Learn more about
|
|
578
|
+
# [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
579
|
+
# - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
580
|
+
# predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
581
|
+
# [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
582
|
+
# - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
583
|
+
# the model to call your own code with strongly typed arguments and outputs.
|
|
584
|
+
# Learn more about
|
|
585
|
+
# [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
586
|
+
# You can also use custom tools to call your own code.
|
|
587
|
+
#
|
|
588
|
+
# @param top_logprobs [Integer, nil]
|
|
589
|
+
# An integer between 0 and 20 specifying the maximum number of most likely tokens
|
|
590
|
+
# to return at each token position, each with an associated log probability. In
|
|
591
|
+
# some cases, the number of returned tokens may be fewer than requested.
|
|
592
|
+
#
|
|
593
|
+
# @param top_p [Float, nil]
|
|
594
|
+
# An alternative to sampling with temperature, called nucleus sampling, where the
|
|
595
|
+
# model considers the results of the tokens with top_p probability mass. So 0.1
|
|
596
|
+
# means only the tokens comprising the top 10% probability mass are considered.
|
|
597
|
+
#
|
|
598
|
+
# We generally recommend altering this or `temperature` but not both.
|
|
599
|
+
#
|
|
600
|
+
# @param truncation [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Truncation, nil]
|
|
601
|
+
# The truncation strategy to use for the model response.
|
|
602
|
+
#
|
|
603
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
604
|
+
# the model will truncate the response to fit the context window by dropping
|
|
605
|
+
# items from the beginning of the conversation.
|
|
606
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
607
|
+
# for a model, the request will fail with a 400 error.
|
|
608
|
+
#
|
|
609
|
+
# @param user [String]
|
|
610
|
+
# This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
|
|
611
|
+
# `prompt_cache_key` instead to maintain caching optimizations. A stable
|
|
612
|
+
# identifier for your end-users. Used to boost cache hit rates by better bucketing
|
|
613
|
+
# similar requests and to help OpenAI detect and prevent abuse.
|
|
614
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
330
615
|
#
|
|
331
616
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
332
617
|
#
|
|
@@ -355,20 +640,27 @@ module OpenAI
|
|
|
355
640
|
|
|
356
641
|
# See {OpenAI::Resources::Responses#retrieve_streaming} for streaming counterpart.
|
|
357
642
|
#
|
|
358
|
-
# Some parameter documentations has been truncated, see
|
|
359
|
-
# {OpenAI::Models::Responses::ResponseRetrieveParams} for more details.
|
|
360
|
-
#
|
|
361
643
|
# Retrieves a model response with the given ID.
|
|
362
644
|
#
|
|
363
645
|
# @overload retrieve(response_id, include: nil, include_obfuscation: nil, starting_after: nil, text: nil, tools: nil, request_options: {})
|
|
364
646
|
#
|
|
365
|
-
# @param response_id [String]
|
|
647
|
+
# @param response_id [String]
|
|
648
|
+
# The ID of the response to retrieve.
|
|
366
649
|
#
|
|
367
|
-
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
|
|
650
|
+
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
|
|
651
|
+
# Additional fields to include in the response. See the `include` parameter for
|
|
652
|
+
# Response creation above for more information.
|
|
368
653
|
#
|
|
369
|
-
# @param include_obfuscation [Boolean]
|
|
654
|
+
# @param include_obfuscation [Boolean]
|
|
655
|
+
# When true, stream obfuscation will be enabled. Stream obfuscation adds random
|
|
656
|
+
# characters to an `obfuscation` field on streaming delta events to normalize
|
|
657
|
+
# payload sizes as a mitigation to certain side-channel attacks. These obfuscation
|
|
658
|
+
# fields are included by default, but add a small amount of overhead to the data
|
|
659
|
+
# stream. You can set `include_obfuscation` to false to optimize for bandwidth if
|
|
660
|
+
# you trust the network links between your application and the OpenAI API.
|
|
370
661
|
#
|
|
371
|
-
# @param starting_after [Integer]
|
|
662
|
+
# @param starting_after [Integer]
|
|
663
|
+
# The sequence number of the event after which to start streaming.
|
|
372
664
|
#
|
|
373
665
|
# @param text [OpenAI::Responses::ResponseTextConfig, OpenAI::StructuredOutput::JsonSchemaConverter, Hash, nil] The structured-output model,
|
|
374
666
|
# or the same typed/hash text configuration accepted by creation, used to parse retrieved text output. This is a local parsing hint and is not
|
|
@@ -415,20 +707,27 @@ module OpenAI
|
|
|
415
707
|
|
|
416
708
|
# See {OpenAI::Resources::Responses#retrieve} for non-streaming counterpart.
|
|
417
709
|
#
|
|
418
|
-
# Some parameter documentations has been truncated, see
|
|
419
|
-
# {OpenAI::Models::Responses::ResponseRetrieveParams} for more details.
|
|
420
|
-
#
|
|
421
710
|
# Retrieves a model response with the given ID.
|
|
422
711
|
#
|
|
423
712
|
# @overload retrieve_streaming(response_id, include: nil, include_obfuscation: nil, starting_after: nil, request_options: {})
|
|
424
713
|
#
|
|
425
|
-
# @param response_id [String]
|
|
714
|
+
# @param response_id [String]
|
|
715
|
+
# The ID of the response to retrieve.
|
|
426
716
|
#
|
|
427
|
-
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
|
|
717
|
+
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
|
|
718
|
+
# Additional fields to include in the response. See the `include` parameter for
|
|
719
|
+
# Response creation above for more information.
|
|
428
720
|
#
|
|
429
|
-
# @param include_obfuscation [Boolean]
|
|
721
|
+
# @param include_obfuscation [Boolean]
|
|
722
|
+
# When true, stream obfuscation will be enabled. Stream obfuscation adds random
|
|
723
|
+
# characters to an `obfuscation` field on streaming delta events to normalize
|
|
724
|
+
# payload sizes as a mitigation to certain side-channel attacks. These obfuscation
|
|
725
|
+
# fields are included by default, but add a small amount of overhead to the data
|
|
726
|
+
# stream. You can set `include_obfuscation` to false to optimize for bandwidth if
|
|
727
|
+
# you trust the network links between your application and the OpenAI API.
|
|
430
728
|
#
|
|
431
|
-
# @param starting_after [Integer]
|
|
729
|
+
# @param starting_after [Integer]
|
|
730
|
+
# The sequence number of the event after which to start streaming.
|
|
432
731
|
#
|
|
433
732
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
434
733
|
#
|
|
@@ -476,7 +775,8 @@ module OpenAI
|
|
|
476
775
|
#
|
|
477
776
|
# @overload delete(response_id, request_options: {})
|
|
478
777
|
#
|
|
479
|
-
# @param response_id [String]
|
|
778
|
+
# @param response_id [String]
|
|
779
|
+
# The ID of the response to delete.
|
|
480
780
|
#
|
|
481
781
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
482
782
|
#
|
|
@@ -495,11 +795,12 @@ module OpenAI
|
|
|
495
795
|
|
|
496
796
|
# Cancels a model response with the given ID. Only responses created with the
|
|
497
797
|
# `background` parameter set to `true` can be cancelled.
|
|
498
|
-
# [Learn more](https://
|
|
798
|
+
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
499
799
|
#
|
|
500
800
|
# @overload cancel(response_id, request_options: {})
|
|
501
801
|
#
|
|
502
|
-
# @param response_id [String]
|
|
802
|
+
# @param response_id [String]
|
|
803
|
+
# The ID of the response to cancel.
|
|
503
804
|
#
|
|
504
805
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
505
806
|
#
|
|
@@ -516,33 +817,71 @@ module OpenAI
|
|
|
516
817
|
)
|
|
517
818
|
end
|
|
518
819
|
|
|
519
|
-
# Some parameter documentations has been truncated, see
|
|
520
|
-
# {OpenAI::Models::Responses::ResponseCompactParams} for more details.
|
|
521
|
-
#
|
|
522
820
|
# Compact a conversation. Returns a compacted response object.
|
|
523
821
|
#
|
|
524
822
|
# Learn when and how to compact long-running conversations in the
|
|
525
|
-
# [conversation state guide](https://
|
|
823
|
+
# [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
|
|
526
824
|
# For ZDR-compatible compaction details, see
|
|
527
|
-
# [Compaction (advanced)](https://
|
|
825
|
+
# [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
528
826
|
#
|
|
529
827
|
# @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, service_tier: nil, request_options: {})
|
|
530
828
|
#
|
|
531
|
-
# @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil]
|
|
532
|
-
#
|
|
533
|
-
#
|
|
534
|
-
#
|
|
535
|
-
#
|
|
536
|
-
#
|
|
537
|
-
#
|
|
538
|
-
#
|
|
539
|
-
#
|
|
540
|
-
#
|
|
541
|
-
# @param
|
|
542
|
-
#
|
|
543
|
-
#
|
|
544
|
-
#
|
|
545
|
-
#
|
|
829
|
+
# @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil]
|
|
830
|
+
# Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
831
|
+
# range of models with different capabilities, performance characteristics, and
|
|
832
|
+
# price points. Refer to the
|
|
833
|
+
# [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
834
|
+
# compare available models.
|
|
835
|
+
#
|
|
836
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>, nil]
|
|
837
|
+
# Text, image, or file inputs to the model, used to generate a response
|
|
838
|
+
#
|
|
839
|
+
# @param instructions [String, nil]
|
|
840
|
+
# A system (or developer) message inserted into the model's context. When used
|
|
841
|
+
# along with `previous_response_id`, the instructions from a previous response
|
|
842
|
+
# will not be carried over to the next response. This makes it simple to swap out
|
|
843
|
+
# system (or developer) messages in new responses.
|
|
844
|
+
#
|
|
845
|
+
# @param previous_response_id [String, nil]
|
|
846
|
+
# The unique ID of the previous response to the model. Use this to create
|
|
847
|
+
# multi-turn conversations. Learn more about
|
|
848
|
+
# [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
849
|
+
# Cannot be used in conjunction with `conversation`.
|
|
850
|
+
#
|
|
851
|
+
# @param prompt_cache_key [String, nil]
|
|
852
|
+
# A key to use when reading from or writing to the prompt cache.
|
|
853
|
+
#
|
|
854
|
+
# @param prompt_cache_options [OpenAI::Models::Responses::ResponseCompactParams::PromptCacheOptions, nil]
|
|
855
|
+
# Options for prompt caching. Supported for `gpt-5.6` and later models. By
|
|
856
|
+
# default, OpenAI automatically chooses one implicit cache breakpoint. You can add
|
|
857
|
+
# explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
|
|
858
|
+
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
859
|
+
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
860
|
+
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
861
|
+
# `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
862
|
+
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
863
|
+
# for current details.
|
|
864
|
+
#
|
|
865
|
+
# @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCompactParams::PromptCacheRetention, nil]
|
|
866
|
+
# How long to retain a prompt cache entry created by this request.
|
|
867
|
+
#
|
|
868
|
+
# @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCompactParams::ServiceTier, nil]
|
|
869
|
+
# Specifies the processing type used for serving the request. - If set to 'auto',
|
|
870
|
+
# then the request will be processed with the service tier configured in the
|
|
871
|
+
# Project settings. Unless otherwise configured, the Project will use 'default'. -
|
|
872
|
+
# If set to 'default', then the request will be processed with the standard
|
|
873
|
+
# pricing and performance for the selected model. - If set to
|
|
874
|
+
# '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
875
|
+
# the request will be processed with the Flex Processing service tier. - To opt-in
|
|
876
|
+
# to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
877
|
+
# request level, include the `service_tier=fast` or `service_tier=priority`
|
|
878
|
+
# parameter for Responses or Chat Completions. For models with a dedicated Fast
|
|
879
|
+
# tier, either value resolves to `service_tier=fast`; for other models, either
|
|
880
|
+
# value resolves to `service_tier=priority`. - When not set, the default behavior
|
|
881
|
+
# is 'auto'. When the `service_tier` parameter is set, the response body will
|
|
882
|
+
# include the `service_tier` value based on the processing mode actually used to
|
|
883
|
+
# serve the request. This response value may be different from the value set in
|
|
884
|
+
# the parameter.
|
|
546
885
|
#
|
|
547
886
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
548
887
|
#
|