Saltar a contenido

Agregar nuevo documento de texto a un Vector Store

POST /vector-stores/{vector-store-id}/documents/create

Create a new text document 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.

Request body

Field Type Required Description
name string The name of the document.
text string The text content of the document.

Responses

  • 201 — Document created successfully.

Ejemplos de Solicitudes

curl -X POST   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/create   
  -H "x-api-key: YOUR_API_KEY"   
  -H "Content-Type: application/json"   
  -d '{
    "name": "Descripción del Producto",
    "text": "Nuestro producto es una solución innovadora para gestionar incrustaciones vectoriales. Proporciona una integración fluida con sus sistemas existentes y ofrece potentes capacidades de búsqueda semántica."
  }'

Info

Reemplace YOUR_API_KEY con su clave API real de Vector Store y vs_abc123 con su ID de Vector Store.

const addTextDocument = async (vectorStoreId, name, text) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/create`, {
    method: 'POST',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: name,
      text: text
    })
  });

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

addTextDocument(
  'vs_abc123',
  'Descripción del Producto',
  'Nuestro producto es una solución innovadora para gestionar incrustaciones vectoriales. Proporciona una integración fluida con sus sistemas existentes y ofrece potentes capacidades de búsqueda semántica.'
);

Info

Reemplace YOUR_API_KEY con su clave API real de Vector Store y vs_abc123 con su ID de Vector Store.

import requests
import json

def add_text_document(vector_store_id, name, text):
    headers = {
        "x-api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    }

    payload = {
        "name": name,
        "text": text
    }

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

    data = response.json()
    print(data)

add_text_document(
    'vs_abc123',
    'Descripción del Producto',
    'Nuestro producto es una solución innovadora para gestionar incrustaciones vectoriales. Proporciona una integración fluida con sus sistemas existentes y ofrece potentes capacidades de búsqueda semántica.'
)

Info

Reemplace YOUR_API_KEY con su clave API real de Vector Store y vs_abc123 con su ID de Vector Store.

Parámetros de Ruta

Parámetro Tipo Descripción
vector-store-id string Requerido. El ID del almacén de vectores al que se añadirá el documento.

Cuerpo de la Solicitud

{
  "name": "Descripción del Producto",
  "text": "Nuestro producto es una solución innovadora para gestionar incrustaciones vectoriales. Proporciona una integración fluida con sus sistemas existentes y ofrece potentes capacidades de búsqueda semántica."
}
Parámetro Tipo Descripción
name string Requerido. El nombre del documento.
text string Requerido. El contenido de texto del documento.

Formato de Respuesta

{
  "id": 1234,
  "name": "Descripción del Producto",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "procesando",
  "processing_status": "en cola",
  "indexed_on": null,
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:15: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 - Faltan campos requeridos o formato inválido
401 No Autorizado - Clave API inválida o faltante
404 No Encontrado - Almacén de Vectores no encontrado
500 Error Interno del Servidor

Este endpoint te permite agregar contenido de texto directamente a tu almacén de vectores. Es particularmente útil para almacenar información que podría no existir en formato de archivo, como descripciones de productos, artículos de base de conocimientos o contenido personalizado. El texto se procesará automáticamente en incrustaciones vectoriales, lo que lo hará buscable utilizando similitud semántica.