tencentcloud-sdk-nodejs 3.0.267 → 3.0.270

package/tencentcloud/vm/v20201229/vm_client.js

@@ -0,0 +1,147 @@
+/*
+ * 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.
+ */
+const models = require("./models");
+const AbstractClient = require('../../common/abstract_client')
+const ImageSegments = models.ImageSegments;
+const ImageResultResult = models.ImageResultResult;
+const StorageInfo = models.StorageInfo;
+const BucketInfo = models.BucketInfo;
+const CreateVideoModerationTaskResponse = models.CreateVideoModerationTaskResponse;
+const TaskResult = models.TaskResult;
+const CancelTaskRequest = models.CancelTaskRequest;
+const DescribeTaskDetailResponse = models.DescribeTaskDetailResponse;
+const DescribeTasksRequest = models.DescribeTasksRequest;
+const TaskInput = models.TaskInput;
+const DescribeTaskDetailRequest = models.DescribeTaskDetailRequest;
+const TaskLabel = models.TaskLabel;
+const ImageResultsResultDetail = models.ImageResultsResultDetail;
+const InputInfo = models.InputInfo;
+const CreateVideoModerationTaskRequest = models.CreateVideoModerationTaskRequest;
+const DescribeTasksResponse = models.DescribeTasksResponse;
+const AudioResultDetailLanguageResult = models.AudioResultDetailLanguageResult;
+const TaskFilter = models.TaskFilter;
+const CancelTaskResponse = models.CancelTaskResponse;
+const AudioResultDetailTextResult = models.AudioResultDetailTextResult;
+const AudioResult = models.AudioResult;
+const AudioResultDetailMoanResult = models.AudioResultDetailMoanResult;
+const TaskData = models.TaskData;
+const MediaInfo = models.MediaInfo;
+const AudioSegments = models.AudioSegments;
+const ImageResultsResultDetailLocation = models.ImageResultsResultDetailLocation;
+const ImageResult = models.ImageResult;
+
+
+/**
+ * vm client
+ * @class
+ */
+class VmClient extends AbstractClient {
+
+    constructor(credential, region, profile) {
+        super("vm.tencentcloudapi.com", "2020-12-29", credential, region, profile);
+    }
+    
+    /**
+     * 通过查看任务详情 DescribeTaskDetail 接口，可主动轮询获取检测结果详情。<br>
+
+默认接口请求频率限制：**200次/秒**。
+     * @param {DescribeTaskDetailRequest} req
+     * @param {function(string, DescribeTaskDetailResponse):void} cb
+     * @public
+     */
+    DescribeTaskDetail(req, cb) {
+        let resp = new DescribeTaskDetailResponse();
+        this.request("DescribeTaskDetail", req, resp, cb);
+    }
+
+    /**
+     * 本接口（Video Moderation System，VM）用于提交视频文件或视频流进行智能审核任务。使用前请您使用腾讯云主账号登录控制台[开通视频内容安全服务](https://console.cloud.tencent.com/cms/video/package)并调整好对应的业务配置。<br>
+### 功能使用说明：
+
+- 前往“[内容安全控制台-视频内容安全](https://console.cloud.tencent.com/cms/video/package)”开启使用视频内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含600分钟的处理量（换算1s每帧截图，赠送**36000张图**、**600分钟的音频**处理量），有效期为1个月。
+
+- 该接口为收费接口，计费方式敬请参见[腾讯云视频内容安全定价](https://cloud.tencent.com/product/vm/pricing)。
+
+- 默认接口请求频率限制：**20次/秒**，对于异步审核任务（点播视频），超出频率限制的请求会自动排入待审核队列，对于同步审核任务（直播视频），超出频率限制将会报错。
+- 默认并发审核路数限制：10路，异步审核任务（点播视频）数量超过并发审核路数时，将会进入排队；同步审核任务（直播视频）超过并发审核路数，接口会返回错误。
+
+
+### 接口功能说明：
+
+- 支持对视频文件或视频流进行自动检测，从 OCR文本识别、物体检测（实体、广告台标、二维码等）、图像识别及音频审核四个维度，通过深度学习技术识别视频中的违规内容；
+- 支持设置回调地址 Callback 获取检测结果，或通过接口(查看任务详情)主动轮询获取检测结果详情；对于正常审核中的视频任务，如含有违规内容，则截帧图片最长会在**3s**内回调，音频片段会在用户配置的**切片时长 + 2s**内回调；对于在队列中的待审核任务，回调时间为正常审核回调时间+等待时间；
+- 支持通过接口（查看审核任务列表）查询任务队列，用户可根据多种业务信息（业务类型、审核结果、任务状态等）筛选审核任务列表；
+- 支持识别多种违规场景，包括：低俗、谩骂、色情、广告等场景；
+- 支持根据不同的业务场景配置自定义的审核策略；
+- 支持用户自定义配置黑白词库及图片库，打击自定义违规内容（目前仅支持黑名单配置）；
+- 支持用户自定义配置审核任务优先级，当有多个任务排队时，可根据用户配置自动调整任务优先级；
+- 支持批量提交检测任务，**最多可同时创建10个任务**；
+
+### 视频文件调用说明：
+
+- 视频文件大小支持：**文件 < 3GB**
+- 视频文件分辨率支持：**最佳分辨率为1920x1080 (1080p)**，如果视频文件小于300MB，则分辨率可以大于1080p，更大视频可以调用[云转码服务](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缓存等；
+- 支持用户配置是否需要开启音频审核，若不开启则将仅对视频文件图像内容进行审核。
+
+### 视频流调用说明：
+
+- 视频流时长支持：**5小时以内**
+- 视频流分辨率支持：支持**1920x1080 (1080p)**，更高分辨率视频可以调用[直播云转码服务](https://cloud.tencent.com/document/product/267/39889)转码后再送审；
+- 视频流支持格式：rmtp，flv 等主流视频流编码格式。
+- 视频文件支持的传输协议：HTTP/HTTPS/RTMP；
+- 支持用户配置是否需要开启音频审核，若不开启则将仅对视频流图像内容进行审核。
+     * @param {CreateVideoModerationTaskRequest} req
+     * @param {function(string, CreateVideoModerationTaskResponse):void} cb
+     * @public
+     */
+    CreateVideoModerationTask(req, cb) {
+        let resp = new CreateVideoModerationTaskResponse();
+        this.request("CreateVideoModerationTask", req, resp, cb);
+    }
+
+    /**
+     * 通过查看审核任务列表接口，可查询任务队列；您可根据多种业务信息（业务类型、审核结果、任务状态等）筛选审核任务列表。<br>
+
+默认接口请求频率限制：**20次/秒**。
+     * @param {DescribeTasksRequest} req
+     * @param {function(string, DescribeTasksResponse):void} cb
+     * @public
+     */
+    DescribeTasks(req, cb) {
+        let resp = new DescribeTasksResponse();
+        this.request("DescribeTasks", req, resp, cb);
+    }
+
+    /**
+     * 可使用该接口取消审核任务，成功取消后，该接口返回已取消任务的TaskId。<br>
+
+默认接口请求频率限制：**20次/秒**。
+     * @param {CancelTaskRequest} req
+     * @param {function(string, CancelTaskResponse):void} cb
+     * @public
+     */
+    CancelTask(req, cb) {
+        let resp = new CancelTaskResponse();
+        this.request("CancelTask", req, resp, cb);
+    }
+
+
+}
+module.exports = VmClient;

