Ajouter un nouveau document texte à 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.

Exemples de Requêtes

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": "Aperçu du Produit",
    "text": "Notre produit est une solution innovante pour la gestion des embeddings vectoriels. Il offre une intégration transparente avec vos systèmes existants et propose de puissantes capacités de recherche sémantique."
  }'

Info

Remplacez YOUR_API_KEY par votre véritable clé API de Vector Store et vs_abc123 par votre 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',
  'Aperçu du Produit',
  'Notre produit est une solution innovante pour la gestion des embeddings vectoriels. Il offre une intégration transparente avec vos systèmes existants et propose de puissantes capacités de recherche sémantique.'
);

Info

Remplacez YOUR_API_KEY par votre véritable clé API de Vector Store et vs_abc123 par votre 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',
    'Aperçu du Produit',
    'Notre produit est une solution innovante pour la gestion des embeddings vectoriels. Il offre une intégration transparente avec vos systèmes existants et propose de puissantes capacités de recherche sémantique.'
)

Info

Remplacez YOUR_API_KEY par votre véritable clé API de Vector Store et vs_abc123 par votre ID de Vector Store.

Paramètres de chemin

Paramètre	Type	Description
vector-store-id	string	Requis. L'ID du magasin de vecteurs auquel ajouter le document.

Corps de la demande

{
  "name": "Aperçu du produit",
  "text": "Notre produit est une solution innovante pour la gestion des embeddings vectoriels. Il offre une intégration transparente avec vos systèmes existants et propose de puissantes capacités de recherche sémantique."
}

Paramètre	Type	Description
name	string	Requis. Le nom du document.
text	string	Requis. Le contenu textuel du document.

Format de Réponse

{
  "id": 1234,
  "name": "Aperçu du Produit",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "traitement",
  "processing_status": "en attente",
  "indexed_on": null,
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:15: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 - Champs requis manquants ou format invalide
401	Non autorisé - Clé API invalide ou manquante
404	Non trouvé - Magasin de vecteurs non trouvé
500	Erreur interne du serveur

Ce point de terminaison vous permet d'ajouter du contenu textuel directement à votre magasin de vecteurs. Il est particulièrement utile pour stocker des informations qui pourraient ne pas exister au format fichier, telles que des descriptions de produits, des articles de base de connaissances ou du contenu personnalisé. Le texte sera automatiquement traité en embeddings vectoriels, le rendant consultable par similarité sémantique.