API对接文档

最近更新时间:2020-07-08 13:06:10

一体机API文档

目录

请求结构

服务地址

统一接入地址为审核一体机IP地址,端口80。

请求方式

支持POST方法发送请求。

请求参数

图像审核、视频审核、领导人纠错/文本审核三类接口,均需要传递guard_id参数,具体参数值不在此文档维护,线下交付。

公共参数

返回结果

接口统一返回json格式数据,满足以下格式:

{
    "header":{
      "err_no":200,
      "err_msg":"success"
    },
    "request_id": "d679e27b-9f1b-44bf-b134-49a6d9f0adff",
    "body":{}
}

调用成功,err_no返回200,err_msg为success,否则返回对应错误码及错误信息。

每此请求会返回唯一的请求表示request_id,调用失败时提供request_id给金山云客服,方便定位问题。

图像识别接口

接口路径

/audit-brain/v1/audit/image

POST请求示例

CURL:

curl -X POST \
  http://api_host/audit-brain/v1/audit/image \
  -H 'Content-Type: application/json' \
  -H 'X-KSC-REQUEST-ID: test' \
  -d '{
    "guard_id": "XXXX",
    "business": [
        "porn"
    ],
    "image_url": "url",
    "tags":{
        "k1":"v1",
        "k2":"v2"
    }
}'

Body:

{
    "guard_id": "1558197932842675542",
    "business": [
        "ocr", "terrorism", "illegal", "sensitive", "porn"
    ],
    "image_url": "http://xxx.xxx.xxx/xxx.jpg",
    "image_data":"image base64",
    "tags":{
        "k1":"v1",
        "k2":"v2"
    }
}

POST参数说明

参数 必选 类型 说明
guard_id string 送审计划id
image_url string 图片url
image_data string 图片内容的BASE64编码,与image_url二选一
business array 调用服务名称
色情图像识别:porn;
涉政图像识别: sensitive
暴恐图像识别: terrorism
OCR图像识别: ocr
违规违法图像识别: illegal
tags object 自定义数据,接口返回时会全量返回.

接口返回:

    {
      "header": {
          "err_no": 200,
          "err_msg": "success"
      },
      "cost": 0.323,
      "body": {
          "tags": {
              "key": "evgqfn"
          },
          "results": [
              {
                  "business": "ocr",
                  "label": "1",
                  "suggest": "normal",
                  "rate": 0.99,
                  "label_desc": "正常",
                  "label_details": {
                      "position": [
                          [
                              [
                                  0.024407200515270233,
                                  0.9395615458488464
                              ],
                              [
                                  0.2291432023048401,
                                  0.936347484588623
                              ],
                              [
                                  0.2293936014175415,
                                  0.9715840816497803
                              ],
                              [
                                  0.024657800793647766,
                                  0.9747976064682007
                              ]
                          ]
                      ],
                      "word_list": [
                          "XXXXXXXXXXXXXX"
                      ],
                      "text_filter": {
                          "conclusion": "正常",
                          "risk_type": "正常",
                          "matched_item": ""
                      }
                  }
              },
              {
                  "business": "terrorism",
                  "label": "3",
                  "suggest": "confirm_reject",
                  "rate": 1,
                  "label_desc": "血腥",
                  "label_details": {
                      "second_labels": [
                          {
                              "label": "8",
                              "rate": 1,
                              "label_desc": "血腥场景"
                          }
                      ]
                  }
              },
              {
                  "business": "illegal",
                  "label": "1",
                  "suggest": "normal",
                  "rate": 0.9996753931045532,
                  "label_desc": "正常",
                  "label_details": {
                      "second_labels": [
                          {
                              "label": "204",
                              "rate": 0.9996753931045532,
                              "label_desc": "其他正常"
                          }
                      ]
                  }
              },
              {
                  "business": "sensitive",
                  "label": "1",
                  "suggest": "normal",
                  "rate": 0.9996753931045532,
                  "label_desc": "正常",
                  "label_details": {
                      "second_labels": [
                          {
                              "label": "202",
                              "rate": 0.9996753931045532,
                              "label_desc": "正常"
                          }
                      ]
                  }
              },
              {
                  "business": "porn",
                  "label": "1",
                  "suggest": "normal",
                  "rate": 0.9864895343780518,
                  "label_desc": "正常",
                  "label_details": {
                      "second_labels": [
                          {
                              "label": "200",
                              "rate": 0.9324476718902588,
                              "label_desc": "正常"
                          }
                      ]
                  }
              }
          ],
          "data_id": "5c2dc5b795e999c8f0820503aef84792",
          "image_url": "XXXXXXXXXXX",
          "guard_id": "1558197932842675542",
          "suggest_summary": "confirm_reject",
          "suggest_summary_code": "229000",
          "suggest_summary_message": "图像涉暴"
      },
      "request_id": "XXXXXXXX"
  }

