1
0

ADD CN DOCs

This commit is contained in:
BlueSkyXN 2023-05-29 12:11:39 +08:00
parent 0c794734a2
commit 21eb753705
2 changed files with 85 additions and 2 deletions

View File

@ -3,8 +3,6 @@
本中文手册由 [@BlueSkyXN](https://github.com/BlueSkyXN) 编写
[英文文档English Docs](README.md)
## 认证和各项准备工作

View File

@ -1,3 +1,45 @@
# 中文指导手册
本中文手册由 [@BlueSkyXN](https://github.com/BlueSkyXN) 编写
[中文文档Chinese Docs](README_CN.md) [英文文档English Docs](README.md)
# 基本配置
有关docker的指导请阅读 [DOCKER中文手册](docs\Docker_CN.md)
有关Token的指导请阅读 [TOKEN中文手册](docs\TOKEN_CN.md)
## Docker-Compase配置
```
version: '3'
services:
app:
image: acheong08/chatgpt-to-api
container_name: chatgpttoapi
restart: unless-stopped
ports:
- '10080:10080'
environment:
SERVER_HOST: 0.0.0.0
SERVER_PORT: 10080
ADMIN_PASSWORD: TotallySecurePassword
API_REVERSE_PROXY: https://ai.fakeopen.com/api/conversation
PUID: user-X
```
- ports 左边是外部端口右边是内部端口内部端口要和下面环境变量的Server port一致。
- Server host/port监听配置默认0000监听某一端口。
- ADMIN_PASSWORD管理员密码HTTP请求时候需要验证。
- API_REVERSE_PROXY:接口的反向代理,具体介绍请看下文的后端代理介绍部分。
- PUID: user-X请看[中文文档Chinese Docs](README_CN.md) 的介绍
其他可以不需要设置包括预设的AccessToken和代理表、HTTP/S5代理。
# 后端代理
目前使用PUID+官网URL的方式不是很可靠建议使用第三方程序或者网站绕过这个WAF限制。
@ -37,3 +79,46 @@ curl http://127.0.0.1:8080/chatgpt/conversation \
```
如果得到缺少认证的提示比如 ```{"errorMessage":"Missing accessToken."}``` 就说明已经正常跑了
# 用例
## 基本提问
```
curl http://127.0.0.1:10080/v1/chat/completions \
-d '{
"model": "text-davinci-002-render-sha",
"messages": [{"role": "user", "content": "你是什么模型是GPT3.5吗"}]
}'
```
参考回复如下
```
{"id":"chatcmpl-QXlha2FBbmROaXhpZUFyZUF3XXXXXX","object":"chat.completion","created":0,"model":"gpt-3.5-turbo-0301","usage":{"prompt_tokens":0,"completion_tokens":0,"total_tokens":0},"choices":[{"index":0,"message":{"role":"assistant","content":"是的我是一个基于GPT-3.5架构的语言模型被称为ChatGPT。我可以回答各种问题提供信息和进行对话。尽管我会尽力提供准确和有用的回答但请记住我并不是完美的有时候可能会出现错误或者误导性的答案。"},"finish_reason":null}]}
```
请注意无论什么模型提问都只会显示为模型是GPT3.5T-0301。你在网页版看不到消息记录可能是删除了Chat不支持并发提问你需要token轮询。
## 提交Token
通过文件提交
```
curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: TotallySecurePassword" \
-d "@/root/access_tokens.json" \
http://127.0.0.1:10080/admin/tokens
```
直接提交
```
curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: TotallySecurePassword" \
-d '["eyJhbXXX"]' \
http://127.0.0.1:10080/admin/tokens
```
要清理Token直接停用删除Docker容器后重新构建运行容器即可