gpt var

Readme für gptvar

Überblick

GPTVAR erleichtert eine einfache Kommunikation mit der OpenAI -API und ermöglicht das nahtlose Versenden von Eingabeaufforderungen und das Empfangen von Antworten. Es kann für andere Modelle angepasst werden, wodurch die Erstellung von Werten für Variablen mithilfe von GPT-generierten Inhalten vereinfacht wird.

Voraussetzungen

• Node.js
• Eine OpenAI -API -Schlüssel

Installation

Installieren Sie GPTVAR mit NPM:

npm install gpt-var

Schneller Start

Verwenden Sie GPTVAR in wenigen einfachen Schritten:

1. Importieren Sie die Klasse

   Importieren Sie mit dem Importieren von GPTVAR in Ihre TypeScript -Datei:

    import GPTVAR from 'gpt-var' ;

2. Erstellen Sie eine Instanz

   Initialisieren Sie GPTVAR mit Ihrem OpenAI -API -Schlüssel und optional Ihr bevorzugtes Modell. Eine Liste von Modellen finden Sie unter OpenAI -Modelsübersicht.

    const gptVar = new GPTVAR ( 'your-openai-api-key' , 'model-name' ) ;

3. Senden Sie eine Eingabeaufforderung

   Rufen Sie prompt mit Ihrer Nachricht und dem gewünschten Format an. Formate können "jedes", "Array", "Objekt" oder "ObjectInArray" sein.

    gptVar . prompt ( 'Your prompt here' , 'any' ) . then ( response => {
     console . log ( response ) ;
   } ) . catch ( error => {
     console . error ( error ) ;
   } ) ;

4. Antworten umgehen

   prompt gibt ein Versprechen mit der Antwort des GPT -Modells zurück, die Sie dann nach Bedarf verarbeiten können.

Verfahren

prompt(message: string, format: string)

Diese Methode sendet eine Nachricht an das GPT -Modell und erwartet eine Antwort im angegebenen Format.

• messages : Die Eingabezeichenfolge für das GPT -Modell.
• format : Das erwartete Antwortformat. Optionen:
  • any : Gibt eine rohe Schnur zurück, die für flexible oder nicht näher bezeichnete Formate geeignet ist.
  • object : Erwartet ein JSON -Objekt, ideal für strukturierte Daten.
  • array : Erwartet ein JSON -Array, das für Listen oder Sequenzen ideal ist.
  • objectInArray : Erwartet eine Reihe von JSON -Objekten, die für strukturierte Listen nützlich sind.

Beispiel Verwendung:

1. Format: any

   Gibt die Antwort als rohe Zeichenfolge zurück, ideal für unstrukturierte Daten.

    gptVar . prompt ( 'Tell me a joke' , 'any' ) . then ( response => {
     console . log ( 'Response:' , response ) ;
   } ) ;

   Beispielantwort:

    "Why don't scientists trust atoms? Because they make up everything!"
   

2. Format: object

   Erwartet eine JSON -Objektantwort.

    gptVar . prompt ( 'Provide details about the Eiffel Tower' , 'object' ) . then ( response => {
     console . log ( 'Response:' , response ) ;
   } ) ;

   Beispielantwort:

   {
     "name" : " Eiffel Tower " ,
     "location" : " Paris, France " ,
     "height" : " 300 meters "
   }

3. Format: array

   Erwartet eine JSON -Array -Antwort.

    gptVar . prompt ( 'List three famous scientists' , 'array' ) . then ( response => {
     console . log ( 'Response:' , response ) ;
   } ) ;

   Beispielantwort:

   [ " Albert Einstein " , " Marie Curie " , " Isaac Newton " ]

4. Format: objectInArray

   Erwartet eine Reihe von JSON -Objekten.

    gptVar . prompt ( 'List major cities with their countries and populations' , 'objectInArray' ) . then ( response => {
      console . log ( 'Response:' , response ) ;
    } ) ;

   Beispielantwort:

    [
      {
        "city" : " New York City " ,
        "country" : " USA " ,
        "population" : " 8.4 million "
      },
      {
        "city" : " Tokyo " ,
        "country" : " Japan " ,
        "population" : " 9.3 million "
      },
      {
        "city" : " London " ,
        "country" : " UK " ,
        "population" : " 8.9 million "
      }
    ]

Notizen

• Stellen Sie sicher, dass Ihr OpenAI -API -Schlüssel gültig ist.
• Standardmodell ist 'GPT-3.5-Turbo'; Andere Modelle können angegeben werden.
• Passen Sie das Antwortformat an, um Ihre Bedürfnisse zu erfüllen.

Unterstützung

Für Unterstützung, Probleme oder Feature -Anfragen stellen Sie bitte ein Problem in unserem GitHub -Repository ein.