More than 1 year has passed since last update.

ChatGPT x Slackbotで議事録Bot作ってみた

Last updated at 2023-04-21Posted at 2023-04-12

Slackbotを使用してslackのスレッド内で書き連ねたネタを回収し、ChatGPT APIを使用し良い具合に議論した内容をまとめてくれる議事録Botを作ってみました。

Bot作成の背景

昨今爆速で普及しまくりのChatGPTに個人的に追いつけてないと危機感を抱いていたのと最近社内・社外でMTGをしながらSlackにメモを取る習慣がついてきており、メモを一手にまとめてくれる人いないかなーと思っていたところ、せや！チャットGPTに任せたろ！の精神で今回実装に至りました。

概要

アーキテクチャとしてはかなりシンプルな作りとなってます。

Slackであらかじめメンション（@Slackbot名）をトリガーにエンドポイントへPOSTを投げるbotを用意し、AWS Lambda経由でSlackAPI, ChatGPT APIと連携しSlackのスレッド内のメッセージを回収・分析し、最後にSlackに向けて議事録っぽいメッセージをプッシュする流れになってます。

事前準備

以下のアカウントが必要です

Slackアカウント
AWS アカウント
Open AI アカウント、ChatGPT API

また、今回のbotを作成する場合、以下のAPIで課金要素が発生します。

AWS (Lambda, API Gateway)
ChatGPT API

Open AI で支払い方法登録＆ ChatGPT API keyの取得

ChatGPT API を使用する場合課金が発生するため、先に支払い方法の登録を行う必要があります。

API key自体の取得は支払い方法登録せずとも取得できますが、支払い登録が済んで無い場合API呼び出しの際に429エラーを受け取り使用できなくなってます。

支払い方法登録

Open AIのアカウントを作成
ログイン後、画面右上のアカウントアイコンをクリック
Manage accountを選択
画面左ナビゲーションペーンからBilling → Overviewを選択
Set up paid accountを選択
モーダルが出現するので、個人プロジェクトであればI’m an individualを選択
支払い情報入力用のモーダルに切り替わるので入力後、Set up payment methodを選択

これで支払い登録完了です。

ChatGPT API keyの取得

同じく画面左のナビゲーションペーンからAPI Keysを選択
+Create new secret keyを選択（初めてAPI keyを発行する場合はAPI key情報はなく、ボタンだけ表示されます。）
API keyが発行されモーダルに表示されるのでコピーしてメモ帳などに貼り付け。
（※モーダルが閉じてしまうと2度と開けなくなります。コピーを忘れた場合はkeyを削除し、新たに発行する必要があります。）

これでChatGPT APIのkeyが取得できました。

ChatGPT Slack BOT作成手順

大まかですが以下のような流れになります。

Slack内のslackbotがリクエストを送る先のLambdaとAPI Gatewayの作成
Slackbotの作成（Slackコンソール）
Slack API, ChatGPT APIを呼び出すLambdaの作成
１のLambdaと３のLambdaの繋ぎ込み

なんで４の作業がいるの？Lambda一つでできるでしょと思われそうですが、こちらはSlackの仕様上6秒以内にレスポンスがない場合はタイムアウトとなってしまうためその対策として応答用のLambda（手順１のLambda）とChatGPTにアクセスし結果をSlackへ通知するLambda（手順３のLambda）と2つ作成しております。

こちらの記事が参考になりました。

1. LambdaとAPI Gatewayの作成

Slackbotだけ先に作成するでもいいんですが、bot作成後にエンドポイント入力の必要があるため先にLambdaを作成します。

私はServerless Frameworkを使用し、API Gatewayとセットで作成しましたが、下記を参考にAWSから直接作成されても問題ないかと思います。

Serverlessを使用せずにマニュアルで作る場合の参考記事
https://qiita.com/miyuki_samitani/items/f01f1bd49334f97fe84c

Serverless Frameworkを使用する場合
参考記事：https://qiita.com/kousaku-maron/items/c591a1245bdd69c0dad3

今回はあくまでLambdaをデプロイするだけなので、記事内のProviderとFunctionsを設定すれば大丈夫です。
今回用意したServerless用のソースコードは下記の通りです。

Serverless.yml

// serverless.yml
service: slack-chatgpt
frameworkVersion: "3"

