volcengine/SearchCLI

SearchCLI – Volcengine AI Search 的命令列介面

是什麼 – SearchCLI 是 Volcengine 的 AI Search 服務的 CLI 封裝。它讓開發者與 AI 代理系統能從終端管理資料集、應用程式，並執行搜尋、推薦與對話式檢索操作。

適合誰 –

• 需要將 AI 驅動的搜尋或推薦功能整合至業務後端的工程師。
• 需要以可重複、可審查方式攝取資料、設定搜尋應用並驗證結果的自主代理團隊。
• 希望在將變更推送到生產環境前進行安全「預演」工作流程的運維人員。

核心功能

領域	CLI 命令（前綴 vs）	功能
認證與健康檢查	vs auth, vs doctor	加載 Volcengine 憑證，檢查連接性
LLM 集成	vs llm	註冊一個 OpenAI 相容的 LLM 用於相關性判斷或查詢產生
資料集處理	vs dataset, vs data	導入檔案，推斷模式，寫入記錄
應用程式管理	vs app	建立搜尋應用，附加資料集
搜尋 / 推薦 / 對話	vs search run, vs recommend run, vs chat run	執行即時查詢，取得排序結果，執行對話式檢索
調優	`vs search tune query-generate	plan
可擴展性	Viking skills（透過 npx skills add … 安裝）	可重用的命令集合包，外部 AI 代理可程式化呼叫

典型人類工作流程

1. 克隆倉儲並執行 bash ./scripts/install.sh（需要 Node 20+ 和 git）。
2. 使用您的 Volcengine Access Key/Secret Key 進行認證（vs auth login 或從環境變數匯入）。
3. （可選）註冊一個 LLM 用於相關性判斷（vs llm login）。
4. 導入一個 JSONL 資料檔案，讓服務推斷模式，寫入資料，建立應用，並附加資料集——僅需幾個 vs dataset … 和 vs app … 命令即可完成。
5. 執行 vs search run、vs recommend run 或 vs chat run 來查看服務運作效果，或使用調優命令提升相關性。

代理導向工作流程

• 一次性安裝 CLI。
• 加入預打包的 Viking skills（npx skills add …）。這些將相同的命令組暴露為外部 AI 代理可呼叫的函數。
• 代理進行認證，驗證技能包後，即可在自動化流程中呼叫 vs search tune … 或 vs chat run …，並內建「預演」與確認步驟以確保安全。

安裝與先決條件

• Node.js 20+ 和 git。
• 擁有 AI Search 權限的 Volcengine 帳戶（AK/SK）。
• （可選）用於相關性判斷的 OpenAI 相容 LLM 端點存取權限。

文件與社群

• 多語系 README 連結（英文、中文、日文等）。
• 詳細的代理快速入門指南（docs/agent-quick-start.md）。
• 實時支援的 WeChat 使用者群組（倉儲中提供 QR 碼）。
• 標準開源貢獻文件（CLA、行為準則、安全策略）。

授權 – Apache-2.0。

---

總結 – SearchCLI 是一個生產級、以 CLI 為先的工具，連接 Volcengine 的 AI Search 平台與人類操作員及自主代理，提供可搜尋、可推薦、可對話的檢索能力，同時具備安全、可腳本化的流程。