コールバックAPI上のPythonでのVK用Chatbot

チャットボットはすでに非常に一般的になっており、毎日すべてのインスタントメッセンジャーに表示されます。



この記事では、一連の単純なコマンドを使用してボットを作成する方法を段階的に見て、将来的にその機能を拡張する方法を見つけます。 この記事は、チャットボットを作成したことのないほとんどの初心者に役立ちます。



ボットを作成したいときは、VKontakteで使用可能なボットの例を検討し、その構造を最大限に単純化することを試みました。



ボットを作成するために、Python 3.5（3番目のpythonの他のバージョンがおそらく適切です）と追加のFlaskおよびVKライブラリを使用しました。 それらをインストールする必要があります。 Flaskのインストールに関するロシア語の記事が多数あります。 Pycharmをお持ちの場合は、おそらくPycharmと共にインストールされています。



API自体から始めましょう。 ボットには、グループメッセージに使用できるコールバックAPIを使用します。 まず、接続されたメッセージを含むVKontakteグループを作成するか、すでに持っている必要があります。



[ コミュニティ管理] →[ APIの操作]セクションで、コミュニティメッセージにアクセスできるキーを作成する必要があります。









コールバックを使用するには、APIからイベントのリクエストを受信し、それらを処理し、レスポンスリクエストを送信するWebサーバーが必要です。 つまり、送信されたリクエストにのみ応答し、送信する「ウェブサイト」を作成します。



pythonで記述しているため、使用できる最も簡単なものはpythonのホスティングです。 Pythonの無料ホスティングを使用しました。 そこで登録し、FlaskでPython 3.5用のアプリケーションを作成する必要があります（Webセクションで作成できます）。 初期ファイルが作成されます：

# A very simple Flask Hello World app for you to get started with... from flask import Flask app = Flask(__name__) @app.route('/') def hello_world(): return 'Hello from Flask!'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

現在ファイルにある唯一の機能は、登録時に指定されたアドレスでページを埋めることに責任があります。 username.pythonanywhere.comのブラウザ（ニックネームを使用）にアクセスすると、「Hello from Flask！」というテキストのみが表示されます。



将来的には、コードはブロックで表示され、ブロック全体の完了後にチェックすることが可能になり、そのプロセスでコードが環境によってエラーとしてマークされる可能性があります。 怖がらないで、ブロックを最後まで終わらせたほうがいいです。



したがって、 ブロック1です。

サイトに送信されたリクエストを処理するには、ドキュメントの最後に次のコードを追加します。

 @app.route('/', methods=['POST']) def processing(): return 'xxxxxxxx'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Xの代わりに、「サーバーが返す必要のある文字列」を代入します。 これは、コールバックAPIセクションのグループ管理にリストされています。



この機能により、グループに通知するためにサイトを接続できます。



これで作業を確認できます。 アプリケーションを再起動するだけです。 サイトが新しいデータで作業を開始できるようにファイルを変更して保存した後のホスティングでは、[Web]タブでそれをリロードする必要があります。 このコードを追加した後、VKontakteグループのサーバーアドレスバーに対応するアドレスusername.pythonanywhere.comを入力し、[確認]をクリックします。



サーバーアドレスが正常に接続されたことを示す緑色の通知が表示されます。



[確認]をクリックすると、VKontakteはサーバーに接続し、それが実際にグループ所有者に属していることを確認し、サーバーが要求に応じて確認コードを返すのを「待機」します。



ブロック2

次のステップに進むことができます。 コミュニティに代わってメッセージを書き込む機能を追加します。 ホスティングにVKライブラリをインストールします。 「コンソール」セクションで、bashコンソールを起動し、コマンド（または選択したバージョンのpythonに適したコマンド）を実行します。

 pip3.5 install --user vk
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

モジュールのインストール方法については、 ここで説明します 。



受信リクエストを処理するための関数のコードを変更します。

 @app.route('/', methods=['POST']) def processing(): # json   POST- data = json.loads(request.data) #        if 'type' not in data.keys(): return 'not vk' if data['type'] == 'confirmation': return confirmation_token elif data['type'] == 'message_new': session = vk.Session() api = vk.API(session, v=5.0) user_id = data['object']['user_id'] api.messages.send(access_token=token, user_id=str(user_id), message=',   !') #   ,     return 'ok'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

VKontakteサーバーには、処理が成功したというメッセージが必要です。 エラーが発生した場合、または他の回答が到着した場合、サーバーは一定の間隔で（処理するまで）着信メッセージに関する通知を送信し続けます。



新しいメッセージについて通知する着信要求の構造は次のとおりです。

 {"type":"message_new","object":{"id":43, "date":1492522323, "out":0, "user_id":xxxxxxxx, "read_state":0, "title":" ... ", "body":""}, "group_id":xxxxxxxxxxx}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Vkontakteは、サイトに3つのオブジェクト「type」、「object」、「group_id」を渡し、メッセージに関する情報は「object」内に保存されます。



すべてのリクエストはVKontakteのドキュメントに記載されています



