Files - Delete

Referens

Tjänst:: Azure AI Services

API-version:: 2024-10-21

Tar bort filen med det angivna fil-ID:t. Borttagning tillåts också om en fil används, t.ex. som träningsfil i ett finjusterat jobb.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-kontonamn).
file-id	path	True	string	Identifieraren för filen.
api-version	query	True	string	Den begärda API-versionen.

Begärandehuvud

Name	Obligatorisk	Typ	Description
api-key	True	string	Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Svar

Name	Typ	Description
200 OK	FileDelete	Filen har tagits bort.
Other Status Codes	ErrorResponse	Ett fel uppstod.

Säkerhet

api-key

Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Typ: apiKey
I: header

Exempel

Deleting a file.

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
Error	Fel
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FileDelete	FileDelete
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Fel

Name	Typ	Description
code	ErrorCode	ErrorCode Felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Felinformationen om den är tillgänglig.
innererror	InnerError	InnerError Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Meddelandet om det här felet.
target	string	Platsen där felet inträffade om det var tillgängligt.

ErrorCode

Name	Typ	Description
conflict	string	Den begärda åtgärden står i konflikt med det aktuella resurstillståndet.
contentFilter	string	Bildgenereringen misslyckades till följd av vårt säkerhetssystem.
fileImportFailed	string	Det gick inte att importera filen.
forbidden	string	Åtgärden är förbjuden för den aktuella användaren/API-nyckeln.
internalFailure	string	Internt fel. Försök igen.
invalidPayload	string	Begärandedata är ogiltiga för den här åtgärden.
itemDoesAlreadyExist	string	Objektet finns redan.
jsonlValidationFailed	string	Verifieringen av jsonl-data misslyckades.
notFound	string	Det går inte att hitta resursen.
quotaExceeded	string	Kvoten har överskridits.
serviceUnavailable	string	Tjänsten är inte tillgänglig för närvarande.
tooManyRequests	string	För många begäranden. Försök igen senare.
unauthorized	string	Den aktuella användar-/API-nyckeln har inte behörighet för åtgärden.
unexpectedEntityState	string	Åtgärden kan inte köras i den aktuella resursens tillstånd.

ErrorResponse

Name	Typ	Description
error	Error	Fel Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FileDelete

Name	Typ	Description
deleted	boolean	Ett värde som anger om filen har tagits bort.
id	string	Fil-ID:t som togs bort.
object	TypeDiscriminator	TypeDiscriminator Definierar typen av ett objekt.

InnerError

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Typ	Description
invalidPayload	string	Begärandedata är ogiltiga för den här åtgärden.

TypeDiscriminator

Name	Typ	Description
batch	string	Det här objektet representerar en batch.
file	string	Det här objektet representerar en fil.
fine_tuning.job	string	Det här objektet representerar ett finjusterat jobb.
fine_tuning.job.checkpoint	string	Det här objektet representerar en kontrollpunkt för ett finjusteringsjobb.
fine_tuning.job.event	string	Det här objektet representerar en händelse av ett finjusteringsjobb.
list	string	Det här objektet representerar en lista över andra objekt.
model	string	Det här objektet representerar en modell (kan vara en basmodell eller finjustera jobbresultatet).
upload	string	Det här objektet representerar en filuppladdning.
upload.part	string	Det här objektet representerar en del av en filuppladdning.

Dela via