tccli 3.0.1142.1__py2.py3-none-any.whl → 3.0.1144.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/aiart/aiart_client.py +53 -0
  3. tccli/services/aiart/v20221229/api.json +108 -0
  4. tccli/services/aiart/v20221229/examples.json +8 -0
  5. tccli/services/bpaas/v20181217/api.json +45 -1
  6. tccli/services/clb/v20180317/api.json +37 -37
  7. tccli/services/cls/v20201016/api.json +37 -0
  8. tccli/services/cwp/v20180228/api.json +76 -8
  9. tccli/services/dbbrain/v20210527/api.json +2 -2
  10. tccli/services/essbasic/v20210526/api.json +5 -7
  11. tccli/services/fmu/v20191213/api.json +6 -6
  12. tccli/services/hunyuan/v20230901/api.json +253 -3
  13. tccli/services/hunyuan/v20230901/examples.json +24 -0
  14. tccli/services/iotexplorer/v20190423/api.json +47 -1
  15. tccli/services/ocr/v20181119/api.json +1 -1
  16. tccli/services/postgres/v20170312/api.json +31 -21
  17. tccli/services/postgres/v20170312/examples.json +4 -4
  18. tccli/services/redis/v20180412/api.json +29 -29
  19. tccli/services/redis/v20180412/examples.json +1 -1
  20. tccli/services/ssl/v20191205/api.json +30 -0
  21. tccli/services/teo/v20220901/api.json +15 -7
  22. tccli/services/tiia/v20190529/api.json +2 -2
  23. tccli/services/tmt/v20180321/api.json +36 -0
  24. tccli/services/tmt/v20180321/examples.json +6 -0
  25. tccli/services/trocket/v20230308/api.json +60 -48
  26. tccli/services/vod/v20180717/api.json +20 -2
  27. tccli/services/waf/v20180125/api.json +222 -174
  28. tccli/services/waf/v20180125/examples.json +14 -14
  29. {tccli-3.0.1142.1.dist-info → tccli-3.0.1144.1.dist-info}/METADATA +2 -2
  30. {tccli-3.0.1142.1.dist-info → tccli-3.0.1144.1.dist-info}/RECORD +33 -33
  31. {tccli-3.0.1142.1.dist-info → tccli-3.0.1144.1.dist-info}/WHEEL +0 -0
  32. {tccli-3.0.1142.1.dist-info → tccli-3.0.1144.1.dist-info}/entry_points.txt +0 -0
  33. {tccli-3.0.1142.1.dist-info → tccli-3.0.1144.1.dist-info}/license_files/LICENSE +0 -0
