API 接口文档

把模型质量检查嵌进你的 CI 流程。企业版及以上档位可在控制台创建应用获取密钥。

调用约定

  • 请求方式：全部接口统一使用 POST，参数放在 JSON body 中。
  • 鉴权：请求头带 Authorization: Bearer <api_key>。
  • 响应格式：{ code, msg, data }，code 为 0 表示成功。
  • 限流：按应用配置的 QPS 与每日调用上限控制，超限返回 1606 / 1607。
  • 回调：任务完成后推送到应用配置的回调地址，请求头 X-Sign 为 HMAC-SHA256 签名。

评测

发起评测任务

POST
/api/v1/open/eval/create

创建一个评测任务并进入队列异步执行。鉴权方式：请求头 Authorization: Bearer <api_key>。任务完成后若配置了回调地址，平台会向其推送结果（请求头 X-Sign 为 HMAC-SHA256 签名）。

请求示例

{
  "model_id": 1,
  "tier_id": 3,
  "strength_id": 2,
  "dim_ids": [1, 2, 3],
  "name": "上线前回归"
}

响应示例

{
  "code": 0,
  "msg": "ok",
  "data": {
    "task_no": "a1b2c3d4e5f6a7b8",
    "status": 0,
    "cost_quota": 6
  }
}

查询评测结果

POST
/api/v1/open/eval/result

按任务编号查询评测进度与结果。任务未完成时只返回进度，完成后返回各维度得分明细。

请求示例

{
  "task_no": "a1b2c3d4e5f6a7b8"
}

响应示例

{
  "code": 0,
  "msg": "ok",
  "data": {
    "task_no": "a1b2c3d4e5f6a7b8",
    "status": 2,
    "score": 86.5,
    "grade": "A",
    "dimensions": [
      {"dimension": "准确性", "score": 92.0, "grade": "S", "pass_num": 5, "fail_num": 1}
    ]
  }
}

元数据

查询评测选项

POST
/api/v1/open/eval/options

返回当前可用的全部评测维度、强度与档位，用于构造创建任务的参数。

请求示例

{}

响应示例

{
  "code": 0,
  "msg": "ok",
  "data": {
    "dimensions": [{"id": 1, "name": "准确性", "slug": "accuracy"}],
    "strengths": [{"id": 2, "name": "标准", "level": 2}],
    "tiers": [{"id": 3, "name": "企业", "level": 3}]
  }
}

账户

查询剩余配额

POST
/api/v1/open/account/quota

查询当前应用所属账号的评测配额与接口配额余额。

请求示例

{}

响应示例

{
  "code": 0,
  "msg": "ok",
  "data": {
    "eval": {"total": 2000, "used": 137, "remain": 1863},
    "api": {"total": 50000, "used": 892, "remain": 49108}
  }
}