agnai

男性主義

AI 角色扮演 使用您最喜歡的 AI 服務與個人化角色聊天。

現場版 |不和諧

請訪問 Agnai.chat 訪問實時版本。

基於 PygmalionAI 的 Galatea-UI 早期工作。

---

快速入門

重要的！ MongoDB 和 Redis 是可選的！如果 MongoDB 不可用，Agnaistic 將在「Guest Only」模式下運作。

Agnaistic 作為 NPM 套件發布，可以全域安裝：

 # Install or update:
npm install agnai -g
agnai

# View launch options:
agnai help

# Run with the Pipeline features
agnai --pipeline

使用 NPM 套件時，您的映像和 JSON 檔案將儲存在： HOME_FOLDER/.agnai中。
範例：
Linux： /home/sceuick/.agnai/
Mac： /Users/sceuick/.agnai
Windows： C:Userssceuick.agnai 。

特徵

• 群組對話：多個用戶與多個機器人
• 多種AI服務：支援Kobold、Novel、AI Horde、Goose、OpenAI、Claude、Replicate、OpenRouter、Mancer
• 多種角色架構格式：W++、方括號格式 (SBF)、Boostyle、純文字
• 多租戶：
  • 使用者認證
  • 使用者設定：使用哪種AI服務以及自己的設置
  • 使用者產生預設
• 訂閱
• 記憶/知識書籍
• 用AI生成角色
• 使用第三方服務產生圖像
• 選用管道功能
  • 長期記憶
  • 維基百科文章和 PDF 嵌入

手動運行

3. 安裝 Node.js
4. 安裝 MongoDB可選
   • 資料庫是可選的。如果沒有可用的資料庫，Agnaistic 將在anonymous-only模式下運行。
   • Anonymous用戶的資料保存到瀏覽器的本機儲存。您的資料將“持續存在”，但不能在裝置或其他瀏覽器之間共用。清除瀏覽器的應用程式資料/cookie 將刪除該資料。
5. 下載專案： git clone https://github.com/agnaistic/agnai或下載
6. 從終端/控制台中克隆/解壓縮的資料夾內：
   • npm run deps
     • 每次更新 AgniAI 時都執行此操作，以防萬一。
     • 這將使用pnpm v8安裝依賴項
   • npm run build:all
   • 在監視模式下建置並運行專案：
     • Mac/Linux： npm run start
     • Windows： npm run start:win
   • 使用本地隧道建置並運行專案：
     • Mac/Linux： npm run start:public
     • Windows: npm run start:public:win

使用 Docker 運行

1. 克隆項目
2. 使用 MongoDB： docker compose -p agnai -f self-host.docker-compose.yml up -d
3. 沒有 MongoDB： docker run -dt --restart=always -p 3001:3001 ghcr.io/agnaistic/agnaistic:latest
   • -dt分離運作容器
   • --restart=always在啟動時或伺服器崩潰時重新啟動
   • -p 3001:3001公開連接埠 3001 http://localhost:3001

自託管設定

為了嘗試滿足人們在應用程式層級的特定需求所需的小調整和調整，我們有settings.json 。
您可以在根級別建立一個名為settings.json的文件，以在整個應用程式中應用一些更改。
如果您對您的申請有特殊需求，可以在此要求滿足您的需求。

我將嘗試在滿足這些請求和不讓它們在程式碼庫中失控之間找到平衡。

適合於此的請求範例：

• 我想要一個適用於所有用戶的「預設記憶簿」。
• 我想使用與提供的結束令牌不同的一組結束令牌。
• 我想禁用匿名訪問

設定.json

您可以複製或查看template.settings.json以取得所有可用設定的範例。您需要重新啟動 Agnai 才能使變更生效。

目前支援的自訂設定：

• baseEndTokens ：將額外的回應結束標記加入到基本集中。

對於開發人員

推薦的開發工具

我強烈建議使用帶有以下擴充功能的 VSCode：

• Prettier - Code formatter ：用於自動格式化
• Tailwind CSS Intellisense ：使用 Tailwind CSS 類別進行自動完成和智慧感知
• 並將"editor.formatOnSave": true新增至 VSCode settings.json以使用 Prettier 自動格式化

使用pnpm start時，Node.JS 伺服器使用--inspect運行。這意味著您可以使用各種 Inspector Client 進行偵錯。

技術堆疊

堆疊的重要部分是：

• MongoDB 用於持久化
• Redis 用於 Websocket 的分散式訊息傳遞。
• SolidJS 的互動性
• TailwindCSS 用於樣式設定
• pnpm 用於依賴管理

開始

 # Install dependencies - Always run this after pulling changes
> npm run deps

# Run MongoDB using Docker
> npm run up

# Start the frontend, backend, and python service
# Mac/Linux
> npm start

# Windows
> npm run start:win

# Install and run Pipeline API
# If required, this will update the dependencies before running the API
> npm run model # Install poetry into a virtual environment

# Run everything with a single command:
> npm run start:all # Linux and OSX
> npm run start:all:win # Windows

此時，您應該能夠在瀏覽器中造訪 http://localhost:3001 以查看 UI。

您也可以嘗試透過熱重載存取前端：http://localhost:1234

推薦的開發工具

• Redux 開發工具
  • 前端應用程式狀態連接到“Redux Dev Tools”Chrome 擴充功能。
• NodeJS 偵錯工具
  • pnpm start腳本使用--inspect標誌啟動 NodeJS API
  • 使用 VSCode 中的預設啟動任務附加 ( F5 )
  • 或到 url chrome://inspect使用偵錯器
• 使用Poetry進行 Python 依賴管理 - https://python-poetry.org/docs/cli
  • .model/bin/poetry [...args]

格式和類型檢查

專案使用 ESLint 進行 linting，使用 Prettier 強制執行程式碼樣式，並使用 TypeScript 檢查類型錯誤。開啟 PR 時，請確保您不會透過執行以下命令在任何這些檢查中引入任何新錯誤：

 # auto-fixes any style problems
$ pnpm run format:fix

# runs the TypeScript compiler so any type errors will be shown
$ pnpm run typecheck

此專案使用 BrowserStack 進行測試。