Vai al contenuto

Ottieni un elenco di documenti in un Vector Store

GET /vector-stores/{vector-store-id}/documents

List all documents in a vector store.

Parameter In Type Required Description
vector-store-id path string yes The ID of the vector store.
x-api-key header string yes The API key for authentication.

Responses

  • 200 — A list of documents.

Esempi di Richieste

curl -X GET   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents   
  -H "x-api-key: YOUR_API_KEY"

Info

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store e vs_abc123 con il tuo ID del Vector Store.

const getVectorStoreDocuments = async (vectorStoreId) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents`, {
    method: 'GET',
    headers: {
      'x-api-key': 'YOUR_API_KEY'
    }
  });

  const data = await response.json();
  console.log(data);
};

getVectorStoreDocuments('vs_abc123');

Info

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store e vs_abc123 con il tuo ID del Vector Store.

import requests

def get_vector_store_documents(vector_store_id):
    headers = {
        "x-api-key": "YOUR_API_KEY"
    }

    response = requests.get(
        f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents",
        headers=headers
    )

    data = response.json()
    print(data)

get_vector_store_documents('vs_abc123')

Info

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store e vs_abc123 con il tuo ID del Vector Store.

Parametri del percorso

Parametro Tipo Descrizione
vector-store-id string Obbligatorio. L'ID del vettore da cui elencare i documenti.

Formato di Risposta

[
  {
    "id": 1234,
    "name": "Manuale del Prodotto.pdf",
    "type": "application/pdf",
    "vector_store": "vs_abc123",
    "size": 250000,
    "status": "indicizzato",
    "processing_status": "completato",
    "indexed_on": "2023-06-15T10:30:00Z",
    "status_error_message": null,
    "created": "2023-06-15T10:15:00Z",
    "modified": "2023-06-15T10:30:00Z"
  },
  {
    "id": 1235,
    "name": "Specifiche Tecniche.docx",
    "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "vector_store": "vs_abc123",
    "size": 125000,
    "status": "indicizzato",
    "processing_status": "completato",
    "indexed_on": "2023-06-15T11:45:00Z",
    "status_error_message": null,
    "created": "2023-06-15T11:30:00Z",
    "modified": "2023-06-15T11:45:00Z"
  }
]

Autenticazione

Questo endpoint richiede autenticazione utilizzando una chiave API nell'intestazione x-api-key.

Risposte di Errore

Codice di Stato Descrizione
401 Non autorizzato - Chiave API non valida o mancante
404 Non trovato - Vector Store non trovato
500 Errore interno del server

Questo endpoint recupera un elenco di tutti i documenti memorizzati nel vector store specificato. Fornisce metadati su ciascun documento, inclusi lo stato di elaborazione del documento, la dimensione e il timestamp indicizzato. Queste informazioni sono utili per monitorare i contenuti del tuo vector store e controllare lo stato di elaborazione dei documenti.