tccli-intl-en 3.1.11.1__py2.py3-none-any.whl → 3.1.39.1__py2.py3-none-any.whl

tccli/services/trtc/v20190722/api.json

@@ -1,9 +1,9 @@
 {
   "actions": {
     "ControlAIConversation": {
-      "document": "Provides server-side control of AI Conversation",
+      "document": "This API is used to provide service for server-side robot control.",
       "input": "ControlAIConversationRequest",
-      "name": "Control AI Conversation task",
+      "name": "Control AI dialogue",
       "output": "ControlAIConversationResponse",
       "status": "online"
     },
@@ -15,7 +15,7 @@
       "status": "online"
     },
     "CreateCloudRecording": {
-      "document": "API description:\nThis API is used to start an on-cloud recording task. It records the audio and video streams in a room and saves them to the specified cloud storage. You can use this API to record the streams in a room separately, or you can mix the streams first and then record the mixed stream.\n\nYou can use this API to perform the following operations:\n* Specify the anchors whose streams you want or do not want to record by using the `RecordParams` parameter\n* Specify the storage service you want to save recording files to by using the `StorageParams` parameter. Currently, you can save recording files to Tencent Cloud VOD or COS.\n* Specify transcoding settings for mixed-stream recording, including video resolution, video bitrate, frame rate, and audio quality, by using `MixTranscodeParams`\n* Specify the layout of different videos in mixed-stream recording mode or select an auto-arranged layout template\n\nKey concepts:\n* Single-stream recording: Record the audio and video of each subscribed user (`UserId`) in a room and save the recording files to the storage you specify.\nMixed-stream recording: Mix the audios and videos of subscribed users (`UserId`) in a room, record the mixed stream, and save the recording files to the storage you specify. After a recording task ends, you can go to the VOD console (https://console.tencentcloud.com/vod/media) or [COS console](https://console.cloud.tencent.com/cos/bucket) to view the recording files.",
+      "document": "API description:.\nStart on-cloud recording to complete audio and video recording in the room and upload to designated cloud storage. This API is used to record each audio and video stream in the TRTC room separately or merge multiple video images into one stream.\nBefore official online operation, pay attention to the recording best practices (https://www.tencentcloud.comom/document/product/647/76497?from_cn_redirect=1#e7e2f04c-6cde-43c9-9cd0-0f8d22dee68c). In conjunction with best practices, it can greatly improve API recording availability.\n\nThis API is used to achieve the following goals:.\nSpecify the subscription stream parameter (RecordParams) to specify the blocklist or allowlist of anchors that need to be recorded.\n* This API is used to specify the storage parameter (StorageParams) to specify the cloud storage you want to upload to. Currently, Tencent Cloud Video on Demand (VOD), Cloud Object Storage (COS), and third-party AWS are supported.\nSpecify detailed parameters for audio and video transcoding in mixed-stream mode (MixTranscodeParams), including video resolution, video bitrate, video frame rate, and sound quality.\n* Specify the position and layout of each stream in mixed-stream mode, or configure via an automatic Template.\n\nKey nouns:.\n* Single stream recording: Record the audio and video of subscribed UserIds in the room separately. The recording service uploads the files to your designated cloud storage in real time.\nMixed-stream recording: Mix the audio and video of subscribed UserId in the room into a video file and upload the recorded files to your designated cloud storage. (After recording ends, go to the VOD console https://console.cloud.tencent.com/vod/media or the object storage COS console https://console.cloud.tencent.com/cos/bucket to view files).",
       "input": "CreateCloudRecordingRequest",
       "name": "Starts an on-cloud recording task",
       "output": "CreateCloudRecordingResponse",
@@ -691,7 +691,7 @@
         },
         {
           "disabled": false,
-          "document": "[Region information](https://www.tencentcloud.comom/document/product/436/6224?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F) of Tencent COS.\nExample value: cn-shanghai-1.\n\n[Region information](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) of AWS S3.\nExample value: ap-southeast-3.\t",
+          "document": "[Region information](https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F) of Tencent COS.\nExample value: cn-shanghai-1.\n\n[Region information](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) of AWS S3.\nExample value: ap-southeast-3.\t",
           "example": "cn-shanghai-1",
           "member": "string",
           "name": "Region",
@@ -727,7 +727,7 @@
         },
         {
           "disabled": false,
-          "document": "Specified location of the cloud bucket, which consists of arrays of strings. Value range for the strings is lowercase letters (a–z), uppercase letters (A–Z), digits (0–9), and special characters (_-). For example, under the feature of [\"prefix1\", \"prefix2\"], the audio slicing file (xxx.mp3) is stored as prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC time}.ogg, while the video frame is stored as prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC time}.png.",
+          "document": "Specified location of the cloud bucket, which consists of arrays of strings. Value range for the strings is lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), and special characters (_-). For example, under the feature of [\"prefix1\", \"prefix2\"], the audio slicing file (xxx.mp3) is stored as prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC time}.ogg, while the video frame is stored as prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC time}.png.",
           "example": "[\"prefix1\", \"prefix2\"]",
           "member": "string",
           "name": "FileNamePrefix",
@@ -751,7 +751,7 @@
         },
         {
           "disabled": false,
-          "document": "[Region information](https://www.tencentcloud.comom/document/product/436/6224?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F) of Tencent COS.\nExample value: cn-shanghai-1.\n[Region information](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) of AWS S3.\nExample value: ap-southeast-3.\t",
+          "document": "[Region information](https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F) of Tencent COS.\nExample value: cn-shanghai-1.\n[Region information](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) of AWS S3.\nExample value: ap-southeast-3.\t",
           "example": "cn-shanghai-1",
           "member": "string",
           "name": "Region",
@@ -787,7 +787,7 @@
         },
         {
           "disabled": false,
-          "document": "Specified location of the cloud bucket, which consists of an array of strings. Value range for the strings is lowercase letters (a–z), uppercase letters (A–Z), digits (0–9), and special characters (_-). For example, under the feature of [\"prefix1\", \"prefix2\"], the audio slicing file (xxx.mp3) is stored as prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC time}.ogg, while the video frame is stored as prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC time}.png.",
+          "document": "Specified location of the cloud bucket, which consists of an array of strings. Value range for the strings is lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), and special characters (_-). For example, under the feature of [\"prefix1\", \"prefix2\"], the audio slicing file (xxx.mp3) is stored as prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC time}.ogg, while the video frame is stored as prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC time}.png.",
           "example": "[\"prefix1\", \"prefix2\"]",
           "member": "string",
           "name": "FileNamePrefix",
@@ -811,7 +811,7 @@
         },
         {
           "disabled": false,
-          "document": "The region of cloud storage.",
+          "document": "[Region information](https://www.tencentcloud.comom/document/product/436/6224?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F) of tencent cloud object storage.\nExample value: cn-shanghai-1.\n\n[Region information](https://docs.AWS.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) of AWS S3.",
           "example": "ap-shanghai(cos, 具体参考云存储厂商支持的地域)",
           "member": "string",
           "name": "Region",
@@ -829,7 +829,7 @@
         },
         {
           "disabled": false,
-          "document": "The access_key of the cloud storage account.",
+          "document": "access_key account information of the cloud storage.\nTo store files to tencent cloud object storage (COS), visit https://console.cloud.tencent.com/cam/capi to view or create the SecretId value corresponding to the key fields in the link.",
           "example": "test-accesskey",
           "member": "string",
           "name": "AccessKey",
@@ -838,7 +838,7 @@
         },
         {
           "disabled": false,
-          "document": "The secret_key of the cloud storage account.",
+          "document": "secret_key account information of the cloud storage.\nTo store files to tencent cloud object storage (COS), visit https://console.cloud.tencent.com/cam/capi to view or create the SecretKey value corresponding to the key fields in the link.",
           "example": "test-secretkey",
           "member": "string",
           "name": "SecretKey",
@@ -847,7 +847,7 @@
         },
         {
           "disabled": false,
-          "document": "The bucket to save data, which is an array of strings that can contain letters (a-z and A-Z), numbers (0-9), underscores (_), and hyphens (-). For example, if the value of this parameter is `[\"prefix1\", \"prefix2\"]`, the recording file `xxx.m3u8` will be saved as `prefix1/prefix2/TaskId/xxx.m3u8`.",
+          "document": "The specified position of the cloud storage bucket consists of an array of strings. valid values: az, az, 0-9, '_', and '-'. for example, the recording file xxx.m3u8 becomes prefix1/prefix2/TaskId/xxx.m3u8 under the function of [\"prefix1\", \"prefix2\"].",
           "example": "[\"prefix1\", \"prefix2\"]",
           "member": "string",
           "name": "FileNamePrefix",
@@ -878,8 +878,8 @@
       "members": [
         {
           "disabled": false,
-          "document": "Unique ID of the task",
-          "example": "无",
+          "document": "Task unique identifier.",
+          "example": "v2*****test",
           "member": "string",
           "name": "TaskId",
           "required": true,
@@ -887,8 +887,8 @@
         },
         {
           "disabled": false,
-          "document": "Control commands, currently supported commands are as follows:\n- ServerPushText, the server sends text to the AI robot, and the AI robot will play the text",
-          "example": "无",
+          "document": "Control command. currently supports the following commands: - ServerPushText: server sends text to the AI robot, and the AI robot will broadcast the text. - InvokeLLM: server sends text to the large model to trigger dialogue.",
+          "example": "ServerPushText",
           "member": "string",
           "name": "Command",
           "required": true,
@@ -896,12 +896,21 @@
         },
         {
           "disabled": false,
-          "document": "The server sends a text broadcast command. This is required when Command is ServerPushText.",
+          "document": "Server-Sent broadcast text Command. required when Command is ServerPushText.",
           "example": "无",
           "member": "ServerPushText",
           "name": "ServerPushText",
           "required": false,
           "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "The server sends a Command to proactively request the large model. when Command is InvokeLLM, it sends the content request to the large model and adds X-Invoke-LLM=\"1\" to the header.",
+          "example": "无",
+          "member": "InvokeLLM",
+          "name": "InvokeLLM",
+          "required": false,
+          "type": "object"
         }
       ],
       "type": "object"
@@ -923,7 +932,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "[SdkAppId](https://www.tencentcloud.comom/document/product/647/46351?from_cn_redirect=1#sdkappid) of TRTC, which is the same as the SdkAppId corresponding to the TRTC room.",
+          "document": "[SdkAppId](https://www.tencentcloud.com/document/product/647/46351?from_cn_redirect=1#sdkappid) of TRTC, which is the same as the SdkAppId corresponding to the TRTC room.",
           "example": "1400188366",
           "member": "uint64",
           "name": "SdkAppId",
@@ -932,7 +941,7 @@
         },
         {
           "disabled": false,
-          "document": "[RoomId](https://www.tencentcloud.comom/document/product/647/46351?from_cn_redirect=1#roomid) of TRTC, which is the RoomId corresponding to the TRTC room.",
+          "document": "[RoomId](https://www.tencentcloud.com/document/product/647/46351?from_cn_redirect=1#roomid) of TRTC, which is the RoomId corresponding to the TRTC room.",
           "example": "295212",
           "member": "string",
           "name": "RoomId",
@@ -1024,7 +1033,7 @@
         {
           "disabled": false,
           "document": "The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.",
-          "example": "1234",
+          "example": "140000000",
           "member": "uint64",
           "name": "SdkAppId",
           "required": true,
@@ -1032,8 +1041,8 @@
         },
         {
           "disabled": false,
-          "document": "The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.",
-          "example": "1234",
+          "document": "[RoomId](https://www.tencentcloud.comom/document/product/647/46351?from_cn_redirect=1#RoomId) of TRTC, which is the RoomId corresponding to the TRTC room in the recording.\nNote: the room id type defaults to integer. if the room id type is a string, specify it via RoomIdType.\n",
+          "example": "room_366",
           "member": "string",
           "name": "RoomId",
           "required": true,
@@ -1105,7 +1114,7 @@
         {
           "disabled": false,
           "document": "The amount of time (in hours) during which API requests can be made after recording starts. Calculation starts when a recording task is started (when the recording task ID is returned). Once the period elapses, the query, modification, and stop recording APIs can no longer be called, but the recording task will continue. The default value is `72` (three days), and the maximum and minimum values allowed are `720` (30 days) and `6` respectively. If you do not set this parameter, the query, modification, and stop recording APIs can be called within 72 hours after recording starts.",
-          "example": "无",
+          "example": "24",
           "member": "uint64",
           "name": "ResourceExpiredHour",
           "required": false,
@@ -1113,8 +1122,8 @@
         },
         {
           "disabled": false,
-          "document": "The permission ticket for a TRTC room. This parameter is required if advanced permission control is enabled in the console, in which case the TRTC backend will verify users’ [PrivateMapKey](https://intl.cloud.tencent.com/document/product/647/32240?from_cn_redirect=1), which include an encrypted room ID and permission bit list. A user providing only `UserSig` and not `PrivateMapKey` will be unable to enter the room.",
-          "example": "无",
+          "document": "The permission ticket for a TRTC room. This parameter is required if advanced permission control is enabled in the console, in which case the TRTC backend will verify users' [PrivateMapKey](https://intl.cloud.tencent.com/document/product/647/32240?from_cn_redirect=1), which include an encrypted room ID and permission bit list. A user providing only `UserSig` and not `PrivateMapKey` will be unable to enter the room.",
+          "example": "eJw1jcEKgkAURX9FZlvY****fL9rfNX4_",
           "member": "string",
           "name": "PrivateMapKey",
           "required": false,
@@ -1129,10 +1138,10 @@
         {
           "disabled": false,
           "document": "The task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends. After a recording task starts, if you want to perform other actions on the task, you need to specify the task ID when making API requests.",
-          "example": "test",
+          "example": "-m9-bVVU7k801X-VX8gO***GrDFLaZwKKZ5-fTXqywE.",
           "member": "string",
           "name": "TaskId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -1150,7 +1159,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "[SdkAppId](https://www.tencentcloud.comom/document/product/647/46351?from_cn_redirect=1#sdkappid) of TRTC, which is the same as the SdkAppId corresponding to the TRTC room.",
+          "document": "[SdkAppId](https://www.tencentcloud.com/document/product/647/46351?from_cn_redirect=1#sdkappid) of TRTC, which is the same as the SdkAppId corresponding to the TRTC room.",
           "example": "1400704311",
           "member": "uint64",
           "name": "SdkAppId",
@@ -1159,7 +1168,7 @@
         },
         {
           "disabled": false,
-          "document": "[RoomId](https://www.tencentcloud.comom/document/product/647/46351?from_cn_redirect=1#roomid) of TRTC, which is the RoomId corresponding to the TRTC room.",
+          "document": "[RoomId](https://www.tencentcloud.com/document/product/647/46351?from_cn_redirect=1#roomid) of TRTC, which is the RoomId corresponding to the TRTC room.",
           "example": "295212",
           "member": "string",
           "name": "RoomId",
@@ -3164,6 +3173,30 @@
       ],
       "usage": "out"
     },
+    "InvokeLLM": {
+      "document": "Service calling actively initiates requests to the LLM.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Request the content of LLM.",
+          "example": "今天天气怎么样",
+          "member": "string",
+          "name": "Content",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Whether to allow the text to interrupt the robot's speaking.",
+          "example": "false",
+          "member": "bool",
+          "name": "Interrupt",
+          "required": false,
+          "type": "bool"
+        }
+      ],
+      "usage": "in"
+    },
     "MaxVideoUser": {
       "document": "The information of the large video in screen sharing or floating layout mode.",
       "members": [
@@ -4039,8 +4072,7 @@
           "member": "uint64",
           "name": "Top",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -4049,8 +4081,7 @@
           "member": "uint64",
           "name": "Left",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -4059,8 +4090,7 @@
           "member": "uint64",
           "name": "Width",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -4069,18 +4099,16 @@
           "member": "uint64",
           "name": "Height",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
           "document": "The user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.",
-          "example": "123",
+          "example": "user_1",
           "member": "string",
           "name": "UserId",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
@@ -4089,8 +4117,7 @@
           "member": "uint64",
           "name": "Alpha",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -4099,8 +4126,7 @@
           "member": "uint64",
           "name": "RenderMode",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -4109,8 +4135,7 @@
           "member": "uint64",
           "name": "MediaId",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -4119,18 +4144,16 @@
           "member": "uint64",
           "name": "ImageLayer",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
-          "document": "The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.",
-          "example": "https://xxxx",
+          "document": "The image url supports only jpg, png, and jpeg formats. the resolution limitation is no more than 2K, and the image size limit is no more than 5MB. note that the url must carry the format extension. the url supports only specific strings within the range of a-z, a-z, 0-9, '-', '.', '_', '~', ':', '/', '?', '#', '[', ']', '@', '!', '&', '(', ')', '*', '+', ',', '%', and '='.",
+          "example": "https://xxxx/image.jpg,  https://xxxx/image.jpg?token=xxx",
           "member": "string",
           "name": "SubBackgroundImage",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         }
       ],
       "usage": "in"
@@ -4140,13 +4163,12 @@
       "members": [
         {
           "disabled": false,
-          "document": "Layout mode:\n1: Floating\n2: Screen sharing\n3: Grid (default)\n4: Custom\n\nFloating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and are superimposed over the large video from left to right starting from the bottom of the canvas according to their room entry sequence. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.\n\nScreen sharing: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.\n\nGrid: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed.\n\nCustom: Specify the layout of videos by using the `MixLayoutList` parameter.",
+          "document": "Layout mode.\n1: floating layout.\n2: screen sharing layout.\n3: nine-grid layout.\n4: custom layout.\n\nFloating layout: by default, the video footage of the first host who enters the room (or a specified host) fills the entire screen. other hosts' video images are arranged horizontally from the bottom-left corner in the room entry sequence, displayed as small pictures floating above the large screen. when the number of screens is less than or equal to 17, each line has 4 (4 x 4 arrangement). when the number of screens exceeds 17, the small pictures are rearranged with 5 per line (5 x 5 arrangement). a maximum of 25 screens are supported. if the user only sends audio, it still occupies a screen position.\n\nScreen sharing layout: specifies a large screen position on the left side for one host (if not specified, the large screen position uses the background color). other hosts are arranged vertically on the right side from top to bottom. when the number of screens is less than 17, each column on the right supports up to 8 hosts, occupying a maximum of two columns. when the number of screens exceeds 17, hosts beyond the 17th are arranged horizontally starting from the bottom-left corner. a maximum of 25 screens is supported. if a host only sends audio, it still occupies a screen position.\n\nNine-Grid layout: automatically adjust the size of each frame based on the number of hosts. each host's frame size is the same, supporting up to 25 frames.\n\nCustom layout: customize the layout of each host's video as needed in MixLayoutList.",
           "example": "3",
           "member": "uint64",
           "name": "MixLayoutMode",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -4155,28 +4177,25 @@
           "member": "MixLayout",
           "name": "MixLayoutList",
           "required": false,
-          "type": "list",
-          "value_allowed_null": false
+          "type": "list"
         },
         {
           "disabled": false,
           "document": "The background color, which is a hexadecimal value (starting with \"#\", followed by the color value) converted from an 8-bit RGB value. For example, the RGB value of orange is `R:255 G:165 B:0`, and its hexadecimal value is `#FFA500`. The default color is black.",
-          "example": "123",
+          "example": "#FF0000",
           "member": "string",
           "name": "BackGroundColor",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
           "document": "The user whose video is displayed in the big window. This parameter is valid if `MixLayoutMode` is set to `1` (floating) or `2` (screen sharing). If it is left empty, the first anchor entering the room is displayed in the big window in the floating mode and the canvas background is displayed in the screen sharing mode.",
-          "example": "123",
+          "example": "user_1",
           "member": "string",
           "name": "MaxResolutionUserId",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
@@ -4185,48 +4204,43 @@
           "member": "uint64",
           "name": "MediaId",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
-          "document": "The URL of the background image, which cannot contain Chinese characters. The image must be in JPG or PNG format and cannot be larger than 5 MB.",
-          "example": "https://xxxx",
+          "document": "The image url supports only jpg, png, and jpeg. the image resolution is limited to no more than 2K, and the image size limit is no more than 5MB. note that the url must carry the format extension, and only specific strings are supported in the url, including a-z, a-z, 0-9, '-', '.', '_', '~', ':', '/', '?', '#', '[', ']', '@', '!', '&', '(', ')', '*', '+', ',', '%', and '='.",
+          "example": "https://xxxx/image.jpg,  https://xxxx/image.jpg?token=xxx",
           "member": "string",
           "name": "BackgroundImageUrl",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
-          "document": "`1` means to use placeholders, and `0` (default) means to not use placeholders. If this parameter is set to `1`, when a user is not publishing video, a placeholder image will be displayed in the window reserved for the user.",
+          "document": "Set to 1 to enable the placeholder image function, and 0 to disable it. default is 0. when enabled, the corresponding placeholder image can be displayed in the preset position if the user has no upload audio and video.",
           "example": "0",
           "member": "uint64",
           "name": "PlaceHolderMode",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
-          "document": "The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is defined the same as `RenderMode` in `MixLayoufList`.",
+          "document": "Handling solution when the background image aspect ratio is not the same, consistent with the RenderMode defined in MixLayoutList.",
           "example": "1",
           "member": "uint64",
           "name": "BackgroundImageRenderMode",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
-          "document": "The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.",
-          "example": "https://xxxx",
+          "document": "Sub-Picture placeholder image url supports only jpg, png, jpeg. resolution limitation is no more than 2K. image size limit is no more than 5MB. note that the url must carry format extension and supports only specific string literals within the range of a-z a-z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='.",
+          "example": "https://xxxx/image.jpg,  https://xxxx/image.jpg?token=xxx",
           "member": "string",
           "name": "DefaultSubBackgroundImage",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
@@ -4235,18 +4249,16 @@
           "member": "WaterMark",
           "name": "WaterMarkList",
           "required": false,
-          "type": "list",
-          "value_allowed_null": false
+          "type": "list"
         },
         {
           "disabled": false,
-          "document": "The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is invalid if a custom layout is used. It is defined the same as `RenderMode` in `MixLayoufList`.",
+          "document": "When the aspect ratio of the background image does not match in the template layout, the handling solution is applied. the custom layout is disabled and aligns with the RenderMode defined in MixLayoutList.",
           "example": "1",
           "member": "uint64",
           "name": "RenderMode",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -4255,8 +4267,16 @@
           "member": "uint64",
           "name": "MaxResolutionUserAlign",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Controls whether audio users inside the room occupy the stream mixing layout. this takes effect only in mixed stream recording and template layout. true: represents that audio users do not occupy placeholders. false: represents that audio users occupy placeholders (false by default).",
+          "example": "false",
+          "member": "bool",
+          "name": "PureAudioDisableLayout",
+          "required": false,
+          "type": "bool"
         }
       ],
       "usage": "in"
@@ -4379,7 +4399,7 @@
         },
         {
           "disabled": false,
-          "document": "Whether to save the hit file. 0: not save by default; 1: save.",
+          "document": "Whether to save file. 0: not save by default; 1: save; 2 save the hit file.",
           "example": "0",
           "member": "uint64",
           "name": "SaveModerationFile",
@@ -4722,7 +4742,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "The recording mode.\n1: Single-stream recording. Records the audio and video of each subscribed user (`UserId`) in a room and saves the recording files to the cloud.\n2: Mixed-stream recording. Mixes the audios and videos of subscribed users (`UserId`) in a room, records the mixed stream, and saves the recording files to the cloud.",
+          "document": "Recording mode:.\n1: single stream recording, record the audio and video of the subscribed UserId in the room separately, and upload the recording files to cloud storage.\n2: mixed-stream recording. mix the audio and video of the subscribed UserId in the room into an audio-video file and upload the recording file to cloud storage.",
           "example": "1",
           "member": "uint64",
           "name": "RecordMode",
@@ -4731,7 +4751,7 @@
         },
         {
           "disabled": false,
-          "document": "The time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room. Value range: 5-86400 (max 24 hours). Default value: 30.",
+          "document": "Recording stops automatically when there is no host inside the room for a duration exceeding MaxIdleTime. measurement unit: second. default value: 30 seconds. the value must be greater than or equal to 5 seconds and less than or equal to 86400 seconds (24 hours).",
           "example": "30",
           "member": "uint64",
           "name": "MaxIdleTime",
@@ -4740,7 +4760,7 @@
         },
         {
           "disabled": false,
-          "document": "The media type of the streams to record.\n0: Audio and video streams (default)\n1: Audio streams only\n2: Video streams only",
+          "document": "Media stream type for recording.\n0: recording audio and video streams (default).\n1: record audio streams only.\n2: record video stream only.",
           "example": "0",
           "member": "uint64",
           "name": "StreamType",
@@ -4749,7 +4769,7 @@
         },
         {
           "disabled": false,
-          "document": "The allowlist/blocklist for stream subscription.",
+          "document": "Specifies the allowlist or blocklist for the subscription stream.",
           "example": "无",
           "member": "SubscribeStreamUserIds",
           "name": "SubscribeStreamUserIds",
@@ -4758,7 +4778,7 @@
         },
         {
           "disabled": false,
-          "document": "The output format. `0` (default): HLS; `1`: HLS + MP4; `2`: HLS + AAC;  `3` : MP4,  `4` : AAC. This parameter is invalid if you save recording files to VOD. To specify the format of files saved to VOD, use `MediaType` of `TencentVod`.",
+          "document": "Output file format (valid when stored in third-party storage such as COS). 0: (default) output file is in hls format. 1: output file format is hls+mp4. 2: output file format is hls+aac. 3: output file format is mp4. 4: output file format is aac.\n\nThis parameter is invalid when storing in VOD. when storing in VOD, set MediaType in TencentVod (https://www.tencentcloud.comom/document/api/647/44055?from_cn_redirect=1#TencentVod).",
           "example": "0",
           "member": "uint64",
           "name": "OutputFormat",
@@ -4767,7 +4787,7 @@
         },
         {
           "disabled": false,
-          "document": "Whether to merge the audio and video of a user in the single-stream recording mode. 0 (default): Do not mix the audio and video; 1: Mix the audio and video into one TS file. You don’t need to specify this parameter for mixed-stream recording, which merges audios and videos by default.",
+          "document": "In single-stream recording mode, determine whether to merge the user's audio and video. 0: do not merge the audio and video of a stream (default). 1: merge the audio and video of a stream into one ts. in mixed-stream recording, this parameter is not required, and the audio and video are merged by default.",
           "example": "0",
           "member": "uint64",
           "name": "AvMerge",
@@ -4776,7 +4796,7 @@
         },
         {
           "disabled": false,
-          "document": "The maximum file duration allowed (minutes). If the output format is AAC or MP4, and the maximum file duration is exceeded, the file will be segmented. Value range: 1-1440. Default value: 1440 (24 hours). The maximum file size allowed is 2 GB. If the file size exceeds 2 GB, or the file duration exceeds 24 hours, the file will also be segmented.\nThis parameter is invalid if the output format is HLS.",
+          "document": "If the file format is aac or mp4, the system will automatically split the video file when the length limit is exceeded. measurement unit: minute. defaults to 1440 min (24h). value range: 1-1440. [single file limit is 2G. if file size exceeds 2G or recording duration exceeds 24h, the file will be automatically split.].\nHls format recording. this parameter is not effective.",
           "example": "1440",
           "member": "uint64",
           "name": "MaxMediaFileDuration",
@@ -4785,12 +4805,30 @@
         },
         {
           "disabled": false,
-          "document": "The type of stream to record. `0` (default): The primary stream and substream; `1`: The primary stream; `2`: The substream.",
+          "document": "Specify recording streams. 0: mainstream + auxiliary stream (default); 1: mainstream; 2: auxiliary stream.",
           "example": "0",
           "member": "uint64",
           "name": "MediaId",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies the type of frame to fill when the upstream video stream stops:\n- 0: Fill with the last frame (freeze the last video frame)\n- 1: Fill with black frames",
+          "example": "0",
+          "member": "uint64",
+          "name": "FillType",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies whether the recording task subscribes to the stream published by the Mixed Stream Robot. \n\n- 1: Subscribe. \n- 0: Do not subscribe (default).\n> Note: \nWhen this option is enabled, it is recommended to use the \"Subscription Allowlist.\" Avoid subscribing to both the stream published by the Mixed Stream Robot and the streams published by the hosts simultaneously; otherwise, it will result in audio echoing (duplicate audio) in the recorded file.",
+          "example": "0",
+          "member": "uint64",
+          "name": "SubscribeAbility",
+          "required": false,
+          "type": "int"
         }
       ],
       "usage": "in"
