tencentcloud-sdk-nodejs-ims 4.0.521 → 4.0.523

package/src/services/ims/v20200713/ims_models.ts

@@ -16,141 +16,58 @@
  */
 
 /**
- * DescribeImageStat请求参数结构体
+ * ImageModeration请求参数结构体
  */
-export interface DescribeImageStatRequest {
+export interface ImageModerationRequest {
   /**
-   * 审核类型 1: 机器审核; 2: 人工审核
+   * 该字段用于标识业务场景。您可以在内容安全控制台创建对应的ID，配置不同的内容审核策略，通过接口调用，默认不填为0，后端使用默认策略。 -- 该字段暂未开放。
    */
-  AuditType: number
+  BizType?: string
 
   /**
-   * 查询条件
+   * 数据ID，可以由英文字母、数字、下划线、-、@#组成，不超过64个字符
    */
-  Filters: Array<Filters>
-}
-
-/**
- * 识别量统计
- */
-export interface TrendCount {
-  /**
-      * 总调用量
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  TotalCount: number
-
-  /**
-      * 总调用时长
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  TotalHour: number
-
-  /**
-      * 通过量
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  PassCount: number
-
-  /**
-      * 通过时长
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  PassHour: number
-
-  /**
-      * 违规量
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  EvilCount: number
-
-  /**
-      * 违规时长
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  EvilHour: number
-
-  /**
-      * 疑似违规量
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  SuspectCount: number
-
-  /**
-      * 疑似违规时长
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  SuspectHour: number
-
-  /**
-      * 日期
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Date: string
-}
+  DataId?: string
 
-/**
- * 坐标
- */
-export interface Location {
   /**
-   * 左上角横坐标
+   * 数据Base64编码，图片检测接口为图片文件内容，大小不能超过5M
    */
-  X: number
+  FileContent?: string
 
   /**
-   * 左上角纵坐标
+   * 图片资源访问链接，__与FileContent参数必须二选一输入__
    */
-  Y: number
+  FileUrl?: string
 
   /**
-   * 宽度
+   * 截帧频率，GIF图/长图检测专用，默认值为0，表示只会检测GIF图/长图的第一帧
    */
-  Width: number
+  Interval?: number
 
   /**
-   * 高度
+   * GIF图/长图检测专用，代表均匀最大截帧数量，默认值为1（即只取GIF第一张，或长图不做切分处理（可能会造成处理超时））。
    */
-  Height: number
+  MaxFrames?: number
 
   /**
-   * 检测框的旋转角度
+   * 账号相关信息字段，填入后可识别违规风险账号。
    */
-  Rotate: number
-}
-
-/**
- * 分类模型命中子标签结果
- */
-export interface LabelDetailItem {
-  /**
-      * 序号
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Id: number
-
-  /**
-      * 子标签名称
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Name: string
+  User?: User
 
   /**
-      * 子标签分数
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Score: number
+   * 设备相关信息字段，填入后可识别违规风险设备。
+   */
+  Device?: Device
 }
 
 /**
- * ImageModeration返回参数结构体
+ * 实体检测结果详情：实体、广告台标、二维码
  */
-export interface ImageModerationResponse {
+export interface ObjectResult {
   /**
-      * 数据是否属于恶意类型。
-0：正常，1：可疑；
-      */
-  HitFlag: number
+   * 场景识别结果
+   */
+  Scene: string
 
   /**
       * 建议您拿到判断结果后的执行操作。
@@ -165,128 +82,114 @@ export interface ImageModerationResponse {
   Label: string
 
   /**
-   * 子标签名称，如色情--性行为；当未命中子标签时，返回空字符串；
-   */
+      * 子标签检测结果
+注意：此字段可能返回 null，表示取不到有效值。
+      */
   SubLabel: string
 
   /**
-      * 机器判断当前分类的置信度，取值范围：0.00~100.00。分数越高，表示越有可能属于当前分类。
-（如：色情 99.99，则该样本属于色情的置信度非常高。）
-      */
+   * 该标签模型命中的分值
+   */
   Score: number
 
   /**
-      * 智能模型的识别结果，包括涉黄、广告等令人反感、不安全或不适宜的内容类型识别结果。
+      * 实体名称
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  LabelResults: Array<LabelResult>
+  Names: Array<string>
 
   /**
-      * 物体检测模型的审核结果，包括实体、广告台标/二维码等物体坐标信息与内容审核信息。
+      * 实体检测结果明细
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  ObjectResults: Array<ObjectResult>
+  Details: Array<ObjectDetail>
+}
 
+/**
+ * OCR文本结果详情
+ */
+export interface OcrTextDetail {
   /**
-      * OCR识别后的文本识别结果，包括文本所处图片的OCR坐标信息以及图片文本的识别结果。
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  OcrResults: Array<OcrResult>
+   * OCR文本内容
+   */
+  Text: string
 
   /**
-      * 基于图片风险库识别的结果。
-风险库包括不安全黑库与正常白库的结果。
-注意：此字段可能返回 null，表示取不到有效值。
+      * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
+以及令人反感、不安全或不适宜的内容类型。
       */
-  LibResults: Array<LibResult>
+  Label: string
 
   /**
-   * 请求参数中的DataId。
+   * 仅当Label为Custom自定义关键词时有效，表示自定义库id
    */
-  DataId: string
+  LibId: string
 
   /**
-   * 您在入参时所填入的Biztype参数。 -- 该字段暂未开放。
+   * 仅当Label为Custom自定义关键词时有效，表示自定义库名称
    */
-  BizType: string
-
-  /**
-      * 扩展字段，用于特定信息返回，不同客户/Biztype下返回信息不同。
-注意：此字段可能返回 null，表示取不到有效值。
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Extra: string
+  LibName: string
 
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 该标签下命中的关键词
    */
-  RequestId?: string
-}
+  Keywords: Array<string>
 
-/**
- * ImageModeration请求参数结构体
- */
-export interface ImageModerationRequest {
   /**
-   * 该字段用于标识业务场景。您可以在内容安全控制台创建对应的ID，配置不同的内容审核策略，通过接口调用，默认不填为0，后端使用默认策略。 -- 该字段暂未开放。
+   * 该标签模型命中的分值
    */
-  BizType?: string
+  Score: number
 
   /**
-   * 数据ID，可以由英文字母、数字、下划线、-、@#组成，不超过64个字符
+   * OCR位置
    */
-  DataId?: string
+  Location: Location
 
   /**
-   * 数据Base64编码，图片检测接口为图片文件内容，大小不能超过5M
+   * OCR文本识别置信度
    */
-  FileContent?: string
+  Rate: number
 
   /**
-   * 图片资源访问链接，__与FileContent参数必须二选一输入__
+   * OCR文本命中的二级标签
    */
-  FileUrl?: string
+  SubLabel: string
+}
 
+/**
+ * 实体检测结果明细，当检测场景为实体、广告台标、二维码时表示模型检测目标框的标签名称、标签值、标签分数以及检测框的位置信息。
+ */
+export interface ObjectDetail {
   /**
-   * 截帧频率，GIF图/长图检测专用，默认值为0，表示只会检测GIF图/长图的第一帧
+   * 序号
    */
-  Interval?: number
+  Id: number
 
   /**
-   * GIF图/长图检测专用，代表均匀最大截帧数量，默认值为1（即只取GIF第一张，或长图不做切分处理（可能会造成处理超时））。
+   * 标签名称
    */
-  MaxFrames?: number
+  Name: string
 
   /**
-   * 账号相关信息字段，填入后可识别违规风险账号。
-   */
-  User?: User
+      * 标签值，
+当标签为二维码时，表示URL地址，如Name为QrCode时，Value为"http//abc.com/aaa"
+      */
+  Value: string
 
   /**
-   * 设备相关信息字段，填入后可识别违规风险设备。
+   * 分数
    */
-  Device?: Device
-}
-
-/**
- * DescribeImsList返回参数结构体
- */
-export interface DescribeImsListResponse {
-  /**
-      * 返回列表数据----非必选，该参数暂未对外开放
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  ImsDetailSet?: Array<ImsDetail>
+  Score: number
 
   /**
-   * 总条数
+   * 检测框坐标
    */
-  TotalCount?: number
+  Location: Location
 
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 二级标签名称
    */
-  RequestId?: string
+  SubLabel: string
 }
 
 /**
@@ -329,206 +232,90 @@ export interface OcrResult {
    * ocr识别出的文本结果
    */
   Text: string
-}
 
-/**
- * User结果
- */
-export interface User {
   /**
-   * 业务用户ID 如填写，会根据账号历史恶意情况，判定消息有害结果，特别是有利于可疑恶意情况下的辅助判断。账号可以填写微信uin、QQ号、微信openid、QQopenid、字符串等。该字段和账号类别确定唯一账号。
+   * 是否命中结果，0 未命中 1命中
    */
-  UserId?: string
-
-  /**
-   * 业务用户ID类型 "1-微信uin 2-QQ号 3-微信群uin 4-qq群号 5-微信openid 6-QQopenid 7-其它string"
-   */
-  AccountType?: string
-
-  /**
-   * 用户昵称
-   */
-  Nickname?: string
-
-  /**
-   * 性别 默认0 未知 1 男性 2 女性
-   */
-  Gender?: number
-
-  /**
-   * 年龄 默认0 未知
-   */
-  Age?: number
-
-  /**
-   * 用户等级，默认0 未知 1 低 2 中 3 高
-   */
-  Level?: number
-
-  /**
-   * 手机号
-   */
-  Phone?: string
-
-  /**
-   * 用户简介，长度不超过5000字
-   */
-  Desc?: string
-
-  /**
-   * 用户头像图片链接
-   */
-  HeadUrl?: string
+  HitFlag: number
 }
 
 /**
- * 分类模型命中结果
+ * 自定义库/黑白库明细
  */
-export interface LabelResult {
+export interface LibDetail {
   /**
-   * 场景识别结果
+   * 序号
    */
-  Scene: string
-
-  /**
-      * 建议您拿到判断结果后的执行操作。
-建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
-      */
-  Suggestion: string
-
-  /**
-      * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义图片。
-以及令人反感、不安全或不适宜的内容类型。
-      */
-  Label: string
-
-  /**
-      * 子标签检测结果
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  SubLabel: string
+  Id: number
 
   /**
-   * 该标签模型命中的分值
+   * 仅当Label为Custom自定义关键词时有效，表示自定义库id
    */
-  Score: number
+  LibId: string
 
   /**
-      * 分类模型命中子标签结果
+      * 仅当Label为Custom自定义关键词时有效，表示自定义库名称
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  Details: Array<LabelDetailItem>
-}
-
-/**
- * Device结果
- */
-export interface Device {
-  /**
-   * 发表消息设备IP
-   */
-  Ip?: string
-
-  /**
-   * Mac地址
-   */
-  Mac?: string
-
-  /**
-   * 设备指纹Token
-   */
-  TokenId?: string
-
-  /**
-   * 设备指纹ID
-   */
-  DeviceId?: string
-
-  /**
-   * 设备序列号
-   */
-  IMEI?: string
-
-  /**
-   * IOS设备，Identifier For Advertising（广告标识符）
-   */
-  IDFA?: string
-
-  /**
-   * IOS设备，IDFV - Identifier For Vendor（应用开发商标识符）
-   */
-  IDFV?: string
-
-  /**
-   * IP地址类型 0 代表ipv4 1 代表ipv6
-   */
-  IpType?: number
-}
-
-/**
- * 机器审核详情列表数据项
- */
-export interface ImsDetail {
-  /**
-   * 文本内容
-   */
-  Content: string
+  LibName: string
 
   /**
-   * 数据方式， 0：我审，1：人审
+   * 图片ID
    */
-  DataSource: number
+  ImageId: string
 
   /**
-   * 最后更新时间
-   */
-  UpdateTime: string
+      * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
+以及其他令人反感、不安全或不适宜的内容类型。
+      */
+  Label: string
 
   /**
-   * ----非必选，该参数暂未对外开放
-   */
-  EvilType: number
+      * 自定义标签
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Tag: string
 
   /**
-   * 机器审核时间
+   * 命中的模型分值
    */
-  ModerationTime: string
+  Score: number
+}
 
+/**
+ * 坐标
+ */
+export interface Location {
   /**
-   * 最后更新人
+   * 左上角横坐标
    */
-  UpdateUser: string
+  X: number
 
   /**
-   * 内容RequestId
+   * 左上角纵坐标
    */
-  ContentId: string
+  Y: number
 
   /**
-   * 自主审核结果
+   * 宽度
    */
-  OperEvilType: number
-}
+  Width: number
 
-/**
- * 违规数据分布
- */
-export interface EvilCount {
   /**
-   * ----非必选，该参数功能暂未对外开放
+   * 高度
    */
-  EvilType: string
+  Height: number
 
   /**
-   * 分布类型总量
+   * 检测框的旋转角度
    */
-  Count: number
+  Rotate: number
 }
 
 /**
- * 实体检测结果详情：实体、广告台标、二维码
+ * 分类模型命中结果
  */
-export interface ObjectResult {
+export interface LabelResult {
   /**
    * 场景识别结果
    */
@@ -558,154 +345,78 @@ export interface ObjectResult {
   Score: number
 
   /**
-      * 实体名称
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Names: Array<string>
-
-  /**
-      * 实体检测结果明细
+      * 分类模型命中子标签结果
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  Details: Array<ObjectDetail>
+  Details: Array<LabelDetailItem>
 }
 
 /**
- * OCR文本结果详情
+ * 分类模型命中子标签结果
  */
-export interface OcrTextDetail {
-  /**
-   * OCR文本内容
-   */
-  Text: string
-
+export interface LabelDetailItem {
   /**
-      * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及令人反感、不安全或不适宜的内容类型。
+      * 序号
+注意：此字段可能返回 null，表示取不到有效值。
       */
-  Label: string
-
-  /**
-   * 仅当Label为Custom自定义关键词时有效，表示自定义库id
-   */
-  LibId: string
-
-  /**
-   * 仅当Label为Custom自定义关键词时有效，表示自定义库名称
-   */
-  LibName: string
-
-  /**
-   * 该标签下命中的关键词
-   */
-  Keywords: Array<string>
-
-  /**
-   * 该标签模型命中的分值
-   */
-  Score: number
-
-  /**
-   * OCR位置
-   */
-  Location: Location
-
-  /**
-   * OCR文本识别置信度
-   */
-  Rate: number
-}
-
-/**
- * 实体检测结果明细，当检测场景为实体、广告台标、二维码时表示模型检测目标框的标签名称、标签值、标签分数以及检测框的位置信息。
- */
-export interface ObjectDetail {
-  /**
-   * 序号
-   */
   Id: number
 
   /**
-   * 标签名称
-   */
+      * 子标签名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
   Name: string
 
   /**
-      * 标签值，
-当标签为二维码时，表示URL地址，如Name为QrCode时，Value为"http//abc.com/aaa"
+      * 子标签分数
+注意：此字段可能返回 null，表示取不到有效值。
       */
-  Value: string
-
-  /**
-   * 分数
-   */
   Score: number
-
-  /**
-   * 检测框坐标
-   */
-  Location: Location
 }
 
 /**
- * 描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等
+ * Device结果
  */
-export interface Filter {
+export interface Device {
   /**
-   * 过滤键的名称。
+   * 发表消息设备IP
    */
-  Name?: string
+  Ip?: string
 
   /**
-   * 一个或者多个过滤值。
+   * Mac地址
    */
-  Values?: Array<string>
-}
+  Mac?: string
 
-/**
- * DescribeImageStat返回参数结构体
- */
-export interface DescribeImageStatResponse {
   /**
-   * 识别结果统计
+   * 设备指纹Token
    */
-  Overview?: Overview
+  TokenId?: string
 
   /**
-   * 识别量统计
+   * 设备指纹ID
    */
-  TrendCount?: Array<TrendCount>
-
-  /**
-      * 违规数据分布
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  EvilCount?: Array<EvilCount>
+  DeviceId?: string
 
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 设备序列号
    */
-  RequestId?: string
-}
+  IMEI?: string
 
-/**
- * DescribeImsList请求参数结构体
- */
-export interface DescribeImsListRequest {
   /**
-   * 分页 页索引
+   * IOS设备，Identifier For Advertising（广告标识符）
    */
-  PageIndex: number
+  IDFA?: string
 
   /**
-   * 分页条数
+   * IOS设备，IDFV - Identifier For Vendor（应用开发商标识符）
    */
-  PageSize: number
+  IDFV?: string
 
   /**
-   * 过滤条件
+   * IP地址类型 0 代表ipv4 1 代表ipv6
    */
-  Filters?: Array<Filter>
+  IpType?: number
 }
 
 /**
@@ -748,107 +459,132 @@ export interface LibResult {
 }
 
 /**
- * 识别结果统计
+ * ImageModeration返回参数结构体
  */
-export interface Overview {
+export interface ImageModerationResponse {
   /**
-   * 总调用量
-   */
-  TotalCount: number
+      * 数据是否属于恶意类型。
+0：正常，1：可疑；
+      */
+  HitFlag: number
 
   /**
-   * 总调用时长
-   */
-  TotalHour: number
+      * 建议您拿到判断结果后的执行操作。
+建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
+      */
+  Suggestion: string
 
   /**
-   * 通过量
-   */
-  PassCount: number
+      * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义图片。
+以及令人反感、不安全或不适宜的内容类型。
+      */
+  Label: string
 
   /**
-   * 通过时长
+   * 子标签名称，如色情--性行为；当未命中子标签时，返回空字符串；
    */
-  PassHour: number
+  SubLabel: string
 
   /**
-   * 违规量
-   */
-  EvilCount: number
+      * 机器判断当前分类的置信度，取值范围：0.00~100.00。分数越高，表示越有可能属于当前分类。
+（如：色情 99.99，则该样本属于色情的置信度非常高。）
+      */
+  Score: number
+
+  /**
+      * 智能模型的识别结果，包括涉黄、广告等令人反感、不安全或不适宜的内容类型识别结果。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  LabelResults: Array<LabelResult>
+
+  /**
+      * 物体检测模型的审核结果，包括实体、广告台标/二维码等物体坐标信息与内容审核信息。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ObjectResults: Array<ObjectResult>
+
+  /**
+      * OCR识别后的文本识别结果，包括文本所处图片的OCR坐标信息以及图片文本的识别结果。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OcrResults: Array<OcrResult>
+
+  /**
+      * 基于图片风险库识别的结果。
+风险库包括不安全黑库与正常白库的结果。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  LibResults: Array<LibResult>
 
   /**
-   * 违规时长
+   * 请求参数中的DataId。
    */
-  EvilHour: number
+  DataId: string
 
   /**
-   * 疑似违规量
+   * 您在入参时所填入的Biztype参数。 -- 该字段暂未开放。
    */
-  SuspectCount: number
+  BizType: string
+
+  /**
+      * 扩展字段，用于特定信息返回，不同客户/Biztype下返回信息不同。
+注意：此字段可能返回 null，表示取不到有效值。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Extra: string
 
   /**
-   * 疑似违规时长
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  SuspectHour: number
+  RequestId?: string
 }
 
 /**
- * 自定义库/黑白库明细
+ * User结果
  */
-export interface LibDetail {
+export interface User {
   /**
-   * 序号
+   * 业务用户ID 如填写，会根据账号历史恶意情况，判定消息有害结果，特别是有利于可疑恶意情况下的辅助判断。账号可以填写微信uin、QQ号、微信openid、QQopenid、字符串等。该字段和账号类别确定唯一账号。
    */
-  Id: number
+  UserId?: string
 
   /**
-   * 仅当Label为Custom自定义关键词时有效，表示自定义库id
+   * 业务用户ID类型 "1-微信uin 2-QQ号 3-微信群uin 4-qq群号 5-微信openid 6-QQopenid 7-其它string"
    */
-  LibId: string
+  AccountType?: string
 
   /**
-      * 仅当Label为Custom自定义关键词时有效，表示自定义库名称
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  LibName: string
+   * 用户昵称
+   */
+  Nickname?: string
 
   /**
-   * 图片ID
+   * 性别 默认0 未知 1 男性 2 女性
    */
-  ImageId: string
+  Gender?: number
 
   /**
-      * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及其他令人反感、不安全或不适宜的内容类型。
-      */
-  Label: string
+   * 年龄 默认0 未知
+   */
+  Age?: number
 
   /**
-      * 自定义标签
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Tag: string
+   * 用户等级，默认0 未知 1 低 2 中 3 高
+   */
+  Level?: number
 
   /**
-   * 命中的模型分值
+   * 手机号
    */
-  Score: number
-}
+  Phone?: string
 
-/**
- * 图片过滤条件
- */
-export interface Filters {
   /**
-      * 查询字段：
-策略BizType
-子账号SubUin
-日期区间DateRange
-      */
-  Name: string
+   * 用户简介，长度不超过5000字
+   */
+  Desc?: string
 
   /**
-   * 查询值
+   * 用户头像图片链接
    */
-  Values: Array<string>
+  HeadUrl?: string
 }