gpt var

Ридме для GPTVAR

Обзор

GPTVAR облегчает общение с API OpenAI, позволяя бесшовной отправке подсказок и получения ответов. Он может быть адаптирован для других моделей, упрощая создание значений для переменных с использованием GPT-сгенерированного контента.

Предварительные условия

• Node.js
• Ключ API OpenAI

Установка

Установите GPTVAR с помощью NPM:

npm install gpt-var

Быстрый старт

Используйте GPTVAR в нескольких простых шагах:

1. Импортировать класс

   Начните с импорта GPTVAR в ваш файл TypeScript:

    import GPTVAR from 'gpt-var' ;

2. Создать экземпляр

   Инициализируйте GPTVAR с помощью вашего ключа API OpenAI и, необязательно, вашей предпочтительной модели. Чтобы получить список моделей, посетите обзор моделей Openai.

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

3. Отправить подсказку

   Позвоните prompt с вашим сообщением и желаемым форматом. Форматы могут быть «любого», «массив», «объект» или «объект».

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

4. Обрабатывать ответы

   prompt возвращает обещание с ответом модели GPT, которое вы можете обрабатывать по мере необходимости.

Метод

prompt(message: string, format: string)

Этот метод отправляет сообщение в модель GPT, ожидая ответа в указанном формате.

• messages : входная строка для модели GPT.
• format : ожидаемый формат ответа. Параметры:
  • any : возвращает необработанную строку, подходящую для гибких или неопределенных форматов.
  • object : ожидает объект JSON, идеально подходит для структурированных данных.
  • array : ожидает массив JSON, отлично подходит для списков или последовательностей.
  • objectInArray : ожидает множество объектов JSON, полезно для структурированных списков.

Пример использования:

1. Формат: any

   Возвращает ответ как необработанную строку, идеально подходящую для неструктурированных данных.

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

   Пример ответа:

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

2. Формат: object

   Ожидает ответа объекта JSON.

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

   Пример ответа:

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

3. Формат: array

   Ожидает ответа массива JSON.

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

   Пример ответа:

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

4. Формат: objectInArray

   Ожидает множество объектов JSON.

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

   Пример ответа:

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

Примечания

• Убедитесь, что ваш ключ API OpenAI действителен.
• Модель по умолчанию-«GPT-3.5-Turbo»; Другие модели могут быть указаны.
• Отрегулируйте формат ответа, чтобы удовлетворить ваши потребности.

Поддерживать

Для поддержки, проблем или запросов функций, пожалуйста, подайте проблему в нашем репозитории GitHub.