Delen via

Files - Delete

  • Referentie
Service:
Azure AI Services
API-versie:
2024-10-21

Hiermee verwijdert u het bestand met de opgegeven bestands-id. Verwijderen is ook toegestaan als een bestand is gebruikt, bijvoorbeeld als trainingsbestand in een taak voor het afstemmen.

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

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string (url)

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-account).
file-id
 path True

string

De id van het bestand.
api-version
 query True

string

De aangevraagde API-versie.

Aanvraagkoptekst

Name Vereist Type Description
api-key True

string

Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Antwoorden

Name Type Description
200 OK

FileDelete

Het bestand is verwijderd.
Other Status Codes

ErrorResponse

Er is een fout opgetreden.

Beveiliging

api-key

Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Type: apiKey
In: header

Voorbeelden

Deleting a file.

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Error

Fout
ErrorCode

Foutcode
ErrorResponse

ErrorResponse
FileDelete

FileDelete
InnerError

InnerError
InnerErrorCode

InnerErrorCode
TypeDiscriminator

TypeDiscriminator

Error

Object

Fout

Name Type Description
code

ErrorCode

Foutcode
Foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details

Error[]

De foutdetails indien beschikbaar.
innererror

InnerError

InnerError
Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message

string

minLength: 1

Het bericht van deze fout.
target

string

De locatie waar de fout is opgetreden, indien beschikbaar.

ErrorCode

Inventarisatie

Foutcode

Waarde Description
conflict

De aangevraagde bewerking conflicteert met de huidige resourcestatus.
contentFilter

Het genereren van installatiekopieën is mislukt als gevolg van ons veiligheidssysteem.
fileImportFailed

Importeren van bestand is mislukt.
forbidden

De bewerking is verboden voor de huidige gebruiker/API-sleutel.
internalFailure

Interne fout. Probeer het opnieuw.
invalidPayload

De aanvraaggegevens zijn ongeldig voor deze bewerking.
itemDoesAlreadyExist

Het item bestaat al.
jsonlValidationFailed

Validatie van jsonl-gegevens is mislukt.
notFound

De resource is niet gevonden.
quotaExceeded

Het quotum is overschreden.
serviceUnavailable

De service is momenteel niet beschikbaar.
tooManyRequests

Te veel aanvragen. Probeer het later opnieuw.
unauthorized

De huidige sleutel van de gebruiker/API is niet geautoriseerd voor de bewerking.
unexpectedEntityState

De bewerking kan niet worden uitgevoerd in de status van de huidige resource.

ErrorResponse

Object

ErrorResponse

Name Type Description
error

Error

Fout
Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FileDelete

Object

FileDelete

Name Type Description
deleted

boolean

Een waarde die aangeeft of het bestand wordt verwijderd.
id

string

minLength: 1

De bestands-id die is verwijderd.
object

TypeDiscriminator

TypeDiscriminator
Hiermee definieert u het type van een object.

InnerError

Object

InnerError

Name Type Description
code

InnerErrorCode

InnerErrorCode
Interne foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror

InnerError

InnerError
Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Inventarisatie

InnerErrorCode

Waarde Description
invalidPayload

De aanvraaggegevens zijn ongeldig voor deze bewerking.

TypeDiscriminator

Inventarisatie

TypeDiscriminator

Waarde Description
batch

Dit object vertegenwoordigt een batch.
file

Dit object vertegenwoordigt een bestand.
fine_tuning.job

Dit object vertegenwoordigt een taak voor het afstemmen.
fine_tuning.job.checkpoint

Dit object vertegenwoordigt een controlepunt van een taak voor het afstemmen.
fine_tuning.job.event

Dit object vertegenwoordigt een gebeurtenis van een taak voor het afstemmen.
list

Dit object vertegenwoordigt een lijst met andere objecten.
model

Dit object vertegenwoordigt een model (kan een basismodel zijn of taakresultaat verfijnen).
upload

Dit object vertegenwoordigt een bestand uploaden.
upload.part

Dit object vertegenwoordigt een deel van een bestandsupload.