GetReport - 获取任务质检报告--企业直播-火山引擎

文档中心

立即注册

导航

GetReport - 获取任务质检报告

最近更新时间：2025.04.15 20:51:42首次发布时间：2025.04.15 20:51:42

调用 GetReport 接口，获取指定任务的质检报告，包含违规占比、话术分析占比、图像分析占比等。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：当满足以下任一条件时，可调用当前接口，获取指定任务的质检报告。
- 任务状态为待人审或人审已完成，即调用 ListTasks 接口，返回参数 Status 取值为 3 或 4 时
- 质检消息回调中，返回的任务状态为成功，即参数 Status 取值为 2 时

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetReport&Version=2024-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetReport`	接口名称。当前 API 的名称为 `GetReport`。
Version	String	是	`2024-08-01`	接口版本。当前 API 的版本为 `2024-08-01`。
ProjectName	String	是	`182701****608457`	项目名称。您可通过调用 ListProjects 接口，获取项目名称。
TaskId	Long	是	`397**671`	任务 ID。您可通过调用 CreateTask 或 ListTasks 获取 ID。

返回参数

参数	类型	示例值	描述
TaskDetail	Object of TaskDetail	`-`	任务详情。
TaskResult	Object of TaskResult	`-`	任务结果。
RuleResultDetails	Array of RuleResultDetails	`-`	规则结果。

TaskDetail

参数	类型	示例值	描述
ProjectName	String	`182701****608457`	项目名称。
TaskId	Long	`397**671`	任务 ID。
TaskName	String	`任务 A`	任务名称。
TaskType	Integer	`2`	任务类型。取值如下： `1`：视频审核（暂不支持） `2`：直播审核
TaskTypeDesc	String	`审核任务 1`	任务类型描述。
Status	Integer	`4`	任务状态。取值如下： `1`：待机审 `2`：机审中 `3`：待人审 `4`：已完成（人审已完成） `5`：任务执行失败
ScenarioId	Long	`1`	审核场景 ID。
LivePullURL	String	`https://www.example.com`	直播拉流地址。
CreatedTime	Long	`1744012851`	任务创建时间。Unix 时间戳，单位为秒。
UpdatedTime	Long	`1744012851`	任务更新时间（任务更新指任务状态变化等情况）。Unix 时间戳，单位为秒。
CallbackURL	String	`https://www.example.com`	回调地址，支持 HTTP 和 HTTPS 协议头。在任务开始到结束的整个生命周期中，当发生以下事件时，直播质检会将任务状态消息、机审违规消息，以及人审处置意见消息以 POST 方式提交至该地址：质检任务状态变化，包括任务开始、任务结束和任务执行失败触发机审违规消息提交人审处置意见
Extra	String	`{"ActivityId":123}`	CreateTask 接口传入的业务相关信息。

TaskResult

参数	类型	示例值	描述
MachineStartTime	Long	`1744016864`	机审开始时间。Unix 时间戳，单位为秒。
MachineEndTime	Long	`1744016900`	机审完成时间。Unix 时间戳，单位为秒。
Cost	Integer	`36`	机审耗时，单位为秒。
ManualEndTime	Long	`1744026900`	最近一次人审完成时间。Unix 时间戳，单位为秒。参数取值为 `0`，表示未进行人审。
RecordURL	String	`https://www.example.com`	M3U8 格式的视频回放地址，包含 HTTPS 协议头。有效期为 7 天，请尽快下载保存。
ASRResult	Object of ASRResult	`-`	语音识别结果。
StatisticalData	Object of StatisticalData	`-`	统计数据。
ManualDetails	Array of ManualDetails	`-`	人审记录。
FinalManualStatus	Integer	`2`	人审状态。取值如下： `0`：未进行人审，即无人审记录 `1`：人审通过 `2`：人审不通过

RuleResultDetails

参数	类型	示例值	描述
RuleName	String	`敏感词`	规则名称。
FinalManualStatus	Integer	`2`	人审状态。取值如下： `0`：未进行人审，即无人审记录 `1`：人审通过 `2`：人审不通过
ManualDetails	Array of ManualDetails	`-`	人审记录。
FinalMachineStatus	Integer	`2`	机审状态。取值如下： `0`：未进行机审 `1`：机审通过 `2`：机审不通过
MachineDetails	Array of MachineDetails	`-`	机审记录。
RuleId	Long	`101`	规则 ID。
RuleType	Integer	`2`	规则类型。取值如下： `1`：系统敏感词 `2`：自定义敏感词 `3`：文字分析 `4`：图像分析
ViolationType	Integer	`1`	规则策略。取值如下： `0`：分析。机审触发本规则，将仅在质检报告中显示机审分析结果 `1`：违规。机审触发本规则，将判定为机审不通过，并在监控台进行机审提示

