接口说明
更新时间 2026-04-29 10:25:48
最近更新时间: 2026-04-29 10:25:48
| 项目 | 内容 |
|---|---|
| 请求 URL | https://aisec-global.ctapi.ctyun.cn/ai-guard/open/chat/check |
| 请求方式 | POST |
| Content-Type | application/json |
请求参数详解
所有检测服务共用同一接口,通过checkService字段区分检测类型。
公共必填参数:
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| checkService | String | 必填 | 检测服务类型,取值:text_input_check、text_output_check、image_security_check |
| reqId | String | 必填 | 请求唯一ID,用于日志追踪与问题排查,建议使用 UUID |
文本输入检测(checkService = text_input_check)专属参数:
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| prompt | String | 必填 | 需要检测的用户输入文本内容(Prompt) |
文本输出检测(checkService = text_output_check)专属参数:
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| answerContent | String | 必填 | 大模型生成的回复内容,支持分片传入 |
| seqId | Integer | 必填 | 分片序号,从1开始,每个分片递增,取值范围最大不超过2,147,483,647 |
| isEnd | Integer | 必填 | 是否为最后一个分片:1表示是,0表示否 |
分片检测说明:大模型通常以流式(Streaming)方式输出内容。文本输出检测支持将流式输出内容分批传入,seqId标识每个分片的序号,isEnd=1表示最后一片内容已发送完毕,系统将综合所有分片内容给出最终检测结论。
图片检测(checkService = image_security_check)专属参数:
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| imageUrl | String | 与imageBase64二选一 | 图片的公网可访问 URL |
| imageBase64 | String | 与imageUrl二选一 | 图片的 Base64 编码字符串,支持 JPEG、PNG 等常见格式 |
返回参数详解
统一返回结构:
| 字段 | 类型 | 说明 |
|---|---|---|
| code | String | 业务状态码,200表示请求成功处理 |
| subCode | String | 子状态码,用于更精细的状态区分 |
| message | String | 返回信息描述 |
| success | Boolean | 请求是否成功:true / false |
| data | Object | 业务数据对象,请求失败时为null |
data 字段说明(ChatCheckResponse):
| 字段 | 类型 | 说明 |
|---|---|---|
| checkResult | String | 检测结果:pass(内容安全,建议放行)/ fail(命中风险,建议拦截) |
| failContent | String | 命中风险的具体内容片段(部分场景可能为空) |
| failType | String | 风险类型中文名称(详见 5.7 节) |
| failTypeEn | String | 风险类型英文编码(详见 5.7 节) |
| presetResponse | String | 命中风险时配置的代答内容(未配置代答库或未命中时为null) |