@nocobase/plugin-verification/dist/node_modules/tencentcloud-sdk-nodejs/tencentcloud/services/ivld/v20210903/ivld_models.d.ts

User identity verification management, including SMS, TOTP authenticator, with extensibility.

/**
 * 标签信息结构体

包含多级(最多三级)标签结果，以及这些标签在识别结果中的出现位置
 */
export interface MultiLevelTag {
    /**
     * 树状标签信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TagSet: Array<L1Tag>;
    /**
     * 标签在识别结果中的定位信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AppearInfo: AppearInfo;
}
/**
 * AddCustomPersonImage请求参数结构体
 */
export interface AddCustomPersonImageRequest {
    /**
     * 自定义人物Id
     */
    PersonId: string;
    /**
     * 自定义人物图片地址
     */
    ImageURL?: string;
    /**
     * 图片数据base64之后的结果
     */
    Image?: string;
}
/**
 * 二级标签信息

请注意，二级标签信息可能不包含三级标签(此时L3TagSet为空)。

 */
export interface L2Tag {
    /**
     * 二级标签名
     */
    Name: string;
    /**
     * 从属于此二级标签的三级标签数组
  注意：此字段可能返回 null，表示取不到有效值。
     */
    L3TagSet: Array<L3Tag>;
    /**
     * 二级标签出现信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AppearIndexPairSet: Array<AppearIndexPair>;
    /**
     * 二级标签首次出现信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FirstAppear: number;
}
/**
 * DescribeTaskDetail返回参数结构体
 */
export interface DescribeTaskDetailResponse {
    /**
     * 任务信息，不包含任务结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskInfo: TaskInfo;
    /**
     * 视频任务结果数据，只在视频任务结束时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskData: Data;
    /**
     * 图片任务结果数据，只在图片任务结束时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ImageTaskData: ImageData;
    /**
     * 音频任务结果数据，只在音频任务结束时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioTaskData: AudioData;
    /**
     * 文本任务结果数据，只在文本任务结束时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TextTaskData: TextData;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteCustomCategory请求参数结构体
 */
export interface DeleteCustomCategoryRequest {
    /**
     * 自定义分类ID
     */
    CategoryId: string;
}
/**
 * 媒资过滤条件


 */
export interface MediaFilter {
    /**
     * 媒资名称过滤条件
     */
    MediaNameSet?: Array<string>;
    /**
     * 媒资状态数组，媒资状态可选值参见MediaInfo
     */
    StatusSet?: Array<number | bigint>;
    /**
     * 媒资ID数组
     */
    MediaIdSet?: Array<string>;
    /**
     * 媒资自定义标签数组
     */
    LabelSet?: Array<string>;
    /**
     * 媒资文件类型，定义参见[MediaPreknownInfo.MediaType](https://cloud.tencent.com/document/product/1509/65063#MediaPreknownInfo)
     */
    MediaType?: number;
}
/**
 * 自定义分类信息
 */
export interface CustomCategory {
    /**
     * 自定义分类ID
     */
    CategoryId: string;
    /**
     * 一级自定义类型
     */
    L1Category: string;
    /**
     * 二级自定义类型
     */
    L2Category: string;
}
/**
 * DescribeCustomCategories请求参数结构体
 */
export declare type DescribeCustomCategoriesRequest = null;
/**
 * DescribeTasks返回参数结构体
 */
export interface DescribeTasksResponse {
    /**
     * 满足过滤条件的任务总数量
     */
    TotalCount: number;
    /**
     * 满足过滤条件的任务数组
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskInfoSet: Array<TaskInfo>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 自定义人物批量查询过滤条件
 */
export interface CustomPersonFilter {
    /**
     * 待查询的人物姓名
     */
    Name: string;
    /**
     * 待过滤的自定义类型Id数组
     */
    CategoryIdSet: Array<string>;
    /**
     * 待过滤的自定义人物Id数组
     */
    PersonIdSet: Array<string>;
    /**
     * 一级自定义人物类型数组
     */
    L1CategorySet: Array<string>;
}
/**
 * CreateCustomPerson返回参数结构体
 */
export interface CreateCustomPersonResponse {
    /**
     * 自定义人物Id
     */
    PersonId: string;
    /**
     * 自定义人脸信息
     */
    ImageInfo: PersonImageInfo;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ImportMedia返回参数结构体
 */
export interface ImportMediaResponse {
    /**
     * 媒资文件在系统中的ID
     */
    MediaId: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * QueryCallback请求参数结构体
 */
export declare type QueryCallbackRequest = null;
/**
 * DescribeMedia请求参数结构体
 */
export interface DescribeMediaRequest {
    /**
     * 导入媒资返回的媒资ID，最长32B
     */
    MediaId: string;
}
/**
 * 任务信息

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 | 任务执行失败 |
 */
export interface TaskInfo {
    /**
     * 任务ID
     */
    TaskId: string;
    /**
     * 描述任务名称，指定后可根据名称筛选
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskName: string;
    /**
     * 媒资文件ID
     */
    MediaId: string;
    /**
     * 任务执行状态
     */
    TaskStatus: number;
    /**
     * 任务进度，范围为[0，100]
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskProgress: number;
    /**
     * 任务执行时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskTimeCost: number;
    /**
     * 任务创建时间
     */
    TaskCreateTime: string;
    /**
     * 任务开始执行时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskStartTime: string;
    /**
     * 任务失败原因
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FailedReason: string;
    /**
     * 任务执行时指定的先验知识
     */
    MediaPreknownInfo: MediaPreknownInfo;
    /**
     * 媒资文件名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaName: string;
    /**
     * 媒资自定义标签
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 任务分析完成后的后调地址
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CallbackURL: string;
    /**
     * 任务对应的媒资文件元信息，仅在MediaType为Audio时有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioMetadata: AudioMetadata;
    /**
     * 任务对应的媒资文件元信息，仅在MediaType为Audio时有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ImageMetadata: ImageMetadata;
    /**
     * 任务对应的媒资文件元信息，仅在MediaType为Text时有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TextMetadata: TextMetadata;
    /**
     * 任务对应的媒资文件元信息，仅在MediaType为Video时有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Metadata: MediaMetadata;
}
/**
 * 视频结构化结果
 */
export interface ShowInfo {
    /**
     * 节目日期(只在新闻有效)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Date: string;
    /**
     * 台标
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Logo: string;
    /**
     * 节目名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Column: string;
    /**
     * 来源信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Source: string;
    /**
     * 节目封面
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CoverImageURL: string;
    /**
     * 节目内容概要列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SummarySet: Array<string>;
    /**
     * 节目片段标题列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TitleSet: Array<string>;
    /**
     * 音频识别结果列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioInfoSet: Array<AudioInfo>;
    /**
     * 可视文字识别结果列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TextInfoSet: Array<TextInfo>;
    /**
     * 已分类人物信息列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ClassifiedPersonInfoSet: Array<ClassifiedPersonInfo>;
    /**
     * 文本标签列表，包含标签内容和出现信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TextTagSet: MultiLevelTag;
    /**
     * 帧标签列表，包括人物信息，场景信息等
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FrameTagSet: MultiLevelTag;
    /**
     * 视频下载地址
  注意：此字段可能返回 null，表示取不到有效值。
     */
    WebMediaURL: string;
    /**
     * 媒资分类信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaClassifierSet: Array<string>;
    /**
     * 概要标签信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SummaryTagSet: Array<string>;
    /**
     * 未知人物信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    UnknownPersonSet: Array<UnknownPerson>;
    /**
     * 树状已分类人物信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MultiLevelPersonInfoSet: Array<MultiLevelPersonInfo>;
}
/**
 * DescribeTasks请求参数结构体
 */
export interface DescribeTasksRequest {
    /**
     * 分页序号，从1开始
     */
    PageNumber?: number;
    /**
     * 每个分页所包含的元素数量，最大为50
     */
    PageSize?: number;
    /**
     * 任务过滤条件，相关限制参见TaskFilter
     */
    TaskFilter?: TaskFilter;
    /**
     * 返回结果排序信息，By字段只支持CreateTimeStamp
     */
    SortBy?: SortBy;
}
/**
 * DescribeCustomPersons返回参数结构体
 */
export interface DescribeCustomPersonsResponse {
    /**
     * 满足过滤条件的自定义人物数量
     */
    TotalCount: number;
    /**
     * 自定义人物信息
     */
    PersonInfoSet: Array<CustomPersonInfo>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 文本文件标签识别结果
 */
export interface TextData {
    /**
     * 文本内容信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Content: string;
    /**
     * 文本概要信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Summary: string;
    /**
     * 文本标签信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TextTagSet: MultiLevelTag;
}
/**
 * 图片文件元信息
 */
export interface ImageMetadata {
    /**
     * 媒资图片文件大小，单位为Byte
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FileSize: number;
    /**
     * 媒资图片文件MD5
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MD5: string;
    /**
     * 媒资图片文件宽度
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Width: number;
    /**
     * 媒资图片文件高度
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Height: number;
    /**
     * 媒资图片文件格式
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Format: string;
}
/**
 * CreateCustomGroup请求参数结构体
 */
export interface CreateCustomGroupRequest {
    /**
     * 人脸图片COS存储桶Host地址
     */
    Bucket: string;
}
/**
 * 文本文件元信息
 */
export interface TextMetadata {
    /**
     * 媒资文本文件大小，单位为字节
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FileSize: number;
    /**
     * 媒资文本文件MD5
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MD5: string;
    /**
     * 媒资文本文件字符数
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Length: number;
    /**
     * 媒资文本文件格式
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Format: string;
}
/**
 * AddCustomPersonImage返回参数结构体
 */
export interface AddCustomPersonImageResponse {
    /**
     * 自定义人物Id
     */
    PersonId: string;
    /**
     * 自定义人脸图片信息
     */
    ImageInfo: PersonImageInfo;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateDefaultCategories请求参数结构体
 */
export declare type CreateDefaultCategoriesRequest = null;
/**
 * 任务筛选条件结构体
 */
export interface TaskFilter {
    /**
     * 媒资文件类型
     */
    MediaTypeSet?: Array<number | bigint>;
    /**
     * 待筛选的任务状态列表
     */
    TaskStatusSet?: Array<number | bigint>;
    /**
     * 待筛选的任务名称数组
     */
    TaskNameSet?: Array<string>;
    /**
     * TaskId数组
     */
    TaskIdSet?: Array<string>;
    /**
     * 媒资文件名数组
     */
    MediaNameSet?: Array<string>;
    /**
     * 媒资语言类型
     */
    MediaLangSet?: Array<number | bigint>;
    /**
     * 媒资素材一级类型
     */
    MediaLabelSet?: Array<number | bigint>;
    /**
     * 媒资自定义标签数组
     */
    LabelSet?: Array<string>;
}
/**
 * 关键词在文本中的定位信息

Position为关键词在文本中的偏移量，从0开始。例如，给定文本结果"欢迎收看新闻三十分”，以及关键词"新闻三十分"，那么StartPosition的值为4，EndPosition的值为9
 */
export interface TextAppearInfo {
    /**
     * 文本结果数组中的下标
     */
    Index: number;
    /**
     * 关键词在文本中出现的起始偏移量(包含)
     */
    StartPosition: number;
    /**
     * 关键词在文本中出现的结束偏移量(不包含)
     */
    EndPosition: number;
}
/**
 * 描述输入媒资的先验知识，例如文件类型(视频)，媒体类型(新闻/综艺等)

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 | 粤语 |
 */
export interface MediaPreknownInfo {
    /**
     * 媒资文件类型，参见MediaPreknownInfo结构体定义
     */
    MediaType: number;
    /**
     * 媒资素材一级类型，参见MediaPreknownInfo结构体定义
     */
    MediaLabel: number;
    /**
     * 媒资素材二级类型，参见MediaPreknownInfo结构体定义
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaSecondLabel: number;
    /**
     * 媒资音频类型，参见MediaPreknownInfo结构体定义
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaLang?: number;
}
/**
 * 自定义人物信息
 */
export interface CustomPersonInfo {
    /**
     * 自定义人物Id
     */
    PersonId: string;
    /**
     * 自定义人物姓名
     */
    Name: string;
    /**
     * 自定义人物简介信息
     */
    BasicInfo: string;
    /**
     * 一级自定义人物类型
     */
    L1Category: string;
    /**
     * 二级自定义人物类型
     */
    L2Category: string;
    /**
     * 自定义人物图片信息
     */
    ImageInfoSet: Array<PersonImageInfo>;
    /**
     * 自定义人物创建时间
     */
    CreateTime: string;
}
/**
 * UpdateCustomPerson返回参数结构体
 */
export interface UpdateCustomPersonResponse {
    /**
     * 成功更新的自定义人物Id
     */
    PersonId: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UpdateCustomCategory请求参数结构体
 */
export interface UpdateCustomCategoryRequest {
    /**
     * 自定义人物类型Id
     */
    CategoryId: string;
    /**
     * 一级自定义人物类型
     */
    L1Category: string;
    /**
     * 二级自定义人物类型
     */
    L2Category?: string;
}
/**
 * CreateTask请求参数结构体
 */
export interface CreateTaskRequest {
    /**
     * 媒资文件ID，最长32B
     */
    MediaId: string;
    /**
     * 媒资素材先验知识，相关限制参考MediaPreknownInfo
     */
    MediaPreknownInfo: MediaPreknownInfo;
    /**
     * 任务名称，最长100个中文字符
     */
    TaskName?: string;
    /**
     * 是否上传转码后的视频，仅设置true时上传，默认为false
     */
    UploadVideo?: boolean;
    /**
     * 自定义标签，可用于查询
     */
    Label?: string;
    /**
     * 任务分析完成的回调地址，该设置优先级高于控制台全局的设置；
     */
    CallbackURL?: string;
}
/**
 * DescribeCustomCategories返回参数结构体
 */
export interface DescribeCustomCategoriesResponse {
    /**
     * 自定义人物类型数组
     */
    CategorySet: Array<CustomCategory>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCustomGroup返回参数结构体
 */
export interface DescribeCustomGroupResponse {
    /**
     * 自定义人物库所包含的人物个数
     */
    GroupSize: number;
    /**
     * 自定义人物库图片后续所在的存储桶
     */
    Bucket: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 自定义人物人脸图片信息
 */
export interface PersonImageInfo {
    /**
     * 人脸图片ID
     */
    ImageId: string;
    /**
     * 自定义人脸图片的URL，存储在IVLDCustomPreson存储桶内
     */
    ImageURL: string;
    /**
     * 自定义人脸图片处理错误码
     */
    ErrorCode: string;
    /**
     * 自定义人脸图片处理错误信息
     */
    ErrorMsg: string;
}
/**
 * 排序条件
 */
export interface SortBy {
    /**
     * 排序字段，默认为CreateTime
     */
    By?: string;
    /**
     * true表示降序，false表示升序
     */
    Descend?: boolean;
}
/**
 * DeleteCustomPersonImage请求参数结构体
 */
export interface DeleteCustomPersonImageRequest {
    /**
     * 自定义人物Id
     */
    PersonId: string;
    /**
     * 自定义人脸图片Id
     */
    ImageId: string;
}
/**
 * DeleteMedia返回参数结构体
 */
export interface DeleteMediaResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 矩形内容框
 */
export interface Rectf {
    /**
     * 矩形框左上角水平座标
  注意：此字段可能返回 null，表示取不到有效值。
     */
    X: number;
    /**
     * 矩形框左上角竖直座标
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Y: number;
    /**
     * 矩形框宽度
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Width: number;
    /**
     * 矩形框长度
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Height: number;
}
/**
 * ModifyCallback请求参数结构体
 */
export interface ModifyCallbackRequest {
    /**
     * 任务分析完成后回调地址
     */
    TaskFinishNotifyURL: string;
    /**
     * 媒体导入完成后回调地址
     */
    MediaFinishNotifyURL: string;
}
/**
 * DeleteCustomPerson返回参数结构体
 */
export interface DeleteCustomPersonResponse {
    /**
     * 已删除的自定义人物Id
     */
    PersonId: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteTask请求参数结构体
 */
export interface DeleteTaskRequest {
    /**
     * 任务Id
     */
    TaskId: string;
}
/**
 * ImportMedia请求参数结构体
 */
export interface ImportMediaRequest {
    /**
     * 待分析视频的URL，目前只支持*不带签名的*COS地址，长度最长1KB
     */
    URL: string;
    /**
     * 待分析视频的MD5，为空时不做校验，否则会做MD5校验，长度必须为32B
     */
    MD5?: string;
    /**
     * 待分析视频的名称，指定后可支持筛选，最多64B
     */
    Name?: string;
    /**
     * 当非本人外部视频地址导入时，该字段为转存的cos桶地址且不可为空; 示例：https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${PathPrefix}/  (注意，cos路径需要以/分隔符结尾)。
  推荐采用本主帐号COS桶，如果使用其他帐号COS桶，请确保COS桶可写，否则可导致分析失败
     */
    WriteBackCosPath?: string;
    /**
     * 自定义标签，可用于查询
     */
    Label?: string;
    /**
     * 媒资导入完成的回调地址，该设置优先级高于控制台全局的设置；
     */
    CallbackURL?: string;
    /**
     * 媒资文件类型，详细定义参见[MediaPreknownInfo.MediaType](https://cloud.tencent.com/document/product/1509/65063#MediaPreknownInfo)
  默认为2(视频)
     */
    MediaType?: number;
}
/**
 * DescribeMedias请求参数结构体
 */
export interface DescribeMediasRequest {
    /**
     * 分页序号，从1开始
     */
    PageNumber: number;
    /**
     * 每个分页所包含的元素数量，最大为50
     */
    PageSize: number;
    /**
     * 列举过滤条件，相关限制相见MediaFilter
     */
    MediaFilter?: MediaFilter;
    /**
     * 返回结果排序信息，By字段只支持CreateTime
     */
    SortBy?: SortBy;
}
/**
 * CreateDefaultCategories返回参数结构体
 */
export interface CreateDefaultCategoriesResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 已分类的人物信息
 */
export interface ClassifiedPersonInfo {
    /**
     * 人物分类名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ClassifyName: string;
    /**
     * 符合特定分类的人物信息数组
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PersonInfoSet: Array<PersonInfo>;
}
/**
 * DescribeCustomPersons请求参数结构体
 */
export interface DescribeCustomPersonsRequest {
    /**
     * 分页序号，从1开始
     */
    PageNumber: number;
    /**
     * 分页数据行数，最多50
     */
    PageSize: number;
    /**
     * 排序信息，默认倒序
     */
    SortBy?: SortBy;
    /**
     * 自定义人物过滤条件
     */
    Filter?: CustomPersonFilter;
}
/**
 * DescribeMedia返回参数结构体
 */
export interface DescribeMediaResponse {
    /**
     * 媒资信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaInfo: MediaInfo;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 任务结果数据
 */
export interface Data {
    /**
     * 节目粒度结构化结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ShowInfo: ShowInfo;
}
/**
 * 出现信息结构

包含关键词在音频转文字(ASR)，图片转文字(OCR)以及视频结果中的出现信息

 */
export interface AppearInfo {
    /**
     * 关键词在音频文本结果中的出现位置数组
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioAppearSet: Array<TextAppearInfo>;
    /**
     * 关键词在可视文本结果中的出现位置数组
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TextAppearSet: Array<TextAppearInfo>;
    /**
     * 关键词在视频信息中的出现位置数组
  注意：此字段可能返回 null，表示取不到有效值。
     */
    VideoAppearSet: Array<VideoAppearInfo>;
}
/**
 * 人物信息
 */
export interface PersonInfo {
    /**
     * 公众人物姓名
     */
    Name: string;
    /**
     * 公众人物职务
     */
    Job: string;
    /**
     * 首次出现模态，可选值为[1,3]，详细参见AppearIndex定义
     */
    FirstAppear: number;
    /**
     * 人物出现信息
     */
    AppearInfo: AppearInfo;
    /**
     * 人脸在图片中的位置，仅在图片标签任务有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AppearRect: Rectf;
}
/**
 * 音频识别结果信息
 */
export interface AudioInfo {
    /**
     * ASR提取的文字信息
     */
    Content: string;
    /**
     * ASR起始时间戳，从0开始
     */
    StartTimeStamp: number;
    /**
     * ASR结束时间戳，从0开始
     */
    EndTimeStamp: number;
    /**
     * ASR提取的音频标签
     */
    Tag: string;
}
/**
 * 图片OCR识别结果
 */
export interface ImageOcr {
    /**
     * 图片中可视文本识别结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Content: string;
    /**
     * 可视文本在图片中的位置信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AppearRect: Rectf;
}
/**
 * DeleteCustomPersonImage返回参数结构体
 */
export interface DeleteCustomPersonImageResponse {
    /**
     * 自定义人物Id
     */
    PersonId: string;
    /**
     * 已删除的人物图片Id
     */
    ImageId: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 可视文本识别结果信息(OCR)
 */
export interface TextInfo {
    /**
     * OCR提取的内容
     */
    Content: string;
    /**
     * OCR起始时间戳，从0开始
     */
    StartTimeStamp: number;
    /**
     * OCR结束时间戳，从0开始
     */
    EndTimeStamp: number;
    /**
     * OCR标签信息
     */
    Tag: string;
}
/**
 * CreateCustomCategory返回参数结构体
 */
export interface CreateCustomCategoryResponse {
    /**
     * 自定义分类信息ID
     */
    CategoryId: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * QueryCallback返回参数结构体
 */
export interface QueryCallbackResponse {
    /**
     * 任务分析完成后回调地址
     */
    TaskFinishNotifyURL: string;
    /**
     * 媒体导入完成后回调地址
     */
    MediaFinishNotifyURL: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 带类型树的已分类人物信息
 */
export interface MultiLevelPersonInfo {
    /**
     * 一级分类名称(分类信息参见自定义人物类型)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    L1ClassifyName: string;
    /**
     * 已分类人物信息数组(所有分类类型为二级分类)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    L2ClassifiedPersonInfoSet: Array<ClassifiedPersonInfo>;
    /**
     * 检测结果来源
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Source: number;
}
/**
 * CreateCustomGroup返回参数结构体
 */
export interface CreateCustomGroupResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UpdateCustomCategory返回参数结构体
 */
export interface UpdateCustomCategoryResponse {
    /**
     * 成功更新的自定义人物类型Id
     */
    CategoryId: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMedias返回参数结构体
 */
export interface DescribeMediasResponse {
    /**
     * 满足过滤条件的媒资视频总数量
     */
    TotalCount: number;
    /**
     * 满足过滤条件的媒资信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaInfoSet: Array<MediaInfo>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 未知人物信息
 */
export interface UnknownPerson {
    /**
     * 视觉出现信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    VideoAppearSet: Array<VideoAppearInfo>;
    /**
     * 未知人物是否可以入库(只有当未知人物人脸小图质量分符合要求时才可入库)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PutLibraryAllowed: boolean;
}
/**
 * 媒资文件视频元信息，包括分辨率，帧率，码率等
 */
export interface MediaMetadata {
    /**
     * 媒资视频文件大小，单位为字节
     */
    FileSize: number;
    /**
     * 媒资视频文件MD5
     */
    MD5: string;
    /**
     * 媒资视频时长，单位为秒
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Duration: number;
    /**
     * 媒资视频总帧数
  注意：此字段可能返回 null，表示取不到有效值。
     */
    NumFrames: number;
    /**
     * 媒资视频宽度，单位为像素
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Width: number;
    /**
     * 媒资视频高度，单位为像素
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Height: number;
    /**
     * 媒资视频帧率，单位为Hz
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FPS: number;
    /**
     * 媒资视频比特率，单位为kbps
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BitRate: number;
}
/**
 * DeleteCustomPerson请求参数结构体
 */
export interface DeleteCustomPersonRequest {
    /**
     * 待删除的自定义人物ID
     */
    PersonId: string;
}
/**
 * 音频文件元信息
 */
export interface AudioMetadata {
    /**
     * 媒资音频文件大小，单位为Byte
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FileSize: number;
    /**
     * 媒资音频文件MD5
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MD5: string;
    /**
     * 媒资音频时长，单位为秒
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Duration: number;
    /**
     * 媒资音频采样率，单位为khz
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SampleRate: number;
    /**
     * 媒资音频码率，单位为kbps
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BitRate: number;
    /**
     * 媒资音频文件格式
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Format: string;
}
/**
 * DescribeCustomPersonDetail返回参数结构体
 */
export interface DescribeCustomPersonDetailResponse {
    /**
     * 自定义人物信息
     */
    PersonInfo: CustomPersonInfo;
    /**
     * 出现该自定义人物的所有分析人物Id
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskIdSet: Array<string>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteMedia请求参数结构体
 */
export interface DeleteMediaRequest {
    /**
     * 媒资文件在系统中的ID
     */
    MediaId: string;
}
/**
 * CreateCustomCategory请求参数结构体
 */
export interface CreateCustomCategoryRequest {
    /**
     * 自定义一级类型
     */
    L1Category: string;
    /**
     * 自定义二级类型
     */
    L2Category: string;
}
/**
 * 关键词在视觉结果中的定位信息
 */
export interface VideoAppearInfo {
    /**
     * 视觉信息起始时间戳，从0开始
     */
    StartTimeStamp: number;
    /**
     * 视觉信息终止时间戳，从0开始
  关键词在视觉信息中的区间为[StartTimeStamp, EndTimeStamp)
     */
    EndTimeStamp: number;
    /**
     * 关键词在视觉信息中的封面图片
     */
    ImageURL: string;
}
/**
 * DescribeTask返回参数结构体
 */
export interface DescribeTaskResponse {
    /**
     * 任务信息，详情参见TaskInfo的定义
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskInfo: TaskInfo;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 出现信息索引对

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开始)音频文字识别结果之中
 */
export interface AppearIndexPair {
    /**
     * 出现信息，取值范围为[1，3]
     */
    AppearIndex: number;
    /**
     * AppearInfo中AppearIndex对应元素的第Index元素，从0开始技术
     */
    Index: number;
}
/**
 * CreateTask返回参数结构体
 */
export interface CreateTaskResponse {
    /**
     * 智能标签视频分析任务ID
     */
    TaskId: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCustomPersonDetail请求参数结构体
 */
export interface DescribeCustomPersonDetailRequest {
    /**
     * 自定义人物Id
     */
    PersonId: string;
}
/**
 * 图片文件标签结果
 */
export interface ImageData {
    /**
     * 图片中出现的可视文本识别结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    OcrSet: Array<ImageOcr>;
    /**
     * 图片中出现的帧标签识别结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FrameTagSet: MultiLevelTag;
    /**
     * 图片中出现的层级人物识别结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MultiLevelPersonInfoSet: Array<MultiLevelPersonInfo>;
    /**
     * 图片中出现的台标识别结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TvLogo: ImageLogo;
    /**
     * 图片中出现的来源信息识别结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SourceLogo: ImageLogo;
}
/**
 * DescribeTaskDetail请求参数结构体
 */
export interface DescribeTaskDetailRequest {
    /**
     * 创建任务返回的TaskId
     */
    TaskId: string;
}
/**
 * DeleteTask返回参数结构体
 */
export interface DeleteTaskResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeTask请求参数结构体
 */
export interface DescribeTaskRequest {
    /**
     * CreateTask返回的任务ID，最长32B
     */
    TaskId: string;
}
/**
 * UpdateCustomPerson请求参数结构体
 */
export interface UpdateCustomPersonRequest {
    /**
     * 待更新的自定义人物Id
     */
    PersonId: string;
    /**
     * 更新后的自定义人物名称，如为空则不更新
     */
    Name?: string;
    /**
     * 更新后的自定义人物简介，如为空则不更新
     */
    BasicInfo?: string;
    /**
     * 更新后的分类信息，如为空则不更新
     */
    CategoryId?: string;
}
/**
 * 一级标签信息

请注意，一级标签信息可能不包含二级标签(此时L2TagSet为空)。在这种情况下，一级标签可直接包含出现信息。
 */
export interface L1Tag {
    /**
     * 一级标签名
     */
    Name: string;
    /**
     * 二级标签数组
  注意：此字段可能返回 null，表示取不到有效值。
     */
    L2TagSet: Array<L2Tag>;
    /**
     * 一级标签出现信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AppearIndexPairSet: Array<AppearIndexPair>;
    /**
     * 一级标签首次出现信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FirstAppear: number;
}
/**
 * ModifyCallback返回参数结构体
 */
export interface ModifyCallbackResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 图片中出现的Logo信息
 */
export interface ImageLogo {
    /**
     * 图片中出现的Logo识别结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Logo: string;
    /**
     * Logo在图片中出现的位置
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AppearRect: Rectf;
}
/**
 * 三级标签信息。

三级标签不再包含任何子标签。所有三级标签都对应着识别结果中的出现信息，出现信息使用AppearIndexPairSet定位。
 */
export interface L3Tag {
    /**
     * 三级标签名
     */
    Name: string;
    /**
     * 三级标签出现信息索引数组
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AppearIndexPairSet: Array<AppearIndexPair>;
    /**
     * 三级标签首次出现信息，可选值为[1,3]
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FirstAppear: number;
}
/**
 * 音频文件分析结果数据
 */
export interface AudioData {
    /**
     * 音频识别文本结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioInfoSet: Array<AudioInfo>;
    /**
     * 音频识别标签数据
     */
    TextTagSet: MultiLevelTag;
}
/**
 * CreateCustomPerson请求参数结构体
 */
export interface CreateCustomPersonRequest {
    /**
     * 自定义人物姓名
     */
    Name: string;
    /**
     * 自定义人物简要信息(仅用于标记，不支持检索)
     */
    BasicInfo: string;
    /**
     * 自定义分类ID，如不存在接口会报错
     */
    CategoryId: string;
    /**
     * 自定义人物图片URL，可支持任意地址，推荐使用COS
     */
    ImageURL?: string;
    /**
     * 原始图片base64编码后的数据
     */
    Image?: string;
}
/**
 * 媒资信息结构体

媒资状态定义如下：

| 状态名 | 状态值 | 状态描述 |
|---|---|---|
| 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 | 媒资导入失败 |
 */
export interface MediaInfo {
    /**
     * 媒资ID
     */
    MediaId: string;
    /**
     * 媒资名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Name: string;
    /**
     * 媒资下载地址
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DownLoadURL: string;
    /**
     * 媒资状态，取值参看上方表格
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Status: number;
    /**
     * 若状态为失败，表示失败原因
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FailedReason: string;
    /**
     * 媒资视频元信息，仅在MediaType=VIDEO时有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Metadata: MediaMetadata;
    /**
     * 导入视频进度，取值范围为[0,100]
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Progress: number;
    /**
     * 媒资自定义标签
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 媒资导入完成后的回调地址
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CallbackURL: string;
    /**
     * 媒资文件类型，具体参看[MediaPreknownInfo](https://cloud.tencent.com/document/product/1509/65063#MediaPreknownInfo)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaType: number;
    /**
     * 媒资音频元信息，仅在MediaType=Audio时有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioMetadata: AudioMetadata;
    /**
     * 媒资图片文件元信息，仅在MediaType=Image时有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ImageMetadata: ImageMetadata;
    /**
     * 媒资文本文件元信息，仅在MediaType=Text时有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TextMetadata: TextMetadata;
}
/**
 * DeleteCustomCategory返回参数结构体
 */
export interface DeleteCustomCategoryResponse {
    /**
     * 123
     */
    CategoryId: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCustomGroup请求参数结构体
 */
export declare type DescribeCustomGroupRequest = null;