@@ -16489,40 +16489,44 @@
16489
16489
  "members": [
16490
16490
  {
16491
16491
  "disabled": false,
16492
- "document": "安全模块类型 1: 入侵检测 2: 漏洞管理 3: 基线管理 4: 高级防御 5:客户端相关 6: 资产指纹",
16492
+ "document": "安全模块类型 1: 入侵检测 2: 漏洞管理 3: 基线管理 4: 高级防御 5:客户端相关 6: 资产指纹 7 主机列表 8 客户端上报",
16493
16493
  "example": "1",
16494
16494
  "member": "uint64",
16495
16495
  "name": "SecurityType",
16496
+ "output_required": true,
16496
16497
  "required": true,
16497
16498
  "type": "int",
16498
16499
  "value_allowed_null": false
16499
16500
  },
16500
16501
  {
16501
16502
  "disabled": false,
16502
- "document": "安全模块下的日志类型,http://tapd.woa.com/Teneyes/markdown_wikis/show/#1210131751002328905",
16503
+ "document": "安全模块下的日志类型",
16503
16504
  "example": "[1,2]",
16504
16505
  "member": "int64",
16505
16506
  "name": "LogType",
16507
+ "output_required": true,
16506
16508
  "required": true,
16507
16509
  "type": "list",
16508
16510
  "value_allowed_null": false
16509
16511
  },
16510
16512
  {
16511
16513
  "disabled": false,
16512
- "document": "kafka topic id",
16514
+ "document": "主题ID",
16513
16515
  "example": "xx",
16514
16516
  "member": "string",
16515
16517
  "name": "TopicId",
16518
+ "output_required": true,
16516
16519
  "required": true,
16517
16520
  "type": "string",
16518
16521
  "value_allowed_null": false
16519
16522
  },
16520
16523
  {
16521
16524
  "disabled": false,
16522
- "document": "kafka topic name",
16525
+ "document": "主题名",
16523
16526
  "example": "xx",
16524
16527
  "member": "string",
16525
16528
  "name": "TopicName",
16529
+ "output_required": true,
16526
16530
  "required": true,
16527
16531
  "type": "string",
16528
16532
  "value_allowed_null": false
@@ -16533,6 +16537,7 @@
16533
16537
  "example": "1",
16534
16538
  "member": "uint64",
16535
16539
  "name": "Switch",
16540
+ "output_required": true,
16536
16541
  "required": true,
16537
16542
  "type": "int",
16538
16543
  "value_allowed_null": false
@@ -16543,6 +16548,7 @@
16543
16548
  "example": "1",
16544
16549
  "member": "uint64",
16545
16550
  "name": "Status",
16551
+ "output_required": true,
16546
16552
  "required": false,
16547
16553
  "type": "int",
16548
16554
  "value_allowed_null": false
@@ -16553,19 +16559,54 @@
16553
16559
  "example": "xx",
16554
16560
  "member": "string",
16555
16561
  "name": "ErrInfo",
16562
+ "output_required": true,
16556
16563
  "required": false,
16557
16564
  "type": "string",
16558
16565
  "value_allowed_null": false
16559
16566
  },
16560
16567
  {
16561
16568
  "disabled": false,
16562
- "document": "最近一次状态上报时间戳,s",
16569
+ "document": "最近一次状态上报时间戳",
16563
16570
  "example": "1",
16564
16571
  "member": "int64",
16565
16572
  "name": "StatusTime",
16573
+ "output_required": true,
16566
16574
  "required": false,
16567
16575
  "type": "int",
16568
16576
  "value_allowed_null": false
16577
+ },
16578
+ {
16579
+ "disabled": false,
16580
+ "document": "日志集名",
16581
+ "example": "xx",
16582
+ "member": "string",
16583
+ "name": "LogName",
16584
+ "output_required": true,
16585
+ "required": false,
16586
+ "type": "string",
16587
+ "value_allowed_null": false
16588
+ },
16589
+ {
16590
+ "disabled": false,
16591
+ "document": "日志集ID",
16592
+ "example": "xx",
16593
+ "member": "string",
16594
+ "name": "LogSetId",
16595
+ "output_required": true,
16596
+ "required": false,
16597
+ "type": "string",
16598
+ "value_allowed_null": false
16599
+ },
16600
+ {
16601
+ "disabled": false,
16602
+ "document": "日志集所在地域",
16603
+ "example": "ap-guangzhou",
16604
+ "member": "string",
16605
+ "name": "Region",
16606
+ "output_required": true,
16607
+ "required": false,
16608
+ "type": "string",
16609
+ "value_allowed_null": false
16569
16610
  }
16570
16611
  ],
16571
16612
  "usage": "both"
@@ -38907,7 +38948,7 @@
38907
38948
  "members": [
38908
38949
  {
38909
38950
  "disabled": false,
38910
- "document": "<li>HostTag - string - 是否必填:否 - 主机标签</i>\n<li>ItemId - int64 - 是否必填:否 - 项Id</i>\n<li>RuleId - int64 - 是否必填:否 - 规则Id</li>\n<li>IsPassed - int - 是否必填:否 - 是否通过</li>\n<li>RiskTier - int - 是否必填:否 - 风险等级</li>",
38951
+ "document": "<li>HostTag - string - 是否必填:否 - 主机标签</li><li>ItemId - int64 - 是否必填:否 - 项Id</li><li>RuleId - int64 - 是否必填:否 - 规则Id</li><li>IsPassed - int - 是否必填:否 - 是否通过</li><li>RiskTier - int - 是否必填:否 - 风险等级</li>",
38911
38952
  "example": "无",
38912
38953
  "member": "Filter",
38913
38954
  "name": "Filters",
@@ -38922,6 +38963,15 @@
38922
38963
  "name": "ExportAll",
38923
38964
  "required": false,
38924
38965
  "type": "int"
38966
+ },
38967
+ {
38968
+ "disabled": false,
38969
+ "document": "0:导出界面展示;1:导出全部结果事件",
38970
+ "example": "0",
38971
+ "member": "int64",
38972
+ "name": "IsExportDetail",
38973
+ "required": false,
38974
+ "type": "int"
38925
38975
  }
38926
38976
  ],
38927
38977
  "type": "object"
