Update bot-api.md

bot-api.md

@@ -12,9 +12,15 @@ https://www.my-bot.com/api/v1/chat
 
 
 
-
 ## [方案一] 标准接口
 
+这是平台向机器人（也就是提供服务的第三方）发起的请求。
+在这个请求里，平台会向机器人提供本次对话的唯一标识 qid（query id） 和唯一用户标识 uid（user id）。
+机器人需要自行储存或处理 qid 和 uid，以便支持以下需求：
+
+- qid：单个用户的多轮对话。
+- uid：区别多个用户的对话。
+
 **POST** `~/chat` （接口地址必须以 `chat` 结尾）
 
 请求体（JSON）：
@@ -42,6 +48,10 @@ https://www.my-bot.com/api/v1/chat
 }
 ```
 
+字段名 | 类型 | 必填 | 含义 | 示例 | 备注
+---|---|:---:|---|---|---
+`type` | String | ✓ | 返回类型 |`text`| 目前支持 text 和 markdown
+`content` | String |  | 机器人所返回的内容 |`很高兴见到你，我是……`|
 
 
 ## [方案二] Hugging Face 风格接口
@@ -75,5 +85,18 @@ https://www.my-bot.com/api/v1/chat
 }
 ```
 
+在 Hugging Face 里，你可以通过一下方式来完成：
 
+```
+def chat(p, qid, uid):
+    #your process
+    return ["text", response]
+
+iface = gr.Interface(fn=chat, 
+                     inputs=["text", "text", "text"], 
+                     outputs=["text", "text"],
+                     description="""这是我的机器人""")
+iface.launch()
+```
 
+其中，gr.Interface 的 inputs 对应了 chat 的三个输入参数， outputs 对应了 chat 返回的两个变量。