tccli 3.0.1113.1__py2.py3-none-any.whl → 3.0.1114.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -175,6 +175,13 @@
175
175
  "output": "CreateIntegrationRoleResponse",
176
176
  "status": "online"
177
177
  },
178
+ "CreateIntegrationSubOrganizationActiveRecord": {
179
+ "document": "通过此接口,创建子企业激活记录,集团企业管理员可针对未激活的成员企业进行激活。\n激活子企业时请保证子企业 lisence 充足。\n这个操作与页面端激活成员企业操作类似\n![image](https://qcloudimg.tencent-cloud.cn/raw/c4e76fbac92e4ce451a03601c964793b.png)\n\np.s.\n此接口只能用于激活,不能用于续期。",
180
+ "input": "CreateIntegrationSubOrganizationActiveRecordRequest",
181
+ "name": "创建子企业激活记录",
182
+ "output": "CreateIntegrationSubOrganizationActiveRecordResponse",
183
+ "status": "online"
184
+ },
178
185
  "CreateIntegrationUserRoles": {
179
186
  "document": "此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。",
180
187
  "input": "CreateIntegrationUserRolesRequest",
@@ -203,6 +210,13 @@
203
210
  "output": "CreateOrganizationBatchSignUrlResponse",
204
211
  "status": "online"
205
212
  },
213
+ "CreateOrganizationGroupInvitationLink": {
214
+ "document": "生成集团加入链接,分享至子企业超管或者法人,子企业管理员可通过链接加入集团。\n注意:调用当前接口的企业 必须为集团企业。如何成为集团企业可以参考下面的文档[集团操作文档](https://qian.tencent.com/document/86707)",
215
+ "input": "CreateOrganizationGroupInvitationLinkRequest",
216
+ "name": "生成集团加入邀请二维码",
217
+ "output": "CreateOrganizationGroupInvitationLinkResponse",
218
+ "status": "online"
219
+ },
206
220
  "CreateOrganizationInfoChangeUrl": {
207
221
  "document": "此接口(CreateOrganizationInfoChangeUrl)用于创建企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。\n\n\n<h3 id=\"1-企业超管变更\">1. 企业超管变更</h3>\n\n<p>换成企业的其他员工来当超管</p>\n\n<h3 id=\"2-企业基础信息变更\">2. 企业基础信息变更</h3>\n\n<h4 id=\"可以变动\">可以变动</h4>\n\n<ul>\n<li>企业名称<br>\n</li>\n<li>法定代表人姓名(新法人有邀请链接)<br>\n</li>\n<li>企业地址和所在地</li>\n</ul>\n\n<h4 id=\"不可变动\">不可变动</h4>\n\n<ul>\n<li>统一社会信用代码<br>\n</li>\n<li>企业主体类型</li>\n</ul>\n\n<p>如果企业名称变动会引起下面的变动</p>\n\n<ul>\n<li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>\n<li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>\n<li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>\n</ul>",
208
222
  "input": "CreateOrganizationInfoChangeUrlRequest",
@@ -4240,6 +4254,52 @@
4240
4254
  ],
4241
4255
  "type": "object"
4242
4256
  },