接口输出字段解释:

字段 类型 是否必须 说明
business string 调用服务名称
色情图像识别:porn;
涉政图像识别: sensitive
暴恐图像识别: terrorism
OCR图像识别: ocr
违规违法图像识别: illegal
label string 分类标签ID
label_desc string 分类标签
rate double 分类置信度 [0, 1.0],值越大置信度越高
image_url string 对应请求中的地址
data_id string 唯一标识该图片
suggest_summary string confirm_reject:拒绝;suggest_review:疑似;normal:通过
suggest_summary_code string 295000:图像涉黄;
349000: 图像政治敏感;
245000: 图像OCR违规
229000: 图像涉暴
237000: 图像违规违法
suggest_summary_message string 295000:图像涉黄;
349000: 图像政治敏感;
245000: 图像OCR违规
229000: 图像涉暴
237000: 图像违规违法

色情图像识别对应的results字段

字段 类型 是否必须 说明
suggest string confirm_reject:拒绝;suggest_review:疑似;normal:通过
label string 分类标签ID
porn: 1正常;2低俗;3色情
label_desc string 分类标签
porn: 1正常;2低俗;3色情
label_details.second_labels.rate double 置信度
label_details.second_labels.label string 二级标签id
label_details.second_labels.label_desc string 二级标签描述

色情图像识别二级标签映射

label_details.second_labels.label label_details.second_labels.label_desc
47 ACG穿着低俗
13 露臀线
14 露背
15 女性露乳沟
62 ACG露乳轮廓
20 穿着低俗
22 男性裸露上体
46 ACG精乳液
45 ACG亲吻
17 亲吻
18 舔舐动作
50 ACG舔舐动作
49 ACG摸胸
16 揉胸
30 床上场景
19 性用品
51 ACG性用品

暴恐图像识别对应的results字段

字段 类型 是否必须 说明
suggest string confirm_reject:拒绝;suggest_review:疑似;normal:通过
label string 分类标签ID
terrorism: 1正常;2暴恐;3血腥;
label_desc string 分类标签
terrorism: 1正常;2暴恐;3血腥;
label_details.second_labels.rate double 置信度
label_details.second_labels.label string 二级标签id
label_details.second_labels.label_desc string 二级标签描述

暴恐图像识别二级标签映射

label_details.second_labels.label label_details.second_labels.label_desc
1 武器携带
2 国内军装
3 特殊着装
4 大型武器
5 游行示威
6 暴乱场景
7 极端组织
19 ACG涉徽
20 ACG大型武器
21 ACG极端组织
22 ACG恐怖
8 血腥场景
9 车祸现场
10 肢体残缺
18 ACG血腥
23 非作战类迷彩服装
24 旧军装
25 其他聚集
26 正常刀具
100 极端旗帜
201 违法运动

违规违法图像识别对应的results字段

字段 类型 是否必须 说明
suggest string confirm_reject:拒绝;suggest_review:疑似;normal:通过
label string 分类标签ID
illegal: 1正常;2违法;3违规;4ACG违规;
label_desc string 分类标签
illegal: 1正常;2违法;3违规;4ACG违规;
label_details.second_labels.rate double 置信度
label_details.second_labels.label string 二级标签id
label_details.second_labels.label_desc string 二级标签描述

