More than 3 years have passed since last update.

やさしいチャットボットのつくりかた -4.Twitterからつぶやきをとってきてみよう！

Last updated at 2020-07-01Posted at 2020-07-01

#どういう記事？
Azure素人の自分がMicrosoft AzureのBot FrameworkとCognitive Serviceと触れ合いながら、難易度も人への接し方も**“やさしい”**チャットボットを作ってみた際の備忘録の第4部です。どんなチャットボットを作るのかを含め、これまでの手順は第1部、第2部、第3部にございます。
PowerPointで記録していたものをQiita化してみたものになるので、そんな感じの画像が頻出します。
Qiita初心者なので、書き方が下手でも広い心で許してほしいです。そして全体的にゆるいです。

アジェンダ

以下の5部構成になります。この記事は第4部にあたります。

なお、公式ドキュメントに沿って作りましたので、それらのリンクを張り付けつつ、辿った道筋通りに書いていきます。
その筋の方からすると遠回りだったり野暮ったかったりすると思いますが、ご容赦ください。

2. Twitterからつぶやきをとってきてみよう！

これまで、第1部で作ったチャットボットのソースコードを、第2部でAzure（クラウド）上へデプロイし、ユーザーから受け取ったコメントをAzure Cognitive ServiceのText Analyticsを使って、ネガティブorポジティブの判定をしてみました。今回は、図中の赤枠部分、Text Analyticsの判定結果がネガティブだった場合、Twitterで偉人さんのありがたいお言葉をつぶやく励ましBotさんのつぶやきをランダムに選択し、ユーザーに返してあげる部分を作っていこうと思います。

2.1 事前準備

Twitter Developer登録

Twitterの各種APIを使うためには、Developer登録が必要となります。審査に数日かかるようです。
こちらにDeveloper登録について、詳しく書かれているので参考にしてください。
手順中で、Access tokenとaccess token secretが生成されますので、忘れずにメモをしておいてください。後々使います。

CoreTweetインストール

C#からTwitterAPI を扱うためのライブラリである、CoreTweetのインストールをします。第3部のTextAnalyticsの設定でも実施したパッケージのインストールをします。検索ボックスでCoreTweetと検索して、インストールを実行します。

2.2 sentimentAnalysisExampleメソッドから分析スコアを返す

第3部で作成したソースコードを前提に、必要な変更を加えていきます。まずは、ユーザーのメッセージをText Analyticsリソースに投げて分析しているsentimentAnalysisExampleメソッドが、呼び出し元に分析結果のスコアを返すようにコードを変更します。

EchoBot.cs

static double sentimentAnalysisExample(ITextAnalyticsClient client, string message)//戻り値をvoidからdouble型に変更
{
     var result = client.Sentiment(message, "ja");//引数messageを分析対象にし、言語は日本語に設定
     Debug.WriteLine($"User Message: {message}");//引数messageの内容を出力
     Debug.WriteLine($"Sentiment Score1: {result.Score:0.00}");//出力確認1
     return (double)result.Score;//分析スコアを返す
}

呼び出し側でも戻り値を格納する変数を用意する必要がありますので、OnMessageActivityAsync内でsentimentAnalysisExampleの部分に以下の通り変更を加えます。Debug.WriteLineは値の受け渡しが正常にできているかの確認のための出力です。

EchoBot.cs

var score = sentimentAnalysisExample(client,turnContext.Activity.Text);//戻り値を格納するためscoreを用意Debug.WriteLine($"Sentiment Score2: {score:0.00}");//出力確認2

2.3 スコアを元に条件分岐をする

Text Analyticsでは0~1の間の値を返します。1に近いほどポジティブで、0に近いほどネガティブな判定という意味となります。
今回は、スコアが0.5以上の場合はポジティブとみなして塩対応し、0.5未満の場合はTwitterからありがたいお言葉をとってきたいと思いますので、OnMessageActivityAsync内で条件分岐をし、それぞれの場合でDebug.WriteLineで出力確認をしたいと思います。
今までのOnMessageActivityAsyncに対する変更をまとめると以下の通りとなります。

EchoBot.cs

protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
{
    var replyText = $"Echo: {turnContext.Activity.Text}";
    await turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken);

    //for TextAnalytics
    var client = authenticateClient();
    var score = sentimentAnalysisExample(client,turnContext.Activity.Text);//戻り値を格納するためscoreを用意
    Debug.WriteLine($"Sentiment Score2: {score:0.00}");//出力確認2

    if(0.5 <= score)
    {
        Debug.WriteLine($"塩対応");//出力確認3
    }
    else
    {
        Debug.WriteLine($"励まし対応");//出力確認4
    }
}

