数据万象音频审核-SDK 文档-文档中心-腾讯云

简介
本文档提供音频审核相关的 API 概览以及 SDK 示例代码。
注意
  该功能需要 COS Python SDK v5 1.9.10 及以上版本。如果当前您的COS Python SDK v5版本低于1.9.10，请升级版本。
API
操作描述
提交音频审核任务
用于提交一个音频审核任务。
查询音频审核任务结果
用来查询指定的音频审核任务。
提交音频审核任务
功能说明
本接口用于提交一个音频审核任务。音频审核功能为异步任务方式，您可以通过提交音频审核任务来审核您的音频文件，然后通过查询音频审核任务接口查询审核结果。
示例代码
    """测试 CI 音频文件内容审核的接口"""
    # 先创建 cos client
    # 识别 COS 上的音频
    response= client.ci_auditing_audio_submit(
        Bucket='bucket',
        Key='test.mp3'
    )
    print response
参数说明
调用 ci_auditing_audio_submit 函数，具体请求参数如下：
参数名称
描述
类型
是否必选
Bucket
存储桶名称。
String
是
Key
对象文件名，例如 picture.jpg。
String
是
BizType
表示审核策略的唯一标识，您可以通过控制台上的审核策略页面，配置您希望审核的场景，如涉黄、广告、违法违规等，配置指引： 设置公共审核策略。您可以在控制台上获取到 BizType。BizType 填写时，此条审核请求将按照该审核策略中配置的场景进行审核。BizType 不填写时，将自动使用默认的审核策略。
String
否
Url
支持直接使用非 COS 上的音频 url 进行审核。
String
否
Callback
回调地址，以 http:// 或者 https:// 开头的地址。
String
否
CallbackVersion
回调内容的结构，有效值：Simple（回调内容包含基本信息）、Detail（回调内容包含详细信息）。默认为 Simple。
String
否
CallbackType
回调片段类型，有效值：1（回调全部音频片段）、2（回调违规音频片段）。默认为1 。
Int
否
UserInfo
用户业务字段。可传入的参数请参考 提交音频审核任务 的 UserInfo 字段。
Dict
否
DataId
该字段在审核结果中会返回原始内容，长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。
String
否
Freeze
可通过该字段，设置根据审核结果给出的不同分值，对音频文件进行自动冻结，仅当 input 中审核的音频为 object 时有效。参数请参考 提交音频审核任务的 UserInfo 字段。
Dict
否
返回参数说明
调用 ci_auditing_audio_submit 函数，会把 API里面的 xml 返回转换成 dict，具体返回参数可参见 提交音频审核任务 文档。
查询音频审核任务结果
功能说明
本接口用于主动查询指定的音频审核任务结果。音频审核功能为异步任务方式，您可以通过提交音频审核任务来审核您的音频文件，然后通过查询音频审核任务接口查询审核结果。
示例代码
    """测试ci查询审核任务结果的接口"""
    # 先创建 cos client
    # 查询审核的结果
    response = client.ci_auditing_audio_query(
        Bucket='bucket',
        JobID='v11122zxxxazzz'
    )
    print response