违规违法图像识别二级标签映射

label_details.second_labels.label label_details.second_labels.label_desc
101 ACG违规
15 涉毒
16 封建迷信
17 赌博场景
11 涉旗涉徽
12 吸烟持烟
14 危险驾驶
13 未成年

OCR图像识别对应的results字段

字段 类型 是否必须 说明
label string 分类标签ID
1:正常
2:涉黄
3:广告
4:涉暴
5:涉政
6:辱骂
label_desc string 分类标签ID
1:正常
2:涉黄
3:广告
4:涉暴
5:涉政
6:辱骂
label_details object ocr识别详情
label_details.text_filter.conclusion string 同label_desc描述
label_details.text_filter.risk_type string 同label_desc描述
label_details.text_filter.matched_item string 违规文本
label_details.word_list array 识别出的详细的文本内容
label_details.position array 文字结果对应坐标
暂时不提供
suggest string confirm_reject:拒绝;normal:通过

涉政图像识别对应的results字段

字段 类型 是否必须 说明
suggest string confirm_reject:拒绝;suggest_review:疑似;normal:通过
label string 分类标签ID
1正常;2涉政运动;3涉政动漫4涉政人物;5涉政违规;
label_desc string 分类标签
1正常;2涉政运动;3涉政动漫4涉政人物;5涉政违规;
label_details.second_labels.rate double 置信度
label_details.second_labels.label string 二级标签id
label_details.second_labels.label_desc string 二级标签描述

涉政图像识别二级标签映射

label_details.second_labels.label label_details.second_labels.label_desc
1 六四运动
2 七五事件
3 占中运动
4 反送中运动
5 其他涉政运动
6 涉一号首长
7 涉其他国家领导人
8 政治事件
9 其他涉政动漫
10 现任国级副国级领导人
11 历任国级副国级领导人
12 省部级及以下领导人
13 文革相关人员
14 落马官员及涉案人员
15 港澳领导人
16 台湾领导人
17 落马官员家属
18 重要领导人家属
19 民运及异见人士
20 港独
21 台独
22 疆独
23 藏独
24 广电封杀明星
25 极端组织和邪教人员
26 革命领袖和英雄
27 主要国外领导人
28 其他国外领导人
29 国内军装
30 大型武器
31 游行示威
32 暴乱场景
33 涉旗涉徽

领导人纠错/文本审核接口

接口路径

/audit-brain/v1/audit/text

POST请求示例

CURL:

curl -X POST \
  http://api_host/audit-brain/v1/audit/text \
  -H 'Content-Type: application/json' \
  -H 'X-KSC-REQUEST-ID: test' \
  -d '{
    "guard_id":"XXXX",
    "text":"习近瓶按时打算习近凭发的安抚暗室逢灯阿斯蒂",
    "business":["text_illegal"],
    "tags":{
          "key1":"v1",
          "k2":"v2"
      }
}'

Body:

{
    "guard_id":"XXXX",
    "text":"习近瓶按时打算习近凭发的安抚暗室逢灯阿斯蒂",
    "business":["text_illegal"],
    "tags":{
          "key1":"v1",
          "k2":"v2"
      }
}

POST参数说明

参数 必选 类型 说明
guard_id string 送审计划id
text string 文本
business string text_illegal:文字过滤 text_correct:领导人纠错
tags object 自定义数据,接口返回时会全量返回.

文字过滤服务

接口返回:

{
    "cost": 0.011,
    "header": {
        "err_no": 200,
        "err_msg": "success"
    },
    "body": {
        "business": "text_illegal",
        "suggest_summary": "confirm_reject",
        "suggest_summary_code": "1000000",
        "suggest_summary_message": "文本违规",
        "guard_id": "1558197932842675544",
        "tags": {
                    "key1": "v1",
                    "k2": "v2"
                },
        "results": [
          {
            "business":"text_illegal",
            "label":"2",
            "label_desc":"文本违规",
            "suggest":"confirm_reject",
            "label_details":{
            "text_illegal_list":[
              {
                "start": 0,
                "end": 3,
                "label":"6",
                "label_desc":"辱骂",
                "error_word": "习近瓶"
              }
            ]
            }
          }
        ]
    },
    "request_id": "test",
    "request_time": 1573527601572
}

