Saltar a contenido

Actualizar el contenido del archivo en un Almacén Vectorial

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.

Ejemplos de Solicitudes

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": "Descripción del Producto Actualizada"
  }'

Info

Reemplace YOUR_API_KEY con su clave API real de Vector Store, vs_abc123 con su ID de Vector Store y 1234 con el 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, 'Descripción del Producto Actualizada');

Info

Reemplace YOUR_API_KEY con su clave API real de Vector Store, vs_abc123 con su ID de Vector Store y 1234 con el 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, 'Descripción del Producto Actualizada')

Info

Reemplace YOUR_API_KEY con su clave API real de Vector Store, vs_abc123 con su ID de Vector Store y 1234 con el ID del documento.

Parámetros de Ruta

Parámetro Tipo Descripción
vector-store-id string Requerido. El ID de la tienda de vectores que contiene el documento.
document-id integer Requerido. El ID del documento a actualizar.

Cuerpo de la Solicitud

{
  "name": "Descripción del Producto Actualizada"
}
Parámetro Tipo Descripción
name string El nuevo nombre para el documento.

Formato de Respuesta

{
  "id": 1234,
  "name": "Descripción del Producto Actualizado",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "indexed",
  "processing_status": "completed",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T11:45:00Z"
}

Autenticación

Este endpoint requiere autenticación utilizando una clave API en el encabezado x-api-key.

Respuestas de Error

Código de Estado Descripción
400 Solicitud Incorrecta - Formato de solicitud inválido
401 No Autorizado - Clave API inválida o faltante
404 No Encontrado - Almacén de Vectores o documento no encontrado
500 Error Interno del Servidor

Este endpoint te permite actualizar los metadatos de un documento en tu almacén de vectores. Actualmente, solo puedes actualizar el nombre del documento. Esto es útil para mejorar la organización y la descubribilidad del documento sin necesidad de volver a cargar el documento.

Info

Nota: Este endpoint solo actualiza los metadatos del documento, no su contenido. Para actualizar el contenido, necesitas eliminar el documento existente y cargar uno nuevo.