Aggiungi un nuovo documento di testo 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.

Esempi di Richieste

cURLJavaScriptPython

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": "Panoramica del Prodotto",
    "text": "Il nostro prodotto è una soluzione innovativa per la gestione degli embedding vettoriali. Offre un'integrazione senza soluzione di continuità con i tuoi sistemi esistenti e fornisce potenti capacità di ricerca semantica."
  }'

Info

Sostituisci YOUR_API_KEY con la tua chiave API del Vector Store e vs_abc123 con il tuo ID del 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',
  'Panoramica del Prodotto',
  'Il nostro prodotto è una soluzione innovativa per la gestione degli embedding vettoriali. Offre un'integrazione senza soluzione di continuità con i tuoi sistemi esistenti e fornisce potenti capacità di ricerca semantica.'
);

Info

Sostituisci YOUR_API_KEY con la tua chiave API del Vector Store e vs_abc123 con il tuo ID del 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',
    'Panoramica del Prodotto',
    'Il nostro prodotto è una soluzione innovativa per la gestione degli embedding vettoriali. Offre un'integrazione senza soluzione di continuità con i tuoi sistemi esistenti e fornisce potenti capacità di ricerca semantica.'
)

Info

Sostituisci YOUR_API_KEY con la tua chiave API del Vector Store e vs_abc123 con il tuo ID del Vector Store.

Parametri del percorso

Parametro	Tipo	Descrizione
vector-store-id	string	Obbligatorio. L'ID del vector store a cui aggiungere il documento.

Corpo della Richiesta

{
  "name": "Panoramica del Prodotto",
  "text": "Il nostro prodotto è una soluzione innovativa per la gestione delle embedding vettoriali. Offre un'integrazione senza soluzione di continuità con i tuoi sistemi esistenti e fornisce potenti capacità di ricerca semantica."
}

Parametro	Tipo	Descrizione
name	string	Obbligatorio. Il nome del documento.
text	string	Obbligatorio. Il contenuto testuale del documento.

Formato di Risposta

{
  "id": 1234,
  "name": "Panoramica del Prodotto",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "in elaborazione",
  "processing_status": "in coda",
  "indexed_on": null,
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:15: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 - Campi richiesti mancanti o formato non valido
401	Non Autorizzato - Chiave API non valida o mancante
404	Non Trovato - Vector Store non trovato
500	Errore Interno del Server

Questo endpoint ti consente di aggiungere contenuti testuali direttamente al tuo vector store. È particolarmente utile per memorizzare informazioni che potrebbero non esistere in formato file, come descrizioni di prodotti, articoli di base di conoscenza o contenuti personalizzati. Il testo verrà automaticamente elaborato in embedding vettoriali, rendendolo ricercabile utilizzando la similarità semantica.