领导人纠错服务

接口返回:

{
    "cost": 0.011,
    "header": {
        "err_no": 200,
        "err_msg": "success"
    },
    "body": {
        "business": "text_correct",
        "suggest_summary": "confirm_reject",
        "suggest_summary_code": "1001000",
        "suggest_summary_message": "领导人名字错误",
        "guard_id": "1558197932842675544",
        "tags": {
                    "key1": "v1",
                    "k2": "v2"
                },
        "results": [
          {
            "business":"text_correct",
            "label":"2",
            "label_desc":"文字错误",
            "suggest":"confirm_reject",
            "label_details":{
            "text_illegal_list":[
              {
                "start": 0,
                "end": 3,
                "type":"LeaderName",
                "error_word": "习近瓶",
                "candidate_list":["习近瓶"]
              }
            ]
            }
          }
        ]
    },
    "request_id": "test",
    "request_time": 1573527601572
}

接口输出字段解释:

字段 类型 是否必须 说明
business string 调用服务名称
文字过滤服务:text_illegal 领导人纠错:text_correct;
suggest_summary string confirm_reject:拒绝;suggest_review:疑似;normal:通过
suggest_summary_code string 100000: 正常;
1000000:领导人名字错误;
1001000: 文本违规;
suggest_summary_message string 100000: 正常;
1000000:领导人名字错误;
1001000: 文本违规;
results[0].suggest string confirm_reject:拒绝;suggest_review:疑似;normal:通过
results[0].label string 分类标签ID
1: 正常,2:文本违规 文字错误
results[0].label_desc string 分类标签
1: 正常,2:文本违规 文字错误
results[0].label_details.text_illegal_list[0].start int 文字错误、违规开始索引
results[0].label_details.text_illegal_list[0].end int 文字错误、违规结束索引,不包含
results[0].label_details.text_illegal_list[0].label string 1正常,2涉黄,3广告,4涉暴,5涉政,6辱骂,7灌水
results[0].label_details.text_illegal_list[0].error_word string 违规文本
results[0].label_details.text_illegal_list[0].label_desc string 1正常,2涉黄,3广告,4涉暴,5涉政,6辱骂,7灌水
results[0].label_details.text_illegal_list[0].type string LeaderName
results[0].label_details.text_illegal_list[0].candidate_list array 纠正字数组

离线视频识别接口

离线视频识别任务提交

接口路径

/audit-media/api/media/create

POST请求示例:

CURL:

curl -X POST \
  http://api_host/audit-media/api/media/create \
  -H 'Content-Type: application/json' \
  -H 'X-KSC-REQUEST-ID: test' \
  -d '{
    "guard_id":"1558197932842675544",
    "origin_name": "test",
    "businesses":["porn","sensitive"],
    "video_url":"https://ks3-cn-beijing.ksyun.com/364.mp4",
    "video_id":"3d6e528b8a0710986e229cd525491259",
    "callback": "https://www.test.com",
    "tags":{
        "key":"value"
    }
}'

Header:

X-KSC-REQUEST-ID : REQUEST_ID

Body:

{
    "video_id":"3d6e528b8a0710986e229cd525491259",
    "guard_id":"1548746633316469125",
    "video_url":"https://ks3-cn-beijing.ksyun.com/364.mp4",
    "origin_name": "test",
    "businesses":["porn", "sensitive", "terrorism", "illegal", "ocr"],
    "callback": "https://www.test.com",
    "tags":{"key":"value"}
}

POST参数说明

