Thuật ngữ Chuẩn hóa

Thuật ngữ và quy ước đặt tên chuẩn hóa cho tài liệu Rememberizer

Tài liệu này cung cấp một tài liệu tham khảo cho thuật ngữ ưa thích để sử dụng khi thảo luận về các tính năng và khái niệm của Rememberizer. Việc tuân theo các tiêu chuẩn này giúp duy trì tính nhất quán trong tài liệu.

Các Thuật Ngữ và Định Nghĩa Ưu Tiên

Thuật Ngữ Ưu Tiên	Thuật Ngữ Thay Thế	Định Nghĩa
Vector Store	Cơ Sở Dữ Liệu Vector	Thuật ngữ ưu tiên cho việc triển khai cơ sở dữ liệu vector của Rememberizer là "Vector Store." Mặc dù "Cơ Sở Dữ Liệu Vector" là chính xác về mặt kỹ thuật, "Vector Store" nên được sử dụng để đảm bảo tính nhất quán.
Vector Embeddings	Nhúng	Thuật ngữ đầy đủ "Vector Embeddings" được ưu tiên trong nội dung giáo dục, trong khi "Nhúng" là chấp nhận được trong các ngữ cảnh kỹ thuật và ví dụ mã.
Data Source	Nguồn Kiến Thức, Tích Hợp	"Data Source" là thuật ngữ ưu tiên để chỉ nguồn gốc của dữ liệu (Slack, Google Drive, v.v.).
Common Knowledge	Kiến Thức Chung	Sử dụng "Common Knowledge" khi đề cập đến tính năng cho phép chia sẻ kiến thức với người dùng và ứng dụng khác.
Memento	Bộ Lọc Memento	Sử dụng "Memento" như thuật ngữ chính, mặc dù "Bộ Lọc Memento" là chấp nhận được trong các ngữ cảnh giao diện người dùng.
Memory Integration	Bộ Nhớ Chia Sẻ, Bộ Nhớ	"Memory Integration" là tên đầy đủ ưu tiên của tính năng; "Bộ Nhớ Chia Sẻ" là chấp nhận được trong nội dung hướng tới người dùng.
OAuth2 Authentication	OAuth	Sử dụng thuật ngữ đầy đủ "OAuth2 Authentication" trong tài liệu chính thức, mặc dù "OAuth" là chấp nhận được trong các ngữ cảnh ít chính thức hơn.
Search Your Knowledge	Tìm Kiếm Trong Rememberizer	"Search Your Knowledge" nên được sử dụng khi đề cập đến tên tính năng trong tiêu đề và điều hướng.
Memorize	Lưu Trữ	Sử dụng "Memorize" cho điểm cuối API và tên chức năng, trong khi "Lưu Trữ" có thể được sử dụng trong các ngữ cảnh giải thích.
X-API-Key	x-api-key	Sử dụng "X-API-Key" viết hoa trong tài liệu, mặc dù viết thường là chấp nhận được trong các ví dụ mã.

Quy tắc API

Thư mục Tài liệu API

Đường dẫn tài liệu API chính thức là /en/developer/api-docs/. Đường dẫn cũ /en/developer/api-documentations/ nên được loại bỏ.

Tiêu đề API

Các quy ước tiêu đề sau đây nên được sử dụng một cách nhất quán:

• Tiêu đề Ủy quyền: Authorization: Bearer YOUR_JWT_TOKEN

• Tiêu đề Khóa API: X-API-Key: YOUR_API_KEY

• Tiêu đề Loại Nội dung: Content-Type: application/json

Phong Cách Điểm Cuối API

Các điểm cuối API nên được định dạng nhất quán:

• URL cơ sở: https://api.rememberizer.ai/api/v1/

• Đường dẫn điểm cuối bằng chữ thường với dấu gạch nối khi cần: /documents/search/

• Đường dẫn kho vector với chỗ giữ tham số: /vector-stores/{vector_store_id}/documents/search

Quy Tắc Đặt Tên Tính Năng

Tên Tích Hợp

Tên tích hợp nên tuân theo mẫu:

• Rememberizer {Tên Tích Hợp} tích hợp (ví dụ: "Tích hợp Rememberizer Slack")

Đặt Tên Máy Chủ MCP

Các loại máy chủ MCP nên được phân biệt rõ ràng:

• Máy Chủ MCP Rememberizer: Máy chủ đa năng

• Máy Chủ MCP Lưu Trữ Vector Rememberizer: Máy chủ dành riêng cho các thao tác lưu trữ vector

Quy Tắc Đặt Tên Tài Liệu

Các tiêu đề tài liệu nên tuân theo những quy tắc sau:

• Viết hoa các từ quan trọng (Title Case)

• Sử dụng thuật ngữ nhất quán cho các tính năng

• Tránh viết tắt trong tiêu đề trừ khi được công nhận rộng rãi (ví dụ: API)

• Giữ cho tiêu đề ngắn gọn và mô tả

Sử Dụng Hướng Dẫn Này

Khi tạo hoặc cập nhật tài liệu, hãy tham khảo hướng dẫn này để đảm bảo thuật ngữ nhất quán. Khi gặp các thuật ngữ biến thể trong tài liệu, ưu tiên cập nhật thành các thuật ngữ ưa thích được liệt kê ở đây khi thực hiện các thay đổi khác đối với các tài liệu đó.

Hãy nhớ rằng việc duy trì tính toàn vẹn của liên kết và tên tệp là rất quan trọng, vì vậy hãy tập trung vào việc cập nhật thuật ngữ trong văn bản trong khi vẫn bảo tồn các URL và cấu trúc tệp.