Skip to content

Commit e663364

Browse files
authored
Merge pull request #2609 from 6vision/master
docs: update README.md
2 parents 1e80c59 + ef6466e commit e663364

File tree

3 files changed

+288
-5
lines changed

3 files changed

+288
-5
lines changed

README.md

Lines changed: 286 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,7 @@ volumes:
276276
## 模型说明
277277

278278
以下对所有可支持的模型的配置和使用方法进行说明,模型接口实现在项目的 `bot/` 目录下。
279+
>部分模型厂商接入有官方sdk和OpenAI兼容两种方式,建议使用OpenAI兼容的方式。
279280
280281
<details>
281282
<summary>OpenAI</summary>
@@ -288,12 +289,14 @@ volumes:
288289
{
289290
"model": "gpt-4.1-mini",
290291
"open_ai_api_key": "YOUR_API_KEY",
291-
"open_ai_api_base": "https://api.openai.com/v1"
292+
"open_ai_api_base": "https://api.openai.com/v1",
293+
"bot_type": "chatGPT"
292294
}
293295
```
294296

295-
- `model`: 与OpenAI接口的model参数一致,支持包括 gpt-4.1系列, gpt-4o系列, o系列模型
297+
- `model`: 与OpenAI接口的 [model参数](https://platform.openai.com/docs/models) 一致,支持包括 o系列、gpt-4系列、gpt-3.5系列等模型
296298
- `open_ai_api_base`: 如果需要接入第三方代理接口,可通过修改该参数进行接入
299+
- `bot_type`: 使用OpenAI相关模型时无需填写。当使用第三方代理接口接入Claude等非OpenAI官方模型时,该参数设为 `chatGPT`
297300
</details>
298301

299302
<details>
@@ -317,7 +320,287 @@ volumes:
317320
+ `model`: model字段填写空则直接使用智能体的模型,可在平台中灵活切换,[模型列表](https://link-ai.tech/console/models)中的全部模型均可使用
318321
</details>
319322

320-
更多模型说明:Coming soon...
323+
<details>
324+
<summary>DeepSeek</summary>
325+
326+
1. API Key创建:在 [DeepSeek平台](https://platform.deepseek.com/api_keys) 创建API Key
327+
328+
2. 填写配置
329+
330+
```json
331+
{
332+
"bot_type": "chatGPT",
333+
"model": "deepseek-chat",
334+
"open_ai_api_key": "sk-xxxxxxxxxxx",
335+
"open_ai_api_base": "https://api.deepseek.com/v1"
336+
}
337+
```
338+
339+
- `bot_type`: OpenAI兼容方式
340+
- `model`: 可填 `deepseek-chat、deepseek-reasoner`,分别对应的是 V3 和 R1 模型
341+
- `open_ai_api_key`: DeepSeek平台的 API Key
342+
- `open_ai_api_base`: DeepSeek平台 BASE URL
343+
</details>
344+
345+
<details>
346+
<summary>Azure</summary>
347+
348+
1. API Key创建:在 [DeepSeek平台](https://platform.deepseek.com/api_keys) 创建API Key
349+
350+
2. 填写配置
351+
352+
```json
353+
{
354+
"model": "",
355+
"use_azure_chatgpt": true,
356+
"open_ai_api_key": "e7ffc5dd84f14521a53f14a40231ea78",
357+
"open_ai_api_base": "https://linkai-240917.openai.azure.com/",
358+
"azure_deployment_id": "gpt-4.1",
359+
"azure_api_version": "2025-01-01-preview"
360+
}
361+
```
362+
363+
- `model`: 留空即可
364+
- `use_azure_chatgpt`: 设为 true
365+
- `open_ai_api_key`: Azure平台的密钥
366+
- `open_ai_api_base`: Azure平台的 BASE URL
367+
- `azure_deployment_id`: Azure平台部署的模型名称
368+
- `azure_api_version`: api版本以及以上参数可以在部署的 [模型配置](https://oai.azure.com/resource/deployments) 界面查看
369+
</details>
370+
371+
<details>
372+
<summary>Claude</summary>
373+
374+
1. API Key创建:在 [Claude控制台](https://console.anthropic.com/settings/keys) 创建API Key
375+
376+
2. 填写配置
377+
378+
```json
379+
{
380+
"model": "claude-sonnet-4-0",
381+
"claude_api_key": "YOUR_API_KEY"
382+
}
383+
```
384+
- `model`: 参考 [官方模型ID](https://docs.anthropic.com/en/docs/about-claude/models/overview#model-aliases) ,例如`claude-opus-4-0``claude-3-7-sonnet-latest`
385+
</details>
386+
387+
<details>
388+
<summary>通义千问</summary>
389+
390+
方式一:官方SDK接入,配置如下:
391+
392+
```json
393+
{
394+
"model": "qwen-turbo",
395+
"dashscope_api_key": "sk-qVxxxxG"
396+
}
397+
```
398+
- `model`: 可填写`qwen-turbo、qwen-plus、qwen-max`
399+
- `dashscope_api_key`: 通义千问的 API-KEY,参考 [官方文档](https://bailian.console.aliyun.com/?tab=api#/api) ,在 [控制台](https://bailian.console.aliyun.com/?tab=model#/api-key) 创建
400+
401+
方式二:OpenAI兼容方式接入,配置如下:
402+
```json
403+
{
404+
"bot_type": "chatGPT",
405+
"model": "qwen-turbo",
406+
"open_ai_api_base": "https://dashscope.aliyuncs.com/compatible-mode/v1",
407+
"open_ai_api_key": "sk-qVxxxxG"
408+
}
409+
```
410+
- `bot_type`: OpenAI兼容方式
411+
- `model`: 支持官方所有模型,参考[模型列表](https://help.aliyun.com/zh/model-studio/models?spm=a2c4g.11186623.0.0.78d84823Kth5on#9f8890ce29g5u)
412+
- `open_ai_api_base`: 通义千问API的 BASE URL
413+
- `open_ai_api_key`: 通义千问的 API-KEY,参考 [官方文档](https://bailian.console.aliyun.com/?tab=api#/api) ,在 [控制台](https://bailian.console.aliyun.com/?tab=model#/api-key) 创建
414+
</details>
415+
416+
<details>
417+
<summary>Gemini</summary>
418+
419+
API Key创建:在 [控制台](https://aistudio.google.com/app/apikey?hl=zh-cn) 创建API Key ,配置如下
420+
```json
421+
{
422+
"model": "gemini-2.5-pro",
423+
"gemini_api_key": ""
424+
}
425+
```
426+
- `model`: 参考[官方文档-模型列表](https://ai.google.dev/gemini-api/docs/models?hl=zh-cn)
427+
</details>
428+
429+
<details>
430+
<summary>Moonshot</summary>
431+
432+
方式一:官方接入,配置如下:
433+
434+
```json
435+
{
436+
"model": "moonshot-v1-8k",
437+
"moonshot_api_key": "moonshot-v1-8k"
438+
}
439+
```
440+
- `model`: 可填写`moonshot-v1-8k、 moonshot-v1-32k、 moonshot-v1-128k`
441+
- `moonshot_api_key`: Moonshot的API-KEY,在 [控制台](https://platform.moonshot.cn/console/api-keys) 创建
442+
443+
方式二:OpenAI兼容方式接入,配置如下:
444+
```json
445+
{
446+
"bot_type": "chatGPT",
447+
"model": "moonshot-v1-8k",
448+
"open_ai_api_base": "https://api.moonshot.cn/v1",
449+
"open_ai_api_key": ""
450+
}
451+
```
452+
- `bot_type`: OpenAI兼容方式
453+
- `model`: 可填写`moonshot-v1-8k、 moonshot-v1-32k、 moonshot-v1-128k`
454+
- `open_ai_api_base`: Moonshot的 BASE URL
455+
- `open_ai_api_key`: Moonshot的 API-KEY,在 [控制台](https://platform.moonshot.cn/console/api-keys) 创建
456+
</details>
457+
458+
<details>
459+
<summary>百度文心</summary>
460+
方式一:官方SDK接入,配置如下:
461+
462+
```json
463+
{
464+
"model": "wenxin",
465+
"baidu_wenxin_api_key": "IajztZ0bDxgnP9bEykU7lBer",
466+
"baidu_wenxin_secret_key": "EDPZn6L24uAS9d8RWFfotK47dPvkjD6G"
467+
}
468+
```
469+
- `model`: 可填 `wenxin``wenxin-4`,对应模型为 文心-3.5 和 文心-4.0
470+
- `baidu_wenxin_api_key`:参考 [千帆平台-access_token鉴权](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/dlv4pct3s) 文档获取 API Key
471+
- `baidu_wenxin_secret_key`:参考 [千帆平台-access_token鉴权](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/dlv4pct3s) 文档获取 Secret Key
472+
473+
方式二:OpenAI兼容方式接入,配置如下:
474+
```json
475+
{
476+
"bot_type": "chatGPT",
477+
"model": "qwen-turbo",
478+
"open_ai_api_base": "https://qianfan.baidubce.com/v2",
479+
"open_ai_api_key": "bce-v3/ALTxxxxxxd2b"
480+
}
481+
```
482+
- `bot_type`: OpenAI兼容方式
483+
- `model`: 支持官方所有模型,参考[模型列表](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Wm9cvy6rl)
484+
- `open_ai_api_base`: 百度文心API的 BASE URL
485+
- `open_ai_api_key`: 百度文心的 API-KEY,参考 [官方文档](https://cloud.baidu.com/doc/qianfan-api/s/ym9chdsy5) ,在 [控制台](https://console.bce.baidu.com/iam/#/iam/apikey/list) 创建API Key
486+
487+
</details>
488+
489+
<details>
490+
<summary>讯飞星火</summary>
491+
492+
方式一:官方接入,配置如下:
493+
参考 [官方文档-快速指引](https://www.xfyun.cn/doc/platform/quickguide.html#%E7%AC%AC%E4%BA%8C%E6%AD%A5-%E5%88%9B%E5%BB%BA%E6%82%A8%E7%9A%84%E7%AC%AC%E4%B8%80%E4%B8%AA%E5%BA%94%E7%94%A8-%E5%BC%80%E5%A7%8B%E4%BD%BF%E7%94%A8%E6%9C%8D%E5%8A%A1) 获取 `APPID、 APISecret、 APIKey` 三个参数
494+
495+
```json
496+
{
497+
"model": "xunfei",
498+
"xunfei_app_id": "",
499+
"xunfei_api_key": "",
500+
"xunfei_api_secret": "",
501+
"xunfei_domain": "4.0Ultra",
502+
"xunfei_spark_url": "wss://spark-api.xf-yun.com/v4.0/chat"
503+
}
504+
```
505+
- `model`: 填 `xunfei`
506+
- `xunfei_domain`: 可填写 `4.0Ultra、 generalv3.5、 max-32k、 generalv3、 pro-128k、 lite`
507+
- `xunfei_spark_url`: 填写参考 [官方文档-请求地址](https://www.xfyun.cn/doc/spark/Web.html#_1-1-%E8%AF%B7%E6%B1%82%E5%9C%B0%E5%9D%80) 的说明
508+
509+
方式二:OpenAI兼容方式接入,配置如下:
510+
```json
511+
{
512+
"bot_type": "chatGPT",
513+
"model": "4.0Ultra",
514+
"open_ai_api_base": "https://spark-api-open.xf-yun.com/v1",
515+
"open_ai_api_key": ""
516+
}
517+
```
518+
- `bot_type`: OpenAI兼容方式
519+
- `model`: 可填写 `4.0Ultra、 generalv3.5、 max-32k、 generalv3、 pro-128k、 lite`
520+
- `open_ai_api_base`: 讯飞星火平台的 BASE URL
521+
- `open_ai_api_key`: 讯飞星火平台的[APIPassword](https://console.xfyun.cn/services/bm3) ,因模型而已
522+
</details>
523+
524+
<details>
525+
<summary>智谱AI</summary>
526+
527+
方式一:官方接入,配置如下:
528+
529+
```json
530+
{
531+
"model": "glm-4-plus",
532+
"zhipu_ai_api_key": ""
533+
}
534+
```
535+
- `model`: 可填 `glm-4-plus、glm-4-air-250414、glm-4-airx、glm-4-long 、glm-4-flashx 、glm-4-flash-250414`, 参考 [glm-4系列模型编码](https://bigmodel.cn/dev/api/normal-model/glm-4)
536+
- `zhipu_ai_api_key`: 智谱AI平台的 API KEY,在 [控制台](https://www.bigmodel.cn/usercenter/proj-mgmt/apikeys) 创建
537+
538+
方式二:OpenAI兼容方式接入,配置如下:
539+
```json
540+
{
541+
"bot_type": "chatGPT",
542+
"model": "glm-4-plus",
543+
"open_ai_api_base": "https://open.bigmodel.cn/api/paas/v4",
544+
"open_ai_api_key": ""
545+
}
546+
```
547+
- `bot_type`: OpenAI兼容方式
548+
- `model`: 可填 `glm-4-plus、glm-4-air-250414、glm-4-airx、glm-4-long 、glm-4-flashx 、glm-4-flash-250414`, 参考 [glm-4系列模型编码](https://bigmodel.cn/dev/api/normal-model/glm-4)
549+
- `open_ai_api_base`: 智谱AI平台的 BASE URL
550+
- `open_ai_api_key`: 智谱AI平台的 API KEY,在 [控制台](https://www.bigmodel.cn/usercenter/proj-mgmt/apikeys) 创建
551+
</details>
552+
553+
<details>
554+
<summary>MiniMax</summary>
555+
556+
方式一:官方接入,配置如下:
557+
558+
```json
559+
{
560+
"model": "abab6.5-chat",
561+
"Minimax_api_key": "",
562+
"Minimax_group_id": ""
563+
}
564+
```
565+
- `model`: 可填写`abab6.5-chat`
566+
- `Minimax_api_key`:MiniMax平台的API-KEY,在 [控制台](https://platform.minimaxi.com/user-center/basic-information/interface-key) 创建
567+
- `Minimax_group_id`: 在 [账户信息](https://platform.minimaxi.com/user-center/basic-information) 右上角获取
568+
569+
方式二:OpenAI兼容方式接入,配置如下:
570+
```json
571+
{
572+
"bot_type": "chatGPT",
573+
"model": "MiniMax-M1",
574+
"open_ai_api_base": "https://api.minimaxi.com/v1",
575+
"open_ai_api_key": ""
576+
}
577+
```
578+
- `bot_type`: OpenAI兼容方式
579+
- `model`: 可填`MiniMax-M1、MiniMax-Text-01`,参考[API文档](https://platform.minimaxi.com/document/%E5%AF%B9%E8%AF%9D?key=66701d281d57f38758d581d0#QklxsNSbaf6kM4j6wjO5eEek)
580+
- `open_ai_api_base`: MiniMax平台API的 BASE URL
581+
- `open_ai_api_key`: MiniMax平台的API-KEY,在 [控制台](https://platform.minimaxi.com/user-center/basic-information/interface-key) 创建
582+
</details>
583+
584+
<details>
585+
<summary>ModelScope</summary>
586+
587+
```json
588+
{
589+
"bot_type": "modelscope",
590+
"model": "Qwen/QwQ-32B",
591+
"modelscope_api_key": "your_api_key",
592+
"modelscope_base_url": "https://api-inference.modelscope.cn/v1/chat/completions",
593+
"text_to_image": "MusePublic/489_ckpt_FLUX_1"
594+
}
595+
```
596+
597+
- `bot_type`: modelscope接口格式
598+
- `model`: 参考[模型列表](https://www.modelscope.cn/models?filter=inference_type&page=1)
599+
- `modelscope_api_key`: 参考 [官方文档-访问令牌](https://modelscope.cn/docs/accounts/token) ,在 [控制台](https://modelscope.cn/my/myaccesstoken)
600+
- `modelscope_base_url`: modelscope平台的 BASE URL
601+
- `text_to_image`: 图像生成模型,参考[模型列表](https://www.modelscope.cn/models?filter=inference_type&page=1)
602+
</details>
603+
321604

322605
## 通道说明
323606

bot/chatgpt/chat_gpt_bot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def reply_text(self, session: ChatGPTSession, api_key=None, args=None, retry_cou
130130
args = self.args
131131
response = openai.ChatCompletion.create(api_key=api_key, messages=session.messages, **args)
132132
# logger.debug("[CHATGPT] response={}".format(response))
133-
# logger.info("[ChatGPT] reply={}, total_tokens={}".format(response.choices[0]['message']['content'], response["usage"]["total_tokens"]))
133+
logger.info("[ChatGPT] reply={}, total_tokens={}".format(response.choices[0]['message']['content'], response["usage"]["total_tokens"]))
134134
return {
135135
"total_tokens": response["usage"]["total_tokens"],
136136
"completion_tokens": response["usage"]["completion_tokens"],

requirements-optional.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ websocket-client==1.2.0
2828
# claude bot
2929
curl_cffi
3030
# claude API
31-
anthropic
31+
anthropic==0.25.0
3232

3333
# tongyi qwen
3434
broadscope_bailian

0 commit comments

Comments
 (0)