Skip to content

Commit

Permalink
docs: 添加模型列表文档说明
Browse files Browse the repository at this point in the history
  • Loading branch information
@TBXark
TBXark committed Jan 17, 2025
1 parent ada47ae commit e38d082
Show file tree
Hide file tree
Showing 3 changed files with 125 additions and 260 deletions.
79 changes: 48 additions & 31 deletions doc/cn/CONFIG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
> IMPORTANT: 必须在botfather中设置`/setprivacy`为`Disable`，否则机器人无法响应`@机器人`的聊天消息。
> 如果您想将`DEFAULT_PARSE_MODE`设置为`MarkdownV2`，您需要使用workers-mk2版本。
#### 锁定配置 `LOCK_USER_CONFIG_KEYS`

> IMPORTANT: 如果你遇到`Key XXX is locked`的错误，说明你的配置被锁定了，需要解锁才能修改。
Expand Down Expand Up @@ -78,14 +80,16 @@ OPENAI_API_BASE,GOOGLE_COMPLETIONS_API,MISTRAL_API_BASE,COHERE_API_BASE,ANTHROPI

每个用户的自定义配置，只能通过Telegram发送消息来修改，消息格式为`/setenv KEY=VALUE`, 用户配置的优先级比系统配置的更高。如果想删除配置，请使用`/delenv KEY`。 批量设置变量请使用`/setenvs {"KEY1": "VALUE1", "KEY2": "VALUE2"}`

所有 `xxx_MODELS_LIST` 可以是一个 URL 或一个 JSON 数组字符串。当它为空时，将默认使用 `xxx__API_BASE` 拼接成 URL 并请求获取所有模型的列表。如果您想手动设置模型列表，可以使用 JSON 数组字符串。

### 通用配置

| KEY | 名称 | 默认值 | 描述 |
|------------------------------|-----------------|-------------|------------------------------------------------------------------------|
| AI_PROVIDER | AI提供商 | `auto` | 可选值 `auto, openai, azure, workers, gemini, mistral, cohere, anthropic` |
| AI_IMAGE_PROVIDER | AI图片提供商 | `auto` | 可选值 `auto, openai, azure, workers` |
| SYSTEM_INIT_MESSAGE | 全局默认初始化消息 | `你是一个得力的助手` | 根据绑定的语言自动选择默认值 |
| ~~SYSTEM_INIT_MESSAGE_ROLE~~ | ~~全局默认初始化消息角色~~ | `system` | 废弃 |
| KEY | 名称 | 默认值 | 描述 |
|------------------------------|-----------------|----------|------------------------------------------------------------------------|
| AI_PROVIDER | AI提供商 | `auto` | 可选值 `auto, openai, azure, workers, gemini, mistral, cohere, anthropic` |
| AI_IMAGE_PROVIDER | AI图片提供商 | `auto` | 可选值 `auto, openai, azure, workers` |
| SYSTEM_INIT_MESSAGE | 全局默认初始化消息 | `null` | 根据绑定的语言自动选择默认值 |
| ~~SYSTEM_INIT_MESSAGE_ROLE~~ | ~~全局默认初始化消息角色~~ | `system` | 废弃 |

### OpenAI

Expand All @@ -95,10 +99,16 @@ OPENAI_API_BASE,GOOGLE_COMPLETIONS_API,MISTRAL_API_BASE,COHERE_API_BASE,ANTHROPI
| OPENAI_CHAT_MODEL | OpenAI的模型名称 | `gpt-4o-mini` |
| OPENAI_API_BASE | OpenAI API BASE | `https://api.openai.com/v1` |
| OPENAI_API_EXTRA_PARAMS | OpenAI API Extra Params | `{}` |
| DALL_E_MODEL | DALL-E的模型名称 | `dall-e-3` |
| DALL_E_IMAGE_SIZE | DALL-E图片尺寸 | `1024x1024` |
| DALL_E_IMAGE_QUALITY | DALL-E图片质量 | `standard` |
| DALL_E_IMAGE_STYLE | DALL-E图片风格 | `vivid` |
| OPENAI_CHAT_MODELS_LIST | OpenAI 模型列表 | `''` |

### Dall-e
| KEY | Name | Default |
|----------------------|-------------|-------------|
| DALL_E_MODEL | DALL-E的模型名称 | `dall-e-3` |
| DALL_E_IMAGE_SIZE | DALL-E图片尺寸 | `1024x1024` |
| DALL_E_IMAGE_QUALITY | DALL-E图片质量 | `standard` |
| DALL_E_IMAGE_STYLE | DALL-E图片风格 | `vivid` |
| DALL_E_MODELS_LIST | DALL-E模型列表 | `''` |

### Azure OpenAI

