tccli 3.0.1112.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.
- tccli/__init__.py +1 -1
- tccli/services/cat/v20180409/api.json +2 -2
- tccli/services/cat/v20180409/examples.json +2 -2
- tccli/services/ckafka/v20190819/api.json +13 -3
- tccli/services/dasb/v20191018/api.json +2 -2
- tccli/services/dbbrain/dbbrain_client.py +57 -4
- tccli/services/dbbrain/v20210527/api.json +173 -5
- tccli/services/dbbrain/v20210527/examples.json +15 -1
- tccli/services/dlc/dlc_client.py +129 -23
- tccli/services/dlc/v20210125/api.json +123 -0
- tccli/services/dlc/v20210125/examples.json +16 -0
- tccli/services/ess/ess_client.py +110 -4
- tccli/services/ess/v20201111/api.json +149 -4
- tccli/services/ess/v20201111/examples.json +18 -2
- tccli/services/essbasic/v20210526/api.json +12 -2
- tccli/services/essbasic/v20210526/examples.json +4 -4
- tccli/services/hunyuan/v20230901/api.json +7 -7
- tccli/services/hunyuan/v20230901/examples.json +6 -6
- tccli/services/iotexplorer/iotexplorer_client.py +53 -0
- tccli/services/iotexplorer/v20190423/api.json +61 -0
- tccli/services/iotexplorer/v20190423/examples.json +8 -0
- tccli/services/monitor/v20180724/api.json +27 -0
- tccli/services/mps/v20190612/api.json +67 -1
- tccli/services/svp/svp_client.py +159 -0
- tccli/services/svp/v20240125/api.json +723 -0
- tccli/services/svp/v20240125/examples.json +24 -0
- tccli/services/tdmq/v20200217/api.json +2 -2
- tccli/services/tione/tione_client.py +214 -2228
- tccli/services/tione/v20211111/api.json +5189 -10622
- tccli/services/tione/v20211111/examples.json +0 -304
- {tccli-3.0.1112.1.dist-info → tccli-3.0.1114.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1112.1.dist-info → tccli-3.0.1114.1.dist-info}/RECORD +35 -35
- {tccli-3.0.1112.1.dist-info → tccli-3.0.1114.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1112.1.dist-info → tccli-3.0.1114.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1112.1.dist-info → tccli-3.0.1114.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"status": "online"
|
|
51
51
|
},
|
|
52
52
|
"CreateBatchSignUrl": {
|
|
53
|
-
"document": "
|
|
53
|
+
"document": "通过此接口，可以创建小程序批量签署链接，个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项：\n- 使用此接口生成链接，需要贵企业先开通 <font color=\"red\">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。\n- 生成批量签署链接时，<font color=\"red\">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人人点击链接后需要输入短信验证码才能查看合同内容。\n- 企业员工批量签署链接：需要传入签署方所在企业名称，用户名字和手机号（或者身份证件信息）参数来生成签署链接。<font color=\"red\">该签署方企业必须已完成腾讯电子签企业认证</font>\n- 个人批量签署链接：需要传入签署方用户名字和手机号（或者身份证件信息）参数来生成签署链接。<font color=\"red\">签名区仅支持手写签名</font>",
|
|
54
54
|
"input": "CreateBatchSignUrlRequest",
|
|
55
55
|
"name": "获取跳转至腾讯电子签小程序的批量签署链接",
|
|
56
56
|
"output": "CreateBatchSignUrlResponse",
|
|
@@ -175,6 +175,13 @@
|
|
|
175
175
|
"output": "CreateIntegrationRoleResponse",
|
|
176
176
|
"status": "online"
|
|
177
177
|
},
|
|
178
|
+
"CreateIntegrationSubOrganizationActiveRecord": {
|
|
179
|
+
"document": "通过此接口，创建子企业激活记录，集团企业管理员可针对未激活的成员企业进行激活。\n激活子企业时请保证子企业 lisence 充足。\n这个操作与页面端激活成员企业操作类似\n\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": [
|
|
@@ -12020,7 +12156,7 @@
|
|
|
12020
12156
|
},
|
|
12021
12157
|
{
|
|
12022
12158
|
"disabled": false,
|
|
12023
|
-
"document": "组织机构超管姓名。\n在注册流程中，必须是超管本人进行操作。\n
|
|
12159
|
+
"document": "组织机构超管姓名。\n在注册流程中，必须是超管本人进行操作。\n如果法人做为超管管理组织机构,超管姓名就是法人姓名\n如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数。",
|
|
12024
12160
|
"example": "无",
|
|
12025
12161
|
"member": "string",
|
|
12026
12162
|
"name": "AdminName",
|
|
@@ -12029,7 +12165,7 @@
|
|
|
12029
12165
|
},
|
|
12030
12166
|
{
|
|
12031
12167
|
"disabled": false,
|
|
12032
|
-
"document": "
|
|
12168
|
+
"document": "组织机构超管手机号。\n在注册流程中，这个手机号必须跟操作人在电子签注册的个人手机号一致。\n如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数",
|
|
12033
12169
|
"example": "无",
|
|
12034
12170
|
"member": "string",
|
|
12035
12171
|
"name": "AdminMobile",
|
|
@@ -12047,7 +12183,7 @@
|
|
|
12047
12183
|
},
|
|
12048
12184
|
{
|
|
12049
12185
|
"disabled": false,
|
|
12050
|
-
"document": "
|
|
12186
|
+
"document": "认证人身份证号，如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数\n",
|
|
12051
12187
|
"example": "无",
|
|
12052
12188
|
"member": "string",
|
|
12053
12189
|
"name": "AdminIdCardNumber",
|
|
@@ -12071,6 +12207,15 @@
|
|
|
12071
12207
|
"name": "BusinessLicense",
|
|
12072
12208
|
"required": false,
|
|
12073
12209
|
"type": "string"
|
|
12210
|
+
},
|
|
12211
|
+
{
|
|
12212
|
+
"disabled": false,
|
|
12213
|
+
"document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。\np.s. 如果上传授权书 ，需遵循以下条件\n1. 超管的信息（超管姓名，超管身份证，超管手机号）必须为必填参数。\n2. 超管的个人身份必须在电子签已经实名。\n2. 认证方式AuthorizationTypes必须只能是上传授权书方式 \n",
|
|
12214
|
+
"example": "超管授权书",
|
|
12215
|
+
"member": "string",
|
|
12216
|
+
"name": "PowerOfAttorneys",
|
|
12217
|
+
"required": false,
|
|
12218
|
+
"type": "list"
|
|
12074
12219
|
}
|
|
12075
12220
|
],
|
|
12076
12221
|
"usage": "in"
|
|
@@ -361,13 +361,13 @@
|
|
|
361
361
|
},
|
|
362
362
|
{
|
|
363
363
|
"document": "1.通过PDF文件发起合同\n2.指定B端签署方为企业【典子谦示例企业】，经办人为【典子谦】\n3.通过绝对对位方式指定【典子谦示例企业】的签署控件为印章控件，控件位置为该文件的第1页，横坐标160，纵坐标260的位置，控件高宽为119x119（公章大小）\n4.指定C端签署方为个人【李四】，联系电话为【15100000000】\n5.通过绝对对位方式指定【李四】的签署控件为手写签名控件，控件位置为该文件的第1页，横坐标60，纵坐标260的位置，控件高宽为119x43（推荐的手写签名大小）\n6.通过绝对定位方式在合同文件的第1页，横坐标360，纵坐标360的位置放置一个单行文本控件，并写入内容【我是一个单行文本】\n7.完成合同发起",
|
|
364
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"19561039c99fe825a934a132520fde6a\"\n },\n \"FlowName\": \"通过文件发起合同\",\n \"FlowDescription\": \"通过文件发起合同\",\n \"Unordered\": false,\n \"FlowType\": \"示例合同\",\n \"Deadline\": 1830268800,\n \"
|
|
364
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"19561039c99fe825a934a132520fde6a\"\n },\n \"FlowName\": \"通过文件发起合同\",\n \"FlowDescription\": \"通过文件发起合同\",\n \"Unordered\": false,\n \"FlowType\": \"示例合同\",\n \"Deadline\": 1830268800,\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"VerifyChannel\": [],\n \"ApproverIdCardType\": \"\",\n \"ApproverIdCardNumber\": \"\",\n \"SignComponents\": [\n {\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 260,\n \"ComponentHeight\": 119,\n \"ComponentWidth\": 119,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": 1,\n \"NotifyType\": \"NONE\",\n \"ApproverName\": \"李四\",\n \"ApproverMobile\": \"15100000000\",\n \"PreReadTime\": 10,\n \"SignComponents\": [\n {\n \"ComponentPage\": 1,\n \"ComponentPosX\": 60,\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\"\n }\n ]\n }\n ],\n \"FileIds\": [\n \"yDwqYUUckp39gkfxUu14JJPxaTyM1ltq\"\n ],\n \"Components\": [\n {\n \"ComponentPage\": 1,\n \"ComponentPosX\": 360,\n \"ComponentPosY\": 360,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"我是一个单行文本\",\n \"FileIndex\": 0\n }\n ]\n}",
|
|
365
365
|
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"SignId\": \"\",\n \"RecipientId\": \"yDw7hUUckpkmo432UunP4DaCo2sOe2oP\",\n \"ApproverRoleName\": \"\"\n }\n ],\n \"FlowId\": \"yDR4yUUgyg1qh6szUxt1qOK1Jy90khKS\",\n \"PreviewUrl\": \"\",\n \"RequestId\": \"s1665674603446404796\"\n }\n}",
|
|
366
366
|
"title": "通过文件发起B2C合同-控件使用绝对定位方式"
|
|
367
367
|
},
|
|
368
368
|
{
|
|
369
369
|
"document": "1.通过PDF文件发起合同\n2.指定B端签署方为企业【典子谦示例企业】，经办人为【典子谦】\n3.通过绝对对位方式指定【典子谦示例企业】的签署控件为印章控件，控件类型为【KEYWORD】关键字类型，并设置关键字为【签名】，关键字查找顺序为【Positive-正序】关键字位置模式为【Middle-居中】，控件高宽为119x119（公章大小）\n4.指定C端签署方为个人【李四】，联系电话为【15100000000】\n5.通过绝对对位方式指定【李四】的签署控件为手写签名控件，控件位置为该文件的第1页，横坐标60，纵坐标260的位置，控件高宽为119x43（推荐的手写签名大小）\n6.通过绝对定位方式在合同文件的第1页，横坐标360，纵坐标360的位置放置一个单行文本控件，并写入内容【我是一个单行文本】\n7.完成合同发起",
|
|
370
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"19561039c99fe825a934a132520fde6a\"\n },\n \"FlowName\": \"通过文件发起合同-关键字定位\",\n \"FlowDescription\": \"通过文件发起合同\",\n \"Unordered\": false,\n \"FlowType\": \"示例合同\",\n \"Deadline\": 1830268800,\n \"
|
|
370
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"19561039c99fe825a934a132520fde6a\"\n },\n \"FlowName\": \"通过文件发起合同-关键字定位\",\n \"FlowDescription\": \"通过文件发起合同\",\n \"Unordered\": false,\n \"FlowType\": \"示例合同\",\n \"Deadline\": 1830268800,\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"VerifyChannel\": [],\n \"ApproverIdCardType\": \"\",\n \"ApproverIdCardNumber\": \"\",\n \"SignComponents\": [\n {\n \"ComponentPage\": 1,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 119,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"GenerateMode\": \"KEYWORD\",\n \"ComponentId\": \"签名\",\n \"KeywordOrder\": \"Positive\",\n \"RelativeLocation\": \"Middle\"\n }\n ]\n },\n {\n \"ApproverType\": 1,\n \"NotifyType\": \"NONE\",\n \"ApproverName\": \"李四\",\n \"ApproverMobile\": \"15100000000\",\n \"PreReadTime\": 10,\n \"SignComponents\": [\n {\n \"ComponentPage\": 1,\n \"ComponentPosX\": 60,\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\"\n }\n ]\n }\n ],\n \"FileIds\": [\n \"yDwqYUUckp39gkfxUu14JJPxaTyM1ltq\"\n ],\n \"Components\": [\n {\n \"ComponentPage\": 1,\n \"ComponentPosX\": 360,\n \"ComponentPosY\": 360,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"我是一个单行文本\",\n \"FileIndex\": 0\n }\n ]\n}",
|
|
371
371
|
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"SignId\": \"\",\n \"RecipientId\": \"yDw7hUUckpkmo432UunP4DaCo2sOe2oP\",\n \"ApproverRoleName\": \"\"\n }\n ],\n \"FlowId\": \"yDR4yUUgyg1qh6szUxt1qOK1Jy90khKS\",\n \"PreviewUrl\": \"\",\n \"RequestId\": \"s1665674603446404796\"\n }\n}",
|
|
372
372
|
"title": "通过文件发起B2C合同-控件使用关键字定位方式"
|
|
373
373
|
},
|
|
@@ -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",
|
|
@@ -6134,7 +6144,7 @@
|
|
|
6134
6144
|
"members": [
|
|
6135
6145
|
{
|
|
6136
6146
|
"disabled": false,
|
|
6137
|
-
"document": "跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表\n<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>
|
|
6147
|
+
"document": "跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表\n<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td> </tr> </tbody> </table>\n\n注： \n1. <font color=\"red\">链接仅单次有效</font>，每次登录需要需要重新创建新的链接\n2. 创建的链接应避免被转义，如：&被转义为\\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）\n",
|
|
6138
6148
|
"example": "无",
|
|
6139
6149
|
"member": "string",
|
|
6140
6150
|
"name": "ConsoleUrl",
|
|
@@ -10638,7 +10648,7 @@
|
|
|
10638
10648
|
},
|
|
10639
10649
|
{
|
|
10640
10650
|
"disabled": false,
|
|
10641
|
-
"document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M",
|
|
10651
|
+
"document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。\np.s. 如果上传授权书 ，需遵循以下条件\n1. 超管的信息（超管姓名，超管身份证，超管手机号）必须为必填参数。\n2. 超管的个人身份必须在电子签已经实名。\n2. 认证方式AuthorizationTypes必须只能是上传授权书方式 \n",
|
|
10642
10652
|
"example": "无",
|
|
10643
10653
|
"member": "string",
|
|
10644
10654
|
"name": "PowerOfAttorneys",
|
|
@@ -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",
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
},
|
|
117
117
|
{
|
|
118
118
|
"disabled": false,
|
|
119
|
-
"document": "功能增强（如搜索）开关。\n说明：\n1.
|
|
119
|
+
"document": "功能增强（如搜索）开关。\n说明：\n1. hunyuan-lite 无功能增强（如搜索）能力，该参数对 hunyuan-lite 版本不生效。\n2. 未传值时默认打开开关。\n3. 关闭时将直接由主模型生成回复内容，可以降低响应时延（对于流式输出时的首字时延尤为明显）。但在少数场景里，回复效果可能会下降。\n4. 安全审核能力不属于功能增强范围，不受此字段影响。",
|
|
120
120
|
"example": "true",
|
|
121
121
|
"member": "bool",
|
|
122
122
|
"name": "EnableEnhancement",
|
|
@@ -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": "
|
|
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": "非流式请求成功示例"
|
|
@@ -4957,6 +4957,58 @@ def doDescribeBatchProduction(args, parsed_globals):
|
|
|
4957
4957
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
4958
4958
|
|
|
4959
4959
|
|
|
4960
|
+
def doUpdateDeviceTWeCallAuthorizeStatus(args, parsed_globals):
|
|
4961
|
+
g_param = parse_global_arg(parsed_globals)
|
|
4962
|
+
|
|
4963
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
|
4964
|
+
cred = credential.CVMRoleCredential()
|
|
4965
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
|
4966
|
+
cred = credential.STSAssumeRoleCredential(
|
|
4967
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
|
4968
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
|
4969
|
+
)
|
|
4970
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
|
4971
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
|
4972
|
+
else:
|
|
4973
|
+
cred = credential.Credential(
|
|
4974
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
|
4975
|
+
)
|
|
4976
|
+
http_profile = HttpProfile(
|
|
4977
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
|
4978
|
+
reqMethod="POST",
|
|
4979
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
|
4980
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
|
4981
|
+
)
|
|
4982
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
|
4983
|
+
if g_param[OptionsDefine.Language]:
|
|
4984
|
+
profile.language = g_param[OptionsDefine.Language]
|
|
4985
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
|
4986
|
+
client = mod.IotexplorerClient(cred, g_param[OptionsDefine.Region], profile)
|
|
4987
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
|
4988
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
|
4989
|
+
model = models.UpdateDeviceTWeCallAuthorizeStatusRequest()
|
|
4990
|
+
model.from_json_string(json.dumps(args))
|
|
4991
|
+
start_time = time.time()
|
|
4992
|
+
while True:
|
|
4993
|
+
rsp = client.UpdateDeviceTWeCallAuthorizeStatus(model)
|
|
4994
|
+
result = rsp.to_json_string()
|
|
4995
|
+
try:
|
|
4996
|
+
json_obj = json.loads(result)
|
|
4997
|
+
except TypeError as e:
|
|
4998
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
|
4999
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
|
5000
|
+
break
|
|
5001
|
+
cur_time = time.time()
|
|
5002
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
|
5003
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
|
5004
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
|
5005
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
|
5006
|
+
else:
|
|
5007
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
|
5008
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
|
5009
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
5010
|
+
|
|
5011
|
+
|
|
4960
5012
|
def doDeleteCloudStorageEvent(args, parsed_globals):
|
|
4961
5013
|
g_param = parse_global_arg(parsed_globals)
|
|
4962
5014
|
|
|
@@ -6831,6 +6883,7 @@ ACTION_MAP = {
|
|
|
6831
6883
|
"GetStudioProductList": doGetStudioProductList,
|
|
6832
6884
|
"DescribeModelDefinition": doDescribeModelDefinition,
|
|
6833
6885
|
"DescribeBatchProduction": doDescribeBatchProduction,
|
|
6886
|
+
"UpdateDeviceTWeCallAuthorizeStatus": doUpdateDeviceTWeCallAuthorizeStatus,
|
|
6834
6887
|
"DeleteCloudStorageEvent": doDeleteCloudStorageEvent,
|
|
6835
6888
|
"DeleteDevices": doDeleteDevices,
|
|
6836
6889
|
"GetGatewaySubDeviceList": doGetGatewaySubDeviceList,
|