Zum Inhalt

Aktualisieren Sie den Inhalt der Datei in einem Vektor-Speicher

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

Update a specific 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.

Request body

Field Type Required Description
name string The new name for the document.

Responses

  • 200 — Document updated successfully.

Beispielanfragen

curl -X PATCH   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234/   
  -H "x-api-key: YOUR_API_KEY"   
  -H "Content-Type: application/json"   
  -d '{
    "name": "Aktualisierte Produktübersicht"
  }'

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 updateDocument = async (vectorStoreId, documentId, newName) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/${documentId}/`, {
    method: 'PATCH',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: newName
    })
  });

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

updateDocument('vs_abc123', 1234, 'Aktualisierte Produktübersicht');

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
import json

def update_document(vector_store_id, document_id, new_name):
    headers = {
        "x-api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    }

    payload = {
        "name": new_name
    }

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

    data = response.json()
    print(data)

update_document('vs_abc123', 1234, 'Aktualisierte Produktübersicht')

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 zu aktualisierenden Dokuments.

Anfragekörper

{
  "name": "Aktualisierte Produktübersicht"
}
Parameter Typ Beschreibung
name string Der neue Name für das Dokument.

Antwortformat

{
  "id": 1234,
  "name": "Aktualisierte Produktübersicht",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "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-15T11:45:00Z"
}

Authentifizierung

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

Fehlerantworten

Statuscode Beschreibung
400 Ungültige Anfrage - Ungültiges Anfrageformat
401 Unbefugt - Ungültiger oder fehlender API-Schlüssel
404 Nicht gefunden - Vektor-Store oder Dokument nicht gefunden
500 Interner Serverfehler

Dieser Endpunkt ermöglicht es Ihnen, die Metadaten eines Dokuments in Ihrem Vektor-Store zu aktualisieren. Derzeit können Sie nur den Namen des Dokuments aktualisieren. Dies ist nützlich, um die Organisation und Auffindbarkeit von Dokumenten zu verbessern, ohne das Dokument erneut hochladen zu müssen.

Info

Hinweis: Dieser Endpunkt aktualisiert nur die Metadaten des Dokuments, nicht dessen Inhalt. Um den Inhalt zu aktualisieren, müssen Sie das vorhandene Dokument löschen und ein neues hochladen.