一度実行して試してみましょう。ボットに話しかけたメッセージと、そのスコア（2回）、スコアに応じた対応内容が出力されていればOKです。

2.4 励まし対応（Twitter連携）部分を作る

ちゃんとスコアを受け取り、条件分岐できていることが確認できたので、いよいよTwitterとの連携部分を作っていきます。事前準備でインストールしたCoreTweetを使うので、以下の通りソースコードの上の方（usingほげほげがあるところ）に追加します。

EchoBot.cs

using CoreTweet;

そしてpublic class EchoBotの中のsentimentAnalysisExampleと同じレベル（深さ）に、Twitterからツイートを取ってくるためのgetTweetメソッドを用意します。

EchoBot.cs

 static string getTweet(double score)
 {
     Random cRandom = new System.Random(); //取得したツイートからランダムに1つ選択するための乱数
     var tokens = Tokens.Create("<API KEY>", "<API SECRET>", "<ACCESS TOKEN>", "<ACCESS TOKEN SECRET>");  //接続用トークン発行
     var tweet = "";//取得したツイートを格納する変数

     var parm = new Dictionary<string, object>();  //条件指定用Dictionary
     parm["count"] = 60;  //取得するツイート数
     parm["screen_name"] = "hagemasi1_bot";  //取得したいユーザーID


     Task task = Task.Factory.StartNew(async () =>
     {
          var tweets = await tokens.Statuses.UserTimelineAsync(parm); //parmの内容に従ってツイートを取得

          var random = cRandom.Next(61); //0～60の間の乱数を生成
          tweet = tweets[random].Text; //取得した60ツイートからrandom番目のツイートを格納

     }).Unwrap();

     task.Wait();

     return tweet;　//選んだツイートを戻り値として返す
}

それぞれ簡単に説明していきます。

Random cRandom = new System.Random();
一括でとってきたツイートたちから、どれか1つを選択する際に使う乱数です。
var tokens = Tokens.Create()
Twitterに接続する際のトークンです。それぞれ以下の手順で確認して、正しいものを入れていきます。

Twitter Developerサイトにアクセスし、画面の右上で、自分のTwitterアカウントより、Appsを選択します。

該当アプリのDetailsボタンをクリックします。