@@ -38943,7 +38993,7 @@
38943
38993
  "members": [
38944
38994
  {
38945
38995
  "disabled": false,
38946
- "document": "<li>HostId - string - 是否必填:否 - 主机Id</i>\n<li>RuleId - int64 - 是否必填:否 - 规则Id</i>\n<li>IsPassed - int - 是否必填:否 - 是否通过</li>\n<li>RiskTier - int - 是否必填:否 - 风险等级</li>",
38996
+ "document": "<li>HostId - string - 是否必填:否 - 主机Id</li><li>RuleId - int64 - 是否必填:否 - 规则Id</li><li>IsPassed - int - 是否必填:否 - 是否通过</li><li>RiskTier - int - 是否必填:否 - 风险等级</li>",
38947
38997
  "example": "无",
38948
38998
  "member": "Filter",
38949
38999
  "name": "Filters",
@@ -38958,6 +39008,15 @@
38958
39008
  "name": "ExportAll",
38959
39009
  "required": false,
38960
39010
  "type": "int"
39011
+ },
39012
+ {
39013
+ "disabled": false,
39014
+ "document": "0:导出界面展示;1:导出全部结果事件",
39015
+ "example": "1",
39016
+ "member": "int64",
39017
+ "name": "IsExportDetail",
39018
+ "required": false,
39019
+ "type": "int"
38961
39020
  }
38962
39021
  ],
38963
39022
  "type": "object"
@@ -39069,7 +39128,7 @@
39069
39128
  "members": [
39070
39129
  {
39071
39130
  "disabled": false,
39072
- "document": "<li>RuleName - string - 是否必填:否 - 规则名称</i>\n<li>IsPassed - int - 是否必填:否 - 是否通过</li>\n<li>RiskTier - int - 是否必填:否 - 风险等级</li>",
39131
+ "document": "<li>RuleName - string - 是否必填:否 - 规则名称</li><li>IsPassed - int - 是否必填:否 - 是否通过</li><li>RiskTier - int - 是否必填:否 - 风险等级</li>",
39073
39132
  "example": "无",
39074
39133
  "member": "Filter",
39075
39134
  "name": "Filters",
@@ -39084,6 +39143,15 @@
39084
39143
  "name": "ExportAll",
39085
39144
  "required": false,
39086
39145
  "type": "int"
39146
+ },
39147
+ {
39148
+ "disabled": false,
39149
+ "document": "0:导出界面展示;1:导出全部结果事件",
39150
+ "example": "1",
39151
+ "member": "int64",
39152
+ "name": "IsExportDetail",
39153
+ "required": false,
39154
+ "type": "int"
39087
39155
  }
39088
39156
  ],
39089
39157
  "type": "object"
@@ -463,7 +463,7 @@
463
463
  },
464
464
  {
465
465
  "disabled": false,
466
- "document": "邮箱地址,支持大小写字母、数字、下划线及@字符, 不能以下划线开头,邮箱地址不可重复。",
466
+ "document": "邮箱地址,支持大小写字母、数字、下划线、连字符及@字符, 只能以数字或字母开头,邮箱地址不可重复。",
467
467
  "example": "test@qq.com",
468
468
  "member": "string",
469
469
  "name": "ContactInfo",
@@ -491,7 +491,7 @@
491
491
  "example": "1",
492
492
  "member": "int64",
493
493
  "name": "Id",
494
- "required": true,
494
+ "output_required": true,
495
495
  "type": "int",
496
496
  "value_allowed_null": false
497
497
  },
@@ -11862,22 +11862,20 @@
11862
11862
  {
11863
11863
  "disabled": false,
11864
11864
  "document": "Base64编码后的文件内容",
11865
- "example": "",
11865
+ "example": "",
11866
11866
  "member": "string",
11867
11867
  "name": "FileBody",
11868
11868
  "required": true,
11869
- "type": "string",
11870
- "value_allowed_null": false
11869
+ "type": "string"
11871
11870
  },
11872
11871
  {
11873
11872
  "disabled": false,
11874
- "document": "文件名",
11875
- "example": "",
11873
+ "document": "文件名,最大长度不超过200字符",
11874
+ "example": "",
11876
11875
  "member": "string",
11877
11876
  "name": "FileName",
11878
11877
  "required": false,
11879
- "type": "string",
11880
- "value_allowed_null": false
11878
+ "type": "string"
11881
11879
  }
11882
11880
  ],
11883
11881
  "usage": "in"
@@ -8,18 +8,18 @@
8
8
  "status": "online"
9
9
  },
10
10
  "BeautifyVideo": {
11
- "document": "视频美颜(此接口目前已下线)",
11
+ "document": "产品不再维护,准备下线。\n\n视频美颜(此接口目前已下线)",
12
12
  "input": "BeautifyVideoRequest",
13
13
  "name": "视频美颜(此接口目前已下线)",
14
14
  "output": "BeautifyVideoResponse",
15
- "status": "online"
15
+ "status": "deprecated"
16
16
  },
17
17
  "CancelBeautifyVideoJob": {
18
- "document": "撤销视频美颜任务请求",
18
+ "document": "产品不再维护,准备下线。\n\n撤销视频美颜任务请求",
19
19
  "input": "CancelBeautifyVideoJobRequest",
20
20
  "name": "撤销视频美颜任务(此接口目前已下线)",
21
21
  "output": "CancelBeautifyVideoJobResponse",
22
- "status": "online"
22
+ "status": "deprecated"
23
23
  },
