Aller au contenu

Mettre à jour le contenu du fichier dans un magasin de vecteurs

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.

Exemples de Requêtes

curl -X PATCH   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234/   
  -H "x-api-key: VOTRE_CLE_API"   
  -H "Content-Type: application/json"   
  -d '{
    "name": "Aperçu du Produit Mis à Jour"
  }'

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 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': 'VOTRE_CLE_API',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: newName
    })
  });

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

updateDocument('vs_abc123', 1234, 'Aperçu du Produit Mis à Jour');

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

def update_document(vector_store_id, document_id, new_name):
    headers = {
        "x-api-key": "VOTRE_CLE_API",
        "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, 'Aperçu du Produit Mis à Jour')

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 string Requis. L'ID du magasin de vecteurs contenant le document.
document-id integer Requis. L'ID du document à mettre à jour.

Corps de la demande

{
  "name": "Aperçu du produit mis à jour"
}
Paramètre Type Description
name string Le nouveau nom du document.

Format de Réponse

{
  "id": 1234,
  "name": "Aperçu du Produit Mis à Jour",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "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-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
400 Mauvaise demande - Format de demande invalide
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 vous permet de mettre à jour les métadonnées d'un document dans votre magasin de vecteurs. Actuellement, vous ne pouvez mettre à jour que le nom du document. Cela est utile pour améliorer l'organisation et la découvrabilité des documents sans avoir besoin de re-télécharger le document.

Info

Remarque : Ce point de terminaison ne met à jour que les métadonnées du document, pas son contenu. Pour mettre à jour le contenu, vous devez supprimer le document existant et en télécharger un nouveau.