4257
+ "CreateIntegrationSubOrganizationActiveRecordRequest": {
4258
+ "document": "CreateIntegrationSubOrganizationActiveRecord请求参数结构体",
4259
+ "members": [
4260
+ {
4261
+ "disabled": false,
4262
+ "document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
4263
+ "example": "无",
4264
+ "member": "UserInfo",
4265
+ "name": "Operator",
4266
+ "required": true,
4267
+ "type": "object"
4268
+ },
4269
+ {
4270
+ "disabled": false,
4271
+ "document": "待激活成员企业ID集合",
4272
+ "example": "无",
4273
+ "member": "string",
4274
+ "name": "SubOrganizationIds",
4275
+ "required": true,
4276
+ "type": "list"
4277
+ }
4278
+ ],
4279
+ "type": "object"
4280
+ },
4281
+ "CreateIntegrationSubOrganizationActiveRecordResponse": {
4282
+ "document": "CreateIntegrationSubOrganizationActiveRecord返回参数结构体",
4283
+ "members": [
4284
+ {
4285
+ "disabled": false,
4286
+ "document": "激活失败的成员企业ID集合",
4287
+ "example": "无",
4288
+ "member": "string",
4289
+ "name": "FailedSubOrganizationIds",
4290
+ "output_required": true,
4291
+ "type": "list",
4292
+ "value_allowed_null": false
4293
+ },
4294
+ {
4295
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4296
+ "member": "string",
4297
+ "name": "RequestId",
4298
+ "type": "string"
4299
+ }
4300
+ ],
4301
+ "type": "object"
4302
+ },
4243
4303
  "CreateIntegrationUserRolesRequest": {
4244
4304
  "document": "CreateIntegrationUserRoles请求参数结构体",
4245
4305
  "members": [
@@ -4760,6 +4820,82 @@
4760
4820
  ],
4761
4821
  "type": "object"
4762
4822
  },
4823
+ "CreateOrganizationGroupInvitationLinkRequest": {
4824
+ "document": "CreateOrganizationGroupInvitationLink请求参数结构体",
4825
+ "members": [
4826
+ {
4827
+ "disabled": false,
4828
+ "document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
4829
+ "example": "无",
4830
+ "member": "UserInfo",
4831
+ "name": "Operator",
4832
+ "required": true,
4833
+ "type": "object"
4834
+ },
4835
+ {
4836
+ "disabled": false,
4837
+ "document": "到期时间(以秒为单位的时间戳),其上限为30天的有效期限。",
4838
+ "example": "无",
4839
+ "member": "int64",
4840
+ "name": "ExpireTime",
4841
+ "required": true,
4842
+ "type": "int"
4843
+ }
4844
+ ],
4845
+ "type": "object"
4846
+ },
4847
+ "CreateOrganizationGroupInvitationLinkResponse": {
4848
+ "document": "CreateOrganizationGroupInvitationLink返回参数结构体",
4849
+ "members": [
4850
+ {
4851
+ "disabled": false,
4852
+ "document": "加入集团二维码链接,子企业的管理员可以直接扫码进入。\n注意:1. 该链接有效期时间为ExpireTime,同时需要注意保密,不要外泄给无关用户。2. 该链接不支持小程序嵌入,仅支持<b>移动端浏览器</b>打开。3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
4853
+ "example": "无",
4854
+ "member": "string",
4855
+ "name": "Link",
4856
+ "output_required": true,
4857
+ "type": "string",
4858
+ "value_allowed_null": false
4859
+ },
4860
+ {
4861
+ "disabled": false,
4862
+ "document": "到期时间(以秒为单位的时间戳)",
4863
+ "example": "无",
4864
+ "member": "int64",
4865
+ "name": "ExpireTime",
4866
+ "output_required": true,
4867
+ "type": "int",
4868
+ "value_allowed_null": false
4869
+ },
4870
+ {
4871
+ "disabled": false,
4872
+ "document": "加入集团短链接。\n注意:\n1. 该链接有效期时间为ExpireTime,同时需要注意保密,不要外泄给无关用户。\n2. 该链接不支持小程序嵌入,仅支持<b>移动端浏览器</b>打开。\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
4873
+ "example": "无",
4874
+ "member": "string",
4875
+ "name": "JumpUrl",
4876
+ "output_required": true,
4877
+ "type": "string",
4878
+ "value_allowed_null": false
4879
+ },
4880
+ {
4881
+ "disabled": false,
4882
+ "document": "腾讯电子签小程序加入集团链接。\n\n<li>小程序和APP集成使用</li>\n<li>得到的链接类似于`pages/guide?shortKey=yDw***k1xFc5`, 用法可以参考:<a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\" target=\"_blank\">跳转电子签小程序</a></li>\n\n\n注: <font color=\"red\">生成的链路后面不能再增加参数</font>",
4883
+ "example": "无",
4884
+ "member": "string",
4885
+ "name": "MiniAppPath",
4886
+ "output_required": false,
4887
+ "type": "string",
4888
+ "value_allowed_null": false
4889
+ },
4890
+ {
4891
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4892
+ "member": "string",
4893
+ "name": "RequestId",
4894
+ "type": "string"
4895
+ }
4896
+ ],
4897
+ "type": "object"
4898
+ },
4763
4899
  "CreateOrganizationInfoChangeUrlRequest": {
4764
4900
  "document": "CreateOrganizationInfoChangeUrl请求参数结构体",
4765
4901
  "members": [
@@ -680,6 +680,14 @@
680
680
  "title": "示例-普通企业创建角色(不带权限树参数)"
681
681
  }
682
682
  ],