@@ -5080,12 +5118,12 @@
       "usage": "out"
     },
     "ServerPushText": {
-      "document": "The server controls the AI conversation robot to broadcast the specified text",
+      "document": "The server controls the chatbot to broadcast the specified text.",
       "members": [
         {
           "disabled": false,
-          "document": "Server push broadcast text",
-          "example": "无",
+          "document": "Server push broadcast text.",
+          "example": "您好",
           "member": "string",
           "name": "Text",
           "required": false,
@@ -5093,8 +5131,8 @@
         },
         {
           "disabled": false,
-          "document": "Allow this text to interrupt the robot",
-          "example": "无",
+          "document": "Whether to allow the text to interrupt the robot's speaking.",
+          "example": "false",
           "member": "bool",
           "name": "Interrupt",
           "required": false,
@@ -5102,12 +5140,57 @@
         },
         {
           "disabled": false,
-          "document": "After the text is finished, whether to automatically close the conversation task",
-          "example": "无",
+          "document": "Broadcast the text and automatically close the dialogue task.",
+          "example": "false",
           "member": "bool",
           "name": "StopAfterPlay",
           "required": false,
           "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "Server push broadcast audio.\nFormat description: audio must be mono, sampling rate must be consistent with the corresponding TTS sampling rate, and coded as a Base64 string.\nInput rule: when the Audio field is provided, the system will not accept user-submitted input in the Text field. the system will play the Audio content in the Audio field directly.",
+          "example": "音频base64字符串",
+          "member": "string",
+          "name": "Audio",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Defaults to 0. valid at that time only when Interrupt is false.\n-0 means drop messages with Interrupt set to false during the occurrence of interaction.\n-1 indicates that during the occurrence of an interaction, messages with Interrupt as false will not be dropped but cached, waiting to be processed when finished.\n\nNote: if DropMode is 1, multiple messages can be cached. if an interruption occurs subsequently, the cache of messages will be cleared.",
+          "example": "0",
+          "member": "uint64",
+          "name": "DropMode",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "The message priority of ServerPushText. 0 means interruptible, 1 means not interruptible. currently only support 0. if you need to input 1, submit a ticket to contact us to grant permission.\nNote: after receiving a message with Priority=1, any other messages will be ignored (including messages with Priority=1) until the message processing of Priority=1 is complete. this field can be used together with the Interrupt and DropMode fields.\nExample:.\n-Priority=1, Interrupt=true, interrupts existing interaction and broadcasts immediately. the broadcast will not be interrupted during the process.\n-Priority=1, Interrupt=false, DropMode=1. wait for the current interaction to complete before broadcasting. the broadcast will not be interrupted during the process.\n",
+          "example": "0",
+          "member": "uint64",
+          "name": "Priority",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Whether to add the text to the llm history context.",
+          "example": "true",
+          "member": "bool",
+          "name": "AddHistory",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "If filled, it will be bound to the subtitle and sent to the terminal. note that the content must be a json string.",
+          "example": "\"{\\\"custom_msg\\\": 100}\"",
+          "member": "string",
+          "name": "MetaInfo",
+          "required": false,
+          "type": "string"
         }
       ],
       "usage": "in"
@@ -5286,7 +5369,7 @@
         {
           "disabled": false,
           "document": "Depreciated. The callback URL is configured in the console.",
-          "example": "无",
+          "example": "url",
           "member": "string",
           "name": "SliceCallbackUrl",
           "required": false,
@@ -6292,7 +6375,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "The operation to perform on the media uploaded. The value of this parameter is the name of a task flow template. You can create a custom task flow template in Tencent Cloud VOD.",
+          "document": "Subsequent media task processing operations allow automatic task initiation after media upload is completed. the parameter value is the task flow template name. VOD (video on demand) supports creating task flow templates and template naming.",
           "example": "LongVideoPreset",
           "member": "string",
           "name": "Procedure",
@@ -6301,7 +6384,7 @@
         },
         {
           "disabled": false,
-          "document": "The expiration time of the media file, which is a time period (seconds) from the current time. For example, `86400` means to save the media file for one day. To save the file permanently, set this parameter to `0`.",
+          "document": "Media file expiry time is the absolute expiration time from the current system time. to save for one day, enter \"86400\". to retain permanently, enter \"0\". the default is permanent preservation.",
           "example": "86400",
           "member": "uint64",
           "name": "ExpireTime",
@@ -6310,7 +6393,7 @@
         },
         {
           "disabled": false,
-          "document": "The storage region. Set this parameter if you have special requirements on the storage region.",
+          "document": "Specify the upload park, applicable only to the user with special requirement for upload region.",
           "example": "ap-shanghai",
           "member": "string",
           "name": "StorageRegion",
@@ -6319,7 +6402,7 @@
         },
         {
           "disabled": false,
-          "document": "The category ID, which is returned after you create a category by calling an API. You can use categories to manage media files.\nThe default value is `0`, which means others.",
+          "document": "Category ID is used to categorize and manage media. you can create a category and obtain the category ID through the create category api.\nThe default value is 0, indicating other categories.",
           "example": "0",
           "member": "uint64",
           "name": "ClassId",
@@ -6328,7 +6411,7 @@
         },
         {
           "disabled": false,
-          "document": "The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.",
+          "document": "Subapplication ID for video-on-demand (vod). if you need to access resources belonging to a subapplication, fill in this field with the subapplication ID. otherwise, this field is not required.",
           "example": "1",
           "member": "uint64",
           "name": "SubAppId",
@@ -6337,7 +6420,7 @@
         },
         {
           "disabled": false,
-          "document": "The task flow context, which is passed through after the task is completed.",
+          "document": "Task flow context, passed through when task complete.",
           "example": "\"session_context_example\"",
           "member": "string",
           "name": "SessionContext",
@@ -6346,7 +6429,7 @@
         },
         {
           "disabled": false,
-          "document": "The upload context, which is passed through after upload is completed.",
+          "document": "Upload context, passed through on upload completion callback.",
           "example": "\"source_context_example\"",
           "member": "string",
           "name": "SourceContext",
@@ -6355,7 +6438,7 @@
         },
         {
           "disabled": false,
-          "document": "The format of recording files uploaded to VOD. `0` (default): MP4; `1`: HLS; `2`: AAC (valid only if `StreamType` is `1`); `3`: HLS+MP4; `4`: HLS+AAC.",
+          "document": "The recording file format type uploaded to the vod platform. valid values: 0: mp4 (default), 1: hls, 2: aac (valid at that time when StreamType=1 for audio-only recording).\n3: hls+mp4, 4: hls+aac (valid at that time when StreamType=1 is audio-only recording).",
           "example": "1",
           "member": "uint64",
           "name": "MediaType",
@@ -6364,7 +6447,7 @@
         },
         {
           "disabled": false,
-          "document": "The custom prefix of recording files. This parameter is valid only if recording files are uploaded to VOD. It can contain letters, numbers, underscores, and hyphens and cannot exceed 64 bytes. This prefix and the automatically generated filename are connected with `__UserId_u_`.",
+          "document": "Only supports API recording upload to vod. this parameter indicates you can customize the recording file name prefix. [length limit: 64 bytes, only allows a combination of uppercase and lowercase letters (a-zA-Z), numbers (0-9), underline, and hyphen]. the prefix is separated from the automatically generated recording file name by `__UserDefine_u_`.",
           "example": "\"user_prefix\"",
           "member": "string",
           "name": "UserDefineRecordId",
@@ -7091,7 +7174,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "The watermark type. 0 (default): image; 1: text (not supported yet).",
+          "document": "The watermark type. 0 (default): image; 1: text; 2: timestamp.",
           "example": "0",
           "member": "uint64",
           "name": "WaterMarkType",
@@ -7142,8 +7225,7 @@
           "member": "uint64",
           "name": "Top",
           "required": true,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7152,8 +7234,7 @@
           "member": "uint64",
           "name": "Left",
           "required": true,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7162,8 +7243,7 @@
           "member": "uint64",
           "name": "Width",
           "required": true,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7172,8 +7252,7 @@
           "member": "uint64",
           "name": "Height",
           "required": true,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7182,8 +7261,7 @@
           "member": "string",
           "name": "Chars",
           "required": true,
-          "type": "string",
-          "value_allowed_null": true
+          "type": "string"
         },
         {
           "disabled": false,
@@ -7192,8 +7270,7 @@
           "member": "uint64",
           "name": "FontSize",
           "required": false,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7202,8 +7279,7 @@
           "member": "string",
           "name": "FontColor",
           "required": false,
-          "type": "string",
-          "value_allowed_null": true
+          "type": "string"
         },
         {
           "disabled": false,
@@ -7212,8 +7288,7 @@
           "member": "string",
           "name": "BackGroundColor",
           "required": false,
-          "type": "string",
-          "value_allowed_null": true
+          "type": "string"
         }
       ],
       "usage": "in"
