API 教程

BenchDX API

获取全部基准提示词，并提交对应的待测模型响应。

对现有 BenchDX 评估使用这套两步请求流程：获取完整提示词列表，让待测模型运行每个提示词，再使用其原始追踪 ID 提交每个答案。

1. 获取基准提示词

GET/api/evaluation/promptsAll

返回分配给所选 BenchDX 评估的全部提示词。

位置	名称	类型	必填
查询参数	`evaluationId`	number	是
请求头	`Authorization`	Bearer PAT	是

获取基准提示词cURL

curl -X GET \
  "https://trial.aidx.pro/api/evaluation/promptsAll?evaluationId={evaluation_id}" \
  -H "Authorization: Bearer {personal_access_token}"

响应示例JSON

{
  "code": "req_01J...",
  "message": "Operation Succeed",
  "data": [
    {
      "traceId": "trace_id_1",
      "content": "prompt_1"
    },
    {
      "traceId": "trace_id_2",
      "content": "prompt_2"
    }
  ],
  "success": true
}

2. 运行待测模型

将每个返回的 content值发送给待测模型或应用。在待测目标请求处理期间，保留与其对应的 traceId。

3. 提交基准响应

POST/api/evaluation/response

为一条 BenchDX 追踪记录保存一个待测模型答案。

位置	名称	类型	必填
表单	`evaluationId`	number	是
表单	`traceId`	string	是
表单	`llmResponse`	string	是
请求头	`Authorization`	Bearer PAT	是

API 接受 multipart/form-data 和 application/x-www-form-urlencoded 参数。

提交基准响应cURL

curl -X POST \
  "https://trial.aidx.pro/api/evaluation/response" \
  -H "Authorization: Bearer {personal_access_token}" \
  -F "evaluationId={evaluation_id}" \
  -F "traceId={trace_id}" \
  -F "llmResponse={model_response}"

响应示例JSON

{
  "code": "req_01J...",
  "message": "Operation Succeed",
  "data": "Operation success",
  "success": true
}

4. 验证进度

在 AIDX 中打开 Process Details，确认各条追踪记录从 Awaiting Trigger 依次进入 Sent、Responded 和 Evaluated。只有所有必要测试用例均已完成评估或被明确处理后，评估才能完成。