删除评估器¶
POST /api/v1/agent_eval/evaluator/{evaluator_uuid}/delete
概述¶
删除当前工作空间的指定自定义评估器。
调用前和使用步骤¶
使用目标工作空间的DF-API-KEY;即使只读,也需Agent监测的应用配置管理权限。仅操作当前空间的custom评估器,不暴露系统内置评估器。参数只放在对应Query/路径或JSON Body,禁止使用URL中的body参数。 删除前获取详情核实名称和UUID。无需Body。成功仅返回已删除的uuid、name及公共declaration,不能据此推断历史Trace或评估结果也已删除。重复删除返回404,不是幂等成功。对超时结果先用详情确认:不存在则已无需重复删除;不要自动换UUID重试。
路由参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| evaluator_uuid | string | Y | 当前工作空间自定义评估器UUID,系统内置评估器和其他工作空间的UUID均按不存在处理。 例子: aeve_0123456789abcdef0123456789abcdef获取或填写方式: 从创建评估器的content.uuid或列出评估器的content.data[].uuid取得。 |
请求头¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| DF-API-KEY | string | Y | 目标工作空间的OpenAPI凭据,读取和写入均需Agent监测的应用配置管理权限;所属角色须为owner、wsAdmin或general。 例子: <DF-API-KEY>获取或填写方式: 在目标工作空间的API Key管理中创建并授权,使用DF-API-KEY请求头传递;不要在URL或示例中填真实Key。 |
参数补充说明¶
接口无需请求体。删除后该 UUID 将无法继续管理,重复删除会返回资源不存在。
请求例子¶
curl 'https://openapi.guance.com/api/v1/agent_eval/evaluator/aeve_0123456789abcdef0123456789abcdef/delete' \
--request POST \
--header 'DF-API-KEY:
响应¶
HTTP 200,application/json。成功包装与字段如下;失败参见公共错误及本页异常处理。
| 字段 | 类型 | 说明 |
|---|---|---|
| code | integer | 业务响应状态,成功为200。 |
| errorCode | string | 成功为空;失败为具体错误码。 |
| message | string | 成功为空;失败为错误消息。 |
| success | boolean | 是否成功。 |
| traceId | string | 本次请求追踪标识,排查问题时保留。 |
| content | object | 删除成功的资源标识。 |
| content.uuid | string | 已删除评估器UUID。 |
| content.name | string | 已删除评估器名称。 |
| content.declaration | object或null | 本空间公共声明,未配置时可为空对象或null;列表只有content这一层携带,不给data[]逐项补充。 |
{
"code": 200,
"content": {
"uuid": "aeve_0123456789abcdef0123456789abcdef",
"name": "LLM 回答完整性",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "example-trace-id"
}
错误响应¶
鉴权、限流和公共请求错误参见公共错误定义。
| HTTP 状态 | errorCode | 触发条件 | 消息或响应说明 | 处理方式 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 请求中包含未声明的参数,或已声明请求字段未通过类型/约束校验 | 参数解析失败 | 只提交本页声明的请求头、路径和Query参数;本接口不需要JSON请求体。 |
| 406 | ft.InvalidParameterV2 | URL中携带body参数 | Send evaluator parameters in the JSON request body. | 移除URL中的body参数;本接口无需请求体。 |
| 404 | ft.ObjectNotExists | 目标评估器不存在、属于其他工作空间或是系统内置评估器 | Agent evaluator does not exist | 从本空间列表取得content.data[].uuid后核对;若删除响应曾超时,目标不存在时不要重复删除。 |
| 500 | ft.InternalServerError | 删除数据库记录、写入审计或其他依赖发生未处理异常 | 内部错误 | 保留traceId,先用详情或列表确认目标是否已删除;不存在则无需重复删除,不要把失败响应当作删除未生效。 |