Allgemeine Einführung
AI Writing Assistant ist ein auf GitHub gehosteter, auf Next.js basierender Open-Source-KI-Schreibassistent, der Autoren, Inhaltserstellern und Werbetextern helfen soll, die Effizienz und Qualität ihres Schreibens durch Technologie der künstlichen Intelligenz zu verbessern. Das Tool ermöglicht es den Nutzern, Schreibanforderungen über einen detaillierten Editor zu organisieren und Anweisungen an mehrere Large Language Models (LLMs) zu senden, um Inhalte zu generieren. Es unterstützt die wichtigsten API-Schnittstellen wie OpenAI, Claude und Grok und bietet flexible Konfigurationsoptionen und eine benutzerfreundliche Oberfläche. Ob es um die Erstellung von Artikeln, die Anpassung des Tons oder den Export von Markdown-Dateien geht, dieses Projekt bietet den Benutzern eine effiziente Schreibunterstützung und ist ein hervorragendes Beispiel dafür, wie Technologie und Kreativität zusammenarbeiten können.
Funktionsliste
- Anpassung des Wortstils für StichworteUnterstützung der mehrdimensionalen Bearbeitung von Sprache, Struktur, Emotionen usw., um einen Text zu erstellen, der den Bedürfnissen des Benutzers entspricht.
- Unterstützung mehrerer ModelleKompatibel mit OpenAI, Claude, Gemini und anderen LLM-APIs, um den Anforderungen verschiedener Szenarien gerecht zu werden.
- Flexible API-KonfigurationEinfaches Einrichten von API-Schlüsseln und Endpunkten mit einem zusammenklappbaren Panel.
- Bearbeitung von Inhalten in EchtzeitDer generierte Text kann direkt im integrierten Editor geändert werden.
- Markdown-ExportEin-Klick-Export von Inhalten in das Markdown-Format zum einfachen Speichern und Teilen.
- Ansicht der Debugging-InformationenDetaillierte API-Antwortprotokolle für die Fehlersuche bereitstellen.
- Thema wechselnUnterstützt dunkle und helle Modi zur Anpassung an die Vorlieben des Benutzers.
- Agent-UnterstützungEingebaute Proxy-Funktionalität, um Netzwerkzugriff oder CORS-Beschränkungen zu umgehen.
Hilfe verwenden
AI Writing Assistant ist ein Open-Source-Tool, für das die Benutzer den Code über GitHub beziehen und lokal ausführen müssen. Nachfolgend finden Sie eine detaillierte Installations- und Nutzungsanleitung, um den Benutzern einen schnellen Einstieg zu ermöglichen.
Ablauf der Installation
Um dieses Tool zu verwenden, benötigen Sie einige technische Grundlagen, darunter eine Node.js-Umgebung und Git-Operationen. Hier sind die Schritte:
- Vorbereiten der Umgebung
- Stellen Sie sicher, dass auf Ihrem Computer Node.js 16.20.0 oder höher installiert ist (Download:
https://nodejs.org/
). - Installieren Sie das Tool Git (Download-Adresse:
https://git-scm.com/
) zum Klonen von Code.
- Stellen Sie sicher, dass auf Ihrem Computer Node.js 16.20.0 oder höher installiert ist (Download:
- Projektcode abrufen
- Öffnen Sie Ihren Browser und besuchen Sie
https://github.com/GeekyWizKid/writing-helper
. - Klicken Sie auf die grüne Schaltfläche "Code", um die Repository-Adresse zu kopieren:
https://github.com/GeekyWizKid/writing-helper.git
. - Öffnen Sie ein Terminal und geben Sie den folgenden Befehl ein, um das Projekt zu klonen:
git clone https://github.com/GeekyWizKid/writing-helper.git
- Rufen Sie den Projektkatalog auf:
cd schreib-helper
- Öffnen Sie Ihren Browser und besuchen Sie
- Installation von Abhängigkeiten
- Führen Sie den folgenden Befehl im Terminal aus, um die erforderlichen Abhängigkeiten für das Projekt zu installieren:
npm-Installation
- Warten Sie ein paar Minuten, bis alle Abhängigkeiten installiert sind.
- Führen Sie den folgenden Befehl im Terminal aus, um die erforderlichen Abhängigkeiten für das Projekt zu installieren:
- Starten des Entwicklungsservers
- Geben Sie den folgenden Befehl ein, um das Projekt zu starten:
npm run dev
- Nach erfolgreichem Start öffnen Sie Ihren Browser und besuchen Sie
http://localhost:3000
Sie können die Schnittstelle des Tools sehen.
- Geben Sie den folgenden Befehl ein, um das Projekt zu starten:
- Fehlerbehebung
- Wenn der Start fehlschlägt, überprüfen Sie, ob die Node.js-Version korrekt ist, oder lesen Sie die Fehlermeldung des Terminals.
- Besuchen Sie die "Issues"-Seite von GitHub, um nach ähnlichen Problemen zu suchen oder ein neues Problem einzureichen, um Hilfe zu erhalten.
Hauptfunktionen
Nach der Installation können die Benutzer die folgenden Funktionen über die Browserschnittstelle nutzen:
API-Einstellungen
- Öffnen Sie das EinstellungsfeldAuf der Startseite klicken Sie auf die Schaltfläche "API-Einstellungen" auf der linken Seite, um das Konfigurationsfenster zu öffnen.
- Modell auswählenWählen Sie eine unterstützte API (z.B. OpenAI, Claude, Grok, etc.) im Dropdown-Menü.
- Geben Sie den SchlüsselAPI-Schlüssel: Geben Sie Ihren API-Schlüssel (den Sie von der entsprechenden Plattform erhalten, z. B. von der OpenAI-Website) in das entsprechende Feld ein.
- Benutzerdefinierte EndpunkteWenn Sie einen Proxy oder ein lokales Modell verwenden, können Sie eine benutzerdefinierte Adresse in die "API Base URL" eingeben.
- Konfiguration speichernKlicken Sie auf "Speichern" oder gehen Sie direkt zum nächsten Schritt und die Konfiguration wird automatisch wirksam.
Einstellung des Inhalts und Anpassung des Stils
- Einstellung des Themas: Geben Sie im Eingabefeld "Artikel-Thema" das Ziel der Erstellung an, z. B. "Wissenschaftliche Pressemitteilung".
- Schlüsselwörter hinzufügen: Geben Sie relevante Wörter in das Feld "Schlüsselwörter" ein, z. B. "Künstliche Intelligenz, Technologietrends", getrennt durch Kommata.
- Zielwortzahl: Geben Sie die gewünschte Anzahl von Wörtern ein, z. B. 500.
- Stil-Editor::
- Klicken Sie auf die Schaltfläche "Style Editor", um die detaillierten Einstellungen vorzunehmen.
- StilBeschreibung: Geben Sie eine allgemeine Beschreibung ein, z. B. "prägnant und klar".
- SpracheWahl der Satzarten (es überwiegen kurze Sätze) oder der Rhetorik (z. B. Metaphern).
- RahmenwerkLänge der Absätze (3-5 Sätze pro Absatz) und Übergänge (natürliche Übergänge) festlegen.
- bewegen (gefühlsmäßig): Passen Sie den Ton an (z. B. positiver Optimismus).
- Speichern Sie und kehren Sie zum Hauptbildschirm zurück.
Inhalte generieren und bearbeiten
- Inhalte generierenKlicken Sie auf die Schaltfläche "Inhalt generieren", warten Sie ein paar Sekunden und der rechte Editor zeigt das Ergebnis an.
- Änderung in EchtzeitAnpassung des Textes direkt im Editor, z. B. durch Entfernen überflüssiger Sätze oder Hinzufügen von Details.
- Dateien exportierenKlicken Sie auf die Schaltfläche "Exportieren als Markdown", wählen Sie den Speicherpfad, und die Datei wird gespeichert als
.md
Format Download.
Fehlersuche und Optimierung
- Ansicht LogWenn die Generierung fehlschlägt, klicken Sie auf "Debug Info", um die API-Antwortdetails anzuzeigen und auf Schlüssel- oder Netzwerkprobleme zu prüfen.
- Verwendung von ProxysWenn ein CORS-Fehler auftritt, kreuzen Sie in den API-Einstellungen "Proxy-Server verwenden" an, um das Problem über den integrierten Proxy zu lösen.
Ausgewählte Funktionen
- Multimodell-Umschaltung::
Benutzer können jederzeit das Modell wechseln, z. B. von OpenAI GPT-4 zu Grok, um den Generierungseffekt der verschiedenen Modelle zu vergleichen. Schritte: API-Einstellungen eingeben, neues Modell auswählen, entsprechenden Schlüssel eingeben, speichern und neu generieren. - Eingehende Anpassung der Stile::
Der Stil-Editor ist das zentrale Highlight. So wird beispielsweise die Erzählperspektive auf "erste Person", der emotionale Tonfall auf "humorvoll und unbeschwert" und das Tempo auf "kurze, rasante Sätze" festgelegt, und der generierte Inhalt hält sich streng an diese Vorgaben. - Grok API-Tests::
Bei Verwendung von Grok Modelle, zugänglichhttp://localhost:3000/grok
Pfad, testen Sie den Verbindungsstatus und sehen Sie sich detaillierte Antwortprotokolle an.
Empfehlungen für die Verwendung
- ErsteinsatzWir empfehlen, zunächst das Modell GPT-3.5-Turbo von OpenAI auszuprobieren, das einfach zu konfigurieren und reaktionsschnell ist.
- Speichern Sie den SchlüsselUm doppelte Einträge zu vermeiden, wird empfohlen, den API-Schlüssel an einem sicheren Ort zu speichern.
- Beteiligung der GemeinschaftWenn die Funktionalität nicht perfekt ist, können Sie einen Pull Request auf GitHub einreichen, um Code oder Vorschläge beizusteuern.
Mit diesen Schritten können die Nutzer die leistungsstarken Funktionen des KI-Schreibassistenten in vollem Umfang nutzen, sei es zur schnellen Erstellung von Entwürfen oder zur tiefgreifenden Anpassung von Inhalten, was die Effizienz beim Schreiben erheblich steigern kann.