Expand All @@ -115,16 +125,19 @@ OPENAI_API_BASE,GOOGLE_COMPLETIONS_API,MISTRAL_API_BASE,COHERE_API_BASE,ANTHROPI
| AZURE_CHAT_MODEL | Azure 对话模型 | `null` |
| AZURE_IMAGE_MODEL | Azure 图片模型 | `null` |
| AZURE_API_VERSION | Azure API 版本号 | `2024-06-01` |
| AZURE_CHAT_MODELS_LIST | Azure聊天模型列表 | `''` |


### Workers

| KEY | 名称 | 默认值 |
|--------------------------|-------------------------|------------------------------------------------------------|
| CLOUDFLARE_ACCOUNT_ID | Cloudflare Account ID | `null` |
| CLOUDFLARE_TOKEN | Cloudflare Token | `null` |
| WORKERS_CHAT_MODEL | Text Generation Model | `@cf/mistral/mistral-7b-instruct-v0.1 ` |
| WORKERS_IMAGE_MODEL | Text-to-Image Model | `@cf/stabilityai/stable-diffusion-xl-base-1.0` |
| KEY | 名称 | 默认值 |
|---------------------------|-----------------------|----------------------------------------|
| CLOUDFLARE_ACCOUNT_ID | Cloudflare Account ID | `null` |
| CLOUDFLARE_TOKEN | Cloudflare Token | `null` |
| WORKERS_CHAT_MODEL | Workers对话模型 | `@cf/qwen/qwen1.5-7b-chat-awq` |
| WORKERS_IMAGE_MODEL | Workers文生图模型 | `@cf/black-forest-labs/flux-1-schnell` |
| WORKERS_CHAT_MODELS_LIST | Workers聊天模型列表 | `''` |
| WORKERS_IMAGE_MODELS_LIST | Workers文生图模型列表 | `''` |

### Gemini

Expand All @@ -136,30 +149,34 @@ OPENAI_API_BASE,GOOGLE_COMPLETIONS_API,MISTRAL_API_BASE,COHERE_API_BASE,ANTHROPI
| ~~GOOGLE_COMPLETIONS_API~~ | ~~Google Gemini API~~ | `https://generativelanguage.googleapis.com/v1beta/models/` |
| GOOGLE_COMPLETIONS_MODEL | Google Gemini Model | `gemini-pro` |
| GOOGLE_API_BASE | 支持Openai API 格式的 Gemini API Base | `https://generativelanguage.googleapis.com/v1beta` |
| GOOGLE_CHAT_MODELS_LIST | 谷歌聊天模型列表 | `''` |

### Mistral

| KEY | 名称 | 默认值 |
|--------------------------|-------------------------|------------------------------------------------------------|
| MISTRAL_API_KEY | Mistral API Key | `null` |
| MISTRAL_API_BASE | Mistral API Base | `https://api.mistral.ai/v1` |
| MISTRAL_CHAT_MODEL | Mistral API Model | `mistral-tiny` |
| KEY | 名称 | 默认值 |
|--------------------------|-------------------|-----------------------------|
| MISTRAL_API_KEY | Mistral API Key | `null` |
| MISTRAL_API_BASE | Mistral API Base | `https://api.mistral.ai/v1` |
| MISTRAL_CHAT_MODEL | Mistral API Model | `mistral-tiny` |
| MISTRAL_CHAT_MODELS_LIST | Mistral聊天模型列表 | `''` |

### Cohere

| KEY | 名称 | 默认值 |
|--------------------------|-------------------------|------------------------------------------------------------|
| COHERE_API_KEY | Cohere API Key | `null` |
| COHERE_API_BASE | Cohere API Base | `https://api.cohere.com/v1` |
| COHERE_CHAT_MODEL | Cohere API Model | `command-r-plus` |
| KEY | 名称 | 默认值 |
|-------------------------|------------------|-----------------------------|
| COHERE_API_KEY | Cohere API Key | `null` |
| COHERE_API_BASE | Cohere API Base | `https://api.cohere.com/v1` |
| COHERE_CHAT_MODEL | Cohere API Model | `command-r-plus` |
| COHERE_CHAT_MODELS_LIST | Cohere 聊天室型号列表 | `''` |

### Anthropic

| KEY | 名称 | 默认值 |
|--------------------------|-------------------------|------------------------------------------------------------|
| ANTHROPIC_API_KEY | Anthropic API Key | `null` |
| ANTHROPIC_API_BASE | Anthropic API Base | `https://api.anthropic.com/v1` |
| ANTHROPIC_CHAT_MODEL | Anthropic API Model | `claude-3-haiku-20240307` |
| KEY | 名称 | 默认值 |
|----------------------------|---------------------|--------------------------------|
| ANTHROPIC_API_KEY | Anthropic API Key | `null` |
| ANTHROPIC_API_BASE | Anthropic API Base | `https://api.anthropic.com/v1` |
| ANTHROPIC_CHAT_MODEL | Anthropic API Model | `claude-3-haiku-20240307` |
| ANTHROPIC_CHAT_MODELS_LIST | Anthropic聊天模型列表 | `''` |

## 支持命令

Expand Down
Loading

0 comments on commit e38d082

Please sign in to comment.