Files - Delete

Référence

Service:: Azure AI Services

Version d'API:: 2024-10-21

Supprime le fichier avec l’ID de fichier donné. La suppression est également autorisée si un fichier a été utilisé, par exemple en tant que fichier d’apprentissage dans un travail d’optimisation.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre compte Azure OpenAI).
file-id	path	True	string	Identificateur du fichier.
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
api-key	True	string	Fournissez votre clé de compte Azure OpenAI Cognitive Services ici.

Réponses

Nom	Type	Description
200 OK	FileDelete	Le fichier a été supprimé avec succès.
Other Status Codes	ErrorResponse	Une erreur s’est produite.

Sécurité

api-key

Fournissez votre clé de compte Azure OpenAI Cognitive Services ici.

Type: apiKey
Dans: header

Exemples

Deleting a file.

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
Error	Erreur
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FileDelete	FileDelete
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Erreur

Nom	Type	Description
code	ErrorCode	ErrorCode Codes d’erreur tels que définis dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Détails de l’erreur s’il est disponible.
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Message de cette erreur.
target	string	Emplacement où l’erreur s’est produite si disponible.

ErrorCode

Nom	Type	Description
conflict	string	L’opération demandée est en conflit avec l’état de ressource actuel.
contentFilter	string	La génération d’images a échoué suite à notre système de sécurité.
fileImportFailed	string	Échec de l’importation du fichier.
forbidden	string	L’opération est interdite pour la clé utilisateur/API actuelle.
internalFailure	string	Erreur interne. Réessayez.
invalidPayload	string	Les données de requête ne sont pas valides pour cette opération.
itemDoesAlreadyExist	string	L’élément existe déjà.
jsonlValidationFailed	string	Échec de la validation des données jsonl.
notFound	string	La ressource est introuvable.
quotaExceeded	string	Quota dépassé.
serviceUnavailable	string	Le service n’est actuellement pas disponible.
tooManyRequests	string	Trop de demandes. Réessayez ultérieurement.
unauthorized	string	La clé utilisateur/API actuelle n’est pas autorisée pour l’opération.
unexpectedEntityState	string	L’opération ne peut pas être exécutée dans l’état de la ressource actuelle.

ErrorResponse

Nom	Type	Description
error	Error	Erreur Contenu d’erreur tel que défini dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FileDelete

Nom	Type	Description
deleted	boolean	Valeur indiquant si le fichier a été supprimé.
id	string	ID de fichier qui a été supprimé.
object	TypeDiscriminator	TypeDiscriminator Définit le type d’un objet.

InnerError

Nom	Type	Description
code	InnerErrorCode	InnerErrorCode Codes d’erreur internes tels que définis dans les instructions MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nom	Type	Description
invalidPayload	string	Les données de requête ne sont pas valides pour cette opération.

TypeDiscriminator

Nom	Type	Description
batch	string	Cet objet représente un lot.
file	string	Cet objet représente un fichier.
fine_tuning.job	string	Cet objet représente un travail d’optimisation.
fine_tuning.job.checkpoint	string	Cet objet représente un point de contrôle d’un travail de réglage précis.
fine_tuning.job.event	string	Cet objet représente un événement d’un travail de réglage précis.
list	string	Cet objet représente une liste d’autres objets.
model	string	Cet objet représente un modèle (il peut s’agir d’un modèle de base ou d’un résultat de travail affiné).
upload	string	Cet objet représente un chargement de fichier.
upload.part	string	Cet objet représente une partie d’un chargement de fichier.

Partager via