ASRResult

参数	类型	示例值	描述
Text	String	`分句 1，分句 2。`	完整语音识别文字内容。
Utterances	Array of Utterances	`-`	语音识别分句详情。

StatisticalData

参数	类型	示例值	描述
ViolationList	Array of ViolationList	`-`	违规占比列表。
ImageLLMAnalysisList	Array of ImageLLMAnalysisList	`-`	图像分析占比列表。
TextLLMAnalysisList	Array of TextLLMAnalysisList	`-`	话术分析占比列表。

ManualDetails

参数	类型	示例值	描述
ManualComment	String	`存在违规内容`	人审审核意见。
Auditor	String	`主账号`	审核人。
UserId	Long	`0`	审核人用户 ID。取值为 `0` 表示主账号。
ManualSource	Integer	`1`	人审来源。取值如下： `1`：监控台任务审核 `2`：监控台规则审核 `3`：质检报告任务审核 `4`：质检报告规则审核
CreatedTime	Long	`1744016900`	人审记录创建时间。Unix 时间戳，单位为秒。
ManualStatus	Integer	`2`	人审状态。取值如下： `0`：未进行人审，即无人审记录 `1`：人审通过 `2`：人审不通过

MachineDetails

参数	类型	示例值	描述
MachineType	Integer	`2`	机审记录类型。取值如下： `1`：系统敏感词 `2`：自定义敏感词 `3`：豆包文字分析 `4`：豆包图像分析
AnalysisTexts	Array of AnalysisTexts	`-`	文字分析结果。
AnalysisImages	Array of AnalysisImages	`-`	图像分析结果。
CustomSensitiveResults	Array of CustomSensitiveResults	`-`	自定义敏感词的检测结果。
SystemSensitiveResults	Array of SystemSensitiveResults	`-`	系统敏感词的检测结果。

Utterances

参数	类型	示例值	描述
StartTime	Long	`1744016864`	分句开始时间。Unix 时间戳，单位为秒。
EndTime	Long	`1744016870`	分句结束时间。Unix 时间戳，单位为秒。
Text	String	`分句 1`	分句文字。

ViolationList

参数	类型	示例值	描述
Title	String	`分类 A`	分类名称。
Count	Integer	`10`	分类数量。

ImageLLMAnalysisList

参数	类型	示例值	描述
Title	String	`分类 B`	分类名称。
Count	Integer	`10`	分类数量。

TextLLMAnalysisList

参数	类型	示例值	描述
Title	String	`分类 C`	分类名称。
Count	Integer	`10`	分类数量。

AnalysisTexts

参数	类型	示例值	描述
Text	String	`文本内容`	语音识别的文本内容。
Type	String	`分类 A`	语音识别文本的所属分类。
AbsoluteStartTime	Long	`1744016864`	语音识别文本的出现时间。Unix 时间戳，单位为秒。
AbsoluteEndTime	Long	`1744016870`	语音识别文本的结束时间。Unix 时间戳，单位为秒。

AnalysisImages

参数	类型	示例值	描述
ImageURLs	Array of String	`["https://www.example.com/a.png","https://www.example.com/b.png"]`	图像的截图链接。有效期为 24 小时。
Type	String	`分类 A`	图像的所属分类。
AbsoluteStartTime	Long	`1744016864`	图像的出现时间。Unix 时间戳，单位为秒。
AbsoluteEndTime	Long	`1744016894`	图像的结束时间。Unix 时间戳，单位为秒。

CustomSensitiveResults

参数	类型	示例值	描述
SensitiveWord	String	`敏感词`	命中的敏感词。
Text	String	`文本内容`	包含敏感词的语音识别文本内容。
AbsoluteStartTime	Long	`1744016865`	语音识别文本的出现时间。Unix 时间戳，单位为秒。
StartTime	Integer	`60`	语音识别文本相对于直播开始时间的出现时间。单位为秒。例如直播于 10:00:00 开始，语音识别文本出现在 10:01:00，则参数取值为 `60`。

SystemSensitiveResults