Keys and tokensタブをクリックします。API keyとAPI secret keyが表示されます。Access tokenとaccess token secretについては、事前準備の[Twitter Developer登録](#Twitter Developer登録)でメモしておいたものを使います。もしメモし損ねてしまっていたら、Regenerateボタンで再作成してください。

var tweet = "";
取得してきたツイート群から、実際にユーザーに返すものを格納する変数です。
var parm = new Dictionary();
取得するツイートの条件を指定するためのDictionaryクラスです。今回は取得してくる全ツイート数（60ツイート）と、取得対象のTwitterアカウントのID（hagemasi1_bot）を指定しています。Dictionaryクラスの公式リファレンスはこちら
var tweets = await tokens.Statuses.UserTimelineAsync(parm);
直前のDictionaryクラスで指定した内容を引数にして、hagemasi1_botのツイートを60ツイート取得してきています。戻り値は取得したツイートたちです。CoreTweetの公式リファレンスはこちら
var random = cRandom.Next(61);
取得した60個のツイートから、何番目のツイートをユーザーに返すか、乱数で決めています。randomには0~60の値のいずれかが入ります。
tweet = tweets[random].Text;
取得した60個のツイートのうち、random番目のものを選んで、tweet変数に格納しています。これをユーザーに返します。
return tweet;
tweet変数を呼び出し元に返します。

Twitterからツイートを取得するメソッドができたので、OnMessageActivityAsync内の条件分岐で**Debug.WriteLine($"励まし対応")**としていた部分からgetTweetを呼び出して、結果を出力するようにします。

EchoBot.cs

if(0.5 <= score)
{
    Debug.WriteLine($"塩対応");//出力確認3
}
else
{
    var res = getTweet(score);
    Debug.WriteLine($"励まし対応:{res}");//出力確認4
}

ではここでまた、実行してみましょう。できるだけネガティブな発言をボットに投げかけてくださいね。

ネガティブ判定され、Twitterから偉人さんのありがたいお言葉を取得してくることができました！

2.5 塩対応部分を作る

TextAnalyticsの分析スコアが0.5以上だった場合の、塩対応用メソッドgetShioCommentを、OnMessageActivityAsync内、getTweetと同じレベル（深さ）に作っていきます。こちらは特に何かと連携はせずに、コード内に書いたいくつかの塩対応フレーズからランダムに選んで返すだけのものにします。励まし対応の部分と被る要素が多いので、説明は割愛します。

EchoBot.cs

static string getShioComment()
{
   Random cRandom = new System.Random(); //乱数
   string res = "";
   var shio = new string[] { "へー・・・。", "・・・だから？", "知らんわー。", "興味ないね。", "いや、聞いてないし。", "ふーん・・・。で？", "そういうのいいから。", "あーちょっと今忙しいからまた今度。", "・・・けっ！", "リア充乙。" };

   var random = cRandom.Next(11);
   res = shio[random];
   return res;
}

呼び出し側も以下の通り変更します。条件分岐の塩対応部分でgetShioCommentメソッドを呼び出し、結果を出力することと、条件分岐外でres変数を定義し、塩対応、励まし対応それぞれの戻り値をres変数に格納する形にしました。

EchoBot.cs

var client = authenticateClient();
var score = sentimentAnalysisExample(client,turnContext.Activity.Text);//戻り値を格納するためscoreを用意
var res = "";//返事格納用
Debug.WriteLine($"Sentiment Score2: {score:0.00}");//出力確認2

if(0.5 <= score)
{
   res = getShioComment();
   Debug.WriteLine($"塩対応:{res}");//出力確認3
}
else
{
   res = getTweet();
   Debug.WriteLine($"励まし対応:{res}");//出力確認4
}

それではまたここで実行してみましょう。今度はできるだけポジティブな言葉を投げかけてください。

0.5以上のスコアで塩対応されていれば成功です！

2.6 ボットに発言させる

ここまできたら、後はもう少しです！今までデバッグとして出力させていたコメントを、ボットからユーザーに発言させるようにします。
まず、せっかくですので、返事に分析スコアもつけるため、score変数（小数点以下2桁まで）とres変数を連結します。Environment.NewLineは間で改行をするために入れています。
いよいよユーザーへの発言ですが、OnMessageActivityAsync内のawait turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken);部分で、ボットはオウム返しをしていますので、この部分を以下の通り変更して、塩対応/励まし対応の条件分岐後（返事をres変数に格納した後）に持ってきます。

EchoBot.cs

 res = $"Score:{score:0.00}" + Environment.NewLine + res;
 await turnContext.SendActivityAsync(MessageFactory.Text(res), cancellationToken);

また、オウム返しのテキストを作っている var replyText = $"Echo: {turnContext.Activity.Text}";は不要になるので、削除します。

ここまでの全ソースコードはこちらです。

EchoBot.cs

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
//
// Generated with Bot Builder V4 SDK Template for Visual Studio EchoBot v4.6.2

using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Bot.Builder;
using Microsoft.Bot.Schema;

//for TextAnalytics
using System;
using System.Net.Http;
using Microsoft.Azure.CognitiveServices.Language.TextAnalytics;
using Microsoft.Azure.CognitiveServices.Language.TextAnalytics.Models;
using Microsoft.Rest;
using System.Diagnostics;

//for Twitter
using CoreTweet;

namespace YasashiiBot.Bots
{
    public class EchoBot : ActivityHandler
    {
        //for TextAnalytics
        private static readonly string key = "<replace-with-your-text-analytics-key-here>;
        private static readonly string endpoint = "<replace-with-your-text-analytics-endpoint-here>";

        protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
        {
            
            //for TextAnalytics
            var client = authenticateClient();
            var score = sentimentAnalysisExample(client,turnContext.Activity.Text);//戻り値を格納するためscoreを用意
            var res = "";//返事格納用
            Debug.WriteLine($"Sentiment Score2: {score:0.00}");//出力確認2

            if(0.5 <= score)
            {
                res = getShioComment();
                Debug.WriteLine($"塩対応:{res}");//出力確認3
            }
            else
            {
                res = getTweet();
                Debug.WriteLine($"励まし対応:{res}");//出力確認4
            }

            res = $"Score:{score:0.00}" + Environment.NewLine + res;
            await turnContext.SendActivityAsync(MessageFactory.Text(res), cancellationToken);
        }

        protected override async Task OnMembersAddedAsync(IList<ChannelAccount> membersAdded, ITurnContext<IConversationUpdateActivity> turnContext, CancellationToken cancellationToken)
        {
            var welcomeText = "Hello and welcome!";
            foreach (var member in membersAdded)
            {
                if (member.Id != turnContext.Activity.Recipient.Id)
                {
                    await turnContext.SendActivityAsync(MessageFactory.Text(welcomeText, welcomeText), cancellationToken);
                }
            }
        }
        
