You need to enable JavaScript to run this app.
企业直播

企业直播

请输入
  • 文档首页
    • 企业直播直播质检API 参考APIGetScenario - 获取场景详情
复制全文
我的收藏
API
GetScenario - 获取场景详情
复制全文
我的收藏
GetScenario - 获取场景详情

调用 GetScenario接口，获取指定项目下指定审核场景的详情，包括场景名称、场景类型、场景描述、场景包含的规则列表等。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetScenario接口名称。当前 API 的名称为 GetScenario。
VersionString是2024-08-01接口版本。当前 API 的版本为 2024-08-01。
ProjectNameString是182701****608457项目名称。您可通过调用 ListProjects 接口获取 ProjectName。
ScenarioIdLong是1审核场景 ID。您可通过调用 ListScenarios 接口获取 ID。

返回参数

参数类型示例值描述
ScenarioIdInteger1审核场景 ID。
ScenarioNameString直播审核场景场景名称。

ScenarioType

Integer

2

审核场景类型。取值如下：

  • 1：视频审核（暂不支持）
  • 2：直播审核
ScenarioDescString直播审核场景。审核场景描述。
CreatedTimeLong1744012851审核场景创建时间。Unix 时间戳，单位为秒。
UpdatedTimeLong1744012851审核场景最近修改时间。Unix 时间戳，单位为秒。
TagsArray of Tags-质检任务的标签。
RulesArray of Rules-审核场景包含的规则列表。

Tags

参数类型示例值描述
TagIdLong657标签 ID。
TagNameString服饰标签名称。
ParentTagIdLong23父标签 ID。
ParentTagNameString电商父标签名称。

Rules

参数类型示例值描述
RuleIdLong4005审核规则 ID。
RuleNameStringOCR文字识别规则名称。

RuleSubType

String

OCR_TEXT_RECOGNITION

规则子类型，支持如下取值，更多定制规则字段，请联系客服获取。

  • SYSTEM_SENSITIVE_WORD：系统敏感词
  • CUSTOM_SENSITIVE_WORD：自定义敏感词
  • OCR_TEXT_RECOGNITION：OCR 文字检测
  • OCR_SCROLLING_SUBTITLE：OCR 滚动字幕
  • PRESET_SCRIPT_COMPARISON: 预设脚本对比

RuleCategory

String

SCREEN_OCR_TEXT

规则类型，取值如下：

  • SYS_SENSITIVE_WORD：系统敏感词
  • CUS_SENSITIVE_WORD：自定义敏感词
  • DOUBAO_TEXT_ANALYSIS：豆包文字分析，即用豆包大模型检测直播语音识别的文本
  • DOUBAO_IMAGE_ANALYSIS：豆包图像分析，即用豆包大模型检测直播画面
  • SCREEN_OCR_TEXT：OCR 文本，即检测直播画面中的文字
  • SCROLLING_CAPTION：滚动字幕，即检测内嵌在直播流画面中的滚动文字
  • ASR_SCRIPT_COMPARISON：ASR脚本对比
RuleArgsObject of RuleArgs-规则参数。

RuleArgs

参数类型示例值描述
OcrTextRecognitionArgsObject of OcrTextRecognitionArgs-基于 OCR 文字识别模型创建的规则中，自定义的规则参数。
OcrScrollingSubtitlesArgsObject of OcrScrollingSubtitlesArgs-基于 OCR 滚动字幕模型创建的规则中，自定义的规则参数。

OcrTextRecognitionArgs

参数类型示例值描述

PositiveOrNegative

Integer

1

正向/负向。取值如下：

  • 0：正向，即出现预设文字时，记录数据。
  • 1：负向，即未出现预设文字时，记录数据。
PresetTextString预设文字的内容。预设文字。

PresetTextSpecifiableOnCreate

Boolean

false

预设文字是否在创建任务时指定。取值如下：

  • true：预设文字在创建任务时指定。
  • false：预设文字不在创建任务时指定。

OcrScrollingSubtitlesArgs

参数类型示例值描述
PresetSubtitlesString预设字幕内容。预设字幕。

PositiveOrNegative

Integer

1

正向/负向。取值如下：

  • 0：正向，即出现预设字幕时，记录数据。
  • 1：负向，即未出现预设字幕时，记录数据。

PresetSubtitlesSpecifiableOnCreate

Boolean

false

预设字幕是否在创建任务时指定。取值如下：

  • true：预设字幕在创建任务时指定。
  • false：预设字幕不在创建任务时指定。

请求示例 

GET https://livesaas.volcengineapi.com/?Action=GetScenario&Version=2024-08-01&ProjectName=182701****608457&ScenarioId=1

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetScenario",
        "Version": "2024-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "Rules": [
            {
                "RuleArgs": {
                    "OcrScrollingSubtitlesArgs": {
                        "PresetSubtitles": "预设字幕内容。",
                        "PositiveOrNegative": 1,
                        "PresetSubtitlesSpecifiableOnCreate": false
                    }
                },
                "RuleId": 4005,
                "RuleName": "OCR文字识别",
                "RuleSubType": "OCR_TEXT_RECOGNITION",
                "RuleCategory": "SCREEN_OCR_TEXT"
            }
        ],
        "ScenarioId": 1,
        "ScenarioName": "直播审核场景",
        "ScenarioType": 2,
        "ScenarioDesc": "直播审核场景。",
        "CreatedTime": 1744012851,
        "UpdatedTime": 1744012851,
        "Tags": [
            {
                "TagId": 657,
                "TagName": "服饰",
                "ParentTagId": 23,
                "ParentTagName": "电商"
            }
        ]
    }
}

错误码

访问公共错误码和错误码获取详细信息。

最近更新时间：2026.02.04 10:52:23
这个页面对您有帮助吗？
有用
有用
无用
无用