Duplicate from baixing/hackathon_test

Co-authored-by: ElfeXu <Elfe@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,34 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,14 @@
+---
+title: Hackathon Test
+emoji: 🌖
+colorFrom: indigo
+colorTo: red
+sdk: gradio
+sdk_version: 3.20.1
+app_file: app.py
+pinned: false
+license: cc-by-4.0
+duplicated_from: baixing/hackathon_test
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -0,0 +1,63 @@
+import random
+import json
+import gradio as gr
+import requests
+
+def getResponse(api, p, qid, uid):
+    if api.strip().endswith(".hf.space/run/predict"):
+        return getResponseFromHF(api, p, qid, uid)
+    else:
+        return getResponseFromDefault(api, p, qid, uid)
+    return reply
+
+
+def getResponseFromHF(api, p, qid, uid):
+    response = requests.post(api, json={
+    	"data": [
+    		p,
+    		qid,
+    		uid,
+    	]
+    }).json()
+    print(response)
+    data = response["data"]
+    if (len(data) == 2):
+        return data[1]
+
+def getResponseFromDefault(api, p, qid, uid):
+    response = requests.post(api, json={
+        "p":p,
+        "qid":qid,
+        "uid":uid
+    }).json()
+    print(response)
+    data = response["data"]
+    return data["content"]
+
+def chat(api, p, qid, uid, history):
+    history = history or []
+    reply = getResponse(api, p, qid, uid)
+    history.append((p, reply))
+    return history, history
+
+gr.Interface(fn=chat,
+             theme="default",
+             css=".footer {display:none !important}",
+             inputs=["text", "text", "text", "text", "state"],
+             outputs=["chatbot", "state"],
+             title="ChatAPI Test",
+             description="""你可以通过本应用来模拟接入瀛海威广场后的效果。  
+#### 左侧：模拟来自瀛海威广场的调用              
+* api: 请填写你的机器人的 api 地址  
+当用户在广场找到你的机器人，和它说话，你的 api 将会收到如下参数的调用：  
+* p: 人们在广场里对你的机器人说话的内容  
+* qid: 当前消息的唯一标识。例如 `'bxqid-cManAtRMszw...'`。由平台生成并传递给机器人，以便机器人区分单个问题（写日志、追踪调试、异步回调等）。同步调用可忽略。  
+* uid: 用户的唯一标识。例如`'bxuid-Aj8Spso8Xsp...'`。由平台生成并传递给机器人，以便机器人区分用户。可被用于实现多轮对话的功能。  
+
+#### 右侧:对话界面  
+当你的机器人 api 返回给瀛海威广场后，瀛海威广场上的机器人和用户的对话，将会呈现如右侧的效果。    
+（瀛海威广场上的对话窗口将有 markdown 格式呈现的功能）  
+
+[参考文档](https://huggingface.co/spaces/baixing/hackathon_test/blob/main/bot-api.md)  [极简 bot 示例](https://huggingface.co/spaces/baixing/hackathon_chatbot_simple)  [Q & A](https://huggingface.co/spaces/baixing/hackathon_test/blob/main/qna.md)
+             """
+            ).launch()

bot-api.md

@@ -0,0 +1,79 @@
+<!--广场机器人 API 规范（草案）-->
+
+## 概述
+
+机器人通过 HTTP 接口的形式来提供对话服务，比如：
+
+```
+https://www.my-bot.com/api/v1/chat
+```
+
+机器人只需要实现以下任意一种接口方案，即可申请入驻广场。
+
+
+
+
+## [方案一] 标准接口
+
+**POST** `~/chat` （接口地址必须以 `chat` 结尾）
+
+请求体（JSON）：
+
+```json
+{ "p": "天空为什么是蓝色的？" }
+```
+
+请求体可能包含如下字段：
+
+字段名 | 类型 | 必填 | 含义 | 示例 | 备注
+---|---|:---:|---|---|---
+`p` | String | ✓ | 提问内容 |`'天空为什么是蓝色的？'`|`p` 表示 “prompt”
+`qid` | String |  | 平台为当前提问分配的唯一标识 |`'bxqid-cManAtRMszw...'`|由平台生成并传递给机器人，以便机器人区分单个问题（写日志、追踪调试、异步回调等）
+`uid` | String |  | 用户的唯一标识 | `'bxuid-Aj8Spso8Xsp...'` | 由平台生成并传递给机器人，以便机器人区分用户 
+
+响应体（JSON）：
+
+```js
+-{
+	"data": {
+        "type": "text",	// 也可以是 "markdown"
+		"content": "因为..."
+	}
+}
+```
+
+
+
+## [方案二] Hugging Face 风格接口
+
+**POST** `https://*.hf.space/run/predict`
+
+> 为方便 Hugging Face 开发者快速接入，特提供本方案。
+>
+> 当机器人提供的接口符合上述模式，平台会自动识别它是一个 Hugging Face 应用。
+
+请求体（JSON）：
+
+```js
+-{
+	"data": [	// 注意：这里 `data` 是一个数组
+		"天空为什么是蓝色的？",	// 相当于方案一的 `p` 字段
+		"bxqid-cManAtRMszw...",	// 相当于方案一的 `qid` 字段
+		"bxuid-Aj8Spso8Xsp..."	// 相当于方案一的 `uid` 字段
+	]
+}
+```
+
+响应体（JSON）：
+
+```js
+-{
+	"data": [	// 注意：这里 `data` 是一个数组
+		"text",	// 相当于方案一的 `type` 字段
+		"因为..."	// 相当于方案一的 `content` 字段
+	]
+}
+```
+
+
+

qna.md

@@ -0,0 +1,24 @@
+# 关于 Hackathon 的 Q&A
+
+# Q: 怎样才算是完成了一个可以参加 hackathon 的机器人？
+**A:** 只要实现了[接口文档](https://huggingface.co/spaces/baixing/hackathon_test/blob/main/bot-api.md)中的任一接口，即可将机器人接入到瀛海威广场。  
+这是一场几乎所有人都能参与的 hackathon。
+- 不会写代码的同学：只需要 duplicate [demo 程序](https://huggingface.co/spaces/baixing/hackathon_chatbot_openai_api)，修改其中的 prompt，就可以完成一个用 prompt 来定制的机器人。
+- 喜欢写代码的同学： 可进一步修改demo程序中的 chat 方法添加自己的逻辑。  
+- 更高级别的同学：可以多多尝试 Hugging Face 上的各种模型，开发出更强大的机器人。  
+
+
+# Q: 是否一定要使用 Hugging Face 的 Space
+**A:** 不需要。你完全可以在你自己的服务器上部署服务。如果在自己的服务器上部署，需要按[接口文档](https://huggingface.co/spaces/baixing/hackathon_test/blob/main/bot-api.md)中的标准接口来实现。如果是对 HF 上 demo 的  duplicate space，只需要提供默认的 api 地址即可。
+
+
+# Q: 项目是否一定要开源
+**A:** 不需要。如果是在 hugging face 上，你需要将 space 设置为 public。但你可以将代码托管在 github 上，将 github 的 token 存在 settings 中，然后 app 去 clone 该 repo。
+
+
+# Q: 我的代码准备开源，但是 openai 或 baixingai 的 apikey 不能公开呀。怎么处理？
+**A:** 你可以把 key 放在 space settings 里的 Repository secrets ，然后通过 os.getenv("key_name") 来读取。
+
+# Q: 我需要多轮对话能力，如何实现？
+**A:** 接口中的 uid 是用户的唯一标记，可以通过它查找历史对话数据。历史对话可以存在其它服务器上，也可以用本地 sqlite 的方式来读写。
+