doc: README update for api demo

This commit is contained in:
sunyuhan
2023-05-08 15:59:15 +08:00
parent 80031f4f44
commit fe65428532
2 changed files with 64 additions and 0 deletions
+32
View File
@@ -382,6 +382,38 @@ streamlit run moss_web_demo_streamlit.py --server.port 8888 -- --model_name fnlp
python moss_web_demo_gradio.py
```
#### Api Demo
你可以运行仓库中的`moss_api_demo.py`来对外提供一个简单的api服务
```bash
python moss_api_demo.py
```
启动api服务后,您可以通过网络调用来与MOSS交互
```bash
## curl moss
curl -X POST "http://0.0.0.0:19324" \
-H 'Content-Type: application/json' \
-d '{"prompt": "你是谁?"}'
```
首次调用,您会得到一个api服务返回的uid
```json
{"response":"\n<|Worm|>: 你好,有什么我可以帮助你的吗?","history":[["你好","\n<|Worm|>: 你好,有什么我可以帮助你的吗?"]],"status":200,"time":"2023-04-28 09:43:41","uid":"10973cfc-85d4-4b7b-a56a-238f98689d47"}
```
您可以在后续的对话中填入该uid来和MOSS进行多轮对话
```bash
## curl moss multi-round
curl -X POST "http://0.0.0.0:19324" \
-H 'Content-Type: application/json' \
-d '{"prompt": "你是谁?", "uid":"10973cfc-85d4-4b7b-a56a-238f98689d47"}'
```
#### 命令行Demo
您可以运行仓库中的`moss_cli_demo.py`来启动一个简单的命令行Demo
+32
View File
@@ -377,6 +377,38 @@ Thank [Pull Request](https://github.com/OpenLMLab/MOSS/pull/25) for providing a
python moss_web_demo_gradio.py
```
#### Api Demo
You can try `moss_api_demo.py` to start an api service:
```bash
python moss_api_demo.py
```
You can chat with MOSS through api calling:
```bash
## curl moss
curl -X POST "http://0.0.0.0:19324" \
-H 'Content-Type: application/json' \
-d '{"prompt": "你是谁?"}'
```
You will get an uid at the first time you call the api:
```json
{"response":"\n<|Worm|>: 你好,有什么我可以帮助你的吗?","history":[["你好","\n<|Worm|>: 你好,有什么我可以帮助你的吗?"]],"status":200,"time":"2023-04-28 09:43:41","uid":"10973cfc-85d4-4b7b-a56a-238f98689d47"}
```
You can fill the uid if you want to have a multi-round chat will moss:
```bash
## curl moss multi-round
curl -X POST "http://0.0.0.0:19324" \
-H 'Content-Type: application/json' \
-d '{"prompt": "你是谁?", "uid":"10973cfc-85d4-4b7b-a56a-238f98689d47"}'
```
#### CLI Demo
You can try MOSS with a simple CLI demo by running `moss_cli_demo.py`: