有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

通过该接口可查看音频审核任务的详情信息,包括任务状态、检测结果、音频文件识别出的对应文本内容、检测结果所对应的恶意标签及推荐的后续操作等,具体输出内容可查看输出参数示例。

默认接口请求频率限制:20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskDetail。
Version String 公共参数,本接口取值:2020-12-29。
Region String 公共参数,本接口不需要传递此参数。
TaskId String 该字段表示创建音频审核任务后返回的任务ID(在Results参数中),用于标识需要查询任务详情的审核任务。

备注:查询接口单次最大查询量为20条每次
示例值:w-audio-YBJzazmYs4vO27p2
ShowAllSegments Boolean 该布尔字段表示是否展示全部的音频片段,取值:True(展示全部的音频分片)、False(只展示命中审核规则的音频分片);默认值为False。
示例值:false

3. 输出参数

参数名称 类型 描述
TaskId String 该字段用于返回创建音频审核任务后返回的任务ID(在Results参数中),用于标识需要查询任务详情的审核任务。
注意:此字段可能返回 null,表示取不到有效值。
示例值:w-audio-YBJzazmYs4vO27p2
DataId String 该字段用于返回调用音频审核接口时在Tasks参数内传入的数据ID参数,方便数据的辨别和管理。
注意:此字段可能返回 null,表示取不到有效值。
示例值:azmYs4vO27p2
BizType String 该字段用于返回调用音频审核接口时传入的BizType参数,方便数据的辨别和管理。
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
Name String 该字段用于返回调用音频审核接口时传入的TaskInput参数中的任务名称,方便任务的识别与管理。
注意:此字段可能返回 null,表示取不到有效值。
示例值:名称
Status String 该字段用于返回所查询内容的任务状态。

取值:FINISH(任务已完成)、PENDING (任务等待中)、RUNNING (任务进行中)、ERROR (任务出错)、CANCELLED (任务已取消)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:FINISH
Type String 该字段用于返回调用音频审核接口时输入的音频审核类型,取值为:AUDIO(点播音频)和LIVE_AUDIO(直播音频),默认值为AUDIO。
注意:此字段可能返回 null,表示取不到有效值。
示例值:AUDIO
Suggestion String 该字段用于返回基于恶意标签的后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。
返回值:Block:建议屏蔽,Review :建议人工复审,Pass:建议通过
注意:此字段可能返回 null,表示取不到有效值。
示例值:Pass
Labels Array of TaskLabel 该字段用于返回检测结果所对应的恶意标签。
返回值:Porn:色情,Abuse:谩骂,Ad:广告,Custom:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
InputInfo InputInfo 该字段用于返回审核服务的媒体内容信息,主要包括传入文件类型和访问地址。
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
AudioText String 该字段用于返回音频文件识别出的对应文本内容,最大支持前1000个字符
注意:此字段可能返回 null,表示取不到有效值。
示例值:the text
AudioSegments Array of AudioSegments 该字段用于返回音频片段的审核结果,主要包括开始时间和音频审核的相应结果。
具体输出内容请参见AudioSegments及AudioResult数据结构的详细描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
ErrorType String 当任务状态为Error时,该字段用于返回对应错误的类型;任务状态非Error时,默认返回为空。
注意:此字段可能返回 null,表示取不到有效值。
示例值:URL_ERROR
ErrorDescription String 当任务状态为Error时,该字段用于返回对应错误的详细描述,任务状态非Error时默认返回为空。
注意:此字段可能返回 null,表示取不到有效值。
示例值:the url is request is 404
CreatedAt String 该字段用于返回被查询任务创建的时间,格式采用 ISO 8601标准。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-01-28T08:20:25.759Z
UpdatedAt String 该字段用于返回被查询任务最后更新时间,格式采用 ISO 8601标准。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-01-28T08:20:25.759Z
Label String 该字段用于返回检测结果所对应的标签。如果未命中恶意,返回Normal,如果命中恶意,则返回Labels中优先级最高的标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:Normal
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看任务详情

在创建任务后,可以通过TaskId查看任务详情

输入示例

POST / HTTP/1.1
Host: ams.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetail
<公共请求参数>

{
    "TaskId": "task-video-XwxJtbkKXWgCt8AZ"
}

输出示例

{
    "Response": {
        "TaskId": "w-audio-X_Qnzci_GulDQ01r",
        "DataId": "",
        "BizType": "202012161",
        "Name": "",
        "Status": "FINISH",
        "Type": "AUDIO",
        "Suggestion": "Review",
        "Labels": [
            {
                "Label": "Abuse",
                "Suggestion": "Review",
                "Score": 0,
                "SubLabel": ""
            }
        ],
        "InputInfo": {
            "Type": "URL",
            "Url": "https://test.cos.ap-guangzhou.myqcloud.com/porn5.mp3"
        },
        "AudioText": "音频文本",
        "AudioSegments": [
            {
                "Result": {
                    "HitFlag": 0,
                    "Url": "https://cos.ap-guangzhou.myqcloud.com/0.mp3",
                    "Suggestion": "Pass",
                    "Label": "Normal",
                    "Text": "",
                    "TextResults": [],
                    "MoanResults": [],
                    "LanguageResults": [],
                    "Duration": "60000",
                    "Score": 0,
                    "Extra": "",
                    "SubLabel": ""
                },
                "OffsetTime": "0"
            }
        ],
        "ErrorType": "",
        "ErrorDescription": "",
        "CreatedAt": "2021-01-05T08:48:13.069Z",
        "UpdatedAt": "2021-01-05T08:49:31.421Z",
        "RequestId": "34785328532523",
        "Label": "Abuse"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。