tencentcloud-sdk-nodejs 4.0.865 → 4.0.867

package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts

@@ -1,6 +1,6 @@
 import { AbstractClient } from "../../../common/abstract_client";
 import { ClientConfig } from "../../../common/interface";
-import { DescribeRoleListResponse, DeleteMQTTTopicRequest, CreateInstanceResponse, ModifyRoleResponse, DeleteMQTTInsPublicEndpointRequest, ModifyInstanceRequest, CreateMQTTInsPublicEndpointResponse, ImportSourceClusterConsumerGroupsResponse, DeleteTopicRequest, ModifyMQTTInstanceRequest, DescribeMQTTProductSKUListResponse, DescribeRoleListRequest, DescribeMQTTClientResponse, DescribeMQTTMessageListResponse, DescribeMQTTProductSKUListRequest, ImportSourceClusterConsumerGroupsRequest, DescribeMQTTMessageResponse, DescribeMQTTInstanceListResponse, DescribeInstanceListResponse, ModifyInstanceResponse, CreateConsumerGroupRequest, ModifyMQTTTopicResponse, DescribeMQTTClientRequest, DescribeMQTTInsVPCEndpointsResponse, DescribeMQTTInsPublicEndpointsResponse, DescribeInstanceListRequest, DeleteMQTTUserRequest, ModifyMQTTInstanceCertBindingRequest, CreateMQTTTopicResponse, DescribeMQTTInstanceRequest, ImportSourceClusterTopicsRequest, CreateMQTTUserResponse, DeleteInstanceResponse, DescribeTopicResponse, DeleteMQTTInsPublicEndpointResponse, DeleteInstanceRequest, ModifyRoleRequest, DescribeMQTTInsVPCEndpointsRequest, CreateTopicRequest, DeleteRoleRequest, DeleteConsumerGroupRequest, CreateConsumerGroupResponse, DescribeMQTTUserListResponse, ModifyMQTTUserResponse, ModifyMQTTInsPublicEndpointRequest, ModifyMQTTInstanceCertBindingResponse, DeleteMQTTInstanceResponse, DescribeTopicRequest, DeleteMQTTInstanceRequest, CreateTopicResponse, DescribeMQTTInstanceListRequest, CreateMQTTInstanceResponse, DescribeMQTTInstanceResponse, DeleteMQTTUserResponse, ImportSourceClusterTopicsResponse, DescribeTopicListRequest, ModifyConsumerGroupRequest, DescribeConsumerGroupRequest, DescribeConsumerGroupListRequest, CreateInstanceRequest, DescribeConsumerGroupResponse, ModifyTopicResponse, DescribeMQTTInsPublicEndpointsRequest, DeleteRoleResponse, DescribeMQTTInstanceCertResponse, DescribeMQTTTopicListRequest, ModifyTopicRequest, DescribeInstanceResponse, DeleteMQTTTopicResponse, ModifyConsumerGroupResponse, DescribeMQTTInstanceCertRequest, ModifyMQTTInsPublicEndpointResponse, CreateMQTTUserRequest, DescribeMQTTMessageRequest, CreateRoleResponse, DescribeMQTTTopicListResponse, DescribeMQTTUserListRequest, ModifyMQTTInstanceResponse, CreateMQTTInstanceRequest, DescribeTopicListResponse, DescribeMQTTTopicRequest, CreateRoleRequest, DeleteConsumerGroupResponse, ModifyMQTTTopicRequest, DescribeConsumerGroupListResponse, ModifyMQTTUserRequest, CreateMQTTInsPublicEndpointRequest, CreateMQTTTopicRequest, DeleteTopicResponse, DescribeMQTTMessageListRequest, DescribeMQTTTopicResponse, DescribeInstanceRequest } from "./trocket_models";
+import { DescribeRoleListResponse, DeleteMQTTTopicRequest, CreateInstanceResponse, ModifyRoleResponse, DeleteMQTTInsPublicEndpointRequest, ModifyInstanceRequest, CreateMQTTInsPublicEndpointResponse, ImportSourceClusterConsumerGroupsResponse, DeleteTopicRequest, ModifyMQTTInstanceRequest, DescribeMQTTProductSKUListResponse, DescribeRoleListRequest, DescribeMQTTClientResponse, DescribeMQTTMessageListResponse, DescribeMQTTProductSKUListRequest, ImportSourceClusterConsumerGroupsRequest, DescribeMQTTMessageResponse, DescribeMQTTInstanceListResponse, DescribeInstanceListResponse, ModifyInstanceResponse, CreateConsumerGroupRequest, ModifyMQTTTopicResponse, DescribeMQTTClientRequest, DescribeMQTTInsVPCEndpointsResponse, DescribeMQTTInsPublicEndpointsResponse, DescribeInstanceListRequest, DeleteMQTTUserRequest, ModifyMQTTInstanceCertBindingRequest, CreateMQTTTopicResponse, DescribeMQTTInstanceRequest, ImportSourceClusterTopicsRequest, CreateMQTTUserResponse, DeleteInstanceResponse, DescribeTopicResponse, DeleteMQTTInsPublicEndpointResponse, DeleteInstanceRequest, ModifyRoleRequest, DescribeMQTTInsVPCEndpointsRequest, DescribeFusionInstanceListResponse, CreateTopicRequest, DeleteRoleRequest, DeleteConsumerGroupRequest, CreateConsumerGroupResponse, DescribeMQTTUserListResponse, ModifyMQTTUserResponse, ModifyMQTTInsPublicEndpointRequest, ModifyMQTTInstanceCertBindingResponse, DeleteMQTTInstanceResponse, DescribeTopicRequest, DeleteMQTTInstanceRequest, CreateTopicResponse, DescribeMQTTInstanceListRequest, CreateMQTTInstanceResponse, DescribeMQTTInstanceResponse, DeleteMQTTUserResponse, ImportSourceClusterTopicsResponse, DescribeTopicListRequest, ModifyConsumerGroupRequest, DescribeConsumerGroupRequest, DescribeConsumerGroupListRequest, CreateInstanceRequest, DescribeConsumerGroupResponse, ModifyTopicResponse, DescribeMQTTInsPublicEndpointsRequest, DeleteRoleResponse, DescribeMQTTInstanceCertResponse, DescribeMQTTTopicListRequest, ModifyTopicRequest, DescribeInstanceResponse, DeleteMQTTTopicResponse, ModifyConsumerGroupResponse, DescribeMQTTInstanceCertRequest, ModifyMQTTInsPublicEndpointResponse, CreateMQTTUserRequest, DescribeFusionInstanceListRequest, DescribeMQTTMessageRequest, CreateRoleResponse, DescribeMQTTTopicListResponse, DescribeMQTTUserListRequest, ModifyMQTTInstanceResponse, CreateMQTTInstanceRequest, DescribeTopicListResponse, DescribeMQTTTopicRequest, CreateRoleRequest, DeleteConsumerGroupResponse, ModifyMQTTTopicRequest, DescribeConsumerGroupListResponse, ModifyMQTTUserRequest, CreateMQTTInsPublicEndpointRequest, CreateMQTTTopicRequest, DeleteTopicResponse, DescribeMQTTMessageListRequest, DescribeMQTTTopicResponse, DescribeInstanceRequest } from "./trocket_models";
 /**
  * trocket client
  * @class
@@ -146,6 +146,10 @@ export declare class Client extends AbstractClient {
 2. TopicType，主题类型查询，支持多选，可选值：Normal,Order,Transaction,DelayScheduled
      */
     DescribeTopicList(req: DescribeTopicListRequest, cb?: (error: string, rep: DescribeTopicListResponse) => void): Promise<DescribeTopicListResponse>;
