Instrukt

指令

終端AI指揮官觸手可及

編碼.assistant.example.mp4

查看演示以獲取更多範例。

注意：這是一項正在進行的工作，預計會出現錯誤和 API 變更。

介紹

Instrukt是一個基於終端的AI整合環境。它提供了一個平台，用戶可以：

• 創建並指導模組化人工智慧代理

• 產生問答的文件索引

• 建立工具並將其附加到任何代理

代理是簡單的嵌入式 Python 包，可以擴展、與他人共享、附加到工具並透過文件索引進行增強。

用自然語言指導它們，並且為了安全起見，在安全容器（目前使用 Docker 實現）中運行它們，以在其專用的沙盒空間中執行任務？

內建：Langchain、Textual、Chroma

諮詢服務：需要 Langchain 或人工智慧整合的幫助嗎？您可以透過 [email protected] 與我聯繫

總有機碳

• 用法

• 特徵

• 支援的平台

• 法學碩士模型

• 文件索引和問答

• 路線圖

• 貢獻

• 派特隆

• 社會的

• 想像

• 執照

用法

快速入門

• pip install instrukt[all]

• 使用您的 OpenAI API 金鑰匯出OPENAI_API_KEY 。

• 運行instrukt

• 如果配色方案被破壞，請匯出TERM=xterm-256color

• 將在下列位置建立設定檔： ~/.config/instrukt/instrukt.yml

您可以在無頭伺服器或具有 CUDA 支援的 Docker 容器上執行 instrukt。

注意：如果您從裸容器開始，則至少需要 g++ 和 libmagic。

查看快速入門和安裝指南以了解更多詳細資訊。

來自來源：

• 確保安裝了最新版本的poetry 。

• 設定你的虛擬環境

• 克隆儲存庫

• 運行poetry install -E all --with dev,test

• 這將安裝 Instrukt，包括用於代理的額外工具。

請參閱安裝指南以了解更多詳細信息

預設代理：

編碼人工智慧：編碼助理。在任何程式碼庫上建立索引並將其附加到代理程式以執行 RAG（檢索增強生成）

聊天問答：一個簡單的對話代理。

特徵

鍵盤和滑鼠終端介面：

• 基於終端的介面，讓強力鍵盤使用者無需離開鍵盤即可指示 AI 代理。

• 由於 Textual TUI 庫，豐富多彩的代理輸出具有降價和原始碼支援。

• 在具有 CUDA 支援的裸機或 Docker 容器上執行 Instrukt。

• 使用 SSH 和終端多工器進行遠端存取。

客製化人工智慧代理：

• 設計客製化代理商和工具。

• 代理是簡單的 python 包，可以由其他使用者共用和載入。

聊程式碼和文件：

• 對您的資料建立索引並讓代理程式檢索它以進行問答。

• 使用簡單的使用者介面建立和組織索引。

• 索引建立將自動偵測程式語言並相應地優化拆分/分塊策略。

• 模糊選擇（fzf、dmenu ...）用於檢索的來源文檔ctrl+p

工具：

• 使用預先定義的工具集或設計您自己的工具。

• 隨時隨地為代理商附加或分離工具，根據您的需求自訂 AI 工作流程。

提示控制台：

• 整合的 REPL-Prompt 可實現與代理程式的快速交互，以及用於開發和測試的快速回饋循環。

• 使用自訂指令自動執行重複任務。

• 內建提示/聊天記錄。

• 使用vim 、 emacs或任何外部$EDITOR來編輯訊息。

浪鏈：

• 利用 LangChain 生態系統實現一切自動化。

• WIP：用於與其他框架整合的可擴充 API。

安全容器：

• 在安全的 Docker 容器內執行代理程式以確保安全和隱私。

• 使用 gVisor 運行時來完全隔離代理程式。

注意：docker 代理僅作為早期預覽版提供給 Patreon 支持者。

開發者控制台：

使用內建 IPython 控制台偵錯和內省代理程式。 ctrl+d

文件索引和問答

• 可以使用 OpenAI 或本地嵌入模型建立索引。

• Chroma 用於管理索引。

• 使用索引管理UI 建立和管理索引（按I ）

• 索引目錄將自動偵測程式語言並使用針對目標語言最佳化的適當分割策略。

• 使用代理程式視窗頂部的index選單，可以將索引作為檢索工具附加到任何代理。

• 客服人員可以使用附加索引進行問答。

支援的平台：

• Linux/Mac。

• Windows 在 WSL2 下進行了測試。

法學碩士模型

• 目前僅支援OpenAI 。

• 使用私有本地模型是下一個里程碑。

路線圖

• 私人本地法學碩士模式

• HF SetenceTransformers 支援嵌入。

• 講師嵌入

• 本地嵌入

• 使用文字產生-webui API

• 模擬 PrivateGPT

• 使用自架的 go-skynet/LocalAI

• 索引和嵌入

• 索引目錄和自動檢測內容。 （參見AutoDirLoader ）

• 檢測程式語言並使用適當的拆分器。

• 從 URL 載入 git 儲存庫

• 加載任何網頁/網站。

• 文件

• 創建代理

• 創建工具

• 對文件和原始碼進行索引和聊天。

• 範例用例

• 教程。

貢獻

歡迎任何貢獻、回饋和公關！

您可以提供以下協助：

• 測試和創建有用的錯誤或功能的問題。

• 如果您有技術能力，歡迎您建立 PR。

• 如果您沒有技術技能，您可以協助編寫文件、新增範例和教學課程或建立新的使用者故事。

派特隆

透過成為贊助人，您將幫助我繼續投入時間開發 Instrukt 並實現所有計劃的功能。請查看 Patreon 頁面，以了解有關早期支持者獎勵的更多詳細資訊。

社會的

加入 Discord 伺服器以了解最新進展或尋求協助。

想像

人工智慧應該可供所有人使用，而不是大公司和 SaaS 服務的圍牆花園。

Instrukt 為創建在不損害用戶自由的情況下增強用戶能力的工具做出了微薄的貢獻。短期目標是使其在對外部 API 和服務的依賴最小化的情況下可用，讓使用者可以選擇本機模型和自託管服務。

執照

版權所有 (c) 2023 Chakib Ben Ziane。版權所有。

Instrukt 獲得 AGPL 許可證，簡而言之，這意味著任何人都可以將其用於任何目的。但是，如果您決定公開提供實例，您的用戶有權獲得原始程式碼的副本，包括您所做的所有修改（需要透過網站上的按鈕等介面提供），您也可以不以不包含原始程式碼的形式分發此項目（例如編譯/加密代碼並分發此版本，但同時不分髮包含您所做更改的源代碼。您可以以封閉形式分發此項目如果您還提供帶有源代碼的單獨存檔。）。