tccli 3.0.1261.1__py2.py3-none-any.whl → 3.0.1263.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 CHANGED
@@ -1 +1 @@
1
- __version__ = '3.0.1261.1'
1
+ __version__ = '3.0.1263.1'
@@ -449,11 +449,11 @@
449
449
  "status": "online"
450
450
  },
451
451
  "DescribeCpuExpandStrategy": {
452
- "document": "通过该 API 可以查询实例的 CPU 弹性扩容策略",
452
+ "document": "DescribeCpuExpandStrategy\n\n通过该 API 可以查询实例的 CPU 弹性扩容策略",
453
453
  "input": "DescribeCpuExpandStrategyRequest",
454
454
  "name": "查询实例的 CPU 弹性扩容策略",
455
455
  "output": "DescribeCpuExpandStrategyResponse",
456
- "status": "online"
456
+ "status": "deprecated"
457
457
  },
458
458
  "DescribeDBFeatures": {
459
459
  "document": "本接口(DescribeDBFeatures)用于查询云数据库版本属性,包括是否支持数据库加密、数据库审计等功能。",
@@ -466,13 +466,13 @@
466
466
  "members": [
467
467
  {
468
468
  "disabled": false,
469
- "document": "错误信息\n注意:此字段可能返回 null,表示取不到有效值。",
470
- "example": "-",
469
+ "document": "错误信息",
470
+ "example": "error",
471
471
  "member": "string",
472
472
  "name": "ErrorMsg",
473
473
  "output_required": true,
474
474
  "type": "string",
475
- "value_allowed_null": true
475
+ "value_allowed_null": false
476
476
  },
477
477
  {
478
478
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -2252,7 +2252,7 @@
2252
2252
  {
2253
2253
  "disabled": false,
2254
2254
  "document": "任务id",
2255
- "example": "123",
2255
+ "example": "1428",
2256
2256
  "member": "int64",
2257
2257
  "name": "BackUpJobId",
2258
2258
  "required": false,
@@ -3404,7 +3404,7 @@
3404
3404
  {
3405
3405
  "disabled": false,
3406
3406
  "document": "总数",
3407
- "example": "123",
3407
+ "example": "1873",
3408
3408
  "member": "int64",
3409
3409
  "name": "TotalCount",
3410
3410
  "output_required": true,
@@ -4435,7 +4435,7 @@
4435
4435
  {
4436
4436
  "disabled": false,
4437
4437
  "document": "总数",
4438
- "example": "123",
4438
+ "example": "76123",
4439
4439
  "member": "int64",
4440
4440
  "name": "TotalCount",
4441
4441
  "output_required": true,
@@ -3,8 +3,8 @@
3
3
  "ActionAlterUser": [
4
4
  {
5
5
  "document": "",
6
- "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ActionAlterUser\n<公共请求参数>\n\n{\n \"UserInfo\": {\n \"InstanceId\": \"abc\",\n \"UserName\": \"abc\",\n \"PassWord\": \"abc\",\n \"WhiteHost\": \"abc\",\n \"OldWhiteHost\": \"abc\",\n \"Describe\": \"abc\",\n \"OldPwd\": \"abc\"\n },\n \"ApiType\": \"abc\",\n \"UserPrivilege\": 0\n}",
7
- "output": "{\n \"Response\": {\n \"ErrorMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
6
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ActionAlterUser\n<公共请求参数>\n\n{\n \"UserInfo\": {\n \"InstanceId\": \"cdwdoris-xasdf\",\n \"UserName\": \"user\",\n \"PassWord\": \"pwd\",\n \"WhiteHost\": \"host\",\n \"OldWhiteHost\": \"o_host\",\n \"Describe\": \"describe\",\n \"OldPwd\": \"pwd\"\n },\n \"ApiType\": \"type\",\n \"UserPrivilege\": 3\n}",
7
+ "output": "{\n \"Response\": {\n \"ErrorMsg\": \"err\",\n \"RequestId\": \"xawef0-asxca\"\n }\n}",
8
8
  "title": "新增、修改ck集群用户"
9
9
  }
10
10
  ],
@@ -8962,7 +8962,7 @@
8962
8962
  {
8963
8963
  "disabled": false,
8964
8964
  "document": "若为cdc防火墙时填充该id",
8965
- "example": "cluster-xxx",
8965
+ "example": "cluster-dxd31akg",
8966
8966
  "member": "string",
8967
8967
  "name": "CdcId",
8968
8968
  "required": false,
@@ -13504,7 +13504,7 @@
13504
13504
  {
13505
13505
  "disabled": false,
13506
13506
  "document": "资产id",
13507
- "example": "ins-123456",
13507
+ "example": "ins-nl6svll8",
13508
13508
  "member": "string",
13509
13509
  "name": "InsID",
13510
13510
  "output_required": true,
@@ -13514,7 +13514,7 @@
13514
13514
  {
13515
13515
  "disabled": false,
13516
13516
  "document": "资产名称",
13517
- "example": "ins-机器",
13517
+ "example": "Dev Proxy",
13518
13518
  "member": "string",
13519
13519
  "name": "InsName",
13520
13520
  "output_required": true,
@@ -17,7 +17,7 @@
17
17
  },
18
18
  {
19
19
  "document": "推荐使用 API Explorer 调用接口,见本文档顶部说明。该示例说明如何给模型传入多轮消息。",
20
- "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 \"Stream\": true,\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}",
20
+ "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 \"Stream\": true,\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}",
21
21
  "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\":\"青蛙\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":1,\"TotalTokens\":86}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"跳\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":2,\"TotalTokens\":87}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"高\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":3,\"TotalTokens\":88}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\",\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":4,\"TotalTokens\":89}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"比\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":5,\"TotalTokens\":90}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"下马\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":6,\"TotalTokens\":91}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"。\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":7,\"TotalTokens\":92}}\n\ndata: {\"Note\":\"以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记\",\"Choices\":[{\"FinishReason\":\"stop\",\"Delta\":{\"Role\":\"assistant\",\"Content\":\"\"}}],\"Created\":1705634032,\"Id\":\"9c772634-8824-43e8-bc24-8bc4c19b9151\",\"Usage\":{\"PromptTokens\":85,\"CompletionTokens\":7,\"TotalTokens\":92}}",
22
22
  "title": "多轮对话示例"
23
23
  },
@@ -10446,6 +10446,39 @@
10446
10446
  "required": false,
10447
10447
  "type": "object",
10448
10448
  "value_allowed_null": true
10449
+ },
10450
+ {
10451
+ "disabled": false,
10452
+ "document": "模型来源 Hunyuan:腾讯混元大模型,Industry:腾讯云行业大模型,Experience:新模型体验",
10453
+ "example": "Hunyuan",
10454
+ "member": "string",
10455
+ "name": "Source",
10456
+ "output_required": false,
10457
+ "required": false,
10458
+ "type": "string",
10459
+ "value_allowed_null": false
10460
+ },
10461
+ {
10462
+ "disabled": false,
10463
+ "document": "模型图标",
10464
+ "example": "无",
10465
+ "member": "string",
10466
+ "name": "Icon",
10467
+ "output_required": false,
10468
+ "required": false,
10469
+ "type": "string",
10470
+ "value_allowed_null": false
10471
+ },
10472
+ {
10473
+ "disabled": false,
10474
+ "document": "是否免费",
10475
+ "example": "无",
10476
+ "member": "bool",
10477
+ "name": "IsFree",
10478
+ "output_required": false,
10479
+ "required": false,
10480
+ "type": "bool",
10481
+ "value_allowed_null": false
10449
10482
  }
10450
10483
  ],
10451
10484
  "usage": "both"
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "actions": {
3
3
  "ChatCompletions": {
4
- "document": "对话",
4
+ "document": "#### 接口功能\n\n调用接口,发起一次对话请求。\n\n#### 已支持的模型\n- DeepSeek-V3(model 参数值为**deepseek-v3**)\n - DeepSeek-V3为671B参数MoE模型,在百科知识、数学推理等多项任务上优势突出,评测成绩在主流榜单中位列开源模型榜首。\n - 支持64K上下文长度,最大支持8K输出长度。\n- DeepSeek-R1(model 参数值为**deepseek-r1**)\n - DeepSeek-R1为671B模型,使用强化学习训练,推理过程包含大量反思和验证,思维链长度可达数万字。 该系列模型在数学、代码以及各种复杂逻辑推理任务上推理效果优异,并为用户展现了完整的思考过程。\n - 支持64K上下文长度,最大支持8K输出长度。\n\n#### 计费说明\n- 限时免费\n\n本接口调用DeepSeek系列模型限时免费。即日至北京时间2025年2月25日23:59:59,所有腾讯云用户均可享受DeepSeek-V3、DeepSeek-R1模型限时免费服务,单账号限制接口并发上限为5。在此之后,模型价格将恢复至原价。\n- 标准计费(2025年2月26日起生效)\n![image](https://cdn.xiaowei.qq.com/static/lke/deepseek-token.png)\n\n### Openai兼容协议接口\n知识引擎原子能力大模型对话 API 兼容了 OpenAI 的接口规范,这意味着您可以直接使用 OpenAI 官方提供的 SDK 来调用大模型对话接口。您仅需要将 base_url 和 [api_key](https://cloud.tencent.com/document/product/1772/115970) 替换成相关配置,不需要对应用做额外修改,即可无缝将您的应用切换到相应的大模型。\n> base_url: https://api.lkeap.cloud.tencent.com/v1\n\n> api_key的获取请参考[API KEY管理](https://cloud.tencent.com/document/product/1772/115970)\n\n\n#### 快速接入\n1. 完成[实名认证](https://console.cloud.tencent.com/developer/auth)。\n2. 主账户前往[控制台](https://console.cloud.tencent.com/lkeap)开通服务。若为子账户,需由主账号在[权限管理](https://console.cloud.tencent.com/cam)中为子账号授权,关联预设策略,策略名称:QcloudLKEAPFullAccess。\n3. 通过API Explorer[在线调试](https://console.cloud.tencent.com/api/explorer?Product=lkeap&Version=2024-05-22&Action=ChatCompletions)。\n4. 使用[官方 SDK ](https://cloud.tencent.com/document/product/1772/115963#SDK)调用本接口(支持Python/Java/PHP/Go/Node.js/.NET等语言)。\n\n-----------\n\n### SDK调用示例\n通过本地代码调用本接口(支持Python/Java/PHP/Go/Node.js/.NET等语言):下面的代码以 Python 语言为例,展示如何访问腾讯云上的DeepSeek模型API的样例。\n(1)安装环境\n```\npython3 -m pip install --upgrade tencentcloud-sdk-python-common\npython3 -m pip install --upgrade tencentcloud-sdk-python-lkeap\n```\n\n(2)示例代码\n\n- 其中SecretKey和SecretID需要从腾讯云控制台获取\n\n- 参数params中模型Model字段可以选择“deepseek-r1“和“deepseek-v3”\n\n```\n# -*- coding: utf-8 -*-\nimport json\n\nfrom tencentcloud.common.common_client import CommonClient\nfrom tencentcloud.common import credential\nfrom tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException\nfrom tencentcloud.common.profile.client_profile import ClientProfile\nfrom tencentcloud.common.profile.http_profile import HttpProfile\n\nclass NonStreamResponse(object):\n def __init__(self):\n self.response = \"\"\n\n def _deserialize(self, obj):\n self.response = json.dumps(obj)\n\ntry:\n # 实例化一个认证对象,入参需要传入腾讯云账户 SecretId 和 SecretKey,此处还需注意密钥对的保密\n # 代码泄露可能会导致 SecretId 和 SecretKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考,建议采用更安全的方式来使用密钥,请参见:https://cloud.tencent.com/document/product/1278/85305\n # 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取\n cred = credential.Credential(\"\", \"\")\n\n httpProfile = HttpProfile()\n httpProfile.endpoint = \"lkeap.tencentcloudapi.com\"\n httpProfile.reqTimeout = 40000 # 流式接口可能耗时较长\n clientProfile = ClientProfile()\n clientProfile.httpProfile = httpProfile\n\n params = \"{\\\"Model\\\":\\\"deepseek-r1\\\",\\\"Messages\\\":[{\\\"Role\\\":\\\"user\\\",\\\"Content\\\":\\\"你好\\\"}],\\\"Stream\\\":true}\";\n common_client = CommonClient(\"lkeap\", \"2024-05-22\", cred, \"ap-guangzhou\", profile=clientProfile)\n resp = common_client._call_and_deserialize(\"ChatCompletions\", json.loads(params), NonStreamResponse)\n if isinstance(resp, NonStreamResponse): # 非流式响应\n print(resp.response)\n else: # 流式响应\n for event in resp:\n print(event)\nexcept TencentCloudSDKException as err:\n print(err)\n\n```\n\n**DeepSeek-R1使用建议**\n\n1. 将温度设置在 0.5-0.7 范围内(建议为0.6),以防止无休止的重复或不连贯的输出。\n2. 避免添加system prompt,所有说明都应包含在user prompt中。",
5
5
  "input": "ChatCompletionsRequest",
6
6
  "name": "对话",
7
7
  "output": "ChatCompletionsResponse",
@@ -325,6 +325,24 @@
325
325
  "name": "Stream",
326
326
  "required": false,
327
327
  "type": "bool"
328
+ },
329
+ {
330
+ "disabled": false,
331
+ "document": "控制生成的随机性,较高的值会产生更多样化的输出。",
332
+ "example": "0.6",
333
+ "member": "float",
334
+ "name": "Temperature",
335
+ "required": false,
336
+ "type": "float"
337
+ },
338
+ {
339
+ "disabled": false,
340
+ "document": "最大生成的token数量",
341
+ "example": "100",
342
+ "member": "int64",
343
+ "name": "MaxTokens",
344
+ "required": false,
345
+ "type": "int"
328
346
  }
329
347
  ],
330
348
  "type": "object"
@@ -332,6 +350,56 @@
332
350
  "ChatCompletionsResponse": {
333
351
  "document": "ChatCompletions返回参数结构体",
334
352
  "members": [
353
+ {
354
+ "disabled": false,
355
+ "document": "Unix 时间戳,单位为秒。",
356
+ "example": "1705634032",
357
+ "member": "int64",
358
+ "name": "Created",
359
+ "output_required": false,
360
+ "type": "int",
361
+ "value_allowed_null": false
362
+ },
363
+ {
364
+ "disabled": false,
365
+ "document": "Token 统计信息。\n按照总 Token 数量计费。",
366
+ "example": "无",
367
+ "member": "ChatUsage",
368
+ "name": "Usage",
369
+ "output_required": false,
370
+ "type": "object",
371
+ "value_allowed_null": false
372
+ },
373
+ {
374
+ "disabled": false,
375
+ "document": "本次请求的 RequestId。",
376
+ "example": "9c772634-8824-43e8-bc24-8bc4c19b9151",
377
+ "member": "string",
378
+ "name": "Id",
379
+ "output_required": false,
380
+ "type": "string",
381
+ "value_allowed_null": false
382
+ },
383
+ {
384
+ "disabled": false,
385
+ "document": "回复内容。",
386
+ "example": "无",
387
+ "member": "Choice",
388
+ "name": "Choices",
389
+ "output_required": false,
390
+ "type": "list",
391
+ "value_allowed_null": false
392
+ },
393
+ {
394
+ "disabled": false,
395
+ "document": "模型名称。",
396
+ "example": "deepseek-r1",
397
+ "member": "string",
398
+ "name": "Model",
399
+ "output_required": false,
400
+ "type": "string",
401
+ "value_allowed_null": false
402
+ },
335
403
  {
336
404
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header \"X-TC-RequestId\" 中。",
337
405
  "member": "string",
@@ -341,6 +409,88 @@
341
409
  ],
342
410
  "type": "object"
343
411
  },
412
+ "ChatUsage": {
413
+ "document": "消耗量",
414
+ "members": [
415
+ {
416
+ "disabled": false,
417
+ "document": "输入token数",
418
+ "example": "10",
419
+ "member": "int64",
420
+ "name": "PromptTokens",
421
+ "output_required": false,
422
+ "type": "int",
423
+ "value_allowed_null": false
424
+ },
425
+ {
426
+ "disabled": false,
427
+ "document": "输出token数",
428
+ "example": "10",
429
+ "member": "int64",
430
+ "name": "CompletionTokens",
431
+ "output_required": false,
432
+ "type": "int",
433
+ "value_allowed_null": false
434
+ },
435
+ {
436
+ "disabled": false,
437
+ "document": "总token数",
438
+ "example": "10",
439
+ "member": "int64",
440
+ "name": "TotalTokens",
441
+ "output_required": false,
442
+ "type": "int",
443
+ "value_allowed_null": false
444
+ }
445
+ ],
446
+ "usage": "out"
447
+ },
448
+ "Choice": {
449
+ "document": "返回的回复, 支持多个",
450
+ "members": [
451
+ {
452
+ "disabled": false,
453
+ "document": "结束标志位,可能为 stop、 sensitive或者tool_calls。\nstop 表示输出正常结束。\nsensitive 只在开启流式输出审核时会出现,表示安全审核未通过。\ntool_calls 标识函数调用。",
454
+ "example": "stop",
455
+ "member": "string",
456
+ "name": "FinishReason",
457
+ "output_required": false,
458
+ "type": "string",
459
+ "value_allowed_null": false
460
+ },
461
+ {
462
+ "disabled": false,
463
+ "document": "增量返回值,流式调用时使用该字段。",
464
+ "example": "无",
465
+ "member": "Delta",
466
+ "name": "Delta",
467
+ "output_required": false,
468
+ "type": "object",
469
+ "value_allowed_null": false
470
+ },
471
+ {
472
+ "disabled": false,
473
+ "document": "返回值,非流式调用时使用该字段。",
474
+ "example": "无",
475
+ "member": "Message",
476
+ "name": "Message",
477
+ "output_required": false,
478
+ "type": "object",
479
+ "value_allowed_null": false
480
+ },
481
+ {
482
+ "disabled": false,
483
+ "document": "索引值,流式调用时使用该字段。",
484
+ "example": "0",
485
+ "member": "int64",
486
+ "name": "Index",
487
+ "output_required": false,
488
+ "type": "int",
489
+ "value_allowed_null": false
490
+ }
491
+ ],
492
+ "usage": "out"
493
+ },
344
494
  "CreateAttributeLabelRequest": {
345
495
  "document": "CreateAttributeLabel请求参数结构体",
346
496
  "members": [
@@ -739,6 +889,32 @@
739
889
  ],
740
890
  "type": "object"
741
891
  },
892
+ "Delta": {
893
+ "document": "返回的内容",
894
+ "members": [
895
+ {
896
+ "disabled": false,
897
+ "document": "角色名称。",
898
+ "example": "assistant",
899
+ "member": "string",
900
+ "name": "Role",
901
+ "output_required": false,
902
+ "type": "string",
903
+ "value_allowed_null": false
904
+ },
905
+ {
906
+ "disabled": false,
907
+ "document": "内容详情。",
908
+ "example": "你好!请问有什么我可以帮助你的吗?",
909
+ "member": "string",
910
+ "name": "Content",
911
+ "output_required": false,
912
+ "type": "string",
913
+ "value_allowed_null": false
914
+ }
915
+ ],
916
+ "usage": "out"
917
+ },
742
918
  "DescribeDocRequest": {
743
919
  "document": "DescribeDoc请求参数结构体",
744
920
  "members": [],
@@ -1206,6 +1382,17 @@
1206
1382
  "required": false,
1207
1383
  "type": "string",
1208
1384
  "value_allowed_null": false
1385
+ },
1386
+ {
1387
+ "disabled": false,
1388
+ "document": "思维链内容。\nReasoningConent参数仅支持出参,且只有deepseek-r1模型会返回。",
1389
+ "example": "无",
1390
+ "member": "string",
1391
+ "name": "ReasoningContent",
1392
+ "output_required": false,
1393
+ "required": false,
1394
+ "type": "string",
1395
+ "value_allowed_null": false
1209
1396
  }
1210
1397
  ],
1211
1398
  "usage": "both"
@@ -2,10 +2,16 @@
2
2
  "actions": {
3
3
  "ChatCompletions": [
4
4
  {
5
- "document": "对话",
6
- "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"Model\": \"deepseek-r1\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"你好\"\n }\n ],\n \"Stream\": false\n}",
7
- "output": "{\n \"Response\": {\n \"RequestId\": \"26b3ed8b-960d-4d68-bc7f-098839f4b574\"\n }\n}",
8
- "title": "对话"
5
+ "document": "流式请求",
6
+ "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"Model\": \"deepseek-r1\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"你是谁\"\n }\n ],\n \"Stream\": true\n}",
7
+ "output": "data:{\"Choices\":[{\"Delta\":{\"Role\":\"assistant\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"ReasoningContent\":\"\\n\\n\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"\\n\\n\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"您好\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"!\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"我是\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"由\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"中国的\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"深度\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"求\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"索\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"(\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"Deep\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"Se\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"ek\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\")\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"公司\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"开发的\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"智能\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"助手\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"Deep\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"Se\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"ek\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"-R\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"1\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"。\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"如\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"您\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"有任何\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"任何\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"问题\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\",\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"我会\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"尽\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"我\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"所能\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"为您\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"提供\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"帮助\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"Content\":\"。\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{},\"FinishReason\":\"stop\",\"Index\":0}],\"Created\":1738697505,\"Id\":\"60c97fbd7cfd14db07b75d56069a131f\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:[DONE]",
8
+ "title": "流式请求"
9
+ },
10
+ {
11
+ "document": "在输出最终回答之前,模型会先输出一段思维链内容,以提升最终答案的准确性。ReasoningContent表示思维链内容,Content表示回答的内容。仅deepseek-r1推理模型支持返回ReasoningContent参数",
12
+ "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatCompletions\n<公共请求参数>\n\n{\n \"Model\": \"deepseek-r1\",\n \"Messages\": [\n {\n \"Role\": \"user\",\n \"Content\": \"9.11和9.8哪个大\"\n }\n ],\n \"Stream\": true\n}",
13
+ "output": "data:{\"Choices\":[{\"Delta\":{\"ReasoningContent\":\"确定\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697628,\"Id\":\"9c91b95dc4df49f2e9596ba07541e41a\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"ReasoningContent\":\"9\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697628,\"Id\":\"9c91b95dc4df49f2e9596ba07541e41a\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"ReasoningContent\":\".\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697628,\"Id\":\"9c91b95dc4df49f2e9596ba07541e41a\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}\n\ndata:{\"Choices\":[{\"Delta\":{\"ReasoningContent\":\"11\"},\"FinishReason\":\"\",\"Index\":0}],\"Created\":1738697628,\"Id\":\"9c91b95dc4df49f2e9596ba07541e41a\",\"Model\":\"deepseek-r1\",\"Object\":\"chat.completion.chunk\",\"Usage\":{\"InputTokens\":0,\"OutputTokens\":0,\"TotalTokens\":0}}",
14
+ "title": "思维链示例"
9
15
  }
10
16
  ],
11
17
  "CreateAttributeLabel": [
@@ -785,7 +785,7 @@
785
785
  {
786
786
  "disabled": false,
787
787
  "document": "新账号密码。密码复杂度要求如下:<ul><li>字符长度范围[8,32]。</li><li>至少包含字母、数字和特殊字符(叹号“!”、at\"@\"、井号“#”、百分号“%”、插入符“^”、星号“*”、小括号“()”、下划线“_”)中的两种。</li></ul>",
788
- "example": "abc123...",
788
+ "example": "abc123!@",
789
789
  "member": "string",
790
790
  "name": "Password",
791
791
  "required": true,
@@ -830,6 +830,7 @@
830
830
  "example": "1",
831
831
  "member": "uint64",
832
832
  "name": "FlowId",
833
+ "output_required": true,
833
834
  "type": "int",
834
835
  "value_allowed_null": false
835
836
  },
@@ -1436,7 +1437,7 @@
1436
1437
  },
1437
1438
  {
1438
1439
  "disabled": false,
1439
- "document": "实例密码。自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。",
1440
+ "document": "实例密码。设置要求如下:\n- 字符个数为[8,32]。\n- 可输入[A,Z]、[a,z]、[0,9]范围内的字符。\n- 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#“、百分号”%”、插入号“^”、星号“*”、括号“()”、下划线“_”。\n- 不能设置单一的字母或者数字。",
1440
1441
  "example": "********",
1441
1442
  "member": "string",
1442
1443
  "name": "Password",
@@ -3814,7 +3815,7 @@
3814
3815
  "members": [
3815
3816
  {
3816
3817
  "disabled": false,
3817
- "document": "实例ID,格式如:cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同,接口单次最多只支持5个实例进行操作。",
3818
+ "document": "实例ID,格式如:cmgo-p8vn****。请登录[MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID,且单次最多同时查询5个实例。",
3818
3819
  "example": "[cmgo-8oij****]",
3819
3820
  "member": "string",
3820
3821
  "name": "InstanceIds",
@@ -35,7 +35,7 @@
35
35
  "CreateDBInstance": [
36
36
  {
37
37
  "document": "当前示例仅适合4.0版本,其余版本请严格参考传入参数中各版本说明项",
38
- "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDBInstance\n<公共请求参数>\n\n{\n \"VpcId\": \"vpc-0akbol5v\",\n \"GoodsNum\": \"1\",\n \"Zone\": \"ap-guangzhou-2\",\n \"ProjectId\": \"0\",\n \"MachineCode\": \"HIO10G\",\n \"Period\": \"1\",\n \"ClusterType\": \"REPLSET\",\n \"Volume\": \"250\",\n \"MongoVersion\": \"MONGO_40_WT\",\n \"NodeNum\": \"3\",\n \"ReplicateSetNum\": \"1\",\n \"Memory\": \"4\",\n \"SubnetId\": \"subnet-fyrtjbqw\",\n \"Password\": \"pwd123456\"\n}",
38
+ "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDBInstance\n<公共请求参数>\n\n{\n \"VpcId\": \"vpc-0akbol5v\",\n \"GoodsNum\": 1,\n \"Zone\": \"ap-guangzhou-2\",\n \"ProjectId\": 0,\n \"MachineCode\": \"HIO10G\",\n \"Period\": 1,\n \"ClusterType\": \"REPLSET\",\n \"Volume\": 250,\n \"MongoVersion\": \"MONGO_40_WT\",\n \"NodeNum\": 3,\n \"ReplicateSetNum\": 1,\n \"Memory\": 4,\n \"SubnetId\": \"subnet-fyrtjbqw\",\n \"Password\": \"pwd123456\"\n}",
39
39
  "output": "{\n \"Response\": {\n \"RequestId\": \"d88095e5-50e8-4245-a0cf-993a536f9b20\",\n \"DealId\": \"7142863\",\n \"InstanceIds\": [\n \"cmgo-po5f899l\"\n ]\n }\n}",
40
40
  "title": "创建包年包月的云数据库实例"
41
41
  }
@@ -115,7 +115,7 @@
115
115
  "DescribeDBBackups": [
116
116
  {
117
117
  "document": "",
118
- "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDBBackups\n<公共请求参数>\n\n{\n \"InstanceId\": \"cmgo-f555zzzz\",\n \"BackupMethod\": \"1\"\n}",
118
+ "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDBBackups\n<公共请求参数>\n\n{\n \"InstanceId\": \"cmgo-f555zzzz\",\n \"BackupMethod\": 1\n}",
119
119
  "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"BackupList\": [],\n \"TotalCount\": 0\n }\n}",
120
120
  "title": "查询云数据库实例的备份文件信息"
121
121
  }
@@ -219,8 +219,8 @@
219
219
  "EnableTransparentDataEncryption": [
220
220
  {
221
221
  "document": "",
222
- "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableTransparentDataEncryption\n<公共请求参数>\n\n{\n \"InstanceId\": \"cmgo-igjysqkr\",\n \"KmsRegion\": \"ap-guangzhou\",\n \"KeyId\": \"abcabc\"\n}",
223
- "output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"RequestId\": \"abcd\"\n }\n}",
222
+ "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableTransparentDataEncryption\n<公共请求参数>\n\n{\n \"InstanceId\": \"cmgo-igjysqkr\",\n \"KmsRegion\": \"ap-guangzhou\",\n \"KeyId\": \"myEncryptionkey\"\n}",
223
+ "output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"RequestId\": \"a8dce7a4-d488-49c9-8d24-33cf623f5992\"\n }\n}",
224
224
  "title": "开启实例数据透明加密"
225
225
  }
226
226
  ],
@@ -243,7 +243,7 @@
243
243
  "InquirePriceCreateDBInstances": [
244
244
  {
245
245
  "document": "",
246
- "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquirePriceCreateDBInstances\n<公共请求参数>\n\n{\n \"GoodsNum\": \"2\",\n \"Zone\": \"ap-guangzhou-4\",\n \"Memory\": \"4\",\n \"Period\": \"1\",\n \"ClusterType\": \"REPLSET\",\n \"Volume\": \"100\",\n \"NodeNum\": \"3\",\n \"ReplicateSetNum\": \"1\",\n \"MachineCode\": \"HIO10G\",\n \"MongoVersion\": \"MONGO_36_WT\"\n}",
246
+ "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquirePriceCreateDBInstances\n<公共请求参数>\n\n{\n \"GoodsNum\": 2,\n \"Zone\": \"ap-guangzhou-4\",\n \"Memory\": 4,\n \"Period\": \"1\",\n \"ClusterType\": \"REPLSET\",\n \"Volume\": 100,\n \"NodeNum\": 3,\n \"ReplicateSetNum\": 1,\n \"MachineCode\": \"HIO10G\",\n \"MongoVersion\": \"MONGO_50_WT\"\n}",
247
247
  "output": "{\n \"Response\": {\n \"Price\": {\n \"DiscountPrice\": 1340,\n \"OriginalPrice\": 1340,\n \"UnitPrice\": 670\n },\n \"RequestId\": \"fb8b4646-389d-44cc-ab8c-98c081cbdad3\"\n }\n}",
248
248
  "title": "查询新购数据库实例价格"
249
249
  }
@@ -15240,7 +15240,7 @@
15240
15240
  },
15241
15241
  {
15242
15242
  "disabled": false,
15243
- "document": "图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。\n建议图片存储于腾讯云,可保障更高的下载速度和稳定性。",
15243
+ "document": "图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500\\*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。\n建议图片存储于腾讯云,可保障更高的下载速度和稳定性。",
15244
15244
  "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
15245
15245
  "member": "string",
15246
15246
  "name": "ImageUrl",
@@ -15326,7 +15326,7 @@
15326
15326
  },
15327
15327
  {
15328
15328
  "disabled": false,
15329
- "document": "图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。\n建议图片存储于腾讯云,可保障更高的下载速度和稳定性。",
15329
+ "document": "图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500\\*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。\n建议图片存储于腾讯云,可保障更高的下载速度和稳定性。",
15330
15330
  "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
15331
15331
  "member": "string",
15332
15332
  "name": "ImageUrl",