Instrukt
v0.6.2
Terminal AI Commander immer zur Hand
Weitere Beispiele finden Sie in den Demos.
HINWEIS : Dies ist eine laufende Arbeit, es sind Fehler und API-Änderungen zu erwarten.
Instrukt ist eine terminalbasierte KI-integrierte Umgebung. Es bietet eine Plattform, auf der Benutzer:
Erstellen und unterweisen Sie modulare KI-Agenten
Generieren Sie Dokumentindizes zur Beantwortung von Fragen
Erstellen Sie Tools und hängen Sie sie an jeden Agenten an
Agenten sind einfache Drop-in-Python-Pakete , die erweitert, mit anderen geteilt, an Tools angehängt und mit Dokumentindizes erweitert werden können.
Weisen Sie sie in natürlicher Sprache an und führen Sie sie aus Sicherheitsgründen in sicheren Containern (derzeit mit Docker implementiert) aus, um Aufgaben in ihrem dedizierten Sandbox-Bereich auszuführen ?️.
Gebaut mit: Langchain, Textual, Chroma
Beratungsdienste : Benötigen Sie Hilfe bei der Langchain- oder KI-Integration? Sie erreichen mich unter [email protected]
Verwendung
Merkmale
Unterstützte Plattformen
LLM-Modelle
Dokumentenverzeichnisse und Fragen-Antworten
Roadmap
Mitwirken
Patreon
Sozial
Vision
Lizenz
pip install instrukt[all]
Exportieren Sie OPENAI_API_KEY mit Ihrem OpenAI-API-Schlüssel.
instrukt ausführen
Wenn das Farbschema fehlerhaft ist, exportieren Sie TERM=xterm-256color
Eine Konfigurationsdatei wird erstellt unter: ~/.config/instrukt/instrukt.yml
Sie können instrukt auf einem Headless-Server wie einem Docker-Container mit CUDA-Unterstützung ausführen.
HINWEIS : Wenn Sie mit einem Bare-Container beginnen, benötigen Sie mindestens g++ und libmagic.
Weitere Informationen finden Sie in der Schnellstart- und Installationsanleitung.
Stellen Sie sicher, dass die neueste Version von poetry installiert ist.
Legen Sie Ihre virtuelle Umgebung fest
Klonen Sie das Repository
Führen Sie poetry install -E all --with dev,test
Dadurch wird Instrukt einschließlich zusätzlicher Tools für Agenten installiert.
Weitere Einzelheiten finden Sie in der Installationsanleitung
Coding AI : Ein Codierungsassistent. Erstellen Sie Indizes für jede Codebasis und hängen Sie sie an den Agenten an, um RAG (Retrieval Augmented Generation) durchzuführen.
Chat-Fragen und Antworten : Ein einfacher Konversationsagent.
Eine terminalbasierte Schnittstelle für Benutzer von Power-Tastaturen, um KI-Agenten Anweisungen zu geben, ohne jemals die Tastatur zu verlassen.
Reichhaltige, farbenfrohe Agentenausgaben mit Markdown- und Quellcode-Unterstützung dank der Textual TUI-Bibliothek.
Führen Sie Instrukt auf Bare-Metal- oder Docker-Containern mit CUDA-Unterstützung aus.
Fernzugriff mit SSH und Terminal-Multiplexern.
Entwerfen Sie benutzerdefinierte Agenten und Tools.
Agenten sind einfache Python-Pakete, die von anderen Benutzern geteilt und geladen werden können.
Indizieren Sie Ihre Daten und lassen Sie sie von Agenten zur Beantwortung von Fragen abrufen.
Erstellen und organisieren Sie Ihre Indizes mit einer einfachen Benutzeroberfläche.
Bei der Indexerstellung werden Programmiersprachen automatisch erkannt und die Aufteilungs-/Chunking-Strategie entsprechend optimiert.
Fuzzy-Auswahl (fzf, dmenu ...) der Quelldokumente, die zum Abrufen verwendet wurden ctrl+p
Nutzen Sie das vordefinierte Toolset oder entwerfen Sie Ihre eigenen Tools.
Fügen Sie den Agenten unterwegs Tools hinzu oder trennen Sie sie, um Ihre KI-Workflows an Ihre Bedürfnisse anzupassen.
Integrierte REPL-Eingabeaufforderung für schnelle Interaktion mit Agenten und eine schnelle Feedbackschleife für Entwicklung und Tests.
Automatisieren Sie sich wiederholende Aufgaben mit benutzerdefinierten Befehlen.
Eingebauter Eingabeaufforderungs-/Chatverlauf.
Verwenden Sie vim , emacs oder einen beliebigen externen $EDITOR um Nachrichten zu bearbeiten.
Nutzen Sie das LangChain-Ökosystem, um alles zu automatisieren.
WIP: Erweiterbare API zur Integration mit anderen Frameworks.
Führen Sie Agenten aus Sicherheits- und Datenschutzgründen in sicheren Docker-Containern aus.
Verwenden Sie die gVisor-Laufzeitumgebung für eine vollständige Isolierung des Agenten.
Hinweis : Der Docker-Agent steht Patreon-Unterstützern nur als frühe Vorschau zur Verfügung.
Debuggen und überprüfen Sie Agenten mithilfe einer integrierten IPython-Konsole. ctrl+d
Indizes können mit OpenAI oder lokalen Einbettungsmodellen erstellt werden.
Chroma zum Verwalten von Indizes.
Erstellen und verwalten Sie Indizes mit der Indexverwaltungs -Benutzeroberfläche (drücken Sie I ).
Durch die Indizierung eines Verzeichnisses werden Programmiersprachen automatisch erkannt und eine geeignete Aufteilungsstrategie verwendet, die für die Zielsprache optimiert ist.
Über das index oben im Fenster des Agenten können Indizes als Abruftool an jeden Agenten angehängt werden.
Agenten können beigefügte Indizes zur Beantwortung von Fragen verwenden.
Linux/Mac.
Windows unter WSL2 getestet.
Derzeit wird nur OpenAI unterstützt.
Der Einsatz privater lokaler Modelle ist der nächste Meilenstein .
private lokale LLM-Modelle
HF SetenceTransformers unterstützte Einbettungen.
Einbettungen von Kursleitern
Lokale Einbettungen
Verwenden Sie die API text-generation-webui
PrivateGPT emulieren
Verwenden Sie selbst gehostetes Go-Skynet/LocalAI
Indizierung und Einbettungen
Verzeichnisse indizieren und Inhalte automatisch erkennen. (siehe AutoDirLoader )
Erkennen Sie Programmiersprachen und verwenden Sie den entsprechenden Splitter.
Laden Sie ein Git-Repository von der URL
Laden Sie eine beliebige Webseite / Website.
Dokumentation
Agenten erstellen
Werkzeuge erstellen
Indizieren und Chatten mit Dokumenten und Quellcode.
Beispielhafte Anwendungsfälle
Tutorials.
Jeder Beitrag, jedes Feedback und jede PR ist willkommen!
Sie können helfen bei:
Testen und Erstellen von Problemen auf Fehler oder Funktionen, die nützlich wären.
Wenn Sie über technische Fähigkeiten verfügen, können Sie gerne eine PR erstellen.
Wenn Sie keine technischen Kenntnisse haben, können Sie bei der Dokumentation helfen, Beispiele und Tutorials hinzufügen oder neue User Stories erstellen.
Indem Sie Förderer werden, helfen Sie mir, weiterhin Zeit in die Entwicklung von Instrukt zu investieren und alle geplanten Funktionen zum Leben zu erwecken. Weitere Informationen zu den Belohnungen für frühe Unterstützer finden Sie auf der Patreon-Seite.
Treten Sie dem Discord-Server bei, um über den Fortschritt auf dem Laufenden zu bleiben oder um Hilfe zu bitten.
KI sollte für jeden zugänglich sein und kein ummauerter Garten für große Konzerne und SaaS-Dienste.
Instrukt ist ein bescheidener Beitrag zur Entwicklung von Tools, die Benutzer befähigen, ohne ihre Freiheiten zu beeinträchtigen. Das kurzfristige Ziel besteht darin, es mit minimaler Abhängigkeit von externen APIs und Diensten nutzbar zu machen und den Benutzern die Wahl zu geben, sich für lokale Modelle und selbst gehostete Dienste zu entscheiden.
Copyright (c) 2023 Chakib Ben Ziane. Alle Rechte vorbehalten.
Instrukt ist mit einer AGPL-Lizenz lizenziert, was kurz gesagt bedeutet, dass es von jedem für jeden Zweck verwendet werden kann. Wenn Sie sich jedoch dafür entscheiden, eine öffentlich zugängliche Instanz bereitzustellen, haben Ihre Benutzer Anspruch auf eine Kopie des Quellcodes einschließlich aller von Ihnen vorgenommenen Änderungen (die über eine Schnittstelle wie eine Schaltfläche auf Ihrer Website verfügbar sein muss). Sie können dies auch tun Verteilen Sie dieses Projekt nicht in einer Form, die den Quellcode nicht enthält (z. B. durch Kompilieren/Verschlüsselung des Codes und Verteilen dieser Version, ohne auch den Quellcode zu verbreiten, der die von Ihnen vorgenommenen Änderungen enthält). Sie dürfen dies in geschlossener Form verbreiten wenn Sie auch eine separate bereitstellen Archiv mit dem Quellcode.).
