oai

OAI- OpenAI助理界面

您的系統上的chatgpt

目錄

• 為什麼OAI
• 示例用法
• 安裝
• 配置
• CLI用法
  • 全球訪問
  • 命令
• 向量存儲
• 工具
  • 可用工具
  • 如何添加工具？
• 偵錯

為什麼OAI

Openai Assistant API處理代理，對話歷史記錄，矢量存儲和運行工具，這些工具需要大量的樣板代碼才能設置。

我們使用OAI的目標是提供一個簡單而直觀的界面來與此API進行交互。

當前版本提供了一個CLI接口，但將來會有更多。

示例用法

• 與託管矢量商店與最新文檔聊天
• 通過利用工具詢問有關您的代碼庫的問題
• 要求您的助手將代碼直接寫入文件
• 讓您的助手管理和訪問您的系統
• 配置和測試助手的另一集成
• 無論您想到什麼

只需從命令行運行oai即可交互

安裝

OAI當前依賴BUN，並且需要在系統上安裝它才能運行該項目。

以後的版本可以允許使用node運行時，但是目前僅支持bun 。

git clone [email protected]:pAIrprogio/gpt-assistant-cli-playground.git
bun install

配置

• 在OpenAI平台上創建一個項目
• 創建一個API鍵
• 使用OPENAI_API_KEY=your-key將OpenAI API鍵添加到.env文件中

CLI用法

全球訪問

要在全球安裝您的助手並使用oai命令訪問它，請在項目文件夾中運行bun link 。

對項目進行的任何更改都將反映在Global命令中，而無需任何額外的構建步驟。

命令

• oai或oai chat ：與助手開始聊天
• oai a|assistant ：管理您的助手
  • oai a ls|list ：列表可用助手
  • oai a add|create|new新助手
  • oai a rm|remove|delete ：刪除助手
  • oai ae|edit ：編輯助手
• oai vs|vector-store ：管理您的矢量商店
  • oai vs ls|list ：列表可用矢量商店
  • oai vs add|create|new ：創建一個新的向量存儲
  • oai vs rm|remove|delete ：刪除矢量存儲
  • oai vs e|edit ：編輯矢量商店
  • oai vs sync ：同步託管向量存儲

向量存儲

啟用file search的助手使用矢量存儲，以動態獲取相關信息。 OAI幫助您管理自定義同步。

• 站點地圖同步：從站點地圖獲取URL，並將每個頁面同步到矢量存儲
• 頁面URL同步：從頁面獲取URL，並將每個URL同步到矢量存儲
• 還有更多

設置後，請確保運行oai vs sync以同步您的矢量存儲。

工具

可用工具

• LS：git意識到文件列表
• 閱讀文件：閱讀文件
• 寫文件：寫信給文件，如果需要，創建目錄
• 附加到文件：附加到現有文件
• 提交：提交當前分支的更改
• Create-Dir：如果需要，請與父母創建一個目錄
• 執行命令：執行命令（配x不會要求確認）
• get-url-content：獲取URL的內容
• 文件 - 差：讀取文件的當前差異

如何添加工具？

按照文檔/添加new-tool.md中的步驟

偵錯

由於BUN-VSCODE中的問題，您需要通過外部調試器進行檢查。

要調試項目，請在項目文件夾中運行bun debug 。