        //for TextAnalytics
        static TextAnalyticsClient authenticateClient()
        {
            ApiKeyServiceClientCredentials credentials = new ApiKeyServiceClientCredentials(key);
            TextAnalyticsClient client = new TextAnalyticsClient(credentials)
            {
                Endpoint = endpoint
            };
            return client;
        }

        //for TextAnalytics
        static double sentimentAnalysisExample(ITextAnalyticsClient client, string message)//戻り値をdouble型に変更
        {
            var result = client.Sentiment(message, "ja");//引数messageを分析対象にし、言語は日本語に設定
            Debug.WriteLine($"User Message: {message}");//引数messageの内容を出力
            Debug.WriteLine($"Sentiment Score1: {result.Score:0.00}");//出力確認1

            return (double)result.Score;//分析スコアを返す
        }
        //for Twitter
        static string getTweet()
        {
            Random cRandom = new System.Random(); //取得したツイートからランダムに1つ選択するための乱数
            var tokens = Tokens.Create("<API KEY>", "<API SECRET>", "<ACCESS TOKEN>", "<ACCESS TOKEN SECRET>");  //接続用トークン発行
            var tweet = "";//取得したツイートを格納する変数

            var parm = new Dictionary<string, object>();  //条件指定用Dictionary
            parm["count"] = 60;  //取得数
            parm["screen_name"] = "hagemasi1_bot";  //取得したいユーザーID


            Task task = Task.Factory.StartNew(async () =>
            {
                var tweets = await tokens.Statuses.UserTimelineAsync(parm); //parmの内容に従ってツイートを取得

                var random = cRandom.Next(61); //0～60の間の乱数を生成
                tweet = tweets[random].Text; //取得した60ツイートからrandom番目のツイートを格納

            }).Unwrap();

            task.Wait();

            return tweet; //選んだツイートを戻り値として返す

        }

        static string getShioComment()
        {
            Random cRandom = new System.Random(); //乱数
            string res = "";
            var shio = new string[] { "へー・・・。", "・・・だから？", "知らんわー。", "興味ないね。", "いや、聞いてないし。", "ふーん・・・。で？", "そういうのいいから。", "あーちょっと今忙しいからまた今度。", "・・・けっ！", "リア充乙。" };

            var random = cRandom.Next(11);
            res = shio[random];
            return res;
        }
    }

    //for TextAnalytics
    class ApiKeyServiceClientCredentials : ServiceClientCredentials
    {
        private readonly string apiKey;

        public ApiKeyServiceClientCredentials(string apiKey)
        {
            this.apiKey = apiKey;
        }

        public override Task ProcessHttpRequestAsync(HttpRequestMessage request, CancellationToken cancellationToken)
        {
            if (request == null)
            {
                throw new ArgumentNullException("request");
            }
            request.Headers.Add("Ocp-Apim-Subscription-Key", this.apiKey);
            return base.ProcessHttpRequestAsync(request, cancellationToken);
        }
    }
}

2.7 Azureへ再デプロイする

PC上（ローカル）でBot Framework Emulatorを使って十分にテストができたら、Azure上に再度更新版のアプリをデプロイしましょう。
第2部に公式ドキュメントに沿ったデプロイ方法の記載がありますが、ちょっと面倒な手順なので、今回はVisual Studioから直接デプロイしてみます。途中でAzureへのサインインを要求されたら、適宜サインインをお願いします。

まず、ソリューションエクスプローラーから、ソリューション名を右クリックし、発行を選択します。

次にデプロイ先のAzureリソースを選んでいきます。今回は第2部で作成したAzureリソースに再デプロイするので、App Servive、既存のものを選択を選んで、プロファイルの作成をクリックします。

続いて、App Serviceの詳細を指定します。サブスクリプションの部分で、デプロイ先のAzureサブスクリプションを選びます。表示部分はリソースグループを選択し、下のボックスでデプロイ対象のリソースグループ、WebAppリソースを選択して、OKをクリックします。

最後に発行をクリックして、デプロイが終わるのを待ちます。

デプロイされたら、第2部 Webチャットでのテストの手順を参考に、テストをします。

ポジティブな発言とネガティブな発言をして、適切な返事が返ってきていれば成功です！

以降の工程について

以降の工程はこのようになっています。
次回はいよいよ、Azure上にあるボットアプリと、LINE経由でおしゃべりができるようにしてみたいと思います。

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up