Files - Delete

Servicio:

Azure AI Services

Versión de la API:

2024-10-21

Elimina el archivo con el identificador de archivo especificado. También se permite la eliminación si se usó un archivo, por ejemplo, como archivo de entrenamiento en un trabajo de ajuste.

DELETE {endpoint}/openai/files/{file-id}?api-version=2024-10-21

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (url)	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre de la cuenta de Azure OpenAI).
file-id	path	True	string	Identificador del archivo.
api-version	query	True	string	La versión de API solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
api-key	True	string	Proporcione la clave de cuenta de Azure OpenAI de Cognitive Services aquí.

Respuestas

Nombre	Tipo	Description
200 OK	FileDelete	El archivo se eliminó correctamente.
Other Status Codes	ErrorResponse	Error.

Seguridad

api-key

Proporcione la clave de cuenta de Azure OpenAI de Cognitive Services aquí.

Tipo: apiKey
En: header

Ejemplos

Deleting a file.

Solicitud de ejemplo

HTTP

DELETE https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099?api-version=2024-10-21

Respuesta de muestra

status code:

200

{
  "object": "file",
  "deleted": true,
  "id": "file-181a1cbdcdcf4677ada87f63a0928099"
}

Definiciones

Nombre	Description
Error	Error
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FileDelete	FileDelete
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Object

Error

Nombre	Tipo	Description
code	ErrorCode	ErrorCode Códigos de error tal como se definen en las directrices de REST de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Los detalles del error si están disponibles.
innererror	InnerError	InnerError Error interno tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Mensaje de este error.
target	string	Ubicación donde se produjo el error si está disponible.

ErrorCode

Enumeración

ErrorCode

Valor	Description
conflict	La operación solicitada entra en conflicto con el estado de recurso actual.
contentFilter	Se produjo un error en la generación de imágenes como resultado de nuestro sistema de seguridad.
fileImportFailed	Error en la importación del archivo.
forbidden	La operación está prohibida para la clave de usuario o API actual.
internalFailure	Error interno. Vuelva a intentarlo.
invalidPayload	Los datos de solicitud no son válidos para esta operación.
itemDoesAlreadyExist	El elemento ya existe.
jsonlValidationFailed	Error en la validación de datos jsonl.
notFound	No se encuentra el recurso.
quotaExceeded	Se superó la cuota.
serviceUnavailable	El servicio no está disponible actualmente.
tooManyRequests	Demasiadas solicitudes. Vuelva a intentarlo más tarde.
unauthorized	La clave de usuario o API actual no está autorizada para la operación.
unexpectedEntityState	La operación no se puede ejecutar en el estado del recurso actual.

ErrorResponse

Object

ErrorResponse

Nombre	Tipo	Description
error	Error	Error Contenido de error tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FileDelete

Object

FileDelete

Nombre	Tipo	Description
deleted	boolean	Valor que indica si se ha eliminado el archivo.
id	string minLength: 1	Identificador de archivo que se eliminó.
object	TypeDiscriminator	TypeDiscriminator Define el tipo de un objeto .

InnerError

Object

InnerError

Nombre	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de error internos tal como se definen en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Error interno tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Enumeración

InnerErrorCode

Valor	Description
invalidPayload	Los datos de solicitud no son válidos para esta operación.

TypeDiscriminator

Enumeración

TypeDiscriminator

Valor	Description
batch	Este objeto representa un lote.
file	Este objeto representa un archivo.
fine_tuning.job	Este objeto representa un trabajo de ajuste preciso.
fine_tuning.job.checkpoint	Este objeto representa un punto de control de un trabajo de ajuste fino.
fine_tuning.job.event	Este objeto representa un evento de un trabajo de ajuste fino.
list	Este objeto representa una lista de otros objetos.
model	Este objeto representa un modelo (puede ser un modelo base o ajustar el resultado del trabajo).
upload	Este objeto representa una carga de archivos.
upload.part	Este objeto representa parte de una carga de archivos.