Zum Inhalt

Informationen zu einem Dokument abrufen

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.

Beispielanfragen

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

Info

Ersetzen Sie YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel für den Vector Store, vs_abc123 durch Ihre Vector Store-ID und 1234 durch die Dokumenten-ID.

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': 'YOUR_API_KEY'
    }
  });

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

getDocumentInfo('vs_abc123', 1234);

Info

Ersetzen Sie YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel für den Vector Store, vs_abc123 durch Ihre Vector Store-ID und 1234 durch die Dokumenten-ID.

import requests

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

    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

Ersetzen Sie YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel für den Vector Store, vs_abc123 durch Ihre Vector Store-ID und 1234 durch die Dokumenten-ID.

Pfadparameter

Parameter Typ Beschreibung
vector-store-id string Erforderlich. Die ID des Vektor-Speichers, der das Dokument enthält.
document-id integer Erforderlich. Die ID des abzurufenden Dokuments.

Antwortformat

{
  "id": 1234,
  "name": "Produktanleitung.pdf",
  "type": "application/pdf",
  "vector_store": "vs_abc123",
  "size": 250000,
  "status": "indiziert",
  "processing_status": "abgeschlossen",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:30:00Z"
}

Authentifizierung

Dieser Endpunkt erfordert eine Authentifizierung mit einem API-Schlüssel im x-api-key-Header.

Fehlerantworten

Statuscode Beschreibung
401 Nicht autorisiert - Ungültiger oder fehlender API-Schlüssel
404 Nicht gefunden - Vektor-Speicher oder Dokument nicht gefunden
500 Interner Serverfehler

Dieser Endpunkt ruft detaillierte Informationen über ein bestimmtes Dokument im Vektor-Speicher ab. Er ist nützlich, um den Verarbeitungsstatus einzelner Dokumente zu überprüfen und Metadaten wie Dateityp, Größe und Zeitstempel abzurufen. Dies kann besonders hilfreich sein, wenn Probleme mit der Dokumentenverarbeitung auftreten oder wenn Sie überprüfen müssen, ob ein Dokument ordnungsgemäß indiziert wurde.