Vector Store Files - List Vector Store Files

Servizio:

AI Foundry

Versione API:

v1

Restituisce un elenco di file dell’archivio di vettori.

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

Con parametri facoltativi:

GET {endpoint}/vector_stores/{vectorStoreId}/files?filter={filter}&api-version=v1&limit={limit}&order={order}&after={after}&before={before}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	Punto finale del progetto sotto forma di: https://.services.ai.azure.com/api/projects/
vectorStoreId	path	True	string	Identificatore del negozio vettoriale.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
after	query		string	Cursore da usare nella paginazione. dopo è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere after=obj_foo per recuperare la pagina successiva dell'elenco.
before	query		string	Cursore da usare nella paginazione. prima di è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco.
filter	query		VectorStoreFileStatusFilter	Filtrare in base allo stato del file.
limit	query		integer (int32)	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query		ListSortOrder	Ordinare in base al timestamp created_at degli oggetti. asc per ordine crescente e desc per l'ordine decrescente.

Risposte

Nome	Tipo	Descrizione
200 OK		La richiesta ha avuto esito positivo.
Other Status Codes	AgentV1Error	Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://ai.azure.com/.default

Esempio

VectorStoreFiles_ListVectorStoreFiles_MaximumSet

VectorStoreFiles_ListVectorStoreFiles_MinimumSet

VectorStoreFiles_ListVectorStoreFiles_MaximumSet

Esempio di richiesta

HTTP

GET {endpoint}/vector_stores/pxdgb/files?filter=in_progress&api-version=v1&limit=4&order=asc&after=skpeflglzjqbdnnxkfwzzfnwstfzng&before=xvqowfdzmyyyaerkecvd

Risposta di esempio

Codice di stato:

200

{
  "data": [
    {
      "id": "yqeohdhcu",
      "object": "vector_store.file",
      "usage_bytes": 12,
      "created_at": 29,
      "vector_store_id": "ppsgzjawikryevzvdusrtgxttrrmbl",
      "status": "in_progress",
      "last_error": {
        "code": "server_error",
        "message": "occbex"
      },
      "chunking_strategy": {
        "type": "VectorStoreChunkingStrategyResponse"
      }
    }
  ],
  "last_id": "xgjovhnxkkdxpudglbqx",
  "has_more": true
}

VectorStoreFiles_ListVectorStoreFiles_MinimumSet

Esempio di richiesta

HTTP

GET {endpoint}/vector_stores/nrmazftjcponrcnqfsz/files?api-version=v1

Risposta di esempio

Codice di stato:

200

{
  "data": [
    {
      "id": "yqeohdhcu",
      "object": "vector_store.file",
      "usage_bytes": 12,
      "created_at": 29,
      "vector_store_id": "ppsgzjawikryevzvdusrtgxttrrmbl",
      "status": "in_progress",
      "last_error": {
        "code": "server_error",
        "message": "occbex"
      },
      "chunking_strategy": {
        "type": "VectorStoreChunkingStrategyResponse"
      }
    }
  ],
  "has_more": true
}

Definizioni

Nome	Descrizione
AgentErrorDetail	Descrive le informazioni sull'errore restituite dall'API degli agenti.
AgentV1Error	Payload di errore restituito dall'API degli agenti.
ListSortOrder	Le opzioni di ordinamento disponibili quando si richiede un elenco di oggetti di risposta.
VectorStoreFileStatusFilter	Filtro dei parametri di query per l'endpoint di recupero dei file dell'archivio vettoriale

AgentErrorDetail

Object

Descrive le informazioni sull'errore restituite dall'API degli agenti.

Nome	Tipo	Descrizione
code	string	Codice di errore leggibile dalla macchina.
message	string	Descrizione leggibile dell'errore.
param	string	Nome del parametro che ha causato l'errore, se applicabile.
type	string	Identificatore del tipo di errore (ad es. invalid_request_error).

AgentV1Error

Object

Payload di errore restituito dall'API degli agenti.

Nome	Tipo	Descrizione
error	AgentErrorDetail	Rappresenta l'errore.

ListSortOrder

Enumerazione

Le opzioni di ordinamento disponibili quando si richiede un elenco di oggetti di risposta.

Valore	Descrizione
asc	Specifica un ordinamento crescente.
desc	Specifica un ordinamento decrescente.

VectorStoreFileStatusFilter

Enumerazione

Filtro dei parametri di query per l'endpoint di recupero dei file dell'archivio vettoriale

Valore	Descrizione
cancelled	Recupera solo i file che sono stati annullati
completed	Recupera solo i file che sono stati elaborati correttamente
failed	Recupera solo i file che non sono stati elaborati
in_progress	Recupera solo i file attualmente in fase di elaborazione