首页>编程相关>Ai源码
下载

谣言线机器人

检查消息是否包含互联网谣言的线路机器人。

状态图和文档

这是真的假的的子项目之一。

此状态图描述了 LINE 机器人如何与用户对话：

发展

开发Rules-line-bot需要您完成以下设置。

获取存储库

将此存储库克隆到项目目录后，然后安装依赖项。 

 $ git clone --recursive [email protected]:cofacts/rumors-line-bot.git # --recursive for the submodules
$ cd rumors-line-bot

LINE 渠道和开发者帐户

请按照LINE官方教程中的所有步骤进行操作。

环境变量

从.env.sample模板创建.env文件，至少填写： 

 API_URL=https://dev-api.cofacts.tw/graphql
LINE_CHANNEL_SECRET=<paste Messaging API's channel secret here>
LINE_CHANNEL_TOKEN=<paste Messaging API's channel access token here>
LINE_LOGIN_CHANNEL_ID=<paste LINE Login channel ID here>
LIFF_URL=<paste LIFF app's LiFF URL>

其他可定制的环境变量有：

  • REDIS_URL ：如果未给出，则使用redis://127.0.0.1:6379 。
  • PORT ：线路机器人服务器将侦听哪个端口。
  • GTM_ID ：Google 跟踪代码管理器 ID。对于我们推送到dataLayer事件和变量，请参阅下面的“Google 跟踪代码管理器”部分。
  • DEBUG_LIFF ：禁用 LIFF 中的外部浏览器检查。在外部浏览器中调试 LIFF 时很有用。不要在生产中启用此功能。
  • RUMORS_LINE_BOT_URL ：服务器公共 url，用于生成 LINE Notify 的教程图像 url 和身份验证回调 url。

节点依赖关系

您需要Node.JS 16+ 才能继续。 

 $ npm i

让机器人服务器在本地计算机上运行

使用以下方法启动 Redis 和 MongoDB 等外围设备： 

 $ docker-compose up -d

然后启动应用程序，包括聊天机器人服务器和 LIFF 的 webpack-dev-server，使用： 

 $ npm run dev

服务器将在localhost:5001 （或您在.env文件中指定的PORT ）上启动。

如果您想停止外围设备，请运行docker-compose stop 。

单元测试

只需运行npm test 。它将自动启动上述 docker 并运行单元测试。

将 LINE 消息发送到本地计算机

我们建议使用ngrok创建一个公共地址，将流量从 LINE 服务器引导到您的本地计算机。当ngrok在你的路上时，只需

 $ ngrok http 5001

ngrok将为您提供一个公共 URL。使用它来设置频道的 webhook URL（请参阅 LINE 官方教程中的“频道控制台”部分）。

我们建议使用 ngrok 配置文件来设置具有固定subdomain隧道。这样，只要subdomain不被其他人占用，公共 URL 就可以固定（意味着无需重复复制粘贴到 LINE 频道设置！）。

在 Message API 通道的 LINE Developers 控制台内，在 Messaging API > Webhook 设置下，将Webhook URL设置为${ngrok_url}/callback并启用Use webhook 。单击“验证”以确认已成功连接到本地计算机。

LIFF设置

我们使用 LIFF 来收集用户提交文章和负面反馈的原因。

如果您不需要开发 LIFF，可以直接使用.env.sample中提供的LIFF_URL ，该 URL 链接到暂存 LIFF 站点。

如果您想修改LIFF，您可能需要按照以下步骤操作：

创建您自己的 LIFF 应用程序

要创建 LIFF 应用程序，请按照官方文档中的说明进行操作，其中涉及

  • 创建 LINE 登录通道
  • 在作用域中选择chat_message.write （供LIFF发送消息）获取LIFF URL后，将其放置在.env中作为LIFF_URL 。
  • 将Endpoint URL设置为以 chabbot 端点开头，并添加/liff/index.html作为后缀。

开发 LIFF

要开发 LIFF，在npm run dev后，可以在开发服务器（http://localhost:5001）或生产聊天机器人服务器的/liff/index.html下访问它。

在开发模式下，它在localhost:<LIFF_DEV_PORT> （默认为8080 ）上旋转 webpack-dev-server，聊天机器人服务器的/liff将所有请求代理到 webpack-dev-server。

