Webhook 指南:使用 BLOOM 构建讨论机器人
Webhook 现已公开可用!
以下是如何使用 Hugging Face Webhook 构建机器人的简要指南,该机器人使用免费推理 API 使用多语言语言模型 BLOOM 回复 Hub 上的讨论评论。
在用户资料中创建您的 Webhook
首先,让我们从您的设置中创建一个 Webhook。
- 输入几个您的 Webhook 将监听的目标存储库。
- 您现在可以输入一个虚拟 Webhook URL,但定义您的 webhook 将使您查看将发送到它的事件(并且您可以重播它们,这将有助于调试)。
- 输入一个秘密,因为它将更安全。
- 订阅社区(PR 和讨论)事件,因为我们正在构建一个讨论机器人。
您的 Webhook 将如下所示
创建新的机器人用户资料
在本指南中,我们创建了一个独立的用户帐户来托管一个 Space 并发布评论
创建将对您的 Webhook 做出反应的 Space
第三步实际上是监听 Webhook 事件。
一种简单的方法是使用 Space 来实现这一点。我们使用我们创建的用户帐户,但如果您愿意,您也可以从您的主要用户帐户中执行此操作。
Space 的代码在这里。
我们使用 NodeJS 和 Typescript 来实现它,但任何语言或框架都可以同样有效。阅读有关 Docker Spaces 的更多信息这里。
主 server.ts
文件在这里
让我们逐步了解此文件中的操作
app.post("/", async (req, res) => {
if (req.header("X-Webhook-Secret") !== process.env.WEBHOOK_SECRET) {
console.error("incorrect secret");
return res.status(400).json({ error: "incorrect secret" });
}
...
在这里,我们监听对 /
发出的 POST 请求,然后我们检查 X-Webhook-Secret
标头是否等于我们之前定义的秘密(您还需要在 Space 的设置中设置 WEBHOOK_SECRET
秘密才能验证它)。
const event = req.body.event;
if (
event.action === "create" &&
event.scope === "discussion.comment" &&
req.body.comment.content.includes(BOT_USERNAME)
) {
...
事件的有效负载被编码为 JSON。在这里,我们指定当事件满足以下条件时,我们才会运行 Webhook:
- 该事件涉及讨论评论
- 该事件是创建,即发布了新评论
- 评论内容包含
@discussion-bot
,即我们的机器人刚刚在一个评论中被提及。
在这种情况下,我们将继续执行下一步
const INFERENCE_URL =
"https://api-inference.huggingface.co/models/bigscience/bloom";
const PROMPT = `Pretend that you are a bot that replies to discussions about machine learning, and reply to the following comment:\n`;
const response = await fetch(INFERENCE_URL, {
method: "POST",
body: JSON.stringify({ inputs: PROMPT + req.body.comment.content }),
});
if (response.ok) {
const output = await response.json();
const continuationText = output[0].generated_text.replace(
PROMPT + req.body.comment.content,
""
);
...
这是最酷的部分:我们使用 BLOOM 模型调用推理 API,并使用 PROMPT
提示它,然后我们获得延续文本,即模型生成的文本部分。
最后,我们将在同一个讨论线程中将其发布为回复
const commentUrl = req.body.discussion.url.api + "/comment";
const commentApiResponse = await fetch(commentUrl, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.HF_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ comment: continuationText }),
});
const apiOutput = await commentApiResponse.json();
配置您的 Webhook 以将事件发送到您的 Space
最后但并非最不重要的一点是,您需要配置您的 Webhook 以将 POST 请求发送到您的 Space。
首先让我们从上下文菜单中获取 Space 的“直接 URL”。单击“嵌入此 Space”,然后复制“直接 URL”。
更新您的 webhook 以将请求发送到该 URL