mirror of
https://github.com/LLM-Red-Team/kimi-free-api.git
synced 2024-12-23 08:49:20 +08:00
492 lines
16 KiB
Markdown
492 lines
16 KiB
Markdown
# KIMI AI Free 服务
|
||
|
||
|
||
<hr>
|
||
|
||
<span>[ 中文 | <a href="README_EN.md">English</a> ]</span>
|
||
|
||
|
||
[](LICENSE)
|
||
|
||
|
||
|
||
|
||
支持高速流式输出、支持多轮对话、支持联网搜索、支持长文档解读、支持图像解析，零配置部署，多路token支持，自动清理会话痕迹。
|
||
|
||
与ChatGPT接口完全兼容。
|
||
|
||
还有以下六个free-api欢迎关注：
|
||
|
||
阶跃星辰 (跃问StepChat) 接口转API [step-free-api](https://github.com/LLM-Red-Team/step-free-api)
|
||
|
||
阿里通义 (Qwen) 接口转API [qwen-free-api](https://github.com/LLM-Red-Team/qwen-free-api)
|
||
|
||
智谱AI (智谱清言) 接口转API [glm-free-api](https://github.com/LLM-Red-Team/glm-free-api)
|
||
|
||
秘塔AI (Metaso) 接口转API [metaso-free-api](https://github.com/LLM-Red-Team/metaso-free-api)
|
||
|
||
讯飞星火（Spark）接口转API [spark-free-api](https://github.com/LLM-Red-Team/spark-free-api)
|
||
|
||
聆心智能 (Emohaa) 接口转API [emohaa-free-api](https://github.com/LLM-Red-Team/emohaa-free-api)
|
||
|
||
## 目录
|
||
|
||
* [免责声明](#免责声明)
|
||
* [在线体验](#在线体验)
|
||
* [效果示例](#效果示例)
|
||
* [接入准备](#接入准备)
|
||
* [多账号接入](#多账号接入)
|
||
* [Docker部署](#Docker部署)
|
||
* [Docker-compose部署](#Docker-compose部署)
|
||
* [Render部署](#Render部署)
|
||
* [Vercel部署](#Vercel部署)
|
||
* [Zeabur部署](#Zeabur部署)
|
||
* [原生部署](#原生部署)
|
||
* [推荐使用客户端](#推荐使用客户端)
|
||
* [接口列表](#接口列表)
|
||
* [对话补全](#对话补全)
|
||
* [文档解读](#文档解读)
|
||
* [图像解析](#图像解析)
|
||
* [refresh_token存活检测](#refresh_token存活检测)
|
||
* [注意事项](#注意事项)
|
||
* [Nginx反代优化](#Nginx反代优化)
|
||
* [Token统计](#Token统计)
|
||
* [Star History](#star-history)
|
||
|
||
## 免责声明
|
||
|
||
**逆向API是不稳定的，建议前往MoonshotAI官方 https://platform.moonshot.cn/ 付费使用API，避免封禁的风险。**
|
||
|
||
**本组织和个人不接受任何资金捐助和交易，此项目是纯粹研究交流学习性质！**
|
||
|
||
**仅限自用，禁止对外提供服务或商用，避免对官方造成服务压力，否则风险自担！**
|
||
|
||
**仅限自用，禁止对外提供服务或商用，避免对官方造成服务压力，否则风险自担！**
|
||
|
||
**仅限自用，禁止对外提供服务或商用，避免对官方造成服务压力，否则风险自担！**
|
||
|
||
## 在线体验
|
||
|
||
此链接仅临时测试功能，不可长期使用，长期使用请自行部署。
|
||
|
||
https://udify.app/chat/Po0F6BMJ15q5vu2P
|
||
|
||
## 效果示例
|
||
|
||
### 验明正身Demo
|
||
|
||
|
||
|
||
### 多轮对话Demo
|
||
|
||
|
||
|
||
### 联网搜索Demo
|
||
|
||
|
||
|
||
### 长文档解读Demo
|
||
|
||
|
||
|
||
### 图像解析Demo
|
||
|
||
|
||
|
||
### 响应流畅度一致
|
||
|
||
|
||
|
||
## 接入准备
|
||
|
||
从 [kimi.moonshot.cn](https://kimi.moonshot.cn) 获取refresh_token
|
||
|
||
进入kimi随便发起一个对话，然后F12打开开发者工具，从Application > Local Storage中找到`refresh_token`的值，这将作为Authorization的Bearer Token值：`Authorization: Bearer TOKEN`
|
||
|
||
|
||
|
||
如果你看到的`refresh_token`是一个数组，请使用`.`拼接起来再使用。
|
||
|
||
|
||
|
||
### 多账号接入
|
||
|
||
目前kimi限制普通账号每3小时内只能进行30轮长文本的问答（短文本不限），你可以通过提供多个账号的refresh_token并使用`,`拼接提供：
|
||
|
||
`Authorization: Bearer TOKEN1,TOKEN2,TOKEN3`
|
||
|
||
每次请求服务会从中挑选一个。
|
||
|
||
## Docker部署
|
||
|
||
请准备一台具有公网IP的服务器并将8000端口开放。
|
||
|
||
拉取镜像并启动服务
|
||
|
||
```shell
|
||
docker run -it -d --init --name kimi-free-api -p 8000:8000 -e TZ=Asia/Shanghai vinlic/kimi-free-api:latest
|
||
```
|
||
|
||
查看服务实时日志
|
||
|
||
```shell
|
||
docker logs -f kimi-free-api
|
||
```
|
||
|
||
重启服务
|
||
|
||
```shell
|
||
docker restart kimi-free-api
|
||
```
|
||
|
||
停止服务
|
||
|
||
```shell
|
||
docker stop kimi-free-api
|
||
```
|
||
|
||
### Docker-compose部署
|
||
|
||
```yaml
|
||
version: '3'
|
||
|
||
services:
|
||
kimi-free-api:
|
||
container_name: kimi-free-api
|
||
image: vinlic/kimi-free-api:latest
|
||
restart: always
|
||
ports:
|
||
- "8000:8000"
|
||
environment:
|
||
- TZ=Asia/Shanghai
|
||
```
|
||
|
||
### Render部署
|
||
|
||
**注意：部分部署区域可能无法连接kimi，如容器日志出现请求超时或无法连接（新加坡实测不可用）请切换其他区域部署！**
|
||
**注意：免费账户的容器实例将在一段时间不活动时自动停止运行，这会导致下次请求时遇到50秒或更长的延迟，建议查看[Render容器保活](https://github.com/LLM-Red-Team/free-api-hub/#Render%E5%AE%B9%E5%99%A8%E4%BF%9D%E6%B4%BB)**
|
||
|
||
1. fork本项目到你的github账号下。
|
||
|
||
2. 访问 [Render](https://dashboard.render.com/) 并登录你的github账号。
|
||
|
||
3. 构建你的 Web Service（New+ -> Build and deploy from a Git repository -> Connect你fork的项目 -> 选择部署区域 -> 选择实例类型为Free -> Create Web Service）。
|
||
|
||
4. 等待构建完成后，复制分配的域名并拼接URL访问即可。
|
||
|
||
### Vercel部署
|
||
|
||
**注意：Vercel免费账户的请求响应超时时间为10秒，但接口响应通常较久，可能会遇到Vercel返回的504超时错误！**
|
||
|
||
请先确保安装了Node.js环境。
|
||
|
||
```shell
|
||
npm i -g vercel --registry http://registry.npmmirror.com
|
||
vercel login
|
||
git clone https://github.com/LLM-Red-Team/kimi-free-api
|
||
cd kimi-free-api
|
||
vercel --prod
|
||
```
|
||
|
||
### Zeabur部署
|
||
|
||
**注意：免费账户的容器实例可能无法稳定运行**
|
||
|
||
[](https://zeabur.com/templates/GRFYBP)
|
||
|
||
## 原生部署
|
||
|
||
请准备一台具有公网IP的服务器并将8000端口开放。
|
||
|
||
请先安装好Node.js环境并且配置好环境变量，确认node命令可用。
|
||
|
||
安装依赖
|
||
|
||
```shell
|
||
npm i
|
||
```
|
||
|
||
安装PM2进行进程守护
|
||
|
||
```shell
|
||
npm i -g pm2
|
||
```
|
||
|
||
编译构建，看到dist目录就是构建完成
|
||
|
||
```shell
|
||
npm run build
|
||
```
|
||
|
||
启动服务
|
||
|
||
```shell
|
||
pm2 start dist/index.js --name "kimi-free-api"
|
||
```
|
||
|
||
查看服务实时日志
|
||
|
||
```shell
|
||
pm2 logs kimi-free-api
|
||
```
|
||
|
||
重启服务
|
||
|
||
```shell
|
||
pm2 reload kimi-free-api
|
||
```
|
||
|
||
停止服务
|
||
|
||
```shell
|
||
pm2 stop kimi-free-api
|
||
```
|
||
|
||
## 推荐使用客户端
|
||
|
||
使用以下二次开发客户端接入free-api系列项目更快更简单，支持文档/图像上传！
|
||
|
||
由 [Clivia](https://github.com/Yanyutin753/lobe-chat) 二次开发的LobeChat [https://github.com/Yanyutin753/lobe-chat](https://github.com/Yanyutin753/lobe-chat)
|
||
|
||
由 [时光@](https://github.com/SuYxh) 二次开发的ChatGPT Web [https://github.com/SuYxh/chatgpt-web-sea](https://github.com/SuYxh/chatgpt-web-sea)
|
||
|
||
## 接口列表
|
||
|
||
目前支持与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
|
||
{
|
||
// 模型名称随意填写，如果不希望输出检索过程模型名称请包含silent_search
|
||
"model": "kimi",
|
||
// 目前多轮对话基于消息合并实现，某些场景可能导致能力下降且受单轮最大Token数限制
|
||
// 如果您想获得原生的多轮对话体验，可以传入首轮消息获得的id，来接续上下文，注意如果使用这个，首轮必须传none，否则第二轮会空响应！
|
||
// "conversation_id": "cnndivilnl96vah411dg",
|
||
"messages": [
|
||
{
|
||
"role": "user",
|
||
"content": "测试"
|
||
}
|
||
],
|
||
// 是否开启联网搜索，默认false
|
||
"use_search": true,
|
||
// 如果使用SSE流请设置为true，默认false
|
||
"stream": false
|
||
}
|
||
```
|
||
|
||
响应数据：
|
||
```json
|
||
{
|
||
// 如果想获得原生多轮对话体验，此id，你可以传入到下一轮对话的conversation_id来接续上下文
|
||
"id": "cnndivilnl96vah411dg",
|
||
"model": "kimi",
|
||
"object": "chat.completion",
|
||
"choices": [
|
||
{
|
||
"index": 0,
|
||
"message": {
|
||
"role": "assistant",
|
||
"content": "你好！我是Kimi，由月之暗面科技有限公司开发的人工智能助手。我擅长中英文对话，可以帮助你获取信息、解答疑问，还能阅读和理解你提供的文件和网页内容。如果你有任何问题或需要帮助，随时告诉我！"
|
||
},
|
||
"finish_reason": "stop"
|
||
}
|
||
],
|
||
"usage": {
|
||
"prompt_tokens": 1,
|
||
"completion_tokens": 1,
|
||
"total_tokens": 2
|
||
},
|
||
"created": 1710152062
|
||
}
|
||
```
|
||
|
||
### 文档解读
|
||
|
||
提供一个可访问的文件URL或者BASE64_URL进行解析。
|
||
|
||
**POST /v1/chat/completions**
|
||
|
||
header 需要设置 Authorization 头部：
|
||
|
||
```
|
||
Authorization: Bearer [refresh_token]
|
||
```
|
||
|
||
请求数据：
|
||
```json
|
||
{
|
||
// 模型名称随意填写，如果不希望输出检索过程模型名称请包含silent_search
|
||
"model": "kimi",
|
||
"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": "文档中包含了几个古代魔法咒语的例子，这些咒语来自古希腊和罗马时期的魔法文本，被称为PGM（Papyri 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": 1,
|
||
"completion_tokens": 1,
|
||
"total_tokens": 2
|
||
},
|
||
"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
|
||
{
|
||
// 模型名称随意填写，如果不希望输出检索过程模型名称请包含silent_search
|
||
"model": "kimi",
|
||
"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": 1,
|
||
"completion_tokens": 1,
|
||
"total_tokens": 2
|
||
},
|
||
"created": 1710123627
|
||
}
|
||
```
|
||
|
||
### refresh_token存活检测
|
||
|
||
检测refresh_token是否存活，如果存活live为true，否则为false，请不要频繁（小于10分钟）调用此接口。
|
||
|
||
**POST /token/check**
|
||
|
||
请求数据：
|
||
```json
|
||
{
|
||
"token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9..."
|
||
}
|
||
```
|
||
|
||
响应数据：
|
||
```json
|
||
{
|
||
"live": true
|
||
}
|
||
```
|
||
|
||
## 注意事项
|
||
|
||
### Nginx反代优化
|
||
|
||
如果您正在使用Nginx反向代理kimi-free-api，请添加以下配置项优化流的输出效果，优化体验感。
|
||
|
||
```nginx
|
||
# 关闭代理缓冲。当设置为off时，Nginx会立即将客户端请求发送到后端服务器，并立即将从后端服务器接收到的响应发送回客户端。
|
||
proxy_buffering off;
|
||
# 启用分块传输编码。分块传输编码允许服务器为动态生成的内容分块发送数据，而不需要预先知道内容的大小。
|
||
chunked_transfer_encoding on;
|
||
# 开启TCP_NOPUSH，这告诉Nginx在数据包发送到客户端之前，尽可能地发送数据。这通常在sendfile使用时配合使用，可以提高网络效率。
|
||
tcp_nopush on;
|
||
# 开启TCP_NODELAY，这告诉Nginx不延迟发送数据，立即发送小数据包。在某些情况下，这可以减少网络的延迟。
|
||
tcp_nodelay on;
|
||
# 设置保持连接的超时时间，这里设置为120秒。如果在这段时间内，客户端和服务器之间没有进一步的通信，连接将被关闭。
|
||
keepalive_timeout 120;
|
||
```
|
||
|
||
### Token统计
|
||
|
||
由于推理侧不在kimi-free-api，因此token不可统计，将以固定数字返回!!!!!
|
||
|
||
## Star History
|
||
|
||
[](https://star-history.com/#LLM-Red-Team/kimi-free-api&Date)
|