Vector Store Files - Delete Vector Store File

Usługa:

AI Foundry

Wersja interfejsu API:

v1

Usuwa plik magazynu wektorów. Spowoduje to usunięcie łącza plik-do sklepu (nie spowoduje to usunięcia samego pliku).

DELETE {endpoint}/vector_stores/{vectorStoreId}/files/{fileId}?api-version=v1

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Punkt końcowy projektu w postaci: https://.services.ai.azure.com/api/projects/
fileId	path	True	string	Identyfikator pliku.
vectorStoreId	path	True	string	Identyfikator składnicy wektorów.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VectorStoreFileDeletionStatus	Żądanie zakończyło się pomyślnie.
Other Status Codes	AgentV1Error	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://ai.azure.com/.default

Przykłady

VectorStoreFiles_DeleteVectorStoreFile_MaximumSet

VectorStoreFiles_DeleteVectorStoreFile_MinimumSet

VectorStoreFiles_DeleteVectorStoreFile_MaximumSet

Przykładowe żądanie

HTTP

DELETE {endpoint}/vector_stores/oiahkyqjlkwxgmelrwoxc/files/rfgkesorimtijceyrt?api-version=v1

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "lv",
  "deleted": true,
  "object": "vector_store.file.deleted"
}

VectorStoreFiles_DeleteVectorStoreFile_MinimumSet

Przykładowe żądanie

HTTP

DELETE {endpoint}/vector_stores/kepdsihxekrxejfclyuwfyvbz/files/alustadyecwlinwtcycjmpelbcxs?api-version=v1

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "lv",
  "deleted": true,
  "object": "vector_store.file.deleted"
}

Definicje

Nazwa	Opis
AgentErrorDetail	Opisuje informacje o błędach zwracane przez interfejs API agentów.
AgentV1Error	Ładunek błędu zwrócony przez interfejs API agentów.
VectorStoreFileDeletionStatus	Obiekt odpowiedzi na potrzeby usuwania relacji pliku magazynu wektorów.

AgentErrorDetail

Objekt

Opisuje informacje o błędach zwracane przez interfejs API agentów.

Nazwa	Typ	Opis
code	string	Kod błędu nadający się do odczytu maszynowego.
message	string	Opis błędu czytelny dla człowieka.
param	string	Nazwa parametru, który spowodował błąd, jeśli dotyczy.
type	string	Identyfikator typu błędu (np. invalid_request_error).

AgentV1Error

Objekt

Ładunek błędu zwrócony przez interfejs API agentów.

Nazwa	Typ	Opis
error	AgentErrorDetail	Reprezentuje błąd.

VectorStoreFileDeletionStatus

Objekt

Obiekt odpowiedzi na potrzeby usuwania relacji pliku magazynu wektorów.

Nazwa	Typ	Opis
deleted	boolean	Wartość wskazująca, czy usunięcie zakończyło się pomyślnie.
id	string	Identyfikator zasobu określonego do usunięcia.
object	enum: vector_store.file.deleted	Typ obiektu, który jest zawsze "vector_store.deleted".