Поделиться через

Files - Delete

  • Ссылка
Служба:
Azure AI Services
Версия API:
2024-10-21

Удаляет файл с заданным идентификатором файла. Удаление также допускается, если файл использовался, например в качестве обучающего файла в задании точной настройки.

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

FileDelete

Файл успешно удален.
Other Status Codes

ErrorResponse

Произошла ошибка.

Безопасность

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

Пример ответа

Код состояния:
200 
{
  "object": "file",
  "deleted": true,
  "id": "file-181a1cbdcdcf4677ada87f63a0928099"
}

Определения

Имя Описание
Error

Ошибка
ErrorCode

Код ошибки
ErrorResponse

ErrorResponse
FileDelete

FileDelete
InnerError

InnerError
InnerErrorCode

InnerErrorCode
TypeDiscriminator

TypeDiscriminator

Error

Object

Ошибка

Имя Тип Описание
code

ErrorCode

Код ошибки
Коды ошибок, определенные в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details

Error[]

Сведения об ошибке, если они доступны.
innererror

InnerError

InnerError
Внутренняя ошибка, определенная в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message

string

minLength: 1

Сообщение об этой ошибке.
target

string

Расположение, в котором произошла ошибка, если она доступна.

ErrorCode

Перечисление

Код ошибки

Значение Описание
conflict

Запрошенная операция конфликтует с текущим состоянием ресурса.
contentFilter

Сбой создания изображений в результате нашей системы безопасности.
fileImportFailed

Сбой импорта файла.
forbidden

Операция запрещена для текущего ключа пользователя или API.
internalFailure

Внутренняя ошибка. Повторите попытку.
invalidPayload

Данные запроса недопустимы для этой операции.
itemDoesAlreadyExist

Элемент уже существует.
jsonlValidationFailed

Сбой проверки данных jsonl.
notFound

Ресурс не найден.
quotaExceeded

Превышена квота.
serviceUnavailable

В настоящее время служба недоступна.
tooManyRequests

Слишком много запросов. Повторите попытку позже.
unauthorized

Текущий ключ пользователя или API не авторизован для операции.
unexpectedEntityState

Невозможно выполнить операцию в состоянии текущего ресурса.

ErrorResponse

Object

ErrorResponse

Имя Тип Описание
error

Error

Ошибка
Содержимое ошибки, определенное в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FileDelete

Object

FileDelete

Имя Тип Описание
deleted

boolean

Значение, указывающее, возвращается ли файл, если файл был удален.
id

string

minLength: 1

Идентификатор файла, который был удален.
object

TypeDiscriminator

TypeDiscriminator
Определяет тип объекта.

InnerError

Object

InnerError

Имя Тип Описание
code

InnerErrorCode

InnerErrorCode
Внутренние коды ошибок, определенные в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror

InnerError

InnerError
Внутренняя ошибка, определенная в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Перечисление

InnerErrorCode

Значение Описание
invalidPayload

Данные запроса недопустимы для этой операции.

TypeDiscriminator

Перечисление

TypeDiscriminator

Значение Описание
batch

Этот объект представляет пакет.
file

Этот объект представляет файл.
fine_tuning.job

Этот объект представляет точное задание настройки.
fine_tuning.job.checkpoint

Этот объект представляет контрольную точку задания тонкой настройки.
fine_tuning.job.event

Этот объект представляет событие задания тонкой настройки.
list

Этот объект представляет список других объектов.
model

Этот объект представляет модель (может быть базовой моделью или результатом точной настройки задания).
upload

Этот объект представляет отправку файла.
upload.part

Этот объект представляет часть отправки файла.