Vai al contenuto

Aggiorna il contenuto del file in un Vector Store

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.

Esempi di Richieste

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": "Panoramica del Prodotto Aggiornata"
  }'

Info

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store, vs_abc123 con il tuo ID del Vector Store e 1234 con l'ID del documento.

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, 'Panoramica del Prodotto Aggiornata');

Info

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store, vs_abc123 con il tuo ID del Vector Store e 1234 con l'ID del documento.

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, 'Panoramica del Prodotto Aggiornata')

Info

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store, vs_abc123 con il tuo ID del Vector Store e 1234 con l'ID del documento.

Parametri del percorso

Parametro Tipo Descrizione
vector-store-id string Obbligatorio. L'ID del vettore store contenente il documento.
document-id integer Obbligatorio. L'ID del documento da aggiornare.

Corpo della Richiesta

{
  "name": "Panoramica del Prodotto Aggiornata"
}
Parametro Tipo Descrizione
name string Il nuovo nome per il documento.

Formato di Risposta

{
  "id": 1234,
  "name": "Panoramica del Prodotto Aggiornata",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "indicizzato",
  "processing_status": "completato",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T11:45:00Z"
}

Autenticazione

Questo endpoint richiede autenticazione utilizzando una chiave API nell'intestazione x-api-key.

Risposte di Errore

Codice di Stato Descrizione
400 Richiesta Errata - Formato di richiesta non valido
401 Non Autorizzato - Chiave API non valida o mancante
404 Non Trovato - Vector Store o documento non trovato
500 Errore Interno del Server

Questo endpoint ti consente di aggiornare i metadati di un documento nel tuo vector store. Attualmente, puoi solo aggiornare il nome del documento. Questo è utile per migliorare l'organizzazione e la reperibilità dei documenti senza dover ricaricare il documento.

Info

Nota: Questo endpoint aggiorna solo i metadati del documento, non il suo contenuto. Per aggiornare il contenuto, devi eliminare il documento esistente e caricarne uno nuovo.