@@ -7223,13 +7298,12 @@
       "members": [
         {
           "disabled": false,
-          "document": "The download URLs of the watermark images, which must be in JPG or PNG format and cannot be larger than 5 MB.",
-          "example": "https://xxxx",
+          "document": "The download url address supports only jpg, png, and jpeg with a size limit of no more than 5M. note that the url must carry the format extension and supports only specific strings within the range of a-z, a-z, 0-9, '-', '.', '_', '~', ':', '/', '?', '#', '[', ']', '@', '!', '&', '(', ')', '*', '+', ',', '%', '='.",
+          "example": "https://xxxx/image.jpg,  https://xxxx/image.jpg?token=xxx",
           "member": "string",
           "name": "WaterMarkUrl",
           "required": true,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
@@ -7238,8 +7312,7 @@
           "member": "uint64",
           "name": "Top",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7248,8 +7321,7 @@
           "member": "uint64",
           "name": "Left",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7258,8 +7330,7 @@
           "member": "uint64",
           "name": "Width",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7268,8 +7339,7 @@
           "member": "uint64",
           "name": "Height",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         }
       ],
       "usage": "in"
@@ -7284,8 +7354,7 @@
           "member": "uint64",
           "name": "Pos",
           "required": true,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         },
         {
           "disabled": false,
@@ -7294,8 +7363,7 @@
           "member": "uint64",
           "name": "TimeZone",
           "required": false,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         }
       ],
       "usage": "in"