gpt var

Readme pour gptvar

Aperçu

GPTVAR facilite une communication facile avec l'API OpenAI, permettant l'envoi transparent des invites et la réception des réponses. Il peut être adapté pour d'autres modèles, simplifiant la création de valeurs pour les variables à l'aide du contenu généré par GPT.

Condition préalable

• Node.js
• Une clé API Openai

Installation

Installez GPTVAR à l'aide de NPM:

npm install gpt-var

Démarrage rapide

Utilisez GPTVAR en quelques étapes simples:

1. Importer la classe

   Commencez par importer GPTVAR dans votre fichier TypeScript:

    import GPTVAR from 'gpt-var' ;

2. Créer une instance

   Initialisez GPTVAR avec votre touche API OpenAI et, éventuellement, votre modèle préféré. Pour une liste de modèles, visitez les modèles OpenAI Aperçu.

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

3. Envoyer une invite

   Invite prompt appel avec votre message et le format souhaité. Les formats peuvent être «n'importe quel», «array», «objet» ou «objetInArray».

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

4. Gérer les réponses

   prompt renvoie une promesse avec la réponse du modèle GPT, que vous pouvez ensuite traiter au besoin.

Méthode

prompt(message: string, format: string)

Cette méthode envoie un message au modèle GPT, s'attendant à une réponse dans le format spécifié.

• messages : la chaîne d'entrée pour le modèle GPT.
• format : le format de réponse attendu. Options:
  • any : renvoie une chaîne brute, adaptée aux formats flexibles ou non spécifiés.
  • object : s'attend à un objet JSON, idéal pour les données structurées.
  • array : s'attend à un tableau JSON, idéal pour les listes ou les séquences.
  • objectInArray : s'attend à un tableau d'objets JSON, utile pour les listes structurées.

Exemple d'utilisation:

1. Format: any

   Renvoie la réponse en tant que chaîne brute, idéale pour les données non structurées.

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

   Exemple de réponse:

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

2. Format: object

   Attend une réponse d'objet JSON.

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

   Exemple de réponse:

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

3. Format: array

   Attend une réponse JSON Array.

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

   Exemple de réponse:

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

4. Format: objectInArray

   Attend un tableau d'objets JSON.

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

   Exemple de réponse:

    [
      {
        "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 "
      }
    ]

Notes

• Assurez-vous que votre clé API OpenAI est valide.
• Le modèle par défaut est «GPT-3.5-turbo»; D'autres modèles peuvent être spécifiés.
• Ajustez le format de réponse pour répondre à vos besoins.

Soutien

Pour le support, les problèmes ou les demandes de fonctionnalités, veuillez déposer un problème sur notre référentiel GitHub.