GPTypisiert

Willkommen bei GPTyped! ? Ein kleines, aber leistungsstarkes NPM-Paket, mit dem Sie typsicher mit dem GPT-Sprachmodell von OpenAI interagieren können. Mit GPTyped können Sie im Handumdrehen Objekte als Eingabeaufforderungen senden und strukturierte Antworten von LLM-KIs erhalten, unabhängig davon, ob Sie es im Web oder auf dem Server ausführen.

Merkmale

Sendet TypeScript-Objekte als Eingabeaufforderungen und empfängt TypeScript-Objekte als Antworten.
? Vollständig anpassbar mit Interceptoren, um Anfragen oder Antworten jederzeit zu ändern.
? Im Lieferumfang ist ein OpenAI-Client zur einfachen Integration mit GPT vorinstalliert.
Validiert zurückgegebene Objektschemata mithilfe von Zod.
Unterstützung für gängige Eingabeaufforderungsmuster wie Speicher und Metaeingabeaufforderungen.

Installation

Sie können GPTyped mit NPM oder Yarn installieren:

 npm install gptyped zod

oder

 Garn gptyped zod hinzufügen

Bereit zum Start? Sehen Sie sich hier die vollständigen Dokumente an?

Grundlegende Verwendung

Die Verwendung von GPTyped ist einfach. Hier ist ein Beispiel dafür, wie Sie Objekte als Eingabeaufforderungen senden und typsichere Objektantworten erhalten können:

 import { OpenAiClientBuilder, PrompterForObjectBuilder } from „gptyped“import { z } from „zod“// Ein Zod-Schema, das den Typ der KI-Antwort beschreibtexport const TweetSchema = z.object({
  Tweet: z.string().min(1),
  Tags: z.array(z.string()).min(3),})type Tweet = z.inferconst gpTypedOpenAiClient = new OpenAiClientBuilder("YOUR_OPEN_AI_SECRET_KEY").build()const prompterForObject = new PrompterForObjectBuilder( gpTypedOpenAiClient, TweetSchema, {
  tweet: „Ein Tweet zum Thema. Maximal 140 Zeichen.“,
  Tags: „3 Hashtags zum Tweet.“,}).build()// Verwenden Sie ein Eingabeobjekt, um eine Anfrage an die OpenAI-API zu stellen. Die Antwort wird vom Typ „safe.const result = waiting prompterForObject.send({“ sein.
  Thema: „Warum ist der Frühling die beste Jahreszeit?“,})// Greifen Sie auf den Tweet-Typ-Safe zu. Antwortconsole.log(result.tweet) // „Der Frühling ist wegen der Blumen und der Natur die beste Jahreszeit.“console.log(result .tags) // ["#Frühling", "#Blumen", "#Natur"]

Hinweis: Über strukturierte Antworten und generative KI

Die Antworten von LLM sind nicht deterministisch. Dies bedeutet, dass genau dieselbe Eingabeaufforderung zu unterschiedlichen Reaktionen der KI führen kann. Vor diesem Hintergrund kann nicht garantiert werden, ob die Antwort eine gültige Datenstruktur ist oder nicht. GPTyped validiert die Antwort anhand des Schemas, das Sie mit Zod bereitgestellt haben, und gibt die Antwort zurück, wenn sie gültig ist. Wenn die Antwort ungültig ist, gibt GPTyped einen Fehler aus.

Es wird empfohlen, die Anfrage mindestens ein paar Mal zu wiederholen, wenn ein Typfehler auftritt, da nachfolgende Anfragen normalerweise eine gültige Antwort zurückgeben. Mit dem GPT von OpenAI können Sie auch versuchen, den Temperaturparameter der KI zu senken, um ihn vorhersehbarer zu machen.

Mitwirken

Beiträge sind willkommen! Fühlen Sie sich frei, Probleme zu öffnen oder Anfragen für Fehlerbehebungen, Funktionsanfragen oder Verbesserungen zu stellen. Bitte werfen Sie einen Blick auf einige geplante Verbesserungen, bei denen Sie einsteigen können:

Automatischer Wiederholungsversuch bei fehlgeschlagenen Anfragen
Clients für andere beliebte LLM-APIs
Unterstützung für Markdown-Anfragen/-Antworten
Unterstützung für CSV-Anfragen/-Antworten
Unterstützung für andere gängige Datenformate

Lizenz

GPTyped ist eine Open-Source-Software, die unter der MIT-Lizenz veröffentlicht wird. Fühlen Sie sich frei, es gemäß den Lizenzbedingungen zu verwenden, zu ändern und zu verbreiten.

Expandieren

Zusätzliche Informationen