provider:
  name: aws
  runtime: nodejs18.x
  region: ap-northeast-1
  timeout: 30

plugins:
  - serverless-offline

functions:
  // Slackbotがリクエストを送るLambda
  slackinvoke:
    handler: slackInvoke.handler
    events:
      - httpApi: "*"

下記はSlackbotからアクセスを受けてレスポンスを返すLambdaです。
Post リクエストを受ける必要があるため、Expressを使用し、POSTリクエストを受けるとメッセージ "Hello from root!" を返すようにしています。

slackinvoke.js

const serverless = require("serverless-http");
const aws = require("aws-sdk");
const express = require("express");
const app = express();
const qs = require("querystring");

const lambda = new aws.Lambda({
  apiVersion: "2015-03-31",
  region: "ap-northeast-1",
});

app.post("/", async (req, res) => {
  const body = req.body;
  const urlCode = body.toString();
  const requestBody = qs.parse(urlCode);
  // slack botのメンション通知設定の際のVerification用
  if (JSON.parse(Object.keys(requestBody)[0]).type === "url_verification") {
    const parsedBody = JSON.parse(Object.keys(requestBody)[0]);
    return res.status(200).json({
      value: parsedBody.challenge,
    });
  }
  return res.status(200).json({
    message: "Hello from root!",
  });
});

module.exports.handler = serverless(app);

作成後はこんな感じでLambdaとAPI Gatewayが出来ているかと思います。

2. slackbotの作成

Labmdaを作成し、API Gatewayからエンドポイントを取得できたら次はSlackbotの作成です。

こちらの記事を参考にし、Slack管理画面からSlackbotを作成しました。

スラッシュやイベントなどSlackbotを呼び出すトリガーは色々あったんですがスレッド内で呼べるものが欲しかったのでメンションイベントによる発火を選択しました。

数点気をつける点があるので記載。

1. Slackメンション発火用のVerification用にLambda関数の改修

メンション発火(@[Slackbot名])の場合、Slack管理画面でイベントを選択した時点でverificationが行われるため、Lambda側で事前にSlackのVerificationを受け取りレスポンスを返すよう設定する必要があります。

エンドポイント入力後に自動で下記のようなPayloadを持ったPOSTリクエストが送信されます。
応答ができれば上の画像のようにVerifiedとなりメンショントリガーでのSlackbot起動が登録できます。

Slackから送信されるPostリクエストのPayload

// slack chat bot verification request body
{
    "token": "Jhj5dZrVaK7ZwHHjRyZWjbDl",
    "challenge": "3eZbrw1aBm2rZgRNFdxV2595E9CY3gmdALWMmHkvFXO7tYXAYM8P",
    "type": "url_verification"
}

上でお見せしたslackInvoke.jsの下記の部分がVerificationの対応コードになります。

// slackInvoke.js
...
  // slack botのメンション通知設定の際のVerification用
  if (JSON.parse(Object.keys(requestBody)[0]).type === "url_verification") {
    const parsedBody = JSON.parse(Object.keys(requestBody)[0]);
    return res.status(200).json({
      value: parsedBody.challenge,
    });
  }
...

2. Bot Token Scopesの設定

今回、Slackbotを使用しスレッド内の会話を読み取りChatGPTで議事録を作るため、スレッド内の会話を読み取るための権限設定がSlack側で必要になります。

Slack api ページからYour appsを選択
作成したアプリの選択
左側のナビゲーションペーンからOAuth & Permissionsを選択
スクロールダウンするとScopesという項目が見えるのでそこで設定します

こちらはStep3の際に必要になります。

下記今回の実装で使用したScopeを記載してます。

必要なScopes

app_mentioned:read
channels:history
channels:read
chat:write
groups:history
im:history
mpim:history

3. Slack API, ChatGPT APIを呼び出すLambdaの作成

色々と事前準備が多かったですが、いよいよコアの実装です。

とは言っても殆どAPI頼りで実際のところは１ファイルだけで事足ります。

const serverless = require("serverless-http");
const { WebClient, LogLevel } = require("@slack/web-api");
const { Configuration, OpenAIApi } = require("openai");
// local test用
require("dotenv").config();

// ChatGPT APIインスタンス用Config
const configuration = new Configuration({
  apiKey: process.env.OPEN_AI_KEY,
});

