tccli 3.0.1102.1__py2.py3-none-any.whl → 3.0.1104.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 (102) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/aiart/v20221229/ImageToImage.md +1 -1
  3. tccli/examples/csip/v20221121/DescribeDbAssets.md +7 -0
  4. tccli/examples/csip/v20221121/DescribeOrganizationUserInfo.md +12 -1
  5. tccli/examples/cwp/v20180228/DescribePublicProxyInstallCommand.md +4 -4
  6. tccli/examples/cynosdb/v20190107/CreateCLSDelivery.md +18 -0
  7. tccli/examples/cynosdb/v20190107/DeleteCLSDelivery.md +18 -0
  8. tccli/examples/cynosdb/v20190107/DescribeInstanceCLSLogDelivery.md +18 -0
  9. tccli/examples/cynosdb/v20190107/StartCLSDelivery.md +18 -0
  10. tccli/examples/cynosdb/v20190107/StopCLSDelivery.md +18 -0
  11. tccli/examples/ess/v20201111/CreateUserVerifyUrl.md +29 -0
  12. tccli/examples/ess/v20201111/DescribeUserVerifyStatus.md +23 -0
  13. tccli/examples/hai/v20230812/DescribeInstances.md +3 -2
  14. tccli/examples/hunyuan/v20230901/QueryHunyuanImageJob.md +33 -0
  15. tccli/examples/hunyuan/v20230901/SubmitHunyuanImageJob.md +21 -0
  16. tccli/examples/iotexplorer/v20190423/CreateTRTCSignaturesWithRoomId.md +30 -0
  17. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageAIServiceTask.md +36 -0
  18. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageAIServiceTasks.md +3 -0
  19. tccli/examples/iotexplorer/v20190423/DismissRoomByStrRoomIdFromTRTC.md +20 -0
  20. tccli/examples/iotexplorer/v20190423/GenerateCloudStorageAIServiceTaskFileURL.md +24 -0
  21. tccli/examples/iotexplorer/v20190423/RemoveUserByRoomIdFromTRTC.md +21 -0
  22. tccli/examples/lighthouse/v20200324/DescribeInstancesDeniedActions.md +11 -6
  23. tccli/examples/live/v20180801/DescribeLivePadProcessorList.md +25 -0
  24. tccli/examples/live/v20180801/StopLivePadProcessor.md +23 -0
  25. tccli/examples/mrs/v20200910/DrugInstructionObject.md +98 -0
  26. tccli/examples/ssl/v20191205/DescribeDownloadCertificateUrl.md +23 -0
  27. tccli/examples/tke/v20220501/CreateNodePool.md +33 -0
  28. tccli/examples/tke/v20220501/DeleteNodePool.md +21 -0
  29. tccli/examples/tke/v20220501/DescribeNodePools.md +9 -3
  30. tccli/examples/tke/v20220501/ModifyNodePool.md +32 -0
  31. tccli/examples/waf/v20180125/CreateIpAccessControl.md +27 -0
  32. tccli/examples/waf/v20180125/DeleteIpAccessControlV2.md +25 -0
  33. tccli/examples/waf/v20180125/ImportIpAccessControl.md +30 -0
  34. tccli/examples/waf/v20180125/ModifyIpAccessControl.md +28 -0
  35. tccli/services/aiart/v20221229/api.json +3 -3
  36. tccli/services/aiart/v20221229/examples.json +1 -1
  37. tccli/services/apm/v20210622/api.json +1 -1
  38. tccli/services/batch/v20170312/api.json +1 -1
  39. tccli/services/billing/v20180709/api.json +2 -2
  40. tccli/services/captcha/v20190722/api.json +2 -2
  41. tccli/services/ccc/v20200210/api.json +3 -3
  42. tccli/services/cdb/v20170320/api.json +2 -2
  43. tccli/services/clb/v20180317/api.json +2 -2
  44. tccli/services/cls/v20201016/api.json +2 -2
  45. tccli/services/csip/v20221121/api.json +80 -2
  46. tccli/services/csip/v20221121/examples.json +4 -4
  47. tccli/services/cvm/v20170312/api.json +1 -1
  48. tccli/services/cwp/v20180228/api.json +17 -5
  49. tccli/services/cwp/v20180228/examples.json +2 -2
  50. tccli/services/cynosdb/cynosdb_client.py +269 -4
  51. tccli/services/cynosdb/v20190107/api.json +131 -0
  52. tccli/services/cynosdb/v20190107/examples.json +40 -0
  53. tccli/services/dlc/v20210125/api.json +70 -1
  54. tccli/services/ess/ess_client.py +110 -4
  55. tccli/services/ess/v20201111/api.json +185 -5
  56. tccli/services/ess/v20201111/examples.json +16 -0
  57. tccli/services/essbasic/v20210526/api.json +4 -4
  58. tccli/services/faceid/v20180301/api.json +1 -1
  59. tccli/services/fmu/v20191213/api.json +1 -1
  60. tccli/services/hai/v20230812/api.json +2 -2
  61. tccli/services/hai/v20230812/examples.json +1 -1
  62. tccli/services/hunyuan/hunyuan_client.py +110 -4
  63. tccli/services/hunyuan/v20230901/api.json +188 -4
  64. tccli/services/hunyuan/v20230901/examples.json +16 -0
  65. tccli/services/iotexplorer/iotexplorer_client.py +298 -33
  66. tccli/services/iotexplorer/v20190423/api.json +359 -20
  67. tccli/services/iotexplorer/v20190423/examples.json +41 -1
  68. tccli/services/iss/v20230517/api.json +10 -0
  69. tccli/services/lighthouse/v20200324/api.json +45 -33
  70. tccli/services/lighthouse/v20200324/examples.json +3 -3
  71. tccli/services/live/live_client.py +114 -8
  72. tccli/services/live/v20180801/api.json +124 -0
  73. tccli/services/live/v20180801/examples.json +16 -0
  74. tccli/services/lke/v20231130/api.json +109 -3
  75. tccli/services/mrs/mrs_client.py +53 -0
  76. tccli/services/mrs/v20200910/api.json +1649 -415
  77. tccli/services/mrs/v20200910/examples.json +8 -0
  78. tccli/services/ocr/v20181119/api.json +1 -1
  79. tccli/services/rce/rce_client.py +0 -53
  80. tccli/services/rce/v20201103/api.json +0 -197
  81. tccli/services/rce/v20201103/examples.json +0 -8
  82. tccli/services/ssl/ssl_client.py +57 -4
  83. tccli/services/ssl/v20191205/api.json +63 -0
  84. tccli/services/ssl/v20191205/examples.json +8 -0
  85. tccli/services/ssm/v20190923/api.json +1 -1
  86. tccli/services/tdmq/v20200217/api.json +40 -10
  87. tccli/services/teo/v20220901/api.json +34 -0
  88. tccli/services/tke/tke_client.py +171 -12
  89. tccli/services/tke/v20180525/api.json +1 -1
  90. tccli/services/tke/v20220501/api.json +1403 -86
  91. tccli/services/tke/v20220501/examples.json +25 -1
  92. tccli/services/trtc/v20190722/api.json +6 -9
  93. tccli/services/tse/v20201207/api.json +2 -2
  94. tccli/services/vpc/v20170312/api.json +1 -0
  95. tccli/services/waf/v20180125/api.json +396 -0
  96. tccli/services/waf/v20180125/examples.json +32 -0
  97. tccli/services/waf/waf_client.py +216 -4
  98. {tccli-3.0.1102.1.dist-info → tccli-3.0.1104.1.dist-info}/METADATA +2 -2
  99. {tccli-3.0.1102.1.dist-info → tccli-3.0.1104.1.dist-info}/RECORD +102 -77
  100. {tccli-3.0.1102.1.dist-info → tccli-3.0.1104.1.dist-info}/WHEEL +0 -0
  101. {tccli-3.0.1102.1.dist-info → tccli-3.0.1104.1.dist-info}/entry_points.txt +0 -0
  102. {tccli-3.0.1102.1.dist-info → tccli-3.0.1104.1.dist-info}/license_files/LICENSE +0 -0
