開發者工具和 API¶
歡迎來到 Rememberizer 開發者文檔。本節提供有關可供開發者使用的工具、API 和集成選項的全面信息,這些工具和選項與 Rememberizer 的語義搜索和知識管理能力相關。
Rememberizer 開發者功能概述¶
Rememberizer 提供了一套強大的開發者工具,旨在幫助您將強大的語義搜索能力整合到您的應用程序中。作為開發者,您可以:
- 通過 RESTful API 訪問語義搜索,使用向量嵌入技術
- 使用 OAuth2 或 API 金鑰將 Rememberizer 整合到您自己的應用程序中
- 構建自定義應用程序,利用用戶的知識庫
- 創建向量存儲,用於專門的語義搜索數據庫
- 與 AI 模型連接,包括 OpenAI GPT 和 LangChain
核心組件¶
Rememberizer 的架構由幾個關鍵組件組成,這些組件協同工作以提供全面的知識管理和語義搜索系統:
| 組件 | 描述 |
|---|---|
| API 服務 | 提供訪問 Rememberizer 功能的 RESTful 端點 |
| 身份驗證系統 | 用於安全訪問的 OAuth2 和 API 金鑰管理 |
| 向量存儲 | 專門優化用於語義搜索的數據庫 |
| 備忘錄 | 用於知識來源的可配置訪問過濾器 |
| 集成 | 連接到外部數據源的連接器(Slack、Google Drive 等) |
| 文檔處理 | 用於分塊、嵌入和索引內容的系統 |
認證選項¶
Rememberizer 支援兩種主要的認證方法:
-
OAuth2 認證:適用於需要訪問特定用戶數據和文件的應用程序。此流程允許用戶授權您的應用程序通過可配置的備忘錄訪問他們的知識。
-
API 金鑰認證:用於直接訪問向量存儲或公共知識庫,而不需要 OAuth 流程。這為不需要用戶特定數據的應用程序提供了更簡單的整合路徑。
開發者文檔路線圖¶
本文件組織旨在幫助您快速找到所需的信息:
開始使用¶
- 註冊 Rememberizer 應用程式 - 創建開發者應用程式
- 授權 Rememberizer 應用程式 - 實現 OAuth2 授權
- 註冊和使用 API 金鑰 - 使用 API 金鑰身份驗證
核心功能¶
- 向量儲存 - 創建和管理語義搜索數據庫
- 創建 Rememberizer GPT - 與 OpenAI 的 GPT 模型集成
- LangChain 集成 - 與 LangChain 應用程序連接
- 企業集成模式 - 企業部署的架構模式
API 參考¶
- API 文件 - 綜合 API 參考
- 認證、搜索、文檔管理及更多專門端點
範例和示範程式碼¶
- Talk-to-Slack 範例網頁應用程式 - 範例整合
示例整合流程¶
這是一個將 Rememberizer 與您的應用程式整合的典型流程:
- 在 Rememberizer 開發者入口網站註冊應用程式
- 在您的應用程式中實現 OAuth2 授權
- 請求訪問用戶的紀念品
- 進行 API 調用以搜尋和檢索知識
- 在您的應用程式中處理和顯示結果
// 示例:使用 OAuth 令牌進行身份驗證的 API 請求
async function searchUserKnowledge(query, token) {
const response = await fetch('https://api.rememberizer.ai/api/v1/search/', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({ query })
});
return response.json();
}