// ChatGPT APIインスタンス
const openai = new OpenAIApi(configuration);

// SlackAPIインスタンス
const client = new WebClient(process.env.SLACK_TOKEN, {
  logLevel: LogLevel.DEBUG,
});

// slack apiを使用し特定のスレッドから会話を取得
const getAllMessagesInThread = async (slackEvent) => {
  const messages = await client.conversations.replies({
    channel: slackEvent.channel,
    ts: slackEvent.thread_ts,
  });

  // 会話をChatGPTが読みやすいように加工
  const conversations = messages.messages.reduce((acc, cur) => {
    return (acc += JSON.stringify({ user: cur.user, message: cur.text }));
  }, "");

  return conversations;
};

// ChatGPTへの質問関数
const askChatGPT = async (question, model = "gpt-3.5-turbo-0301") => {
  // 質問前の前提条件
  const prerequisite = `You're the minutes taker who summarize conversations happened while meeting.
  I'll give you conversations note, so I'd like you to create meeting minutes based on that conversation with rules.`;

  // 議事録作成のためのルール
  const rules = `These are the rules.
    - Meeting minutes must summarize with bullet point. You can ignore attendees and date in the meeting minutes.
    - Please write meeting minutes based on the language that uses the most in the conversation, but also prepare English translate version for foreigner too.
    - Please do not concise too much, we don't want to miss conversation itself because of summarize too much.
    - When you write Japanese meeting minutes, please do not use 丁寧語 like 〜しました at the end of each bullet point.
    - Please not include the message that only mention using @.
    `;

  // 質問実行関数
  const response = await openai.createChatCompletion({
    model: model,
    messages: [
      { role: "system", content: prerequisite },
      { role: "assistant", content: rules },
      { role: "user", content: question },
    ],
  });

  // 回答の抽出
  const answer = response.data.choices[0].message?.content;
  return answer;
};

// Lambda実行関数
async function publishMessage(event) {
  try {
    const parsedEvent = JSON.parse(Object.keys(event.apiGateway.event)[0]);
    const slackEvent = parsedEvent.event;

    const conversations = await getAllMessagesInThread(slackEvent);

    // ChatGPTへの命令文
    const question = `please make a meeting minutes based on below conversations.
    ${conversations}`;

    const answer = await askChatGPT(question);

    // slackメッセージプッシュ関数
    const result = await client.chat.postMessage({
      // The token you used to initialize your app
      token: process.env.SLACK_TOKEN,
      channel: process.env.CHANNEL_ID,
      text: answer,
      thread_ts: slackEvent.thread_ts,
    });
  } catch (error) {
    console.error(error);
  }
}

module.exports.handler = serverless(publishMessage);

大きく3つの関数に分かれています。

getAllMessagesInThread

Slack apiを介してチャネル内の特定のスレッドの会話を取得する関数です。
レスポンスタイプがオブジェクト配列でメッセージ以外の要素も含んでいるため、ChatGPTが読みやすいように微妙に加工してます。

// slack apiを使用し特定のスレッドから会話を取得
const getAllMessagesInThread = async (slackEvent) => {
  const messages = await client.conversations.replies({
    channel: slackEvent.channel,
    ts: slackEvent.thread_ts,
  });

  // 会話をChatGPTが読みやすいように加工
  const conversations = messages.messages.reduce((acc, cur) => {
    return (acc += JSON.stringify({ user: cur.user, message: cur.text }));
  }, "");

  return conversations;
};

askChatGPT

ChatGPTへ質問を投げかける関数です。参考記事をもとに作成してます。

今回、贅沢に日本語版だけでなく英語版も作ってくれと依頼してます。（どうなるかは不明）

以下議事録作成のためのルール

議事録を書いてください、出席者は無視してOK。
会話内で一番使われている言語をもとに議事録を書いてください、ただし、外国籍の方用に英語版も作ってください。
出来るだけ会話を逃したくないので、あまりまとめ過ぎないで下さい
日本語で議事録を書くときは〜しましたなどの丁寧語は省いてください。
＠を用いたメンションは議事録に含めないで下さい。

どういう結果が得られるか分からないのでめっちゃお願いしてます。

