Zum Inhalt

Holen Sie sich eine Liste von Dokumenten in einem Vektor-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.

Beispielanfragen

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

Info

Ersetzen Sie IHR_API_SCHLÜSSEL durch Ihren tatsächlichen API-Schlüssel für den Vector Store und vs_abc123 durch Ihre Vector Store-ID.

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

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

getVectorStoreDocuments('vs_abc123');

Info

Ersetzen Sie IHR_API_SCHLÜSSEL durch Ihren tatsächlichen API-Schlüssel für den Vector Store und vs_abc123 durch Ihre Vector Store-ID.

import requests

def get_vector_store_documents(vector_store_id):
    headers = {
        "x-api-key": "IHR_API_SCHLÜSSEL"
    }

    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

Ersetzen Sie IHR_API_SCHLÜSSEL durch Ihren tatsächlichen API-Schlüssel für den Vector Store und vs_abc123 durch Ihre Vector Store-ID.

Pfadparameter

Parameter Typ Beschreibung
vector-store-id string Erforderlich. Die ID des Vektor-Speichers, aus dem Dokumente aufgelistet werden sollen.

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"
  },
  {
    "id": 1235,
    "name": "Technische Spezifikationen.docx",
    "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "vector_store": "vs_abc123",
    "size": 125000,
    "status": "indiziert",
    "processing_status": "abgeschlossen",
    "indexed_on": "2023-06-15T11:45:00Z",
    "status_error_message": null,
    "created": "2023-06-15T11:30:00Z",
    "modified": "2023-06-15T11:45:00Z"
  }
]

Authentifizierung

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

Fehlerantworten

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

Dieser Endpunkt ruft eine Liste aller Dokumente ab, die im angegebenen Vektor-Store gespeichert sind. Er liefert Metadaten zu jedem Dokument, einschließlich des Verarbeitungsstatus, der Größe und des indizierten Zeitstempels des Dokuments. Diese Informationen sind nützlich, um den Inhalt Ihres Vektor-Stores zu überwachen und den Verarbeitungsstatus der Dokumente zu überprüfen.