在浏览器中开发 LIFF 的技巧是：

  1. 在桌面浏览器中访问https://<your-dev-chatbot.ngrok.io>/liff/index.html?p=<page>&...
  2. 如果您的浏览器尚未登录 LINE，LIFF SDK 会将您的桌面浏览器窗口重定向到登录页面。
  3. 如果您的浏览器登录 LINE 一段时间，您的会话可能已超时。 LINE LIFF 不会自动注销您；您需要在 JS 控制台中手动输入liff.logout()来触发重新登录。

liff.init()仍然可以在桌面浏览器中工作，以便应用程序呈现，使我们能够在桌面上调试 Web 布局。不过， liff.sendMessages()不起作用。如果您的浏览器窗口已经历登录重定向， liff.closeWindow()也将不起作用。

LIFF 的 GraphQL API

LINE 机器人服务器启动一个 GraphQL 服务器，该服务器缝合 Cofacts GraphQL API 和 LINE 聊天机器人特定的 API。

每当 Cofacts API 更新时，请使用npm run cofactsapi来获取最新的 Cofacts API 架构。

LIFF 组件故事书

在开发过程中，使用以下命令在本地计算机上启动故事书： 

 npm run storybook # Then visit http://localhost:6006

您还可以访问 https://cofacts.github.io/rumors-line-bot 在master分支上预构建故事书。

LIFF 如何在生产中部署

在生产中，LIFF 文件被编译到/liff目录并由聊天机器人服务器用作静态文件。

如果您在 LIFF 中收到400 bad request ，请在编译的 JS 二进制文件中搜索liff.init函数调用，看看 LIFF ID 是否与您的 LIFF URL 一致，该 URL 应该是不带前导的路径https://liff.line.me/ 。

LIFF ID 是在构建期间使用 Webpack Define 插件设置的，因此在不重建 LIFF 二进制文件的情况下交换 LIFF URL 环境变量将导致 400 错误请求。

翻译

我们使用 ttag 来支持聊天机器人的构建时 i18n。

请参阅 ttag 文档以注释要翻译的字符串。

要将带注释的字符串提取到翻译文件，请使用： 

 $ npm run i18n:extract

翻译文件

翻译文件位于i18n/下，采用 Gettext PO 格式。

  • en_US.po ：由于代码中使用的语言已经是英语，因此存在这个空翻译文件以简化设置。
  • zh_TW.po ：繁体中文翻译。
  • ja.po ：日语翻译。

支持其他语言

您可以利用 Gettext msginit命令将其替换为您想要支持的任何语言。

您需要更改package.json中的i18n:extract和i18n:validate脚本以反映区域设置更改。

用不同的语言构建

默认情况下，聊天机器人将在en_US语言环境下构建。

在 Heroku 上，请将LOCALE设置为en_US 、 zh_TW或i18n/目录下存在的任何其他语言代码之一。

如果您想使用 docker 进行构建，则可能需要修改 Dockerfile 以包含所需的LOCALE 。

通知设置

  • 先决条件：

    1. LIFF设置
    2. 连接 MongoDB

  • 要使用推送消息：在.env文件中，设置NOTIFY_METHOD=PUSH_MESSAGE

  • 要使用 LINE 通知：

    1. 您应该首先注册一个服务。
    2. 然后设置Callback Url ： RUMORS_LINE_BOT_URL /authcallback/line_notify
    3. 在.env文件中，设置
       LINE_NOTIFY_CLIENT_ID=<paste LINE Notify Client ID here>
LINE_NOTIFY_CLIENT_SECRET=<paste LINE Notify Client Secret here>
NOTIFY_METHOD=LINE_NOTIFY
RUMORS_LINE_BOT_URL=<line bot server url>
LINE_FRIEND_URL=https://line.me/R/ti/p/<paste your chatbot ID here>

您可以在账户管理器 -> 丰富菜单中设置设置页面入口点( LIFF_URL ?p=setting)

通知定时任务

  • 在本地机器上运行
 $ npm run notify
  • 要在heroku上运行，可以使用heroku调度程序
 $ node build/scripts/scanRepliesAndNotify.js