+    /**
+     * 查询MQTT实例公网接入点
+     */
+    DescribeMQTTInsPublicEndpoints(req: DescribeMQTTInsPublicEndpointsRequest, cb?: (error: string, rep: DescribeMQTTInsPublicEndpointsResponse) => void): Promise<DescribeMQTTInsPublicEndpointsResponse>;
     /**
      * 查询MQTT集群证书列表
      */
@@ -186,9 +190,14 @@ export declare class Client extends AbstractClient {
      */
     DescribeInstanceList(req: DescribeInstanceListRequest, cb?: (error: string, rep: DescribeInstanceListResponse) => void): Promise<DescribeInstanceListResponse>;
     /**
-     * 查询MQTT实例公网接入点
+     * 获取实例列表，Filters参数使用说明如下：
+1. InstanceName, 名称模糊查询
+2. InstanceId，实例ID查询
+3. InstanceType, 实例类型查询，支持多选
+4. Version，实例版本查询
+当使用TagFilters查询时，Filters参数失效。
      */
-    DescribeMQTTInsPublicEndpoints(req: DescribeMQTTInsPublicEndpointsRequest, cb?: (error: string, rep: DescribeMQTTInsPublicEndpointsResponse) => void): Promise<DescribeMQTTInsPublicEndpointsResponse>;
+    DescribeFusionInstanceList(req: DescribeFusionInstanceListRequest, cb?: (error: string, rep: DescribeFusionInstanceListResponse) => void): Promise<DescribeFusionInstanceListResponse>;
     /**
      * 添加mqtt角色
      */

package/tencentcloud/services/trocket/v20230308/trocket_client.js

@@ -230,6 +230,12 @@ class Client extends abstract_client_1.AbstractClient {
     async DescribeTopicList(req, cb) {
         return this.request("DescribeTopicList", req, cb);
     }
+    /**
+     * 查询MQTT实例公网接入点
+     */
+    async DescribeMQTTInsPublicEndpoints(req, cb) {
+        return this.request("DescribeMQTTInsPublicEndpoints", req, cb);
+    }
     /**
      * 查询MQTT集群证书列表
      */
@@ -282,10 +288,15 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeInstanceList", req, cb);
     }
     /**
-     * 查询MQTT实例公网接入点
+     * 获取实例列表，Filters参数使用说明如下：
+1. InstanceName, 名称模糊查询
+2. InstanceId，实例ID查询
+3. InstanceType, 实例类型查询，支持多选
+4. Version，实例版本查询
+当使用TagFilters查询时，Filters参数失效。
      */
-    async DescribeMQTTInsPublicEndpoints(req, cb) {
-        return this.request("DescribeMQTTInsPublicEndpoints", req, cb);
+    async DescribeFusionInstanceList(req, cb) {
+        return this.request("DescribeFusionInstanceList", req, cb);
     }
     /**
      * 添加mqtt角色

package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts

@@ -185,86 +185,169 @@ export interface ModifyInstanceRequest {
     MaxTopicNum?: number;
 }
 /**
- * 主题与消费组的订阅关系数据
+ * 实例列表页中的实例信息
  */
-export interface SubscriptionData {
+export interface FusionInstanceItem {
     /**
      * 实例ID
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     InstanceId?: string;
     /**
-     * 主题名称
+     * 实例名称
+     */
+    InstanceName?: string;
+    /**
+     * 实例版本
+     */
+    Version?: string;
+    /**
+     * 实例类型，
+  EXPERIMENT，体验版
+  BASIC，基础版
+  PRO，专业版
+  PLATINUM，铂金版
+     */
+    InstanceType?: string;
+    /**
+     * 实例状态，
+  RUNNING, 运行中
+  MAINTAINING，维护中
+  ABNORMAL，异常
+  OVERDUE，欠费
+  DESTROYED，已删除
+  CREATING，创建中
+  MODIFYING，变配中
+  CREATE_FAILURE，创建失败
+  MODIFY_FAILURE，变配失败
+  DELETING，删除中
+     */
+    InstanceStatus?: string;
+    /**
+     * 实例主题数上限
+     */
+    TopicNumLimit?: number;
+    /**
+     * 实例消费组数量上限
+     */
+    GroupNumLimit?: number;
+    /**
+     * 计费模式，
+  POSTPAID，按量计费
+  PREPAID，包年包月
+     */
+    PayMode?: string;
+    /**
+     * 到期时间，秒为单位
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    Topic?: string;
+    ExpiryTime?: number;
     /**
-     * 主题类型
+     * 备注信息
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    TopicType?: string;
+    Remark?: string;
     /**
-     * 单个节点上主题队列数
+     * 主题数量
+     */
+    TopicNum?: number;
+    /**
+     * 消费组数量
+     */
+    GroupNum?: number;
+    /**
+     * 标签列表
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    TopicQueueNum?: number;
+    TagList?: Array<Tag>;
     /**
-     * 消费组名称
+     * 商品规格
+     */
+    SkuCode?: string;
+    /**
+     * TPS限流值
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    ConsumerGroup?: string;
+    TpsLimit?: number;
     /**
-     * 是否在线
+     * 弹性TPS限流值
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    IsOnline?: boolean;
+    ScaledTpsLimit?: number;
     /**
-     * 消费类型
+     * 消息保留时间，小时为单位
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    ConsumeType?: string;
+    MessageRetention?: number;
     /**
-     * 订阅规则
+     * 延迟消息最大时长，小时为单位
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    SubString?: string;
+    MaxMessageDelay?: number;
     /**
-     * 过滤类型
+     * 是否自动续费
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    ExpressionType?: string;
+    RenewFlag?: number;
     /**
-     * 订阅一致性
+     * 4.x独有数据
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    Consistency?: number;
+    InstanceItemExtraInfo?: InstanceItemExtraInfo;
     /**
-     * 消费堆积
+     * 预销毁时间
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    ConsumerLag?: number;
+    DestroyTime?: number;
+}
+/**
+ * 4.x集群和5.0集群列表统一显示 4.x特殊数据承载接口
+ */
+export interface InstanceItemExtraInfo {
     /**
-     * 最后消费进度更新时间，秒为单位
+     * 是否vip
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    LastUpdateTime?: number;
+    IsVip?: boolean;
     /**
-     * 最大重试次数
+     * 4.x专享集群状态
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    MaxRetryTimes?: number;
+    VipInstanceStatus?: number;
     /**
-     * 是否顺序消费
+     * 专享集群峰值带宽
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    ConsumeMessageOrderly?: boolean;
+    MaxBandWidth?: number;
     /**
-     * 消费模式:
-  BROADCASTING 广播模式;
-  CLUSTERING 集群模式;
+     * 专享集群规格
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    MessageModel?: string;
+    SpecName?: string;
+    /**
+     * 专享集群节点数量
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    NodeCount?: number;
+    /**
+     * 专享集群最大存储
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    MaxStorage?: number;
+    /**
+     * 专享集群最大保留时间
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    MaxRetention?: number;
+    /**
+     * 专项集群最大保留时间
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    MinRetention?: number;
+    /**
+     * 4.0共享集群
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    InstanceStatus?: number;
 }
 /**
  * CreateMQTTInsPublicEndpoint返回参数结构体
@@ -1013,6 +1096,24 @@ export interface DescribeMQTTInsVPCEndpointsRequest {
      */
     InstanceId: string;
 }
+/**
+ * DescribeFusionInstanceList返回参数结构体
+ */
+export interface DescribeFusionInstanceListResponse {
+    /**
+     * 查询总数
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    TotalCount?: number;
+    /**
+     * 实例列表
+     */
+    Data?: Array<FusionInstanceItem>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateTopic请求参数结构体
  */
@@ -1708,6 +1809,88 @@ export interface TopicItem {
      */
     MsgTTL?: number;
 }
+/**
+ * 主题与消费组的订阅关系数据
+ */
+export interface SubscriptionData {
+    /**
+     * 实例ID
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    InstanceId?: string;
+    /**
+     * 主题名称
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Topic?: string;
+    /**
+     * 主题类型
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    TopicType?: string;
+    /**
+     * 单个节点上主题队列数
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    TopicQueueNum?: number;
+    /**
+     * 消费组名称
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ConsumerGroup?: string;
+    /**
+     * 是否在线
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    IsOnline?: boolean;
+    /**
+     * 消费类型
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ConsumeType?: string;
+    /**
+     * 订阅规则
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    SubString?: string;
+    /**
+     * 过滤类型
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ExpressionType?: string;
+    /**
+     * 订阅一致性
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Consistency?: number;
+    /**
+     * 消费堆积
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ConsumerLag?: number;
+    /**
+     * 最后消费进度更新时间，秒为单位
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    LastUpdateTime?: number;
+    /**
+     * 最大重试次数
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    MaxRetryTimes?: number;
+    /**
+     * 是否顺序消费
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ConsumeMessageOrderly?: boolean;
+    /**
+     * 消费模式:
+  BROADCASTING 广播模式;
+  CLUSTERING 集群模式;
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    MessageModel?: string;
+}
 /**
  * CreateInstance请求参数结构体
  */
@@ -2165,6 +2348,27 @@ export interface CreateMQTTUserRequest {
      */
     Password?: string;
 }
+/**
+ * DescribeFusionInstanceList请求参数结构体
+ */
+export interface DescribeFusionInstanceListRequest {
+    /**
+     * 查询起始位置
+     */
+    Offset: number;
+    /**
+     * 查询结果限制数量
+     */
+    Limit: number;
+    /**
+     * 查询条件列表
+     */
+    Filters?: Array<Filter>;
+    /**
+     * 标签过滤器
+     */
+    TagFilters?: Array<TagFilter>;
+}
 /**
  * DescribeMQTTMessage请求参数结构体
  */

package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts

@@ -271,7 +271,50 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
      */
     StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
     /**
-     * 这个接口调用后，后台会启动机器人，实时进行语音识别并下发字幕和会议记录。
+     * 这个接口调用后，后台会启动转录机器人，实时进行语音识别并下发字幕和转录消息。
+转录机器人支持两种拉流方式，通过TranscriptionMode字段控制：
+- 拉取全房间的流。
+- 拉取特定用户的流。
+
+服务端实时下发字幕和会议记录有两种方式，通过IMAdminUserId和IMAdminUserSig字段控制：
+- 如果填写IMAdminUserId和IMAdminUserSig，服务端会调用IM的[发送群组消息](https://cloud.tencent.com/document/product/269/1629)API来向端上实时下发消息。客户端只需监听群组消息的回调即可，比如[web端回调](https://cloud.tencent.com/document/product/269/75319)。
+- 如果不填写IMAdminUserId和IMAdminUserSig，服务端使用TRTC自定义消息通道下发消息，CmdId固定是1。客户端只需监听自定义消息的回调即可，比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。
+
+服务端实时下发的消息是JSON字符串，实时字幕具体格式如下：
+`{
+    "type": "subtitle",
+    "userid": "xxx",
+    "text": "xxx",
+    "translation_text": "xxx",
+    "start_time": "00:00:02",
+    "end_time": "00:00:05"
+}`
+字段作用如下：
+- type是subtitle，表示这是实时字幕消息。
+- userid表示是哪个用户说的话。
+- text是语音识别出的文本。
+- translation_text是text翻译后的文本，如果不启用翻译，则是空字符串。
+- start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。
+
+转录消息具体格式如下：
+`{
+    "type": "transcription",
+    "userid": "xxx",
+    "text": "xxx",
+    "translation_text": "xx",
+    "start_time": "00:00:02",
+    "end_time": "00:00:05"
+}`
+字段作用如下：
+- type是transcription，表示这是转录消息。
+- 其余字段同实时字幕消息。
+
+转录消息和实时字幕消息的区别是，转录消息是完整的一句话，实时字幕消息则是这一句话的中间阶段。
+假如有一句完整的话，“今天天气怎么样？”，那么服务的下发消息的顺序可能是这样：
+- 字幕消息，“今天”
+- 字幕消息，“今天天气”
+- 字幕消息，“今天天气怎么样”
+- 转录消息，“今天天气怎么样？”
      */
     StartAITranscription(req: StartAITranscriptionRequest, cb?: (error: string, rep: StartAITranscriptionResponse) => void): Promise<StartAITranscriptionResponse>;
     /**
@@ -339,7 +382,7 @@ peakCurrentUsers：峰值同时在线人数。
      */
     StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
     /**
-     * 对转录的文本进行总结
+     * 对转录的文本进行总结。
      */
     SummarizeTranscription(req?: SummarizeTranscriptionRequest, cb?: (error: string, rep: SummarizeTranscriptionResponse) => void): Promise<SummarizeTranscriptionResponse>;
     /**
@@ -403,7 +446,7 @@ peakCurrentUsers：峰值同时在线人数。
      */
     ModifyPicture(req: ModifyPictureRequest, cb?: (error: string, rep: ModifyPictureResponse) => void): Promise<ModifyPictureResponse>;
     /**
-     * 查询AI转录状态
+     * 查询AI转录任务状态。
      */
     DescribeAITranscription(req: DescribeAITranscriptionRequest, cb?: (error: string, rep: DescribeAITranscriptionResponse) => void): Promise<DescribeAITranscriptionResponse>;
     /**
@@ -441,7 +484,7 @@ networkDelay ：网络延迟率。
      */
     DescribeTRTCMarketQualityData(req: DescribeTRTCMarketQualityDataRequest, cb?: (error: string, rep: DescribeTRTCMarketQualityDataResponse) => void): Promise<DescribeTRTCMarketQualityDataResponse>;
     /**
-     * 停止AI转录
+     * 停止AI转录任务。
      */
     StopAITranscription(req: StopAITranscriptionRequest, cb?: (error: string, rep: StopAITranscriptionResponse) => void): Promise<StopAITranscriptionResponse>;
     /**

package/tencentcloud/services/trtc/v20190722/trtc_client.js

@@ -333,7 +333,50 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
         return this.request("StartMCUMixTranscode", req, cb);
     }
     /**
-     * 这个接口调用后，后台会启动机器人，实时进行语音识别并下发字幕和会议记录。
+     * 这个接口调用后，后台会启动转录机器人，实时进行语音识别并下发字幕和转录消息。
+转录机器人支持两种拉流方式，通过TranscriptionMode字段控制：
+- 拉取全房间的流。
+- 拉取特定用户的流。
+
+服务端实时下发字幕和会议记录有两种方式，通过IMAdminUserId和IMAdminUserSig字段控制：
+- 如果填写IMAdminUserId和IMAdminUserSig，服务端会调用IM的[发送群组消息](https://cloud.tencent.com/document/product/269/1629)API来向端上实时下发消息。客户端只需监听群组消息的回调即可，比如[web端回调](https://cloud.tencent.com/document/product/269/75319)。
+- 如果不填写IMAdminUserId和IMAdminUserSig，服务端使用TRTC自定义消息通道下发消息，CmdId固定是1。客户端只需监听自定义消息的回调即可，比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。
+
+服务端实时下发的消息是JSON字符串，实时字幕具体格式如下：
+`{
+    "type": "subtitle",
+    "userid": "xxx",
+    "text": "xxx",
+    "translation_text": "xxx",
+    "start_time": "00:00:02",
+    "end_time": "00:00:05"
+}`
+字段作用如下：
+- type是subtitle，表示这是实时字幕消息。
+- userid表示是哪个用户说的话。
+- text是语音识别出的文本。
+- translation_text是text翻译后的文本，如果不启用翻译，则是空字符串。
+- start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。
+
+转录消息具体格式如下：
+`{
+    "type": "transcription",
+    "userid": "xxx",
+    "text": "xxx",
+    "translation_text": "xx",
+    "start_time": "00:00:02",
+    "end_time": "00:00:05"
+}`
+字段作用如下：
+- type是transcription，表示这是转录消息。
+- 其余字段同实时字幕消息。
+
+转录消息和实时字幕消息的区别是，转录消息是完整的一句话，实时字幕消息则是这一句话的中间阶段。
+假如有一句完整的话，“今天天气怎么样？”，那么服务的下发消息的顺序可能是这样：
+- 字幕消息，“今天”
+- 字幕消息，“今天天气”
+- 字幕消息，“今天天气怎么样”
+- 转录消息，“今天天气怎么样？”
      */
     async StartAITranscription(req, cb) {
         return this.request("StartAITranscription", req, cb);
@@ -421,7 +464,7 @@ peakCurrentUsers：峰值同时在线人数。
         return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
     }
     /**
-     * 对转录的文本进行总结
+     * 对转录的文本进行总结。
      */
     async SummarizeTranscription(req, cb) {
         return this.request("SummarizeTranscription", req, cb);
@@ -505,7 +548,7 @@ peakCurrentUsers：峰值同时在线人数。
         return this.request("ModifyPicture", req, cb);
     }
     /**
-     * 查询AI转录状态
+     * 查询AI转录任务状态。
      */
     async DescribeAITranscription(req, cb) {
         return this.request("DescribeAITranscription", req, cb);
@@ -555,7 +598,7 @@ networkDelay ：网络延迟率。
         return this.request("DescribeTRTCMarketQualityData", req, cb);
     }
     /**
-     * 停止AI转录
+     * 停止AI转录任务。
      */
     async StopAITranscription(req, cb) {
         return this.request("StopAITranscription", req, cb);