tencentcloud-sdk-nodejs-ims 4.0.1052 → 4.1.28

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

@@ -1,560 +0,0 @@
-/*
- * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * ImageModeration请求参数结构体
- */
-export interface ImageModerationRequest {
-  /**
-   * 该字段用于标识业务场景。您可以在内容安全控制台创建对应的ID，配置不同的内容审核策略，通过接口调用，默认不填为0，后端使用默认策略。 -- 该字段暂未开放。
-   */
-  BizType?: string
-  /**
-   * 数据ID，可以由英文字母、数字、下划线、-、@#组成，不超过64个字符
-   */
-  DataId?: string
-  /**
-   * 数据Base64编码，图片检测接口为图片文件内容，大小不能超过5M
-   */
-  FileContent?: string
-  /**
-   * 图片资源访问链接，__与FileContent参数必须二选一输入__ 。由于网络安全策略，送审带重定向的链接，可能引起下载失败，请尽量避免，比如Http返回302状态码的链接，可能导致接口返回ResourceUnavailable.ImageDownloadError
-   */
-  FileUrl?: string
-  /**
-   * 截帧频率，GIF图/长图检测专用，默认值为0，表示只会检测GIF图/长图的第一帧
-   */
-  Interval?: number
-  /**
-   * GIF图/长图检测专用，代表均匀最大截帧数量，默认值为1（即只取GIF第一张，或长图不做切分处理（可能会造成处理超时））。
-   */
-  MaxFrames?: number
-  /**
-   * 账号相关信息字段，填入后可识别违规风险账号。
-   */
-  User?: User
-  /**
-   * 设备相关信息字段，填入后可识别违规风险设备。
-   */
-  Device?: Device
-}
-
-/**
- * 识别类型标签结果信息
- */
-export interface RecognitionResult {
-  /**
-   * 当前可能的取值：Scene（图片场景模型）
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Label?: string
-  /**
-   * Label对应模型下的识别标签信息
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Tags?: Array<RecognitionTag>
-}
-
-/**
- * 实体检测结果详情：实体、广告台标、二维码
- */
-export interface ObjectResult {
-  /**
-   * 场景识别结果
-   */
-  Scene: string
-  /**
-   * 建议您拿到判断结果后的执行操作。
-建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
-   */
-  Suggestion: string
-  /**
-   * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义图片。
-以及令人反感、不安全或不适宜的内容类型。
-   */
-  Label: string
-  /**
-   * 子标签检测结果
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  SubLabel: string
-  /**
-   * 该标签模型命中的分值
-   */
-  Score: number
-  /**
-   * 实体名称
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Names: Array<string>
-  /**
-   * 实体检测结果明细
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Details: Array<ObjectDetail>
-}
-
-/**
- * OCR文本结果详情
- */
-export interface OcrTextDetail {
-  /**
-   * OCR文本内容
-   */
-  Text: string
-  /**
-   * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及令人反感、不安全或不适宜的内容类型。
-   */
-  Label: string
-  /**
-   * 仅当Label为Custom自定义关键词时有效，表示自定义库id
-   */
-  LibId: string
-  /**
-   * 仅当Label为Custom自定义关键词时有效，表示自定义库名称
-   */
-  LibName: string
-  /**
-   * 该标签下命中的关键词
-   */
-  Keywords: Array<string>
-  /**
-   * 该标签模型命中的分值
-   */
-  Score: number
-  /**
-   * OCR位置
-   */
-  Location: Location
-  /**
-   * OCR文本识别置信度
-   */
-  Rate: number
-  /**
-   * OCR文本命中的二级标签
-   */
-  SubLabel: string
-}
-
-/**
- * 识别类型标签信息
- */
-export interface RecognitionTag {
-  /**
-   * 标签名称
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Name?: string
-  /**
-   * 置信分：0～100，数值越大表示置信度越高
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Score?: number
-  /**
-   * 标签位置信息，若模型无位置信息，则可能为零值
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Location?: Location
-}
-
-/**
- * 实体检测结果明细，当检测场景为实体、广告台标、二维码时表示模型检测目标框的标签名称、标签值、标签分数以及检测框的位置信息。
- */
-export interface ObjectDetail {
-  /**
-   * 序号
-   */
-  Id: number
-  /**
-   * 标签名称
-   */
-  Name: string
-  /**
-   * 标签值，
-当标签为二维码时，表示URL地址，如Name为QrCode时，Value为"http//abc.com/aaa"
-   */
-  Value: string
-  /**
-   * 分数
-   */
-  Score: number
-  /**
-   * 检测框坐标
-   */
-  Location: Location
-  /**
-   * 二级标签名称
-   */
-  SubLabel: string
-  /**
-   * 图库或人脸库id
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  GroupId?: string
-  /**
-   * 图或人脸id
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  ObjectId?: string
-}
-
-/**
- * OCR结果检测详情
- */
-export interface OcrResult {
-  /**
-   * 场景识别结果
-   */
-  Scene: string
-  /**
-   * 建议您拿到判断结果后的执行操作。
-建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
-   */
-  Suggestion: string
-  /**
-   * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及令人反感、不安全或不适宜的内容类型。
-   */
-  Label: string
-  /**
-   * 子标签检测结果
-   */
-  SubLabel: string
-  /**
-   * 该标签模型命中的分值
-   */
-  Score: number
-  /**
-   * ocr结果详情
-   */
-  Details: Array<OcrTextDetail>
-  /**
-   * ocr识别出的文本结果
-   */
-  Text: string
-  /**
-   * 是否命中结果，0 未命中 1命中
-   */
-  HitFlag: number
-}
-
-/**
- * 自定义库/黑白库明细
- */
-export interface LibDetail {
-  /**
-   * 序号
-   */
-  Id: number
-  /**
-   * 仅当Label为Custom自定义关键词时有效，表示自定义库id
-   */
-  LibId: string
-  /**
-   * 仅当Label为Custom自定义关键词时有效，表示自定义库名称
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  LibName: string
-  /**
-   * 图片ID
-   */
-  ImageId: string
-  /**
-   * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及其他令人反感、不安全或不适宜的内容类型。
-   */
-  Label: string
-  /**
-   * 自定义标签
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Tag: string
-  /**
-   * 命中的模型分值
-   */
-  Score: number
-}
-
-/**
- * 坐标
- */
-export interface Location {
-  /**
-   * 左上角横坐标
-   */
-  X: number
-  /**
-   * 左上角纵坐标
-   */
-  Y: number
-  /**
-   * 宽度
-   */
-  Width: number
-  /**
-   * 高度
-   */
-  Height: number
-  /**
-   * 检测框的旋转角度
-   */
-  Rotate: number
-}
-
-/**
- * 分类模型命中结果
- */
-export interface LabelResult {
-  /**
-   * 场景识别结果
-   */
-  Scene: string
-  /**
-   * 建议您拿到判断结果后的执行操作。
-建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
-   */
-  Suggestion: string
-  /**
-   * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义图片。
-以及令人反感、不安全或不适宜的内容类型。
-   */
-  Label: string
-  /**
-   * 子标签检测结果
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  SubLabel: string
-  /**
-   * 该标签模型命中的分值
-   */
-  Score: number
-  /**
-   * 分类模型命中子标签结果
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Details: Array<LabelDetailItem>
-}
-
-/**
- * 分类模型命中子标签结果
- */
-export interface LabelDetailItem {
-  /**
-   * 序号
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Id: number
-  /**
-   * 子标签名称
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Name: string
-  /**
-   * 子标签分数
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Score: number
-}
-
-/**
- * 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 LibResult {
-  /**
-   * 场景识别结果
-   */
-  Scene: string
-  /**
-   * 建议您拿到判断结果后的执行操作。
-建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
-   */
-  Suggestion: string
-  /**
-   * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及令人反感、不安全或不适宜的内容类型。
-   */
-  Label: string
-  /**
-   * 子标签检测结果
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  SubLabel: string
-  /**
-   * 该标签模型命中的分值
-   */
-  Score: number
-  /**
-   * 黑白库结果明细
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Details: Array<LibDetail>
-}
-
-/**
- * ImageModeration返回参数结构体
- */
-export interface ImageModerationResponse {
-  /**
-   * 数据是否属于恶意类型。
-0：正常，1：可疑；
-   */
-  HitFlag?: number
-  /**
-   * 建议您拿到判断结果后的执行操作。
-建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
-   */
-  Suggestion?: string
-  /**
-   * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义图片。
-以及令人反感、不安全或不适宜的内容类型。
-   */
-  Label?: string
-  /**
-   * 子标签名称，如色情--性行为；当未命中子标签时，返回空字符串；
-   */
-  SubLabel?: string
-  /**
-   * 机器判断当前分类的置信度，取值范围：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。
-   */
-  DataId?: string
-  /**
-   * 您在入参时所填入的Biztype参数。 -- 该字段暂未开放。
-   */
-  BizType?: string
-  /**
-   * 扩展字段，用于特定信息返回，不同客户/Biztype下返回信息不同。
-注意：此字段可能返回 null，表示取不到有效值。
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Extra?: string
-  /**
-   * 该字段用于返回仅识别图片元素的模型结果；包括：场景模型命中的标签、置信度和位置信息
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  RecognitionResults?: Array<RecognitionResult>
-  /**
-   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
-}
-
-/**
- * User结果
- */
-export interface User {
-  /**
-   * 业务用户ID 如填写，会根据账号历史恶意情况，判定消息有害结果，特别是有利于可疑恶意情况下的辅助判断。账号可以填写微信uin、QQ号、微信openid、QQopenid、字符串等。该字段和账号类别确定唯一账号。
-   */
-  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
-}

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

@@ -1,6 +0,0 @@
-import * as Models from "./ims_models"
-import { Client } from "./ims_client"
-export const v20200713 = {
-  Client: Client,
-  Models: Models,
-}

package/src/services/ims/v20201229/ims_client.ts

@@ -1,139 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/*
- * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
-import {
-  ImageModerationRequest,
-  RecognitionResult,
-  OcrHitInfo,
-  ObjectResult,
-  OcrTextDetail,
-  CreateImageModerationAsyncTaskResponse,
-  RecognitionTag,
-  ObjectDetail,
-  Device,
-  OcrResult,
-  LibDetail,
-  Location,
-  LabelResult,
-  LabelDetailItem,
-  CreateImageModerationAsyncTaskRequest,
-  LibResult,
-  ImageModerationResponse,
-  Positions,
-  User,
-} from "./ims_models"
-
-/**
- * ims client
- * @class
- */
-export class Client extends TencentCloudCommon.AbstractClient {
-  constructor(clientConfig: TencentCloudCommon.ClientConfig) {
-    super("ims.tencentcloudapi.com", "2020-12-29", clientConfig)
-  }
-
-  /**
-     * 本接口用于提交图片文件进行异步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms/image/package) 并调整好对应的业务配置。
-### 接口使用说明：
-- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms/image/package)”开启使用图片内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含**3000张图片**识别额度，有效期为15天。
-- 该接口为收费接口，计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。
-
-### 接口功能说明：
-- 支持对图片文件或链接进行检测，通过深度学习技术，识别可能令人反感、不安全或不适宜的违规图片内容；
-- 支持对长图进行拆分检测；
-- 支持识别多种违规场景，包括：低俗、违法违规、色情、广告等场景；
-- 支持多种物体检测（实体、广告台标、二维码等）及图片中文本的OCR文本识别；
-- 支持根据不同的业务场景配置自定义的审核策略；
-- 支持用户自定义选择图片风险库，打击自定义识别类型的违规图片（目前仅支持黑名单配置）；
-- 支持在审核图片内容时同时关联账号或设备信息，可识别违规风险账号或设备。
-### 接口调用说明：
-- 图片文件大小限制：**Base64编码内容应小于10MB**；**图片资源应小于100MB**
-- 图片尺寸支持：**长和宽 需>50分辨率且<40000分辨率，并且图片长宽比<90:1；**
-- 图片文件分辨率支持：建议**分辨率大于256x256**，否则可能会影响识别效果；
-- 图片文件支持格式：PNG、JPG、JPEG、BMP、GIF、WEBP格式；
-- 图片文件链接支持的传输协议：HTTP、HTTPS；
-- 若传入图片文件的访问链接，则需要注意**图片异步接口下载超时时间为15秒，失败后重试1次为3 秒，共18秒下载时间**，为保障被检测图片的稳定性和可靠性，建议您使用腾讯云COS存储或者CDN缓存等；
-- 默认接口请求频率限制：**20次/秒**，超过此调用频率则会报错。
-- ### 接口回调格式：
-- 图片异步检测接口回调格式同[图片同步检测接口输出参数](https://cloud.tencent.com/document/product/1125/53273#3.-.E8.BE.93.E5.87.BA.E5.8F.82.E6.95.B0)
-     */
-  async CreateImageModerationAsyncTask(
-    req: CreateImageModerationAsyncTaskRequest,
-    cb?: (error: string, rep: CreateImageModerationAsyncTaskResponse) => void
-  ): Promise<CreateImageModerationAsyncTaskResponse> {
-    return this.request("CreateImageModerationAsyncTask", req, cb)
-  }
-
-  /**
-     * 本接口（Image Moderation, IM）用于提交图片文件进行同步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms) 并调整好对应的业务配置。
-### 接口使用说明：
-- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms)”开启使用图片内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含**3000张图片**识别额度，有效期为15天。
-- 该接口为收费接口，计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。
-
-### 接口功能说明：
-- 支持对图片文件或链接进行检测，通过深度学习技术，识别可能令人反感、不安全或不适宜的违规图片内容；
-- 支持对GIF图/长图进行截帧或拆分检测；
-- 支持识别多种违规场景，包括：低俗、违法违规、色情、广告等场景；
-- 支持多种物体检测（实体、广告台标、二维码等）及图片中文本的OCR文本识别；
-- 支持根据不同的业务场景配置自定义的审核策略；
-- 支持用户自定义选择图片风险库，打击自定义识别类型的违规图片（目前仅支持黑名单配置）；
-- 支持在审核图片内容时同时关联账号或设备信息，可识别违规风险账号或设备。
-
-### 接口调用说明：
-- 文件大小限制：
-    - 文件大小的最小限制为16字节；
-    - Base64编码后的内容（仅限FileContent）应小于10MB； 
-    - 通过FileURL可访问的源图大小应小于30MB；
-- 图片尺寸支持：长和宽需大于50像素且小于10000像素，并且图片长宽比需小于90:1；
-- 分辨率建议：为保证识别效果，建议图片分辨率大于256x256。
-- 文件格式支持：
-    - **静态图**：BMP、ICO、JPEG、JNG、PNG、TIFF、RAW、SVG、GIF、WEBP、HEIC
-    - **动态图**：GIF、WEBP、HEIC（默认最多抽取5帧图像，每隔5帧进行一次采样）
-- 传输协议：仅支持HTTP和HTTPS协议的图片链接；
-- 并发请求与审核：每次仅能传输一条URL进行审核，支持多并发请求，默认并发量为100 QPS。超过此限制将返回`RequestLimitExceeded`错误；
-- 存储与缓存建议：为了保障图片的稳定性和可靠性，推荐使用腾讯云COS存储或CDN缓存服务存放图片文件。
-
-### 图片下载说明：
-请根据以下规则调整您的图片链接和下载逻辑，以确保最佳的下载体验。
-- 下载时间限制：图片的首次下载超时时间为3秒；如果首次下载超时，系统将自动重试一次，重试的超时时间同样是3秒；若重试后仍未能成功下载，系统将返回 `ImageDownloadError`（下载超时）；
-- 网络安全策略：由于网络安全策略的影响，带有HTTP 302重定向状态码的链接可能会导致下载失败。请尽量避免使用此类链接，以确保下载过程顺利进行；对于因重定向或其他原因导致的下载失败，可能返回 `ResourceUnavailable.ImageDownloadError`；
-- 异步回源支持：目前不支持通过异步回源方式获取图片源。请确保提供的链接为直接指向图片资源的链接，以避免因异步回源不支持而导致的下载失败。
-
-<div class="rno-api-explorer" style="margin-bottom:20px">
-    <div class="rno-api-explorer-inner">
-        <div class="rno-api-explorer-hd">
-            <div class="rno-api-explorer-title">
-                关于版本迭代的描述
-            </div>
-        </div>
-        <div class="rno-api-explorer-body">
-            <div class="rno-api-explorer-cont">
-                <p>当前页面版本为图片内容安全2020版本，2020.11.3日前接入的图片内容安全接口为2019版本</p>
-                <p>2020版本相对2019版本进行了升级，支持更灵活的多场景业务策略配置以及更丰富的识别回调信息，满足不同业务的识别需求，建议按照2020版本接入指引进行接口升级。</p>
-            </div>
-        </div>
-    </div>
-</div>
-     */
-  async ImageModeration(
-    req: ImageModerationRequest,
-    cb?: (error: string, rep: ImageModerationResponse) => void
-  ): Promise<ImageModerationResponse> {
-    return this.request("ImageModeration", req, cb)
-  }
-}