標準化術語

Rememberizer 文檔的標準化術語和命名慣例

本文件提供了在討論 Rememberizer 功能和概念時使用的首選術語的參考。遵循這些標準有助於在文檔中保持一致性。

首選術語與定義

首選術語	替代術語	定義
向量存儲	向量數據庫	Rememberizer 的向量數據庫實現的首選術語是「向量存儲」。雖然「向量數據庫」在技術上是準確的，但應使用「向量存儲」以保持一致性。
向量嵌入	嵌入	在教育內容中首選完整術語「向量嵌入」，而在技術上下文和代碼示例中「嵌入」是可以接受的。
數據來源	知識來源、整合	「數據來源」是指數據來源（Slack、Google Drive 等）的首選術語。
共同知識	共享知識	當提到允許與其他用戶和應用程序共享知識的功能時，使用「共同知識」。
記憶	記憶過濾器	使用「記憶」作為主要術語，雖然在 UI 上下文中「記憶過濾器」是可以接受的。
記憶整合	共享記憶、記憶	「記憶整合」是該功能的首選全名；「共享記憶」在面向用戶的內容中是可以接受的。
OAuth2 認證	OAuth	在正式文檔中使用完整術語「OAuth2 認證」，雖然在不那麼正式的上下文中「OAuth」是可以接受的。
搜尋你的知識	在 Rememberizer 中搜尋	當提到標題和導航中的功能名稱時，應使用「搜尋你的知識」。
記住	存儲	對於 API 端點和功能名稱使用「記住」，而「存儲」可以用於解釋性上下文。
X-API-Key	x-api-key	在文檔中使用大寫的「X-API-Key」，雖然在代碼示例中小寫是可以接受的。

API 約定

API 文件目錄

官方 API 文件路徑為 /en/developer/api-docs/。舊的路徑 /en/developer/api-documentations/ 應該逐步淘汰。

API 標頭

以下標頭約定應一致使用：

• 授權標頭：Authorization: Bearer YOUR_JWT_TOKEN

• API 金鑰標頭：X-API-Key: YOUR_API_KEY

• 內容類型標頭：Content-Type: application/json

API 端點樣式

API 端點應該保持一致的樣式：

• 基本 URL: https://api.rememberizer.ai/api/v1/

• 端點路徑使用小寫字母，必要時使用連字符: /documents/search/

• 向量存儲路徑帶有參數佔位符: /vector-stores/{vector_store_id}/documents/search

功能命名規範

整合名稱

整合名稱應遵循以下模式：

• Rememberizer {整合名稱} 整合（例如，“Rememberizer Slack 整合”）

MCP 伺服器命名

MCP 伺服器類型應明確區分：

• Rememberizer MCP 伺服器：通用伺服器

• Rememberizer 向量儲存 MCP 伺服器：專門用於向量儲存操作的伺服器

文件標題慣例

文件標題應遵循以下慣例：

• 大寫重要單詞（標題大小寫）

• 對功能使用一致的術語

• 除非廣為人知，否則避免在標題中使用縮寫（例如，API）

• 保持標題簡潔且具描述性

使用本指南

在創建或更新文檔時，請參考本指南以確保術語的一致性。在文檔中遇到變體術語時，優先在對這些文檔進行其他更改時更新為此處列出的首選術語。

請記住，保持鏈接完整性和文件名稱至關重要，因此請專注於在文本中更新術語，同時保留 URL 和文件結構。