Allgemeine Einführung
Das Projekt nutzt das Large Language Model (LLM) und intelligente Web-Crawling-Technologien, um es Benutzern zu ermöglichen, benutzerdefinierte APIs durch Beschreibungen in natürlicher Sprache zu erstellen. Zu den wichtigsten Funktionen gehören die automatische Generierung von Datenstrukturen, Datenaktualisierungen in Echtzeit, strukturierte Datenausgabe und flexible Bereitstellungsoptionen. Die LLM API Engine verfügt über eine modulare Architektur, die die Bereitstellung von API-Endpunkten auf mehreren Plattformen wie Cloudflare Workers, Vercel Edge Functions und AWS Lambda unterstützt.
Funktionsliste
- Umwandlung von Text in APIGenerierung von APIs mit einfachen Beschreibungen in natürlicher Sprache.
- Automatische Generierung von DatenstrukturenOpenAI: Automatische Generierung von Datenstrukturen mit Hilfe der OpenAI-Technologie.
- Intelligentes Web CrawlingCrawling von Webseitendaten mit der Firecrawl-Technologie.
- Datenaktualisierung in EchtzeitUnterstützung für zeitgesteuerte Crawls und Datenaktualisierungen in Echtzeit.
- Sofortige API-BereitstellungSchnelle Bereitstellung von API-Endpunkten.
- Strukturierte DatenausgabeValidierung der Ausgabedaten mittels JSON-Schema.
- Caching und SpeicherarchitekturRedis für Caching und Speicherung verwenden.
Hilfe verwenden
Ablauf der Installation
- Klon-Lager::
git clone https://github.com/developersdigest/llm-api-engine.git
cd llm-api-engine
- Installation von Abhängigkeiten::
npm-Installation
- Erstellen einer Datei mit UmgebungsvariablenAnlegen im Stammverzeichnis des Projekts
.env
Datei und fügen Sie die folgenden Variablen hinzu:
OPENAI_API_KEY=Ihr_openai_key
FIRECRAWL_API_KEY=Ihr_firecrawl_key
UPSTASH_REDIS_REST_URL=Ihre_redis_url
UPSTASH_REDIS_REST_TOKEN=Ihr_redis_token
NÄCHSTE_ÖFFENTLICHE_API_ROUTE=http://localhost:3000
- Betrieb des Entwicklungsservers::
npm run dev
Öffnen Sie Ihren Browser, um aufhttp://localhost:3000
App ansehen.
Funktion Betriebsablauf
- Erstellen von API-Endpunkten::
- Besuchen Sie die Homepage der Anwendung und klicken Sie auf die Schaltfläche "Neue API erstellen".
- Geben Sie den API-Namen und die Beschreibung ein und wählen Sie die Art der Datenquelle (z. B. Web-Crawling).
- Verwenden Sie natürliche Sprache, um die erforderlichen Datenstrukturen und Crawling-Regeln zu beschreiben.
- Klicken Sie auf die Schaltfläche "API generieren", das System wird automatisch API-Endpunkte und Datenstrukturen generieren.
- Konfigurieren und Verwalten der API::
- Zeigen Sie die Liste der erstellten APIs auf dem Bildschirm API-Verwaltung an.
- Klicken Sie auf eine API, um die Detailseite aufzurufen, auf der Sie die API-Konfiguration bearbeiten, Crawl-Protokolle anzeigen und API-Endpunkte testen können.
- Konfiguriert mit der Redis Storage API, mit Unterstützung für Änderungen und Aktualisierungen zu jeder Zeit.
- Bereitstellen von API-Endpunkten::
- Wählen Sie die Bereitstellungsplattform aus (z. B. Vercel, AWS Lambda, usw.).
- Konfigurieren Sie die Bereitstellungsparameter entsprechend den Anforderungen der Plattform und klicken Sie auf die Schaltfläche "Bereitstellen".
- Nachdem die Bereitstellung abgeschlossen ist, können Sie die URL und den Status der API-Endpunkte auf dem Bildschirm "API-Verwaltung" anzeigen.
- Verwendung von API-Endpunkten::
- Rufen Sie API-Endpunkte in Ihrer Anwendung auf, um strukturierte Daten zu erhalten.
- Unterstützt den Zugriff auf API-Endpunkte über HTTP-Anforderungen, die Daten im JSON-Format zurückgeben.