有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

对点播中的图片文件发起审核(令人反感的信息、不安全的信息、不适宜的信息)任务。

  • 图片文件大小支持:文件 < 5M;
  • 图片文件分辨率支持:建议分辨率大于256x256,否则可能会影响审核效果;
  • 图片文件支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP格式。
  • 默认接口请求频率限制:20次/秒。

    推荐使用 API Explorer
    点击调试
    API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

    2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

    参数名称 必选 类型 描述
    Action String 公共参数,本接口取值:ReviewImage。
    Version String 公共参数,本接口取值:2018-07-17。
    Region String 公共参数,此参数为可选参数。
    FileId String 媒体文件 ID,即该文件在云点播上的全局唯一标识符。本接口要求媒体文件必须是图片格式。
    示例值:5285485487985271487
    Definition Integer 图片审核模板 ID,取值范围:
  • 10:预置模板,支持检测的违规标签包括色情(Porn)、暴力(Terror)和不适宜的信息(Polity)。

  • 示例值:10
    SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
    示例值:123

    3. 输出参数

    参数名称 类型 描述
    ReviewResultSet Array of ContentReviewResult 图片审核任务结果。
    注意:该字段已废弃,建议使用 MediaReviewResult。
    MediaReviewResult ReviewImageResult 图片审核任务结果。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 发起图片审核任务

    使用模板 ID 10 发起图片审核任务。

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ReviewImage
    <公共请求参数>
    
    {
        "Definition": "10",
        "FileId": "5285485487985271487"
    }

    输出示例

    {
        "Response": {
            "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
            "MediaReviewResult": {
                "Suggestion": "block",
                "Label": "Porn",
                "Form": "Image",
                "SegmentSet": [
                    {
                        "Confidence": 99,
                        "Suggestion": "block",
                        "Label": "Porn",
                        "SubLabel": "SexyBehavior",
                        "Form": "Image",
                        "AreaCoordSet": [],
                        "Text": "",
                        "KeywordSet": []
                    }
                ],
                "SegmentSetFileUrl": "xxx/a.mp4",
                "SegmentSetFileUrlExpireTime": "2020-09-07T00:00:00+08:00"
            },
            "ReviewResultSet": [
                {
                    "Type": "Porn.Image",
                    "PornImageResult": {
                        "Confidence": 99,
                        "Suggestion": "block",
                        "Label": "porn"
                    },
                    "TerrorismImageResult": null,
                    "PoliticalImageResult": null,
                    "PornOcrResult": null,
                    "TerrorismOcrResult": null,
                    "PoliticalOcrResult": null
                }
            ]
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.InvalidVodUser 没有开通点播业务。
    FailedOperation.MediaType 操作失败:不支持的媒体类型。
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。
    LimitExceeded 超过配额限制。
    RequestLimitExceeded 请求的次数超过了频率限制。
    ResourceNotFound 资源不存在。