{
  "name": "ivld",
  "display_name": "媒体智能标签",
  "description": "介绍如何使用API对媒体智能标签进行操作，包括视频上传、发起分析任务、获取任务分析结果等。",
  "domain": "other",
  "api_version": "2021-09-03",
  "endpoint": "ivld.tencentcloudapi.com",
  "actions": [
    {
      "name": "AddCustomPersonImage",
      "description": "增加自定义人脸图片，每个自定义人物最多可包含10张人脸图片 请注意，与创建自定义人物一样，图片数据优先级优于图片URL优先级",
      "status": "online",
      "parameters": [
        {
          "name": "PersonId",
          "type": "string",
          "required": true,
          "description": "自定义人物Id",
          "example": "person-Axgo3FYc"
        },
        {
          "name": "ImageURL",
          "type": "string",
          "required": false,
          "description": "自定义人物图片地址",
          "example": "https://example-123456.cos.ap-guangzho.myqcloud.com/example.jpg"
        },
        {
          "name": "Image",
          "type": "string",
          "required": false,
          "description": "图片数据base64之后的结果",
          "example": "Qk0WWgsAAADYAoAAA...AtQEAADcCAAABABPD"
        }
      ],
      "required": [
        "PersonId"
      ]
    },
    {
      "name": "CreateCustomCategory",
      "description": "创建自定义人物分类信息 当L2Category为空时，将创建一级自定义分类。 当L1Category与L2Category均不为空时，将创建二级自定义分类。请注意，**只有当一级自定义分类存在时，才可创建二级自定义分类**。",
      "status": "online",
      "parameters": [
        {
          "name": "L1Category",
          "type": "string",
          "required": true,
          "description": "自定义一级类型",
          "example": "娱乐明星"
        },
        {
          "name": "L2Category",
          "type": "string",
          "required": true,
          "description": "自定义二级类型",
          "example": "张三"
        }
      ],
      "required": [
        "L1Category",
        "L2Category"
      ]
    },
    {
      "name": "CreateCustomGroup",
      "description": "创建自定义人物库 Bucket的格式参考为 `bucketName-123456.cos.ap-shanghai.myqcloud.com` 在调用CreateCustomPerson和AddCustomPersonImage接口之前，请先确保本接口成功调用。当前每个用户只支持一个自定义人物库，一旦自定义人物库创建成功，后续接口调用均会返回人物库已存在错误。 由于人脸图片对于自定义人物识别至关重要，因此自定义人物识别功能需要用户显式指定COS存储桶方可使用。具\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Bucket",
          "type": "string",
          "required": true,
          "description": "人脸图片COS存储桶Host地址",
          "example": "bk0-1234.cos.ap-shanghai.myqcloud.com"
        }
      ],
      "required": [
        "Bucket"
      ]
    },
    {
      "name": "CreateCustomPerson",
      "description": "创建自定义人物。 输入人物名称，基本信息，分类信息与人脸图片，创建自定义人物 人脸图片可使用图片数据(base64编码的图片数据)或者图片URL(推荐使用COS以减少下载时间，其他地址也支持)，原始图片优先，也即如果同时指定了图片数据和图片URL，接口将仅使用图片数据",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "自定义人物姓名",
          "example": "张三"
        },
        {
          "name": "BasicInfo",
          "type": "string",
          "required": true,
          "description": "自定义人物简要信息(仅用于标记，不支持检索)",
          "example": "一线娱乐明星"
        },
        {
          "name": "CategoryId",
          "type": "string",
          "required": true,
          "description": "自定义分类ID，如不存在接口会报错",
          "example": "\"11\""
        },
        {
          "name": "ImageURL",
          "type": "string",
          "required": false,
          "description": "自定义人物图片URL，可支持任意地址，推荐使用COS",
          "example": "http://b0-123.cos.ap-shanghai.myqcloud.com/hello.jpg"
        },
        {
          "name": "Image",
          "type": "string",
          "required": false,
          "description": "原始图片base64编码后的数据",
          "example": "Qk0WWgsAAADYAoAAA...AtQEAADcCAAABABPD"
        }
      ],
      "required": [
        "Name",
        "BasicInfo",
        "CategoryId"
      ]
    },
    {
      "name": "CreateDefaultCategories",
      "description": "创建默认自定义人物类型",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "CreateTask",
      "description": "创建智能标签任务。 请注意，本接口为异步接口，**返回TaskId只代表任务创建成功，不代表任务执行成功**。",
      "status": "online",
      "parameters": [
        {
          "name": "MediaId",
          "type": "string",
          "required": true,
          "description": "媒资文件ID",
          "example": "\"media-2aHsU6sj\""
        },
        {
          "name": "MediaPreknownInfo",
          "type": "object",
          "required": true,
          "description": "媒资素材先验知识，相关限制参考MediaPreknownInfo",
          "example": "无",
          "children": [
            {
              "name": "MediaType",
              "type": "integer",
              "required": true,
              "description": "媒资文件类型，参见MediaPreknownInfo结构体定义",
              "example": "1"
            },
            {
              "name": "MediaLabel",
              "type": "integer",
              "required": true,
              "description": "媒资素材一级类型，参见MediaPreknownInfo结构体定义",
              "example": "1"
            },
            {
              "name": "MediaSecondLabel",
              "type": "integer",
              "required": true,
              "description": "媒资素材二级类型，参见MediaPreknownInfo结构体定义 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "1"
            },
            {
              "name": "MediaLang",
              "type": "integer",
              "required": false,
              "description": "媒资音频类型，参见MediaPreknownInfo结构体定义 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "1"
            }
          ]
        },
        {
          "name": "TaskName",
          "type": "string",
          "required": false,
          "description": "任务名称，最长100个中文字符",
          "example": "\"新闻30分\""
        },
        {
          "name": "UploadVideo",
          "type": "boolean",
          "required": false,
          "description": "是否上传转码后的视频，仅设置true时上传，默认为false",
          "example": "false"
        },
        {
          "name": "Label",
          "type": "string",
          "required": false,
          "description": "自定义标签，可用于查询",
          "example": "新闻"
        },
        {
          "name": "CallbackURL",
          "type": "string",
          "required": false,
          "description": "任务分析完成的回调地址，该设置优先级高于控制台全局的设置；",
          "example": "http://example.com/api/callback"
        }
      ],
      "required": [
        "MediaId",
        "MediaPreknownInfo"
      ]
    },
    {
      "name": "CreateVideoSummaryTask",
      "description": "创建一个视频缩编任务。 ### 回调事件消息通知协议 #### 网络协议 - 回调接口协议目前仅支持http/https协议； - 请求：HTTP POST 请求，包体内容为 JSON，每一种消息的具体包体内容参见后文。 - 应答：HTTP STATUS CODE = 200，服务端忽略应答包具体内容，为了协议友好，建议客户应答内容携带 JSON： `{\"code\":0}` #### 通知可靠性 事件通知服务具备重试能力，事件通知失败后会总计重试3次； \ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "SummaryType",
          "type": "integer",
          "required": true,
          "description": "目前只支持 1，表示新闻缩编。",
          "example": "1"
        },
        {
          "name": "VideoURL",
          "type": "string",
          "required": true,
          "description": "待处理的视频的URL，目前只支持*不带签名的*COS地址，长度最长1KB",
          "example": "cos://my-release-9327555674/d833e1e4bb2.mp4"
        },
        {
          "name": "CallbackURL",
          "type": "string",
          "required": false,
          "description": "任务处理完成的回调地址。",
          "example": "http://example.com/api/callback"
        },
        {
          "name": "WriteBackCosPath",
          "type": "string",
          "required": false,
          "description": "如果需要你输出 TTS 或者视频，该字段为转存的cos桶地址且不可为空; 示例：https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${PathPrefix}/ (注意，cos路径需要以/分隔符结尾)。",
          "example": "https://my-release-9327555674.cos.ap-guangzhou.myqcloud.com/writedir/"
        },
        {
          "name": "ActiveVideoGenerate",
          "type": "boolean",
          "required": false,
          "description": "是否开启结果视频生成功能，如果开启，需要指定WriteBackCosPath 参数",
          "example": "true"
        },
        {
          "name": "VideoRotationMode",
          "type": "object",
          "required": false,
          "description": "生成结果视频的时候，控制生成的结果视频的横转竖参数。如果 ActiveVideoGenerate 为 false, 该参数无效。",
          "example": "无",
          "children": [
            {
              "name": "ActiveVideoRotation",
              "type": "boolean",
              "required": true,
              "description": "生成的视频是否需要横屏转竖屏。",
              "example": "true"
            }
          ]
        },
        {
          "name": "TTSMode",
          "type": "object",
          "required": false,
          "description": "语音合成相关的控制参数",
          "example": "无",
          "children": [
            {
              "name": "Speed",
              "type": "float",
              "required": false,
              "description": "语速，范围：[-2，2]，分别对应不同语速： -2代表0.6倍 -1代表0.8倍 0代表1.0倍（默认） 1代表1.2倍 2代表1.5倍 如果需要更细化的语速，可以保留小数点后 2 位，例如0.5/1.25/2.81等。",
              "example": "1"
            },
            {
              "name": "VoiceType",
              "type": "integer",
              "required": false,
              "description": "音色 ID，[音色体验地址](https://cloud.tencent.com/product/tts)。 |音乐ID|音色名称|推荐场景| |--|--|--| |1001|智瑜|情感女声| |1002|智聆|通用女声| |1003|智美|客服女声| |1004|智云|通用男声| |1005|智莉|通用女声| |1007|智娜|客服女声| |1008|智琪|客服女声| |1009|智芸|知性女声| |1010|智华|通用男声| |1017|智蓉|情感女声| |1018|智靖|情感男声|",
              "example": "1001"
            }
          ]
        },
        {
          "name": "ActiveTTSOutput",
          "type": "boolean",
          "required": false,
          "description": "是否输出合成好的语音列表。",
          "example": "true"
        },
        {
          "name": "ExactAsrSet",
          "type": "array",
          "required": false,
          "description": "用户指定的精确的 asr 结果列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Content",
              "type": "string",
              "required": true,
              "description": "ASR提取的文字信息",
              "example": "\"欢迎收看新闻30分\""
            },
            {
              "name": "StartTimeStamp",
              "type": "float",
              "required": true,
              "description": "ASR起始时间戳，从0开始",
              "example": "0.52"
            },
            {
              "name": "EndTimeStamp",
              "type": "float",
              "required": true,
              "description": "ASR结束时间戳，从0开始",
              "example": "1.92"
            }
          ]
        },
        {
          "name": "ExactTextSummary",
          "type": "string",
          "required": false,
          "description": "用户指定的精确的文本摘要",
          "example": "\"文本摘要\""
        },
        {
          "name": "ExactTextSegSet",
          "type": "array",
          "required": false,
          "description": "用户指定的精确的文本摘要分割结果",
          "example": "[\"文本摘要分割1\", \"文本摘要分割2\"]",
          "item_type": "string"
        },
        {
          "name": "ExactShotSegSet",
          "type": "array",
          "required": false,
          "description": "用户指定的精确的镜头分割结果",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "StartTimeStamp",
              "type": "float",
              "required": true,
              "description": "镜头开始时间 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "0.52"
            },
            {
              "name": "EndTimeStamp",
              "type": "float",
              "required": true,
              "description": "镜头结束时间 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "1.92"
            }
          ]
        }
      ],
      "required": [
        "SummaryType",
        "VideoURL"
      ]
    },
    {
      "name": "DeleteCustomCategory",
      "description": "删除自定义分类信息",
      "status": "online",
      "parameters": [
        {
          "name": "CategoryId",
          "type": "string",
          "required": true,
          "description": "自定义分类ID",
          "example": "\"99\""
        }
      ],
      "required": [
        "CategoryId"
      ]
    },
    {
      "name": "DeleteCustomPerson",
      "description": "删除自定义人物",
      "status": "online",
      "parameters": [
        {
          "name": "PersonId",
          "type": "string",
          "required": true,
          "description": "待删除的自定义人物ID",
          "example": "person-Axgo3FYc"
        }
      ],
      "required": [
        "PersonId"
      ]
    },
    {
      "name": "DeleteCustomPersonImage",
      "description": "删除自定义人脸数据",
      "status": "online",
      "parameters": [
        {
          "name": "PersonId",
          "type": "string",
          "required": true,
          "description": "自定义人物Id",
          "example": "person-Axgo3FYc"
        },
        {
          "name": "ImageId",
          "type": "string",
          "required": true,
          "description": "自定义人脸图片Id",
          "example": "image-Axgo3FYc-GOeV"
        }
      ],
      "required": [
        "PersonId",
        "ImageId"
      ]
    },
    {
      "name": "DeleteMedia",
      "description": "将MediaId对应的媒资文件从系统中删除。 **请注意，本接口仅删除媒资文件，媒资文件对应的视频分析结果不会被删除**。如您需要删除结构化分析结果，请调用DeleteTask接口。",
      "status": "online",
      "parameters": [
        {
          "name": "MediaId",
          "type": "string",
          "required": true,
          "description": "媒资文件在系统中的ID",
          "example": "\"media-2aHsU6sj\""
        }
      ],
      "required": [
        "MediaId"
      ]
    },
    {
      "name": "DeleteTask",
      "description": "删除任务信息 请注意，本接口**不会**删除媒资文件 只有已完成(成功或者失败)的任务可以删除，**正在执行中的任务不支持删除**",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务Id",
          "example": "task-g8lqk737"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DescribeCustomCategories",
      "description": "批量描述自定义人物分类信息",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeCustomGroup",
      "description": "描述自定义人物库信息，当前库大小(库中有多少人脸)，以及库中的存储桶",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeCustomPersonDetail",
      "description": "描述自定义人物详细信息，包括人物信息与人物信息",
      "status": "online",
      "parameters": [
        {
          "name": "PersonId",
          "type": "string",
          "required": true,
          "description": "自定义人物Id",
          "example": "person-Axgo3FYc"
        }
      ],
      "required": [
        "PersonId"
      ]
    },
    {
      "name": "DescribeCustomPersons",
      "description": "批量描述自定义人物",
      "status": "online",
      "parameters": [
        {
          "name": "PageNumber",
          "type": "integer",
          "required": true,
          "description": "分页序号，从1开始",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "分页数据行数，最多50",
          "example": "50"
        },
        {
          "name": "SortBy",
          "type": "object",
          "required": false,
          "description": "排序信息，默认倒序",
          "example": "无",
          "children": [
            {
              "name": "By",
              "type": "string",
              "required": false,
              "description": "排序字段，默认为CreateTime",
              "example": "CreateTime"
            },
            {
              "name": "Descend",
              "type": "boolean",
              "required": false,
              "description": "true表示降序，false表示升序",
              "example": "true"
            }
          ]
        },
        {
          "name": "Filter",
          "type": "object",
          "required": false,
          "description": "自定义人物过滤条件",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "待查询的人物姓名",
              "example": "张三"
            },
            {
              "name": "CategoryIdSet",
              "type": "array",
              "required": true,
              "description": "待过滤的自定义类型Id数组",
              "example": "[\"10\", \"99\"]",
              "item_type": "string"
            },
            {
              "name": "PersonIdSet",
              "type": "array",
              "required": true,
              "description": "待过滤的自定义人物Id数组",
              "example": "[\"person-Axgo3FYc\", \"person-Bxgo3FYc\"]",
              "item_type": "string"
            },
            {
              "name": "L1CategorySet",
              "type": "array",
              "required": true,
              "description": "一级自定义人物类型数组",
              "example": "[\"喜剧明星\", \"话剧明星\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "PageNumber",
        "PageSize"
      ]
    },
    {
      "name": "DescribeMedia",
      "description": "描述媒资文件信息，包括媒资状态，分辨率，帧率等。 如果媒资文件未完成导入，本接口将仅输出媒资文件的状态信息；导入完成后，本接口还将输出媒资文件的其他元信息。",
      "status": "online",
      "parameters": [
        {
          "name": "MediaId",
          "type": "string",
          "required": true,
          "description": "导入媒资返回的媒资ID",
          "example": "\"media-2aHsU6sj\""
        }
      ],
      "required": [
        "MediaId"
      ]
    },
    {
      "name": "DescribeMedias",
      "description": "依照输入条件，描述命中的媒资文件信息，包括媒资状态，分辨率，帧率等。 请注意，本接口最多支持同时描述**50**个媒资文件 如果媒资文件未完成导入，本接口将仅输出媒资文件的状态信息；导入完成后，本接口还将输出媒资文件的其他元信息。",
      "status": "online",
      "parameters": [
        {
          "name": "PageNumber",
          "type": "integer",
          "required": true,
          "description": "分页序号，从1开始",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "每个分页所包含的元素数量，最大为50",
          "example": "15"
        },
        {
          "name": "MediaFilter",
          "type": "object",
          "required": false,
          "description": "列举过滤条件，相关限制相见MediaFilter",
          "example": "无",
          "children": [
            {
              "name": "MediaNameSet",
              "type": "array",
              "required": false,
              "description": "媒资名称过滤条件",
              "example": "[\"新闻30分\",\"朝闻天下\"]",
              "item_type": "string"
            },
            {
              "name": "StatusSet",
              "type": "array",
              "required": false,
              "description": "媒资状态数组，媒资状态可选值参见MediaInfo",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "MediaIdSet",
              "type": "array",
              "required": false,
              "description": "媒资ID数组",
              "example": "[\"59\",\"108\"]",
              "item_type": "string"
            },
            {
              "name": "LabelSet",
              "type": "array",
              "required": false,
              "description": "媒资自定义标签数组",
              "example": "[\"新闻\"]",
              "item_type": "string"
            },
            {
              "name": "MediaType",
              "type": "integer",
              "required": false,
              "description": "媒资文件类型，定义参见[MediaPreknownInfo.MediaType](https://cloud.tencent.com/document/product/1509/65063#MediaPreknownInfo)",
              "example": "2"
            }
          ]
        },
        {
          "name": "SortBy",
          "type": "object",
          "required": false,
          "description": "返回结果排序信息，By字段只支持CreateTime",
          "example": "无",
          "children": [
            {
              "name": "By",
              "type": "string",
              "required": false,
              "description": "排序字段，默认为CreateTime",
              "example": "CreateTime"
            },
            {
              "name": "Descend",
              "type": "boolean",
              "required": false,
              "description": "true表示降序，false表示升序",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "PageNumber",
        "PageSize"
      ]
    },
    {
      "name": "DescribeTask",
      "description": "描述智能标签任务进度。 请注意，**此接口仅返回任务执行状态信息，不返回任务执行结果**",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "CreateTask返回的任务ID",
          "example": "\"task-g8lqk737\""
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DescribeTaskDetail",
      "description": "描述任务信息，如果任务成功完成，还将返回任务结果",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "创建任务返回的TaskId",
          "example": "\"task-g8lqk737\""
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DescribeTasks",
      "description": "依照输入条件，描述命中的任务信息，包括任务创建时间，处理时间信息等。 请注意，本接口最多支持同时描述**50**个任务信息",
      "status": "online",
      "parameters": [
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "分页序号，从1开始",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每个分页所包含的元素数量，最大为50",
          "example": "15"
        },
        {
          "name": "TaskFilter",
          "type": "object",
          "required": false,
          "description": "任务过滤条件，相关限制参见TaskFilter",
          "example": "无",
          "children": [
            {
              "name": "MediaTypeSet",
              "type": "array",
              "required": false,
              "description": "媒资文件类型",
              "example": "[2]",
              "item_type": "integer"
            },
            {
              "name": "TaskStatusSet",
              "type": "array",
              "required": false,
              "description": "待筛选的任务状态列表",
              "example": "[1,2,3]",
              "item_type": "integer"
            },
            {
              "name": "TaskNameSet",
              "type": "array",
              "required": false,
              "description": "待筛选的任务名称数组",
              "example": "[\"xx新闻\",\"yy新闻\"]",
              "item_type": "string"
            },
            {
              "name": "TaskIdSet",
              "type": "array",
              "required": false,
              "description": "TaskId数组",
              "example": "[\"task-g8lqk737\", \"task-b8lqk738\"]",
              "item_type": "string"
            },
            {
              "name": "MediaNameSet",
              "type": "array",
              "required": false,
              "description": "媒资文件名数组",
              "example": "[\"xx新闻\"]",
              "item_type": "string"
            },
            {
              "name": "MediaLangSet",
              "type": "array",
              "required": false,
              "description": "媒资语言类型",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "MediaLabelSet",
              "type": "array",
              "required": false,
              "description": "媒资素材一级类型",
              "example": "[1,3]",
              "item_type": "integer"
            },
            {
              "name": "LabelSet",
              "type": "array",
              "required": false,
              "description": "媒资自定义标签数组",
              "example": "[\"新闻\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "SortBy",
          "type": "object",
          "required": false,
          "description": "返回结果排序信息，By字段只支持CreateTimeStamp",
          "example": "无",
          "children": [
            {
              "name": "By",
              "type": "string",
              "required": false,
              "description": "排序字段，默认为CreateTime",
              "example": "CreateTime"
            },
            {
              "name": "Descend",
              "type": "boolean",
              "required": false,
              "description": "true表示降序，false表示升序",
              "example": "true"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DescribeUsageAmount",
      "description": "获取用户资源使用量",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeVideoSummaryDetail",
      "description": "描述任务信息，如果任务成功完成，还将返回任务结果",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "要查询的任务Id",
          "example": "task-g8lqk737"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "ImportMedia",
      "description": "将URL指向的媒资视频文件导入系统之中。 **请注意，本接口为异步接口**。接口返回MediaId仅代表导入视频任务发起，不代表任务完成，您可调用读接口(DescribeMedia/DescribeMedias)接口查询MediaId URL字段推荐您使用COS地址，其形式为`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}`，其中`${Bucket}`为您的COS桶名称，Region为COS桶所在[可用区](https://cloud.tencent.com/document/product/213/6091)，`${O...",
      "status": "online",
      "parameters": [
        {
          "name": "URL",
          "type": "string",
          "required": true,
          "description": "待分析视频的URL，目前只支持不带签名的COS地址，字段输入内容最大为1KB",
          "example": "cos://my-release-9327555674/d833e1e4bb2.mp4"
        },
        {
          "name": "MD5",
          "type": "string",
          "required": false,
          "description": "待分析视频的MD5，为空时不做校验，否则会做MD5校验，长度必须为32",
          "example": "9207adf18198dd5b165aae0bdd8f709d"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "待分析视频的名称，指定后可支持筛选，视频名称的大小长度不能超过64",
          "example": "新闻30分"
        },
        {
          "name": "WriteBackCosPath",
          "type": "string",
          "required": false,
          "description": "当非本人外部视频地址导入时，该字段为转存的cos桶地址且不可为空; 示例：https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${PathPrefix}/ (注意，cos路径需要以/分隔符结尾)。推荐采用本主账号COS桶，如果使用其他账号COS桶，请确保COS桶可写，否则可导致分析失败",
          "example": "https://my-release-9327555674.cos.ap-guangzhou.myqcloud.com/d833e1e4bb2.mp4"
        },
        {
          "name": "Label",
          "type": "string",
          "required": false,
          "description": "自定义标签，可用于查询",
          "example": "新闻"
        },
        {
          "name": "CallbackURL",
          "type": "string",
          "required": false,
          "description": "媒资导入完成的回调地址，该设置优先级高于控制台全局的设置；",
          "example": "http://example.com/api/callback"
        },
        {
          "name": "MediaType",
          "type": "integer",
          "required": false,
          "description": "媒资文件类型，详细定义参见MediaPreknownInfo.MediaType默认为2(视频)",
          "example": "2"
        }
      ],
      "required": [
        "URL"
      ]
    },
    {
      "name": "ModifyCallback",
      "description": "用户设置对应事件的回调地址 ### 回调事件消息通知协议 #### 网络协议 - 回调接口协议目前仅支持http/https协议； - 请求：HTTP POST 请求，包体内容为 JSON，每一种消息的具体包体内容参见后文。 - 应答：HTTP STATUS CODE = 200，服务端忽略应答包具体内容，为了协议友好，建议客户应答内容携带 JSON： `{\"code\":0}` #### 通知可靠性 事件通知服务具备重试能力，事件通知失败后会总计重试3\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "TaskFinishNotifyURL",
          "type": "string",
          "required": true,
          "description": "任务分析完成后回调地址",
          "example": "http://example.com/api/task/callback"
        },
        {
          "name": "MediaFinishNotifyURL",
          "type": "string",
          "required": true,
          "description": "媒体导入完成后回调地址",
          "example": "http://example.com/api/media/callback"
        }
      ],
      "required": [
        "TaskFinishNotifyURL",
        "MediaFinishNotifyURL"
      ]
    },
    {
      "name": "QueryCallback",
      "description": "查询用户回调设置",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "UpdateCustomCategory",
      "description": "更新自定义人物分类 当L2Category为空时，代表更新CategoryId对应的一级自定义人物类型以及所有二级自定义人物类型所从属的一级自定义人物类型； 当L2Category非空时，仅更新CategoryId对应的二级自定义人物类型",
      "status": "online",
      "parameters": [
        {
          "name": "CategoryId",
          "type": "string",
          "required": true,
          "description": "自定义人物类型Id",
          "example": "\"2\""
        },
        {
          "name": "L1Category",
          "type": "string",
          "required": true,
          "description": "一级自定义人物类型",
          "example": "公众人物"
        },
        {
          "name": "L2Category",
          "type": "string",
          "required": false,
          "description": "二级自定义人物类型",
          "example": "娱乐明星"
        }
      ],
      "required": [
        "CategoryId",
        "L1Category"
      ]
    },
    {
      "name": "UpdateCustomPerson",
      "description": "更新自定义人物信息，包括姓名，简要信息，分类信息等",
      "status": "online",
      "parameters": [
        {
          "name": "PersonId",
          "type": "string",
          "required": true,
          "description": "待更新的自定义人物Id",
          "example": "person-Axgo3FYc"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "更新后的自定义人物名称，如为空则不更新",
          "example": "李四"
        },
        {
          "name": "BasicInfo",
          "type": "string",
          "required": false,
          "description": "更新后的自定义人物简介，如为空则不更新",
          "example": "喜剧明星"
        },
        {
          "name": "CategoryId",
          "type": "string",
          "required": false,
          "description": "更新后的分类信息，如为空则不更新",
          "example": "10"
        }
      ],
      "required": [
        "PersonId"
      ]
    }
  ]
}