24
24
  "CreateModel": {
25
25
  "document": "在使用LUT素材的modelid实现试唇色前,您需要先上传 LUT 格式的cube文件注册唇色ID。查看 [LUT文件的使用说明](https://cloud.tencent.com/document/product/1172/41701)。\n\n注:您也可以直接使用 [试唇色接口](https://cloud.tencent.com/document/product/1172/40706),通过输入RGBA模型数值的方式指定唇色,更简单易用。\n",
@@ -43,11 +43,11 @@
43
43
  "status": "online"
44
44
  },
45
45
  "QueryBeautifyVideoJob": {
46
- "document": "查询视频美颜处理进度",
46
+ "document": "产品不再维护,准备下线。\n\n查询视频美颜处理进度",
47
47
  "input": "QueryBeautifyVideoJobRequest",
48
48
  "name": "查询视频美颜任务(此接口目前已下线)",
49
49
  "output": "QueryBeautifyVideoJobResponse",
50
- "status": "online"
50
+ "status": "deprecated"
51
51
  },
52
52
  "StyleImage": {
53
53
  "document": "上传一张照片,输出滤镜处理后的图片。",
@@ -48,7 +48,7 @@
48
48
  "members": [
49
49
  {
50
50
  "disabled": false,
51
- "document": "模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro。\n各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。\n\n注意:\n不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。",
51
+ "document": "模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro、 hunyuan-code、 hunyuan-role、 hunyuan-functioncall、 hunyuan-vision。\n各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。\n\n注意:\n不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。",
52
52
  "example": "hunyuan-pro",
53
53
  "member": "string",
54
54
  "name": "Model",
@@ -57,7 +57,7 @@
57
57
  },
58
58
  {
59
59
  "disabled": false,
60
- "document": "聊天上下文信息。\n说明:\n1. 长度最多为 40,按对话时间从旧到新在数组中排列。\n2. Message.Role 可选值:system、user、assistant。\n其中,system 角色可选,如存在则必须位于列表的最开始。user 和 assistant 需交替出现(一问一答),以 user 提问开始和结束,且 Content 不能为空。Role 的顺序示例:[system(可选) user assistant user assistant user ...]。\n3. Messages 中 Content 总长度不能超过模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。",
60
+ "document": "聊天上下文信息。\n说明:\n1. 长度最多为 40,按对话时间从旧到新在数组中排列。\n2. Message.Role 可选值:system、user、assistant、 tool。\n其中,system 角色可选,如存在则必须位于列表的最开始。user(tool) 和 assistant 需交替出现(一问一答),以 user 提问开始,user(tool)提问结束,且 Content 不能为空。Role 的顺序示例:[system(可选) user assistant user assistant user ...]。\n3. Messages 中 Content 总长度不能超过模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。",
61
61
  "example": "无",
62
62
  "member": "Message",
63
63
  "name": "Messages",
@@ -108,6 +108,33 @@
108
108
  "name": "EnableEnhancement",
109
109
  "required": false,
110
110
  "type": "bool"
111
+ },
112
+ {
113
+ "disabled": false,
114
+ "document": "可调用的工具列表,仅对 hunyuan-functioncall 模型生效。",
115
+ "example": "无",
116
+ "member": "Tool",
117
+ "name": "Tools",
118
+ "required": false,
119
+ "type": "list"
120
+ },
121
+ {
122
+ "disabled": false,
123
+ "document": "工具使用选项,可选值包括 none、auto、custom。\n说明:\n1. 仅对 hunyuan-functioncall 模型生效。\n2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。\n3. 未设置时,默认值为auto",
124
+ "example": "auto",
125
+ "member": "string",
126
+ "name": "ToolChoice",
127
+ "required": false,
128
+ "type": "string"
129
+ },
130
+ {
131
+ "disabled": false,
132
+ "document": "强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填",
133
+ "example": "无",
134
+ "member": "Tool",
135
+ "name": "CustomTool",
136
+ "required": false,
137
+ "type": "object"
111
138
  }
112
139
  ],
113
140
  "type": "object"
@@ -220,6 +247,45 @@
220
247
  ],
221
248
  "usage": "out"
222
249
  },