@@ -155,7 +155,7 @@
155
155
  "status": "online"
156
156
  },
157
157
  "ChannelCreateReleaseFlow": {
158
- "document": "发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。\n解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。\n\n注意:\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>\n<li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li>\n<li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>\n</ul>",
158
+ "document": "发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。\n解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。\n\n注意:\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>\n<li>在解除协议签署完毕后,原合同及解除协议均变为已解除状态。</li>\n<li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>\n</ul>",
159
159
  "input": "ChannelCreateReleaseFlowRequest",
160
160
  "name": "发起解除协议",
161
161
  "output": "ChannelCreateReleaseFlowResponse",
@@ -5584,7 +5584,7 @@
5584
5584
  },
5585
5585
  {
5586
5586
  "disabled": false,
5587
- "document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 手写签名</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
5587
+ "document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
5588
5588
  "example": "ComponentExtra",
5589
5589
  "member": "string",
5590
5590
  "name": "ComponentExtra",
@@ -5764,7 +5764,7 @@
5764
5764
  },
5765
5765
  {
5766
5766
  "disabled": false,
5767
- "document": "签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围\n\n1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)\n\n2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)\n\n<ul><li>HANDWRITE : 手写签名</li>\n<li>OCR_ESIGN : OCR印章(智慧手写签名)</li>\n<li>ESIGN : 个人印章</li>\n<li>SYSTEM_ESIGN : 系统印章</li></ul>\n\n3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。",
5767
+ "document": "签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围\n\n1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)\n\n2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)\n\n<ul><li>HANDWRITE : 需要实时手写的手写签名</li>\n<li>HANDWRITTEN_ESIGN : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li>OCR_ESIGN : OCR印章(智慧手写签名)</li>\n<li>ESIGN : 个人印章</li>\n<li>SYSTEM_ESIGN : 系统印章</li></ul>\n\n3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。",
5768
5768
  "example": "无",
5769
5769
  "member": "string",
5770
5770
  "name": "ComponentValue",
@@ -8340,7 +8340,7 @@
8340
8340
  },
