文档中心>音频内容安全

短音频审核同步接口

最近更新时间:2024-09-03 01:07:34

我的收藏

1. 接口描述

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

本接口(CreateAudioModerationSyncTask) 用于提交短音频内容进行智能审核任务,使用前请您使用腾讯云主账号登录控制台 开通音频内容安全服务 并调整好对应的业务配置。

接口使用说明:

接口调用说明:

  • 音频文件大小支持:文件 <= 4M;
  • 音频文件时长不超过60s,超过60s音频调用则报错;
  • 音频文件支持格式:wav (PCM编码)mp3aacm4a (采样率:16kHz~48kHz,位深:16bit 小端,声道数:单声道/双声道,建议格式:16kHz/16bit/单声道);
  • 接口仅限音频文件传入,视频文件传入请调用长音频异步接口;
  • 接口默认QPS为20,如需自定义配置并发或请求频率,请工单咨询;
  • 接口默认超时为10s,请求如超过该时长则接口会报错。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAudioModerationSyncTask。
Version String 公共参数,本接口取值:2020-12-29。
Region String 公共参数,详见产品支持的 地域列表
BizType String Biztype为策略的具体的编号,用于接口调度,在内容安全控制台中可配置。不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype。Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;调用时不传入Biztype代表采用默认的识别策略。
示例值:audio_test_0001
DataId String 数据标识,可以由英文字母、数字、下划线、-、@#组成,不超过64个字符
示例值:5c10e038-35ff-4114-88ab-53a0aaea5dd7
FileFormat String 音频文件资源格式,当前支持格式:wav、mp3、m4a,请按照实际文件格式填入。
示例值:mp3
Name String 文件名称,可以由英文字母、数字、下划线、-、@#组成,不超过64个字符
示例值:file_name
FileContent String 数据Base64编码,短音频同步接口仅传入可音频内容;
支持范围:文件大小不能超过5M,时长不可超过60s;
支持格式:wav (PCM编码)、mp3、m4a (采样率:16kHz~48kHz,位深:16bit 小端,声道数:单声道/双声道,建议格式:16kHz/16bit/单声道)。
示例值:1
FileUrl String 音频资源访问链接,与FileContent参数必须二选一输入;
支持范围及格式:同FileContent;
示例值:1

3. 输出参数

参数名称 类型 描述
DataId String 请求接口时传入的数据标识
示例值:1
Name String 文件名称,可以由英文字母、数字、下划线、-、@#组成,不超过64个字符
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
BizType String Biztype为策略的具体的编号,用于接口调度,在内容安全控制台中可配置。不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype。Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;调用时不传入Biztype代表采用默认的识别策略。
示例值:1
Suggestion String 智能审核服务对于内容违规类型的等级,可选值:
Pass 建议通过;
Reveiw 建议复审;
Block 建议屏蔽;
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Label String 智能审核服务对于内容违规类型的判断,详见返回值列表
如:Label:Porn(色情);
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AsrText String 音频文本,备注:这里的文本最大只返回前1000个字符
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TextResults Array of TextResult 音频中对话内容审核结果;
注意:此字段可能返回 null,表示取不到有效值。
MoanResults Array of MoanResult 音频中低俗内容审核结果;
注意:此字段可能返回 null,表示取不到有效值。
SubLabel String 该字段用于返回当前标签(Lable)下的二级标签。
注意:此字段可能返回null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LanguageResults Array of AudioResultDetailLanguageResult 该字段用于返回音频小语种检测的详细审核结果。具体结果内容请参见AudioResultDetailLanguageResult数据结构的细节描述。
注意:此字段可能返回 null,表示取不到有效值。
SpeakerResults Array of AudioResultDetailSpeakerResult 音频中说话人识别返回结果;
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RecognitionResults Array of RecognitionResult 识别类标签结果信息列表
注意:此字段可能返回 null,表示取不到有效值。
Duration String 识别音频时长,单位为毫秒;
注意:此字段可能返回 null,表示取不到有效值。
示例值:15
HitFlag Integer 是否命中(0:否, 1: 是)
示例值:1
Score Integer 得分
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 音频同步接口返回示例

输入示例

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

{
    "BizType": "test_biztype",
    "FileUrl": "https://test.myqcloud.com/test.mp3",
    "DataId": "test0000000000001",
    "Name": "test_file",
    "FileFormat": "mp3"
}

输出示例

{
    "Response": {
        "RequestId": "24235235-sfsddgsdg-242532-test",
        "DataId": "test0000000000001",
        "Label": "Normal",
        "SubLabel": "",
        "Name": "test_audio",
        "BizType": "test_biztype",
        "Suggestion": "Pass",
        "AsrText": "新年快乐,恭喜发财,身体健康,万事如意。",
        "TextResults": [
            {
                "Label": "Normal",
                "Score": 0,
                "Keywords": [],
                "Suggestion": "Pass",
                "LibId": "",
                "LibType": 0,
                "LibName": "",
                "SubLabel": ""
            }
        ],
        "MoanResults": [],
        "LanguageResults": [],
        "SpeakerResults": [],
        "RecognitionResults": [],
        "Duration": "15000",
        "HitFlag": 0,
        "Score": 0
    }
}

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 内部错误。
InternalError.InternalError InternalError.InternalError
InvalidParameter 参数错误。
InvalidParameter.ImageSizeTooSmall InvalidParameter.ImageSizeTooSmall
InvalidParameter.InvalidImageContent InvalidParameter.InvalidImageContent
InvalidParameter.ParameterError InvalidParameter.ParameterError
InvalidParameterValue 参数取值错误。
InvalidParameterValue.EmptyImageContent InvalidParameterValue.EmptyImageContent
InvalidParameterValue.ImageSizeTooSmall InvalidParameterValue.ImageSizeTooSmall
InvalidParameterValue.InvalidContent InvalidParameterValue.InvalidContent
InvalidParameterValue.InvalidDataId InvalidParameterValue.InvalidDataId
InvalidParameterValue.InvalidFileContentSize InvalidParameterValue.InvalidFileContentSize
InvalidParameterValue.InvalidImageContent InvalidParameterValue.InvalidImageContent
InvalidParameterValue.InvalidParameter InvalidParameterValue.InvalidParameter
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourceUnavailable.InvalidImageContent ResourceUnavailable.InvalidImageContent
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。