Thêm tài liệu văn bản mới vào 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.
Ví dụ Yêu Cầu¶
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": "Tổng Quan Sản Phẩm",
"text": "Sản phẩm của chúng tôi là một giải pháp đổi mới cho việc quản lý các nhúng vector. Nó cung cấp tích hợp liền mạch với các hệ thống hiện có của bạn và cung cấp khả năng tìm kiếm ngữ nghĩa mạnh mẽ."
}'
Info
Thay thế YOUR_API_KEY bằng khóa API Vector Store thực tế của bạn và vs_abc123 bằng ID Vector Store của bạn.
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',
'Tổng Quan Sản Phẩm',
'Sản phẩm của chúng tôi là một giải pháp đổi mới cho việc quản lý các nhúng vector. Nó cung cấp tích hợp liền mạch với các hệ thống hiện có của bạn và cung cấp khả năng tìm kiếm ngữ nghĩa mạnh mẽ.'
);
Info
Thay thế YOUR_API_KEY bằng khóa API Vector Store thực tế của bạn và vs_abc123 bằng ID Vector Store của bạn.
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',
'Tổng Quan Sản Phẩm',
'Sản phẩm của chúng tôi là một giải pháp đổi mới cho việc quản lý các nhúng vector. Nó cung cấp tích hợp liền mạch với các hệ thống hiện có của bạn và cung cấp khả năng tìm kiếm ngữ nghĩa mạnh mẽ.'
)
Info
Thay thế YOUR_API_KEY bằng khóa API Vector Store thực tế của bạn và vs_abc123 bằng ID Vector Store của bạn.
Tham số Đường dẫn¶
| Tham số | Loại | Mô tả |
|---|---|---|
| vector-store-id | chuỗi | Bắt buộc. ID của cửa hàng vector để thêm tài liệu vào. |
Request Body¶
{
"name": "Tổng quan sản phẩm",
"text": "Sản phẩm của chúng tôi là một giải pháp đổi mới cho việc quản lý các nhúng vector. Nó cung cấp tích hợp liền mạch với các hệ thống hiện có của bạn và cung cấp khả năng tìm kiếm ngữ nghĩa mạnh mẽ."
}
| Tham số | Loại | Mô tả |
|---|---|---|
| name | chuỗi | Bắt buộc. Tên của tài liệu. |
| text | chuỗi | Bắt buộc. Nội dung văn bản của tài liệu. |
Định dạng Phản hồi¶
{
"id": 1234,
"name": "Tổng quan sản phẩm",
"type": "text/plain",
"vector_store": "vs_abc123",
"size": 173,
"status": "đang xử lý",
"processing_status": "đã xếp hàng",
"indexed_on": null,
"status_error_message": null,
"created": "2023-06-15T10:15:00Z",
"modified": "2023-06-15T10:15:00Z"
}
Xác thực¶
Điểm cuối này yêu cầu xác thực bằng cách sử dụng khóa API trong tiêu đề x-api-key.
Phản hồi Lỗi¶
| Mã Trạng Thái | Mô Tả |
|---|---|
| 400 | Yêu cầu không hợp lệ - Thiếu các trường bắt buộc hoặc định dạng không hợp lệ |
| 401 | Không được ủy quyền - Khóa API không hợp lệ hoặc bị thiếu |
| 404 | Không tìm thấy - Không tìm thấy Vector Store |
| 500 | Lỗi Máy Chủ Nội Bộ |
Điểm cuối này cho phép bạn thêm nội dung văn bản trực tiếp vào kho vector của bạn. Nó đặc biệt hữu ích cho việc lưu trữ thông tin có thể không tồn tại ở định dạng tệp, chẳng hạn như mô tả sản phẩm, bài viết trong cơ sở kiến thức hoặc nội dung tùy chỉnh. Văn bản sẽ được tự động xử lý thành các nhúng vector, giúp nó có thể tìm kiếm được bằng cách sử dụng sự tương đồng ngữ nghĩa.