私の所属している「どすこい塾」のSlackで、とある人が毎日21時にお風呂リマインドを設定していました。
ただ、毎日同じ文言で同じ時間にリマインドが来てしまうと、飽きが生じてしまいます。
そこでChatGPTのAPIを用いて、毎日違う文言でリマインドするように変更を行なったのでその備忘録です。
かかる費用について
ChatGPTのAPIを用いるので少しだけお金が発生します。連続実行にはご注意ください。
ChatGPTのモデルによりますが、GPT-3.5で毎日実行すれば、1Bot100円/月かからないくらいです。
間違えて何度も実行してしまわないように確実に1回しか通らないことをご確認ください。
設定で金額が超えたらAlertが出る設定もあると思うので、使用することをお勧めします。
そもそもGASとは
そもそもGASを知らない人もいるかと思うのでGASについて説明します。
GASはGoogle App Scriptの略称です。
簡単にいうと、GmailやGoogleスプレットシートやgoogle Slideと連携したりしてGoogle Workspaceを自動化および拡張できます。
詳細は以下にございますので興味ある方は以下をご覧ください。
https://developers.google.com/apps-script?hl=ja
今回作るもの
どすこい塾では「お風呂絶対くん」というBotを作成しました。
毎日9時~10時あたりにslack通知が飛んで、
毎回chatGPTを用いてお風呂の大切さを伝えるようになっています。
Bot作成手順
以下にbotの作成方法を書いたのでそれを参考に作ってみてください！
1. 専用のスプシファイルを作成
GASではスプシを擬似DBとして扱うことができます。
今回は使いませんが、今後加えたい時のためにも加えておきます。
スプシを何でもいいので作成してください。
2. そのスプシファイルに紐づくGASファイルを作成
スプシの拡張にある、App Scriptsに遷移してそこでGASファイルを変更できます。
3. GASファイルに以下のコードを記載する
「お風呂入ったか！」の後にスレッドでお風呂の大切さを返します。
const SLACK_BOT_TOKEN = 'xoxb-{TOKENを入れてください}';
const SLACK_CHANNEL_ID = '{チャンネルID}';
const CHATGPT_API_KEY = 'sk-{chatGPT Token}';
const NAME_MENSION = '@{メンバーID}'
function process() {
// Send email subject or first 50 characters of the body to Slack
const response = sendToSlack('<NAME_MENSION>\nお風呂入ったか!!!!!🚿🛀\n');
const promptMailToType =
`# 条件\n- 100文字程度で返答をお願いします。\n- 怒るようにお願いします\n- お風呂入ってない??を始めに入れる\n- 語尾は優しい人のように\n- お風呂に入らないデメリットを入れる`
// Generate a response using ChatGPT and post it to the same Slack thread
const chatGptResponse = generateResponseWithChatGPT('```' + promptMailToType + '```');
sendToSlack(chatGptResponse, response.ts);
}
function sendToSlack(text, threadTs) {
const payload = {
channel: SLACK_CHANNEL_ID,
text: text,
thread_ts: threadTs
};
const options = {
method: 'post',
contentType: 'application/json; charset=utf-8',
headers: { Authorization: `Bearer ${SLACK_BOT_TOKEN}` },
payload: JSON.stringify(payload)
};
const response = UrlFetchApp.fetch('https://slack.com/api/chat.postMessage', options);
return JSON.parse(response.getContentText());
}
function generateResponseWithChatGPT(prompt) {
const data = {
max_tokens: 150,
model: 'gpt-3.5-turbo-1106', // TODO ここでモデル変更してください！高い精度&速度出すならgpt4oかな
messages: [
{ role: 'user', content: prompt }
],
};
const options = {
method: 'post',
contentType: 'application/json',
headers: { Authorization: `Bearer ${CHATGPT_API_KEY}` },
payload: JSON.stringify(data)
};
const response = UrlFetchApp.fetch('https://api.openai.com/v1/chat/completions', options);
const jsonResponse = JSON.parse(response.getContentText());
Logger.log(response);
return jsonResponse.choices[0].message.content.trim();
}
4. 通知するslackチャンネルのIDを取得
通知するslackメンションIDを取得します。
取得方法はslackのチャンネルの詳細を開いて一番下までスクロールしたら出てくるのでそれをコピーして、コードのSLACK_CHANNEL_IDに指定してください。
5. メンションも必要であれば、メンションするメンバーのIDも取得
メンバーのプロフィール詳細に飛んで、そこからメンバーIDをコピーできます。
5. Slack App(bot)を作成する。
こちらのURLから登録してください。
https://api.slack.com/
URLに遷移すると以下のような画面に遷移すると思うので、「Your apps」をクリックします。
遷移するとこのような画面に出ると思うので、「Create New App」をクリックします。
この画面では、「From scratch」を選択します。
最後にアプリの名前とworkspaceを指定して「Create App」をクリックします。
これでBotを作成できます。
6. Bot(Slack App)に権限を付与する
「0Auth&Permission」に移動してください。そこで下にスクロールすると2枚目のようにScopesが表示されていると思います。
そこで必要になる権限をbotに付与してください。
メッセージを送るためにはchat:writeが必要ですし、チャンネルの情報を読み取って欲しい場合はchannels:readが必要で、メンバーへのメンションが必要なら、app_mentions:readが必要です。
詳しくは調べてみてください。
7. Bot(Slack App)の基本情報を設定する
これ忘れがちなんですが、基本情報を設定しないとワークスペースにインストールできないです。
Botの表示名と名前を入力してください。
他の写真などの諸々の設定は、「Basic Information」で設定できます。
8. ワークスペースにアプリをインストールする
権限を付与し、基本情報を入力した後で、disableになっていたアプリインストールが可能になります。
「Install to Workspace」を押して該当のチャンネルにインストールしてください。
9. slackBotのTokenを取得してコードに設定しておく
これでOAuth&Permissionsに移動すればBot User OAuth Tokenを取得できるのでコードのSLACK_BOT_TOKENに設定してください。
8. ChatGPTのAPIを使えるようにする
最後に上で挙げたGASコードにChatGPTのAPIKeyを設定する必要があります。
以下のURLにアクセスしてください。
※アカウントがない場合は作成してください。
右上のCreate New Secret Keyをクリックしてください。
悪用を防ぐために、Permissionは必要なもののみチェックするようにした方がいいかもしれません。
完了したら、API Keyをコピーして{CHATGPT_API_KEY}に貼り付けて完了です。
モデルは自分で値段と出したい精度と相談して決めてください。コード上で指定できます。
APIの料金はこちら
※たまに使えないことがあるのですが、数ドルチャージすればそこから使用できるようになると思います。
API Keyを守るために
※ここでは簡易的にこのようにしていますが、使われるとお金が発生してしまうKeyになるので、以下のように環境変数として定義しておくことをお勧めします。
// 以下で取得できます
function getKey() {
PropertiesService.getScriptProperties().getProperty("{KEY名}");
}
9. 動くかどうかを実行してテストする
まずは実行してみて出力されるか試してみてください。
slackに通知が来れば成功です。
10.実際にスケジューリングの設定をする
gasでは9時ちょうどに定期実行するというのが面倒です。
実行数を増やして、その中で今の時刻を取得する処理を書いて、該当の時刻だったら通知することなどはできますが、面倒なので今回はピッタシに通知するのはやりません。
GASでは1日の定期実行の時間を1時間の幅で選択することになっているので、9~10時で設定すれば、その間のどこかで通知がきます。
ただし、１度目で9時35分に通知されれば次回以降の定期実行も同じ9時35分に実行されます。
その後にスケジューリング設定をするためにAppsScriptでトリガーを開きます。
画像のように設定して保存すれば9時から10時のどこかで毎日通知されます。
まとめ
これでどすこい塾の人が1人救われました。
途中で切れてますがこれはプロンプト変えるなどして各自工夫してくださいw
APIの料金結構かかるので気をつけてください。
https://openai.com/api/pricing/
もっと応用
スプシをDBにして、前回の回答内容をもとに回答を得たりすることもできますので興味ある方はお試しください。