参数说明
调用 ci_auditing_audio_query 函数，具体请求参数如下：
参数名称
描述
类型
是否必选
Bucket
存储桶名称。
String
是
JobID
任务 ID。
String
是
返回参数说明
调用 ci_auditing_audio_query 函数，会把 api 里面的 xml 返回转换成 dict，具体返回参数如下：
节点名称
父节点
描述
类型
Response
无
音频审核任务结果。
Dict
节点 Response 的内容：
节点名称
父节点
描述
类型
JobsDetail
Response
音频审核任务的详细信息。
Dict
RequestId
Response
每次请求发送时，服务端将会自动为请求生成一个 ID，遇到问题时，该 ID 能更快地协助定位问题。
String
节点 Response.JobsDetail 的内容：
节点名称（关键字）
父节点
描述
类型
Code
Response.JobsDetail
错误码，只有 State 为 Failed 时返回。详情请查看 错误码列表。
String
Message
Response.JobsDetail
错误描述，只有 State 为 Failed 时返回。
String
DataId
Response.JobsDetail
该字段在审核结果中会返回原始内容，长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。
String
JobId
Response.JobsDetail
本次音频审核任务的 ID。
String
State
Response.JobsDetail
音频审核任务的状态，值为 Submitted（已提交审核）、Success（审核成功）、Failed（审核失败）、Auditing（审核中）其中一个。
String
CreationTime
Response.JobsDetail
音频审核任务的创建时间。
String
Object
Response.JobsDetail
审核的音频文件为存储在 COS 中的文件时，该字段表示本次审核的音频文件名称。
String
Url
Response.JobsDetail
审核的音频文件为一条文件链接时，该字段表示本次审核的音频文件链接。
String
Label
Response.JobsDetail
该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Ads：广告，以及其他不安全或不适宜的类型。
String
Result
Response.JobsDetail
该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。
String
AudioText
Response.JobsDetail
该字段用于返回音频文件中已识别的对应文本内容。
String
PornInfo
Response.JobsDetail
审核场景为色情的审核结果信息。
Dict
AdsInfo
Response.JobsDetail
审核场景为广告的审核结果信息。
Dict
Section
Response.JobsDetail
当音频过长时，会对音频进行分段，该字段用于返回音频片段的审核结果，主要包括开始时间和音频审核的相应结果。
Dict Array
UserInfo
Response.JobsDetail
用户业务字段。创建任务未设置 UserInfo 时无此字段。
Dict
ListInfo
Response.JobsDetail
账号黑白名单结果。
Dict
ForbidState
Response.JobsDetail
若您设置了自动冻结，该字段表示音频文件的冻结状态。0：未冻结，1：已被冻结，2：已转移文件。
String
节点 Response.JobsDetail.PornInfo，Response.JobsDetail.AdsInfo 的内容：
节点名称
父节点
描述
类型
HitFlag
Response.JobsDetail.*Info
用于返回该审核场景的审核结果，返回值：0：正常。1：确认为当前场景的违规内容。2：疑似为当前场景的违规内容。
String
Score
Response.JobsDetail.*Info
该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表该内容越有可能属于当前返回审核信息。例如：色情 99，表明该内容非常有可能属于色情内容。
String
Label
Response.JobsDetail.*Info
本次审核的综合结果标签，如果命中了敏感的关键词，该字段返回对应的关键词。
String
Category
Response.JobsDetail.*Info
该字段表示审核命中的具体审核类别。注意：该字段可能返回空。
String
SubLabel
Response.JobsDetail.*Info
该字段表示审核命中的具体子标签。注意：该字段可能返回空。
String
节点 Response.JobsDetail.Section 的内容：
节点名称（关键字）
父节点
描述
类型
Url
Response.JobsDetail.Section
当前音频片段的访问地址，您可以通过该地址获取该音频片段的内容，地址格式为标准 URL 格式。注意：每次查看数据的有效期为2小时，2小时后如还需查看，请重新发起查询请求。
String
Text
Response.JobsDetail.Section
该字段用于返回当前音频片段的 ASR 文本识别的检测结果。
String
OffsetTime
Response.JobsDetail.Section
该字段用于返回当前音频片段位于总音频中的时间，单位为毫秒，例如5000（音频开始后5000毫秒）。
String
Duration
Response.JobsDetail.Section
当前音频片段的时长，单位毫秒。
String
Label
Response.JobsDetail.Section
该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Ads：广告，以及其他不安全或不适宜的类型。
String
SubLabel
Response.JobsDetail
该字段表示审核命中的具体子标签。注意：该字段可能返回空。
String
Result
Response.JobsDetail.Section
该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。
String
PornInfo
Response.JobsDetail.Section
审核场景为色情的审核结果信息。
Dict
AdsInfo
Response.JobsDetail.Section
审核场景为广告的审核结果信息。
Dict
节点 Response.JobsDetail.Section.PornInfo，Response.JobsDetail.Section.AdsInfo 的内容：
节点名称
父节点
描述
类型
HitFlag
Response.JobsDetail.Section.*Info
用于返回该审核场景的审核结果，返回值：0：正常。1：确认为当前场景的违规内容。2：疑似为当前场景的违规内容。
String
Score
Response.JobsDetail.Section.*Info
该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表该内容越有可能属于当前返回审核信息。例如：色情 99，表明该内容非常有可能属于色情内容。
String
Category
Response.JobsDetail.Section.*Info
该字段为 Label 的子集，表示审核命中的具体审核类别。例如 Sexy，表示色情标签中的性感类别。
String
Keywords
Response.JobsDetail.Section.*Info
本次审核命中的敏感关键词，没有时不返回。
String Array
LibResults
Response.JobsDetail.Section.*Info
该字段用于返回基于风险库识别的结果。注意：未命中风险库中样本时，此字段不返回。
Dict Array
节点 Response.JobsDetail.Section.*Info.LibResults 的内容：
节点名称
父节点
描述
类型
LibType
Response.JobsDetail.Section.*Info.LibResults
命中的风险库类型，取值为1（预设风险库）和2（自定义风险库）。
String
LibName
Response.JobsDetail.Section.*Info.LibResults
命中的风险库名称。
String
Keywords
Response.JobsDetail.Section.*Info.LibResults
命中的库中关键词。该参数可能会有多个返回值，代表命中的多个关键词。
String Array
节点 Response.JobsDetail.UserInfo 的内容：
节点名称
父节点
描述
类型
TokenId
Response.JobsDetail.UserInfo
一般用于表示账号信息，长度不超过128字节。
String
Nickname
Response.JobsDetail.UserInfo
一般用于表示昵称信息，长度不超过128字节。
String
DeviceId
Response.JobsDetail.UserInfo
一般用于表示设备信息，长度不超过128字节。
String
AppId
Response.JobsDetail.UserInfo
一般用于表示 App 的唯一标识，长度不超过128字节。
String
Room
Response.JobsDetail.UserInfo
一般用于表示房间号信息，长度不超过128字节。
String
IP
Response.JobsDetail.UserInfo
一般用于表示 IP 地址信息，长度不超过128字节。
String
Type
Response.JobsDetail.UserInfo
一般用于表示业务类型，长度不超过128字节。
String
ReceiveTokenId
Response.JobsDetail.UserInfo
一般用于表示接收消息的用户账号，长度不超过128字节。
String
Gender
Response.JobsDetail.UserInfo
一般用于表示性别信息，长度不超过128字节。
String
Level
Response.JobsDetail.UserInfo
一般用于表示等级信息，长度不超过128字节。
String
Role
Response.JobsDetail.UserInfo
一般用于表示角色信息，长度不超过128字节。
String
节点 Response.JobsDetail.ListInfo 的内容：
节点名称
父节点
描述
类型
ListResults
Response.JobsDetail.ListInfo
命中的所有名单结果。
Dict Array
节点 Response.JobsDetail.ListInfo.ListResults 的内容：
节点名称
父节点
描述
类型
ListType
Response.JobsDetail.ListInfo.ListResults
命中的名单类型，取值为0（白名单）和1（黑名单）。
String
ListName
Response.JobsDetail.ListInfo.ListResults
命中的名单名称。
String
Entity
Response.JobsDetail.ListInfo.ListResults
命中了名单中的哪条内容。
String
﻿