250
+ "Content": {
251
+ "document": "可以传入多种类型的内容,如图片或文本。当前只支持传入单张图片,传入多张图片时,以第一个图片为准。",
252
+ "members": [
253
+ {
254
+ "disabled": false,
255
+ "document": "内容类型\n注意:\n当前只支持传入单张图片,传入多张图片时,以第一个图片为准。\n注意:此字段可能返回 null,表示取不到有效值。",
256
+ "example": "[\"text\", \"image_url\"]",
257
+ "member": "string",
258
+ "name": "Type",
259
+ "output_required": false,
260
+ "required": true,
261
+ "type": "string",
262
+ "value_allowed_null": true
263
+ },
264
+ {
265
+ "disabled": false,
266
+ "document": "当 Type 为 text 时使用,表示具体的文本内容\n注意:此字段可能返回 null,表示取不到有效值。",
267
+ "example": "下面图片中是哪个公司的 Logo?",
268
+ "member": "string",
269
+ "name": "Text",
270
+ "output_required": false,
271
+ "required": false,
272
+ "type": "string",
273
+ "value_allowed_null": true
274
+ },
275
+ {
276
+ "disabled": false,
277
+ "document": "当 Type 为 image_url 时使用,表示具体的图片内容\n注意:此字段可能返回 null,表示取不到有效值。",
278
+ "example": "无",
279
+ "member": "ImageUrl",
280
+ "name": "ImageUrl",
281
+ "output_required": false,
282
+ "required": false,
283
+ "type": "object",
284
+ "value_allowed_null": true
285
+ }
286
+ ],
287
+ "usage": "both"
288
+ },
223
289
  "Delta": {
224
290
  "document": "返回的内容(流式返回)",
225
291
  "members": [
@@ -242,6 +308,16 @@
242
308
  "output_required": false,
243
309
  "type": "string",
244
310
  "value_allowed_null": false
311
+ },
312
+ {
313
+ "disabled": false,
314
+ "document": "模型生成的工具调用,仅 hunyuan-functioncall 模型支持\n说明:\n对于每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并。\n\n注意:此字段可能返回 null,表示取不到有效值。",
315
+ "example": "无",
316
+ "member": "ToolCall",
317
+ "name": "ToolCalls",
318
+ "output_required": false,
319
+ "type": "list",
320
+ "value_allowed_null": true
245
321
  }
246
322
  ],
247
323
  "usage": "out"
@@ -438,12 +514,29 @@
438
514
  ],
439
515
  "type": "object"
440
516
  },
517
+ "ImageUrl": {
518
+ "document": "具体的图片内容",
519
+ "members": [
520
+ {
521
+ "disabled": false,
522
+ "document": "图片的 Url(以 http:// 或 https:// 开头)\n注意:此字段可能返回 null,表示取不到有效值。",
523
+ "example": "https://cloudcache.tencent-cloud.com/qcloud/ui/portal-set/build/About/images/bg-product-series_87d.png",
524
+ "member": "string",
525
+ "name": "Url",
526
+ "output_required": false,
527
+ "required": true,
528
+ "type": "string",
529
+ "value_allowed_null": true
530
+ }
531
+ ],
532
+ "usage": "both"
533
+ },
441
534
  "Message": {
442
535
  "document": "会话内容",
443
536
  "members": [
444
537
  {
445
538
  "disabled": false,
446
- "document": "角色,可选值包括 system、user、assistant。",
539
+ "document": "角色,可选值包括 system、user、assistant、 tool。",
447
540
  "example": "user",
448
541
  "member": "string",
449
542
  "name": "Role",
@@ -462,6 +555,39 @@
462
555
  "required": false,
463
556
  "type": "string",
464
557
  "value_allowed_null": false
558
+ },
559
+ {
560
+ "disabled": false,
561
+ "document": "多种类型内容(目前支持图片和文本),仅 hunyuan-vision 模型支持\n注意:此字段可能返回 null,表示取不到有效值。",
562
+ "example": "无",
563
+ "member": "Content",
564
+ "name": "Contents",
565
+ "output_required": false,
566
+ "required": false,
567
+ "type": "list",
568
+ "value_allowed_null": true
569
+ },
570
+ {
571
+ "disabled": false,
572
+ "document": "当role为tool时传入,标识具体的函数调用\n注意:此字段可能返回 null,表示取不到有效值。",
573
+ "example": "call_cpv320k2c3m8fgcs8ja0",
574
+ "member": "string",
575
+ "name": "ToolCallId",
576
+ "output_required": false,
577
+ "required": false,
578
+ "type": "string",
579
+ "value_allowed_null": true
580
+ },
581
+ {
582
+ "disabled": false,
583
+ "document": "模型生成的工具调用,仅 hunyuan-functioncall 模型支持\n注意:此字段可能返回 null,表示取不到有效值。",
584
+ "example": "无",
585
+ "member": "ToolCall",
586
+ "name": "ToolCalls",
587
+ "output_required": false,
588
+ "required": false,
589
+ "type": "list",
590
+ "value_allowed_null": true
465
591
  }
466
592
  ],
467
593
  "usage": "both"
@@ -636,6 +762,130 @@
636
762
  ],
