圖靈機器人相關接口
圖靈機器人是一個中文語境下的對話機器人,免費的機器人每天有5000次調用的,如果放在群聊中是完全夠用的(如果只有@的消息才使用機器人回復的)。圖靈機器人也包括一些簡單的能力,比如講笑話、故事大全、成語接龍、新聞資訊等,我們將介紹如何簡單調用圖靈機器人接口。
前期準備
前往注冊圖靈機器人,增加一個機器人,并記錄機器人的APIKey。具體注冊方法可以前往圖靈API查看。(如果你覺得很麻煩, 也可以暫時使用itchat提供的幾個key)
-
# 從 pip 安裝 () pip install requests
并在機器人中導入Requests包(寫在程序最初):
import requests
調用接口
wxpy提供了圖靈的接口,使用方法:
tuling = Tuling(api_key='Your API Key') # 剛才申請的key
@bot.register(my_friend) # 注冊消息
def reply_my_friend(msg):
tuling.do_reply(msg)
為了讓大家了解HTTP協議在python中的使用方式,我接下來會介紹如何使用請求獲取信息。
本節中內容如果沒有特殊提示,都應寫在你希望處理的某種注冊了的消息方法中以保證它的正常運作。
首先,將圖靈API寫入程序中:
TULING_TOKEN = 'Your API Key'
然后,定義接口鏈接和需要傳輸的數據:
url_api = 'http://www.tuling123.com/openapi/api'
data = {
'key' : TULING_TOKEN,
'info' : msg.text, # 收到消息的文字內容
}
根據文檔,通過HTTP請求,我們將會得到一個json格式的文件。使用Requests包,我們可以簡單的獲得調用接口所返回的信息:
s = requests.post(url_api, data=data).json()
print s # 打印所獲得的json查看如何使用
# {u'text': u'回復的內容', u'code': 100000}
我們發現經過請求,我們一般會得到一個字典內容,其中包括text和code兩項:text是圖靈機器人回復的文本,而code是返回的編號。詳細的返回數據格式也可以在圖靈API中看到,除了文字類還有新聞類、圖片類、鏈接類等返回類型。在這里我們以文字類為例,介紹如何處理:
if s['code'] == 100000:
print s['text'] # 查看回復消息的內容,可省略
msg.reply(s['text']) # 回復消息
如果需要回復其他類型的消息,也完全可以通過判斷code確定消息類型,再決定如何回復。這里給出我的回復方法供大家參考(也可以選擇不處理這一類內容):
if s['code'] == 200000: # 鏈接類:回復文字和鏈接
msg.reply(s['text'] + s['url'])
至此,我們已經成功調用了圖靈機器人的API接口進行回復,完整程序如下:
# -*- coding: utf-8 -*-
from wxpy import *
import requests
TULING_TOKEN = 'Your API Key'
bot = Bot()
@bot.register(Group, TEXT) # 這里注冊了群聊中的文字消息,測試時可以設置為自己(上篇中提到過)
def group_msg(msg):
if msg.is_at:
url_api = 'http://www.tuling123.com/openapi/api'
data = {
'key' : TULING_TOKEN,
'info' : msg.text, # 收到消息的文字內容
}
s = requests.post(url_api, data=data).json()
print s # 打印所獲得的json查看如何使用
if s['code'] == 100000:
print s['text'] # 查看回復消息的內容,可省略
msg.reply(s['text']) # 回復消息
embed()
以下內容更加進階,而文末有一些簡單問題的解答。如果遇到其他問題,我也會在之后更新。
番外:使用上下文
wxpy給每個用戶定義了一個相對穩定的對象/用戶id,為puid,可以始終被獲取到并有唯一的穩定性(根據文檔),我們可以使用這個id來作為userid傳給圖靈機器人,以方便識別機器人或航班/列成信息的上下文。
bot.enable_puid() # puid 需要手動開啟,請將這句話寫在登陸登錄之后
這樣傳送給接口的數據也要同時修改為:
data = {
'key' : TULING_TOKEN,
'info' : msg.text, # 收到消息的文字內容
'userid' : msg.member.puid, # 使用群聊中發送者的 puid 作為 userid 傳送給圖靈接口, 如果是私聊可以使用 msg.sender.puid
}
這樣做的好處是,圖靈機器人可以根據得userid來獲取上下文信息。例如你詢問『天氣』,它會回復『親愛的,悄悄地告訴我你在哪個城市?』。在這種情況下,如果你不使用userid參數,你再次回復城市,圖靈機器人也無法正確找到天氣;如果你使用了這一參數,且兩次回復使用的userid相同,圖靈機器人會為你回復你回復的城市的天氣情況,完成這一對話。
使用api.ai
api.ai是一家被谷歌收購的人機交互系統,主要著重于對話機器人的開發。圖靈機器人雖然包括一個知識庫,但其語義識別的能力較差。我所需要的機器人主要用于新生群,很多問題人與人之間會有相當多不同的表達,圖靈機器人無法滿足我對于群聊機器人的要求。因此,我嘗試使用api.ai進行回復有針對性的一些問題。
如果你的英語相對糟糕,我不建議使用api.ai。api.ai的配置大多需要使用英語,雖然接口簡單,但是后臺設置相對復雜,如果沒有英文背景不推薦使用。
這一部分內容相對進階,如果沒有特殊需要,完全可以跳過不看。這里只作一個對api.ai使用方式上大體的介紹,希望能幫助大家了解這一網站。
前期準備
前往api.ai注冊,創建機器人,并獲得APIkey。雖然被谷歌收購,但是這個網站是不需要翻墻的哦!
-
安裝api.ai官方提供的Python SDK
pip install apiai
-
在文件頭部加入(處理返回的消息時使用)
import json
調用接口
首先,我們需要設置api.ai的Token,
APIAI_TOKEN = 'Your API Key'
而后我們發起一個最簡單的請求,一下內容都可以通過例子找到:
ai = apiai.ApiAI(APIAI_TOKEN)
request = ai.text_request()
request.lang = 'zh-CN' # 使用中文
request.session_id = msg.member.puid # api.ai 中用 session id 來區分對話對象,必須
request.query = msg.text # 消息文字內容
然后通過接口得到傳回的json:
response = request.getresponse()
s = json.loads(response.read(), encoding='UTF-8') # 講傳回的json轉換為python字典
print s
# {u'lang': u'zh-cn', u'status': {u'errorType': u'success', u'code': 200}, u'timestamp': u'20}
我們發現,api.ai傳回的json相對于圖靈機器人更加復雜。參考api.ai的query文檔,我對對這部分回復進行了如下處理:
if s['result']['action'] == 'input.unknown': #
raise Exception('api.ai cannot reply this message') # 拋出異常:使用 try 語句捕捉后使用圖靈機器人回復
if s['status']['code'] == 200:
msg.reply(s['result']['fulfillment']['speech']) # 回復 api.ai 返回的內容
api.ai的設置和調試
在進入api.ai的機器人后,你將會看到左邊的多個菜單。
如果你只是簡單的需要特定語句回復的功能,只需要創建并設置Intents就可以實現。在User Says一欄中填寫消息可能是什么,在下方Response處填寫可能回復的內容,然后保存即可。
api.ai自帶機器學習功能,它的參數可以在機器人設置中的ML settings里找到??梢酝ㄟ^調整參數和方式讓你的機器人回復更加準確。
在進入機器人后,api.ai的右側會出現一個對話框。你可以使用它進行一些基礎調試。在上方輸入你的消息后,下方會給出機器人的回復,你可以通過這個對話框來了解是否正確設置了機器人。(需要翻墻)
你可能會遇到的一些問題
報錯:No handlers could be found for logger "wxpy.api.bot"
有報錯但是無法顯示,可以選擇在代碼頭部加入:
import logging
logging.basicConfig()
消息處理:刪除@內容
如果不刪除消息中@部分的內容,圖靈機器人的回復可能會受到昵稱內容的影響,導致回復不準確,或是識別不出一些應當識別出的內容。我們可以用一段簡單的代碼刪除@到空格之間的內容并去除首尾多余的空格。
content = re.sub('@[^\s]*', '', unicodedata.normalize('NFKC', msg.text)).strip().encode('utf-8')
這里使用了正則表達式,匹配@以及它之后所有不為空的字符。如果你的微信昵稱中沒有空白字符,這條代碼是可行的。(需要在代碼開頭添加import re
)
機器人代碼
我的微信機器人的代碼在GitHub托管,歡迎查看(づ ̄3 ̄)づ╭?~