API	操作描述
提交音频审核任务	用于提交一个音频审核任务。
查询音频审核任务结果	用来查询指定的音频审核任务。

参数名称	描述	类型	是否必选
Bucket	存储桶名称。	String	是
Key	对象文件名，例如 picture.jpg。	String	是
BizType	表示审核策略的唯一标识，您可以通过控制台上的审核策略页面，配置您希望审核的场景，如涉黄、广告、违法违规等，配置指引：设置公共审核策略。您可以在控制台上获取到 BizType。BizType 填写时，此条审核请求将按照该审核策略中配置的场景进行审核。BizType 不填写时，将自动使用默认的审核策略。	String	否
Url	支持直接使用非 COS 上的音频 url 进行审核。	String	否
Callback	回调地址，以 http:// 或者 https:// 开头的地址。	String	否
CallbackVersion	回调内容的结构，有效值：Simple（回调内容包含基本信息）、Detail（回调内容包含详细信息）。默认为 Simple。	String	否
CallbackType	回调片段类型，有效值：1（回调全部音频片段）、2（回调违规音频片段）。默认为1 。	Int	否
UserInfo	用户业务字段。可传入的参数请参考提交音频审核任务的 UserInfo 字段。	Dict	否
DataId	该字段在审核结果中会返回原始内容，长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。	String	否
Freeze	可通过该字段，设置根据审核结果给出的不同分值，对音频文件进行自动冻结，仅当 input 中审核的音频为 object 时有效。参数请参考提交音频审核任务的 UserInfo 字段。	Dict	否

节点名称	父节点	描述	类型
Response	无	音频审核任务结果。	Dict

节点名称（关键字）	父节点	描述	类型
Code	Response.JobsDetail	错误码，只有 State 为 Failed 时返回。详情请查看错误码列表。	String
Message	Response.JobsDetail	错误描述，只有 State 为 Failed 时返回。	String
DataId	Response.JobsDetail	该字段在审核结果中会返回原始内容，长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。	String
JobId	Response.JobsDetail	本次音频审核任务的 ID。	String
State	Response.JobsDetail	音频审核任务的状态，值为 Submitted（已提交审核）、Success（审核成功）、Failed（审核失败）、Auditing（审核中）其中一个。	String
CreationTime	Response.JobsDetail	音频审核任务的创建时间。	String
Object	Response.JobsDetail	审核的音频文件为存储在 COS 中的文件时，该字段表示本次审核的音频文件名称。	String
Url	Response.JobsDetail	审核的音频文件为一条文件链接时，该字段表示本次审核的音频文件链接。	String
Label	Response.JobsDetail	该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。返回值：Normal：正常，Porn：色情，Ads：广告，以及其他不安全或不适宜的类型。	String
Result	Response.JobsDetail	该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。	String
AudioText	Response.JobsDetail	该字段用于返回音频文件中已识别的对应文本内容。	String
PornInfo	Response.JobsDetail	审核场景为色情的审核结果信息。	Dict
AdsInfo	Response.JobsDetail	审核场景为广告的审核结果信息。	Dict
Section	Response.JobsDetail	当音频过长时，会对音频进行分段，该字段用于返回音频片段的审核结果，主要包括开始时间和音频审核的相应结果。	Dict Array
UserInfo	Response.JobsDetail	用户业务字段。创建任务未设置 UserInfo 时无此字段。	Dict
ListInfo	Response.JobsDetail	账号黑白名单结果。	Dict
ForbidState	Response.JobsDetail	若您设置了自动冻结，该字段表示音频文件的冻结状态。0：未冻结，1：已被冻结，2：已转移文件。	String

音频审核

本页目录：

简介

提交音频审核任务

功能说明

示例代码

参数说明

返回参数说明

查询音频审核任务结果

功能说明

示例代码

参数说明

返回参数说明