637
763
  "type": "object"
638
764
  },
765
+ "Tool": {
766
+ "document": "用户指定模型使用的工具",
767
+ "members": [
768
+ {
769
+ "disabled": false,
770
+ "document": "工具类型,当前只支持function",
771
+ "example": "function",
772
+ "member": "string",
773
+ "name": "Type",
774
+ "required": true,
775
+ "type": "string"
776
+ },
777
+ {
778
+ "disabled": false,
779
+ "document": "具体要调用的function",
780
+ "example": "无",
781
+ "member": "ToolFunction",
782
+ "name": "Function",
783
+ "required": true,
784
+ "type": "object"
785
+ }
786
+ ],
787
+ "usage": "in"
788
+ },
789
+ "ToolCall": {
790
+ "document": "模型生成的工具调用",
791
+ "members": [
792
+ {
793
+ "disabled": false,
794
+ "document": "工具调用id",
795
+ "example": "call_cpv320k2c3m8fgcs8ja0",
796
+ "member": "string",
797
+ "name": "Id",
798
+ "output_required": true,
799
+ "required": true,
800
+ "type": "string",
801
+ "value_allowed_null": false
802
+ },
803
+ {
804
+ "disabled": false,
805
+ "document": "工具调用类型,当前只支持function",
806
+ "example": "function",
807
+ "member": "string",
808
+ "name": "Type",
809
+ "output_required": true,
810
+ "required": true,
811
+ "type": "string",
812
+ "value_allowed_null": false
813
+ },
814
+ {
815
+ "disabled": false,
816
+ "document": "具体的function调用",
817
+ "example": "无",
818
+ "member": "ToolCallFunction",
819
+ "name": "Function",
820
+ "output_required": true,
821
+ "required": true,
822
+ "type": "object",
823
+ "value_allowed_null": false
824
+ }
825
+ ],
826
+ "usage": "both"
827
+ },
828
+ "ToolCallFunction": {
829
+ "document": "具体的function调用",
830
+ "members": [
831
+ {
832
+ "disabled": false,
833
+ "document": "function名称",
834
+ "example": "get_current_weather",
835
+ "member": "string",
836
+ "name": "Name",
837
+ "output_required": true,
838
+ "required": true,
839
+ "type": "string",
840
+ "value_allowed_null": false
841
+ },
842
+ {
843
+ "disabled": false,
844
+ "document": "function参数,一般为json字符串",
845
+ "example": "{\\\"location\\\":[\\\"北京\\\",\\\"深圳\\\"],\\\"unit\\\":\\\"celsius\\\"}",
846
+ "member": "string",
847
+ "name": "Arguments",
848
+ "output_required": true,
849
+ "required": true,
850
+ "type": "string",
851
+ "value_allowed_null": false
852
+ }
853
+ ],
854
+ "usage": "both"
855
+ },
856
+ "ToolFunction": {
857
+ "document": "function定义",
858
+ "members": [
859
+ {
860
+ "disabled": false,
861
+ "document": "function名称,只能包含a-z,A-Z,0-9,\\_或-",
862
+ "example": "get_current_weather",
863
+ "member": "string",
864
+ "name": "Name",
865
+ "required": true,
866
+ "type": "string"
867
+ },
868
+ {
869
+ "disabled": false,
870
+ "document": "function参数,一般为json字符串",
871
+ "example": "无",
872
+ "member": "string",
873
+ "name": "Parameters",
874
+ "required": true,
875
+ "type": "string"
876
+ },
877
+ {
878
+ "disabled": false,
879
+ "document": "function的简单描述",
880
+ "example": "获取当前地点的天气",
881
+ "member": "string",
882
+ "name": "Description",
883
+ "required": false,
884
+ "type": "string"
885
+ }
886
+ ],
887
+ "usage": "in"
888
+ },
639
889
  "Usage": {
640
890
  "document": "Token 数量",
641
891
  "members": [
@@ -30,6 +30,30 @@
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": "非流式请求成功示例"
33
+ },
34
+ {
35
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例说明hunyuan-functioncall模型如何用非流式方式调用接口。",
36
+ "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-functioncall\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"北京和深圳今天天气如何\"\n }\n ],\n \"Tools\": [\n {\n \"Type\": \"function\",\n \"Function\": {\n \"Name\": \"get_current_weather\",\n \"Description\": \"获取当前地点的天气\",\n \"Parameters\": \"{\\n \\\"type\\\": \\\"object\\\",\\n \\\"properties\\\": {\\n \\\"location\\\": {\\n \\\"type\\\": \\\"string\\\",\\n \\\"description\\\": \\\"城市名称\\\"\\n },\\n \\\"unit\\\": {\\n \\\"type\\\": \\\"string\\\",\\n \\\"enum\\\": [\\n \\\"celsius\\\",\\n \\\"fahrenheit\\\"\\n ]\\n }\\n },\\n \\\"required\\\": [\\n \\\"location\\\"\\n ]\\n }\"\n }\n }\n ],\n \"ToolChoice\": \"auto\"\n}",
37
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e7f5ce41-87fd-4977-803c-54cded687cd9\",\n \"Note\": \"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\n \"Choices\": [\n {\n \"Message\": {\n \"Role\": \"assistant\",\n \"Content\": \"使用get_current_weather工具来获取北京和深圳的当前天气情况。\\n\\t\\n\\t用户想要知道北京和深圳今天的天气情况。用户的请求是关于天气的查询,需要使用天气查询工具来获取信息。\",\n \"ToolCalls\": [\n {\n \"Type\": \"function\",\n \"Function\": {\n \"Name\": \"get_current_weather\",\n \"Arguments\": \"{\\\"location\\\":[\\\"北京\\\",\\\"深圳\\\"],\\\"unit\\\":\\\"celsius\\\"}\"\n }\n }\n ]\n },\n \"FinishReason\": \"tool_calls\"\n }\n ],\n \"Created\": 1719638614,\n \"Usage\": {\n \"PromptTokens\": 6,\n \"CompletionTokens\": 46,\n \"TotalTokens\": 52\n }\n }\n}",
38
+ "title": "hunyuan-functioncall模型非流式请求成功示例"
39
+ },
40
+ {
41
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例说明hunyuan-functioncall模型如何用流式方式调用接口。",
42
+ "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"Model\": \"hunyuan-functioncall\",\n \"Stream\": true,\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"北京和深圳今天天气如何\"\n }\n ],\n \"Tools\": [\n {\n \"Type\": \"function\",\n \"Function\": {\n \"Name\": \"get_current_weather\",\n \"Description\": \"获取当前地点的天气\",\n \"Parameters\": \"{\\n \\\"type\\\": \\\"object\\\",\\n \\\"properties\\\": {\\n \\\"location\\\": {\\n \\\"type\\\": \\\"string\\\",\\n \\\"description\\\": \\\"城市名称\\\"\\n },\\n \\\"unit\\\": {\\n \\\"type\\\": \\\"string\\\",\\n \\\"enum\\\": [\\n \\\"celsius\\\",\\n \\\"fahrenheit\\\"\\n ]\\n }\\n },\\n \\\"required\\\": [\\n \\\"location\\\"\\n ]\\n }\"\n }\n }\n ],\n \"ToolChoice\": \"auto\"\n}",
43
+ "output": "说明: 对于Delta.ToolCalls每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并,本示例中的ToolCalls 最终值为:[{\"Id\": \"call_cq177uk2c3m1v7ep35dg\",\"Type\": \"function\",\"Function\": {\"Name\": \"get_current_weather\", \"Arguments\": \"{\\\"location\\\":[\\\"北京\\\",\\\"深圳\\\"],\\\"unit\\\":\\\"celsius\\\"}\"}}]\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\",\"ToolCalls\":[{\"Id\":\"call_cq154vk2c3m1v7ep3530\",\"Type\":\"function\",\"Function\":{\"Name\":\"get_current_weather\",\"Arguments\":\"\"}}]},\"FinishReason\":\"\"}],\"Created\":1719816830,\"Id\":\"cd37cf66-089f-4ab2-8118-e18baa238462\",\"Usage\":{\"PromptTokens\":6,\"CompletionTokens\":0,\"TotalTokens\":6}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\",\"ToolCalls\":[{\"Id\":\"call_cq154vk2c3m1v7ep3530\",\"Type\":\"function\",\"Function\":{\"Name\":\"\",\"Arguments\":\"{\\\"location\\\":\\\"北京\\\"}\"}}]},\"FinishReason\":\"\"}],\"Created\":1719816830,\"Id\":\"cd37cf66-089f-4ab2-8118-e18baa238462\",\"Usage\":{\"PromptTokens\":6,\"CompletionTokens\":0,\"TotalTokens\":6}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"Delta\":{\"Role\":\"assistant\",\"Content\":\"计划使用get_current_weather工具来获取北京和深圳的当前天气。\\n\\t\\n\\t用户想要知道北京和深圳今天的天气情况。用户的请求是关于天气的查询,需要使用天气查询工具来获取信息。\"},\"FinishReason\":\"\"}],\"Created\":1719816830,\"Id\":\"cd37cf66-089f-4ab2-8118-e18baa238462\",\"Usage\":{\"PromptTokens\":6,\"CompletionTokens\":46,\"TotalTokens\":52}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\"},\"FinishReason\":\"tool_calls\"}],\"Created\":1719816830,\"Id\":\"cd37cf66-089f-4ab2-8118-e18baa238462\",\"Usage\":{\"PromptTokens\":6,\"CompletionTokens\":46,\"TotalTokens\":52}}",
44
+ "title": "hunyuan-functioncall模型流式请求成功示例"
45
+ },
46
+ {
47
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例说明hunyuan-functioncall模型多轮对话如何调用接口。",
48
+ "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"Model\": \"hunyuan-functioncall\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"北京和深圳今天天气如何\"\n },\n {\n \"Role\": \"assistant\",\n \"Content\": \"使用get_current_weather工具来获取北京和深圳的当前天气。\\n\\t\\n\\t用户想要知道北京和深圳今天的天气情况。用户提供了两个城市名称,但没有指定温度单位,根据常识,默认用户需要的是摄氏度。\",\n \"ToolCalls\": [\n {\n \"Id\": \"call_cq16e7k2c3m1v7ep35c0\",\n \"Type\": \"function\",\n \"Function\": {\n \"Name\": \"get_current_weather\",\n \"Arguments\": \"{\\\"location\\\":\\\"北京\\\",\\\"unit\\\":\\\"celsius\\\"}\"\n }\n }\n ]\n },\n {\n \"Role\": \"tool\",\n \"ToolCallId\": \"call_cq16e7k2c3m1v7ep35c0\",\n \"Content\": \"{\\\"temperature\\\": 35, \\\"wind\\\": \\\"南\\\", \\\"condition\\\": \\\"暴雨\\\"}\"\n }\n ],\n \"Tools\": [\n {\n \"Type\": \"function\",\n \"Function\": {\n \"Name\": \"get_current_weather\",\n \"Description\": \"获取当前地点的天气\",\n \"Parameters\": \"{\\n \\\"type\\\": \\\"object\\\",\\n \\\"properties\\\": {\\n \\\"location\\\": {\\n \\\"type\\\": \\\"string\\\",\\n \\\"description\\\": \\\"城市名称\\\"\\n },\\n \\\"unit\\\": {\\n \\\"type\\\": \\\"string\\\",\\n \\\"enum\\\": [\\n \\\"celsius\\\",\\n \\\"fahrenheit\\\"\\n ]\\n }\\n },\\n \\\"required\\\": [\\n \\\"location\\\"\\n ]\\n }\"\n }\n }\n ],\n \"ToolChoice\": \"auto\"\n}",
49
+ "output": "{\n \"Response\": {\n \"RequestId\": \"5a112898-d802-4bca-8ba2-7ce2388b98e8\",\n \"Note\": \"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\n \"Choices\": [\n {\n \"Message\": {\n \"Role\": \"assistant\",\n \"Content\": \"北京今天的天气情况是:\\n温度:35摄氏度\\n风向:南\\n天气状况:暴雨\\n\\n深圳今天的天气情况是:\\n温度:35摄氏度\\n风向:南\\n天气状况:暴雨\"\n },\n \"FinishReason\": \"stop\"\n }\n ],\n \"Created\": 1719822322,\n \"Id\": \"5a112898-d802-4bca-8ba2-7ce2388b98e8\",\n \"Usage\": {\n \"PromptTokens\": 71,\n \"CompletionTokens\": 42,\n \"TotalTokens\": 113\n }\n }\n}",
50
+ "title": "hunyuan-functioncall模型多轮对话示例"
51
+ },
52
+ {
53
+ "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例说明hunyuan-vision模型如何调用接口。",
54
+ "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"Model\": \"hunyuan-vision\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Contents\": [\n {\n \"Type\": \"text\",\n \"Text\": \"下面图片中是哪个公司的 Logo?\"\n },\n {\n \"Type\": \"image_url\",\n \"ImageUrl\": {\n \"Url\": \"https://cloudcache.tencent-cloud.com/qcloud/ui/portal-set/build/About/images/bg-product-series_87d.png\"\n }\n }\n ]\n }\n ],\n \"Stream\": false\n}",
55
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a21f9d7e-c18a-438b-bfb4-7941a2adf8ae\",\n \"Note\": \"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\n \"Choices\": [\n {\n \"Message\": {\n \"Role\": \"assistant\",\n \"Content\": \"这张图片中展示的Logo属于腾讯公司。\"\n },\n \"FinishReason\": \"stop\"\n }\n ],\n \"Created\": 1714290436,\n \"Id\": \"a21f9d7e-c18a-438b-bfb4-7941a2adf8ae\",\n \"Usage\": {\n \"PromptTokens\": 7,\n \"CompletionTokens\": 10,\n \"TotalTokens\": 17\n }\n }\n}",
56
+ "title": "图片理解示例"
33
57
  }
34
58
  ],
35
59
  "GetEmbedding": [