Aller au contenu

Obtenir les informations d'un document

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

Retrieve the information of a document in a Vector Store.

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

Responses

  • 200 — Document details retrieved successfully.

Exemples de Requêtes

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

Info

Remplacez VOTRE_CLE_API par votre véritable clé API de Vector Store, vs_abc123 par votre ID de Vector Store, et 1234 par l'ID du document.

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

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

getDocumentInfo('vs_abc123', 1234);

Info

Remplacez VOTRE_CLE_API par votre véritable clé API de Vector Store, vs_abc123 par votre ID de Vector Store, et 1234 par l'ID du document.

import requests

def get_document_info(vector_store_id, document_id):
    headers = {
        "x-api-key": "VOTRE_CLE_API"
    }

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

    data = response.json()
    print(data)

get_document_info('vs_abc123', 1234)

Info

Remplacez VOTRE_CLE_API par votre véritable clé API de Vector Store, vs_abc123 par votre ID de Vector Store, et 1234 par l'ID du document.

Paramètres de chemin

Paramètre Type Description
vector-store-id chaîne Requis. L'ID du magasin de vecteurs contenant le document.
document-id entier Requis. L'ID du document à récupérer.

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"
}

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 ou document non trouvé
500 Erreur interne du serveur

Ce point de terminaison récupère des informations détaillées sur un document spécifique dans le magasin de vecteurs. Il est utile pour vérifier l'état de traitement des documents individuels et récupérer des métadonnées telles que le type de fichier, la taille et les horodatages. Cela peut être particulièrement utile lors du dépannage des problèmes de traitement de documents ou lorsque vous devez vérifier qu'un document a été correctement indexé.