概述
本文将介绍如何完成火山方舟高代码应用的在线创建、部署、体验和修改全流程。
对于高代码应用的介绍请参考高代码产品使用说明--火山方舟大模型服务平台-火山引擎。
方舟高代码应用基于veFaaS函数服务等多个云产品，提供了便捷的在线部署流程和生产级的运行环境。如无法满足需求，您也可以选择使用高代码应用sdk在本地或其他环境进行开发。
在线部署流程概述
一、创建高代码应用
在方舟应用实验室创建应用-创建高代码应用
1.1权限获取
- 进入高代码应用创建页时，您需具备高代码应用所需权限，将进行IAM权限校验。
- 高代码在线部署依赖veFaaS函数服务，需要授权IAM角色
SeverlessApplicationRole。 - 首次创建IAM角色需由主账号操作，如您登录的为子账号，可先点击【立即开通】，并根据提示点击【复制信息】并发送给主账号管理员，由主账号管理员创建角色并对子账号授权。
如您登录的为主账号，且已完成企业认证，
- 您可直接点击【立即开通】，进行ServerlessApplicationRole授权。
- 您也可请前往【访问控制】控制台中【角色管理】模块，进行空白角色服务新建，并在后续应用创建时，需根据提示添加权限。具体操作如下：
【新建角色】
选择信任身份类型为「服务」，选择服务为「火山方舟」，点击下一步
角色名填写：ServerlessApplicationRole，其余均不填，点击下一步
不选择策略，点击跳过，完成角色授权。
后续在高代码应用创建时，根据提示按需配置策略：CloudMonitorReadOnlyAccess，TLSFullAccess，VPCFullAccess，VeFaaSFullAccess，STSAssumeRoleAccess，APIGFullAccess
完成授权后，将提示「IAM角色已授权」
1.2云产品服务开通
- 高代码应用在线部署依赖函数服务等多个云产品提供的服务，需要开通相关云产品。
- 若存在未开通产品，可通过页面上的【立即开通】，在阅读相关协议文档后批量开通相关云产品。
- 若提示“已开通所有云服务”则代表已完成开通。
1.3创建高代码应用
填写应用名称等基础信息后，点击页面右上角保存。
保存后即可通过【立即创建】去部署高代码应用相关联的函数服务。
二、部署高代码应用
点击 应用函数【立即创建】，进行高代码应用函数服务的创建部署。
2.1所需权限及产品开通
- 若在创建高代码应用时完成了权限获取和云产品开通，应当已具备所需权限和服务。
- 若IAM角色未授权或关联云服务未开通，请联系管理员进行授权或开通，可参考权限获取。
2.2填写基础信息
- 填写应用名称、函数名称等基础信息。
2.3填写AK/SK
- API访问密钥（Access Key）是请求火山引擎API的安全凭证，包含 Access Key ID和Secret Access Key，即AK/SK。
- 需要使用您的 AK/SK 进行日志服务 Trace 和方舟模型调用鉴权，可在此获取AK/SK。
2.4选择触发器
为了在调用时触发执行函数，需要在创建函数时关联触发器，现为您提供以下类型触发器。
触发器类型 | 目标群体 | 创建流程 | 调用流程 |
|---|---|---|---|
方舟触发器（推荐使用） | 默认提供，面向无特殊要求的大部分群体。 | 创建高代码应用时选用方舟触发器，即可将函数服务关联到指定的高代码应用ID。 | 获取方舟长效/短效API key，调用时通过方舟统一域名+BotID，使用API key鉴权。 |
APIG触发器-API 网关服务 | 有独立部署网关需求 | 已有APIG：选择关联的APIG。确认部署应用后将创建关联的APIG触发器。 | 获取有效期7天的jwt token，通过APIG调用，使用jwt token鉴权。 |
2.5确认部署
- 完成以上内容的填写后，点击 确定 进行部署
- 部署需耗时约数分钟，请耐心等候。页面上将展示部署日志，若部署失败可根据日志信息定位原因。
- 部署成功后，可通过页面右上角按钮跳转到函数代码页编辑代码，或返回体验应用。
2.6关联trace日志（可选）
部署完成创建函数后，您可将函数服务关联TLS日志服务和Trace，以采集记录您的请求input和output及各阶段耗时信息。同时将产生日志服务相关费用。
您可通过日志记录查看原生打印的debug信息，通过Trace结构化分析各部分调用时间和进行错误追踪。
配置函数日志
- 进入应用对应函数的函数详情页。您可通过在应用编辑管理页点击更新代码，跳转到函数详情页。
- 在函数详情页的基础信息Tab，为函数配置日志。
- 启用日志功能，可使用默认配置。
配置trace实例
- 去日志服务控制台创建Trace实例
- 可将Trace实例配置在上述日志项目。
- 获取TLS私网访问地址和Trace日志主题id(非Trace id)
- Trace索引配置
- 在Attributes下配置二级索引request_id,client_request_id, input, output
配置环境变量
类型 | Key | Value | 作用 |
|---|---|---|---|
鉴权 | VOLC_ACCESS_KEY | 火山ak | Trace上报需要 |
VOLC_SECRET_KEY | 火山sk | Trace上报需要 | |
(Optional) EXPOSE_HEADERS | true | 透传鉴权信息。如果不开启apig鉴权需配置这一环境变量 | |
(Optional) ARK_API_KEY | 如果配置EXPOSE_HEADERS，建议配置这一环境变量为特定空值。否则sdk会根据aksk自动刷新apikey。 | ||
Trace依赖 | REGION（tls地域） | 例：cn-beijing | 配置后可查看各函数调用时间并追踪函数错误栈 |
TRACE_ENDPOINT | 例：https://tls-cn-beijing.ivolces.com:4317 | ||
TRACE_TOPIC | 例：abcd1234-12ab-1234-a1b1-123456abcdef | ||
自定义信息 | ACCOUNT_ID | 例：2100000825 | 用于设置Trace中的部分属性便于链路追踪。 |
RESOURCE_TYPE | 例：bot | ||
RESOURCE_ID | 例：browsing-pipeline |
三、修改和体验高代码应用
完成部署后，您可根据业务需求对函数代码进行修改、更新、发布。
3.1修改高代码应用
- 您可从高代码应用编辑页，点击更新代码进入函数代码管理页修改代码。
方案一：在线编辑
- 您可在线进行代码修改，按照您的配置调整各endpoint、插件参数，以进行效果和性能优化或实现业务逻辑。详见sdk说明文档 应用SDK说明文档--火山方舟大模型服务平台-火山引擎
- 您需要至少将
pipeline.yaml中预设的endpoint_id替换为您账号下的endpoint_id，方可正常调用模型推理服务。 - 完成编辑后，点击保存按钮保存代码，保存完成后可进行函数发布。
方案二：下载代码包编辑
代码包下载
您可在函数代码页下载最新版本服务对应的代码包
修改代码
- 您可在本地IDE进行代码修改，按照您的配置调整各endpoint、插件参数，以进行效果和性能优化或实现业务逻辑。
- 您需要至少将pipeline.yaml中预设的endpoint_id替换为您账号下的endpoint_id，方可正常调用模型推理服务。
详见sdk说明文档 应用SDK说明文档--火山方舟大模型服务平台-火山引擎
代码包上传和保存
将本地代码包打包为zip文件后，上传更新函数代码。
如线上预览耗时较久，可能是代码包较大。建议在本地预览后，上传到函数服务进行发布。
方案三：使用命令行工具编辑
可以联系我们获取 vefaas命令行工具使用说明文档 使用命令行工具，结合本地IDE进行代码编辑和发布等操作。
函数发布
- 完成代码修改、上传、保存后，可根据需求进行全量发布/灰度发布，并配置函数版本
建议使用灰度发布，防止变更失误影响线上服务
- 灰度发布可配置比例
可在函数详情-发布管理找到灰度发布的版本，并调整灰度比例直至全量发布。
完成发布后，可点击对话测试返回
3.2体验高代码应用
等待应用完成部署，函数完成发布。
现在，您可以在高代码应用页面上和应用交互进行体验了。
您也可以按照以上流程，继续修改优化高代码应用，让应用的表现更符合您的预期。
3.3调用和鉴权
- 方舟触发器
- 如果您配置了方舟触发器，可通过 Bot API 接口调用，使用 API key鉴权。接口文档请参见应用(Bot) API。
- APIG 触发器
- 如果您配置了 APIG 触发器，可通过您配置的 APIG 访问地址进行调用。调用时需使用 jwt token鉴权。