参数 必选 类型 说明
video_id string 视频id
guard_id string 送审计划id
video_url string 视频url
origin_name string 视频名称
businesses array 调用服务名称
色情视频识别: porn;
涉政视频识别: sensitive;
暴恐视频识别: terrorism;
违规违法视频识别: illegal;
ocr视频识别: ocr
tags object 自定义数据,接口返回时会全量返回.
callback string 回调地址,视频处理结果通过此地址回传

接口返回:

{
    "cost": 0.02,
    "header": {
        "err_no": 200,
        "err_msg": "success"
    },
    "request_time": 1536148409363,
    "request_id": "d679e27b-9f1b-44bf-b134-49a6d9f0adff"
}

离线视频识别结果查询

接口路径

/audit-media/api/media/select

POST请求示例:

CURL:

curl -X POST \
  http://api_host/audit-media/api/media/select \
  -H 'Content-Type: application/json' \
  -H 'X-KSC-REQUEST-ID: test' \
  -d '{
    "video_id":"3d6e528b8a0710986e229cd525491259"
}'

Header:

X-KSC-REQUEST-ID : REQUEST_ID

Body:

{
    "video_id":"1267362389641"
}

POST参数说明

参数 必选 类型 说明
video_id string 视频id

接口返回:

{
    "cost": 0.24,
    "header": {
        "err_no": 200,
        "err_msg": "success"
    },
    "request_id": "ff35f7a5-7b65-4aaf-a97f-cf63bec2218c",
    "request_time": 1560240162393,
    "body": {
        "video_id": "test08102",
        "video_url": "http://test.com/object/smarttag/2000092829/test78116.mp4",
        "video_duration": 229,
        "video_suggestion": "confirm_reject",
        "suggest_summary_code": "250000",
        "suggest_summary_message": "图像涉黄",
        "image_result":[
            {
                "business":"terrorism",
                "suggest":"suggest_review",
                "detail":[
                    {
                        "imageUrl":"/object/smarttag/2000074681/test08102/30.jpg",
                        "timestamp":30,
                        "labelId":"2",
                        "labelDesc":"暴恐",
                        "rate":"0.98",
                        "label2":"2",
                        "label2_desc":"国类军装",
                        "rate2":"0.96"
                    }
                ]
            },
            {
                "business":"ocr",
                "suggest":"confirm_reject",
                "detail":[
                    {
                        "imageUrl":"/object/smarttag/2000074681/test08102/6.jpg",
                        "timestamp":6,
                        "labelId":"5",
                        "labelDesc":"涉政",
                        "rate":"0.96",
                        "keywords":[
                            {
                                "matched_item":"共军"
                            }
                        ]
                    }
                ]
            },
            {
                "business":"porn",
                "suggest":"confirm_reject",
                "detail":[
                    {
                        "imageUrl":"/object/smarttag/2000074681/test08102/8.jpg",
                        "timestamp":8,
                        "labelId":"2",
                        "labelDesc":"低俗",
                        "rate":"0.98",
                        "label2":"30",
                        "label2_desc":"床上场景",
                        "rate2":"0.95"
                    },
                    {
                        "imageUrl":"/object/smarttag/2000074681/test08102/9.jpg",
                        "timestamp":9,
                        "labelId":"2",
                        "labelDesc":"低俗",
                        "rate":"0.96",
                        "label2":"30",
                        "label2_desc":"床上场景",
                        "rate2":"0.96"
                    }
                ]
            },
            {
                "business":"sensitive",
                "suggest":"normal",
                "detail":[

                ]
            },
            {
                "business":"illegal",
                "suggest":"suggest_review",
                "detail":[
                    {
                        "imageUrl":"/object/smarttag/2000074681/test08102/33.jpg",
                        "timestamp":33,
                        "labelId":"4",
                        "labelDesc":"ACG违规",
                        "rate":"0.99",
                        "label2":"13",
                        "label2_desc":"未成年",
                        "rate2":"0.98"
                    }
                ]
            }
        ]
    }
}

接口输出字段解释:

