Fügen Sie ein neues Textdokument zu einem Vektor-Store hinzu

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.

Beispielanfragen

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": "Produktübersicht",
    "text": "Unser Produkt ist eine innovative Lösung zur Verwaltung von Vektor-Embeddings. Es bietet nahtlose Integration mit Ihren bestehenden Systemen und bietet leistungsstarke semantische Suchfunktionen."
  }'

Info

Ersetzen Sie YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel für den Vector Store und vs_abc123 durch Ihre Vector Store-ID.

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',
  'Produktübersicht',
  'Unser Produkt ist eine innovative Lösung zur Verwaltung von Vektor-Embeddings. Es bietet nahtlose Integration mit Ihren bestehenden Systemen und bietet leistungsstarke semantische Suchfunktionen.'
);

Info

Ersetzen Sie YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel für den Vector Store und vs_abc123 durch Ihre Vector Store-ID.

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',
    'Produktübersicht',
    'Unser Produkt ist eine innovative Lösung zur Verwaltung von Vektor-Embeddings. Es bietet nahtlose Integration mit Ihren bestehenden Systemen und bietet leistungsstarke semantische Suchfunktionen.'
)

Info

Ersetzen Sie YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel für den Vector Store und vs_abc123 durch Ihre Vector Store-ID.

Pfadparameter

Parameter	Typ	Beschreibung
vector-store-id	string	Erforderlich. Die ID des Vektor-Speichers, zu dem das Dokument hinzugefügt werden soll.

Anfragekörper

{
  "name": "Produktübersicht",
  "text": "Unser Produkt ist eine innovative Lösung zur Verwaltung von Vektor-Embeddings. Es bietet nahtlose Integration mit Ihren bestehenden Systemen und bietet leistungsstarke semantische Suchfunktionen."
}

Parameter	Typ	Beschreibung
name	string	Erforderlich. Der Name des Dokuments.
text	string	Erforderlich. Der Textinhalt des Dokuments.

Antwortformat

{
  "id": 1234,
  "name": "Produktübersicht",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "verarbeitet",
  "processing_status": "in der Warteschlange",
  "indexed_on": null,
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:15:00Z"
}

Authentifizierung

Dieser Endpunkt erfordert eine Authentifizierung mit einem API-Schlüssel im x-api-key-Header.

Fehlerantworten

Statuscode	Beschreibung
400	Schlechte Anfrage - Fehlende erforderliche Felder oder ungültiges Format
401	Nicht autorisiert - Ungültiger oder fehlender API-Schlüssel
404	Nicht gefunden - Vektorstore nicht gefunden
500	Interner Serverfehler

Dieser Endpunkt ermöglicht es Ihnen, Textinhalte direkt zu Ihrem Vektorstore hinzuzufügen. Es ist besonders nützlich, um Informationen zu speichern, die möglicherweise nicht im Dateiformat vorliegen, wie Produktbeschreibungen, Artikel aus Wissensdatenbanken oder benutzerdefinierte Inhalte. Der Text wird automatisch in Vektor-Embeddings verarbeitet, wodurch er mithilfe semantischer Ähnlichkeit durchsuchbar wird.