本文主要介绍AgentSphere沙箱的整体使用流程,帮助您了解从准备到运行任务的各环节及其关系,助您快速上手。
使用流程总览
使用沙箱大致可分为三个阶段:准备、运行、清理。
图1 使用流程总览
准备阶段
- 准备沙箱模板:选择代码解释器模板或创建自定义模板,模板定义了实例的镜像、资源规格、网络配置等,是创建实例的前提。详情请参见沙箱模板概述。
沙箱模板可以分为两大类:
- 代码解释器模板:预装了Jupyter的运行环境,适合快速验证运行代码,无需额外配置,可直接使用。
- 自建模板:基于自定义镜像进行创建,适合特殊资源规格和特定网络配置的场景。
- 获取API Key:创建用于调用API和SDK的认证凭证,所有创建、连接、管理沙箱实例的操作都需要通过API Key鉴权。详情请参见API Key概述。
运行阶段
准备阶段就绪后,即可进入运行阶段:
- 创建沙箱实例
基于模板创建实例,实例将继承模板中定义的镜像、资源规格、网络配置等。创建时可覆盖模板的部分配置(如环境变量等),无需为临时调整而修改模板。详情请参见创建沙箱实例。
实例创建后自动进入运行状态,即可接受任务执行。
- 连接实例并执行任务
调用API Key通过API/SDK方式连接沙箱实例,并在沙箱中执行任务,例如执行代码、Shell命令等。
- 监控与日志
任务执行过程中,可随时查看实例的运行状态和资源使用情况,追踪操作记录,用于问题排查和性能分析。详情请参见监控与日志。
清理阶段
任务完成后,删除沙箱实例以释放资源。详情请参见删除沙箱实例。
如果沙箱实例长时间处在闲置状态,在闲置时间超过超时时间(超时时间可在模板中配置)后,系统会自动释放或休眠。
删除操作不可逆,实例内置文件系统中的数据将被清除。如需保留数据,请在删除前导出或使用外挂存储。