Files - Delete

Reference

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

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	Zpráva o této chybě.
target	string	Umístění, kde k chybě došlo, pokud je k dispozici.

ErrorCode

Kód chyby

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

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

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

InnerError

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

Name	Typ	Description
invalidPayload	string	Data požadavku jsou pro tuto operaci neplatná.

TypeDiscriminator

Type Nábídka

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

Sdílet prostřednictvím