tccli 3.0.1146.1__py2.py3-none-any.whl → 3.0.1147.1__py2.py3-none-any.whl

tccli/services/trtc/v20190722/api.json

@@ -28,6 +28,13 @@
       "output": "DeletePictureResponse",
       "status": "online"
     },
+    "DescribeAIConversation": {
+      "document": "查询AI对话任务状态。",
+      "input": "DescribeAIConversationRequest",
+      "name": "查询AI对话状态",
+      "output": "DescribeAIConversationResponse",
+      "status": "online"
+    },
     "DescribeAITranscription": {
       "document": "查询AI转录任务状态。",
       "input": "DescribeAITranscriptionRequest",
@@ -252,6 +259,13 @@
       "output": "RemoveUserByStrRoomIdResponse",
       "status": "online"
     },
+    "StartAIConversation": {
+      "document": "启动一个任务，机器人将进入TRTC房间，与指定成员进行AI对话",
+      "input": "StartAIConversationRequest",
+      "name": "开始AI对话任务",
+      "output": "StartAIConversationResponse",
+      "status": "online"
+    },
     "StartAITranscription": {
       "document": "这个接口调用后，后台会启动转录机器人，实时进行语音识别并下发字幕和转录消息。\n转录机器人支持两种拉流方式，通过TranscriptionMode字段控制：\n- 拉取全房间的流。\n- 拉取特定用户的流。\n\n服务端通过TRTC的自定义消息实时下发字幕和会议记录，CmdId固定是1。客户端只需监听自定义消息的回调即可，比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。其他客户端比如安卓、Web等同样可在该链接处找到。\n\n服务端实时下发的消息是JSON字符串，实时字幕具体格式如下：\n`{\n    \"type\": \"subtitle\",\n    \"userid\": \"xxx\",\n    \"text\": \"xxx\",\n    \"translation_text\": \"xxx\",\n    \"start_time\": \"00:00:02\",\n    \"end_time\": \"00:00:05\"\n}`\n字段作用如下：\n- type是subtitle，表示这是实时字幕消息。\n- userid表示是哪个用户说的话。\n- text是语音识别出的文本。\n- translation_text是text翻译后的文本，如果不启用翻译，则是空字符串。\n- start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。\n\n转录消息具体格式如下：\n`{\n    \"type\": \"transcription\",\n    \"userid\": \"xxx\",\n    \"text\": \"xxx\",\n    \"translation_text\": \"xx\",\n    \"start_time\": \"00:00:02\",\n    \"end_time\": \"00:00:05\"\n}`\n字段作用如下：\n- type是transcription，表示这是转录消息。\n- 其余字段同实时字幕消息。\n\n转录消息和实时字幕消息的区别是，转录消息是完整的一句话，实时字幕消息则是这一句话的中间阶段。\n假如有一句完整的话，“今天天气怎么样？”，那么服务的下发消息的顺序可能是这样：\n- 字幕消息，“今天”\n- 字幕消息，“今天天气”\n- 字幕消息，“今天天气怎么样”\n- 转录消息，“今天天气怎么样？”",
       "input": "StartAITranscriptionRequest",
@@ -294,6 +308,13 @@
       "output": "StartWebRecordResponse",
       "status": "online"
     },
+    "StopAIConversation": {
+      "document": "停止AI对话任务",
+      "input": "StopAIConversationRequest",
+      "name": "停止AI对话",
+      "output": "StopAIConversationResponse",
+      "status": "online"
+    },
     "StopAITranscription": {
       "document": "停止AI转录任务。",
       "input": "StopAITranscriptionRequest",
@@ -440,6 +461,56 @@
       ],
       "usage": "out"
     },