8341
8341
  {
8342
8342
  "disabled": false,
8343
- "document": "当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:\n\n<ul><li> <b>HANDWRITE</b> :手写签名。</li>\n<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>\n<li> <b>ESIGN</b> :个人印章类型。</li>\n<li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>\n<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>\n\n各种签名的样式可以参考下图:\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)",
8343
+ "document": "当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:\n\n<ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li>\n<li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名, 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>\n<li> <b>ESIGN</b> :个人印章类型。</li>\n<li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>\n<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>\n\n各种签名的样式可以参考下图:\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)",
8344
8344
  "example": "[\"OCR_ESIGN\"]",
8345
8345
  "member": "string",
8346
8346
  "name": "ComponentLimitType",
@@ -4975,7 +4975,7 @@
4975
4975
  },
4976
4976
  {
4977
4977
  "disabled": false,
4978
- "document": "业务结果详细信息。(当VerifyMode配置\"详版\",且Result为\"-4: 三要素信息不一致\"时返回)\n\n枚举值:\n\n手机号码与姓名一致,与身份证号不一致;\n\n手机号码身份证号一致,与姓名不一致;\n\n手机号码与姓名和身份证号均不一致;\n\n姓名和身份证号不一致;\n\n其他不一致。",
4978
+ "document": "业务结果详细信息。(当VerifyMode配置\"详版\",且Result为\"-4: 三要素信息不一致\"时返回)\n枚举值:\nPhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致;\nPhoneNameMismatch:手机号码身份证号一致,与姓名不一致;\nPhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致;\nNameIdCardMismatch:姓名和身份证号不一致;\nOtherMismatch:其他不一致;",
4979
4979
  "example": "无",
4980
4980
  "member": "string",
4981
4981
  "name": "ResultDetail",
@@ -756,7 +756,7 @@
756
756
  "members": [
757
757
  {
758
758
  "disabled": false,
759
- "document": "滤镜类型,取值如下: \n1.白茶;2 白皙;3.初夏;4.东京;5.告白;6.暖阳;7.蔷薇;8.清澄;9.清透;10.甜薄荷;11.默认;12.心动;13.哑灰;14.樱桃布丁;15.自然;16.清逸;17.黑白;18.水果;19.爱情;20.冬日;21.相片;22.夏日;23.香氛;24.魅惑;25.悸动;26.沙滩;27.街拍;28.甜美;29.初吻;30.午后;31.活力;32.朦胧;33.悦动;34.时尚;35.气泡;36.柠檬;37.棉花糖;38.小溪;39.丽人;40.咖啡;41.嫩芽;42.热情;43.渐暖;44.早餐;45.白茶;46.白嫩;47.圣代;48.森林;49.冲浪;50.奶咖;51.清澈;52.微风;53.日落;54.水光;55.日系;56.星光;57.阳光;58.落叶;59.生机;60.甜心;61.清逸;62.春意;63.罗马;64.青涩;65.清风;66.暖心;67.海水;68.神秘;69.旧调1;70.旧调2;71.雪顶;72.日光;73.浮云;74.流彩;75.胶片;76.回味;77.奶酪;78.蝴蝶。",
759
+ "document": "滤镜类型,取值如下: \n1.白茶1;2 白皙;3.初夏;4.东京;5.告白;6.暖阳;7.蔷薇;8.清澄;9.清透;10.甜薄荷;11.默认;12.心动;13.哑灰;14.樱桃布丁;15.自然;16.清逸1;17.黑白;18.水果;19.爱情;20.冬日;21.相片;22.夏日;23.香氛;24.魅惑;25.悸动;26.沙滩;27.街拍;28.甜美;29.初吻;30.午后;31.活力;32.朦胧;33.悦动;34.时尚;35.气泡;36.柠檬;37.棉花糖;38.小溪;39.丽人;40.咖啡;41.嫩芽;42.热情;43.渐暖;44.早餐;45.白茶2;46.白嫩;47.圣代;48.森林;49.冲浪;50.奶咖;51.清澈;52.微风;53.日落;54.水光;55.日系;56.星光;57.阳光;58.落叶;59.生机;60.甜心;61.清逸2;62.春意;63.罗马;64.青涩;65.清风;66.暖心;67.海水;68.神秘;69.旧调1;70.旧调2;71.雪顶;72.日光;73.浮云;74.流彩;75.胶片;76.回味;77.奶酪;78.蝴蝶。",
760
760
  "example": "1",
761
761
  "member": "int64",
762
762
  "name": "FilterType",
@@ -794,8 +794,8 @@
794
794
  },
795
795
  {
796
796
  "disabled": false,
797
- "document": "公网出带宽上限,默认5Mbps\n注意:此字段可能返回 null,表示取不到有效值。",
798
- "example": "5Mbps",
797
+ "document": "公网出带宽上限,默认10Mbps\n注意:此字段可能返回 null,表示取不到有效值。",
798
+ "example": "10Mbps",
799
799
  "member": "string",
800
800
  "name": "MaxOutBandwidth",
801
801
  "output_required": true,
@@ -20,7 +20,7 @@
20
20
  {
21
21
  "document": "查看指定实例hai-jklfaded的信息",
22
22
  "input": "POST / HTTP/1.1\nHost: hai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstances\n<公共请求参数>\n\n{\n \"InstanceIds\": [\n \"hai-jklfaded\"\n ],\n \"Offset\": 0,\n \"Limit\": 1\n}",
23
- "output": "{\n \"Response\": {\n \"TotalCount\": 10,\n \"InstanceSet\": [\n {\n \"InstanceId\": \"hai-jklfaded\",\n \"InstanceName\": \"abc\",\n \"InstanceState\": \"RUNNING\",\n \"ApplicationName\": \"pytorch\",\n \"BundleName\": \"基础型\",\n \"GPUPerformance\": \"8+TFlops\",\n \"GPUMemory\": \"16+GB\",\n \"CPU\": \"20C\",\n \"Memory\": \"80GB\",\n \"SystemDisk\": {\n \"DiskType\": \"CLOUD_SSD\",\n \"DiskSize\": 80\n },\n \"PrivateIpAddresses\": [\n \"1.1.1.1\"\n ],\n \"PublicIpAddresses\": [\n \"2.2.2.2\"\n ],\n \"SecurityGroupIds\": [\n \"sg-xxxxxxxx\"\n ],\n \"LatestOperation\": \"RunInstances\",\n \"LatestOperationState\": \"SUCCESS\",\n \"CreateTime\": \"2023-08-01 00:00:00\",\n \"MaxOutBandwidth\": \"5Mbps\",\n \"MaxFreeTraffic\": \"1000GB\",\n \"ConfigurationEnvironment\": \"cuda 10 | pytorch | tensorflow\",\n \"LoginServices\": [\n {\n \"ServiceName\": \"jupyter\"\n }\n ]\n }\n ],\n \"RequestId\": \"41fa870d-8592-493c-b794-9fe19f23e800\"\n }\n}",
23
+ "output": "{\n \"Response\": {\n \"TotalCount\": 10,\n \"InstanceSet\": [\n {\n \"InstanceId\": \"hai-jklfaded\",\n \"InstanceName\": \"abc\",\n \"InstanceState\": \"RUNNING\",\n \"ApplicationName\": \"pytorch\",\n \"BundleName\": \"基础型\",\n \"GPUPerformance\": \"8+TFlops\",\n \"GPUMemory\": \"16+GB\",\n \"CPU\": \"20C\",\n \"Memory\": \"80GB\",\n \"SystemDisk\": {\n \"DiskType\": \"CLOUD_SSD\",\n \"DiskSize\": 80\n },\n \"PrivateIpAddresses\": [\n \"1.1.1.1\"\n ],\n \"PublicIpAddresses\": [\n \"2.2.2.2\"\n ],\n \"SecurityGroupIds\": [\n \"sg-xxxxxxxx\"\n ],\n \"LatestOperation\": \"RunInstances\",\n \"LatestOperationState\": \"SUCCESS\",\n \"CreateTime\": \"2023-08-01 00:00:00\",\n \"MaxOutBandwidth\": \"10Mbps\",\n \"MaxFreeTraffic\": \"1000GB\",\n \"ConfigurationEnvironment\": \"cuda 10 | pytorch | tensorflow\",\n \"LoginServices\": [\n {\n \"ServiceName\": \"jupyter\"\n }\n ],\n \"OSType\": \"linux\"\n }\n ],\n \"RequestId\": \"41fa870d-8592-493c-b794-9fe19f23e800\"\n }\n}",
24
24
  "title": "查看指定实例hai-jklfaded的信息"
25
25
  }
26
26
  ],
@@ -17,7 +17,7 @@ from tencentcloud.hunyuan.v20230901 import models as models_v20230901
17
17
  from jmespath import search
18
18
  import time
19
19
 
20
- def doChatCompletions(args, parsed_globals):
20
+ def doSubmitHunyuanImageJob(args, parsed_globals):
21
21
  g_param = parse_global_arg(parsed_globals)
22
22
 
23
23
  if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -46,11 +46,11 @@ def doChatCompletions(args, parsed_globals):
46
46
  client = mod.HunyuanClient(cred, g_param[OptionsDefine.Region], profile)
47
47
  client._sdkVersion += ("_CLI_" + __version__)
48
48
  models = MODELS_MAP[g_param[OptionsDefine.Version]]
49
- model = models.ChatCompletionsRequest()
49
+ model = models.SubmitHunyuanImageJobRequest()
50
50
  model.from_json_string(json.dumps(args))
51
51
  start_time = time.time()
52
52
  while True:
53
- rsp = client.ChatCompletions(model)
53
+ rsp = client.SubmitHunyuanImageJob(model)
54
54
  result = rsp.to_json_string()
55
55
  try:
56
56
  json_obj = json.loads(result)
@@ -121,6 +121,58 @@ def doChatPro(args, parsed_globals):
121
121
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
122
122
 
123
123
 
124
+ def doQueryHunyuanImageJob(args, parsed_globals):
125
+ g_param = parse_global_arg(parsed_globals)
126
+
127
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
128
+ cred = credential.CVMRoleCredential()
129
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
130
+ cred = credential.STSAssumeRoleCredential(
131
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
132
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
133
+ )
134
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
135
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
136
+ else:
137
+ cred = credential.Credential(
138
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
139
+ )
140
+ http_profile = HttpProfile(
141
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
142
+ reqMethod="POST",
143
+ endpoint=g_param[OptionsDefine.Endpoint],
144
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
145
+ )
146
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
147
+ if g_param[OptionsDefine.Language]:
148
+ profile.language = g_param[OptionsDefine.Language]
149
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
150
+ client = mod.HunyuanClient(cred, g_param[OptionsDefine.Region], profile)
151
+ client._sdkVersion += ("_CLI_" + __version__)
152
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
153
+ model = models.QueryHunyuanImageJobRequest()
154
+ model.from_json_string(json.dumps(args))
155
+ start_time = time.time()
156
+ while True:
157
+ rsp = client.QueryHunyuanImageJob(model)
158
+ result = rsp.to_json_string()
159
+ try:
160
+ json_obj = json.loads(result)
161
+ except TypeError as e:
162
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
163
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
164
+ break
165
+ cur_time = time.time()
166
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
167
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
168
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
169
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
170
+ else:
171
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
172
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
173
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
174
+
175
+
124
176
  def doChatStd(args, parsed_globals):
125
177
  g_param = parse_global_arg(parsed_globals)
126
178
 
@@ -173,6 +225,58 @@ def doChatStd(args, parsed_globals):
173
225
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
174
226
 
175
227
 
228
+ def doChatCompletions(args, parsed_globals):
229
+ g_param = parse_global_arg(parsed_globals)
230
+
231
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
232
+ cred = credential.CVMRoleCredential()
233
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
234
+ cred = credential.STSAssumeRoleCredential(
235
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
236
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
237
+ )
238
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
239
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
240
+ else:
241
+ cred = credential.Credential(
242
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
243
+ )
244
+ http_profile = HttpProfile(
245
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
246
+ reqMethod="POST",
247
+ endpoint=g_param[OptionsDefine.Endpoint],
248
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
249
+ )
250
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
251
+ if g_param[OptionsDefine.Language]:
252
+ profile.language = g_param[OptionsDefine.Language]
253
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
254
+ client = mod.HunyuanClient(cred, g_param[OptionsDefine.Region], profile)
255
+ client._sdkVersion += ("_CLI_" + __version__)
256
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
257
+ model = models.ChatCompletionsRequest()
258
+ model.from_json_string(json.dumps(args))
259
+ start_time = time.time()
260
+ while True:
261
+ rsp = client.ChatCompletions(model)
262
+ result = rsp.to_json_string()
263
+ try:
264
+ json_obj = json.loads(result)
265
+ except TypeError as e:
266
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
267
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
268
+ break
269
+ cur_time = time.time()
270
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
271
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
272
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
273
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
274
+ else:
275
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
276
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
277
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
278
+
279
+
176
280
  def doGetTokenCount(args, parsed_globals):
177
281
  g_param = parse_global_arg(parsed_globals)
178
282
 
@@ -288,9 +392,11 @@ MODELS_MAP = {
288
392
  }
289
393
 
290
394
  ACTION_MAP = {
291
- "ChatCompletions": doChatCompletions,
395
+ "SubmitHunyuanImageJob": doSubmitHunyuanImageJob,
292
396
  "ChatPro": doChatPro,
397
+ "QueryHunyuanImageJob": doQueryHunyuanImageJob,
293
398
  "ChatStd": doChatStd,
399
+ "ChatCompletions": doChatCompletions,
294
400
  "GetTokenCount": doGetTokenCount,
295
401
  "GetEmbedding": doGetEmbedding,
296
402
 
@@ -34,6 +34,20 @@
34
34
  "name": "Token 计数",
35
35
  "output": "GetTokenCountResponse",
36
36
  "status": "online"
37
+ },
38
+ "QueryHunyuanImageJob": {
39
+ "document": "混元生图接口基于混元大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。\n提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。\n查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。\n并发任务数(并发)说明:并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。",
40
+ "input": "QueryHunyuanImageJobRequest",
41
+ "name": "查询混元生图任务",
42
+ "output": "QueryHunyuanImageJobResponse",
43
+ "status": "online"
44
+ },
45
+ "SubmitHunyuanImageJob": {
46
+ "document": "混元生图接口基于混元大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。\n提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。\n查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。\n并发任务数(并发)说明:并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。",
47
+ "input": "SubmitHunyuanImageJobRequest",
48
+ "name": "提交混元生图任务",
49
+ "output": "SubmitHunyuanImageJobResponse",
50
+ "status": "online"
37
51
  }
38
52
  },
39
53
  "metadata": {
@@ -48,8 +62,8 @@
48
62
  "members": [
49
63
  {
50
64
  "disabled": false,
51
- "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) 按需调用。",
52
- "example": "",
65
+ "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) 按需调用。",
66
+ "example": "hunyuan-standard",
53
67
  "member": "string",
54
68
  "name": "Model",
55
69
  "required": true,
@@ -85,7 +99,7 @@
85
99
  {
86
100
  "disabled": false,
87
101
  "document": "说明:\n1. 影响输出文本的多样性,取值越大,生成文本的多样性越强。\n2. 默认 1.0,取值区间为 [0.0, 1.0]。\n3. 非必要不建议使用,不合理的取值会影响效果。",
88
- "example": "",
102
+ "example": "1.0",
89
103
  "member": "float",
90
104
  "name": "TopP",
91
105
  "required": false,
@@ -94,7 +108,7 @@
94
108
  {
95
109
  "disabled": false,
96
110
  "document": "说明:\n1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。\n2. 默认 1.0,取值区间为 [0.0, 2.0]。\n3. 非必要不建议使用,不合理的取值会影响效果。",
97
- "example": "",
111
+ "example": "1.0",
98
112
  "member": "float",
99
113
  "name": "Temperature",
100
114
  "required": false,
@@ -703,6 +717,176 @@
703
717
  ],
704
718
  "usage": "both"
705
719
  },
720
+ "QueryHunyuanImageJobRequest": {
721
+ "document": "QueryHunyuanImageJob请求参数结构体",
722
+ "members": [
723
+ {
724
+ "disabled": false,
725
+ "document": "任务 ID。",
726
+ "example": "无",
727
+ "member": "string",
728
+ "name": "JobId",
729
+ "required": true,
730
+ "type": "string"
731
+ }
732
+ ],
733
+ "type": "object"
734
+ },
735
+ "QueryHunyuanImageJobResponse": {
736
+ "document": "QueryHunyuanImageJob返回参数结构体",
737
+ "members": [
738
+ {
739
+ "disabled": false,
740
+ "document": "当前任务状态码:\n1:等待中、2:运行中、4:处理失败、5:处理完成。",
741
+ "example": "无",
742
+ "member": "string",
743
+ "name": "JobStatusCode",
744
+ "output_required": false,
745
+ "type": "string",
746
+ "value_allowed_null": false
747
+ },
748
+ {
749
+ "disabled": false,
750
+ "document": "当前任务状态:排队中、处理中、处理失败或者处理完成。\n",
751
+ "example": "无",
752
+ "member": "string",
753
+ "name": "JobStatusMsg",
754
+ "output_required": false,
755
+ "type": "string",
756
+ "value_allowed_null": false
757
+ },
758
+ {
759
+ "disabled": false,
760
+ "document": "任务处理失败错误码。\n",
761
+ "example": "无",
762
+ "member": "string",
763
+ "name": "JobErrorCode",
764
+ "output_required": false,
765
+ "type": "string",
766
+ "value_allowed_null": false
767
+ },
768
+ {
769
+ "disabled": false,
770
+ "document": "任务处理失败错误信息。\n",
771
+ "example": "无",
772
+ "member": "string",
773
+ "name": "JobErrorMsg",
774
+ "output_required": false,
775
+ "type": "string",
776
+ "value_allowed_null": false
777
+ },
778
+ {
779
+ "disabled": false,
780
+ "document": "生成图 URL 列表,有效期1小时,请及时保存。\n",
781
+ "example": "无",
782
+ "member": "string",
783
+ "name": "ResultImage",
784
+ "output_required": false,
785
+ "type": "list",
786
+ "value_allowed_null": false
787
+ },
788
+ {
789
+ "disabled": false,
790
+ "document": "结果 detail 数组,Success 代表成功。\n",
791
+ "example": "无",
792
+ "member": "string",
793
+ "name": "ResultDetails",
794
+ "output_required": false,
795
+ "type": "list",
796
+ "value_allowed_null": false
797
+ },
798
+ {
799
+ "disabled": false,
800
+ "document": "对应 SubmitTextToImageProJob 接口中 Revise 参数。开启扩写时,返回扩写后的 prompt 文本。 如果关闭扩写,将直接返回原始输入的 prompt。",
801
+ "example": "无",
802
+ "member": "string",
803
+ "name": "RevisedPrompt",
804
+ "output_required": false,
805
+ "type": "list",
806
+ "value_allowed_null": false
807
+ },
808
+ {
809
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
810
+ "member": "string",
811
+ "name": "RequestId",
812
+ "type": "string"
813
+ }
814
+ ],
815
+ "type": "object"
816
+ },
817
+ "SubmitHunyuanImageJobRequest": {
818
+ "document": "SubmitHunyuanImageJob请求参数结构体",
819
+ "members": [
820
+ {
821
+ "disabled": false,
822
+ "document": "文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空,推荐使用中文。最多可传100个 utf-8 字符。",
823
+ "example": "雨中, 竹林, 小路",
824
+ "member": "string",
825
+ "name": "Prompt",
826
+ "required": true,
827
+ "type": "string"
828
+ },
829
+ {
830
+ "disabled": false,
831
+ "document": "绘画风格。\n请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格,传入风格编号。\n不传默认不指定风格。",
832
+ "example": "无",
833
+ "member": "string",
834
+ "name": "Style",
835
+ "required": false,
836
+ "type": "string"
837
+ },
838
+ {
839
+ "disabled": false,
840
+ "document": "生成图分辨率。\n支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3),不传默认使用1024:1024。",
841
+ "example": "无",
842
+ "member": "string",
843
+ "name": "Resolution",
844
+ "required": false,
845
+ "type": "string"
846
+ },
847
+ {
848
+ "disabled": false,
849
+ "document": "为生成结果图添加显式水印标识的开关,默认为1。 \n1:添加。 \n0:不添加。 \n其他数值:默认按1处理。 \n建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。",
850
+ "example": "无",
851
+ "member": "int64",
852
+ "name": "LogoAdd",
853
+ "required": false,
854
+ "type": "int"
855
+ },
856
+ {
857
+ "disabled": false,
858
+ "document": "prompt 扩写开关。1为开启,0为关闭,不传默认开启。\n开启扩写后,将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片,返回生成图片结果时将一并返回扩写后的 prompt 文本。\n如果关闭扩写,将直接使用原始输入的 prompt 生成图片。\n建议开启,在多数场景下可提升生成图片效果、丰富生成图片细节。",
859
+ "example": "无",
860
+ "member": "int64",
861
+ "name": "Revise",
862
+ "required": false,
863
+ "type": "int"
864
+ }
865
+ ],
866
+ "type": "object"
867
+ },
868
+ "SubmitHunyuanImageJobResponse": {
869
+ "document": "SubmitHunyuanImageJob返回参数结构体",
870
+ "members": [
871
+ {
872
+ "disabled": false,
873
+ "document": "任务 ID。",
874
+ "example": "无",
875
+ "member": "string",
876
+ "name": "JobId",
877
+ "output_required": false,
878
+ "type": "string",
879
+ "value_allowed_null": false
880
+ },
881
+ {
882
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
883
+ "member": "string",
884
+ "name": "RequestId",
885
+ "type": "string"
886
+ }
887
+ ],
888
+ "type": "object"
889
+ },
706
890
  "Usage": {
707
891
  "document": "Token 数量",
708
892
  "members": [
@@ -105,6 +105,22 @@
105
105
  "output": "{\n \"Response\": {\n \"RequestId\": \"c9e24deb-dd6d-4fe5-b0ca-c9292d1f1a9d\",\n \"TokenCount\": 2,\n \"CharacterCount\": 3,\n \"Tokens\": [\n \"你是\",\n \"谁\"\n ]\n }\n}",
106
106
  "title": "调用接口成功案例"
107
107
  }
108
+ ],
109
+ "QueryHunyuanImageJob": [
110
+ {
111
+ "document": "成功查询",
112
+ "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryHunyuanImageJob\n<公共请求参数>\n\n{\n \"JobId\": \"test\"\n}",
113
+ "output": "{\n \"Response\": {\n \"JobErrorCode\": \"\",\n \"JobErrorMsg\": \"\",\n \"JobStatusCode\": \"5\",\n \"JobStatusMsg\": \"处理完成\",\n \"RequestId\": \"56b2ecae-46e4-4697-87d2-dc2b3bbbc2c6\",\n \"ResultDetails\": [\n \"Success\"\n ],\n \"ResultImage\": [\n \"https:/result.jpg\"\n ],\n \"RevisedPrompt\": [\n \"摄影风格,画面主要描述一座雄伟的山峰,山顶覆盖着白雪,阳光照耀下闪耀着光芒,背景是蔚蓝的天空,镜头是全景\"\n ]\n }\n}",
114
+ "title": "成功查询"
115
+ }
116
+ ],
117
+ "SubmitHunyuanImageJob": [
118
+ {
119
+ "document": "调用成功",
120
+ "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SubmitHunyuanImageJob\n<公共请求参数>\n\n{\n \"Prompt\": \"雪山\"\n}",
121
+ "output": "{\n \"Response\": {\n \"JobId\": \"test\",\n \"RequestId\": \"d4e1f224-fa21-40bc-9ee7-4bb13abece6e\"\n }\n}",
122
+ "title": "调用成功"
123
+ }
108
124
  ]
109
125
  },
110
126
  "version": "1.0"