また、新しい「インポート」をファイルの先頭に追加します。

 from flask import Flask, request, json from settings import * import vk
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

同じsettings.pyフォルダーに新しいファイルを作成し、そこに必要なログインデータを保存します。

 token = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' confirmation_token = 'xxxxxxxx'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

それらはトークンに置き換える必要があります。 最初は記事の冒頭で作成し、2番目はグループをサーバーに接続するための確認コードです。



これでボットは着信メッセージに挨拶し、コードを与えたグループに属していることを確認できます。



これを確認してメッ​​セージを書き込むことができます。CallbackAPIセクションのグループ設定で着信メッセージに関する通知を有効にするだけです。



ボットがメッセージを送信するには、アプリケーションを再起動する必要があります。 その後、ボットに再度書き込み、すべてが正常に行われた場合、次のステップに進みます。



ブロック3

すべてがうまくいき、メッセージに応じてボットがあなたに挨拶した場合、次のステップに進みます。 vkライブラリとのすべての対話を別のファイルに入れました。vkapiと呼びます。

 import vk session = vk.Session() api = vk.API(session, v=5.0) def send_message(user_id, token, message, attachment=""): api.messages.send(access_token=token, user_id=str(user_id), message=message, attachment=attachment)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

VKontakteセッションの関数と初期化は1つだけですが、他のセッションを追加します。 潜在的に、関数は添付ファイルを送信することもできます。 後でこの機会を利用します。



次に、メッセージハンドラファイルを開始します。 着信メッセージを処理し、表示されたときに適切なコマンドを決定し、必要な回答を発行します。



ファイル「messageHandler.py」：

 import vkapi def get_answer(body): message = ",   !" return message def create_answer(data, token): user_id = data['user_id'] message = get_answer(data['body'].lower()) vkapi.send_message(user_id, token, message)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

新しいファイルをメインのファイルに接続します。 メインファイルのリクエスト処理関数を変更します。

 @app.route('/', methods=['POST']) def processing(): data = json.loads(request.data) if 'type' not in data.keys(): return 'not vk' if data['type'] == 'confirmation': return confirmation_token elif data['type'] == 'message_new': messageHandler.create_answer(data['object'], token) return 'ok'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして、適切なインポートをファイルの先頭に追加します。

 import messageHandler
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

アプリケーションを再起動することで、実行したことを確認できます。



ブロック4

チームの作成を始めましょう。 コマンドのクラスを作成します。



ファイル「command_system.py」：

 command_list = [] class Command: def __init__(self): self.__keys = [] self.description = '' command_list.append(self) @property def keys(self): return self.__keys @keys.setter def keys(self, mas): for k in mas: self.__keys.append(k.lower()) def process(self): pass
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

クラスにはkeysプロパティがあり、このコマンドにアクセスできるキーが保存されます。 プロパティを設定するとき、すべてのキーは小文字で保存されます。また、コマンドコールの成功にレジスタが影響しないように、小文字に変換されたユーザーメッセージと比較する必要があります。



説明フィールドは、ボットコマンドに関する情報を発行するために使用されます。 プロセス関数が実行され、応答メッセージが生成されます。



初期化時にすべてのコマンドが保存される一般的なリストがあります。 彼は教室の外にいます。 このリストを使用して、ユーザーがメッセージで要求したコマンドを見つけます。



それでは、ボット用のチームをいくつか作成しましょう。 ロードの便宜上、コマンドを初期化するファイルを「commands」フォルダーに配置します。



複数のファイルを作成しますが、コマンドを1つのファイルに配置することもできます



「Hello.py」

 import command_system def hello(): message = ', !\n  -.' return message, '' hello_command = command_system.Command() hello_command.keys = ['', 'hello', '', '', ''] hello_command.description = ' ' hello_command.process = hello
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

「Cat.py」

 import command_system import vkapi import settings def cat(): #      attachment = vkapi.get_random_wall_picture(-32015300, settings.access_token) message = '   :)\n      .' return message, attachment cat_command = command_system.Command() cat_command.keys = ['', '', '', '', '', 'cat'] cat_command.description = '   ' cat_command.process = cat
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

猫を送るチームには、グループまたはユーザーの壁からランダムな画像を返す「vkapi」ファイルの新しいトークンと新しい関数が必要です。 この場合、私たちは猫と一緒に公衆の壁からランダムな写真を受け取ります。



トークンを取得することから始めましょう。 サービスアクセスキーが必要です。 これを行うには、新しいスタンドアロンアプリケーションを作成します。 参照によって作成できます。 次に、アプリケーションを作成したら、その設定に移動して、[サービスアクセスキー]フィールドの内容をコピーする必要があります。

これをトークンファイルに追加する必要があります。

「Settings.py」

 token = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' confirmation_token = 'xxxxxxxx' access_token = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

それでは、新しいvkapiメソッドの作成に移りましょう。 ここでは、使用するAPIメソッドの範囲を少し拡大します。