package/tencentcloud/vms/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+    v20200902: require("./v20200902"),
+};

package/tencentcloud/vms/v20200902/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+    Client: require("./vms_client"),
+    Models: require("./models"),
+};

package/tencentcloud/vms/v20200902/models.js

@@ -0,0 +1,264 @@
+/*
+ * 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.
+ */
+const AbstractModel = require("../../common/abstract_model");
+
+/**
+ * SendTtsVoice返回参数结构体
+ * @class
+ */
+class SendTtsVoiceResponse extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * 语音通知发送状态。
+         * @type {SendStatus || null}
+         */
+        this.SendStatus = null;
+
+        /**
+         * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+         * @type {string || null}
+         */
+        this.RequestId = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+
+        if (params.SendStatus) {
+            let obj = new SendStatus();
+            obj.deserialize(params.SendStatus)
+            this.SendStatus = obj;
+        }
+        this.RequestId = 'RequestId' in params ? params.RequestId : null;
+
+    }
+}
+
+/**
+ * SendCodeVoice返回参数结构体
+ * @class
+ */
+class SendCodeVoiceResponse extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * 语音验证码发送状态。
+         * @type {SendStatus || null}
+         */
+        this.SendStatus = null;
+
+        /**
+         * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+         * @type {string || null}
+         */
+        this.RequestId = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+
+        if (params.SendStatus) {
+            let obj = new SendStatus();
+            obj.deserialize(params.SendStatus)
+            this.SendStatus = obj;
+        }
+        this.RequestId = 'RequestId' in params ? params.RequestId : null;
+
+    }
+}
+
+/**
+ * 语音验证码发送状态
+ * @class
+ */
+class SendStatus extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * 标识本次发送 ID，标识一次下发记录。
+         * @type {string || null}
+         */
+        this.CallId = null;
+
+        /**
+         * 用户的 session 内容，腾讯 server 回包中会原样返回。
+注意：此字段可能返回 null，表示取不到有效值。
+         * @type {string || null}
+         */
+        this.SessionContext = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.CallId = 'CallId' in params ? params.CallId : null;
+        this.SessionContext = 'SessionContext' in params ? params.SessionContext : null;
+
+    }
+}
+
+/**
+ * SendCodeVoice请求参数结构体
+ * @class
+ */
+class SendCodeVoiceRequest extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * 验证码，仅支持填写数字，实际播报语音时，会自动在数字前补充语音文本"您的验证码是"。
+         * @type {string || null}
+         */
+        this.CodeMessage = null;
+
+        /**
+         * 被叫手机号码，采用 e.164 标准，格式为+[国家或地区码][用户号码]。
+例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号。
+         * @type {string || null}
+         */
+        this.CalledNumber = null;
+
+        /**
+         * 在[语音控制台](https://console.cloud.tencent.com/vms)添加应用后生成的实际SdkAppid，示例如1400006666。
+         * @type {string || null}
+         */
+        this.VoiceSdkAppid = null;
+
+        /**
+         * 播放次数，可选，最多3次，默认2次。
+         * @type {number || null}
+         */
+        this.PlayTimes = null;
+
+        /**
+         * 用户的 session 内容，腾讯 server 回包中会原样返回。
+         * @type {string || null}
+         */
+        this.SessionContext = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.CodeMessage = 'CodeMessage' in params ? params.CodeMessage : null;
+        this.CalledNumber = 'CalledNumber' in params ? params.CalledNumber : null;
+        this.VoiceSdkAppid = 'VoiceSdkAppid' in params ? params.VoiceSdkAppid : null;
+        this.PlayTimes = 'PlayTimes' in params ? params.PlayTimes : null;
+        this.SessionContext = 'SessionContext' in params ? params.SessionContext : null;
+
+    }
+}
+
+/**
+ * SendTtsVoice请求参数结构体
+ * @class
+ */
+class SendTtsVoiceRequest extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * 模板 ID，在控制台审核通过的模板 ID。
+         * @type {string || null}
+         */
+        this.TemplateId = null;
+
+        /**
+         * 被叫手机号码，采用 e.164 标准，格式为+[国家或地区码][用户号码]。
+例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号。
+         * @type {string || null}
+         */
+        this.CalledNumber = null;
+
+        /**
+         * 在[语音控制台](https://console.cloud.tencent.com/vms)添加应用后生成的实际SdkAppid，示例如1400006666。
+         * @type {string || null}
+         */
+        this.VoiceSdkAppid = null;
+
+        /**
+         * 模板参数，若模板没有参数，请提供为空数组。
+注：语音消息的内容长度不超过350字。
+         * @type {Array.<string> || null}
+         */
+        this.TemplateParamSet = null;
+
+        /**
+         * 播放次数，可选，最多3次，默认2次。
+         * @type {number || null}
+         */
+        this.PlayTimes = null;
+
+        /**
+         * 用户的 session 内容，腾讯 server 回包中会原样返回。
+         * @type {string || null}
+         */
+        this.SessionContext = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.TemplateId = 'TemplateId' in params ? params.TemplateId : null;
+        this.CalledNumber = 'CalledNumber' in params ? params.CalledNumber : null;
+        this.VoiceSdkAppid = 'VoiceSdkAppid' in params ? params.VoiceSdkAppid : null;
+        this.TemplateParamSet = 'TemplateParamSet' in params ? params.TemplateParamSet : null;
+        this.PlayTimes = 'PlayTimes' in params ? params.PlayTimes : null;
+        this.SessionContext = 'SessionContext' in params ? params.SessionContext : null;
+
+    }
+}
+
+module.exports = {
+    SendTtsVoiceResponse: SendTtsVoiceResponse,
+    SendCodeVoiceResponse: SendCodeVoiceResponse,
+    SendStatus: SendStatus,
+    SendCodeVoiceRequest: SendCodeVoiceRequest,
+    SendTtsVoiceRequest: SendTtsVoiceRequest,
+
+}