// ChatGPTへの質問関数
const askChatGPT = async (question, model = "gpt-3.5-turbo-0301") => {
  // 質問前の前提条件
  const prerequisite = `You're the minutes taker who summarize conversations happened while meeting.
  I'll give you conversations note, so I'd like you to create meeting minutes based on that conversation with rules.`;

  // 議事録作成のためのルール
  const rules = `These are the rules.
    - Meeting minutes must summarize with bullet point. You can ignore attendees and date in the meeting minutes.
    - Please write meeting minutes based on the language that uses the most in the conversation, but also prepare English translate version for foreigner too.
    - Please do not concise too much, we don't want to miss conversation itself because of summarize too much.
    - When you write Japanese meeting minutes, please do not use 丁寧語 like 〜しました at the end of each bullet point.
    - Please not include the message that only mention using @.
    `;

  // 質問実行関数
  const response = await openai.createChatCompletion({
    model: model,
    messages: [
      { role: "system", content: prerequisite },
      { role: "assistant", content: rules },
      { role: "user", content: question },
    ],
  });

  // 回答の抽出
  const answer = response.data.choices[0].message?.content;
  return answer;
};

publishMessage

Lambda上での実行関数です。

上記2つの関数を内部で呼び出し、結果をSlackへ通知する関数になります。

// Lambda実行関数
async function publishMessage(event) {
  try {
    const parsedEvent = JSON.parse(Object.keys(event.apiGateway.event)[0]);
    const slackEvent = parsedEvent.event;

    const conversations = await getAllMessagesInThread(slackEvent);

    // ChatGPTへの命令文
    const question = `please make a meeting minutes based on below conversations.
    ${conversations}`;

    const answer = await askChatGPT(question);

    // slackメッセージプッシュ関数
    const result = await client.chat.postMessage({
      // The token you used to initialize your app
      token: process.env.SLACK_TOKEN,
      channel: process.env.CHANNEL_ID,
      text: answer,
      thread_ts: slackEvent.thread_ts,
    });
  } catch (error) {
    console.error(error);
  }
}

後はServerless frameworkを使用しAWSへデプロイすればLambda反映完了です！

serverless deploy

ではでは・・・お待ちかねのテスト、の前にもう一つ作業があります。

実装の前にAWS側でAPI 呼び出し用のLambdaと１で作成したSlackレスポンス用のLambdaを繋ぎこむ作業が必要です。

lambdaの繋ぎ込み作業

AWS Lambdaからレスポンス用Lambdaを選択
関数の概要から送信先を追加を選択

ソース：非同期呼び出し
条件：正常
送信先タイプ：Lambda 関数

を選択し、先ほどデプロイしたAPI 呼び出し用の関数を選択

保存を押し、下記のように設定されていれば繋ぎ込み完了です！

後は初めに作成したLambda(slackInvoke.js)に繋ぎ込み用の関数を挿入します。

const invokeLambda = async (event) => {
  try {
    const params = {
      FunctionName: "slack-chatgpt-dev-slackchat",
      InvocationType: "Event",
      Payload: JSON.stringify({ ...event }),
    };
    await lambda.invoke(params).promise();
    return { statusCode: 200, body: "OK" };
  } catch (e) {
    console.log("error", e);
  }
};

挿入後は以下のようになります。

slackInvoke.js

const serverless = require("serverless-http");
const aws = require("aws-sdk");
const express = require("express");
const app = express();
const qs = require("querystring");

const lambda = new aws.Lambda({
  apiVersion: "2015-03-31",
  region: "ap-northeast-1",
});

const invokeLambda = async (event) => {
  try {
    const params = {
      FunctionName: "slack-chatgpt-dev-slackchat",
      InvocationType: "Event",
      Payload: JSON.stringify({ ...event }),
    };
    await lambda.invoke(params).promise();
    return { statusCode: 200, body: "OK" };
  } catch (e) {
    console.log("error", e);
  }
};

app.post("/", async (req, res) => {
  const body = req.body;
  const urlCode = body.toString();
  const requestBody = qs.parse(urlCode);
  if (JSON.parse(Object.keys(requestBody)[0]).type === "url_verification") {
    const parsedBody = JSON.parse(Object.keys(requestBody)[0]);
    return res.status(200).json({
      value: parsedBody.challenge,
    });
  }
  await invokeLambda(requestBody);
  return res.status(200).json({
    message: "Hello from root!",
  });
});

module.exports.handler = serverless(app);