このメソッドは次のようになります。

 def get_random_wall_picture(group_id, token): max_num = api.photos.get(owner_id=group_id, album_id='wall', count=0, access_token=token)['count'] num = random.randint(1, max_num) photo = api.photos.get(owner_id=str(group_id), album_id='wall', count=1, offset=num, access_token=token)['items'][0]['id'] attachment = 'photo' + str(group_id) + '_' + str(photo) return attachment
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

「vkapi」ファイルに追加します。 また、必要なインポートを「vkapi」ファイルの先頭に追加します。

 import random
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして最後のチーム



「Info.py」

 import command_system def info(): message = '' for c in command_system.command_list: message += c.keys[0] + ' - ' + c.description + '\n' return message, '' info_command = command_system.Command() info_command.keys = ['', '', 'help'] info_command.desciption = '  ' info_command.process = info
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最終的なファイル階層：





botFlaskは、着信要求を受け入れるメインファイルです。



コマンドの説明が終わったので、コマンドシートがいっぱいになっていることを確認する必要があります。また、command_listは特定のコマンドでファイルを起動したときにのみ入力されるため、ユーザーがアクセスしたコマンドを理解できます。



ボットの起動時に、「commands」フォルダーからすべてのファイルを自動的に起動します。



これを行うには、messageHandler.pyファイルに関数を追加します。

 def load_modules(): #    ,       files = os.listdir("mysite/commands") modules = filter(lambda x: x.endswith('.py'), files) for m in modules: importlib.import_module("commands." + m[0:-3])
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この関数では、コマンドを使用してディレクトリからファイルのリストをロードし、Pythonファイルのみをフィルター処理してプログラムにインポートします。これにより、リストにコマンドが入力されます。



この関数の呼び出しがcreate_answerに追加されます。 次に、対応する応答を呼び出すようにget_answer関数を変更しましょう。



ファイルの最終形式：

 import vkapi import os import importlib from command_system import command_list def load_modules(): #    ,       files = os.listdir("mysite/commands") modules = filter(lambda x: x.endswith('.py'), files) for m in modules: importlib.import_module("commands." + m[0:-3]) def get_answer(body): #        message = ",   .  '',    " attachment = '' for c in command_list: if body in c.keys: message, attachment = c.process() return message, attachment def create_answer(data, token): load_modules() user_id = data['user_id'] message, attachment = get_answer(data['body'].lower()) vkapi.send_message(user_id, token, message, attachment)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ボットの準備ができました！ これで、ボットのベースを作成し、そのための新しいチームを追加する方法がわかりました。



ブロック5

記事の残りの部分では、必要だと思う1つの改善について説明します。 ただし、ボットはそれなしで動作します。



おおよそのコマンド認識



ユーザーが1つの文字を間違えた場合、最も類似したコマンドを念頭に置いている可能性が高いです。 したがって、ボットがまだ答えを出し、「私はあなたを理解していません」と言わなかったらいいでしょう。



おおよその認識のために、Damerau-Levenshtein距離を使用します。 文字を削除、挿入、置換、移動する操作が、ある行から別の行に移動できる回数を示しています。



この距離を見つけるためのアルゴリズムは、例えばウィキペディアで説明されています。



関数をmessageHandler.pyファイルに追加します。

 def damerau_levenshtein_distance(s1, s2): d = {} lenstr1 = len(s1) lenstr2 = len(s2) for i in range(-1, lenstr1 + 1): d[(i, -1)] = i + 1 for j in range(-1, lenstr2 + 1): d[(-1, j)] = j + 1 for i in range(lenstr1): for j in range(lenstr2): if s1[i] == s2[j]: cost = 0 else: cost = 1 d[(i, j)] = min( d[(i - 1, j)] + 1, # deletion d[(i, j - 1)] + 1, # insertion d[(i - 1, j - 1)] + cost, # substitution ) if i and j and s1[i] == s2[j - 1] and s1[i - 1] == s2[j]: d[(i, j)] = min(d[(i, j)], d[i - 2, j - 2] + cost) # transposition return d[lenstr1 - 1, lenstr2 - 1]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この距離を見つけるためのアルゴリズムが実装されており、必要に応じて変更または改善できます。



これらの行によると、1つを別の値に変換するための操作の数が与えられます。 get_answerメソッドを変更します。

 def get_answer(body): message = ",   .  '',    " attachment = '' distance = len(body) command = None key = '' for c in command_list: for k in c.keys: d = damerau_levenshtein_distance(body, k) if d < distance: distance = d command = c key = k if distance == 0: message, attachment = c.process() return message, attachment if distance < len(body)*0.4: message, attachment = command.process() message = '     "%s"\n\n' % key + message return message, attachment
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この関数では、メッセージと各キーの距離を計算します。 一致が不正確な場合、送信された各コマンドをボットがどのように認識したかを記述します。 距離が送信されたメッセージの長さの40％を超えた場合、ユーザーが誤解しすぎていると見なし、デフォルトメッセージを返します。



それだけです。（この記事を書いている時点で）動作するコードはgithubに投稿されています。



VK用の独自のボットを作成することに決めた場合、この記事があなたの人生を少し楽にすることを願っています。