Skip to content

Commit

Permalink
update (baidubce#403)
Browse files Browse the repository at this point in the history
  • Loading branch information
MrChengmo authored Jul 11, 2024
1 parent 5adb231 commit 5cf4f79
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions docs/develop_guide/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,44 @@
- 默认值: 空字符串
- 影响范围:当前终端(Terminal)运行的所有AppBuilder程序

- `SECRET_KEY_PREFIX`
- 超参说明:设置当前运行环境中AppBuilder组件(Component)的密钥前缀,SDK会自动组装最终的密钥为 `{SECRET_KEY_PREFIX} {APPBUILDER_TOKEN}`的形式,用于发起HTTP请求。常用于私有化部署的场景。
- 默认值: `Bearer`
- 影响范围:当前终端(Terminal)运行的所有AppBuilder程序

- `GATEWAY_URL`
- 超参说明:设置当前运行环境中AppBuilder组件(Component)网关的URL
- 默认值: `https://appbuilder.baidu.com`
- 影响范围:当前终端(Terminal)运行的所有AppBuilder程序中的基础组件调用请求

- `GATEWAY_URL_V2`
- 超参说明:设置当前运行环境中AppBuilder 端到端应用(AppBuilderClient)网关以及OpenAPI的URL
- 超参说明:设置当前运行环境中AppBuilder OpenAPI的URL
- 默认值: `https://qianfan.baidubce.com`
- 影响范围:当前终端(Terminal)运行的所有AppBuilder程序中的端到端应用 及 OpenAPI能力的调用
- 注意事项:当前该参数影响以下接口
- 接口:`AppBuilderClient.create_conversation`
- 接口:`AppBuilderClient.upload_local_file`
- 接口:`AppBuilderClient.run`
- `AppBuilderClient SDK` 所有接口
- `KnowledgeBase SDK` 所有接口

- `CONSOLE_OPENAPI_PREFIX`
- 超参说明:设置当前运行环境中AppBuilder OpenAPI的URL前缀,体现在`https://qianfan.baidubce.com/{custom_prefix}/v2/app/conversation`中的`{custom_prefix}`字段。常用于私有化部署的场景。
- 默认值: 空字符串
- 影响范围:当前终端(Terminal)运行的所有AppBuilder程序中的端到端应用 及 OpenAPI能力的调用
- 注意事项:当前该参数影响以下接口
- `AppBuilderClient SDK` 所有接口
- `KnowledgeBase SDK` 所有接口

- `CONSOLE_OPENAPI_VERSION`
- 超参说明:设置当前运行环境中AppBuilder OpenAPI的版本,体现在`https://qianfan.baidubce.com/{custom_prefix}/v2/app/conversation`中的`/v2`字段。常用于私有化部署的场景。
- 默认值: `v2`
- 影响范围:当前终端(Terminal)运行的所有AppBuilder程序中的端到端应用 及 OpenAPI能力的调用
- 注意事项:当前该参数影响以下接口
- `AppBuilderClient SDK` 所有接口
- `KnowledgeBase SDK` 所有接口



### 运行超参使用Tips
- 私有化环境部署时,需要同时设置私有化部署的网关地址:`GATEWAY_URL``GATEWAY_URL_V2`,且需要使用在私有化环境中可以鉴权的用户Token:`APPBUILDER_TOKEN`
- 私有化环境部署时,需要同时设置私有化部署的网关地址:`GATEWAY_URL``GATEWAY_URL_V2`,且需要使用在私有化环境中可以鉴权的用户Token:`APPBUILDER_TOKEN``SECRET_KEY_PREFIX`


## 调试超参
Expand Down

0 comments on commit 5cf4f79

Please sign in to comment.