谷歌云服务

传闻线机器人使用谷歌云服务，该服务使用谷歌云服务帐户和应用程序默认凭据进行身份验证和授权。

请在项目下创建一个服务帐户，下载其密钥并使用GOOGLE_APPLICATION_CREDENTIALS env var 提供下载的服务帐户密钥的路径。详细信息请参阅文档。

对话流

我们使用 Dialogflow 来检测用户是否正在尝试聊天。如果用户输入与任何 Dialogflow 意图匹配，我们可以直接返回该意图中的预定义响应。

要使用 Dialogflow，请执行以下设置：

  1. 请确保您的 GCP 项目已启用 Dialogflow api。
  2. 构建连接到 GCP 项目的代理。
  3. 请确保服务帐户具有dialogflow.sessions.detectIntent权限。
  4. 设置这些环境变量（可选）：
    • DAILOGFLOW_LANGUAGE ：为空，为代理的默认语言，或者您可以指定一种语言。
    • DAILOGFLOW_ENV ：默认为草稿代理，或者您可以创建不同的版本。

Google Analytics 自定义维度和指标

为Message Source创建自定义（用户范围）维度，并为Group Members Count创建自定义（命中范围）矩阵。两者默认索引都是1。如果GA创建的索引不为1，则在代码中找到cd1和cm1 ，分别修改为cd$theIndexGACreated和cm$theIndexGACreated 。

打字稿

使用npm run typecheck检查类型；使用npm run typegen从 GraphQL 模式生成类型。

生产部署

准备.env文件（应与您的部署环境相同）并运行docker build .生成docker镜像。

.env将被复制到构建器映像，以使用 env 生成 LIFF 静态文件。构建镜像时，您可以在.env中包含“构建时变量”（在.env.sample中表示），以确保构建的客户端代码中不会泄露服务器凭据。

由于构建的 docker 镜像会将公共 URL 编码到静态构建的文件中，因此当我们将镜像作为容器运行时，这些构建时变量。因此，每个单独的部署环境都需要单独构建映像。

您可以使用docker-compose.yml在本地测试构建的镜像；只需取消注释 line bot 部分并提供构建的图像名称即可。

对于生产，请参阅谣言部署以获取运行此类映像的示例docker-coompose.yml 。

谷歌标签管理器

当用户与 LIFF 交互时，我们将变量和事件推送到 Google 跟踪代码管理器的dataLayer中。

您可以在.env文件中准备以下设置：

  • GTM_ID ：Google 跟踪代码管理器容器 ID ( GTM-XXXXXXX )

应用程序将在 GTM dataLayer中触发以下自定义事件：

  • dataLoaded - 当数据加载到文章、评论或反馈 LIFF 中时。
  • routeChangeComplete - 当 LIFF 加载或更改路径时。
  • feedbackVote - 当用户提交反馈时。
    • 当用户打开反馈 LIFF 时触发一次，并且当用户更新投票或评论时可以再次触发。
    • 当用户提交有关文章 LIFF 的反馈时也会触发。
  • chooseArticle - 当用户在文章 LIFF 中选择一篇文章时。

此外，它会将以下自定义变量推送到dataLayer ；

  • pagePath - 当routeChangeComplete事件触发时设置。来自 LIFF 路由器的页面路径。
  • userId - 在 LIFF 获取 ID 令牌并解码内部的 LINE 用户 ID 后设置。
  • articleId和replyId ：在文章、评论和反馈上设置onMount()生命周期被调用。或者当chooseArticle事件被触发时。
  • doc - 当dataLoaded事件触发时设置。对象中加载的内容本身（Article LIFF 中的文章、Comment LIFF 中的评论和feedback LIFF 中的反馈）。

Google Analytics 事件表

发送事件格式： Event category / Event action / Event label

我们使用维度Message Source （Custom Dimemsion1）来对不同的事件源进行分类

  • 一对一消息的user
  • room | group用于群组消息