package/tencentcloud/vms/v20200902/vms_client.js

@@ -0,0 +1,60 @@
+/*
+ * 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.
+ */
+const models = require("./models");
+const AbstractClient = require('../../common/abstract_client')
+const SendTtsVoiceResponse = models.SendTtsVoiceResponse;
+const SendCodeVoiceResponse = models.SendCodeVoiceResponse;
+const SendStatus = models.SendStatus;
+const SendCodeVoiceRequest = models.SendCodeVoiceRequest;
+const SendTtsVoiceRequest = models.SendTtsVoiceRequest;
+
+
+/**
+ * vms client
+ * @class
+ */
+class VmsClient extends AbstractClient {
+
+    constructor(credential, region, profile) {
+        super("vms.tencentcloudapi.com", "2020-09-02", credential, region, profile);
+    }
+    
+    /**
+     * 给用户发语音验证码（仅支持数字）。
+     * @param {SendCodeVoiceRequest} req
+     * @param {function(string, SendCodeVoiceResponse):void} cb
+     * @public
+     */
+    SendCodeVoice(req, cb) {
+        let resp = new SendCodeVoiceResponse();
+        this.request("SendCodeVoice", req, resp, cb);
+    }
+
+    /**
+     * 给用户发送指定模板的语音通知。
+     * @param {SendTtsVoiceRequest} req
+     * @param {function(string, SendTtsVoiceResponse):void} cb
+     * @public
+     */
+    SendTtsVoice(req, cb) {
+        let resp = new SendTtsVoiceResponse();
+        this.request("SendTtsVoice", req, resp, cb);
+    }
+
+
+}
+module.exports = VmsClient;