Dela via

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

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

Objekt

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

minLength: 1

Meddelandet om det här felet.
target

string

Platsen där felet inträffade om det var tillgängligt.

ErrorCode

Uppräkning

ErrorCode

Värde Description
conflict

Den begärda åtgärden står i konflikt med det aktuella resurstillståndet.
contentFilter

Bildgenereringen misslyckades till följd av vårt säkerhetssystem.
fileImportFailed

Det gick inte att importera filen.
forbidden

Åtgärden är förbjuden för den aktuella användaren/API-nyckeln.
internalFailure

Internt fel. Försök igen.
invalidPayload

Begärandedata är ogiltiga för den här åtgärden.
itemDoesAlreadyExist

Objektet finns redan.
jsonlValidationFailed

Verifieringen av jsonl-data misslyckades.
notFound

Det går inte att hitta resursen.
quotaExceeded

Kvoten har överskridits.
serviceUnavailable

Tjänsten är inte tillgänglig för närvarande.
tooManyRequests

För många begäranden. Försök igen senare.
unauthorized

Den aktuella användar-/API-nyckeln har inte behörighet för åtgärden.
unexpectedEntityState

Åtgärden kan inte köras i den aktuella resursens tillstånd.

ErrorResponse

Objekt

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

Objekt

FileDelete

Name Typ Description
deleted

boolean

Ett värde som anger om filen har tagits bort.
id

string

minLength: 1

Fil-ID:t som togs bort.
object

TypeDiscriminator

TypeDiscriminator
Definierar typen av ett objekt.

InnerError

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

Uppräkning

InnerErrorCode

Värde Description
invalidPayload

Begärandedata är ogiltiga för den här åtgärden.

TypeDiscriminator

Uppräkning

TypeDiscriminator

Värde Description
batch

Det här objektet representerar en batch.
file

Det här objektet representerar en fil.
fine_tuning.job

Det här objektet representerar ett finjusterat jobb.
fine_tuning.job.checkpoint

Det här objektet representerar en kontrollpunkt för ett finjusteringsjobb.
fine_tuning.job.event

Det här objektet representerar en händelse av ett finjusteringsjobb.
list

Det här objektet representerar en lista över andra objekt.
model

Det här objektet representerar en modell (kan vara en basmodell eller finjustera jobbresultatet).
upload

Det här objektet representerar en filuppladdning.
upload.part

Det här objektet representerar en del av en filuppladdning.