【Next.js】Assistants APIの基本的なコードまとめ。

2023/11/21

Open AIの「Assistants API」をNext.jsで使用する時の基本的なコードをまとめました。

Open AIのAPIセットアップ
基本の使い方
追加機能

Open AIのAPIセットアップ

const openai = new OpenAI({apiKey: YOUR_OPENAI_API_KEY});

基本の使い方

Threads: スレッドを作る

// スレッドを作成する ================
const emptyThread = await openai.beta.threads.create();

console.log(emptyThread.id);
// thread_abc123

https://platform.openai.com/docs/api-reference/threads/createThread

Assistants: アシスタントを作る

// アシスタントのロール設定・指示文を作成する ================
const INSTRUCTIONS = "あなたは数学の家庭教師です。質問をされたら、質問に答えてください。";

// アシスタントを作成する ================
const myAssistant = await openai.beta.assistants.create({
    model: "gpt-4-1106-preview", // アシスタントのモデル
    instructions: INSTRUCTIONS,  // アシスタントへの指示文
    tools: [],                   // アシスタントが使うツール （retrieval,code_interpreter,function）
});

console.log(myAssistant.id);
// asst_abc123

https://platform.openai.com/docs/api-reference/assistants/createAssistant

Messages: 送るメッセージを設定する

const THREAD_ID = "thread_abc123";
const MESSAGE_CONTENT = "方程式 `3x + 11 = 14` を解きたい。助けてくれますか？";

// スレッドにメッセージを追加する ================
const threadMessages = await openai.beta.threads.messages.create(
    THREAD_ID,                                 // スレッドを指定
    { role: "user", content: MESSAGE_CONTENT } // メッセージ内容
);

https://platform.openai.com/docs/api-reference/messages/createMessage

Runs: アシスタントによるメッセージ応答を生成する

const THREAD_ID = "thread_abc123";
const ASSISTANT_ID = "asst_abc123";

// スレッドでアシスタントの回答を生成する ================
const run = await openai.beta.threads.runs.create(
    THREAD_ID,                                 // スレッドを指定
    { assistant_id: ASSISTANT_ID }             // アシスタントを指定
);

console.log(run.id);
// run_abc123

https://platform.openai.com/docs/api-reference/runs/createRun

Runs & Messages: 生成されたメッセージを取得する

const THREAD_ID = "thread_abc123";
const RUN_ID = "run_abc123";

// Runのステータス確認 ================
async function waitOnRun(run_id: string, thread_id: string): Promise<any> {
    const startTime = Date.now();
    while (run.status === "queued" || run.status === "in_progress") {
        if (Date.now() - startTime > 300000) {          // タイムアウトの設定
            throw new Error("Timeout exceeded");
        }

        run = await client.beta.threads.runs.retrieve({
            thread_id: thread_id,
            run_id: run_id
        });
        await new Promise(resolve => setTimeout(resolve, 500));
    }
    return run;
};

waitOnRun(RUN_ID, THREAD_ID)


// アシスタントの生成したメッセージを取得する ================
const threadMessages = await openai.beta.threads.messages.list(THREAD_ID); // スレッドのメッセージを取得
const newMessage = threadMessages.data[0].content.text.value;              // 最新のメッセージ

追加機能

各機能は、アシスタント作成時に設定します。

1) Data Retrieval: アシスタントがファイルを参照して回答する

// ファイルをアップロードする ================
const file = await openai.files.create({
    file: fs.createReadStream(YOUR_FILE),
    purpose: "assistants",
});

// ファイルを参照するよう設定する ================
const assistant = await openai.beta.assistants.create({
    instructions: "あなたはカスタマーサポートのチャットボットです。ナレッジベースを活用して、顧客からの問い合わせに最適な対応をしましょう。",
    model: "gpt-4-1106-preview",
    tools: [{"type": "retrieval"}],
    file_ids: [file.id]
});

最大ファイルサイズ: 「512MB/1ファイル」（※参考1）
Assistant: 「最大20ファイル,または最大合計100GB」（※参考1、※参考2）
Message: 「最大10ファイル」（※参考1）

2) Code Interpreter: アシスタントがコードを生成&実行する

// コードを生成&実行するよう設定する ================
const assistant = await openai.beta.assistants.create({
    instructions: "あなたは数学の家庭教師です。数学の質問をされたら、その質問に答えるコードを書いて実行します。",
    model: "gpt-4-1106-preview",
    tools: [{"type": "code_interpreter"}]
});

3) Function Calling: アシスタントが自作の関数を実行する

// 使用する関数を指定する ================
const assistant = await openai.beta.assistants.create({
    instructions: "あなたは天気ボットです。提供された機能を使って質問に答えてください。",
    model: "gpt-4-1106-preview",            // 使用するモデルの指定: gpt-4-1106-preview
    tools: [{
        "type": "function",                 // ツールのタイプ: function
        "function": {
            "name": "getCurrentWeather",    // 関数名
            "description": "場所の天気を取得", // 関数の説明
            "parameters": {                 // 関数のパラメータ
                "type": "object",           // 関数のパラメータ: タイプ
                "properties": {             // 関数のパラメータ: 一覧
                    "location": {"type": "string", "description": "都市と州 例：サンフランシスコ、CA"}, // パラメータ1
                    "unit": {"type": "string", "enum": ["c", "f"]}                                 // パラメータ2
                },
                "required": ["location"]    // 必須パラメータ
            }
        }
    }, {
        "type": "function",                 // ツールのタイプ: function
        "function": {
            "name": "getNickname",          // 関数名
            "description": "都市の愛称を取得", // 関数の説明
            "parameters": {                 // 関数のパラメータ
                "type": "object",           // 関数のパラメータ: タイプ
                "properties": {             // 関数のパラメータ: 一覧
                    "location": {"type": "string", "description": "都市と州 例：サンフランシスコ、CA"}  // パラメータ1
                },
                "required": ["location"]    // 必須パラメータ
            }
        }
    }]
});

AI Next.js

OpenAI