tccli 3.0.1098.1__py2.py3-none-any.whl → 3.0.1100.1__py2.py3-none-any.whl

tccli/services/hunyuan/v20230901/api.json

@@ -1,30 +1,37 @@
 {
   "actions": {
+    "ChatCompletions": {
+      "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**” 部分提供。",
+      "input": "ChatCompletionsRequest",
+      "name": "hunyuan",
+      "output": "ChatCompletionsResponse",
+      "status": "online"
+    },
     "ChatPro": {
-      "document": "腾讯混元大模型高级版是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。\n\n 1. 本接口暂不支持返回图片内容。\n 2. 默认单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。\n 3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。",
+      "document": "<span style=\"font-size:1.5em;\">注意：本接口将于 5 月 15 日下线；下线后将不再提供文档指引，接口本身可继续调用，建议使用 [hunyuan](https://cloud.tencent.com/document/api/1729/105701) 接入。</span>\n\n腾讯混元大模型（hunyuan-pro）是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 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**” 部分提供。",
       "input": "ChatProRequest",
-      "name": "腾讯混元大模型高级版",
+      "name": "hunyuan-pro (即将下线)",
       "output": "ChatProResponse",
       "status": "online"
     },
     "ChatStd": {
-      "document": "腾讯混元大模型标准版是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。\n\n 1. 本接口暂不支持返回图片内容。\n 2. 默认单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。\n 3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。",
+      "document": "<span style=\"font-size:1.5em;\">注意：本接口将于 5 月 15 日下线；下线后将不再提供文档指引，接口本身可继续调用，建议使用 [hunyuan](https://cloud.tencent.com/document/api/1729/105701) 接入。</span>\n\n腾讯混元大模型标准版是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 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**” 部分提供。",
       "input": "ChatStdRequest",
-      "name": "腾讯混元大模型标准版",
+      "name": "hunyuan-standard (即将下线)",
       "output": "ChatStdResponse",
       "status": "online"
     },
     "GetEmbedding": {
-      "document": "腾讯混元-Embedding接口，可以将文本转化为高质量的向量数据。",
+      "document": "腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。",
       "input": "GetEmbeddingRequest",
-      "name": "腾讯混元-Embedding",
+      "name": "hunyuan-embedding",
       "output": "GetEmbeddingResponse",
       "status": "online"
     },
     "GetTokenCount": {
       "document": "该接口用于计算文本对应Token数、字符数。",
       "input": "GetTokenCountRequest",
-      "name": "Token计数",
+      "name": "Token 计数",
       "output": "GetTokenCountResponse",
       "status": "online"
     }
@@ -36,18 +43,45 @@
     "serviceShortName": "hunyuan"
   },
   "objects": {
-    "ChatProRequest": {
-      "document": "ChatPro请求参数结构体",
+    "ChatCompletionsRequest": {
+      "document": "ChatCompletions请求参数结构体",
       "members": [
         {
           "disabled": false,
-          "document": "聊天上下文信息。\n说明：\n1. 长度最多为 40，按对话时间从旧到新在数组中排列。\n2. Message 的 Role 当前可选值：system、user、assistant。其中，system 角色是可选的，如果存在，必须位于列表的最开始。此外，user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。\n3. Messages 中 Content 总长度不超过 16000 Token，超过则会截断最前面的内容，只保留尾部内容。建议不超过 4000 Token。",
+          "document": "模型名称，可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-pro。\n各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。\n\n注意：\n不同的模型计费不同，请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。",
+          "example": "无",
+          "member": "string",
+          "name": "Model",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "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) 文档），超过则会截断最前面的内容，只保留尾部内容。",
           "example": "无",
           "member": "Message",
           "name": "Messages",
           "required": true,
           "type": "list"
         },
+        {
+          "disabled": false,
+          "document": "流式调用开关。\n说明：\n1. 未传值时默认为非流式调用（false）。\n2. 流式调用时以 SSE 协议增量返回结果（返回值取 Choices[n].Delta 中的值，需要拼接增量数据才能获得完整结果）。\n3. 非流式调用时：\n调用方式与普通 HTTP 请求无异。\n接口响应耗时较长，**如需更低时延建议设置为 true**。\n只返回一次最终结果（返回值取 Choices[n].Message 中的值）。\n\n注意：\n通过 SDK 调用时，流式和非流式调用需用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。",
+          "example": "false",
+          "member": "bool",
+          "name": "Stream",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "流式输出审核开关。\n说明：\n1. 当使用流式输出（Stream 字段值为 true）时，该字段生效。\n2. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。未传值时默认为流式模式（true）。\n3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。\n4. 如果值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。\n\n注意：\n当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。",
+          "example": "false",
+          "member": "bool",
+          "name": "StreamModeration",
+          "required": false,
+          "type": "bool"
+        },
         {
           "disabled": false,
           "document": "说明：\n1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。\n2. 默认 1.0，取值区间为 [0.0, 1.0]。\n3. 非必要不建议使用，不合理的取值会影响效果。",
@@ -59,16 +93,121 @@
         },
         {
           "disabled": false,
-          "document": "说明：\n1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。\n2. 默认 1.0，取值区间为 [0.0，2.0]。\n3. 非必要不建议使用，不合理的取值会影响效果。",
+          "document": "说明：\n1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。\n2. 默认 1.0，取值区间为 [0.0, 2.0]。\n3. 非必要不建议使用，不合理的取值会影响效果。",
           "example": "无",
           "member": "float",
           "name": "Temperature",
           "required": false,
           "type": "float"
+        }
+      ],
+      "type": "object"
+    },
+    "ChatCompletionsResponse": {
+      "document": "ChatCompletions返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Unix 时间戳，单位为秒。",
+          "example": "无",
+          "member": "int64",
+          "name": "Created",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Token 统计信息。\n按照总 Token 数量计费。",
+          "example": "无",
+          "member": "Usage",
+          "name": "Usage",
+          "output_required": false,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "免责声明。",
+          "example": "无",
+          "member": "string",
+          "name": "Note",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "流式调用开关。\n说明：\n1. 未传值时默认为流式调用。\n2. 流式调用时以 SSE 协议增量返回结果。\n3. 非流式调用时接口响应耗时较长，非必要不建议使用。\n4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。",
+          "document": "本轮对话的 ID。",
+          "example": "无",
+          "member": "string",
+          "name": "Id",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "回复内容。",
+          "example": "无",
+          "member": "Choice",
+          "name": "Choices",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "错误信息。\n如果流式返回中服务处理异常，返回该错误信息。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "ErrorMsg",
+          "name": "ErrorMsg",
+          "output_required": false,
+          "type": "object",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header \"X-TC-RequestId\" 中。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "ChatProRequest": {
+      "document": "ChatPro请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "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 总长度不能超过 hunyuan-pro 模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。",
+          "example": "无",
+          "member": "Message",
+          "name": "Messages",
+          "required": true,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "说明：\n1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。\n2. 默认 1.0，取值区间为 [0.0, 1.0]。\n3. 非必要不建议使用，不合理的取值会影响效果。",
+          "example": "1.0",
+          "member": "float",
+          "name": "TopP",
+          "required": false,
+          "type": "float"
+        },
+        {
+          "disabled": false,
+          "document": "说明：\n1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。\n2. 默认 1.0，取值区间为 [0.0, 2.0]。\n3. 非必要不建议使用，不合理的取值会影响效果。",
+          "example": "1.0",
+          "member": "float",
+          "name": "Temperature",
+          "required": false,
+          "type": "float"
+        },
+        {
+          "disabled": false,
+          "document": "流式调用开关。\n说明：\n1. 未传值时默认为流式调用。\n2. 流式调用时以 SSE 协议增量返回结果。\n3. 非流式调用时接口响应耗时较长，非必要不建议使用。\n4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。\n\n注意：\n通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。",
           "example": "true",
           "member": "bool",
           "name": "Stream",
@@ -77,7 +216,7 @@
         },
         {
           "disabled": false,
-          "document": "流式输出审核开关。\n说明：\n1. 当 Stream 字段值为 true 时，该字段有效。\n2. 未传值时默认不使用流式输出审核。\n3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 finish_reason 值为 sensitive。\n4. 如果值为 false，则需要审核完所有输出内容后再返回结果。\n\n注意：\n当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 finish_reason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。",
+          "document": "流式输出审核开关。\n说明：\n1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。\n2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。\n3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。\n4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。\n\n注意：\n当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。",
           "example": "false",
           "member": "bool",
           "name": "StreamModeration",
@@ -164,7 +303,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "聊天上下文信息。\n说明：\n1. 长度最多为 40，按对话时间从旧到新在数组中排列。\n2. Message 的 Role 当前可选值：user、assistant。其中，user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[user assistant user assistant user ...]。\n3. Messages 中 Content 总长度不超过 16000 Token，超过则会截断最前面的内容，只保留尾部内容。建议不超过 4000 Token。\n",
+          "document": "聊天上下文信息。\n说明：\n1. 长度最多为 40，按对话时间从旧到新在数组中排列。\n2. Message 的 Role 当前可选值：user、assistant。\n其中，user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[user assistant user assistant user ...]。\n3. Messages 中 Content 总长度不能超过 hunyuan-standard 模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。",
           "example": "无",
           "member": "Message",
           "name": "Messages",
@@ -174,7 +313,7 @@
         {
           "disabled": false,
           "document": "说明：\n1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。\n2. 默认 1.0，取值区间为 [0.0, 1.0]。\n3. 非必要不建议使用，不合理的取值会影响效果。",
-          "example": "无",
+          "example": "1.0",
           "member": "float",
           "name": "TopP",
           "required": false,
@@ -182,8 +321,8 @@
         },
         {
           "disabled": false,
-          "document": "说明：\n1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。\n2. 默认 1.0，取值区间为 [0.0，2.0]。\n3. 非必要不建议使用，不合理的取值会影响效果。",
-          "example": "无",
+          "document": "说明：\n1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。\n2. 默认 1.0，取值区间为 [0.0, 2.0]。\n3. 非必要不建议使用，不合理的取值会影响效果。",
+          "example": "1.0",
           "member": "float",
           "name": "Temperature",
           "required": false,
@@ -191,7 +330,7 @@
         },
         {
           "disabled": false,
-          "document": "流式调用开关。\n说明：\n1. 未传值时默认为流式调用。\n2. 流式调用时以 SSE 协议增量返回结果。\n3. 非流式调用时接口响应耗时较长，非必要不建议使用。\n4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。",
+          "document": "流式调用开关。\n说明：\n1. 未传值时默认为流式调用。\n2. 流式调用时以 SSE 协议增量返回结果。\n3. 非流式调用时接口响应耗时较长，非必要不建议使用。\n4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。\n\n注意：\n通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。",
           "example": "true",
           "member": "bool",
           "name": "Stream",
@@ -200,7 +339,7 @@
         },
         {
           "disabled": false,
-          "document": "流式输出审核开关。\n说明：\n1. 当 Stream 字段值为 true 时，该字段有效。\n2. 未传值时默认不使用流式输出审核。\n3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 finish_reason 值为 sensitive。\n4. 如果值为 false，则需要审核完所有输出内容后再返回结果。\n\n注意：\n当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 finish_reason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。",
+          "document": "流式输出审核开关。\n说明：\n1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。\n2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。\n3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。\n4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。\n\n注意：\n当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。",
           "example": "false",
           "member": "bool",
           "name": "StreamModeration",
@@ -287,8 +426,8 @@
       "members": [
         {
           "disabled": false,
-          "document": "结束标志位，为 stop 则表示尾包。",
-          "example": "无",
+          "document": "结束标志位，可能为 stop 或 sensitive。\nstop 表示输出正常结束，sensitive 只在开启流式输出审核时会出现，表示安全审核未通过。",
+          "example": "stop",
           "member": "string",
           "name": "FinishReason",
           "output_required": false,
@@ -345,7 +484,7 @@
       "usage": "out"
     },
     "EmbeddingData": {
-      "document": "embedding 信息，当前不支持批量，所以数组元素数目为1。",
+      "document": "Embedding 信息。",
       "members": [
         {
           "disabled": false,
@@ -437,7 +576,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "输入文本。总长度不超过1024 个token, 超过则会截断最后面的内容。",
+          "document": "输入文本。总长度不超过 1024 个 Token，超过则会截断最后面的内容。",
           "example": "无",
           "member": "string",
           "name": "Input",
@@ -452,7 +591,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "返回的 embedding 信息。",
+          "document": "返回的 Embedding 信息。当前不支持批量，所以数组元素数目为 1。",
           "example": "无",
           "member": "EmbeddingData",
           "name": "Data",
@@ -462,7 +601,7 @@
         },
         {
           "disabled": false,
-          "document": "token 使用计数，按照总token数量收费。",
+          "document": "Token 使用计数，按照总 Token 数量收费。",
           "example": "无",
           "member": "EmbeddingUsage",
           "name": "Usage",
@@ -552,7 +691,7 @@
         },
         {
           "disabled": false,
-          "document": "消息内容",
+          "document": "文本内容",
           "example": "你好！",
           "member": "string",
           "name": "Content",

tccli/services/hunyuan/v20230901/examples.json

@@ -1,5 +1,37 @@
 {
   "actions": {
+    "ChatCompletions": [
+      {
+        "document": "system提示词",
+        "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}",
+        "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}}",
+        "title": "system参数示例"
+      },
+      {
+        "document": "多轮对话场景",
+        "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}",
+        "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}}",
+        "title": "多轮对话示例"
+      },
+      {
+        "document": "",
+        "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}",
+        "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}",
+        "title": "请求失败示例"
+      },
+      {
+        "document": "",
+        "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}",
+        "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}}",
+        "title": "流式请求成功示例"
+      },
+      {
+        "document": "",
+        "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}",
+        "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}",
+        "title": "非流式请求成功示例"
+      }
+    ],
     "ChatPro": [
       {
         "document": "system提示词",
@@ -16,7 +48,7 @@
       {
         "document": "",
         "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChatPro\n<公共请求参数>\n\n{\n    \"TopP\": 0,\n    \"Temperature\": 4.8,\n    \"Messages\": [\n        {\n            \"Role\": \"user\",\n            \"Content\": \"介绍下自己\"\n        }\n    ]\n}",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"655c67aad32b0f48f52b89b0\",\n        \"Error\": {\n            \"Code\": \"InvalidParameter\",\n            \"Message\": \"The value of Temperature should be within the range [0.0, 2.0]: 4.800000 \"\n        }\n    }\n}",
+        "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}",
         "title": "请求失败示例"
       },
       {

tccli/services/ims/v20200713/api.json

@@ -188,6 +188,7 @@
           "example": "1",
           "member": "int64",
           "name": "HitFlag",
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -197,6 +198,7 @@
           "example": "Block",
           "member": "string",
           "name": "Suggestion",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -206,6 +208,7 @@
           "example": "Porn",
           "member": "string",
           "name": "Label",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -215,6 +218,7 @@
           "example": "SexBehavior",
           "member": "string",
           "name": "SubLabel",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -224,6 +228,7 @@
           "example": "90",
           "member": "int64",
           "name": "Score",
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -233,6 +238,7 @@
           "example": "无",
           "member": "LabelResult",
           "name": "LabelResults",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },
@@ -242,6 +248,7 @@
           "example": "无",
           "member": "ObjectResult",
           "name": "ObjectResults",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },
@@ -251,6 +258,7 @@
           "example": "无",
           "member": "OcrResult",
           "name": "OcrResults",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },
@@ -260,6 +268,7 @@
           "example": "无",
           "member": "LibResult",
           "name": "LibResults",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },
@@ -269,6 +278,7 @@
           "example": "a61237dd-c2a0-43e7-a3da-d27022d39ba7",
           "member": "string",
           "name": "DataId",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -278,6 +288,7 @@
           "example": "test_1001",
           "member": "string",
           "name": "BizType",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -287,6 +298,7 @@
           "example": "无",
           "member": "string",
           "name": "Extra",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -296,6 +308,7 @@
           "example": "无",
           "member": "RecognitionResult",
           "name": "RecognitionResults",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },

tccli/services/ims/v20200713/examples.json

@@ -4,7 +4,7 @@
       {
         "document": "图片同步检测",
         "input": "POST / HTTP/1.1\nHost: ims.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ImageModeration\n<公共请求参数>\n\n{\n    \"BizType\": \"test_1001\",\n    \"DataId\": \"1213\",\n    \"FileUrl\": \"https://xxx.jpg\"\n}",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n        \"DataId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n        \"BizType\": \"test_1001\",\n        \"Suggestion\": \"Block\",\n        \"Label\": \"Porn\",\n        \"SubLabel\": \"SexBehavior\",\n        \"Score\": 90,\n        \"HitFlag\": 1,\n        \"LabelResults\": [\n            {\n                \"Scene\": \"Porn\",\n                \"Suggestion\": \"Block\",\n                \"Label\": \"Porn\",\n                \"SubLabel\": \"SexBehavior\",\n                \"Score\": 90,\n                \"Details\": [\n                    {\n                        \"Id\": 0,\n                        \"Name\": \"SexBehavior\",\n                        \"Score\": 90\n                    }\n                ]\n            }\n        ],\n        \"ObjectResults\": [\n            {\n                \"Scene\": \"QrCode\",\n                \"Suggestion\": \"Block\",\n                \"Label\": \"Ad\",\n                \"SubLabel\": \"\",\n                \"Score\": 100,\n                \"Names\": [\n                    \"QRCODE\"\n                ],\n                \"Details\": [\n                    {\n                        \"Id\": 0,\n                        \"Name\": \"QRCODE\",\n                        \"Value\": \"https://test.com/test\",\n                        \"Score\": 100,\n                        \"Location\": {\n                            \"X\": 155.01746,\n                            \"Y\": 396.01746,\n                            \"Width\": 769.9824,\n                            \"Height\": 769.98254,\n                            \"Rotate\": 0\n                        }\n                    }\n                ]\n            }\n        ],\n        \"OcrResults\": [\n            {\n                \"HitFlag\": 0,\n                \"Scene\": \"OCR\",\n                \"Suggestion\": \"Pass\",\n                \"Label\": \"Normal\",\n                \"SubLabel\": \"\",\n                \"Score\": 0,\n                \"Text\": \"hello world\",\n                \"Details\": [\n                    {\n                        \"Text\": \"hello world\",\n                        \"Label\": \"\",\n                        \"LibId\": \"\",\n                        \"LibName\": \"\",\n                        \"Keywords\": [],\n                        \"Rate\": 0,\n                        \"Score\": 0,\n                        \"Location\": {\n                            \"X\": 8,\n                            \"Y\": 0,\n                            \"Width\": 111,\n                            \"Height\": 19,\n                            \"Rotate\": 0\n                        }\n                    }\n                ]\n            }\n        ],\n        \"LibResults\": [\n            {\n                \"Scene\": \"Similar\",\n                \"Label\": \"Porn\",\n                \"SubLabel\": \"\",\n                \"Score\": 99,\n                \"Details\": [\n                    {\n                        \"LibName\": \"123\",\n                        \"Score\": 99,\n                        \"Label\": \"Porn\",\n                        \"Tag\": \"\",\n                        \"ImageId\": \"111\",\n                        \"Id\": 0,\n                        \"LibId\": \"\"\n                    }\n                ],\n                \"Suggestion\": \"Block\"\n            }\n        ],\n        \"RecognitionResults\": [\n            {\n                \"Label\": \"Scene\",\n                \"Tags\": [\n                    {\n                        \"Name\": \"MedicalImage\",\n                        \"Score\": 30,\n                        \"Location\": {\n                            \"X\": 0,\n                            \"Y\": 0,\n                            \"Width\": 0,\n                            \"Height\": 0,\n                            \"Rotate\": 0\n                        }\n                    }\n                ]\n            }\n        ],\n        \"Extra\": \"\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n        \"DataId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n        \"BizType\": \"test_1001\",\n        \"Suggestion\": \"Block\",\n        \"Label\": \"Porn\",\n        \"SubLabel\": \"SexBehavior\",\n        \"Score\": 90,\n        \"HitFlag\": 1,\n        \"LabelResults\": [\n            {\n                \"Scene\": \"Porn\",\n                \"Suggestion\": \"Block\",\n                \"Label\": \"Porn\",\n                \"SubLabel\": \"SexBehavior\",\n                \"Score\": 90,\n                \"Details\": [\n                    {\n                        \"Id\": 0,\n                        \"Name\": \"SexBehavior\",\n                        \"Score\": 90\n                    }\n                ]\n            }\n        ],\n        \"ObjectResults\": [\n            {\n                \"Scene\": \"QrCode\",\n                \"Suggestion\": \"Block\",\n                \"Label\": \"Ad\",\n                \"SubLabel\": \"\",\n                \"Score\": 100,\n                \"Names\": [\n                    \"QRCODE\"\n                ],\n                \"Details\": [\n                    {\n                        \"Id\": 0,\n                        \"Name\": \"QRCODE\",\n                        \"Value\": \"https://test.com/test\",\n                        \"Score\": 100,\n                        \"Location\": {\n                            \"X\": 155.01746,\n                            \"Y\": 396.01746,\n                            \"Width\": 769.9824,\n                            \"Height\": 769.98254,\n                            \"Rotate\": 0\n                        },\n                        \"SubLabel\": \"abc\",\n                        \"GroupId\": \"abc\",\n                        \"ObjectId\": \"abc\"\n                    }\n                ]\n            }\n        ],\n        \"OcrResults\": [\n            {\n                \"HitFlag\": 0,\n                \"Scene\": \"OCR\",\n                \"Suggestion\": \"Pass\",\n                \"Label\": \"Normal\",\n                \"SubLabel\": \"\",\n                \"Score\": 0,\n                \"Text\": \"hello world\",\n                \"Details\": [\n                    {\n                        \"Text\": \"hello world\",\n                        \"Label\": \"\",\n                        \"LibId\": \"\",\n                        \"LibName\": \"\",\n                        \"Keywords\": [],\n                        \"Rate\": 0,\n                        \"Score\": 0,\n                        \"Location\": {\n                            \"X\": 8,\n                            \"Y\": 0,\n                            \"Width\": 111,\n                            \"Height\": 19,\n                            \"Rotate\": 0\n                        }\n                    }\n                ]\n            }\n        ],\n        \"LibResults\": [\n            {\n                \"Scene\": \"Similar\",\n                \"Label\": \"Porn\",\n                \"SubLabel\": \"\",\n                \"Score\": 99,\n                \"Details\": [\n                    {\n                        \"LibName\": \"123\",\n                        \"Score\": 99,\n                        \"Label\": \"Porn\",\n                        \"Tag\": \"\",\n                        \"ImageId\": \"111\",\n                        \"Id\": 0,\n                        \"LibId\": \"\"\n                    }\n                ],\n                \"Suggestion\": \"Block\"\n            }\n        ],\n        \"RecognitionResults\": [\n            {\n                \"Label\": \"Scene\",\n                \"Tags\": [\n                    {\n                        \"Name\": \"MedicalImage\",\n                        \"Score\": 30,\n                        \"Location\": {\n                            \"X\": 0,\n                            \"Y\": 0,\n                            \"Width\": 0,\n                            \"Height\": 0,\n                            \"Rotate\": 0\n                        }\n                    }\n                ]\n            }\n        ],\n        \"Extra\": \"\"\n    }\n}",
         "title": "图片同步检测"
       }
     ]

tccli/services/ims/v20201229/api.json

@@ -1,7 +1,7 @@
 {
   "actions": {
     "CreateImageModerationAsyncTask": {
-      "document": "本接口用于提交图片文件进行异步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms/image/package) 并调整好对应的业务配置。\n### 接口使用说明：\n- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms/image/package)”开启使用图片内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含**1万张图片**识别额度，有效期为1个月。\n- 该接口为收费接口，计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。\n\n### 接口功能说明：\n- 支持对图片文件或链接进行检测，通过深度学习技术，识别可能令人反感、不安全或不适宜的违规图片内容；\n- 支持对GIF图/长图进行截帧或拆分检测；\n- 支持识别多种违规场景，包括：低俗、违法违规、色情、广告等场景；\n- 支持多种物体检测（实体、广告台标、二维码等）及图片中文本的OCR文本识别；\n- 支持根据不同的业务场景配置自定义的审核策略；\n- 支持用户自定义选择图片风险库，打击自定义识别类型的违规图片（目前仅支持黑名单配置）；\n- 支持在审核图片内容时同时关联账号或设备信息，可识别违规风险账号或设备。\n### 接口调用说明：\n- 图片尺寸支持：**长或者宽 >50分辨率**和**长或者宽<40000分辨率**,并且**图片长宽比<90:1；**\n- 图片文件分辨率支持：建议**分辨率大于256x256**，否则可能会影响识别效果；\n- 图片文件支持格式：PNG、JPG、JPEG、BMP、GIF、WEBP格式；\n- 图片文件链接支持的传输协议：HTTP、HTTPS；\n- 若传入图片文件的访问链接，则需要注意**图片下载时间限制为3秒**，为保障被检测图片的稳定性和可靠性，建议您使用腾讯云COS存储或者CDN缓存等；\n- 默认接口请求频率限制：**20次/秒**，超过此调用频率则会报错。",
+      "document": "本接口用于提交图片文件进行异步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms/image/package) 并调整好对应的业务配置。\n### 接口使用说明：\n- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms/image/package)”开启使用图片内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含**3000张图片**识别额度，有效期为15天。\n- 该接口为收费接口，计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。\n\n### 接口功能说明：\n- 支持对图片文件或链接进行检测，通过深度学习技术，识别可能令人反感、不安全或不适宜的违规图片内容；\n- 支持对GIF图/长图进行截帧或拆分检测；\n- 支持识别多种违规场景，包括：低俗、违法违规、色情、广告等场景；\n- 支持多种物体检测（实体、广告台标、二维码等）及图片中文本的OCR文本识别；\n- 支持根据不同的业务场景配置自定义的审核策略；\n- 支持用户自定义选择图片风险库，打击自定义识别类型的违规图片（目前仅支持黑名单配置）；\n- 支持在审核图片内容时同时关联账号或设备信息，可识别违规风险账号或设备。\n### 接口调用说明：\n- 图片尺寸支持：**长或者宽 >50分辨率**和**长或者宽<40000分辨率**,并且**图片长宽比<90:1；**\n- 图片文件分辨率支持：建议**分辨率大于256x256**，否则可能会影响识别效果；\n- 图片文件支持格式：PNG、JPG、JPEG、BMP、GIF、WEBP格式；\n- 图片文件链接支持的传输协议：HTTP、HTTPS；\n- 若传入图片文件的访问链接，则需要注意**图片下载时间限制为3秒**，为保障被检测图片的稳定性和可靠性，建议您使用腾讯云COS存储或者CDN缓存等；\n- 默认接口请求频率限制：**20次/秒**，超过此调用频率则会报错。",
       "input": "CreateImageModerationAsyncTaskRequest",
       "name": "图片异步检测",
       "output": "CreateImageModerationAsyncTaskResponse",
@@ -118,6 +118,7 @@
           "example": "a61237dd-c2a0-43e7-a3da-d27022d39ba7",
           "member": "string",
           "name": "DataId",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },