如何用 Python 打造一个简单的聊天机器人?

导读

不知道玩Slack的人多不多?国内有一个类似的产品,之前搞PythonTG翻译组在用,但是没怎么用起来。感觉这些产品提供的灵活性还蛮大的,可以自己实现许多有意思的机器人。

聊天机器人(Bot) 是一种像 Slack 一样的实用的互动聊天服务方式。如果你之前从来没有建立过聊天机器人,那么这篇文章提供了一个简单的入门指南,告诉你如何用 Python 结合 Slack API 建立你第一个聊天机器人。

我们通过搭建你的开发环境, 获得一个 Slack API 的聊天机器人令牌,并用 Pyhon 开发一个简单聊天机器人。

我们所需的工具

我们的聊天机器人我们将它称作为“StarterBot”,它需要 Python 和 Slack API。要运行我们的 Python 代码,我们需要:

Python 2 或者 Python 3

pip 和 virtualenv 来处理 Python 应用程序依赖关系

一个可以访问 API 的免费 Slack 账号,或者你可以注册一个 Slack Developer Hangout team。

通过 Slack 团队建立的官方 Python Slack 客户端代码库

Slack API 测试令牌

当你在本教程中进行构建时,Slack API 文档 是很有用的。

本教程中所有的代码都放在 slack-starterbot 公共库里,并以 MIT 许可证开源。

搭建我们的环境

我们现在已经知道我们的项目需要什么样的工具,因此让我们来搭建我们所的开发环境吧。首先到终端上(或者 Windows 上的命令提示符)并且切换到你想要存储这个项目的目录。在那个目录里,创建一个新的 virtualenv 以便和其他的 Python 项目相隔离我们的应用程序依赖关系。

激活 virtualenv:

你的提示符现在应该看起来如截图:

已经激活的starterbot的virtualenv的命令提示符这个官方的 slack 客户端 API 帮助库是由 Slack 建立的,它可以通过 Slack 通道发送和接收消息。通过这个pip 命令安装 slackclient 库:

当 pip 命令完成时,你应该看到类似这样的输出,并返回提示符。

在已经激活的virtualenv用pip安装slackclient的输出我们也需要为我们的Slack项目获得一个访问令牌,以便我们的聊天机器人可以用它来连接到Slack API。

Slack 实时消息传递(RTM)API

Slack 允许程序通过一个 Web API 来访问他们的消息传递通道。去这个 Slack Web API 页面 注册建立你自己的 Slack 项目。你也可以登录一个你拥有管理权限的已有账号。

使用 Web API页面的右上角登录按钮登录后你会到达 聊天机器人用户页面。

定制聊天机器人用户页面给你的聊天机器人起名为“starterbot”然后点击 “Add bot integration” 按钮。

添加一个bot integration 并起名为“starterbot”这个页面将重新加载,你将看到一个新生成的访问令牌。你还可以将标志改成你自己设计的。例如我给的这个“Full Stack Python”标志。

为你的新 Slack 聊天机器人复制和粘贴访问令牌在页面底部点击“Save Integration”按钮。你的聊天机器人现在已经准备好连接 Slack API。

Python 开发人员的一个常见的做法是以环境变量输出秘密令牌。输出的Slack令牌名字为SLACK_BOT_TOKEN:

好了,我们现在得到了将这个 Slack API 用作聊天机器人的授权。

我们建立聊天机器人还需要更多信息:我们的聊天机器人的 ID。接下来我们将会写一个简短的脚本,从 Slack API 获得该 ID。

获得我们聊天机器人的 ID

这是最后写一些 Python 代码的时候了! 我们编写一个简短的 Python 脚本获得 StarterBot 的 ID 来热身一下。这个 ID 基于 Slack 项目而不同。

我们需要该ID,当解析从Slack RTM上发给StarterBot的消息时,它用于对我们的应用验明正身。我们的脚本也会测试我们SLACK_BOT_TOKEN环境变量是否设置正确。

建立一个命名为printbotid.py的新文件,并且填入下面的代码:

我们的代码导入SlackClient,并用我们设置的环境变量SLACK_BOT_TOKEN实例化它。 当该脚本通过python命令执行时,我们通过会访问Slack API列出所有的 Slack 用户并且获得匹配一个名字为“satrterbot”的ID。

这个获得聊天机器人的ID的脚本我们仅需要运行一次。

当它运行为我们提供了聊天机器人的ID时,脚本会打印出简单的一行输出。

在你的Slack 项目中用Python脚本打印Slack聊天机器人的ID复制这个脚本打印出的唯一ID。并将该ID作为一个环境变量BOT_ID输出。

这个脚本仅仅需要运行一次来获得聊天机器人的ID。 我们现在可以在我们的运行StarterBot的Python应用程序中使用这个ID。

编码我们的 StarterBot

现在我们拥有了写我们的StarterBot代码所需的一切。 创建一个新文件命名为starterbot.py,它包括以下代码。

对os和SlackClient的导入我们看起来很熟悉,因为我们已经在theprintbotid.py中用过它们了。

通过我们导入的依赖包,我们可以使用它们获得环境变量值,并实例化Slack客户端。

该代码通过我们以输出的环境变量SLACK_BOT_TOKEN 实例化SlackClient`客户端。

Slack 客户端会连接到 Slack RTM API WebSocket,然后当解析来自 firehose 的消息时会不断循环。如果有任何发给 StarterBot 的消息,那么一个被称作 handle_command 的函数会决定做什么。

接下来添加两个函数来解析 Slack 的输出并处理命令。

parse_slack_output 函数从 Slack 接受信息,并且如果它们是发给我们的 StarterBot 时会作出判断。消息以一个给我们的聊天机器人 ID 的直接命令开始,然后交由我们的代码处理。目前只是通过 Slack 管道发布一个消息回去告诉用户去多写一些 Python 代码!

这是整个程序组合在一起的样子 (你也可以 在 GitHub 中查看该文件):

现在我们的代码已经有了,我们可以通过 python starterbot.py 来运行我们 StarterBot 的代码了。

当 StarterBot 开始运行而且连接到 API 的输出通道在 Slack 中创建新通道,并且把 StarterBot 邀请进来,或者把 StarterBot 邀请进一个已经存在的通道中。

在Slack界面创建一个新通道并且邀请 StarterBot现在在你的通道中给 StarterBot 发命令。

在你的Slack通道里给你的 StarterBot 发命令如果你从聊天机器人得到的响应中遇见问题,你可能需要做一个修改。正如上面所写的这个教程,其中一行AT_BOT = “:”,在“@starter”(你给你自己的聊天机器人起的名字)后需要一个冒号。从 AT_BOT 字符串后面移除:。Slack 似乎需要在@ 一个人名后加一个冒号,但这好像是有些不协调的。

结束

好吧,你现在已经获得一个简易的聊天机器人,你可以在代码中很多地方加入你想要创建的任何特性。

我们能够使用 Slack RTM API 和 Python 完成很多功能。看看通过这些文章你还可以学习到什么:

附加一个持久的关系数据库 或者 NoSQL 后端 比如 PostgreSQL、MySQL 或者 SQLite ,来保存和检索用户数据

添加另外一个与聊天机器人互动的通道,比如 短信 或者电话呼叫

集成其它的 web API,比如 GitHub、Twilio 或者 api.ai

有问题? 通过 Twitter 联系我 @fullstackpython 或 @mattmakai。我在 GitHub 上的用户名是mattmakai。

这篇文章感兴趣? Fork 这个 GitHub 上的页面吧。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20190122A0GFAV00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券

玩转腾讯云 有奖征文活动