Skip to content

Commit fdccccd

Browse files
authored
[docs][model] refactor readme (#92)
* feat(doc): add more model info
1 parent b4d178f commit fdccccd

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.cn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Coze Loop 通过提供全生命周期的管理能力,帮助开发者更高效
5151
cd coze-loop
5252
```
5353
2. 配置模型。进入目录 `conf/default/app/runtime/`,编辑文件 `model_config.yaml`,修改 api_key 和 model 字段。以火山方舟为例:
54-
* api_key:火山方舟 API Key,获取方式可参考[获取 API Key](Keyhttps://www.volcengine.com/docs/82379/1541594)
55-
* model:火山方舟模型接入点的 Endpoint ID,获取方式可参考[获取 Endpoint](https://www.volcengine.com/docs/82379/1099522)
54+
* api_key:火山方舟 API Key。中国境内用户参考[火山方舟文档](https://www.volcengine.com/docs/82379/1541594);非中国境内的用户可参考[BytePlus ModelArk 文档](https://docs.byteplus.com/en/docs/ModelArk/1361424?utm_source=github&utm_medium=readme&utm_campaign=coze_open_source)
55+
* model:火山方舟模型接入点的 Endpoint ID。中国境内用户参考[火山方舟文档](https://www.volcengine.com/docs/82379/1099522);非中国境内的用户可参考[BytePlus ModelArk 文档](https://docs.byteplus.com/en/docs/ModelArk/1099522?utm_source=github&utm_medium=readme&utm_campaign=coze_open_source)
5656
3. 启动服务。执行以下命令,使用 Docker Compose 快速部署 Coze Loop 开源版。
5757
```Bash
5858
# 启动服务,默认为开发模式

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ Coze Loop helps developers efficiently develop and operate AI agents by providin
5353
cd coze-loop
5454
```
5555
2. Configure the model. Go to the `conf/default/app/runtime/` directory, edit the `model_config.yaml` file, and modify the `api_key` and `model` fields. Taking Volcengine Ark as an example:
56-
* `api_key`: Volcengine Ark API Key. For how to obtain it, please refer to [Get API Key](https://www.volcengine.com/docs/82379/1541594).
57-
* `model`: The Endpoint ID of the Volcengine Ark model access point. For how to obtain it, please refer to [Get Endpoint](https://www.volcengine.com/docs/82379/1099522).
56+
* `api_key`: Volcengine Ark API Key. For users in China, refer to the [Volcengine Ark document](https://www.volcengine.com/docs/82379/1541594); for users outside China, refer to the [BytePlus ModelArk document](https://docs.byteplus.com/en/docs/ModelArk/1361424?utm_source=github&utm_medium=readme&utm_campaign=coze_open_source).
57+
* `model`: The Endpoint ID of the Volcengine Ark model access point. For users in China, refer to the [Volcengine Ark document](https://www.volcengine.com/docs/82379/1099522); for users outside China, refer to the [BytePlus ModelArk document](https://docs.byteplus.com/en/docs/ModelArk/1099522?utm_source=github&utm_medium=readme&utm_campaign=coze_open_source).
5858
3. Start the service. Execute the following command to quickly deploy the Coze Loop open-source edition using Docker Compose.
5959
```Bash
6060
# Start the service, default is development mode

0 commit comments

Comments
 (0)