Tilføj ny tekstdokument til en Vektorbutik¶
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.
Eksempelanmodninger¶
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": "Produktoversigt",
"text": "Vores produkt er en innovativ løsning til håndtering af vektorindlejringer. Det giver problemfri integration med dine eksisterende systemer og tilbyder kraftfulde semantiske søgefunktioner."
}'
Info
Erstat YOUR_API_KEY med din faktiske Vector Store API-nøgle og vs_abc123 med dit 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',
'Produktoversigt',
'Vores produkt er en innovativ løsning til håndtering af vektorindlejringer. Det giver problemfri integration med dine eksisterende systemer og tilbyder kraftfulde semantiske søgefunktioner.'
);
Info
Erstat YOUR_API_KEY med din faktiske Vector Store API-nøgle og vs_abc123 med dit 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',
'Produktoversigt',
'Vores produkt er en innovativ løsning til håndtering af vektorindlejringer. Det giver problemfri integration med dine eksisterende systemer og tilbyder kraftfulde semantiske søgefunktioner.'
)
Info
Erstat YOUR_API_KEY med din faktiske Vector Store API-nøgle og vs_abc123 med dit Vector Store ID.
Sti Parametre¶
| Parameter | Type | Beskrivelse |
|---|---|---|
| vector-store-id | string | Påkrævet. ID'en på vektorbutikken, som dokumentet skal tilføjes til. |
Anmodningskrop¶
{
"name": "Produktoversigt",
"text": "Vores produkt er en innovativ løsning til håndtering af vektorindlejringer. Det giver problemfri integration med dine eksisterende systemer og tilbyder kraftfulde semantiske søgefunktioner."
}
| Parameter | Type | Beskrivelse |
|---|---|---|
| name | string | Påkrævet. Navnet på dokumentet. |
| text | string | Påkrævet. Tekstindholdet i dokumentet. |
Responsformat¶
{
"id": 1234,
"name": "Produktoversigt",
"type": "text/plain",
"vector_store": "vs_abc123",
"size": 173,
"status": "behandling",
"processing_status": "i kø",
"indexed_on": null,
"status_error_message": null,
"created": "2023-06-15T10:15:00Z",
"modified": "2023-06-15T10:15:00Z"
}
Godkendelse¶
Denne endpoint kræver godkendelse ved hjælp af en API-nøgle i x-api-key headeren.
Fejlrespons¶
| Statuskode | Beskrivelse |
|---|---|
| 400 | Bad Request - Manglende påkrævede felter eller ugyldigt format |
| 401 | Unauthorized - Ugyldig eller manglende API-nøgle |
| 404 | Not Found - Vektorbutik ikke fundet |
| 500 | Intern serverfejl |
Denne endpoint giver dig mulighed for at tilføje tekstindhold direkte til din vektorbutik. Det er særligt nyttigt til at gemme information, der måske ikke findes i filformat, såsom produktbeskrivelser, vidensbaseartikler eller brugerdefineret indhold. Teksten vil automatisk blive behandlet til vektorindlejring, hvilket gør den søgbar ved hjælp af semantisk lighed.