Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 84 additions & 16 deletions docs/content/2.configurations/1.system.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,102 @@
---
title: 配置管理系统
description: 实现自动身份管理、云上资源设施管理等
title: 配置管理
description: 通过配置文件来进行资源接入管理
navigation:
icon: i-lucide-settings
---

VeADK 内置了一套配置管理系统,您能够通过定义一个 `config.yaml` 文件来管理您的各项配置。文件中的配置项将会在运行时被自动加载为对应的环境变量
在您项目的根目录创建 `config.yaml`,VeADK 能够自动读取,并转化为环境变量

为管理配置项,VeADK 提供了根据 `config.yaml` 文件的自动化配置管理方案。您在配置文件中的所有配置将会根据层级,自动转为大写并使用下划线连接,统一注册成为运行时的环境变量。
## 最小化配置

::warning
[了解如何管理或创建方舟大模型平台 API Key](https://www.volcengine.com/docs/82379/1361424){:target="_blank"}
::

```yaml [config.yaml]
model:
agent:
# 打开注释,您可以设置用来运行 Agent 的模型名称
# 缺省模型为豆包 1.6
# name: doubao-seed-1-6-251015

# 在此处可以设置您用来运行 Agent 的模型的 API Key
api_key:
```

## 完整配置

```yaml [config.yaml]
model:
# 用于 Agent 推理的模型
agent:
name: doubao-seed-1-6-251015
api_key:
# 用于视频生成的模型
video:
name: doubao-seedance-1-0-pro-250528
# 如果您想使用另外的 API Key,可以打开下方注释
# api_key:
# 用于图片生成的模型
image:
name: doubao-seedream-4-0-250828
# 如果您想使用另外的 API Key,可以打开下方注释
# api_key:

volcengine:
access_key:
secret_key:

observability:
opentelemetry:
cozeloop:
api_key:
service_name: # CozeLoop 中的空间 ID

database:
opensearch:
host: # 请去掉 `http://` 或 `https://` 前缀
username:
password:
# OpenSearch 端口
# port: 9200
mysql:
host:
user:
password:
database:
tos:
endpoint: tos-cn-beijing.volces.com
region: cn-beijing
bucket:

logging:
# ERROR
# WARNING
# INFO
# DEBUG
level: DEBUG
```

## 配置文件到环境变量

您在配置文件中的所有配置将会根据层级,自动转为大写并使用下划线连接,统一注册成为运行时的环境变量。

例如下面的配置项:

```yaml [config.yaml]
model:
name:
api_key:
api_base:
base_a:
base_b:
...
agent:
name:
api_key:
api_base:
```

将会被转为如下几条环境变量:

```bash
MODEL_NAME=
MODEL_API_KEY=
MODEL_API_BASE_BASE_A=
MODEL_API_BASE_BASE_B=
MODEL_AGENT_NAME=
MODEL_AGENT_API_KEY=
MODEL_AGENT_API_BASE=
...
```

VeADK 中提供了 `getenv` 方法来读取相关配置,您无需在各组件中次手动传入某个配置的参数。
3 changes: 0 additions & 3 deletions veadk/consts.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,6 @@

DEFAULT_COZELOOP_SPACE_NAME = "VeADK Space"

DEFAULT_TEXT_TO_IMAGE_MODEL_NAME = "doubao-seedream-3-0-t2i-250415"
DEFAULT_TEXT_TO_IMAGE_MODEL_API_BASE = "https://ark.cn-beijing.volces.com/api/v3/"

DEFAULT_IMAGE_EDIT_MODEL_NAME = "doubao-seededit-3-0-i2i-250628"
DEFAULT_IMAGE_EDIT_MODEL_API_BASE = "https://ark.cn-beijing.volces.com/api/v3/"

Expand Down
Loading