字段 类型 是否必须 说明
video_id string 视频ID
video_url string 视频地址
video_duration int 视频时长,单位秒
video_suggestion string 视频处理建议:
normal、 suggest_review、 confirm_reject
suggest_summary_code string 识别建议原因编码
100000正常
250000视频图像涉黄
350000视频图像政治敏感
246000视频OCR违规
230000视频图像涉暴
238000视频图像违规违法
suggest_summary_message string 识别建议原因描述
image_result list 违规图片识别结果集
business string 服务名称
色情图像识别:porn
图像政治敏感识别: sensitive
暴恐图像识别: terrorism
OCR图像识别: ocr
违规违法图像识别: illegal
suggest string 建议
正常normal
疑似suggest_review
拒绝confirm_reject
detail list 违规图片详情
image_url string 图片地址
timestamp int 相对于视频起始位置的秒数
label int 分类标签ID(int类型)
porn: 1正常;2低俗;3色情
sensitive: 1正常;2涉政运动;3涉政动漫;4涉政人物;5涉政违规
terrorism:1-正常;2-暴恐;3-血腥
ocr:1-正常,2-涉黄,3-广告,4-涉暴,5-涉政,6--辱骂,7-灌水
illegal: 1-正常;2-违法;3-违规;4-ACG违规
label_desc string 标签描述
rate double 分类置信度 [0, 1.0],值越大置信度越高
label2 int 二级标签
label2_desc string 二级标签描述
rate2 double 二级分类置信度 [0, 1.0],值越大置信度越高(double类型)
keywords list 命中关键字列表
matched_item string 命中关键字

音频识别

通过websocket协议审核音频数据,可以是本地音频文件,也可以是实时音频流。

音频数据要求:单声道,16000采样率,PCM格式

接口路径

/audit-brain/v1/audit/audio

输入:

{
  "guard_id":"1548746633316469125",
  "stream_id":"134234",
  "audio_data":"base64data",
  "action":"begin"
}

POST参数说明

参数 必选 类型 说明
guard_id string 送审计划id
stream_id string 音频文件或者音频流的唯一标识
audio_data object 自定义数据,接口返回时会全量返回.
action string begin 第一个音频数据包
data 音频数据
end 最后一个音频数据包,标识审核即将结束

识别结果回调:

{
    "body": {
        "suggest_summary": "confirm_reject",
        "suggest_summary_code": "209000",
        "suggest_summary_message": "音频违规",
        "stream_id": "1111111",
        "results": [
            {
                "business":"illegal",
                "label":"2",
                "text": "XXXX",
                "label_desc":"文本违规",
                "suggest":"confirm_reject",
                "label_details":{
                "text_illegal_list":[
                  {
                    "start": 0,
                    "end": 3,
                    "label":"6",
                    "label_desc":"辱骂",
                    "error_word": "习近平"
                  }
                ]
            }
        ]
    },
    "header": {
        "err_no": 200,
        "err_msg": "success"
    }
}

回调输出字段解释:

字段 类型 是否必须 说明
business string 调用服务名称
违规音频识别服务:audio_illegal
text string 识别出的文本
results[0].label string 分类标签ID
1: 正常,2:文本违规 文字错误
results[0].label_desc string 分类标签
1: 正常,2:文本违规 文字错误
results[0].label_details.text_illegal_list[0].start int 文字错误、违规开始索引
results[0].label_details.text_illegal_list[0].end int 文字错误、违规结束索引,不包含
results[0].label_details.text_illegal_list[0].label string 1正常,2涉黄,3广告,4涉暴,5涉政,6辱骂,7灌水
results[0].label_details.text_illegal_list[0].error_word string 违规文本
results[0].label_details.text_illegal_list[0].label_desc string 1正常,2涉黄,3广告,4涉暴,5涉政,6辱骂,7灌水

详细使用参见Java SDK

错误码说明

业务层级错误码

err_msg err_no 说明
ERR_TOO_MANY_REQUESTS 500018 请求QPS超过限制。

金山云,开启您的云计算之旅

免费注册