欢迎使用 Beacon 大模型服务平台 API。您可以通过 API 管理模型与模型制品、部署推理服务、接入外部或集群内部 AI 服务,并配置服务路由和访问权限,将大模型能力集成到自己的应用程序中。
本文档提供了 Beacon 各类 API 的功能描述、调用方式、参数说明及请求与响应示例,涵盖模型管理、推理部署、模型体验和基准测试等功能。在调用 API 之前,请先了解以下相关术语。
| 术语 | 说明 |
|---|---|
| 模型 | 用于描述 AI 模型的名称、类型、来源和能力等信息,可关联默认推理引擎与模型制品,作为部署和服务管理的基础。 |
| 模型仓库 | 用于存放和管理模型制品的存储资源,提供仓库查询与容量管理能力。 |
| 模型制品 | 可供部署使用的模型文件及其发布信息,记录文件来源、版本、存储位置和处理状态。 |
| 模型导入任务 | 将远程来源的模型文件导入模型仓库的异步任务,可查询执行进度、结果和失败原因。 |
| 模型上传 | 将客户端的模型文件上传到平台的过程,支持上传会话及进度管理,完成后可用于生成模型制品。 |
| 推理引擎 | 运行 AI 模型所需的推理运行配置,包括容器镜像、启动参数和计算资源要求。 |
| 加速器 | 为模型推理提供加速计算能力的设备资源,例如 GPU;可查询库存及相关资源信息。 |
| 容器镜像 | 封装推理服务运行环境及依赖的镜像,可用于推理引擎和模型部署。 |
| 模型部署 | 将模型制品与推理引擎组合为可运行的推理服务,管理其副本、资源配置和运行状态。 |
| AI 服务提供者 | 供模型网关调用的上游服务配置,可以接入平台外部 AI 服务,也可以接入集群内部模型部署;可配置 API 规范、访问地址和认证信息。 |
| 网关路由 | 将对外模型名称、访问域名等入口信息与一个或多个 AI 服务提供者后端关联的转发配置。 |
| 套餐 | 定义 API Key 可访问的模型网关路由,以及按周期生效的请求数和 Token 数限流。 |
| 消费者 | 通过套餐获得模型服务访问权限的调用主体,可关联用于访问网关的 API Key。 |
| API Key | 消费者访问模型网关时使用的密钥,用于识别调用方及应用套餐的路由授权和限流配置,不用于替代管理接口的登录令牌。 |
| 模型体验 | 通过交互式请求体验模型能力的功能,涵盖对话、向量、图像及音频等接口,具体能力取决于目标服务。 |
| 基准测试 | 使用平台预定义的测试方法对模型部署发起测试请求,统计响应时延、吞吐量等指标,用于评估和对比模型服务性能。 |
| 配额 | 项目可使用资源的限制,用于约束资源分配;用量用于反映已经使用的资源或服务调用情况。 |
| 命名空间 | 承载项目模型部署等运行资源的逻辑隔离空间。 |
| Token | 身份认证令牌。管理接口通过登录令牌识别用户及其项目、部门与角色;模型用量中的 Token 指模型处理的文本计量单位。 |
| 部门 | 部门是云平台中用户权限的一个划分层级,用户不能横跨多个部门。 |
| 项目 | 项目是定义资源所有权的基本单元,可理解为租户。所有资源(如云主机等)都要隶属于某个项目中。项目必须隶属于一个部门。项目名称在单个部门中的管理范围内是唯一的,但在整个云平台中可以不唯一。 |
| 用户 | 用户可以被云管理员、部门管理员创建。 用户通过登录后,可以操作云平台提供的各项资源,如云主机/云硬盘等。 |