File tree Expand file tree Collapse file tree 4 files changed +403
-618
lines changed
docs/content/2.configurations Expand file tree Collapse file tree 4 files changed +403
-618
lines changed Original file line number Diff line number Diff line change 11---
2- title : 配置管理系统
3- description : 实现自动身份管理、云上资源设施管理等
2+ title : 配置管理
3+ description : 通过配置文件来进行资源接入管理
44navigation :
55 icon : i-lucide-settings
66---
77
8- VeADK 内置了一套配置管理系统,您能够通过定义一个 ` config.yaml ` 文件来管理您的各项配置。文件中的配置项将会在运行时被自动加载为对应的环境变量 。
8+ 在您项目的根目录创建 ` config.yaml ` ,VeADK 能够自动读取,并转化为环境变量 。
99
10- 为管理配置项,VeADK 提供了根据 ` config.yaml ` 文件的自动化配置管理方案。您在配置文件中的所有配置将会根据层级,自动转为大写并使用下划线连接,统一注册成为运行时的环境变量。
10+ ## 最小化配置
11+
12+ :: warning
13+ [ 了解如何管理或创建方舟大模型平台 API Key] ( https://www.volcengine.com/docs/82379/1361424 ) {: target ="_ blank"}
14+ ::
15+
16+ ``` yaml [config.yaml]
17+ model :
18+ agent :
19+ # 打开注释,您可以设置用来运行 Agent 的模型名称
20+ # 缺省模型为豆包 1.6
21+ # name: doubao-seed-1-6-251015
22+
23+ # 在此处可以设置您用来运行 Agent 的模型的 API Key
24+ api_key :
25+ ` ` `
26+
27+ ## 完整配置
28+
29+ ` ` ` yaml [config.yaml]
30+ model :
31+ # 用于 Agent 推理的模型
32+ agent :
33+ name : doubao-seed-1-6-251015
34+ api_key :
35+ # 用于视频生成的模型
36+ video :
37+ name : doubao-seedance-1-0-pro-250528
38+ # 如果您想使用另外的 API Key,可以打开下方注释
39+ # api_key:
40+ # 用于图片生成的模型
41+ image :
42+ name : doubao-seedream-4-0-250828
43+ # 如果您想使用另外的 API Key,可以打开下方注释
44+ # api_key:
45+
46+ volcengine :
47+ access_key :
48+ secret_key :
49+
50+ observability :
51+ opentelemetry :
52+ cozeloop :
53+ api_key :
54+ service_name : # CozeLoop 中的空间 ID
55+
56+ database :
57+ opensearch :
58+ host : # 请去掉 `http://` 或 `https://` 前缀
59+ username :
60+ password :
61+ # OpenSearch 端口
62+ # port: 9200
63+ mysql :
64+ host :
65+ user :
66+ password :
67+ database :
68+ tos :
69+ endpoint : tos-cn-beijing.volces.com
70+ region : cn-beijing
71+ bucket :
72+
73+ logging :
74+ # ERROR
75+ # WARNING
76+ # INFO
77+ # DEBUG
78+ level : DEBUG
79+ ` ` `
80+
81+ ## 配置文件到环境变量
82+
83+ 您在配置文件中的所有配置将会根据层级,自动转为大写并使用下划线连接,统一注册成为运行时的环境变量。
1184
1285例如下面的配置项:
1386
1487` ` ` yaml [config.yaml]
1588model :
16- name :
17- api_key :
18- api_base :
19- base_a :
20- base_b :
21- ...
89+ agent :
90+ name :
91+ api_key :
92+ api_base :
2293` ` `
2394
2495将会被转为如下几条环境变量:
2596
2697` ` ` bash
27- MODEL_NAME=
28- MODEL_API_KEY=
29- MODEL_API_BASE_BASE_A=
30- MODEL_API_BASE_BASE_B=
98+ MODEL_AGENT_NAME=
99+ MODEL_AGENT_API_KEY=
100+ MODEL_AGENT_API_BASE=
31101...
32102```
33-
34- VeADK 中提供了 ` getenv ` 方法来读取相关配置,您无需在各组件中次手动传入某个配置的参数。
Original file line number Diff line number Diff line change 6262
6363DEFAULT_COZELOOP_SPACE_NAME = "VeADK Space"
6464
65- DEFAULT_TEXT_TO_IMAGE_MODEL_NAME = "doubao-seedream-3-0-t2i-250415"
66- DEFAULT_TEXT_TO_IMAGE_MODEL_API_BASE = "https://ark.cn-beijing.volces.com/api/v3/"
67-
6865DEFAULT_IMAGE_EDIT_MODEL_NAME = "doubao-seededit-3-0-i2i-250628"
6966DEFAULT_IMAGE_EDIT_MODEL_API_BASE = "https://ark.cn-beijing.volces.com/api/v3/"
7067
You can’t perform that action at this time.
0 commit comments