You need to enable JavaScript to run this app.
导航

创建 AI 模板

最近更新时间2022.12.29 10:18:38

首次发布时间2022.01.30 14:42:53

创建 AI 模板。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称CreateAITemplate
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01

Body 参数

字段
类型
必填
说明
TemplateNameString模板名称,支持汉字、大小写字母、数字、中划线
AIArray of objectsAI 能力配置,参考以下 AI 能力配置结构说明

AI 能力配置结构说明

字段
类型
必填
说明

TemplateItems

Map

AI 能力类型配置信息:

  • vehicle:车辆检测能力类型
  • blackout:视频黑屏检测能力类型
  • blur:视频模糊检测能力类型
  • overexposure:视频过曝检测能力类型
  • hinder:视频遮挡检测能力类型
  • noise:视频噪声检测能力类型

以上 AI 能力类型的详细配置信息,参考以下 检测能力配置结构说明

ImageTTLInteger图片存储周期,单位:天

检测能力配置结构说明

字段
类型
必填
说明
CapabilityTypeStringAI 能力类型
ConfidenceThresholdFloat置信阈值
FrameIntervalInteger截帧间隔,单位:毫秒

GrabStrategy

String

图片抓取方式:

  • timing(定时)
  • best(最优)
  • fastest(最快)
StatusBoolean模板是否启用
ExtraArray of objects自定义信息

EnableTimes

Array of objects

模板生效时间:

  • EnableFrom(模板生效起始时间,例如:08:00:00)
  • EnableTo(模板生效结束时间,例如:23:59:00)
    注:起始时间和结束时间不能交叉,数组长度必须大于0

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明
IDString创建成功的 AI 模板 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateAITemplate
&Version=2021-01-01
&<公共请求参数>
{
    "TemplateName": "New-template",
    "AI": {
        "TemplateItems": {
            "vehicle": {
                "CapabilityType": "vehicle",
                "EnableTimes": [
                    {
                        "EnableFrom": "08:00:00",
                        "EnableTo": "23:59:00"
                    }
                ],
                "ConfidenceThreshold": 90,
                "FrameInterval": 100,
                "Status": true,
                "GrabStrategy": "timing"
            },
            "blackout": {
                "CapabilityType": "blackout",
                "EnableTimes": [
                    {
                        "EnableFrom": "08:00:00",
                        "EnableTo": "23:59:00"
                    }
                ],
                "ConfidenceThreshold": 90,
                "FrameInterval": 100,
                "Status": true,
                "GrabStrategy": "timing"
            }
        },
        "ImageTTL": 7
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022012609594401021204520909005796",
        "Action": "CreateAITemplate",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "d3605074-9a09-4a83-9c29-a57aa0xxxxxx"
    }
}