1对1消息

  1. 用户向我们发送消息
  • UserInput / MessageType / <text | image | video | ...>
  • 如果我们在数据库中找到与消息匹配的文章：
    • UserInput / ArticleSearch / ArticleFound
    • Article / Search / <article id>找到的每篇文章
  • 如果数据库中没有找到任何内容：
    • UserInput / ArticleSearch / ArticleNotFound
  • 如果在数据库中找到文章但不是用户想要的：
    • UserInput / ArticleSearch / ArticleFoundButNoHit
  • 当用户提供来源时
    • UserInput / IsForwarded / Yes | No
  • 当用户指定消息是否同时来自同一个人（同时出现）
    • UserInput / IsCooccurrence / Yes | No
  • 匹配 Dialogflow 意图之一
    • UserInput / ChatWithBot / <intent name>
  1. 用户选择找到的文章
  • Article / Selected / <selected article id>
  • 如果有回复：
    • 每个回复的Reply / Search / <reply id>
  • 如果没有回复：
    • Article / NoReply / <selected article id>
  1. 用户选择回复
  • Reply / Selected / <selected reply id>
  • Reply / Type / <selected reply's type>
  1. 用户对回复进行投票
  • UserInput / Feedback-Vote / <articleId>/<replyId>
  • 当 LIFF 打开时，还会发送页面/feedback/yes或/feedback/no的页面视图。
  1. 用户想要提交一篇新文章
  • Article / Create / Yes
  1. 用户不想提交文章
  • Article / Create / No
  1. 用户更新回复请求的原因
  • Article / ProvidingReason / <articleId>
  • 当 LIFF 打开时，还会发送页面/reason的页面视图。
  1. 用户打开文章列表
  • 页面/articles的页面视图已发送
  • 如果通过丰富菜单打开： utm_source=rumors-line-bot&utm_medium=richmenu
  • 如果通过推送消息打开： utm_source=rumors-line-bot&utm_medium=push
  1. 当用户单击文章列表中已查看的文章项时
  • LIFF / ChooseArticle / <articleId>
  • 注意：此事件在 LIFF 中调度，因此utm_source 、 utm_medium等 URL 参数也适用。
  1. 用户打开设置列表
  • 页面/setting的页面视图已发送
  • 如果发送回复请求后打开： utm_source=rumors-line-bot&utm_medium=reply-request
  • 如果在教程中打开： &utm_source=rumors-line-bot&utm_medium=tutorial
  1. 教程
  • 如果它是由关注事件（又名添加好友事件）触发的
    • Tutorial / Step / ON_BOARDING
  • 如果是由丰富的菜单触发的
    • Tutorial / Step / RICH_MENU
  • 其他的
    • Tutorial / Step / <TUTORIAL_STEPS>

群组消息

  1. 当聊天机器人加入/离开群组或房间时
  • 加入
    • Group / Join / 1 （ Event category / Event action / Event value ）
    • Group Members Count （自定义指标1）用于记录聊天机器人加入时的群组成员计数。
  • 离开
    • Group / Leave / -1 （ Event category / Event action / Event value ）

笔记：

  1. 我们将 ga 事件值 1 设置为加入，-1 设置为离开。要了解聊天机器人当前加入的群组总数，您可以直接查看总事件值（详细信息请参阅隐式计数）。
  2. 要了解当前组是加入还是离开，您应该找到Client Id的最后一次Join或Leave操作。
  3. 此外，您还应该找到Client Id的最后一个Join操作，以获得更准确的Group Members Count 。 Group Members Count仅在聊天机器人加入群组时记录，要知道确切的计数，您应该直接从 line messages-api 获取。
  1. 用户向我们发送消息
  • 如果我们在数据库中找到与消息匹配的文章：
    • UserInput / ArticleSearch / ArticleFound
    • Article / Search / <article id>找到的每篇文章
  • 如果文章相同
    • Article / Selected / <selected article id>
  • 如果文章有有效类别且回复有效（详情见​​#238）
    • Reply / Selected / <selected reply id>
  1. 用户触发聊天机器人自我介绍：
  • UserInput / Intro /

其他的

  1. 正在访问 LINE 内容代理 URL： ContentProxy / Forward / <content type> / <content length> （值）

合法的

LICENSE定义此存储库中源代码的许可协议。

LEGAL.md是 Cofacts 网站用户的用户协议。

展开
附加信息
相关应用
为您推荐
相关资讯 全部