Files - Delete
Удаляет файл с заданным идентификатором файла. Удаление также допускается, если файл использовался, например в качестве обучающего файла в задании точной настройки.
DELETE {endpoint}/openai/files/{file-id}?api-version=2024-10-21
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://aoairesource.openai.azure.com. Замените aoairesource именем учетной записи Azure OpenAI. |
file-id
|
path | True |
string |
Идентификатор файла. |
api-version
|
query | True |
string |
Запрошенная версия API. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
api-key | True |
string |
Укажите здесь ключ учетной записи Azure OpenAI Для Cognitive Services. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Файл успешно удален. |
|
Other Status Codes |
Произошла ошибка. |
Безопасность
api-key
Укажите здесь ключ учетной записи Azure OpenAI Для Cognitive Services.
Тип:
apiKey
В:
header
Примеры
Deleting a file.
Образец запроса
DELETE https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099?api-version=2024-10-21
Пример ответа
{
"object": "file",
"deleted": true,
"id": "file-181a1cbdcdcf4677ada87f63a0928099"
}
Определения
Имя | Описание |
---|---|
Error |
Ошибка |
Error |
Код ошибки |
Error |
ErrorResponse |
File |
FileDelete |
Inner |
InnerError |
Inner |
InnerErrorCode |
Type |
TypeDiscriminator |
Error
Ошибка
Имя | Тип | Описание |
---|---|---|
code |
Код ошибки |
|
details |
Error[] |
Сведения об ошибке, если они доступны. |
innererror |
InnerError |
|
message |
string |
Сообщение об этой ошибке. |
target |
string |
Расположение, в котором произошла ошибка, если она доступна. |
ErrorCode
Код ошибки
Имя | Тип | Описание |
---|---|---|
conflict |
string |
Запрошенная операция конфликтует с текущим состоянием ресурса. |
contentFilter |
string |
Сбой создания изображений в результате нашей системы безопасности. |
fileImportFailed |
string |
Сбой импорта файла. |
forbidden |
string |
Операция запрещена для текущего ключа пользователя или API. |
internalFailure |
string |
Внутренняя ошибка. Повторите попытку. |
invalidPayload |
string |
Данные запроса недопустимы для этой операции. |
itemDoesAlreadyExist |
string |
Элемент уже существует. |
jsonlValidationFailed |
string |
Сбой проверки данных jsonl. |
notFound |
string |
Ресурс не найден. |
quotaExceeded |
string |
Превышена квота. |
serviceUnavailable |
string |
В настоящее время служба недоступна. |
tooManyRequests |
string |
Слишком много запросов. Повторите попытку позже. |
unauthorized |
string |
Текущий ключ пользователя или API не авторизован для операции. |
unexpectedEntityState |
string |
Невозможно выполнить операцию в состоянии текущего ресурса. |
ErrorResponse
ErrorResponse
Имя | Тип | Описание |
---|---|---|
error |
Ошибка |
FileDelete
FileDelete
Имя | Тип | Описание |
---|---|---|
deleted |
boolean |
Значение, указывающее, возвращается ли файл, если файл был удален. |
id |
string |
Идентификатор файла, который был удален. |
object |
TypeDiscriminator |
InnerError
InnerError
Имя | Тип | Описание |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
Имя | Тип | Описание |
---|---|---|
invalidPayload |
string |
Данные запроса недопустимы для этой операции. |
TypeDiscriminator
TypeDiscriminator
Имя | Тип | Описание |
---|---|---|
batch |
string |
Этот объект представляет пакет. |
file |
string |
Этот объект представляет файл. |
fine_tuning.job |
string |
Этот объект представляет точное задание настройки. |
fine_tuning.job.checkpoint |
string |
Этот объект представляет контрольную точку задания тонкой настройки. |
fine_tuning.job.event |
string |
Этот объект представляет событие задания тонкой настройки. |
list |
string |
Этот объект представляет список других объектов. |
model |
string |
Этот объект представляет модель (может быть базовой моделью или результатом точной настройки задания). |
upload |
string |
Этот объект представляет отправку файла. |
upload.part |
string |
Этот объект представляет часть отправки файла. |