683
+ "CreateIntegrationSubOrganizationActiveRecord": [
684
+ {
685
+ "document": "通过此接口,创建子企业激活记录,集团企业管理员可针对未激活的成员企业进行授权。",
686
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateIntegrationSubOrganizationActiveRecord\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"abc\"\n },\n \"SubOrganizationIds\": [\n \"123456\"\n ]\n}",
687
+ "output": "{\n \"Response\": {\n \"FailedSubOrganizationIds\": [],\n \"RequestId\": \"yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF\"\n }\n}",
688
+ "title": "创建成员企业激活记录"
689
+ }
690
+ ],
683
691
  "CreateIntegrationUserRoles": [
684
692
  {
685
693
  "document": "示例-主代子绑定角色",
@@ -760,6 +768,14 @@
760
768
  "title": "基于RecipientIds 生成他方签署链接"
761
769
  }
762
770
  ],
771
+ "CreateOrganizationGroupInvitationLink": [
772
+ {
773
+ "document": "生成建工集团集团加入邀请链接",
774
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOrganizationGroupInvitationLink\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDR4yUUgyg1qh6szUxt1qOK1Jy90khKS\",\n \"ClientIp\": \"8.8.8.8\"\n },\n \"ExpireTime\": 1702366386\n}",
775
+ "output": "{\n \"Response\": {\n \"ExpireTime\": 1716683735,\n \"JumpUrl\": \"https://test.essurl.cn/BGgGUBGtln\",\n \"Link\": \"https://dyn.test.ess.tencent.cn/imgs/organization/732aaefa78c439d726f541b89c49e022/qrcode/joingroup/yDCZFUUckpyyo8pgUxP8QQ8yRgWF3en4.png\",\n \"MiniAppPath\": \"/pages/guide/index?shortKey=yDCZFUyOc8a3FdjP9477\",\n \"RequestId\": \"acba9fe30ab0\"\n }\n}",
776
+ "title": "生成建工集团集团加入邀请链接"
777
+ }
778
+ ],
763
779
  "CreateOrganizationInfoChangeUrl": [
764
780
  {
765
781
  "document": "设置changeType为1,生成超管变更链接。",
@@ -3080,6 +3080,16 @@
3080
3080
  "type": "string",
3081
3081
  "value_allowed_null": false
3082
3082
  },
3083
+ {
3084
+ "disabled": false,
3085
+ "document": "发起的合同临时Id, 只有当点击进入链接,成功发起合同后, 此Id才有效",
3086
+ "example": "无",
3087
+ "member": "string",
3088
+ "name": "FlowId",
3089
+ "output_required": false,
3090
+ "type": "string",
3091
+ "value_allowed_null": false
3092
+ },
3083
3093
  {
3084
3094
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3085
3095
  "member": "string",
@@ -337,20 +337,20 @@
337
337
  "ChannelCreatePrepareFlow": [
338
338
  {
339
339
  "document": "",
340
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69xxxxxx245e4\",\n \"AppId\": \"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\": \"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\": 2,\n \"FlowInfo\": {\n \"FlowName\": \"第三方预发起合同-跳过文件上传\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FlowDescription\": \"\",\n \"Deadline\": 0,\n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": []\n },\n \"FlowOption\": {\n \"CanEditFlow\": true,\n \"HideShowFlowName\": false,\n \"HideShowFlowType\": false,\n \"HideShowDeadline\": false,\n \"ForbidEditFillComponent\": false,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"FlowApproverList\": [\n {\n \"ApproverType\": 0,\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"IsFullText\": true,\n \"PreReadTime\": 0\n },\n {\n \"ApproverType\": 1,\n \"ApproverIdCardType\": \"\",\n \"ApproverName\": \"里斯\",\n \"NotChannelOrganization\": false,\n \"ApproverMobile\": \"13312312312\",\n \"IsFullText\": true,\n \"PreReadTime\": 0\n }\n ]\n}",
341
- "output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
340
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69xxxxxx245e4\",\n \"AppId\": \"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\": \"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\": 2,\n \"FlowInfo\": {\n \"FlowName\": \"第三方预发起合同-跳过文件上传\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FlowDescription\": \"\",\n \"Deadline\": 0,\n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": []\n },\n \"FlowOption\": {\n \"CanEditFlow\": true,\n \"HideShowFlowName\": false,\n \"HideShowFlowType\": false,\n \"HideShowDeadline\": false,\n \"ForbidEditFillComponent\": false,\n \"SkipUploadFile\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"FlowApproverList\": [\n {\n \"ApproverType\": 0,\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"IsFullText\": true,\n \"PreReadTime\": 0\n },\n {\n \"ApproverType\": 1,\n \"ApproverIdCardType\": \"\",\n \"ApproverName\": \"里斯\",\n \"NotChannelOrganization\": false,\n \"ApproverMobile\": \"13312312312\",\n \"IsFullText\": true,\n \"PreReadTime\": 0\n }\n ]\n}",
341
+ "output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"FlowId\": \"yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
342
342
  "title": "文件发起-跳过文件上传"
343
343
  },
344
344
  {
345
345
  "document": "1.这是一个B2C的合同模板, 创建发起合同签署链接,只指定一个子企业的参与方\n2.FlowApproverList参数指定的参与方不能更改, 未指定的参与方可以修改\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/f51c3d969db0093300094a22c6c01555.png\" />\n",
346
346
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"zhansan\"\n }\n },\n \"ResourceId\": \"yDSL6UUckpo6ynynUx47m3cSKQavf88Q\",\n \"ResourceType\": 1,\n \"FlowInfo\": {\n \"FlowName\": \"2024典子谦入职合同\",\n \"FlowType\": \"入职合同\",\n \"FlowDescription\": \"2024典子谦入职合同\",\n \"Deadline\": 1706335491\n },\n \"FlowApproverList\": [\n {\n \"NotChannelOrganization\": false,\n \"ApproverType\": 0,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n9527\",\n \"RecipientId\": \"yDSL6UUckpo6am9jUuRHYOWRfZbRAhm6\"\n }\n ]\n}",
347
- "output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?code=yDCNBUUckpvlzt0sUypjGZRCTkEHyRh6\",\n \"PreviewFlowUrl\": \"\",\n \"RequestId\": \"296e3cfb-504e-494d-a86c-75101a87c09e\"\n }\n}",
347
+ "output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?code=yDCNBUUckpvlzt0sUypjGZRCTkEHyRh6\",\n \"PreviewFlowUrl\": \"\",\n \"FlowId\": \"yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT\",\n \"RequestId\": \"296e3cfb-504e-494d-a86c-75101a87c09e\"\n }\n}",
348
348
  "title": "创建发起合同签署链接-模板发起(固定一个参与方)"
349
349
  },
350
350
  {
351
351
  "document": "1.创建发起合同签署链接, 提前定义两个签署人, 分别是 B端渠道子客企业的员工和C端为张三这个自然人\n2.FlowApproverList参数指定的参与方不能更改\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/935a3cebf2881b25c1d87e234a303a13.png\" />\n",
352
352
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"ResourceId\": \"yDSL6UUckpo6ynynUx47m3cSKQavf88Q\",\n \"ResourceType\": 1,\n \"FlowInfo\": {\n \"FlowName\": \"典子谦入职合同(17:53:30)\",\n \"FlowType\": \"入职合同\",\n \"FlowDescription\": \"2024典子谦入职合同\",\n \"Deadline\": 1701679610\n },\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"110101200610116558\"\n }\n },\n \"FlowApproverList\": [\n {\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"RecipientId\": \"yDSL6UUckpo6am9jUuRHYOWRfZbRAhm6\"\n },\n {\n \"ApproverType\": 1,\n \"NotChannelOrganization\": false,\n \"ApproverName\": \"张三\",\n \"ApproverMobile\": \"1850000000\",\n \"RecipientId\": \"yDSL6UUckpo6am9qUuRHYOWwmX5rZGCX\"\n }\n ]\n}",
353
- "output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
353
+ "output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"FlowId\": \"yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
354
354
  "title": "创建发起合同签署链接-模板发起(固定所有的参与方)"
355
355
  }
356
356
  ],
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "actions": {
3
3
  "ChatCompletions": {
4
- "document": "腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。\n\n 1. 本接口暂不支持返回图片内容。\n 2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。\n 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。",
4
+ "document": "腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。\n\n 1. 本接口暂不支持返回图片内容。\n 2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。\n 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。\n 4. 我们推荐您使用 API Explorer,方便快速地在线调试接口和下载各语言的示例代码,[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。",
5
5
  "input": "ChatCompletionsRequest",
6
6
  "name": "hunyuan",
7
7
  "output": "ChatCompletionsResponse",
@@ -132,7 +132,7 @@
132
132
  {
133
133
  "disabled": false,
134
134
  "document": "Unix 时间戳,单位为秒。",
135
- "example": "",
135
+ "example": "1705634032",
136
136
  "member": "int64",
137
137
  "name": "Created",
138
138
  "output_required": false,
@@ -152,7 +152,7 @@
152
152
  {
153
153
  "disabled": false,
154
154
  "document": "免责声明。",
155
- "example": "",
155
+ "example": "以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记",
156
156
  "member": "string",
157
157
  "name": "Note",
158
158
  "output_required": false,
@@ -162,7 +162,7 @@
162
162
  {
163
163
  "disabled": false,
164
164
  "document": "本轮对话的 ID。",
165
- "example": "",
165
+ "example": "9c772634-8824-43e8-bc24-8bc4c19b9151",
166
166
  "member": "string",
167
167
  "name": "Id",
168
168
  "output_required": false,
@@ -703,8 +703,8 @@
703
703
  "members": [
704
704
  {
705
705
  "disabled": false,
706
- "document": "角色",
707
- "example": "[\"system\", \"user\", \"assistant\"]",
706
+ "document": "角色,可选值包括 system、user、assistant。",
707
+ "example": "user",
708
708
  "member": "string",
709
709
  "name": "Role",
710
710
  "output_required": false,
@@ -2,31 +2,31 @@
2
2
  "actions": {
3
3
  "ChatCompletions": [
4
4
  {
5
- "document": "system提示词",
5
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例说明 system prompt 的使用方法。",
6
6
  "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"TopP\": 1,\n \"Temperature\": 1,\n \"Model\": \"hunyuan-pro\",\n \"Messages\": [\n {\n \"Role\": \"system\",\n \"Content\": \"将英文单词转换为包括中文翻译、英文释义和一个例句的完整解释。请检查所有信息是否准确,并在回答时保持简洁,不需要任何其他反馈。\"\n },\n {\n \"Role\": \"user\",\n \"Content\": \"nice\"\n }\n ]\n}",
7
7
  "output": "{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"很好\"}}],\"Created\":1705634813,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":1,\"TotalTokens\":37}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\":\"}}],\"Created\":1705634813,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":2,\"TotalTokens\":38}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"nice\"}}],\"Created\":1705634813,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":3,\"TotalTokens\":39}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\\n\"}}],\"Created\":1705634813,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":4,\"TotalTokens\":40}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"英文\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":5,\"TotalTokens\":41}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"释义\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":6,\"TotalTokens\":42}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\":\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":7,\"TotalTokens\":43}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"ple\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":8,\"TotalTokens\":44}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"asing\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":9,\"TotalTokens\":45}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\" or\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":10,\"TotalTokens\":46}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\" acceptable\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":11,\"TotalTokens\":47}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\\n\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":12,\"TotalTokens\":48}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"例\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":13,\"TotalTokens\":49}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"句\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":14,\"TotalTokens\":50}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\":\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":15,\"TotalTokens\":51}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"She\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":16,\"TotalTokens\":52}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\" had\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":17,\"TotalTokens\":53}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\" a\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":18,\"TotalTokens\":54}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\" nice\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":19,\"TotalTokens\":55}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\" smile\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":20,\"TotalTokens\":56}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\".\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":21,\"TotalTokens\":57}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"stop\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\"}}],\"Created\":1705634814,\"Id\":\"681ef57e-9f1e-4faa-a2d3-07b655a1fa1f\",\"Usage\":{\"PromptTokens\":36,\"CompletionTokens\":21,\"TotalTokens\":57}}",
8
- "title": "system参数示例"
8
+ "title": "system prompt 示例"
9
9
  },
10
10
  {
11
- "document": "多轮对话场景",
11
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例说明如何给模型传入多轮消息。",
12
12
  "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"TopP\": 1,\n \"Temperature\": 1,\n \"Model\": \"hunyuan-pro\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"请介绍下自己\"\n },\n {\n \"Role\": \"assistant\",\n \"Content\": \"我的名字是腾讯混元大模型,是腾讯开发的一款大型语言模型。我能够理解人类语言,擅长提供问答服务、常识推理、文本创作、数学计算和互动问答等服务。如果您需要帮助或有任何问题,请随时向我提问。\"\n },\n {\n \"Role\": \"user\",\n \"Content\": \"请给我讲个字数小于10个字的搞笑笑话\"\n },\n {\n \"Role\": \"assistant\",\n \"Content\": \"猫头鹰遇见眯眯眼,看得眼睛都眯成线。”\"\n },\n {\n \"Role\": \"user\",\n \"Content\": \"不好笑,换一个吧\"\n }\n ]\n}",
13
13
  "output": "{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"青蛙\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":1,\"TotalTokens\":86}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"跳\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":2,\"TotalTokens\":87}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"高\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":3,\"TotalTokens\":88}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\",\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":4,\"TotalTokens\":89}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"比\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":5,\"TotalTokens\":90}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"下马\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":6,\"TotalTokens\":91}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"。\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":7,\"TotalTokens\":92}}\n{\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"stop\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":7,\"TotalTokens\":92}}",
14
14
  "title": "多轮对话示例"
15
15
  },
16
16
  {
17
- "document": "",
17
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例给出接口调用失败时的响应例子。",
18
18
  "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"TopP\": 0,\n \"Temperature\": 4.8,\n \"Model\": \"hunyuan-pro\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"介绍下自己\"\n }\n ]\n}",
19
19
  "output": "{\n \"Response\": {\n \"RequestId\": \"188cc996-ab09-49a7-aa9f-1df88f11c6b4\",\n \"Error\": {\n \"Code\": \"InvalidParameter\",\n \"Message\": \"Temperature must be 2 or less\"\n }\n }\n}",
20
20
  "title": "请求失败示例"
21
21
  },
22
22
  {
23
- "document": "",
23
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例给出接口正常调用时的响应例子。",
24
24
  "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"TopP\": 1,\n \"Temperature\": 1,\n \"Model\": \"hunyuan-pro\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"计算1+1\"\n }\n ]\n}",
25
25
  "output": "HTTP/1.1 200 OK\nCache-Control: no-cache\nConnection: keep-alive\nContent-Type: text/event-stream\nDate: Tue, 21 Nov 2023 06:56:00 GMT\nTransfer-Encoding: chunked\nX-TC-RequestId: 61a8459b-27c8-4868-af8f-f374db0245f8\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"1\"}}],\"Created\":1700549760,\"Id\":\"148b89ef-14e1-489f-8e70-b767e5b27d56\",\"Usage\":{\"PromptTokens\":4,\"CompletionTokens\":2,\"TotalTokens\":6}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"+\"}}],\"Created\":1700549760,\"Id\":\"148b89ef-14e1-489f-8e70-b767e5b27d56\",\"Usage\":{\"PromptTokens\":4,\"CompletionTokens\":3,\"TotalTokens\":7}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"1\"}}],\"Created\":1700549760,\"Id\":\"148b89ef-14e1-489f-8e70-b767e5b27d56\",\"Usage\":{\"PromptTokens\":4,\"CompletionTokens\":4,\"TotalTokens\":8}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"=\"}}],\"Created\":1700549760,\"Id\":\"148b89ef-14e1-489f-8e70-b767e5b27d56\",\"Usage\":{\"PromptTokens\":4,\"CompletionTokens\":5,\"TotalTokens\":9}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"2\"}}],\"Created\":1700549760,\"Id\":\"148b89ef-14e1-489f-8e70-b767e5b27d56\",\"Usage\":{\"PromptTokens\":4,\"CompletionTokens\":5,\"TotalTokens\":9}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"stop\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\"}}],\"Created\":1700549760,\"Id\":\"148b89ef-14e1-489f-8e70-b767e5b27d56\",\"Usage\":{\"PromptTokens\":4,\"CompletionTokens\":5,\"TotalTokens\":9}}",
26
26
  "title": "流式请求成功示例"
27
27
  },
28
28
  {
29
- "document": "",
29
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例说明如何用非流式方式调用接口。",
30
30
  "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"TopP\": 0,\n \"Stream\": false,\n \"Temperature\": 0,\n \"Model\": \"hunyuan-pro\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"你好呀!\"\n }\n ]\n}",
31
31
  "output": "{\n \"Note\": \"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\n \"Choices\": [\n {\n \"FinishReason\": \"stop\",\n \"Message\": {\n \"Role\": \"assistant\",\n \"Content\": \"你好!很高兴为您提供帮助。请问有什么问题我可以帮助您解决?\"\n }\n }\n ],\n \"Created\": 1710902312,\n \"Id\": \"e4657570-94a5-45f1-896c-a00ac3471d51\",\n \"Usage\": {\n \"PromptTokens\": 3,\n \"CompletionTokens\": 14,\n \"TotalTokens\": 17\n }\n}",
32
32
  "title": "非流式请求成功示例"
@@ -11382,6 +11382,33 @@
11382
11382
  "name": "Limit",
11383
11383
  "required": false,
11384
11384
  "type": "int"
11385
+ },
11386
+ {
11387
+ "disabled": false,
11388
+ "document": "用于通过集群id过滤被绑定集群",
11389
+ "example": "[\"cls-12345\"]",
11390
+ "member": "string",
11391
+ "name": "ClusterIds",
11392
+ "required": false,
11393
+ "type": "list"
11394
+ },
11395
+ {
11396
+ "disabled": false,
11397
+ "document": "用于通过集群类型过滤被绑定集群",
11398
+ "example": "[\"eks\"]",
11399
+ "member": "string",
11400
+ "name": "ClusterTypes",
11401
+ "required": false,
11402
+ "type": "list"
11403
+ },
11404
+ {
11405
+ "disabled": false,
11406
+ "document": "用于通过名称搜索被绑定集群",
11407
+ "example": "测试集群",
11408
+ "member": "string",
11409
+ "name": "ClusterName",
11410
+ "required": false,
11411
+ "type": "string"
11385
11412
  }
11386
11413
  ],
11387
11414
  "type": "object"
@@ -15936,7 +15936,7 @@
15936
15936
  "members": [
15937
15937
  {
15938
15938
  "disabled": false,
15939
- "document": "结果的类型,取值范围:\n<li>FaceRecognition:人脸识别,</li>\n<li>AsrWordsRecognition:语音关键词识别,</li>\n<li>OcrWordsRecognition:文本关键词识别,</li>\n<li>AsrFullTextRecognition:语音全文识别,</li>\n<li>OcrFullTextRecognition:文本全文识别。</li>\n<li>TransTextRecognition:语音翻译。</li>\n<li>TagRecognition:精彩打点。</li>",
15939
+ "document": "结果的类型,取值范围:\n<li>FaceRecognition:人脸识别,</li>\n<li>AsrWordsRecognition:语音关键词识别,</li>\n<li>OcrWordsRecognition:文本关键词识别,</li>\n<li>AsrFullTextRecognition:语音全文识别,</li>\n<li>OcrFullTextRecognition:文本全文识别。</li>\n<li>TransTextRecognition:语音翻译。</li>\n<li>ObjectRecognition:目标检测。</li>\n<li>TagRecognition:精彩打点。</li>",
15940
15940
  "example": "FaceRecognition",
15941
15941
  "member": "string",
15942
15942
  "name": "Type",
@@ -16004,6 +16004,16 @@
16004
16004
  "type": "list",
16005
16005
  "value_allowed_null": false
16006
16006
  },
16007
+ {
16008
+ "disabled": false,
16009
+ "document": "目标检测结果,当Type为 ObjectRecognition 时有效。",
16010
+ "example": "NULL",
16011
+ "member": "LiveStreamObjectRecognitionResult",
16012
+ "name": "ObjectRecognitionResultSet",
16013
+ "output_required": true,
16014
+ "type": "list",
16015
+ "value_allowed_null": false
16016
+ },
16007
16017
  {
16008
16018
  "disabled": false,
16009
16019
  "document": "打点结果,当Type 为 TagRecognition 时有效。\n注意:此字段可能返回 null,表示取不到有效值。",
@@ -16591,6 +16601,62 @@
16591
16601
  ],
16592
16602
  "usage": "out"
16593
16603
  },
16604
+ "LiveStreamObjectRecognitionResult": {
16605
+ "document": "直播 AI 物体识别结果",
16606
+ "members": [
16607
+ {
16608
+ "disabled": false,
16609
+ "document": "识别的物体名称。",
16610
+ "example": "",
16611
+ "member": "string",
16612
+ "name": "Name",
16613
+ "required": true,
16614
+ "type": "string",
16615
+ "value_allowed_null": false
16616
+ },
16617
+ {
16618
+ "disabled": false,
16619
+ "document": "识别片段起始的 PTS 时间,单位:秒。",
16620
+ "example": "",
16621
+ "member": "float",
16622
+ "name": "StartPtsOffset",
16623
+ "required": true,
16624
+ "type": "float",
16625
+ "value_allowed_null": false
16626
+ },
16627
+ {
16628
+ "disabled": false,
16629
+ "document": "识别片段终止的 PTS 时间,单位:秒。",
16630
+ "example": "",
16631
+ "member": "float",
16632
+ "name": "EndPtsOffset",
16633
+ "required": true,
16634
+ "type": "float",
16635
+ "value_allowed_null": false
16636
+ },
16637
+ {
16638
+ "disabled": false,
16639
+ "document": "识别片段置信度。取值:0~100。",
16640
+ "example": "",
16641
+ "member": "float",
16642
+ "name": "Confidence",
16643
+ "required": true,
16644
+ "type": "float",
16645
+ "value_allowed_null": false
16646
+ },
16647
+ {
16648
+ "disabled": false,
16649
+ "document": "识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。",
16650
+ "example": "",
16651
+ "member": "int64",
16652
+ "name": "AreaCoordSet",
16653
+ "required": true,
16654
+ "type": "list",
16655
+ "value_allowed_null": false
16656
+ }
16657
+ ],
16658
+ "usage": "out"
16659
+ },
16594
16660
  "LiveStreamOcrFullTextRecognitionResult": {
16595
16661
  "document": "直播识别 Ocr 全文识别",
16596
16662
  "members": [