Files - Delete

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-10-21

Löscht die Datei mit der angegebenen Datei-ID. Das Löschen ist auch zulässig, wenn eine Datei verwendet wurde, z. B. als Schulungsdatei in einem Feinabstimmungsauftrag.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Kontonamen.
file-id	path	True	string	Der Bezeichner der Datei.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
api-key	True	string	Stellen Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services bereit.

Antworten

Name	Typ	Beschreibung
200 OK	FileDelete	Die Datei wurde erfolgreich gelöscht.
Other Status Codes	ErrorResponse	Fehler.

Sicherheit

api-key

Stellen Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services bereit.

Typ: apiKey
In: header

Beispiele

Deleting a file.

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
Error	Fehler
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FileDelete	FileDelete
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Fehler

Name	Typ	Beschreibung
code	ErrorCode	ErrorCode Fehlercodes gemäß der Definition in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Die Fehlerdetails, falls verfügbar.
innererror	InnerError	InnerError Innerer Fehler gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Die Meldung dieses Fehlers.
target	string	Der Ort, an dem der Fehler aufgetreten ist, falls verfügbar.

ErrorCode

Name	Typ	Beschreibung
conflict	string	Der angeforderte Vorgang ist mit dem aktuellen Ressourcenstatus in Konflikt.
contentFilter	string	Die Bildgenerierung ist aufgrund unseres Sicherheitssystems fehlgeschlagen.
fileImportFailed	string	Fehler beim Importieren der Datei.
forbidden	string	Der Vorgang ist für den aktuellen Benutzer-/API-Schlüssel verboten.
internalFailure	string	Interner Fehler. Versuchen Sie es erneut.
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.
itemDoesAlreadyExist	string	Das Element ist bereits vorhanden.
jsonlValidationFailed	string	Fehler bei der Überprüfung von JSONL-Daten.
notFound	string	Die Ressource wurde nicht gefunden.
quotaExceeded	string	Das Kontingent wurde überschritten.
serviceUnavailable	string	Der Dienst ist derzeit nicht verfügbar.
tooManyRequests	string	Zu viele Anforderungen. Versuchen Sie es später erneut.
unauthorized	string	Der aktuelle Benutzer-/API-Schlüssel ist für den Vorgang nicht autorisiert.
unexpectedEntityState	string	Der Vorgang kann nicht im Zustand der aktuellen Ressource ausgeführt werden.

ErrorResponse

Name	Typ	Beschreibung
error	Error	Fehler Fehlerinhalte gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FileDelete

Name	Typ	Beschreibung
deleted	boolean	Ein Wert, der angibt, ob die Datei gelöscht wurde.
id	string	Die Datei-ID, die gelöscht wurde.
object	TypeDiscriminator	TypeDiscriminator Definiert den Typ eines Objekts.

InnerError

Name	Typ	Beschreibung
code	InnerErrorCode	InnerErrorCode Innere Fehlercodes gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Innerer Fehler gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Typ	Beschreibung
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.

TypeDiscriminator

Name	Typ	Beschreibung
batch	string	Dieses Objekt stellt einen Batch dar.
file	string	Dieses Objekt stellt eine Datei dar.
fine_tuning.job	string	Dieses Objekt stellt einen Feinabstimmungsauftrag dar.
fine_tuning.job.checkpoint	string	Dieses Objekt stellt einen Prüfpunkt eines Feinabstimmungsauftrags dar.
fine_tuning.job.event	string	Dieses Objekt stellt ein Ereignis eines Feinabstimmungsauftrags dar.
list	string	Dieses Objekt stellt eine Liste anderer Objekte dar.
model	string	Dieses Objekt stellt ein Modell dar (kann ein Basismodell oder ein Feinabstimmungsauftragsergebnis sein).
upload	string	Dieses Objekt stellt einen Dateiupload dar.
upload.part	string	Dieses Objekt stellt einen Teil eines Dateiuploads dar.

Freigeben über