产品动态
产品公告
GET /<ObjectKey>?ci-process=sensitive-content-recognition&detect-type=<type>&detect-url=<detect-url>&interval=<interval>&max-frames=<max-frames>&biz-type=<biz-type> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization: Auth String
参数名称 | 描述 | 类型 | 是否必选 |
ObjectKey | COS 存储桶中的图片文件名称，COS 存储桶由 Host指定，例如在北京的 examplebucket-1250000000存储桶中的目录 test 下的文件 img.jpg，则Host填写 examplebucket-1250000000.cos.ap-beijing.myqcloud.com，ObjectKey填写 test/img.jpg。 | String | 否 |
ci-process | 标识数据处理功能的字段，内容审核的值为：sensitive-content-recognition。 | String | 是 |
biz-type | 表示审核策略的唯一标识，您可以通过控制台上的审核策略页面，配置您希望审核的场景，如涉黄、广告、违法违规等，配置指引： 设置公共审核策略。您可以在控制台上获取到 biz-type。biz-type 填写时，此条审核请求将按照该审核策略中配置的场景进行审核。biz-type 不填写时，将自动使用默认的审核策略。 | String | 否 |
detect-type | （后续不再维护）审核的场景类型，有效值：Porn（涉黄）、Ads（广告）等，可以传入多种类型，不同类型以逗号分隔，例如：Porn,Ads。如您有更多场景的审核需要，请使用 biz-type 参数。 | String | 否 |
detect-url | 您可以通过填写 detect-url审核任意公网可访问的图片链接不填写detect-url时，后台会默认审核ObjectKey填写了detect-url时，后台会审核detect-url链接，无需再填写ObjectKey``detect-url示例：http://www.example.com/abc.jpg。 | String | 否 |
interval | 审核 GIF 动图时，可使用该参数进行截帧配置，代表截帧的间隔。例如值设为5，则表示从第1帧开始截取，每隔5帧截取一帧，默认值5。 | Int | 否 |
max-frames | 针对 GIF 动图审核的最大截帧数量，需大于0。例如值设为5，则表示最大截取5帧，默认值为5。 | Int | 否 |
large-image-detect | 对于超过大小限制的图片是否进行压缩后再审核，取值为： 0（不压缩），1（压缩）。默认为0。注：压缩最大支持32MB的图片，且会收取图片压缩费用。对于 GIF 等动态图过大时，压缩时间较长，可能会导致审核超时失败。 | Int | 否 |
dataid | 图片标识，该字段在结果中返回原始内容，长度限制为512字节。 | String | 否 |
async | 是否异步进行审核，取值 0：同步返回结果，1：异步进行审核，默认为0。 | Int | 否 |
callback | 审核结果（Detail版本）以回调形式发送至您的回调地址，异步审核时生效，支持以 http:// 或者 https:// 开头的地址，例如： http://www.callback.com。 | String | 否 |
<RecognitionResult><JobId>xxxxxxxxxxxxxxx</JobId><Result>1</Result><Label>Porn</Label><SubLabel>SexBehavior</SubLabel><Score>90</Score><PornInfo><Code>0</Code><Msg>OK</Msg><HitFlag>1</HitFlag><Label>xxx</Label><SubLabel>SexBehavior</SubLabel><Score>100</Score><OcrResults><Text></Text><Keywords></Keywords><Location><X></X><Y></Y><Width></Width><Height></Height><Rotate></Rotate></Location></OcrResults></PornInfo></RecognitionResult>
参数名称 | 类型 | 描述 |
RecognitionResult | Container | 图片审核结果。 |
参数名称 | 类型 | 描述 |
DataId | String | 图片标识，审核结果会返回原始内容，长度限制为512字节。 |
JobId | String | 图片审核任务的 ID。 |
State | String | 审核任务的状态，值为Submitted（已提交审核）。 |
Object | String | 存储在 COS 桶中的图片名称，创建任务使用 ObjectKey 时返回。 |
Url | String | 图片文件的链接地址，创建任务使用 detect-url 时返回。 |
参数名称 | 类型 | 描述 |
DataId | String | 图片标识，审核结果会返回原始内容，长度限制为512字节。 |
JobId | String | 图片审核任务的 ID。 |
State | String | 审核任务的状态，值为 Success（审核成功）。 |
Object | String | 存储在 COS 桶中的图片名称，创建任务使用 ObjectKey 时返回。 |
Url | String | 图片文件的链接地址，创建任务使用 detect-url 时返回。 |
CompressionResult | Int | 图片是否被压缩处理，值为 0（未压缩），1（正常压缩）。 |
Result | Int | 该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。 |
Label | String | 该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。返回值：Normal 表示正常，Porn 表示色情，Ads 表示广告，以及其他不安全或不适宜的类型。 |
Category | String | 该字段为 Label的子集，表示审核命中的具体审核类别。例如 Sexy，表示色情标签中的性感类别。 |
SubLabel | String | 该图命中的二级标签结果。 |
Score | Int | 该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表该内容越有可能属于当前返回审核信息例如：色情 99，则表明该内容非常有可能属于色情内容。 |
Text | String | 该图里的文字内容（OCR），当审核策略开启文本内容检测时返回。 |
PornInfo | Container | 审核场景为涉黄的审核结果信息。 |
AdsInfo | Container | 审核场景为广告引导的审核结果信息。 |
参数名称 | 类型 | 描述 |
Code | Int | |
Msg | String | 具体错误信息，如正常则为 OK。 |
HitFlag | Int | 用于返回该审核场景的审核结果，返回值：0：正常。1：确认为当前场景的违规内容。2：疑似为当前场景的违规内容。 |
Score | Int | 该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高），越高代表该内容越有可能属于当前返回审核信息。其中0 - 60分表示图片正常，61 - 90分表示图片疑似敏感，91 - 100分表示图片确定敏感。例如：色情 99，表明该内容非常有可能属于色情内容。 |
Label | String | 该字段表示该截图的综合结果标签（可能为 SubLabel，可能为人物名字等）。 |
Category | String | 该字段为 Label的子集，表示审核命中的具体审核类别。例如 Sexy，表示色情标签中的性感类别。 |
SubLabel | String | 该字段表示审核命中的具体子标签，例如：Porn 下的 SexBehavior 子标签。注意：该字段可能返回空，表示未命中具体的子标签。 |
OcrResults | Container Array | 该字段表示 OCR 文本识别的详细检测结果，包括文本识别结果、命中的关键词等信息，有相关违规内容时返回。 |
LibResults | Container Array | 该字段用于返回基于风险库识别的结果。注意：未命中风险库中样本时，此字段不返回。 |
参数名称 | 类型 | 描述 |
ImageId | String | 该字段表示命中的风险库中的图片样本 ID。 |
Score | Integer | 该字段用于返回当前标签下的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表当前的图片越有可能命中库中的样本。例如：色情 99，表明该数据非常有可能命中库中的色情样本。 |
参数名称 | 类型 | 描述 |
Text | String | 图片 OCR 文本识别出的具体文本内容。 |
Keywords | String Array | 在当前审核场景下命中的关键词。 |
Location | Container | 该参数用于返回 OCR 检测框在图片中的位置（左上角 xy 坐标、长宽、旋转角度），以方便快速定位识别文字的相关信息。 |
名称 | 类型 | 描述 |
X | Float | 该参数用于返回检测框左上角位置的横坐标（x）所在的像素位置，结合剩余参数可唯一确定检测框的大小和位置。 |
Y | Float | 该参数用于返回检测框左上角位置的纵坐标（y）所在的像素位置，结合剩余参数可唯一确定检测框的大小和位置。 |
Width | Float | 该参数用于返回检测框的宽度（由左上角出发在 x 轴向右延伸的长度），结合剩余参数可唯一确定检测框的大小和位置。 |
Height | Float | 该参数用于返回检测框的高度（由左上角出发在 y 轴向下延伸的长度），结合剩余参数可唯一确定检测框的大小和位置。 |
Rotate | Float | 该参数用于返回检测框的旋转角度，该参数结合 X 和 Y 两个坐标参数可唯一确定检测框的具体位置；取值：0-360（角度制），方向为逆时针旋转。 |
名称 | 类型 | 描述 |
Name | String | 该标签用于返回所识别出的实体名称，例如人名。 |
Location | Container | 该参数用于返回检测结果在图片中的位置（左上角 xy 坐标、长宽、旋转角度），以方便快速定位相关信息。 |
GET /picture.jpg?ci-process=sensitive-content-recognition&detect-type=porn&interval=0&max-frames=1&biz-type=*** HTTP/1.1Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.comDate: Tue, 03 Apr 2019 09:06:15 GMTAuthorization:XXXXXXXXXXXX
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 645Date: Tue, 03 Apr 2018 09:06:16 GMTStatus: 200 OKx-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****<RecognitionResult><JobId>xxxxxxxxxxxxxxx</JobId><CompressionResult>0</CompressionResult><Result>1</Result><Label>Porn</Label><SubLabel>SexBehavior</SubLabel><Score>95</Score><PornInfo><Code>0</Code><Msg>OK</Msg><HitFlag>1</HitFlag><Label>xxx</Label><SubLabel>SexBehavior</SubLabel><Score>95</Score></PornInfo></RecognitionResult>
GET /picture.jpg?ci-process=sensitive-content-recognitionbiz-type=***&async=1&callback=http://www.callback.com HTTP/1.1Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.comDate: Tue, 03 Apr 2019 09:06:15 GMTAuthorization:XXXXXXXXXXXX
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 645Date: Tue, 03 Apr 2018 09:06:16 GMTStatus: 200 OKx-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****<RecognitionResult><JobId>xxxxxxxxxxxxxxx</JobId></RecognitionResult>
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback