oai

OAI - OpenAI -Assistent -Schnittstelle

Chatgpt auf Ihrem System

Inhaltsverzeichnis

• Warum oai
• Musteranwendungen
• Installation
• Konfigurieren
• CLI -Verwendung
  • Globaler Zugang
  • Befehle
• Vektorspeicher
• Werkzeuge
  • Verfügbare Werkzeuge
  • Wie füge ich Werkzeuge hinzu?
• Debuggen

Warum oai

Die OpenAI -Assistentin API kümmert sich um Agenten, Gesprächsgeschichte, Vektorspeicher und Auslaufwerkzeuge, für die Traditionnaly viel Boilerplate -Code benötigt.

Unser Ziel bei OAI ist es, eine einfache und intuitive Schnittstelle zur Interaktion mit dieser API zu bieten.

Die aktuelle Version bietet eine CLI -Schnittstelle, aber in Zukunft wird mehr kommen.

Musteranwendungen

• Chatten Sie mit aktuellen Dokumentationen mit verwalteten Vektorstors
• Stellen Sie Fragen zu Ihrem Codebasis, indem Sie Tools nutzen
• Bitten Sie Ihren Assistenten, Code direkt in Dateien zu schreiben
• Lassen Sie Ihren Assistenten auf Ihr System verwalten und zugreifen
• Konfigurieren und testen Sie einen Assistenten für eine weitere Integration
• Was auch immer Sie denken können

Führen Sie einfach oai aus der Befehlszeile aus, um zu interagieren

Installation

OAI verlässt sich derzeit auf Bun und muss in Ihrem System installiert werden, um das Projekt auszuführen.

Eine spätere Version kann die Verwendung der node -Laufzeit ermöglichen, aber im Moment wird nur bun unterstützt.

git clone [email protected]:pAIrprogio/gpt-assistant-cli-playground.git
bun install

Konfigurieren

• Erstellen Sie ein Projekt auf der OpenAI -Plattform
• Erstellen Sie einen API -Schlüssel
• Fügen Sie Ihre OpenAI-API-Schlüssel zu einer .env-Datei mit OPENAI_API_KEY=your-key

CLI -Verwendung

Globaler Zugang

Um Ihren Assistenten global zu installieren und mit dem oai -Befehl zuzugreifen, führen Sie bun link im Ordner des Projekts aus.

Jede Änderung des Projekts wird im globalen Befehl ohne zusätzlichen Build -Schritt widerspiegelt.

Befehle

• oai oder oai chat : Startet einen Chat mit einem Assistenten
• oai a|assistant : Verwalten Sie Ihren Assistenten
  • oai a ls|list : Listen Sie die verfügbaren Assistenten auf
  • oai a add|create|new : Erstellen Sie einen neuen Assistenten
  • oai a rm|remove|delete : entfernen Sie einen Assistenten
  • oai ae|edit : bearbeiten einen Assistenten
• oai vs|vector-store : Verwalten Sie Ihren Vektor Store
  • oai vs ls|list : LIST VECTORSASTORES VORSCHALTEN
  • oai vs add|create|new : Erstellen Sie einen neuen Vektor Store
  • oai vs rm|remove|delete : Entfernen Sie einen Vektorspeicher
  • oai vs e|edit : Bearbeiten eines Vektor Store
  • oai vs sync : Synchronisierte Vektorspeicher synchronisieren

Vektorspeicher

Vektorspeicher werden von Assistenten verwendet, bei denen file search aktiviert werden, um relevante Informationen dynamisch abzurufen. OAI hilft Ihnen, sie benutzerdefinierte Synchronisierungen zu verwalten.

• Sitemap -Synchronisation : Ruft URLs aus einer Sitemap und synchronisiert jede Seite mit dem Vektor Store
• Seiten -URLS -Synchronisation : Ruft URLs von einer Seite ab und synchronisiert jede URL mit dem Vektorspeicher
• Weitere kommen

Stellen Sie nach dem Einrichten sicher, dass Sie oai vs sync durchführen, um Ihren Vektor -Store zu synchronisieren.

Werkzeuge

Verfügbare Werkzeuge

• LS: Git Aware Dateiliste
• Read-Datei: Lesen Sie eine Datei
• Write-Datei: Schreibt in eine Datei und erstellen Sie bei Bedarf Verzeichnisse
• Append-to-File: Findet sich an eine vorhandene Datei an
• Commit: Verpflichtet Änderungen an der aktuellen Filiale
• Create-dir: Erstellt bei Bedarf ein Verzeichnis mit seinen Eltern
• Ausführen von Command: Führen Sie einen Befehl aus (aus Euen Wird nicht um Bestätigung bitten)
• Get-URL-In-Inhalt: Abrufen Sie den Inhalt einer URL ab
• Datei-diff: liest die aktuellen Diffs einer Datei

Wie füge ich Werkzeuge hinzu?

Befolgen Sie die Schritte in DOCS/add-new-tool.md

Debuggen

Aufgrund von Problemen in Bun-vscode müssen Sie durch einen externen Debugger inspizieren.

Um das Projekt zu debuggen, rennen Sie bun debug im Ordner des Projekts.