Files - Delete

Služba:

Azure AI Services

Verze rozhraní API:

2024-10-21

Odstraní soubor s daným ID souboru. Odstranění je také povoleno, pokud byl použit soubor, například jako trénovací soubor v úloze vyladění.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (url)	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem účtu Azure OpenAI).
file-id	path	True	string	Identifikátor souboru.
api-version	query	True	string	Požadovaná verze rozhraní API.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
api-key	True	string	Tady zadejte svůj klíč účtu Azure OpenAI služeb Cognitive Services.

Odpovědi

Name	Typ	Description
200 OK	FileDelete	Soubor byl úspěšně odstraněn.
Other Status Codes	ErrorResponse	Došlo k chybě.

Zabezpečení

api-key

Tady zadejte svůj klíč účtu Azure OpenAI služeb Cognitive Services.

Typ: apiKey
V: header

Příklady

Deleting a file.

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
Error	Chyba
ErrorCode	Kód chyby
ErrorResponse	ErrorResponse
FileDelete	FileDelete
InnerError	Vnitřní chyba
InnerErrorCode	InnerErrorCode
TypeDiscriminator	Type Nábídka

Error

Objekt

Chyba

Name	Typ	Description
code	ErrorCode	Kód chyby Kódy chyb definované v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Podrobnosti o chybě, pokud jsou k dispozici.
innererror	InnerError	Vnitřní chyba Vnitřní chyba definovaná v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Zpráva o této chybě.
target	string	Umístění, kde k chybě došlo, pokud je k dispozici.

ErrorCode

Výčet

Kód chyby

Hodnota	Description
conflict	Požadovaná operace je v konfliktu s aktuálním stavem prostředku.
invalidPayload	Data požadavku jsou pro tuto operaci neplatná.
forbidden	Operace je zakázaná pro aktuální klíč uživatele nebo rozhraní API.
notFound	Prostředek nebyl nalezen.
unexpectedEntityState	Operaci nelze spustit ve stavu aktuálního prostředku.
itemDoesAlreadyExist	Položka již existuje.
serviceUnavailable	Služba není aktuálně dostupná.
internalFailure	Vnitřní chyba. Zkuste to prosím znovu.
quotaExceeded	Kvóta byla překročena.
jsonlValidationFailed	Ověření dat jsonl se nezdařilo.
fileImportFailed	Import souboru se nezdařil.
tooManyRequests	Příliš mnoho požadavků. Zkuste to prosím znovu později.
unauthorized	Aktuální klíč uživatele nebo rozhraní API není pro operaci autorizovaný.
contentFilter	Generování obrázků selhalo v důsledku našeho bezpečnostního systému.

ErrorResponse

Objekt

ErrorResponse

Name	Typ	Description
error	Error	Chyba Obsah chyby definovaný v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FileDelete

Objekt

FileDelete

Name	Typ	Description
deleted	boolean	Hodnota označující, zda je soubor odstraněn.
id	string minLength: 1	ID souboru, které bylo odstraněno.
object	TypeDiscriminator	Type Nábídka Definuje typ objektu.

InnerError

Objekt

Vnitřní chyba

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Vnitřní kódy chyb definované v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	Vnitřní chyba Vnitřní chyba definovaná v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Výčet

InnerErrorCode

Hodnota	Description
invalidPayload	Data požadavku jsou pro tuto operaci neplatná.

TypeDiscriminator

Výčet

Type Nábídka

Hodnota	Description
list	Tento objekt představuje seznam dalších objektů.
fine_tuning.job	Tento objekt představuje doladění úlohy.
file	Tento objekt představuje soubor.
fine_tuning.job.event	Tento objekt představuje událost úlohy jemného ladění.
fine_tuning.job.checkpoint	Tento objekt představuje kontrolní bod úlohy jemného ladění.
model	Tento objekt představuje model (může to být základní model nebo vyladění výsledku úlohy).
batch	Tento objekt představuje dávku.
upload	Tento objekt představuje nahrání souboru.
upload.part	Tento objekt představuje část nahrávání souboru.