接口简介
「AI 提示词评估」(ai-prompt-eval)是数据鱼API平台提供的提示词质量评估接口,对提示词文本做本地启发式评分与结构化改进建议,Base 路径 /api/ai-prompt-eval,共 2 个端点。调用方传入提示词内容,接口返回综合分数、分级标识、维度指标(长度、是否使用 Markdown 结构、是否设定角色、指令条数、注入风险特征)以及按短板给出的中文建议列表。
它面向提示词工程的质量管理环节:编辑器在保存前做即时体检,提示词仓库在合并前做基线评分,教学场景用它演示角色设定、指令组织、格式结构等要素对提示词质量的影响。全部评估为服务端本地规则计算,不调用任何大模型、不联网,因此结果可复现、延迟低,适合直接嵌入产品流程。
接口包含两个端点:免鉴权的健康检查与分析评估端点 analyze,后者支持 GET 与 POST 传参。
端点总览
方法 路径 说明 鉴权
GET /api/ai-prompt-eval/ping 健康检查(免鉴权) 免鉴权
POST /api/ai-prompt-eval/analyze 提示词分析评估 需要
通用约定
鉴权使用 X-API-Key 请求头或 ?api_key= 查询参数,全站统一 Key:缺失返回 4011,无效返回 4013。响应为统一三段结构 {code, msg, data},code 为 0 表示成功。参数类错误 4001~4004 分别对应缺少必填参数、格式或取值非法、取值不在支持列表、目标未收录;4040 为路由不存在,4050 为方法不允许,5000/5001 为服务内部错误。POST 支持 JSON body 或表单,参数名与 query 完全一致。以上为数据鱼API平台全站通用约定。
核心端点详解
提示词分析(POST /analyze)
用途:对提示词内容执行启发式质量评估。
参数 类型 必填 默认 说明
prompt array/object 否 — 提示词内容,以 JSON 数组或对象形式承载
返回字段要点:
score:综合评分(实测样例为 20);
level:分级标识,实测样例为 Low;
metrics:维度指标对象,含 length(长度计分)、has_markdown(是否使用 Markdown 结构)、has_role_play(是否设定角色)、instruction_count(指令条数)、injection_risk(是否识别出注入风险特征);
suggestions:中文改进建议数组,按评估出的短板逐条给出,如补充上下文背景、给模型设定明确角色、使用标题与列表组织任务结构。
请求示例(文档实测样例,空载荷调用也会返回基线评分):
POST /api/ai-prompt-eval/analyze?api_key=YOUR_KEY
Content-Type: application/json
{}
响应示例(实测输出):
{
"code": 0,
"msg": "success",
"data": {
"score": 20,
"level": "Low",
"metrics": {
"length": 1,
"has_markdown": false,
"has_role_play": false,
"instruction_count": 0,
"injection_risk": false
},
"suggestions": [
"提示词太短,建议增加具体的上下文或背景信息。",
"尝试给 AI 设定一个明确的角色(例如:你是一个资深的编辑)。",
"使用 Markdown 格式(如标题、列表)可以帮助 AI 更好地理解任务结构。"
]
}
}
健康检查(GET /ping)
免鉴权,无请求参数,返回 data.version(当前 1.0.0),用于探活与部署确认。
GET /api/ai-prompt-eval/ping
数据与限制
评估为规则启发式计算,不联网、不调用模型;指标阈值与权重为服务端内置,文档未公布细则。
prompt 在参数表中标注为非必填:空载荷也会返回基线评分(实测 score 20、level Low),但有效评估需在请求体中携带提示词内容。
suggestions 为固定中文文案,语言不随请求参数切换。
无历史版本管理与对比能力,每次调用独立评估。
典型使用场景
提示词编辑器在保存或发布前做即时质量体检,给出结构化改进建议。
提示词仓库的 CI 流程对新模板做基线评分卡,拦截质量明显偏低的提交。
教学与培训场景演示提示词的结构要素(角色、指令、格式、注入风险)。
注意事项
文档将 prompt 的类型标注为「JSON 数组或对象」,但未给出键名样例;实际承载提示词文本的字段结构建议以实测为准。
score 的满分口径与 level 的完整分级集合文档未列出,样例仅出现 Low;解析时按字符串处理,不要假设分级枚举。
injection_risk 只是启发式特征标记,反映提示词中存在类似注入的写法特征,不能当作安全审计结论。
本接口属于数据鱼API平台开发工具类接口,鉴权与错误码处理方式与其他接口一致。