agnai

Agnaistisch

KI-Rollenspiel-Chat mit personalisierten Charakteren unter Verwendung Ihrer bevorzugten KI-Dienste.

Live-Version | Zwietracht

Besuchen Sie die Live-Version auf Agnai.chat.

Basierend auf der frühen Arbeit von Galatea-UI von PygmalionAI.

---

Schnellstart

Wichtig! MongoDB und Redis sind optional! Agnaistic wird im Modus „Nur Gast“ ausgeführt, wenn MongoDB nicht verfügbar ist.

Agnaistic wird als NPM-Paket veröffentlicht und kann global installiert werden:

 # Install or update:
npm install agnai -g
agnai

# View launch options:
agnai help

# Run with the Pipeline features
agnai --pipeline

Wenn Sie das NPM-Paket verwenden, werden Ihre Bilder und JSON-Dateien gespeichert in: HOME_FOLDER/.agnai .
Beispiele:
Linux: /home/sceuick/.agnai/
Mac: /Users/sceuick/.agnai
Windows: C:Userssceuick.agnai .

Merkmale

• Gruppengespräche : Mehrere Benutzer mit mehreren Bots
• Mehrere KI-Dienste : Unterstützung für Kobold, Novel, AI Horde, Goose, OpenAI, Claude, Replicate, OpenRouter, Mancer
• Mehrere Persona-Schemaformate: W++, Format mit eckigen Klammern (SBF), Boostyle, Nur-Text
• Mandantenfähigkeit:
  • Benutzerauthentifizierung
  • Benutzereinstellungen: Welcher KI-Dienst verwendet werden soll und eigene Einstellungen
  • Voreinstellungen für die Benutzergenerierung
• Abonnements
• Erinnerungs-/Überlieferungsbücher
• Generieren Sie Charaktere mit KI
• Bildgenerierung mithilfe von Diensten Dritter
• Optionale Pipeline-Funktionen
  • Langzeitgedächtnis
  • Wikipedia-Artikel und PDF-Einbettung

Manuell ausführen

3. Installieren Sie Node.js
4. Installieren Sie MongoDB optional
   • Die Datenbank ist optional. Agnaistic wird im anonymous-only Modus ausgeführt, wenn keine Datenbank verfügbar ist.
   • Bei Anonymous Benutzern werden die Daten im lokalen Speicher des Browsers gespeichert. Ihre Daten bleiben „bleiben“, können jedoch nicht zwischen Geräten oder anderen Browsern geteilt werden. Durch das Löschen der Anwendungsdaten/Cookies Ihres Browsers werden diese Daten gelöscht.
5. Laden Sie das Projekt herunter: git clone https://github.com/agnaistic/agnai oder laden Sie es herunter
6. Aus dem geklonten/entpackten Ordner in Ihrem Terminal/Ihrer Konsole:
   • npm run deps
     • Tun Sie dies für alle Fälle jedes Mal, wenn Sie AgnAI aktualisieren.
     • Dadurch werden die Abhängigkeiten mit pnpm v8 installiert
   • npm run build:all
   • Erstellen Sie das Projekt und führen Sie es im Überwachungsmodus aus:
     • Mac/Linux: npm run start
     • Windows: npm run start:win
   • Erstellen Sie das Projekt und führen Sie es mit Local Tunnel aus:
     • Mac/Linux: npm run start:public
     • Windows: npm run start:public:win

Laufen mit Docker

1. Klonen Sie das Projekt
2. Mit MongoDB: docker compose -p agnai -f self-host.docker-compose.yml up -d
3. Ohne MongoDB: docker run -dt --restart=always -p 3001:3001 ghcr.io/agnaistic/agnaistic:latest
   • -dt Den Container getrennt ausführen
   • --restart=always neu starten beim Start oder wenn der Server abstürzt
   • -p 3001:3001 Geben Sie Port 3001 frei. Greifen Sie auf die App unter http://localhost:3001 zu

Self-Hosting-Einstellungen

Um zu versuchen, die kleinen Optimierungen und Optimierungen zu berücksichtigen, die Benutzer für ihre spezifischen Anforderungen auf Anwendungsebene benötigen, haben wir settings.json .
Sie können auf der Stammebene eine Datei mit dem Namen settings.json erstellen, um einige Änderungen auf die gesamte Anwendung anzuwenden.
Wenn Sie spezielle Anforderungen an Ihre Anwendung haben, können Sie hier nachfragen, ob diese berücksichtigt werden.

Ich werde versuchen, ein Gleichgewicht zwischen der Beantwortung dieser Anforderungen und der Vermeidung, dass sie in der Codebasis außer Kontrolle geraten, zu finden.

Beispiele dafür geeigneter Anfragen:

• Ich möchte, dass allen Benutzern ein „Standardspeicherbuch“ zugewiesen wird.
• Ich möchte einen anderen Satz End-Tokens als die bereitgestellten verwenden.
• Ich möchte den anonymen Zugriff deaktivieren

Settings.json

Sie können template.settings.json kopieren oder sich ein Beispiel für alle verfügbaren Einstellungen ansehen. Sie müssen Agnai neu starten, damit die Änderungen wirksam werden.

Derzeit unterstützte benutzerdefinierte Einstellungen:

• baseEndTokens : Fügen Sie dem Basissatz zusätzliche Antwort-End-Tokens hinzu.

Für Entwickler

Empfohlene Entwicklungstools

Ich würde die Verwendung von VSCode mit den folgenden Erweiterungen dringend empfehlen:

• Prettier - Code formatter : Für die automatische Formatierung
• Tailwind CSS Intellisense : Für automatische Vervollständigung und Intellisense mit Tailwind CSS-Klassen
• Und fügen Sie "editor.formatOnSave": true zu Ihrer VSCode- settings.json hinzu, um die automatische Formatierung mit Prettier durchzuführen

Bei Verwendung von pnpm start wird der Node.JS-Server mit --inspect ausgeführt. Das bedeutet, dass Sie zum Debuggen verschiedene Inspector-Clients verwenden können.

Tech-Stack

Die wichtigen Teile des Stapels sind:

• MongoDB für Persistenz
• Redis für verteiltes Messaging für Websockets.
• SolidJS für Interaktivität
• TailwindCSS für das Styling
• pnpm für das Abhängigkeitsmanagement

Beginnt

 # 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

Zu diesem Zeitpunkt sollten Sie in Ihrem Browser auf http://localhost:3001 zugreifen können, um die Benutzeroberfläche anzuzeigen.

Sie können auch versuchen, mit Hot-Reloading unter http://localhost:1234 auf das Frontend zuzugreifen

Empfohlene Entwicklertools

• Redux-Entwicklungstools
  • Der Front-End-Anwendungsstatus ist mit der Chrome-Erweiterung „Redux Dev Tools“ verknüpft.
• NodeJS-Debugger
  • Das pnpm start Startskript startet die NodeJS-API mit dem Flag --inspect
  • Anhängen mit der Standard-Startaufgabe in VSCode ( F5 )
  • Oder gehen Sie zur URL chrome://inspect um den Debugger zu verwenden
• Python-Abhängigkeitsmanagement mit Poetry – https://python-poetry.org/docs/cli
  • .model/bin/poetry [...args]

Format- und Typprüfung

Das Projekt verwendet ESLint zum Flusen, Prettier zur Durchsetzung des Codestils und TypeScript zur Überprüfung auf Typfehler. Stellen Sie beim Öffnen einer PR sicher, dass Sie bei keiner dieser Prüfungen neue Fehler verursachen, indem Sie Folgendes ausführen:

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

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

Dieses Projekt wurde mit BrowserStack getestet.