tencentcloud-sdk-nodejs 4.0.280 → 4.0.284

package/src/services/ivld/v20210903/ivld_models.ts

@@ -15,6 +15,36 @@
  * under the License.
  */
 
+/**
+ * 一级标签信息
+
+请注意，一级标签信息可能不包含二级标签(此时L2TagSet为空)。在这种情况下，一级标签可直接包含出现信息。
+ */
+export interface L1Tag {
+  /**
+   * 一级标签名
+   */
+  Name: string
+
+  /**
+      * 二级标签数组
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  L2TagSet: Array<L2Tag>
+
+  /**
+      * 一级标签出现信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  AppearIndexPairSet: Array<AppearIndexPair>
+
+  /**
+      * 一级标签首次出现信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FirstAppear: number
+}
+
 /**
  * DeleteMedia返回参数结构体
  */
@@ -134,28 +164,88 @@ export interface MultiLevelTag {
 }
 
 /**
- * DescribeTasks请求参数结构体
+ * 媒资过滤条件
+
+
  */
-export interface DescribeTasksRequest {
+export interface MediaFilter {
   /**
-   * 分页序号，从1开始
+      * 媒资名称过滤条件
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  MediaNameSet?: Array<string>
+
+  /**
+      * 媒资状态数组，媒资状态可选值参见MediaInfo
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  StatusSet?: Array<number>
+
+  /**
+      * 媒资ID数组
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  MediaIdSet?: Array<string>
+}
+
+/**
+ * AddCustomPersonImage请求参数结构体
+ */
+export interface AddCustomPersonImageRequest {
+  /**
+   * 自定义人物Id
    */
-  PageNumber?: number
+  PersonId: string
 
   /**
-   * 每个分页所包含的元素数量，最大为50
+   * 自定义人物图片地址
    */
-  PageSize?: number
+  ImageURL?: string
 
   /**
-   * 任务过滤条件，相关限制参见TaskFilter
+   * 图片数据base64之后的结果
    */
-  TaskFilter?: TaskFilter
+  Image?: string
+}
 
+/**
+ * UpdateCustomPerson请求参数结构体
+ */
+export interface UpdateCustomPersonRequest {
   /**
-   * 返回结果排序信息，By字段只支持CreateTimeStamp
+   * 待更新的自定义人物Id
    */
-  SortBy?: SortBy
+  PersonId: string
+
+  /**
+   * 更新后的自定义人物名称，如为空则不更新
+   */
+  Name?: string
+
+  /**
+   * 更新后的自定义人物简介，如为空则不更新
+   */
+  BasicInfo?: string
+
+  /**
+   * 更新后的分类信息，如为空则不更新
+   */
+  CategoryId?: string
+}
+
+/**
+ * DeleteCustomPerson返回参数结构体
+ */
+export interface DeleteCustomPersonResponse {
+  /**
+   * 已删除的自定义人物Id
+   */
+  PersonId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -189,6 +279,31 @@ export interface L2Tag {
   FirstAppear: number
 }
 
+/**
+ * DescribeCustomPersons返回参数结构体
+ */
+export interface DescribeCustomPersonsResponse {
+  /**
+   * 满足过滤条件的自定义人物数量
+   */
+  TotalCount: number
+
+  /**
+   * 自定义人物信息
+   */
+  PersonInfoSet: Array<CustomPersonInfo>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DescribeCustomCategories请求参数结构体
+ */
+export type DescribeCustomCategoriesRequest = null
+
 /**
  * ImportMedia请求参数结构体
  */
@@ -209,6 +324,31 @@ export interface ImportMediaRequest {
   Name?: string
 }
 
+/**
+ * CreateCustomCategory请求参数结构体
+ */
+export interface CreateCustomCategoryRequest {
+  /**
+   * 自定义一级类型
+   */
+  L1Category: string
+
+  /**
+   * 自定义二级类型
+   */
+  L2Category: string
+}
+
+/**
+ * DescribeMedia请求参数结构体
+ */
+export interface DescribeMediaRequest {
+  /**
+   * 导入媒资返回的媒资ID，最长32B
+   */
+  MediaId: string
+}
+
 /**
  * DescribeMedias请求参数结构体
  */
@@ -255,31 +395,6 @@ export interface VideoAppearInfo {
   ImageURL: string
 }
 
-/**
- * 可视文本识别结果信息(OCR)
- */
-export interface TextInfo {
-  /**
-   * OCR提取的内容
-   */
-  Content: string
-
-  /**
-   * OCR起始时间戳，从0开始
-   */
-  StartTimeStamp: number
-
-  /**
-   * OCR结束时间戳，从0开始
-   */
-  EndTimeStamp: number
-
-  /**
-   * OCR标签信息
-   */
-  Tag: string
-}
-
 /**
  * DescribeTask返回参数结构体
  */
@@ -296,6 +411,16 @@ export interface DescribeTaskResponse {
   RequestId?: string
 }
 
+/**
+ * CreateDefaultCategories返回参数结构体
+ */
+export interface CreateDefaultCategoriesResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 出现信息索引对
 
@@ -322,6 +447,56 @@ export interface AppearIndexPair {
   Index: number
 }
 
+/**
+ * CreateTask返回参数结构体
+ */
+export interface CreateTaskResponse {
+  /**
+   * 智能标签视频分析任务ID
+   */
+  TaskId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DeleteCustomCategory请求参数结构体
+ */
+export interface DeleteCustomCategoryRequest {
+  /**
+   * 自定义分类ID
+   */
+  CategoryId: string
+}
+
+/**
+ * DescribeTasks请求参数结构体
+ */
+export interface DescribeTasksRequest {
+  /**
+   * 分页序号，从1开始
+   */
+  PageNumber?: number
+
+  /**
+   * 每个分页所包含的元素数量，最大为50
+   */
+  PageSize?: number
+
+  /**
+   * 任务过滤条件，相关限制参见TaskFilter
+   */
+  TaskFilter?: TaskFilter
+
+  /**
+   * 返回结果排序信息，By字段只支持CreateTimeStamp
+   */
+  SortBy?: SortBy
+}
+
 /**
  * DescribeTaskDetail返回参数结构体
  */
@@ -343,30 +518,65 @@ export interface DescribeTaskDetailResponse {
 }
 
 /**
- * CreateTask返回参数结构体
+ * 自定义人物人脸图片信息
  */
-export interface CreateTaskResponse {
+export interface PersonImageInfo {
   /**
-   * 智能标签视频分析任务ID
+   * 人脸图片ID
    */
-  TaskId: string
+  ImageId: string
 
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 自定义人脸图片的URL，存储在IVLDCustomPreson存储桶内
    */
-  RequestId?: string
+  ImageURL: string
+
+  /**
+   * 自定义人脸图片处理错误码
+   */
+  ErrorCode: string
+
+  /**
+   * 自定义人脸图片处理错误信息
+   */
+  ErrorMsg: string
 }
 
 /**
- * DescribeTaskDetail请求参数结构体
+ * CreateCustomGroup请求参数结构体
  */
-export interface DescribeTaskDetailRequest {
+export interface CreateCustomGroupRequest {
   /**
-   * 创建任务返回的TaskId
+   * 人脸图片COS存储桶Host地址
    */
-  TaskId: string
+  Bucket: string
+}
+
+/**
+ * AddCustomPersonImage返回参数结构体
+ */
+export interface AddCustomPersonImageResponse {
+  /**
+   * 自定义人物Id
+   */
+  PersonId: string
+
+  /**
+   * 自定义人脸图片信息
+   */
+  ImageInfo: PersonImageInfo
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
+/**
+ * CreateDefaultCategories请求参数结构体
+ */
+export type CreateDefaultCategoriesRequest = null
+
 /**
  * 任务筛选条件结构体
  */
@@ -410,34 +620,130 @@ export interface TaskFilter {
 /**
  * 关键词在文本中的定位信息
 
-Position为关键词在文本中的偏移量，从0开始。例如，给定文本结果"欢迎收看新闻三十分”，以及关键词"新闻三十分"，那么StartPosition的值为4，EndPosition的值为9
- */
-export interface TextAppearInfo {
+Position为关键词在文本中的偏移量，从0开始。例如，给定文本结果"欢迎收看新闻三十分”，以及关键词"新闻三十分"，那么StartPosition的值为4，EndPosition的值为9
+ */
+export interface TextAppearInfo {
+  /**
+   * 文本结果数组中的下标
+   */
+  Index: number
+
+  /**
+   * 关键词在文本中出现的起始偏移量(包含)
+   */
+  StartPosition: number
+
+  /**
+   * 关键词在文本中出现的结束偏移量(不包含)
+   */
+  EndPosition: number
+}
+
+/**
+ * DescribeMedia返回参数结构体
+ */
+export interface DescribeMediaResponse {
+  /**
+      * 媒资信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  MediaInfo: MediaInfo
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 自定义分类信息
+ */
+export interface CustomCategory {
+  /**
+   * 自定义分类ID
+   */
+  CategoryId: string
+
+  /**
+   * 一级自定义类型
+   */
+  L1Category: string
+
+  /**
+   * 二级自定义类型
+   */
+  L2Category: string
+}
+
+/**
+ * 任务结果数据
+ */
+export interface Data {
+  /**
+      * 节目粒度结构化结果
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ShowInfo: ShowInfo
+}
+
+/**
+ * DescribeTask请求参数结构体
+ */
+export interface DescribeTaskRequest {
+  /**
+   * CreateTask返回的任务ID，最长32B
+   */
+  TaskId: string
+}
+
+/**
+ * DescribeCustomPersonDetail请求参数结构体
+ */
+export interface DescribeCustomPersonDetailRequest {
+  /**
+   * 自定义人物Id
+   */
+  PersonId: string
+}
+
+/**
+ * 自定义人物信息
+ */
+export interface CustomPersonInfo {
+  /**
+   * 自定义人物Id
+   */
+  PersonId: string
+
   /**
-   * 文本结果数组中的下标
+   * 自定义人物姓名
    */
-  Index: number
+  Name: string
 
   /**
-   * 关键词在文本中出现的起始偏移量(包含)
+   * 自定义人物简介信息
    */
-  StartPosition: number
+  BasicInfo: string
 
   /**
-   * 关键词在文本中出现的结束偏移量(不包含)
+   * 一级自定义人物类型
    */
-  EndPosition: number
+  L1Category: string
+
+  /**
+   * 二级自定义人物类型
+   */
+  L2Category: string
 }
 
 /**
- * DescribeMedia返回参数结构体
+ * UpdateCustomPerson返回参数结构体
  */
-export interface DescribeMediaResponse {
+export interface UpdateCustomPersonResponse {
   /**
-      * 媒资信息
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  MediaInfo: MediaInfo
+   * 成功更新的自定义人物Id
+   */
+  PersonId: string
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -446,54 +752,48 @@ export interface DescribeMediaResponse {
 }
 
 /**
- * 任务结果数据
+ * DescribeCustomGroup返回参数结构体
  */
-export interface Data {
+export interface DescribeCustomGroupResponse {
   /**
-      * 节目粒度结构化结果
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  ShowInfo: ShowInfo
-}
+   * 自定义人物库所包含的人物个数
+   */
+  GroupSize: number
 
-/**
- * DescribeTask请求参数结构体
- */
-export interface DescribeTaskRequest {
   /**
-   * CreateTask返回的任务ID，最长32B
+   * 自定义人物库图片后续所在的存储桶
    */
-  TaskId: string
+  Bucket: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
- * 一级标签信息
-
-请注意，一级标签信息可能不包含二级标签(此时L2TagSet为空)。在这种情况下，一级标签可直接包含出现信息。
+ * DescribeCustomPersons请求参数结构体
  */
-export interface L1Tag {
+export interface DescribeCustomPersonsRequest {
   /**
-   * 一级标签名
+   * 分页序号，从1开始
    */
-  Name: string
+  PageNumber: number
 
   /**
-      * 二级标签数组
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  L2TagSet: Array<L2Tag>
+   * 分页数据行数，最多50
+   */
+  PageSize: number
 
   /**
-      * 一级标签出现信息
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  AppearIndexPairSet: Array<AppearIndexPair>
+   * 排序信息，默认倒序
+   */
+  SortBy?: SortBy
 
   /**
-      * 一级标签首次出现信息
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  FirstAppear: number
+   * 自定义人物过滤条件
+   */
+  Filter?: CustomPersonFilter
 }
 
 /**
@@ -517,6 +817,31 @@ export interface DescribeTasksResponse {
   RequestId?: string
 }
 
+/**
+ * 可视文本识别结果信息(OCR)
+ */
+export interface TextInfo {
+  /**
+   * OCR提取的内容
+   */
+  Content: string
+
+  /**
+   * OCR起始时间戳，从0开始
+   */
+  StartTimeStamp: number
+
+  /**
+   * OCR结束时间戳，从0开始
+   */
+  EndTimeStamp: number
+
+  /**
+   * OCR标签信息
+   */
+  Tag: string
+}
+
 /**
  * 音频识别结果信息
  */
@@ -542,6 +867,31 @@ export interface AudioInfo {
   Tag: string
 }
 
+/**
+ * 自定义人物批量查询过滤条件
+ */
+export interface CustomPersonFilter {
+  /**
+   * 待查询的人物姓名
+   */
+  Name: string
+
+  /**
+   * 待过滤的自定义类型Id数组
+   */
+  CategoryIdSet: Array<string>
+
+  /**
+   * 待过滤的自定义人物Id数组
+   */
+  PersonIdSet: Array<string>
+
+  /**
+   * 一级自定义人物类型数组
+   */
+  L1CategorySet: Array<string>
+}
+
 /**
  * CreateTask请求参数结构体
  */
@@ -592,28 +942,64 @@ export interface L3Tag {
 }
 
 /**
- * 媒资过滤条件
+ * UpdateCustomCategory请求参数结构体
+ */
+export interface UpdateCustomCategoryRequest {
+  /**
+   * 自定义人物类型Id
+   */
+  CategoryId: string
+
+  /**
+   * 一级自定义人物类型
+   */
+  L1Category: string
 
+  /**
+   * 二级自定义人物类型
+   */
+  L2Category?: string
+}
 
+/**
+ * DescribeCustomPersonDetail返回参数结构体
  */
-export interface MediaFilter {
+export interface DescribeCustomPersonDetailResponse {
   /**
-      * 媒资名称过滤条件
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  MediaNameSet?: Array<string>
+   * 自定义人物信息
+   */
+  PersonInfo: CustomPersonInfo
 
   /**
-      * 媒资状态数组，媒资状态可选值参见MediaInfo
+      * 出现该自定义人物的所有分析人物Id
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  StatusSet?: Array<number>
+  TaskIdSet: Array<string>
 
   /**
-      * 媒资ID数组
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  MediaIdSet?: Array<string>
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DeleteCustomPersonImage返回参数结构体
+ */
+export interface DeleteCustomPersonImageResponse {
+  /**
+   * 自定义人物Id
+   */
+  PersonId: string
+
+  /**
+   * 已删除的人物图片Id
+   */
+  ImageId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -681,6 +1067,56 @@ export interface MediaPreknownInfo {
   MediaLang?: number
 }
 
+/**
+ * DescribeCustomCategories返回参数结构体
+ */
+export interface DescribeCustomCategoriesResponse {
+  /**
+   * 自定义人物类型数组
+   */
+  CategorySet: Array<CustomCategory>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * CreateCustomCategory返回参数结构体
+ */
+export interface CreateCustomCategoryResponse {
+  /**
+   * 自定义分类信息ID
+   */
+  CategoryId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * CreateCustomPerson返回参数结构体
+ */
+export interface CreateCustomPersonResponse {
+  /**
+   * 自定义人物Id
+   */
+  PersonId: string
+
+  /**
+   * 自定义人脸信息
+   */
+  ImageInfo: PersonImageInfo
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 出现信息结构
 
@@ -707,6 +1143,26 @@ export interface AppearInfo {
   VideoAppearSet: Array<VideoAppearInfo>
 }
 
+/**
+ * DescribeCustomGroup请求参数结构体
+ */
+export type DescribeCustomGroupRequest = null
+
+/**
+ * UpdateCustomCategory返回参数结构体
+ */
+export interface UpdateCustomCategoryResponse {
+  /**
+   * 成功更新的自定义人物类型Id
+   */
+  CategoryId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DeleteMedia请求参数结构体
  */
@@ -717,6 +1173,16 @@ export interface DeleteMediaRequest {
   MediaId: string
 }
 
+/**
+ * CreateCustomGroup返回参数结构体
+ */
+export interface CreateCustomGroupResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * ImportMedia返回参数结构体
  */
@@ -732,6 +1198,16 @@ export interface ImportMediaResponse {
   RequestId?: string
 }
 
+/**
+ * DescribeTaskDetail请求参数结构体
+ */
+export interface DescribeTaskDetailRequest {
+  /**
+   * 创建任务返回的TaskId
+   */
+  TaskId: string
+}
+
 /**
  * DescribeMedias返回参数结构体
  */
@@ -882,13 +1358,73 @@ export interface MediaMetadata {
 }
 
 /**
- * DescribeMedia请求参数结构体
+ * DeleteCustomPerson请求参数结构体
  */
-export interface DescribeMediaRequest {
+export interface DeleteCustomPersonRequest {
   /**
-   * 导入媒资返回的媒资ID，最长32B
+   * 待删除的自定义人物ID
    */
-  MediaId: string
+  PersonId: string
+}
+
+/**
+ * DeleteCustomCategory返回参数结构体
+ */
+export interface DeleteCustomCategoryResponse {
+  /**
+   * 123
+   */
+  CategoryId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DeleteCustomPersonImage请求参数结构体
+ */
+export interface DeleteCustomPersonImageRequest {
+  /**
+   * 自定义人物Id
+   */
+  PersonId: string
+
+  /**
+   * 自定义人脸图片Id
+   */
+  ImageId: string
+}
+
+/**
+ * CreateCustomPerson请求参数结构体
+ */
+export interface CreateCustomPersonRequest {
+  /**
+   * 自定义人物姓名
+   */
+  Name: string
+
+  /**
+   * 自定义人物简要信息(仅用于标记，不支持检索)
+   */
+  BasicInfo: string
+
+  /**
+   * 自定义分类ID，如不存在接口会报错
+   */
+  CategoryId: string
+
+  /**
+   * 自定义人物图片URL，可支持任意地址，推荐使用COS
+   */
+  ImageURL?: string
+
+  /**
+   * 原始图片base64编码后的数据
+   */
+  Image?: string
 }
 
 /**