参数	类型	示例值	描述
Text	String	`文本内容`	包含敏感词的语音识别文本内容。
AbsoluteStartTime	Long	`1744016865`	语音识别文本的出现时间。Unix 时间戳，单位为秒。
StartTime	Integer	`60`	语音识别文本相对于直播开始时间的出现时间。单位为秒。例如直播于 10:00:00 开始，语音识别文本出现在 10:01:00，则参数取值为 60。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetReport&Version=2024-08-01&ProjectName=182701****608457&TaskId=397**671

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetReport",
        "Version": "2024-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskDetail": {
            "TaskId": 397**671,
            "TaskName": "任务 A",
            "ProjectName": "182701****608457",
            "TaskType": 2,
            "TaskTypeDesc": "审核任务 1",
            "Status": 4,
            "ScenarioId": 1,
            "CreatedTime": 1744012851,
            "UpdatedTime": 1744012851,
            "CallbackURL": "https://www.example.com",
            "Extra": "{\"ActivityId\":123}",
            "LivePullURL": "https://www.example.com"
        },
        "TaskResult": {
            "MachineStartTime": 1744016864,
            "MachineEndTime": 1744016900,
            "Cost": 36,
            "ManualEndTime": 1744026900,
            "ASRResult": {
                "Text": "分句 1，分句 2。",
                "Utterances": [
                    {
                        "StartTime": 1744016864,
                        "EndTime": 1744016870,
                        "Text": "分句 1"
                    }
                ]
            },
            "RecordURL": "https://www.example.com",
            "StatisticalData": {
                "ViolationList": [
                    {
                        "Title": "分类 A",
                        "Count": 10
                    }
                ],
                "ImageLLMAnalysisList": [
                    {
                        "Title": "分类 B",
                        "Count": 10
                    }
                ],
                "TextLLMAnalysisList": [
                    {
                        "Title": "分类 C",
                        "Count": 10
                    }
                ]
            },
            "ManualDetails": [
                {
                    "ManualComment": "存在违规内容",
                    "Auditor": "主账号",
                    "UserId": 0,
                    "ManualSource": 1,
                    "CreatedTime": 1744016900,
                    "ManualStatus": 2
                }
            ],
            "FinalManualStatus": 2
        },
        "RuleResultDetails": [
            {
                "RuleName": "敏感词",
                "FinalManualStatus": 2,
                "ManualDetails": [
                    {
                        "ManualDetails": "审核不通过。",
                        "Auditor": "主账户",
                        "UserId": 0,
                        "ManualSource": 1,
                        "CreatedTime": 1744016900,
                        "ManualStatus": 2
                    }
                ],
                "FinalMachineStatus": 2,
                "MachineDetails": [
                    {
                        "MachineType": 2,
                        "AnalysisTexts": [
                            {
                                "Text": "文本内容",
                                "Type": "分类 A",
                                "AbsoluteStartTime": 1744016864,
                                "AbsoluteEndTime": 1744016870
                            }
                        ],
                        "AnalysisImages": [
                            {
                                "Type": "分类 A",
                                "AbsoluteStartTime": 1744016864,
                                "AbsoluteEndTime": 1744016894,
                                "ImageURLs": [
                                    "https://www.example.com/a.png",
                                    "https://www.example.com/b.png"
                                ]
                            }
                        ],
                        "CustomSensitiveResults": [
                            {
                                "Text": "文本内容",
                                "AbsoluteStartTime": 1744016865,
                                "StartTime": 60,
                                "SensitiveWord": "敏感词"
                            }
                        ],
                        "SystemSensitiveResults": [
                            {
                                "Text": "文本内容",
                                "AbsoluteStartTime": 1744016865,
                                "StartTime": 60
                            }
                        ]
                    }
                ],
                "RuleId": 101,
                "RuleType": 2,
                "ViolationType": 1
            }
        ]
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码错误码错误信息说明

状态码	错误码	错误信息	说明
400	ReportNotFoundError	report not found	质检任务未执行完毕或执行失败，导致未生成质检报告。如果任务未执行完毕，请等待任务执行完毕后，再重新调用该接口。如果任务执行失败，请重新调用 CreateTask 接口，确保配置的直播拉流地址（`LivePullURL`）有效，以及任务未超出并发数上限，再重新调用 `GetReport` 接口获取质检报告。

400

ReportNotFoundError

report not found

质检任务未执行完毕或执行失败，导致未生成质检报告。

如果任务未执行完毕，请等待任务执行完毕后，再重新调用该接口。
如果任务执行失败，请重新调用 CreateTask 接口，确保配置的直播拉流地址（LivePullURL）有效，以及任务未超出并发数上限，再重新调用 GetReport 接口获取质检报告。