Skip to content

Commit 66e61cd

Browse files
committed
docs(config): update config with comments
1 parent 761b033 commit 66e61cd

File tree

1 file changed

+50
-25
lines changed

1 file changed

+50
-25
lines changed

config.yaml.example

Lines changed: 50 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,61 @@
1+
# 配置文件示例
2+
# 通讯平台配置部分
13
ims:
2-
- name: "telegram-bot-1234"
3-
enable: true
4-
adapter: "telegram"
5-
config:
6-
token: "abcd"
4+
# 每个 IM 平台的具体配置
5+
- name: "telegram-bot-1234" # IM 平台实例名称
6+
enable: true # 是否启用该平台
7+
adapter: "telegram" # 使用的适配器类型
8+
config: # 平台特定的配置
9+
token: "abcd" # 平台的 API 令牌
710

11+
# 插件系统配置
812
plugins:
9-
enable: []
13+
enable: [] # 启用的插件列表
1014

15+
# Web 服务器配置
1116
web:
12-
host: "127.0.0.1"
13-
port: 8080
14-
secret_key: "please-change-this-to-a-secure-secret-key"
17+
host: "127.0.0.1" # Web 服务器监听地址
18+
port: 8080 # Web 服务器端口
19+
secret_key: "please-change-this-to-a-secure-secret-key" # Web 服务器安全密钥,请修改为安全的值
1520

21+
# LLM (大语言模型) 配置
1622
llms:
17-
api_backends:
18-
- name: "deepseek-official"
19-
adapter: "deepseek"
20-
enable: true
21-
config:
22-
api_key: "your-api-key"
23-
base_url: "https://api.deepseek.com/v1"
24-
models:
23+
api_backends: # API 后端配置列表
24+
# DeepSeek API 配置
25+
- name: "deepseek-official" # 后端名称
26+
adapter: "deepseek" # 使用的适配器
27+
enable: true # 是否启用
28+
config: # API 具体配置
29+
api_key: "your-api-key" # API 密钥
30+
base_url: "https://api.deepseek.com/v1" # API 基础 URL
31+
models: # 支持的模型列表
2532
- "deepseek-chat"
2633
- "deepseek-coder"
2734

28-
- name: "openai-gpt4"
29-
adapter: "openai"
30-
enable: true
31-
config:
32-
api_key: "your-openai-key"
33-
base_url: "https://api.openai.com/v1"
34-
models:
35+
# OpenAI API 配置
36+
- name: "openai-gpt4" # 后端名称
37+
adapter: "openai" # 使用的适配器
38+
enable: true # 是否启用
39+
config: # API 具体配置
40+
api_key: "your-openai-key" # OpenAI API 密钥
41+
base_url: "https://api.openai.com/v1" # OpenAI API 基础 URL
42+
models: # 支持的模型列表
3543
- "gpt-4"
36-
- "gpt-4-turbo"
44+
- "gpt-4-turbo"
45+
46+
# 默认配置
47+
defaults:
48+
llm_model: gemini-1.5-flash # 默认使用的 LLM 模型
49+
50+
# 记忆系统配置
51+
memory:
52+
persistence: # 持久化配置
53+
type: file # 持久化类型(支持 file 或 redis)
54+
file: # 文件存储配置
55+
storage_dir: ./data/memory # 存储目录
56+
redis: # Redis 存储配置
57+
host: localhost # Redis 主机地址
58+
port: 6379 # Redis 端口
59+
db: 0 # Redis 数据库编号
60+
max_entries: 100 # 最大记忆条目数
61+
default_scope: member # 默认记忆作用域

0 commit comments

Comments
 (0)