Allgemeine Einführung
OAK (Open Agent Kit) ist ein Open-Source-Tool, mit dem Entwickler schnell KI-Intelligenzen erstellen, anpassen und einsetzen können. Es kann mit jedem Large Language Model (LLM) verbunden werden, z. B. von OpenAI, Google oder Anthropic, und unterstützt auch das Hinzufügen von Funktionen über Plugins.OAK wurde mit einem klaren Ziel vor Augen entwickelt: die Integration von KI zu erleichtern. Es bietet eine modulare Struktur, intuitive APIs und einfach zu verwendende Schnittstellenkomponenten, die es Entwicklern ermöglichen, schnell von der Idee zur Produktionsumgebung zu gelangen. Egal, ob Sie einen intelligenten Assistenten oder einen KI-gestützten Kundenservice entwickeln, OAK bietet Flexibilität und Skalierbarkeit. Die Website wird von der Entwickler-Community vorangetrieben, der Code ist öffentlich und kann von den Nutzern frei verändert werden, so dass er sich für Projekte jeder Größe eignet.
Funktionsliste
- Unterstützt beliebige LLM-Verbindungen: kompatibel mit OpenAI, Google, Anthropic und anderen Modellen, unterstützt auch selbst gehostete Modelle.
- Plugin-Erweiterungen: Hinzufügen von Funktionen über Plugins, z. B. Datenverarbeitung oder Echtzeitsuche.
- Modulares Design: bietet anpassbare Komponenten für eine einfache Anpassung der AI-Funktionen.
- Ausführung mit einem Klick: Starten Sie native Anwendungen mit Befehlen ohne komplexe Konfiguration.
- Schnittstellenkomponente: Eingebaute Chat-Schnittstelle, die in eine Website oder Anwendung eingebettet werden kann.
- Open Source und transparent: Der Code ist auf GitHub öffentlich zugänglich und kann von den Nutzern verändert oder ergänzt werden.
- Datenbank-Unterstützung: optional in PostgreSQL gesetzt, speichern Daten bequemer.
- Community-orientiert: Holen Sie sich Unterstützung oder tauschen Sie Erfahrungen über Discord aus.
Hilfe verwenden
OAK ist einfach und unkompliziert und eignet sich sowohl für den schnellen Einstieg als auch für eine tiefgreifende Entwicklungsunterstützung. Im Folgenden finden Sie eine ausführliche Anleitung zur Installation und Verwendung.
Grundlegendes Installationsverfahren
Wenn Sie OAK direkt ausführen möchten, ohne den Code zu ändern oder Plug-ins zu entwickeln, können Sie die folgenden Schritte ausführen:
- eine Anwendung starten
Öffnen Sie ein Terminal und geben Sie den Befehl ein:
npx @open-agent-kit/cli run docker
Dadurch wird OAK automatisch heruntergeladen und gestartet.
- Konfigurationsmodell
In der Befehlszeile werden Sie aufgefordert, ein Modell auszuwählen (z. B. OpenAIs GPT-4o) und den API-Schlüssel einzugeben. Geben Sie den Schlüssel nach Aufforderung ein, z. B.OPENAI_API_KEY=你的密钥
und dann eingeben. - Zugang zu Anwendungen
Nach erfolgreichem Start öffnen Sie Ihren Browser und geben Sie ein:
http://localhost:3000
Sie sehen dann den OAK-Chat-Bildschirm.
- Testlauf
Geben Sie "Welcher Wochentag ist heute" in die Schnittstelle ein. Wenn die richtige Antwort zurückgegeben wird, ist die Installation erfolgreich.
Erweiterter Installationsprozess
Wenn Sie das Standardmodell ändern, Plugins hinzufügen oder neue Funktionen entwickeln möchten, können Sie die folgenden Schritte ausführen:
Ein Projekt erstellen
- Projekt generieren
Geben Sie ihn in das Terminal ein:
npx @open-agent-kit/cli create project
Dadurch wird ein Projektordner mit einer Standardkonfiguration erstellt.
- Zugang zum Katalog
Einfuhrcd 项目名
geben Sie den Projektkatalog ein.
Einrichten der Datenbank (optional)
- PostgreSQL ausführen
Starten Sie die Datenbank mit Docker und geben Sie ein:
docker run --name oak-db
-e POSTGRES_USER=你的用户名
-e POSTGRES_PASSWORD=你的密码
-e POSTGRES_DB=oak
-p 5432:5432 -d pgvector/pgvector:pg17
Austauschbarkeit你的用户名
im Gesang antworten你的密码
.
- Konfigurieren von Verbindungen
Kopieren Sie das Projekt.env.example
wegen.env
Bearbeiten Sie die Datei und geben Sie z. B. die Datenbankinformationen ein:
DATABASE_URL=postgresql://你的用户名:你的密码@localhost:5432/oak?schema=public
Konfiguration der Umgebung
- API-Schlüssel abrufen
- OpenAI: ZugangOffizielle Website von OpenAIerstellen Sie den Schlüssel.
- Google: ReferenzZwillinge Dokumentation.
- Anthropic: AnsichtAnthropische Dokumentation.
- XAI: SieheXAI-Dokumente.
- Anwendungsschlüssel generieren
Interviewshttps://api.open-agent-kit.com/generate-secret.html
Erzeugen SieAPP_SECRET
Zum Beispiel:
APP_SECRET=生成的32位密钥
- Setzen von Umgebungsvariablen
existieren.env
Füllen Sie den Schlüssel und andere Konfigurationen aus, zum Beispiel:
APP_URL=http://localhost:5173
OPENAI_API_KEY=你的密钥
APP_SECRET=你的应用密钥
lokale Entwicklung
- Installation von Abhängigkeiten
Eingabe:
npm install
- operative Migration
Wenn eine Datenbank verwendet wird, ausführen:
npm run generate
npm run migrate:deploy
- eine Anwendung starten
Eingabe:
npm run dev
Interviewshttp://localhost:5173
rufen Sie die Verwaltungsoberfläche auf.
Hauptfunktionen
LLM verbinden
- Klicken Sie in der Benutzeroberfläche auf "Einstellungen" und wählen Sie ein Modell aus (z. B. Google Gemini).
- Geben Sie den API-Schlüssel ein und speichern Sie.
- Testen Sie, indem Sie eine Frage in das Chatfeld eingeben, z. B. "Wie oft ist 1+1 gleich?".
Hinzufügen von Plug-Ins
- Im Projektordner des
plugins
Verzeichnis, fügen Sie den Plugin-Code hinzu (siehe(Computer-)Datei). - in Bewegung sein
npm run build
Verpacken. - Starten Sie die Anwendung neu und das Plugin wird automatisch wirksam.
Anpassen der Schnittstelle
- Passen Sie in der Verwaltungsoberfläche die Farben und Schriftarten an.
- eine Kopie machen von
<iframe>
Code zum Einbinden in Ihre Website.
Featured Function Bedienung
Modulare Entwicklung
- Der modulare Aufbau von OAK ermöglicht es Ihnen, Funktionen individuell anzupassen, z. B. die Chatlogik zu ändern.
- Finden Sie im Code
src/modules
, je nach Bedarf geändert.
Cloud-Bereitstellung
- Einsatz mit Vercel: Geben Sie in das Terminal
vercel deploy
und folgen Sie den Aufforderungen. - Zugriff auf die zurückgegebene URL nach der Bereitstellung.
Diese Schritte machen OAK von der Installation bis zur Nutzung übersichtlich und funktionsfähig. Für mehr Details sieheoffizielles Dokument.
Anwendungsszenario
- intelligenter Assistent
Benutzer können mit OAK persönliche Assistenten erstellen, die Fragen beantworten oder Aufgaben erledigen, wenn sie mit LLM verbunden sind. - Kundenbetreuung
Unternehmen binden OAK in ihre Websites ein, um Antworten auf allgemeine Anfragen zu automatisieren und die Effizienz zu verbessern. - Pädagogische Unterstützung
Lehrkräfte verwenden OAK, um Frage-Antwort-Tools zu erstellen, in die die Schüler Fragen eingeben und das System die Antworten zurückgibt. - Datenanalyse
Entwickler plus Daten-Plugin zur Analyse von Geschäftsdaten und Erstellung von Berichten.
QA
- Welche Modelle werden von OAK unterstützt?
Unterstützt gängige LLMs wie OpenAI, Google, Anthropic usw. und unterstützt auch selbst erstellte Modelle. - Brauchen Sie Programmierkenntnisse?
Eine grundlegende Nutzung ist nicht erforderlich, es genügt, die Schnittstelle zu konfigurieren. Die JavaScript-Basis ist für die Entwicklung von Plugins oder die Änderung von Code erforderlich. - Kostet es etwas, es lokal zu betreiben?
Völlig kostenlos, nur Cloud-Bereitstellungen oder API-Aufrufe können kostenpflichtig sein. - Wie aktualisiert man OAK?
Ziehen Sie einfach den neuesten Code von GitHub und führen Sie den Installationsbefehl erneut aus.