AppearIndexPair
出现信息索引对
AppearIndex可选值定义如下：
| AppearIndex名称 | AppearIndex取值 | AppearIndex描述 |
|---|---|---|
| APPEAR_INDEX_INVALID | 0 | 非法的任务状态 |
| APPEAR_INDEX_AUDIO | 1 | 音频出现信息 |
| APPEAR_INDEX_TEXT | 2 | 可视文本出现信息 |
| APPEAR_INDEX_VIDEO | 3 | 视频出现信息 |
例如，当AppearIndex=1，Index=15，则意味着目标关键词出现在第16个(Index计数从0开始)音频文字识别结果之中
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| AppearIndex | Integer | 出现信息，取值范围为[1，3] 示例值：1 |
| Index | Integer | AppearInfo中AppearIndex对应元素的第Index元素，从0开始计数 示例值：50 |
AppearInfo
出现信息结构
包含关键词在音频转文字(ASR)，图片转文字(OCR)以及视频结果中的出现信息
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| AudioAppearSet | Array of TextAppearInfo | 关键词在音频文本结果中的出现位置数组 注意：此字段可能返回 null，表示取不到有效值。 |
| TextAppearSet | Array of TextAppearInfo | 关键词在可视文本结果中的出现位置数组 注意：此字段可能返回 null，表示取不到有效值。 |
| VideoAppearSet | Array of VideoAppearInfo | 关键词在视频信息中的出现位置数组 注意：此字段可能返回 null，表示取不到有效值。 |
AsrResult
一条 asr 语音结果的结构
被如下接口引用：CreateVideoSummaryTask, DescribeVideoSummaryDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Content | String | 是 | ASR提取的文字信息 示例值："欢迎收看新闻30分" |
| StartTimeStamp | Float | 是 | ASR起始时间戳，从0开始 示例值：0.52 |
| EndTimeStamp | Float | 是 | ASR结束时间戳，从0开始 示例值：1.92 |
AudioData
音频文件分析结果数据
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| AudioInfoSet | Array of AudioInfo | 音频识别文本结果 注意：此字段可能返回 null，表示取不到有效值。 |
| TextTagSet | MultiLevelTag | 音频识别标签数据 |
AudioInfo
音频识别结果信息
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | String | ASR提取的文字信息 示例值："欢迎收看新闻30分" |
| StartTimeStamp | Float | ASR起始时间戳，从0开始 示例值：0.52 |
| EndTimeStamp | Float | ASR结束时间戳，从0开始 示例值：0.92 |
| Tag | String | ASR提取的音频标签 示例值："导语" |
AudioMetadata
音频文件元信息
被如下接口引用：DescribeMedia, DescribeMedias, DescribeTask, DescribeTaskDetail, DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileSize | Integer | 媒资音频文件大小，单位为Byte 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| MD5 | String | 媒资音频文件MD5 注意：此字段可能返回 null，表示取不到有效值。 示例值：bbc3f6c9fb18d80dedf28239f9a86fac |
| Duration | Float | 媒资音频时长，单位为秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：20.00 |
| SampleRate | Float | 媒资音频采样率，单位为khz 注意：此字段可能返回 null，表示取不到有效值。 示例值：44.1 |
| BitRate | Integer | 媒资音频码率，单位为kbps 注意：此字段可能返回 null，表示取不到有效值。 示例值：128 |
| Format | String | 媒资音频文件格式 注意：此字段可能返回 null，表示取不到有效值。 示例值：mp3 |
ClassifiedPersonInfo
已分类的人物信息
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClassifyName | String | 人物分类名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：演员 |
| PersonInfoSet | Array of PersonInfo | 符合特定分类的人物信息数组 注意：此字段可能返回 null，表示取不到有效值。 |
CustomCategory
自定义分类信息
被如下接口引用：DescribeCustomCategories。
| 名称 | 类型 | 描述 |
|---|---|---|
| CategoryId | String | 自定义分类ID 示例值："123" |
| L1Category | String | 一级自定义类型 示例值：娱乐明星 |
| L2Category | String | 二级自定义类型 示例值：张三 |
CustomPersonFilter
自定义人物批量查询过滤条件
被如下接口引用：DescribeCustomPersons。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 待查询的人物姓名 示例值：张三 |
| CategoryIdSet | Array of String | 是 | 待过滤的自定义类型Id数组 示例值：["123", "456"] |
| PersonIdSet | Array of String | 是 | 待过滤的自定义人物Id数组 示例值：["person-a1", "person-a2"] |
| L1CategorySet | Array of String | 是 | 一级自定义人物类型数组 示例值：["喜剧明星", "话剧明星"] |
CustomPersonInfo
自定义人物信息
被如下接口引用：DescribeCustomPersonDetail, DescribeCustomPersons。
| 名称 | 类型 | 描述 |
|---|---|---|
| PersonId | String | 自定义人物Id 示例值：person-a1b2c3 |
| Name | String | 自定义人物姓名 示例值：张三 |
| BasicInfo | String | 自定义人物简介信息 示例值：著名喜剧明星 |
| L1Category | String | 一级自定义人物类型 示例值：娱乐明星 |
| L2Category | String | 二级自定义人物类型 示例值：喜剧演员 |
| ImageInfoSet | Array of PersonImageInfo | 自定义人物图片信息 |
| CreateTime | String | 自定义人物创建时间 示例值：2022-01-25 10:35:47 |
Data
任务结果数据
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ShowInfo | ShowInfo | 节目粒度结构化结果 注意：此字段可能返回 null，表示取不到有效值。 |
ImageData
图片文件标签结果
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| OcrSet | Array of ImageOcr | 图片中出现的可视文本识别结果 注意：此字段可能返回 null，表示取不到有效值。 |
| FrameTagSet | MultiLevelTag | 图片中出现的帧标签识别结果 注意：此字段可能返回 null，表示取不到有效值。 |
| MultiLevelPersonInfoSet | Array of MultiLevelPersonInfo | 图片中出现的层级人物识别结果 注意：此字段可能返回 null，表示取不到有效值。 |
| TvLogo | ImageLogo | 图片中出现的台标识别结果 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceLogo | ImageLogo | 图片中出现的来源信息识别结果 注意：此字段可能返回 null，表示取不到有效值。 |
ImageLogo
图片中出现的Logo信息
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Logo | String | 图片中出现的Logo识别结果 注意：此字段可能返回 null，表示取不到有效值。 示例值：“山东卫视” |
| AppearRect | Rectf | Logo在图片中出现的位置 注意：此字段可能返回 null，表示取不到有效值。 |
ImageMetadata
图片文件元信息
被如下接口引用：DescribeMedia, DescribeMedias, DescribeTask, DescribeTaskDetail, DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileSize | Integer | 媒资图片文件大小，单位为Byte 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| MD5 | String | 媒资图片文件MD5 注意：此字段可能返回 null，表示取不到有效值。 示例值：bbc3f6c9fb18d80dedf28239f9a86fac |
| Width | Integer | 媒资图片文件宽度 注意：此字段可能返回 null，表示取不到有效值。 示例值：1920 |
| Height | Integer | 媒资图片文件高度 注意：此字段可能返回 null，表示取不到有效值。 示例值：1080 |
| Format | String | 媒资图片文件格式 注意：此字段可能返回 null，表示取不到有效值。 示例值：jpg |
ImageOcr
图片OCR识别结果
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | String | 图片中可视文本识别结果 注意：此字段可能返回 null，表示取不到有效值。 示例值：“欢迎收看测试新闻” |
| AppearRect | Rectf | 可视文本在图片中的位置信息 注意：此字段可能返回 null，表示取不到有效值。 |
L1Tag
一级标签信息
请注意，一级标签信息可能不包含二级标签(此时L2TagSet为空)。在这种情况下，一级标签可直接包含出现信息。
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 一级标签名 示例值："地点" |
| L2TagSet | Array of L2Tag | 二级标签数组 注意：此字段可能返回 null，表示取不到有效值。 |
| AppearIndexPairSet | Array of AppearIndexPair | 一级标签出现信息 注意：此字段可能返回 null，表示取不到有效值。 |
| FirstAppear | Integer | 一级标签首次出现信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
L2Tag
二级标签信息
请注意，二级标签信息可能不包含三级标签(此时L3TagSet为空)。
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 二级标签名 示例值："地点" |
| L3TagSet | Array of L3Tag | 从属于此二级标签的三级标签数组 注意：此字段可能返回 null，表示取不到有效值。 |
| AppearIndexPairSet | Array of AppearIndexPair | 二级标签出现信息 注意：此字段可能返回 null，表示取不到有效值。 |
| FirstAppear | Integer | 二级标签首次出现信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
L3Tag
三级标签信息。
三级标签不再包含任何子标签。所有三级标签都对应着识别结果中的出现信息，出现信息使用AppearIndexPairSet定位。
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 三级标签名 示例值："成都" |
| AppearIndexPairSet | Array of AppearIndexPair | 三级标签出现信息索引数组 注意：此字段可能返回 null，表示取不到有效值。 |
| FirstAppear | Integer | 三级标签首次出现信息，可选值为[1,3] 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
MediaFilter
媒资过滤条件
被如下接口引用：DescribeMedias。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MediaNameSet | Array of String | 否 | 媒资名称过滤条件 示例值：["新闻30分","朝闻天下"] |
| StatusSet | Array of Integer | 否 | 媒资状态数组，媒资状态可选值参见MediaInfo 示例值：[1,2] |
| MediaIdSet | Array of String | 否 | 媒资ID数组 示例值：["123","456"] |
| LabelSet | Array of String | 否 | 媒资自定义标签数组 示例值：["tag1"] |
| MediaType | Integer | 否 | 媒资文件类型，定义参见MediaPreknownInfo.MediaType 示例值：2 |
MediaInfo
媒资信息结构体
媒资状态定义如下：
| 状态名 | 状态值 | 状态描述 |
|---|---|---|
| MEDIA_STATUS_INVALID | 0 | 非法状态 |
| MEDIA_STATUS_WAITING | 1 | 等待中 |
| MEDIA_STATUS_DOWNLOADING | 2 | 下载中 |
| MEDIA_STATUS_DOWNLOADED | 3 | 下载完成 |
| MEDIA_STATUS_DOWNLOAD_FAILED | 4 | 下载失败(已废弃) |
| MEDIA_STATUS_TRANSCODING | 5 | 转码中 |
| MEDIA_STATUS_TRANSCODED | 6 | 转码完成 |
| MEDIA_STATUS_TRANCODE_FAILED | 7 | 转码失败(已废弃) |
| MEDIA_STATUS_SUCCESS | 8 | 媒资文件状态就绪，可发起任务 |
| MEDIA_STATUS_EXPIRED | 9 | 媒资文件已过期 |
| MEDIA_STATUS_FAILED | 10 | 媒资导入失败 |
被如下接口引用：DescribeMedia, DescribeMedias。
| 名称 | 类型 | 描述 |
|---|---|---|
| MediaId | String | 媒资ID 示例值：“123456” |
| Name | String | 媒资名称 注意：此字段可能返回 null，表示取不到有效值。 示例值："新闻30分" |
| DownLoadURL | String | 媒资下载地址 注意：此字段可能返回 null，表示取不到有效值。 示例值："http://example-bucket/example-key.mp4" |
| Status | Integer | 媒资状态，取值参看上方表格 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| FailedReason | String | 若状态为失败，表示失败原因 注意：此字段可能返回 null，表示取不到有效值。 示例值："下载失败" |
| Metadata | MediaMetadata | 媒资视频元信息，仅在MediaType=VIDEO时有效 注意：此字段可能返回 null，表示取不到有效值。 |
| Progress | Float | 导入视频进度，取值范围为[0,100] 注意：此字段可能返回 null，表示取不到有效值。 示例值：30.0 |
| Label | String | 媒资自定义标签 注意：此字段可能返回 null，表示取不到有效值。 示例值："tag" |
| CallbackURL | String | 媒资导入完成后的回调地址 注意：此字段可能返回 null，表示取不到有效值。 示例值："http://callback.com/callback" |
| MediaType | Integer | 媒资文件类型，具体参看MediaPreknownInfo 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| AudioMetadata | AudioMetadata | 媒资音频元信息，仅在MediaType=Audio时有效 注意：此字段可能返回 null，表示取不到有效值。 |
| ImageMetadata | ImageMetadata | 媒资图片文件元信息，仅在MediaType=Image时有效 注意：此字段可能返回 null，表示取不到有效值。 |
| TextMetadata | TextMetadata | 媒资文本文件元信息，仅在MediaType=Text时有效 注意：此字段可能返回 null，表示取不到有效值。 |
MediaMetadata
媒资文件视频元信息，包括分辨率，帧率，码率等
被如下接口引用：DescribeMedia, DescribeMedias, DescribeTask, DescribeTaskDetail, DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileSize | Integer | 媒资视频文件大小，单位为字节 示例值：340000 |
| MD5 | String | 媒资视频文件MD5 示例值："d228d21b68688c14dcb7275b806398fc" |
| Duration | Float | 媒资视频时长，单位为秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：20.00 |
| NumFrames | Integer | 媒资视频总帧数 注意：此字段可能返回 null，表示取不到有效值。 示例值：500 |
| Width | Integer | 媒资视频宽度，单位为像素 注意：此字段可能返回 null，表示取不到有效值。 示例值：1920 |
| Height | Integer | 媒资视频高度，单位为像素 注意：此字段可能返回 null，表示取不到有效值。 示例值：1080 |
| FPS | Float | 媒资视频帧率，单位为Hz 注意：此字段可能返回 null，表示取不到有效值。 示例值：25 |
| BitRate | Integer | 媒资视频比特率，单位为kbps 注意：此字段可能返回 null，表示取不到有效值。 示例值：5000 |
MediaPreknownInfo
描述输入媒资的先验知识，例如文件类型(视频)，媒体类型(新闻/综艺等)
MediaPreknownInfo.MediaType:
| MediaType 名称 | MediaType取值 | MediaType描述 |
|---|---|---|
| MEDIA_TYPE_INVALID | 0 | 非法的媒资文件类型 |
| MEDIA_TYPE_IMAGE | 1 | 图片 |
| MEDIA_TYPE_VIDEO | 2 | 视频 |
| MEDIA_TYPE_AUDIO | 3 | 音频 |
| MEDIA_TYPE_VIDEO_STREAM | 4 | 视频流，暂不支持 |
| MEDIA_TYPE_TEXT | 5 | 文本 |
MediaPreknownInfo.MediaLabel:
| MediaLabel名称 | MediaLabel取值 | MediaLabel描述 |
|---|---|---|
| MEDIA_LABEL_INVALID | 0 | 非法的一级媒资素材类型 |
| MEDIA_LABEL_NEWS | 1 | 新闻 |
| MEDIA_LABEL_ENTERTAINMENT | 2 | 综艺 |
| MEDIA_LABEL_INTERNET_INFO | 3 | 互联网资讯 |
| MEDIA_LABEL_MOVIE | 4 | 电影 |
| MEDIA_LABEL_SERIES | 5 | 电视连续剧 |
| MEDIA_LABEL_SPECIAL | 6 | 专题 |
| MEDIA_LABEL_SPORT | 7 | 体育 |
MediaPreknownInfo.MediaSecondLabel
请注意：当且仅当MediaLabel=2(综艺)时MediaSecondLabel才有意义
| MediaSecondLabel名称 | MediaSecondLabel取值 | MediaSecondLabel 描述 |
|---|---|---|
| MEDIA_SECOND_LABEL_INVALID | 0 | 非法的MediaSecondLabel |
| MEDIA_SECOND_LABEL_EVENING | 1 | 综艺晚会 |
| MEDIA_SECOND_LABEL_OTHERS | 2 | 其他 |
MediaMeta.MediaLang
| MediaLang名称 | MediaLang取值 | MediaLang描述 |
|---|---|---|
| MEDIA_LANG_INVALID | 0 | 非法的MediaLang |
| MEDIA_LANG_MANDARIN | 1 | 普通话 |
| MEDIA_LANG_CANTONESE | 2 | 粤语 |
被如下接口引用：CreateTask, DescribeTask, DescribeTaskDetail, DescribeTasks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MediaType | Integer | 是 | 媒资文件类型，参见MediaPreknownInfo结构体定义 示例值：1 |
| MediaLabel | Integer | 是 | 媒资素材一级类型，参见MediaPreknownInfo结构体定义 示例值：1 |
| MediaSecondLabel | Integer | 是 | 媒资素材二级类型，参见MediaPreknownInfo结构体定义 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MediaLang | Integer | 否 | 媒资音频类型，参见MediaPreknownInfo结构体定义 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
MultiLevelPersonInfo
带类型树的已分类人物信息
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| L1ClassifyName | String | 一级分类名称(分类信息参见自定义人物类型) 注意：此字段可能返回 null，表示取不到有效值。 示例值：明星 |
| L2ClassifiedPersonInfoSet | Array of ClassifiedPersonInfo | 已分类人物信息数组(所有分类类型为二级分类) 注意：此字段可能返回 null，表示取不到有效值。 |
| Source | Integer | 检测结果来源 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
MultiLevelTag
标签信息结构体
包含多级(最多三级)标签结果，以及这些标签在识别结果中的出现位置
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| TagSet | Array of L1Tag | 树状标签信息 注意：此字段可能返回 null，表示取不到有效值。 |
| AppearInfo | AppearInfo | 标签在识别结果中的定位信息 注意：此字段可能返回 null，表示取不到有效值。 |
PersonImageInfo
自定义人物人脸图片信息
被如下接口引用：AddCustomPersonImage, CreateCustomPerson, DescribeCustomPersonDetail, DescribeCustomPersons。
| 名称 | 类型 | 描述 |
|---|---|---|
| ImageId | String | 人脸图片ID 示例值："941d96ae-52d9-4401-be6a-fcf1bab6a214" |
| ImageURL | String | 自定义人脸图片的URL，存储在IVLDCustomPreson存储桶内 |
| ErrorCode | String | 自定义人脸图片处理错误码 示例值：OK |
| ErrorMsg | String | 自定义人脸图片处理错误信息 示例值：OK |
PersonInfo
人物信息
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 公众人物姓名 示例值：陈好 |
| Job | String | 公众人物职务 示例值：演员 |
| FirstAppear | Integer | 首次出现模态，可选值为[1,3]，详细参见AppearIndex定义 示例值：1 |
| AppearInfo | AppearInfo | 人物出现信息 |
| AppearRect | Rectf | 人脸在图片中的位置，仅在图片标签任务有效 注意：此字段可能返回 null，表示取不到有效值。 |
Rectf
矩形内容框
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| X | Float | 矩形框左上角水平座标 注意：此字段可能返回 null，表示取不到有效值。 示例值：20 |
| Y | Float | 矩形框左上角竖直座标 注意：此字段可能返回 null，表示取不到有效值。 示例值：20 |
| Width | Float | 矩形框宽度 注意：此字段可能返回 null，表示取不到有效值。 示例值：300 |
| Height | Float | 矩形框长度 注意：此字段可能返回 null，表示取不到有效值。 示例值：20 |
ShotInfo
输入的镜头信息的描述
被如下接口引用：CreateVideoSummaryTask, DescribeVideoSummaryDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| StartTimeStamp | Float | 是 | 镜头开始时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.52 |
| EndTimeStamp | Float | 是 | 镜头结束时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.92 |
ShowInfo
视频结构化结果
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Date | String | 节目日期(只在新闻有效) 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-01-01 |
| Logo | String | 台标 注意：此字段可能返回 null，表示取不到有效值。 示例值：东方卫视 |
| Column | String | 节目名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：东方新闻 |
| Source | String | 来源信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：东方卫视 |
| CoverImageURL | String | 节目封面 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://example-123456.cos.ap-guangzho.myqcloud.com/example-key |
| SummarySet | Array of String | 节目内容概要列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["全运会召开",”神舟飞船升空"] |
| TitleSet | Array of String | 节目片段标题列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["中国共产党第十九届中央委员会第五次全体会议在京召开"] |
| AudioInfoSet | Array of AudioInfo | 音频识别结果列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TextInfoSet | Array of TextInfo | 可视文字识别结果列表 注意：此字段可能返回 null，表示取不到有效值。 |
| ClassifiedPersonInfoSet | Array of ClassifiedPersonInfo | 已分类人物信息列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TextTagSet | MultiLevelTag | 文本标签列表，包含标签内容和出现信息 注意：此字段可能返回 null，表示取不到有效值。 |
| FrameTagSet | MultiLevelTag | 帧标签列表，包括人物信息，场景信息等 注意：此字段可能返回 null，表示取不到有效值。 |
| WebMediaURL | String | 视频下载地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://example-123456.cos.ap-guangzho.myqcloud.com/example-key |
| MediaClassifierSet | Array of String | 媒资分类信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：["会议"] |
| SummaryTagSet | Array of String | 概要标签信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：["全运会"] |
| UnknownPersonSet | Array of UnknownPerson | 未知人物信息 注意：此字段可能返回 null，表示取不到有效值。 |
| MultiLevelPersonInfoSet | Array of MultiLevelPersonInfo | 树状已分类人物信息 注意：此字段可能返回 null，表示取不到有效值。 |
SortBy
排序条件
被如下接口引用：DescribeCustomPersons, DescribeMedias, DescribeTasks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| By | String | 否 | 排序字段，默认为CreateTime 示例值：CreateTime |
| Descend | Boolean | 否 | true表示降序，false表示升序 示例值：true |
TTSMode
TTS 的参数模式
被如下接口引用：CreateVideoSummaryTask。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Speed | Float | 否 | 语速，范围：[-2，2]，分别对应不同语速： -2代表0.6倍 -1代表0.8倍 0代表1.0倍（默认） 1代表1.2倍 2代表1.5倍 如果需要更细化的语速，可以保留小数点后 2 位，例如0.5/1.25/2.81等。 示例值：1 |
| VoiceType | Integer | 否 | 音色 ID，音色体验地址。 |音乐ID|音色名称|推荐场景| |--|--|--| |1001|智瑜|情感女声| |1002|智聆|通用女声| |1003|智美|客服女声| |1004|智云|通用男声| |1005|智莉|通用女声| |1007|智娜|客服女声| |1008|智琪|客服女声| |1009|智芸|知性女声| |1010|智华|通用男声| |1017|智蓉|情感女声| |1018|智靖|情感男声| 示例值：1001 |
TaskFilter
任务筛选条件结构体
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MediaTypeSet | Array of Integer | 否 | 媒资文件类型 示例值：[2] |
| TaskStatusSet | Array of Integer | 否 | 待筛选的任务状态列表 示例值：[1,2,3] |
| TaskNameSet | Array of String | 否 | 待筛选的任务名称数组 示例值：["xx新闻","yy新闻"] |
| TaskIdSet | Array of String | 否 | TaskId数组 示例值：["xyzabcd", "xyz1234"] |
| MediaNameSet | Array of String | 否 | 媒资文件名数组 示例值：["xx新闻"] |
| MediaLangSet | Array of Integer | 否 | 媒资语言类型 示例值：[1,2] |
| MediaLabelSet | Array of Integer | 否 | 媒资素材一级类型 示例值：[1,3] |
| LabelSet | Array of String | 否 | 媒资自定义标签数组 示例值：["tag1"] |
TaskInfo
任务信息
TaskStatus定义如下:
| TaskStatus名称 | TaskStatus取值 | TaskStatus描述 |
|---|---|---|
| TASK_STATUS_INVALID | 0 | 非法的任务状态 |
| TASK_STATUS_WAITING | 1 | 排队中 |
| TASK_STATUS_ANALYSING | 2 | 任务分析中 |
| TASK_STATUS_ANALYSED | 3 | 任务分析完成 |
| TASK_STATUS_SNAPSHOT_CREATING | 4 | 任务结果快照生成中 |
| TASK_STATUS_SNAPSHOT_CREATED | 5 | 任务结果快照生成完成 |
| TASK_STATUS_RESULT_UPLOADING | 6 | 任务结果快照上传中 |
| TASK_STATUS_RESULT_UPLOADED | 7 | 任务结果快照上传完成 |
| TASK_STATUS_SUCCESS | 8 | 任务执行完成 |
| TASK_STATUS_FAILED | 9 | 任务执行失败 |
被如下接口引用：DescribeTask, DescribeTaskDetail, DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID 示例值：“34567” |
| TaskName | String | 描述任务名称，指定后可根据名称筛选 注意：此字段可能返回 null，表示取不到有效值。 示例值："本地新闻" |
| MediaId | String | 媒资文件ID 示例值："media-12345678" |
| TaskStatus | Integer | 任务执行状态 示例值：1 |
| TaskProgress | Float | 任务进度，范围为[0，100] 注意：此字段可能返回 null，表示取不到有效值。 示例值：75 |
| TaskTimeCost | Integer | 任务执行时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：300 |
| TaskCreateTime | String | 任务创建时间 示例值：2006-01-02T15:04:05Z07:00 |
| TaskStartTime | String | 任务开始执行时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2006-01-02T15:04:05Z07:00 |
| FailedReason | String | 任务失败原因 注意：此字段可能返回 null，表示取不到有效值。 示例值："分析失败" |
| MediaPreknownInfo | MediaPreknownInfo | 任务执行时指定的先验知识 |
| MediaName | String | 媒资文件名称 注意：此字段可能返回 null，表示取不到有效值。 示例值："test-video" |
| Label | String | 媒资自定义标签 注意：此字段可能返回 null，表示取不到有效值。 示例值："tag" |
| CallbackURL | String | 任务分析完成后的后调地址 注意：此字段可能返回 null，表示取不到有效值。 示例值："http://callback.com/callback" |
| AudioMetadata | AudioMetadata | 任务对应的媒资文件元信息，仅在MediaType为Audio时有效 注意：此字段可能返回 null，表示取不到有效值。 |
| ImageMetadata | ImageMetadata | 任务对应的媒资文件元信息，仅在MediaType为Audio时有效 注意：此字段可能返回 null，表示取不到有效值。 |
| TextMetadata | TextMetadata | 任务对应的媒资文件元信息，仅在MediaType为Text时有效 注意：此字段可能返回 null，表示取不到有效值。 |
| Metadata | MediaMetadata | 任务对应的媒资文件元信息，仅在MediaType为Video时有效 注意：此字段可能返回 null，表示取不到有效值。 |
TextAppearInfo
关键词在文本中的定位信息
Position为关键词在文本中的偏移量，从0开始。例如，给定文本结果"欢迎收看新闻三十分”，以及关键词"新闻三十分"，那么StartPosition的值为4，EndPosition的值为9
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Index | Integer | 文本结果数组中的下标 示例值：1 |
| StartPosition | Integer | 关键词在文本中出现的起始偏移量(包含) 示例值：10 |
| EndPosition | Integer | 关键词在文本中出现的结束偏移量(不包含) 示例值：13 |
TextData
文本文件标签识别结果
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | String | 文本内容信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：“欢迎收看测试新闻” |
| Summary | String | 文本概要信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：“欢迎” |
| TextTagSet | MultiLevelTag | 文本标签信息 注意：此字段可能返回 null，表示取不到有效值。 |
TextInfo
可视文本识别结果信息(OCR)
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | String | OCR提取的内容 示例值："深圳湾公园启用" |
| StartTimeStamp | Float | OCR起始时间戳，从0开始 示例值：0.52 |
| EndTimeStamp | Float | OCR结束时间戳，从0开始 示例值：1.52 |
| Tag | String | OCR标签信息 示例值："新闻" |
TextMetadata
文本文件元信息
被如下接口引用：DescribeMedia, DescribeMedias, DescribeTask, DescribeTaskDetail, DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileSize | Integer | 媒资文本文件大小，单位为字节 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| MD5 | String | 媒资文本文件MD5 注意：此字段可能返回 null，表示取不到有效值。 示例值：bbc3f6c9fb18d80dedf28239f9a86fac |
| Length | Integer | 媒资文本文件字符数 注意：此字段可能返回 null，表示取不到有效值。 示例值：30 |
| Format | String | 媒资文本文件格式 注意：此字段可能返回 null，表示取不到有效值。 示例值：txt |
TextSegMatchShotScore
单个文本摘要分割结果和所有镜头的匹配度信息
被如下接口引用：DescribeVideoSummaryDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ScoreSet | Array of Float | 数组第 i 个值表示该文本摘要和第 i 个镜头的匹配度 注意：此字段可能返回 null，表示取不到有效值。 示例值：["0.1", "0.98", "0.65"] |
UnknownPerson
未知人物信息
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| VideoAppearSet | Array of VideoAppearInfo | 视觉出现信息 注意：此字段可能返回 null，表示取不到有效值。 |
| PutLibraryAllowed | Boolean | 未知人物是否可以入库(只有当未知人物人脸小图质量分符合要求时才可入库) 注意：此字段可能返回 null，表示取不到有效值。 示例值：是 |
VideoAppearInfo
关键词在视觉结果中的定位信息
被如下接口引用：DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeStamp | Float | 视觉信息起始时间戳，从0开始 示例值：0.52 |
| EndTimeStamp | Float | 视觉信息终止时间戳，从0开始 关键词在视觉信息中的区间为[StartTimeStamp, EndTimeStamp) 示例值：1.52 |
| ImageURL | String | 关键词在视觉信息中的封面图片 示例值：cos://bucket/cover0.jpg |
VideoRotationMode
视频横转竖的控制参数
被如下接口引用：CreateVideoSummaryTask。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ActiveVideoRotation | Boolean | 是 | 生成的视频是否需要横屏转竖屏。 示例值：true |
