Aller au contenu

Obtenir une liste de documents dans 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.

Exemples de Requêtes

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

Info

Remplacez VOTRE_CLE_API par votre véritable clé API de Vector Store et vs_abc123 par votre ID de 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': 'VOTRE_CLE_API'
    }
  });

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

getVectorStoreDocuments('vs_abc123');

Info

Remplacez VOTRE_CLE_API par votre véritable clé API de Vector Store et vs_abc123 par votre ID de Vector Store.

import requests

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

    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

Remplacez VOTRE_CLE_API par votre véritable clé API de Vector Store et vs_abc123 par votre ID de Vector Store.

Paramètres de chemin

Paramètre Type Description
vector-store-id string Requis. L'ID du magasin de vecteurs à partir duquel lister les documents.

Format de Réponse

[
  {
    "id": 1234,
    "name": "Manuel du Produit.pdf",
    "type": "application/pdf",
    "vector_store": "vs_abc123",
    "size": 250000,
    "status": "indexé",
    "processing_status": "terminé",
    "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": "Spécifications Techniques.docx",
    "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "vector_store": "vs_abc123",
    "size": 125000,
    "status": "indexé",
    "processing_status": "terminé",
    "indexed_on": "2023-06-15T11:45:00Z",
    "status_error_message": null,
    "created": "2023-06-15T11:30:00Z",
    "modified": "2023-06-15T11:45:00Z"
  }
]

Authentification

Ce point de terminaison nécessite une authentification à l'aide d'une clé API dans l'en-tête x-api-key.

Réponses d'erreur

Code d'état Description
401 Non autorisé - Clé API invalide ou manquante
404 Non trouvé - Magasin de vecteurs non trouvé
500 Erreur interne du serveur

Ce point de terminaison récupère une liste de tous les documents stockés dans le magasin de vecteurs spécifié. Il fournit des métadonnées sur chaque document, y compris l'état de traitement du document, la taille et l'horodatage indexé. Ces informations sont utiles pour surveiller le contenu de votre magasin de vecteurs et vérifier l'état de traitement des documents.