Forked from yongwei/rag-flex
Project Files
README.zh-TW.md
Version: 1.2.0 | License: MIT
適用於 LM Studio 的靈活 RAG（檢索增強生成）插件，支援動態 Embedding 模型選擇、智慧情境管理與多語系支援。
nomic-ai/nomic-embed-text-v1.5-GGUF（內建，速度快）lm-kit/bge-m3-gguf（較慢但更精確）git clone https://github.com/henrychen95/rag-flex.git cd rag-flex lms dev
插件會自動載入到 LM Studio。終端機會顯示 "Register with LM Studio" 表示載入成功。
📎 上傳：會議記錄.txt（5 KB） 💬 您：「這次會議的待辦事項有哪些？」 🤖 AI：[檢視完整文件] 「待辦事項包括： 1. John 在週五前準備 Q4 報告 2. Sarah 安排後續會議...」
📎 上傳：技術手冊.pdf（2 MB） 💬 您：「如何設定 SSL 憑證？」 🤖 AI：[檢索相關章節] 「根據參考片段 1 和參考片段 3： 要設定 SSL 憑證，您需要...」 參考片段 1：（第 45 頁）「SSL 設定包括...」 參考片段 3：（第 89 頁）「憑證安裝步驟...」
在 LM Studio → Plugins → RAG-Flex 中存取插件設定
| 參數 | 預設值 | 範圍 | 說明 |
|---|---|---|---|
| 訊息語言 | 自動偵測 | EN/ZH-TW/JA | 執行時訊息的語言 |
| Embedding 模型 | nomic-ai/nomic-embed-text-v1.5 | 4 種預設 | 從預設的 Embedding 模型中選擇 |
| 自訂 Embedding 模型 | （空白） | 文字輸入 | 覆蓋上方選擇，輸入模型名稱（如 text-embedding-bge-m3）、識別碼（如 lm-kit/bge-m3-gguf）或完整路徑 |
| 情境使用門檻 | 0.7 | 0.1 - 1.0 | RAG 檢索觸發點（數值越低越精確） |
| 檢索片段數 | 5 | 1 - 15 | 觸發檢索時回傳的片段數量 |
| 相似度門檻 | 0.4 | 0.0 - 1.0 | 相似度門檻（BGE-M3 建議 0.4-0.6） |
| 啟用除錯日誌 | 關閉 | 開/關 | 啟用除錯日誌（開發者用） |
| 除錯日誌路徑 | ./logs/lmstudio-debug.log | 自訂路徑 | 除錯日誌檔案路徑 |
| 模型 | 大小 | 速度 | 適用場景 | 語言支援 |
|---|---|---|---|---|
| nomic-ai/nomic-embed-text-v1.5-GGUF | 84 MB | ⚡⚡⚡ 快 | 英文、一般用途 | 英文 |
| NathanMad/sentence-transformers_all-MiniLM-L12-v2-gguf | 133 MB | ⚡⚡⚡ 快 | 輕量任務 | 英文 |
| groonga/gte-large-Q4_K_M-GGUF | 216 MB | ⚡⚡ 中等 | 平衡型 | 多語言 |
| lm-kit/bge-m3-gguf | 1.16 GB | ⚡ 慢 (F16) / ⚡⚡ 中等 (Q4) | 中文、多語言、高精度 | 100+ 種語言 |
注意：由於 SDK 限制，下拉選單僅顯示預設模型。請使用自訂 Embedding 模型欄位輸入模型名稱（如 text-embedding-qwen3-embedding-8b）、識別碼或完整路徑來指定任何已下載的模型。
情境：軟體開發者需要查詢 API 文件 上傳：FastAPI-documentation.pdf（3.2 MB） 提問：「FastAPI 支援哪些身份驗證方法？」 結果：RAG 檢索模式啟動 ✓ 檢索到 5 個相關引用 ✓ 找到 JWT、OAuth2、API Key 章節 ✓ 提供文件中的程式碼範例 配置建議： - 情境門檻：0.7（預設值） - 檢索片段數：5-7（全面涵蓋） - 相似度門檻：0.5（技術內容）
情境：律師審查合約條款 上傳：商業租賃合約.docx（250 KB） 提問：「承租人的維護責任有哪些？」 結果：全文注入模式（檔案在門檻內） ✓ 整份文件注入為情境 ✓ AI 可以交叉參照多個條款 ✓ 提供完整答案並標註確切條款編號 配置建議： - 情境門檻：0.8（允許全文注入） - 語言：繁體中文（處理中文合約）
情境：理解資料庫架構 上傳：database-schema.sql（450 KB） 提問：「說明 users 和 orders 表之間的關聯性」 結果：RAG 檢索（降低門檻） ✓ 檢索相關的 CREATE TABLE 語句 ✓ 找到外鍵約束條件 ✓ 識別關聯表 配置建議： - 相似度門檻：0.3-0.4（程式碼/SQL 使用較低值） - 檢索片段數：8-10（捕捉相關表格） - 模型：bge-m3（更適合帶中文註解的程式碼）
情境：公務人員處理申請案件 上傳：2024年補助申請作業要點.pdf（1.8 MB） 提問：「申請資格有哪些限制條件？」 結果：多語言 RAG 檢索 ✓ 語言自動偵測為繁體中文 ✓ 檢索資格條件章節 ✓ 引用包含頁碼與條文參考 配置建議： - 語言：繁體中文 - 模型：bge-m3（最適合繁體中文） - 相似度門檻：0.5-0.6
情境：研究生進行文獻回顧 上傳：機器學習綜述論文-2024.pdf（4.5 MB） 提問：「Transformer 架構目前有哪些挑戰？」 結果：精確 RAG 檢索 ✓ 檢索「挑戰」和「未來工作」章節 ✓ 交叉參照方法論章節 ✓ 提供含頁碼的引用 配置建議： - 情境門檻：0.6（大型論文強制使用 RAG） - 檢索片段數：10-15（捕捉多元觀點） - 模型：gte-large（學術內容的良好平衡）
門檻決定何時從全文注入切換到 RAG 檢索：
可用情境 = 剩餘情境 × 門檻 如果（檔案 Token 數 + 提示詞 Token 數）> 可用情境： → 使用 RAG 檢索（精確模式） 否則： → 使用全文注入（全面模式）
何時調整：
| 門檻 | 行為 | 使用場景 |
|---|---|---|
| 0.3-0.5 | 更常強制使用 RAG | 大型文件、記憶體限制 |
| 0.6-0.7 | 平衡（預設） | 一般使用 |
| 0.8-0.9 | 允許更多全文注入 | 小型文件、需要完整情境 |
不同內容類型需要不同的相似度門檻：
| 內容類型 | 建議門檻 | 原因 |
|---|---|---|
| 自然語言文字 | 0.5-0.7 | 語意匹配清晰 |
| 技術文件 | 0.4-0.6 | 技術術語變化大 |
| 程式碼/SQL | 0.3-0.4 | 語法密集，語意相似度較低 |
| 混合語言 | 0.4-0.5 | 考慮語言切換 |
插件會自動偵測您的系統語言並設定介面：
LANG、LANGUAGE、LC_ALL 環境變數支援的語言：
📖 給開發者：請參閱 I18N.zh-TW.md 了解國際化系統的技術細節、如何新增語言以及翻譯指南。另有 English 和 日本語 版本。
啟用除錯日誌以進行故障排除或開發：
預設日誌位置：./logs/lmstudio-debug.log
原因：所選模型未在 LM Studio 中下載
解決方式：
bge-m3）替代方案：在插件設定中選擇其他模型
原因：檢索相似度門檻對您的內容來說太高
解決方式：
如何調整：LM Studio → Plugins → RAG-Flex → 檢索相似度門檻
原因：大型檔案使用高精度 embedding 模型
解決方式：
nomic-embed-text-v1.5 而非 bge-m3原因：系統語言自動偵測結果與您的偏好不符
解決方式：
注意：此設定僅影響插件執行時的訊息（錯誤訊息、狀態更新等）。LM Studio 的介面語言由 LM Studio 本身控制。
可能原因：
解決方式：
./logs/lmstudio-debug.log\\ 或 /💡 專業提示：所有錯誤訊息都是 AI 友善格式 - 可直接貼到 LLM 對話中進行自動故障排除！
| 格式 | 副檔名 | 處理方式 | 備註 |
|---|---|---|---|
.pdf | 文字擷取 | 支援文字型 PDF（不支援掃描影像） | |
| Word 文件 | .docx | 完整文件解析 | 保留結構與格式 |
| 純文字 | .txt | 直接讀取 | 建議使用 UTF-8 編碼 |
| Markdown | .md | Markdown 解析 | 維持標題結構 |
不支援：圖片、音訊、影片、Excel 試算表、未經 OCR 的掃描 PDF
| 功能 | RAG-v1 | RAG-Flex (v1.2.0) |
|---|---|---|
| Embedding 模型 | ❌ 硬編碼（僅 nomic） | ✅ 4 種可選 + 自動偵測 |
| 多語系支援 | ❌ 僅英文 | ✅ English, 繁體中文, 日本語 |
| 錯誤訊息 | ❌ 技術性英文 | ✅ 友善的在地化訊息 |
| 情境管理 | ⚙️ 基本門檻 | ✅ 智慧門檻策略 |
| 相似度門檻 | ❌ 固定 0.5 | ✅ 可配置（0.0-1.0） |
| 無結果處理 | ❌ 暴露系統提示詞 | ✅ 優雅降級 |
| 模型偵測 | ❌ 手動設定 | ✅ 自動偵測本地模型 |
| 除錯工具 | ❌ 無 | ✅ 可選的除錯日誌 |
| 配置介面 | ⚙️ 僅英文 | ✅ 多語言（系統語言） |
歡迎貢獻！以下是您可以協助的方式：
git checkout -b feature/amazing-feature）git commit -m 'Add amazing feature'）git push origin feature/amazing-feature）要新增新語言：
src/locales/types.ts 中新增語言代碼src/locales/[lang].tssrc/locales/index.tssrc/config.ts 語言選項README.[lang].mdMIT License - 詳見 LICENSE 檔案
這表示您可以：
要求：
作者：Henry Chen GitHub：@henrychen95 專案連結：rag-flex LM Studio 插件頁面：lmstudio.ai/yongwei/rag-flex
⭐ 如果 RAG-Flex 對您的工作流程有幫助，請給專案一個星星！
用 ❤️ 為 LM Studio 社群打造