tencentcloud-sdk-nodejs 4.0.726 → 4.0.728

package/src/services/vm/v20210922/vm_client.ts

@@ -39,6 +39,7 @@ import {
   RecognitionResult,
   CancelTaskResponse,
   AudioResultDetailTextResult,
+  SegmentCosUrlList,
   RcbAsr,
   AudioResult,
   AudioResultDetailMoanResult,
@@ -60,7 +61,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 查看任务详情DescribeTaskDetail
+   * 通过查看任务详情 DescribeTaskDetail 接口，可主动轮询获取检测结果详情。
    */
   async DescribeTaskDetail(
     req: DescribeTaskDetailRequest,
@@ -70,14 +71,49 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 通过URL或存储桶创建审核任务。
+     * 本接口（Video Moderation System，VM）用于提交视频文件或视频流进行智能审核任务。使用前请您使用腾讯云主账号登录控制台[开通视频内容安全服务](https://console.cloud.tencent.com/cms)并调整好对应的业务配置。<br>
+### 功能使用说明：
+
+- 前往“[内容安全控制台-视频内容安全](https://console.cloud.tencent.com/cms)”开启使用视频内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含200分钟的处理量（换算1s每帧截图，赠送**12000张图**、**200分钟的音频**处理量），有效期为15天。
+
+- 该接口为收费接口，计费方式敬请参见[腾讯云视频内容安全定价](https://cloud.tencent.com/product/vm/pricing)。
+
+- 默认接口请求频率限制：**20次/秒**，对于异步审核任务（点播视频），超出频率限制的请求会自动排入待审核队列，对于同步审核任务（直播视频），超出频率限制将会报错。
+- 默认并发审核路数限制：点播默认10路，异步审核任务（点播视频）数量超过并发审核路数时，将会进入排队；直播默认100路，同步审核任务（直播视频）超过并发审核路数，接口会返回错误。
+
+
+### 接口功能说明：
+
+- 支持对视频文件或视频流进行自动检测，从 OCR文本识别、物体检测（实体、广告台标、二维码等）、图像识别及音频审核四个维度，通过深度学习技术识别视频中的违规内容；
+- 支持设置回调地址 Callback 获取检测结果，或通过接口(查看任务详情)主动轮询获取检测结果详情；对于正常审核中的视频任务，如含有违规内容，则截帧图片最长会在**3s**内回调，音频片段会在用户配置的**切片时长 + 2s**内回调；对于在队列中的待审核任务，回调时间为正常审核回调时间+等待时间；
+- 支持通过接口（查看审核任务列表）查询任务队列，用户可根据多种业务信息（业务类型、审核结果、任务状态等）筛选审核任务列表；
+- 支持识别多种违规场景，包括：低俗、谩骂、色情、广告等场景；
+- 支持根据不同的业务场景配置自定义的审核策略；
+- 支持用户自定义配置黑白词库及图片库，打击自定义违规内容（目前仅支持黑名单配置）；
+- 支持用户自定义配置审核任务优先级，当有多个任务排队时，可根据用户配置自动调整任务优先级；
+- 支持批量提交检测任务，**最多可同时创建10个任务**；
+
+### 视频文件调用说明：
+
+- 视频文件大小支持：**4K视频文件 < 10GB**；**低于4K视频文件 < 5GB**
+- 视频文件分辨率支持：**最佳分辨率为1920x1080 (1080p)**，如果视频文件小于300MB，则分辨率可以大于1080p，分辨率最大支持4K，更大视频可以调用[云转码服务](https://cloud.tencent.com/product/mps/details)转码后再送审；
+- 视频文件支持格式：flv、mkv 、mp4 、rmvb 、avi 、wmv、3gp、ts、mov、rm、mpeg、wmf等。
+- 视频文件支持的访问方式：链接地址（支持HTTP/HTTPS）、腾讯云COS存储；
+- 若传入视频文件的访问链接，则需要注意视频**头文件的读取时间限制为3秒**，为保障被检测视频的稳定性和可靠性，建议您使用腾讯云COS存储或者CDN缓存等；
+- 支持用户配置是否需要开启音频审核，若不开启则将仅对视频文件图像内容进行审核。
+
+### 视频流调用说明：
+
+- 视频流时长支持：**8小时以内**
+- 视频流分辨率支持：支持**1920x1080 (1080p)**，更高分辨率视频可以调用[直播云转码服务](https://cloud.tencent.com/document/product/267/39889)转码后再送审；
+- 视频流支持格式：rmtp，flv 等主流视频流编码格式。
+- 视频文件支持的传输协议：HTTP/HTTPS/RTMP；
+- 支持用户配置是否需要开启音频审核，若不开启则将仅对视频流图像内容进行审核。
 
 ### 直播断流处理说明：
 - 请确认已对接[取消任务](https://cloud.tencent.com/document/product/1265/80018)。
 - 如果直播任务取消/结束，则终止直播拉流并退出审核。
 - 如果直播任务没有取消/结束，直播视频推流因故中断，产品将在将在10分钟内持续拉流重试。如果10分钟检测到图片截帧/音频切片数据，则恢复正常审核，反之，则终止拉流并退出审核。在拉流终止后，用户如有审核需求，需重新送审。
-
-默认接口请求频率限制：20次/秒。
      */
   async CreateVideoModerationTask(
     req: CreateVideoModerationTaskRequest,
@@ -87,10 +123,8 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 通过查看审核任务列表接口，可查询任务队列；您可根据多种业务信息（业务类型、审核结果、任务状态等）筛选审核任务列表。<br>
-
-默认接口请求频率限制：**20次/秒**。
-     */
+   * 通过查看审核任务列表接口，可查询任务队列；您可根据多种业务信息（业务类型、审核结果、任务状态等）筛选审核任务列表。
+   */
   async DescribeTasks(
     req: DescribeTasksRequest,
     cb?: (error: string, rep: DescribeTasksResponse) => void
@@ -99,7 +133,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 取消任务
+   * 可使用该接口取消审核任务，成功取消后，该接口返回已取消任务的TaskId。
    */
   async CancelTask(
     req: CancelTaskRequest,

package/src/services/vm/v20210922/vm_models.ts

@@ -46,14 +46,14 @@ Terror 暴恐
 Ad 广告
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Scene: string
+  Scene?: string
   /**
    * 是否命中
 0 未命中
 1 命中
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  HitFlag: number
+  HitFlag?: number
   /**
    * 审核建议，可选值：
 Pass 通过，
@@ -61,37 +61,37 @@ Review 建议人审，
 Block 确认违规
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Suggestion: string
+  Suggestion?: string
   /**
    * 标签
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Label: string
+  Label?: string
   /**
    * 子标签
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  SubLabel: string
+  SubLabel?: string
   /**
    * 分数
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Score: number
+  Score?: number
   /**
-   * 如果命中场景为涉政，则该数据为人物姓名列表，否则null
+   * 人物名称列表，如未识别，则为null
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Names: Array<string>
+  Names?: Array<string>
   /**
    * 图片OCR文本
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Text: string
+  Text?: string
   /**
    * 其他详情
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Details: Array<ImageResultsResultDetail>
+  Details?: Array<ImageResultsResultDetail>
 }
 
 /**
@@ -141,7 +141,7 @@ export interface CreateVideoModerationTaskResponse {
    * 任务创建结果
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Results: Array<TaskResult>
+  Results?: Array<TaskResult>
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -192,105 +192,115 @@ export interface DescribeTaskDetailResponse {
    * 该字段用于返回创建视频审核任务后返回的任务ID（在Results参数中），用于标识需要查询任务详情的审核任务。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  TaskId: string
+  TaskId?: string
   /**
    * 该字段用于返回调用视频审核接口时传入的数据ID参数，方便数据的辨别和管理。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  DataId: string
+  DataId?: string
   /**
    * 该字段用于返回调用视频审核接口时传入的BizType参数，方便数据的辨别和管理。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  BizType: string
+  BizType?: string
   /**
    * 该字段用于返回调用视频审核接口时传入的TaskInput参数中的任务名称，方便任务的识别与管理。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Name: string
+  Name?: string
   /**
    * 该字段用于返回所查询内容的任务状态。
 <br>取值：**FINISH**（任务已完成）、**PENDING** （任务等待中）、**RUNNING** （任务进行中）、**ERROR** （任务出错）、**CANCELLED** （任务已取消）。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Status: string
+  Status?: string
   /**
    * 该字段用于返回调用视频审核接口时输入的视频审核类型，取值为：**VIDEO**（点播视频）和**LIVE_VIDEO**（直播视频），默认值为VIDEO。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Type: string
+  Type?: string
   /**
    * 该字段用于返回基于恶意标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Suggestion: string
+  Suggestion?: string
   /**
    * 该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Porn**：色情，**Abuse**：谩骂，**Ad**：广告，**Custom**：自定义违规；以及其他令人反感、不安全或不适宜的内容类型。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Labels: Array<TaskLabel>
+  Labels?: Array<TaskLabel>
   /**
    * 该字段用于返回输入媒体文件的详细信息，包括编解码格式、分片时长等信息。详细内容敬请参考MediaInfo数据结构的描述。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  MediaInfo: MediaInfo
+  MediaInfo?: MediaInfo
   /**
    * 该字段用于返回审核服务的媒体内容信息，主要包括传入文件类型和访问地址。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  InputInfo: InputInfo
+  InputInfo?: InputInfo
   /**
    * 该字段用于返回被查询任务创建的时间，格式采用 ISO 8601标准。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  CreatedAt: string
+  CreatedAt?: string
   /**
    * 该字段用于返回被查询任务最后更新时间，格式采用 ISO 8601标准。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  UpdatedAt: string
+  UpdatedAt?: string
   /**
    * 在秒后重试
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  TryInSeconds: number
+  TryInSeconds?: number
   /**
    * 该字段用于返回视频中截帧审核的结果，详细返回内容敬请参考ImageSegments数据结构的描述。<br>备注：数据有效期为24小时，如需要延长存储时间，请在已配置的COS储存桶中设置。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ImageSegments: Array<ImageSegments>
+  ImageSegments?: Array<ImageSegments>
   /**
    * 该字段用于返回视频中音频审核的结果，详细返回内容敬请参考AudioSegments数据结构的描述。<br>备注：数据有效期为24小时，如需要延长存储时间，请在已配置的COS储存桶中设置。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  AudioSegments: Array<AudioSegments>
+  AudioSegments?: Array<AudioSegments>
   /**
-   * 当任务状态为Error时，返回对应错误的类型，取值：**DECODE_ERROR**: 解码失败。（输入资源中可能包含无法解码的视频）
+   * 当任务状态为Error时，返回对应错误的类型，取值：
+**DECODE_ERROR**: 解码失败。（输入资源中可能包含无法解码的视频）
 **URL_ERROR**：下载地址验证失败。
-**TIMEOUT_ERROR**：处理超时。任务状态非Error时默认返回为空。
+**TIMEOUT_ERROR**：处理超时。
+**CALLBACK_ERRORR**：回调错误。
+**MODERATION_ERROR**：审核失败。
+**URL_NOT_SUPPORTED**：源文件太大或没有图片音频帧
+任务状态非Error时默认返回为空。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ErrorType: string
+  ErrorType?: string
   /**
    * 当任务状态为Error时，该字段用于返回对应错误的详细描述，任务状态非Error时默认返回为空。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ErrorDescription: string
+  ErrorDescription?: string
   /**
    * 该字段用于返回检测结果所对应的标签。如果未命中恶意，返回Normal，如果命中恶意，则返回Labels中优先级最高的标签
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Label: string
+  Label?: string
   /**
    * 该字段用于返回音频文件识别出的对应文本内容，最大支持**前1000个字符**。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  AudioText: string
+  AudioText?: string
   /**
    * 该字段用于返回音频文件识别出的对应文本内容。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Asrs: Array<RcbAsr>
+  Asrs?: Array<RcbAsr>
+  /**
+   * 该字段用于返回检测结果明细数据相关的cos url	
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  SegmentCosUrlList?: SegmentCosUrlList
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -384,6 +394,11 @@ Block 确认违规
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Score: number
+  /**
+   * 命中的二级标签
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  SubLabel: string
 }
 
 /**
@@ -468,7 +483,8 @@ export interface InputInfo {
  */
 export interface CreateVideoModerationTaskRequest {
   /**
-   * 业务类型, 定义 模版策略，输出存储配置。如果没有BizType，可以先参考 【创建业务配置】接口进行创建
+   * 该字段表示策略的具体编号，用于接口调度，在[内容安全控制台](https://console.cloud.tencent.com/cms/clouds/manage)中可配置。若不传入Biztype参数（留空），则代表采用默认的识别策略；传入则会在审核时根据业务场景采取不同的审核策略。
+备注：Biztype仅为数字、字母与下划线的组合，长度为3-32个字符；不同Biztype关联不同的业务场景与识别能力策略，调用前请确认正确的Biztype。
    */
   BizType: string
   /**
@@ -501,17 +517,17 @@ export interface DescribeTasksResponse {
    * 该字段用于返回当前查询的任务总量，格式为int字符串。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Total: string
+  Total?: string
   /**
    * 该字段用于返回当前页的任务详细数据，具体输出内容请参见TaskData数据结构的详细描述。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Data: Array<TaskData>
+  Data?: Array<TaskData>
   /**
    * 该字段用于返回翻页时使用的Token信息，由系统自动生成，并在翻页时向下一个生成的页面传递此参数，以方便快速翻页功能的实现。当到最后一页时，该字段为空。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  PageToken: string
+  PageToken?: string
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -644,6 +660,37 @@ export interface AudioResultDetailTextResult {
   SubLabel: string
 }
 
+/**
+ * 明细数据相关的cos url
+ */
+export interface SegmentCosUrlList {
+  /**
+   * 全量图片片段的cos url
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  ImageAllUrl?: string
+  /**
+   * 全量音频片段的cos url
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  AudioAllUrl?: string
+  /**
+   * 违规图片片段的cos url
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  ImageBlockUrl?: string
+  /**
+   * 违规音频片段的cos url
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  AudioBlockUrl?: string
+  /**
+   * 全量音频识别文本的cos url
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  AsrUrl?: string
+}
+
 /**
  * 审核切片asr文本信息
  */

package/src/services/wedata/v20210820/wedata_client.ts

@@ -2370,7 +2370,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 查询规则模版操作记录
+   * 查询规则模板操作记录
    */
   async DescribeTemplateHistory(
     req: DescribeTemplateHistoryRequest,
@@ -2552,7 +2552,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 编辑规则模版
+   * 编辑规则模板
    */
   async ModifyRuleTemplate(
     req: ModifyRuleTemplateRequest,
@@ -3419,7 +3419,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 查询规则模版维度分布情况
+   * 查询规则模板维度分布情况
    */
   async DescribeTemplateDimCount(
     req: DescribeTemplateDimCountRequest,

package/src/services/wedata/v20210820/wedata_models.ts

@@ -2152,7 +2152,7 @@ export interface UpdateInLongAgentResponse {
  */
 export interface DescribeTemplateDimCountRequest {
   /**
-   * 模版类型
+   * 模板类型
    */
   Type?: number
   /**
@@ -7502,7 +7502,7 @@ export interface ModifyRuleRequest {
    */
   Type?: number
   /**
-   * 规则所属质量维度（1：准确性，2：唯一性，3：完整性，4：一致性，5：及时性，6：有效性
+   * 规则所属质量维度（1：准确性，2：唯一性，3：完整性，4：一致性，5：及时性，6：有效性）
    */
   QualityDim?: number
   /**
@@ -9941,15 +9941,15 @@ export interface CreateInLongAgentRequest {
  */
 export interface ModifyRuleTemplateRequest {
   /**
-   * 模版ID
+   * 模板ID
    */
   TemplateId?: number
   /**
-   * 模版类型  1.系统模版   2.自定义模版
+   * 模板类型  1.系统模板   2.自定义模板
    */
   Type?: number
   /**
-   * 模版名称
+   * 模板名称
    */
   Name?: string
   /**
@@ -10653,7 +10653,7 @@ export interface ModifyRuleTemplateResponse {
    * 修改成功
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Data: boolean
+  Data?: boolean
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -11929,19 +11929,19 @@ export interface DeleteIntegrationNodeResponse {
  */
 export interface CommitRuleGroupExecResultRequest {
   /**
-   * preject id
+   * 项目ID
    */
   ProjectId: string
   /**
-   * rule group exec id
+   * 规则组执行ID
    */
   RuleGroupExecId: number
   /**
-   * group exec state
+   * 规则组执行状态
    */
   RuleGroupState: string
   /**
-   * runner rule exec result list
+   * 规则执行结果集合
    */
   RuleExecResults: Array<RunnerRuleExecResult>
 }
@@ -14196,7 +14196,7 @@ export interface DescribeTemplateDimCountResponse {
    * 维度统计结果
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Data: Array<DimensionCount>
+  Data?: Array<DimensionCount>
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -22202,7 +22202,7 @@ export interface DescribeTemplateHistoryResponse {
    * 分页记录
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Data: RuleTemplateHistoryPage
+  Data?: RuleTemplateHistoryPage
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -24251,7 +24251,7 @@ export interface CommitRuleGroupExecResultResponse {
    * 无
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  Data: string
+  Data?: string
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */