update README

This commit is contained in:
Vinlic 2024-03-11 18:16:43 +08:00
parent 733831668e
commit 1ffc8af307

329
README.md
View File

@ -7,12 +7,13 @@
* [声明](#声明) * [声明](#声明)
* [在线体验](#在线体验) * [在线体验](#在线体验)
* [接入准备](#接入准备) * [接入准备](#接入准备)
* [对话接口](#对话接口)
* [文档解读](#文档解读)
* [图像解析](#图像解析)
* [Docker部署](#Docker部署) * [Docker部署](#Docker部署)
* [Docker-compose部署](#Docker-compose部署) * [Docker-compose部署](#Docker-compose部署)
* [原生部署](#原生部署) * [原生部署](#原生部署)
* [接口列表](#接口列表)
* [对话补全](#对话补全)
* [文档解读](#文档解读)
* [图像解析](#图像解析)
## 声明 ## 声明
@ -40,144 +41,6 @@ https://udify.app/chat/Po0F6BMJ15q5vu2P
![example0](./doc/example-0.png) ![example0](./doc/example-0.png)
## 对话接口
目前支持与openai兼容的 `/v1/chat/completions` 接口可自行使用与openai或其他兼容的客户端接入接口或者使用dify线上服务接入使用。
POST /v1/chat/completions
header 需要设置 Authorization 头部:
```
Authorization: Bearer [refresh_token]
```
请求数据:
```json
{
"messages": [
{
"role": "user",
"content": "测试"
}
],
// 是否开启联网搜索默认false
"use_search": true,
// 如果使用SSE流请设置为true默认false
"stream": false
}
```
### 文档解读
提供一个可访问的文件URL或者BASE64_URL进行解析。
请求数据:
```json
{
"messages": [
{
"role": "user",
"content": [
{
"type": "file",
"file_url": {
"url": "https://mj101-1317487292.cos.ap-shanghai.myqcloud.com/ai/test.pdf"
}
},
{
"type": "text",
"text": "文档里说了什么?"
}
]
}
],
// 建议关闭联网搜索,防止干扰解读结果
"use_search": false
}
```
响应数据:
```json
{
"id": "cnmuo7mcp7f9hjcmihn0",
"model": "kimi",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "文档中包含了几个古代魔法咒语的例子这些咒语来自古希腊和罗马时期的魔法文本被称为PGMPapyri Graecae Magicae。以下是文档中提到的几个咒语的内容\n\n1. 第一个咒语PMG 4.1390 1495描述了一个仪式要求留下一些你吃剩的面包将其分成七块小片然后去到英雄、角斗士和那些死于非命的人被杀的地方。对面包片念咒并扔出去然后从仪式地点捡起一些被污染的泥土扔进你心仪的女人的家中之后去睡觉。咒语的内容是向命运女神Moirai、罗马的命运女神Fates和自然力量Daemons祈求希望他们帮助实现愿望。\n\n2. 第二个咒语PMG 4.1342 57是一个召唤咒语通过念出一系列神秘的名字和词语来召唤一个名为Daemon的存在以使一个名为Tereous的人由Apia所生受到精神和情感上的折磨直到她来到施法者Didymos由Taipiam所生的身边。\n\n3. 第三个咒语PGM 4.1265 74提到了一个名为NEPHERIĒRI的神秘名字这个名字与爱神阿佛洛狄忒Aphrodite有关。为了赢得一个美丽女人的心需要保持三天的纯洁献上乳香并在献祭时念出这个名字。然后在接近那位女士时心中默念这个名字七次连续七天这样做以期成功。\n\n4. 第四个咒语PGM 4.1496 1描述了在燃烧没药myrrh时念诵的咒语。这个咒语是向没药祈祷希望它能够像“肉食者”和“心灵点燃者”一样吸引一个名为[名字]的女人(她的母亲名为[名字]),让她无法安坐、饮食、注视或亲吻其他人,而是让她的心中只有施法者,直到她来到施法者身边。\n\n这些咒语反映了古代人们对魔法和超自然力量的信仰以及他们试图通过这些咒语来影响他人情感和行为的方式。"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 0
},
"created": 100920
}
```
### 图像解析
提供一个可访问的图像URL或者BASE64_URL进行解析。
此格式兼容 [gpt-4-vision-preview](https://platform.openai.com/docs/guides/vision) API格式您也可以用这个格式传送文档进行解析。
请求数据:
```json
{
"messages": [
{
"role": "user",
"content": [
{
"type": "image_url",
"image_url": {
"url": "https://www.moonshot.cn/assets/logo/normal-dark.png"
}
},
{
"type": "text",
"text": "图像描述了什么?"
}
]
}
],
// 建议关闭联网搜索,防止干扰解读结果
"use_search": false
}
```
响应数据:
```json
{
"id": "cnn6l8ilnl92l36tu8ag",
"model": "kimi",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "图像中展示了“Moonshot AI”的字样这可能是月之暗面科技有限公司Moonshot AI的标志或者品牌标识。通常这样的图像用于代表公司或产品传达品牌信息。由于图像是PNG格式它可能是一个透明背景的logo用于网站、应用程序或其他视觉材料中。"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 0
},
"created": 1710123627
}
```
## Docker部署 ## Docker部署
请准备一台具有公网IP的服务器并将8000端口开放。 请准备一台具有公网IP的服务器并将8000端口开放。
@ -269,3 +132,187 @@ pm2 reload kimi-free-api
```shell ```shell
pm2 stop kimi-free-api pm2 stop kimi-free-api
``` ```
## 接口列表
目前支持与openai兼容的 `/v1/chat/completions` 接口可自行使用与openai或其他兼容的客户端接入接口或者使用 [dify](https://dify.ai/) 等线上服务接入使用。
### 对话补全
对话补全接口与openai的 [chat-completions-api](https://platform.openai.com/docs/guides/text-generation/chat-completions-api) 兼容。
**POST /v1/chat/completions**
header 需要设置 Authorization 头部:
```
Authorization: Bearer [refresh_token]
```
请求数据:
```json
{
"messages": [
{
"role": "user",
"content": "测试"
}
],
// 是否开启联网搜索默认false
"use_search": true,
// 如果使用SSE流请设置为true默认false
"stream": false
}
```
响应数据:
```json
{
"id": "cnndivilnl96vah411dg",
"model": "kimi",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "你好我是Kimi由月之暗面科技有限公司开发的人工智能助手。我擅长中英文对话可以帮助你获取信息、解答疑问还能阅读和理解你提供的文件和网页内容。如果你有任何问题或需要帮助随时告诉我"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 0
},
"created": 1710152062
}
```
### 文档解读
提供一个可访问的文件URL或者BASE64_URL进行解析。
**POST /v1/chat/completions**
header 需要设置 Authorization 头部:
```
Authorization: Bearer [refresh_token]
```
请求数据:
```json
{
"messages": [
{
"role": "user",
"content": [
{
"type": "file",
"file_url": {
"url": "https://mj101-1317487292.cos.ap-shanghai.myqcloud.com/ai/test.pdf"
}
},
{
"type": "text",
"text": "文档里说了什么?"
}
]
}
],
// 建议关闭联网搜索,防止干扰解读结果
"use_search": false
}
```
响应数据:
```json
{
"id": "cnmuo7mcp7f9hjcmihn0",
"model": "kimi",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "文档中包含了几个古代魔法咒语的例子这些咒语来自古希腊和罗马时期的魔法文本被称为PGMPapyri Graecae Magicae。以下是文档中提到的几个咒语的内容\n\n1. 第一个咒语PMG 4.1390 1495描述了一个仪式要求留下一些你吃剩的面包将其分成七块小片然后去到英雄、角斗士和那些死于非命的人被杀的地方。对面包片念咒并扔出去然后从仪式地点捡起一些被污染的泥土扔进你心仪的女人的家中之后去睡觉。咒语的内容是向命运女神Moirai、罗马的命运女神Fates和自然力量Daemons祈求希望他们帮助实现愿望。\n\n2. 第二个咒语PMG 4.1342 57是一个召唤咒语通过念出一系列神秘的名字和词语来召唤一个名为Daemon的存在以使一个名为Tereous的人由Apia所生受到精神和情感上的折磨直到她来到施法者Didymos由Taipiam所生的身边。\n\n3. 第三个咒语PGM 4.1265 74提到了一个名为NEPHERIĒRI的神秘名字这个名字与爱神阿佛洛狄忒Aphrodite有关。为了赢得一个美丽女人的心需要保持三天的纯洁献上乳香并在献祭时念出这个名字。然后在接近那位女士时心中默念这个名字七次连续七天这样做以期成功。\n\n4. 第四个咒语PGM 4.1496 1描述了在燃烧没药myrrh时念诵的咒语。这个咒语是向没药祈祷希望它能够像“肉食者”和“心灵点燃者”一样吸引一个名为[名字]的女人(她的母亲名为[名字]),让她无法安坐、饮食、注视或亲吻其他人,而是让她的心中只有施法者,直到她来到施法者身边。\n\n这些咒语反映了古代人们对魔法和超自然力量的信仰以及他们试图通过这些咒语来影响他人情感和行为的方式。"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 0
},
"created": 100920
}
```
### 图像解析
提供一个可访问的图像URL或者BASE64_URL进行解析。
此格式兼容 [gpt-4-vision-preview](https://platform.openai.com/docs/guides/vision) API格式您也可以用这个格式传送文档进行解析。
**POST /v1/chat/completions**
header 需要设置 Authorization 头部:
```
Authorization: Bearer [refresh_token]
```
请求数据:
```json
{
"messages": [
{
"role": "user",
"content": [
{
"type": "image_url",
"image_url": {
"url": "https://www.moonshot.cn/assets/logo/normal-dark.png"
}
},
{
"type": "text",
"text": "图像描述了什么?"
}
]
}
],
// 建议关闭联网搜索,防止干扰解读结果
"use_search": false
}
```
响应数据:
```json
{
"id": "cnn6l8ilnl92l36tu8ag",
"model": "kimi",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "图像中展示了“Moonshot AI”的字样这可能是月之暗面科技有限公司Moonshot AI的标志或者品牌标识。通常这样的图像用于代表公司或产品传达品牌信息。由于图像是PNG格式它可能是一个透明背景的logo用于网站、应用程序或其他视觉材料中。"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 0
},
"created": 1710123627
}
```