gpt var

gptvarのreadme

概要

GPTVAR 、OpenAI APIとの簡単な通信を促進し、プロンプトのシームレスな送信と回答の受信を可能にします。他のモデルに適合させることができ、GPT生成コンテンツを使用して変数の値の作成を簡素化できます。

前提条件

• node.js
• Openai APIキー

インストール

NPMを使用してGPTVARをインストールします。

npm install gpt-var

クイックスタート

いくつかの簡単な手順でGPTVAR利用してください：

1. クラスをインポートします

   GPTVAR TypeScriptファイルにインポートすることから始めます。

    import GPTVAR from 'gpt-var' ;

2. インスタンスを作成します

   OpenAI APIキーと、オプションでは、希望するモデルでGPTVAR初期化します。モデルのリストについては、OpenAIモデルの概要にアクセスしてください。

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

3. プロンプトを送信します

   メッセージと目的の形式でpromptを呼び出します。フォーマットは、「任意」、「配列」、「オブジェクト」、または「ObjectInArray」です。

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

メモ

• OpenAI APIキーが有効であることを確認してください。
• デフォルトモデルは「GPT-3.5-Turbo」です。他のモデルを指定できます。
• あなたのニーズを満たすために応答形式を調整します。

サポート

サポート、問題、または機能のリクエストについては、GitHubリポジトリに問題を提出してください。