+    "AgentConfig": {
+      "document": "机器人参数",
+      "members": [
+        {
+          "disabled": false,
+          "document": "机器人的UserId，用于进房发起任务。【注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个任务时，机器人的UserId也不能相互重复，否则会中断前一个任务。需要保证机器人UserId在房间内唯一。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "UserId",
+          "output_required": false,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "UserSig",
+          "output_required": false,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "机器人拉流的UserId, 填写后，机器人会拉取该UserId的流进行实时处理\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "TargetUserId",
+          "output_required": false,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "房间内推流用户全部退出后超过MaxIdleTime秒，后台自动关闭任务，默认值是60s。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "uint64",
+          "name": "MaxIdleTime",
+          "output_required": false,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
     "AgentParams": {
       "document": "转推服务加入TRTC房间的机器人参数。",
       "members": [
@@ -972,6 +1043,91 @@
       ],
       "type": "object"
     },
+    "DescribeAIConversationRequest": {
+      "document": "DescribeAIConversation请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和开启转录任务的房间使用的SdkAppId相同。",
+          "example": "无",
+          "member": "uint64",
+          "name": "SdkAppId",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "唯一标识一次任务。",
+          "example": "无",
+          "member": "string",
+          "name": "TaskId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "开启任务时填写的SessionId，如果没写则不返回。",
+          "example": "无",
+          "member": "string",
+          "name": "SessionId",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeAIConversationResponse": {
+      "document": "DescribeAIConversation返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "任务开始时间。",
+          "example": "无",
+          "member": "string",
+          "name": "StartTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务状态。有4个值：1、Idle表示任务未开始2、Preparing表示任务准备中3、InProgress表示任务正在运行4、Stopped表示任务已停止，正在清理资源中",
+          "example": "无",
+          "member": "string",
+          "name": "Status",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "唯一标识一次任务。",
+          "example": "无",
+          "member": "string",
+          "name": "TaskId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "开启对话任务时填写的SessionId，如果没写则不返回。",
+          "example": "无",
+          "member": "string",
+          "name": "SessionId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeAITranscriptionRequest": {
       "document": "DescribeAITranscription请求参数结构体",
       "members": [
@@ -5066,6 +5222,34 @@
       ],
       "usage": "both"
     },
+    "STTConfig": {
+      "document": "语音转文字参数",
+      "members": [
+        {
+          "disabled": false,
+          "document": "语音识别支持的语言，默认是\"zh\" 中文\n目前全量支持的语言如下，等号左面是语言英文名，右面是Language字段需要填写的值，该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)：\n1.     Chinese = \"zh\" # 中文\n2.     Chinese_TW = \"zh-TW\" # 中国台湾\n3.     Chinese_DIALECT = \"zh-dialect\" # 中国方言\n4.     English = \"en\" # 英语\n5.     Vietnamese = \"vi\" # 越南语\n6.     Japanese = \"ja\" # 日语\n7.     Korean = \"ko\" # 汉语\n8.     Indonesia = \"id\" # 印度尼西亚语\n9.     Thai = \"th\" # 泰语\n10.     Portuguese = \"pt\" # 葡萄牙语\n11.     Turkish = \"tr\" # 土耳其语\n12.     Arabic = \"ar\" # 阿拉伯语\n13.     Spanish = \"es\" # 西班牙语\n14.     Hindi = \"hi\" # 印地语\n15.     French = \"fr\" # 法语\n16.     Malay = \"ms\" # 马来语\n17.     Filipino = \"fil\" # 菲律宾语\n18.     German = \"de\" # 德语\n19.     Italian = \"it\" # 意大利语\n20.     Russian = \"ru\" # 俄语\n\n注意：\n如果缺少满足您需求的语言，请联系我们技术人员。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "zh",
+          "member": "string",
+          "name": "Language",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "额外识别可能替代语言,最多3个, 需高级版支持,Language指定方言时，不允许设置该字段\n\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "AlternativeLanguage",
+          "output_required": false,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
     "ScaleInfomation": {
       "document": "历史规模信息",
       "members": [
@@ -5338,6 +5522,106 @@
       ],
       "usage": "in"
     },
+    "StartAIConversationRequest": {
+      "document": "StartAIConversation请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和开启转录任务的房间使用的SdkAppId相同。",
+          "example": "无",
+          "member": "uint64",
+          "name": "SdkAppId",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，表示开启对话任务的房间号。",
+          "example": "无",
+          "member": "string",
+          "name": "RoomId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "机器人参数",
+          "example": "无",
+          "member": "AgentConfig",
+          "name": "AgentConfig",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "调用方传入的唯一Id，服务端用来去重。",
+          "example": "无",
+          "member": "string",
+          "name": "SessionId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "TRTC房间号的类型，0代表数字房间号，1代表字符串房间号。不填默认是数字房间号。",
+          "example": "无",
+          "member": "uint64",
+          "name": "RoomIdType",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "语音识别配置。",
+          "example": "无",
+          "member": "STTConfig",
+          "name": "STTConfig",
+          "required": false,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "LLM配置。需符合openai规范，为JSON字符串，示例如下：\n<pre> { <br> &emsp;  \"LLMType\": “大模型类型\"，  // String 必填，目前固定为\"openai\" <br> &emsp;  \"Model\": \"您的模型名称\", // String 必填，指定使用的模型<br>    \"APIKey\": \"您的OpenAI API密钥\", // String 必填，相当于环境变量中的OPENAI_API_KEY<br> &emsp;  \"APIBaseUrl\": \"https://api.openai.com\", // String 必填，OpenAI API的基础URL<br> &emsp;  \"Streaming\": true // Boolean 非必填，指定是否使用流式传输<br> &emsp;} </pre>\n",
+          "example": "无",
+          "member": "string",
+          "name": "LLMConfig",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "TTS配置。目前支持腾讯云TTS, 为JSON字符串，示例如下：\n <pre>{ <br> &emsp; \"AppId\": \"您的应用ID\", // String 必填<br> &emsp; \"TTSType\": \"TTS类型\", // String TTS类型, 固定为\"tencent\"<br> &emsp; \"SercetId\": \"您的密钥ID\", // String 必填<br> &emsp; \"SercetKey\":  \"您的密钥Key\", // String 必填<br> &emsp; \"VoiceType\": 101001, // Integer  必填，音色 ID，包括标准音色与精品音色，精品音色拟真度更高，价格不同于标准音色，请参见<a href=\"https://cloud.tencent.com/document/product/1073/34112\">语音合成计费概述</a>。完整的音色 ID 列表请参见<a href=\"https://cloud.tencent.com/document/product/1073/92668#55924b56-1a73-4663-a7a1-a8dd82d6e823\">语音合成音色列表</a>。<br> &emsp; \"Speed\": 1.25, // Integer 非必填，语速，范围：[-2，6]，分别对应不同语速： -2: 代表0.6倍 -1: 代表0.8倍 0: 代表1.0倍（默认） 1: 代表1.2倍 2: 代表1.5倍  6: 代表2.5倍  如果需要更细化的语速，可以保留小数点后 2 位，例如0.5/1.25/2.81等。 参数值与实际语速转换，可参考 <a href=\"https://sdk-1300466766.cos.ap-shanghai.myqcloud.com/sample/speed_sample.tar.gz\">语速转换</a><br> &emsp; \"Volume\": 5, // Integer 非必填，音量大小，范围：[0，10]，分别对应11个等级的音量，默认值为0，代表正常音量。<br> &emsp; \"PrimaryLanguage\": \"zh-CN\" // String 非必填，主要语言<br> &emsp;}</pre>",
+          "example": "无",
+          "member": "string",
+          "name": "TTSConfig",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "StartAIConversationResponse": {
+      "document": "StartAIConversation返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "用于唯一标识对话任务。",
+          "example": "SV1FR+XTtvzAjRxZZ+aof1DfJF00VSBBNE0zR9W-PEpgCPBmt402BbnqMCdom79LtZO-VbLyV1nhVY1pFauWgrW12BevPvJ5Zn010nD6vj3hgfbVH0.",
+          "member": "string",
+          "name": "TaskId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "StartAITranscriptionRequest": {
       "document": "StartAITranscription请求参数结构体",
       "members": [
@@ -5909,6 +6193,33 @@
       ],
       "type": "object"
     },
+    "StopAIConversationRequest": {
+      "document": "StopAIConversation请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "唯一标识任务。",
+          "example": "-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ..",
+          "member": "string",
+          "name": "TaskId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "StopAIConversationResponse": {
+      "document": "StopAIConversation返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "StopAITranscriptionRequest": {
       "document": "StopAITranscription请求参数结构体",
       "members": [

tccli/services/trtc/v20190722/examples.json

@@ -32,6 +32,14 @@
         "title": "删除图片"
       }
     ],
+    "DescribeAIConversation": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAIConversation\n<公共请求参数>\n\n{\n    \"TaskId\": \"SV1FR+XTtvzAjRxZZ+aof1DfJF00VSBBNE0zR9W-PEpgCPBmt402BbnqMCdom79LtZO-VbLyV1nhVY1pFauWgrW12BevPvJ5Zn010RnD6vj3hgfbV0.\"\n}",
+        "output": "{\n    \"Response\": {\n        \"StartTime\": \"abc\",\n        \"Status\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "查询对话任务状态"
+      }
+    ],
     "DescribeAITranscription": [
       {
         "document": "",
@@ -288,6 +296,14 @@
         "title": "移出用户"
       }
     ],
+    "StartAIConversation": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartAIConversation\n<公共请求参数>\n\n{\n    \"SdkAppId\": 12345678,\n    \"RoomId\": \"room_987654321\",\n    \"RoomIdType\": 1,\n    \"AgentConfig\": {\n        \"UserId\": \"user_12345\",\n        \"UserSig\": \"user_signature_example\",\n        \"MaxIdleTime\": 120,\n        \"TargetUserId\": \"target_user_54321\"\n    },\n    \"SessionId\": \"session_1234567890abcdef\",\n    \"STTConfig\": {\n        \"Language\": \"en-US\",\n        \"AlternativeLanguage\": [\n            \"en-US\",\n            \"zh\"\n        ]\n    },\n    \"LLMConfig\": \"{\\\"LLMType\\\": \\\"openai\\\", \\\"Model\\\": \\\"gpt-3.5-turbo\\\", \\\"APIKey\\\": \\\"xxx\\\", \\\"APIBaseUrl\\\": \\\"http://xxxx-api.woa.com/v1\\\", \\\"Streaming\\\": true}\",\n    \"TTSConfig\": \"{\\\"TTSType\\\": \\\"tencent\\\", \\\"AppId\\\": 130000000, \\\"SecretId\\\": \\\"AKIDxxxxx\\\", \\\"SecretKey\\\": \\\"HlDxxxxxx\\\", \\\"VoiceType\\\": 1008, \\\"Speed\\\": 1}\"\n}",
+        "output": "{\n    \"Response\": {\n        \"TaskId\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "启动一个AI机器人对话"
+      }
+    ],
     "StartAITranscription": [
       {
         "document": "",
@@ -360,6 +376,14 @@
         "title": "启动一个页面录制任务"
       }
     ],
+    "StopAIConversation": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopAIConversation\n<公共请求参数>\n\n{\n    \"TaskId\": \"SV1FR+XTtvzAjRxZZ+aof1DfJF00VSBBNE0zR9W-PEpgCPBmt402BbnqMCdom79LtZO-VbLyV1nhVY1pFauWgrW12BevPvJ5Zn010RnD6vj3hgfbVH0.\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "停止AI对话任务"
+      }
+    ],
     "StopAITranscription": [
       {
         "document": "",

tccli/services/tse/v20201207/api.json

@@ -3910,6 +3910,15 @@
           "name": "InternetConfig",
           "required": false,
           "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "关联的prometheus ID",
+          "example": "prom-788xxxxxx",
+          "member": "string",
+          "name": "PromId",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -14577,6 +14586,16 @@
           "output_required": false,
           "type": "string",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "公网负载均衡描述\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "test",
+          "member": "string",
+          "name": "Description",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"