Files - Delete

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-10-21

Usuwa plik z danym identyfikatorem pliku. Usunięcie jest również dozwolone, jeśli plik został użyty, np. jako plik szkoleniowy w zadaniu dostrajania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (url)	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą konta usługi Azure OpenAI.
file-id	path	True	string	Identyfikator pliku.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
api-key	True	string	Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	FileDelete	Plik został pomyślnie usunięty.
Other Status Codes	ErrorResponse	Wystąpił błąd.

Zabezpieczenia

api-key

Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Typ: apiKey
W: header

Przykłady

Deleting a file.

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
Error	Błąd
ErrorCode	Kod błędu
ErrorResponse	ErrorResponse
FileDelete	PlikUsuń
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Objekt

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Szczegóły błędu, jeśli są dostępne.
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Komunikat o tym błędzie.
target	string	Lokalizacja, w której wystąpił błąd, jeśli jest dostępny.

ErrorCode

Wyliczanie

Kod błędu

Wartość	Opis
conflict	Żądana operacja powoduje konflikt z bieżącym stanem zasobu.
contentFilter	Generowanie obrazu nie powiodło się w wyniku naszego systemu bezpieczeństwa.
fileImportFailed	Importowanie pliku nie powiodło się.
forbidden	Operacja jest zabroniona dla bieżącego klucza użytkownika/interfejsu API.
internalFailure	Błąd wewnętrzny. Ponów próbę.
invalidPayload	Dane żądania są nieprawidłowe dla tej operacji.
itemDoesAlreadyExist	Element już istnieje.
jsonlValidationFailed	Sprawdzanie poprawności danych jsonl nie powiodło się.
notFound	Nie można odnaleźć zasobu.
quotaExceeded	Przekroczono limit przydziału.
serviceUnavailable	Usługa jest obecnie niedostępna.
tooManyRequests	Zbyt wiele żądań. Spróbuj ponownie później.
unauthorized	Bieżący klucz użytkownika/interfejsu API nie jest autoryzowany dla operacji.
unexpectedEntityState	Nie można wykonać operacji w stanie bieżącego zasobu.

ErrorResponse

Objekt

ErrorResponse

Nazwa	Typ	Opis
error	Error	Błąd Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FileDelete

Objekt

PlikUsuń

Nazwa	Typ	Opis
deleted	boolean	Wartość wskazująca, czy plik został usunięty.
id	string minLength: 1	Identyfikator pliku, który został usunięty.
object	TypeDiscriminator	TypeDiscriminator Definiuje typ obiektu.

InnerError

Objekt

InnerError

Nazwa	Typ	Opis
code	InnerErrorCode	InnerErrorCode Wewnętrzne kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Wyliczanie

InnerErrorCode

Wartość	Opis
invalidPayload	Dane żądania są nieprawidłowe dla tej operacji.

TypeDiscriminator

Wyliczanie

TypeDiscriminator

Wartość	Opis
batch	Ten obiekt reprezentuje partię.
file	Ten obiekt reprezentuje plik.
fine_tuning.job	Ten obiekt reprezentuje zadanie dostrajania.
fine_tuning.job.checkpoint	Ten obiekt reprezentuje punkt kontrolny zadania dostrajania.
fine_tuning.job.event	Ten obiekt reprezentuje zdarzenie zadania dostrajania.
list	Ten obiekt reprezentuje listę innych obiektów.
model	Ten obiekt reprezentuje model (może być modelem bazowym lub dostrajać wynik zadania).
upload	Ten obiekt reprezentuje przekazywanie pliku.
upload.part	Ten obiekt reprezentuje część przekazywania plików.