tencentcloud-sdk-nodejs 4.0.873 → 4.0.875
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.
- package/CHANGELOG.md +524 -0
- package/SERVICE_CHANGELOG.md +735 -44
- package/package.json +1 -1
- package/products.md +32 -32
- package/src/common/sdk_version.ts +1 -1
- package/src/services/asr/v20190614/asr_client.ts +8 -7
- package/src/services/asr/v20190614/asr_models.ts +10 -4
- package/src/services/billing/v20180709/billing_models.ts +2 -2
- package/src/services/ccc/v20200210/ccc_models.ts +1 -1
- package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +10 -0
- package/src/services/cls/v20201016/cls_models.ts +4 -0
- package/src/services/cynosdb/v20190107/cynosdb_models.ts +3 -3
- package/src/services/dc/v20180410/dc_client.ts +1 -1
- package/src/services/dc/v20180410/dc_models.ts +86 -78
- package/src/services/domain/v20180808/domain_client.ts +2 -3
- package/src/services/domain/v20180808/domain_models.ts +8 -8
- package/src/services/dsgc/v20190723/dsgc_models.ts +5 -1
- package/src/services/dts/v20180330/dts_client.ts +4 -2
- package/src/services/emr/v20190103/emr_client.ts +20 -4
- package/src/services/emr/v20190103/emr_models.ts +274 -78
- package/src/services/es/v20180416/es_models.ts +5 -0
- package/src/services/ess/v20201111/ess_client.ts +3 -4
- package/src/services/ess/v20201111/ess_models.ts +19 -4
- package/src/services/essbasic/v20210526/essbasic_client.ts +7 -4
- package/src/services/essbasic/v20210526/essbasic_models.ts +51 -5
- package/src/services/hunyuan/v20230901/hunyuan_client.ts +20 -56
- package/src/services/hunyuan/v20230901/hunyuan_models.ts +46 -226
- package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +4 -0
- package/src/services/monitor/v20180724/monitor_client.ts +10 -6
- package/src/services/monitor/v20180724/monitor_models.ts +14 -14
- package/src/services/mps/v20190612/mps_client.ts +7 -4
- package/src/services/mps/v20190612/mps_models.ts +129 -67
- package/src/services/mrs/v20200910/mrs_models.ts +142 -17
- package/src/services/ocr/v20181119/ocr_models.ts +1 -0
- package/src/services/organization/v20210331/organization_models.ts +13 -0
- package/src/services/rce/v20201103/rce_models.ts +21 -13
- package/src/services/redis/v20180412/redis_client.ts +1 -1
- package/src/services/redis/v20180412/redis_models.ts +27 -15
- package/src/services/tdmq/v20200217/tdmq_models.ts +8 -8
- package/src/services/tke/v20180525/tke_models.ts +16 -9
- package/src/services/tse/v20201207/tse_models.ts +2 -2
- package/src/services/waf/v20180125/waf_client.ts +24 -0
- package/src/services/waf/v20180125/waf_models.ts +51 -0
- package/src/services/wedata/v20210820/wedata_client.ts +2 -0
- package/src/services/wedata/v20210820/wedata_models.ts +56 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/asr/v20190614/asr_client.d.ts +8 -7
- package/tencentcloud/services/asr/v20190614/asr_client.js +8 -7
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +10 -4
- package/tencentcloud/services/billing/v20180709/billing_models.d.ts +2 -2
- package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +1 -1
- package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +10 -0
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +4 -0
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +3 -3
- package/tencentcloud/services/dc/v20180410/dc_client.d.ts +1 -1
- package/tencentcloud/services/dc/v20180410/dc_client.js +1 -1
- package/tencentcloud/services/dc/v20180410/dc_models.d.ts +86 -78
- package/tencentcloud/services/domain/v20180808/domain_client.d.ts +0 -1
- package/tencentcloud/services/domain/v20180808/domain_client.js +0 -1
- package/tencentcloud/services/domain/v20180808/domain_models.d.ts +8 -8
- package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +5 -1
- package/tencentcloud/services/dts/v20180330/dts_client.d.ts +3 -1
- package/tencentcloud/services/dts/v20180330/dts_client.js +3 -1
- package/tencentcloud/services/emr/v20190103/emr_client.d.ts +5 -1
- package/tencentcloud/services/emr/v20190103/emr_client.js +6 -0
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +268 -78
- package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -0
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +3 -4
- package/tencentcloud/services/ess/v20201111/ess_client.js +3 -4
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +19 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +6 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +6 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +50 -5
- package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.d.ts +10 -30
- package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.js +11 -35
- package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +46 -222
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +4 -0
- package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +8 -4
- package/tencentcloud/services/monitor/v20180724/monitor_client.js +8 -4
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +14 -14
- package/tencentcloud/services/mps/v20190612/mps_client.d.ts +1 -1
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +125 -66
- package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +142 -17
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +1 -0
- package/tencentcloud/services/organization/v20210331/organization_models.d.ts +13 -0
- package/tencentcloud/services/rce/v20201103/rce_models.d.ts +21 -13
- package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
- package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
- package/tencentcloud/services/redis/v20180412/redis_models.d.ts +27 -15
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +8 -8
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +16 -9
- package/tencentcloud/services/tse/v20201207/tse_models.d.ts +2 -2
- package/tencentcloud/services/waf/v20180125/waf_client.d.ts +9 -1
- package/tencentcloud/services/waf/v20180125/waf_client.js +12 -0
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +47 -0
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +54 -1
- package/test/emr.v20190103.test.js +10 -0
- package/test/hunyuan.v20230901.test.js +4 -24
- package/test/waf.v20180125.test.js +20 -0
|
@@ -188,7 +188,13 @@ export interface Component {
|
|
|
188
188
|
<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
|
|
189
189
|
<b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
|
|
190
190
|
印章的对应关系参考下图
|
|
191
|
-

|
|
191
|
+
<br><br>
|
|
192
|
+
<font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
|
|
193
|
+
<ul><li> <b>OFFICIAL</b> : 企业公章</li>
|
|
194
|
+
<li> <b>CONTRACT</b> : 合同专用章</li>
|
|
195
|
+
<li> <b>FINANCE</b> : 财务专用章</li>
|
|
196
|
+
<li> <b>PERSONNEL</b> : 人事专用章</li></ul>
|
|
197
|
+
<b>参考样例</b>:`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
|
|
192
198
|
|
|
193
199
|
<font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
|
|
194
200
|
<ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
|
|
@@ -2407,7 +2413,12 @@ export interface ChannelCreateOrganizationBatchSignUrlRequest {
|
|
|
2407
2413
|
*/
|
|
2408
2414
|
FlowIds?: Array<string>;
|
|
2409
2415
|
/**
|
|
2410
|
-
* 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。
|
|
2416
|
+
* 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。
|
|
2417
|
+
|
|
2418
|
+
<ul>
|
|
2419
|
+
<li>1. 若OpenId为空,Name和Mobile 必须提供。</li>
|
|
2420
|
+
<li>2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。 </li>
|
|
2421
|
+
</ul>
|
|
2411
2422
|
*/
|
|
2412
2423
|
OpenId?: string;
|
|
2413
2424
|
/**
|
|
@@ -2988,7 +2999,14 @@ export interface ComponentLimit {
|
|
|
2988
2999
|
/**
|
|
2989
3000
|
* 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
|
|
2990
3001
|
|
|
2991
|
-
1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id
|
|
3002
|
+
1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)或者以下印章类型
|
|
3003
|
+
|
|
3004
|
+
<ul><li> <b>OFFICIAL</b> : 企业公章</li>
|
|
3005
|
+
<li> <b>CONTRACT</b> : 合同专用章</li>
|
|
3006
|
+
<li> <b>FINANCE</b> : 财务专用章</li>
|
|
3007
|
+
<li> <b>PERSONNEL</b> : 人事专用章</li></ul>
|
|
3008
|
+
|
|
3009
|
+
注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
|
|
2992
3010
|
|
|
2993
3011
|
2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
|
|
2994
3012
|
|
|
@@ -3722,6 +3740,10 @@ export interface ChannelDescribeOrganizationSealsRequest {
|
|
|
3722
3740
|
注: `为空时查询所有类型的印章。`
|
|
3723
3741
|
*/
|
|
3724
3742
|
SealTypes?: Array<string>;
|
|
3743
|
+
/**
|
|
3744
|
+
* 查询的印章状态列表。 <ul> <li>空,只查询启用状态的印章;</li> <li>ALL,查询所有状态的印章;</li> <li>CHECKING,查询待审核的印章;</li> <li>SUCCESS,查询启用状态的印章;</li> <li>FAIL,查询印章审核拒绝的印章;</li> <li>DISABLE,查询已停用的印章;</li> <li>STOPPED,查询已终止的印章;</li> <li>VOID,查询已作废的印章;</li> <li>INVALID,查询已失效的印章;</li> </ul>
|
|
3745
|
+
*/
|
|
3746
|
+
SealStatuses?: Array<string>;
|
|
3725
3747
|
}
|
|
3726
3748
|
/**
|
|
3727
3749
|
* DescribeUsage请求参数结构体
|
|
@@ -4668,7 +4690,7 @@ export interface SignQrCode {
|
|
|
4668
4690
|
|
|
4669
4691
|
**各种场景传参说明**:
|
|
4670
4692
|
|
|
4671
|
-
<table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)ApproverOption.FillType:需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(固定)ApproverType:需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)OrganizationName:SaaS企业的名字</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li
|
|
4693
|
+
<table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)ApproverOption.FillType:需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(固定)ApproverType:需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)OrganizationName:SaaS企业的名字</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(不传)OrganizationOpenId:子企业的标识</li> <li>(不传)OpenId:企业员工标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)NotChannelOrganization:需设置为True</li> </ul> </td> </tr> </tbody> </table>
|
|
4672
4694
|
|
|
4673
4695
|
|
|
4674
4696
|
**注1**: `使用模板发起合同时,RecipientId(模板发起合同时)必传`
|
|
@@ -4851,7 +4873,7 @@ export interface FlowApproverInfo {
|
|
|
4851
4873
|
*/
|
|
4852
4874
|
NotifyType?: string;
|
|
4853
4875
|
/**
|
|
4854
|
-
* [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID
|
|
4876
|
+
* [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID,或者印章类型)或签名方式。
|
|
4855
4877
|
|
|
4856
4878
|
注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
|
|
4857
4879
|
*/
|
|
@@ -7339,6 +7361,25 @@ export interface ChannelCreateOrganizationBatchSignUrlResponse {
|
|
|
7339
7361
|
*/
|
|
7340
7362
|
RequestId?: string;
|
|
7341
7363
|
}
|
|
7364
|
+
/**
|
|
7365
|
+
* 创建嵌入式页面url个性化参数
|
|
7366
|
+
*/
|
|
7367
|
+
export interface EmbedUrlOption {
|
|
7368
|
+
/**
|
|
7369
|
+
* 合同详情页面是否展示合同控件信息
|
|
7370
|
+
<br/>true:允许在合同详情页展示控件
|
|
7371
|
+
<br/>false:不允许在合同详情页展示控件
|
|
7372
|
+
<br/>默认false,在合同详情页不展示控件
|
|
7373
|
+
*/
|
|
7374
|
+
ShowFlowDetailComponent?: boolean;
|
|
7375
|
+
/**
|
|
7376
|
+
* 模版预览页面是否展示空间信息
|
|
7377
|
+
<br/>true:允许在模版预览页展示控件
|
|
7378
|
+
<br/>false:不允许在模版预览页展示控件
|
|
7379
|
+
<br/>默认false,在模版预览页不展示控件
|
|
7380
|
+
*/
|
|
7381
|
+
ShowTemplateComponent?: boolean;
|
|
7382
|
+
}
|
|
7342
7383
|
/**
|
|
7343
7384
|
* 用量明细
|
|
7344
7385
|
*/
|
|
@@ -7867,6 +7908,10 @@ export interface ChannelCreateEmbedWebUrlRequest {
|
|
|
7867
7908
|
</ul>
|
|
7868
7909
|
*/
|
|
7869
7910
|
UserData?: string;
|
|
7911
|
+
/**
|
|
7912
|
+
* 个性化参数,用于控制页面展示内容
|
|
7913
|
+
*/
|
|
7914
|
+
Option?: EmbedUrlOption;
|
|
7870
7915
|
}
|
|
7871
7916
|
/**
|
|
7872
7917
|
* 抄送信息
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { ChatCompletionsRequest,
|
|
3
|
+
import { ChatCompletionsRequest, GetEmbeddingResponse, QueryHunyuanImageJobRequest, GetEmbeddingRequest, SubmitHunyuanImageJobResponse, GetTokenCountResponse, QueryHunyuanImageJobResponse, SubmitHunyuanImageJobRequest, GetTokenCountRequest, ChatCompletionsResponse } from "./hunyuan_models";
|
|
4
4
|
/**
|
|
5
5
|
* hunyuan client
|
|
6
6
|
* @class
|
|
@@ -8,22 +8,14 @@ import { ChatCompletionsRequest, GetTokenCountResponse, GetEmbeddingResponse, Qu
|
|
|
8
8
|
export declare class Client extends AbstractClient {
|
|
9
9
|
constructor(clientConfig: ClientConfig);
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
12
|
-
提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。
|
|
13
|
-
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
|
|
14
|
-
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
|
|
15
|
-
*/
|
|
16
|
-
SubmitHunyuanImageJob(req: SubmitHunyuanImageJobRequest, cb?: (error: string, rep: SubmitHunyuanImageJobResponse) => void): Promise<SubmitHunyuanImageJobResponse>;
|
|
17
|
-
/**
|
|
18
|
-
* <span style="font-size:1.5em;">注意:本接口将于 5 月 15 日下线;下线后将不再提供文档指引,接口本身可继续调用,建议使用 [hunyuan](https://cloud.tencent.com/document/api/1729/105701) 接入。</span>
|
|
19
|
-
|
|
20
|
-
腾讯混元大模型(hunyuan-pro)是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
|
|
11
|
+
* 腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
|
|
21
12
|
|
|
22
13
|
1. 本接口暂不支持返回图片内容。
|
|
23
|
-
2.
|
|
14
|
+
2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
24
15
|
3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
|
|
16
|
+
4. 我们推荐您使用 API Explorer,方便快速地在线调试接口和下载各语言的示例代码,[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。
|
|
25
17
|
*/
|
|
26
|
-
|
|
18
|
+
ChatCompletions(req: ChatCompletionsRequest, cb?: (error: string, rep: ChatCompletionsResponse) => void): Promise<ChatCompletionsResponse>;
|
|
27
19
|
/**
|
|
28
20
|
* 混元生图接口基于混元大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
|
|
29
21
|
提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。
|
|
@@ -32,24 +24,12 @@ export declare class Client extends AbstractClient {
|
|
|
32
24
|
*/
|
|
33
25
|
QueryHunyuanImageJob(req: QueryHunyuanImageJobRequest, cb?: (error: string, rep: QueryHunyuanImageJobResponse) => void): Promise<QueryHunyuanImageJobResponse>;
|
|
34
26
|
/**
|
|
35
|
-
*
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
1. 本接口暂不支持返回图片内容。
|
|
40
|
-
2. 默认单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
41
|
-
3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
|
|
42
|
-
*/
|
|
43
|
-
ChatStd(req: ChatStdRequest, cb?: (error: string, rep: ChatStdResponse) => void): Promise<ChatStdResponse>;
|
|
44
|
-
/**
|
|
45
|
-
* 腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
|
|
46
|
-
|
|
47
|
-
1. 本接口暂不支持返回图片内容。
|
|
48
|
-
2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
49
|
-
3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
|
|
50
|
-
4. 我们推荐您使用 API Explorer,方便快速地在线调试接口和下载各语言的示例代码,[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。
|
|
27
|
+
* 混元生图接口基于混元大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
|
|
28
|
+
提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。
|
|
29
|
+
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
|
|
30
|
+
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
|
|
51
31
|
*/
|
|
52
|
-
|
|
32
|
+
SubmitHunyuanImageJob(req: SubmitHunyuanImageJobRequest, cb?: (error: string, rep: SubmitHunyuanImageJobResponse) => void): Promise<SubmitHunyuanImageJobResponse>;
|
|
53
33
|
/**
|
|
54
34
|
* 该接口用于计算文本对应Token数、字符数。
|
|
55
35
|
*/
|
|
@@ -28,25 +28,15 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
28
28
|
super("hunyuan.tencentcloudapi.com", "2023-09-01", clientConfig);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
32
|
-
提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。
|
|
33
|
-
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
|
|
34
|
-
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
|
|
35
|
-
*/
|
|
36
|
-
async SubmitHunyuanImageJob(req, cb) {
|
|
37
|
-
return this.request("SubmitHunyuanImageJob", req, cb);
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* <span style="font-size:1.5em;">注意:本接口将于 5 月 15 日下线;下线后将不再提供文档指引,接口本身可继续调用,建议使用 [hunyuan](https://cloud.tencent.com/document/api/1729/105701) 接入。</span>
|
|
41
|
-
|
|
42
|
-
腾讯混元大模型(hunyuan-pro)是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
|
|
31
|
+
* 腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
|
|
43
32
|
|
|
44
33
|
1. 本接口暂不支持返回图片内容。
|
|
45
|
-
2.
|
|
34
|
+
2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
46
35
|
3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
|
|
36
|
+
4. 我们推荐您使用 API Explorer,方便快速地在线调试接口和下载各语言的示例代码,[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。
|
|
47
37
|
*/
|
|
48
|
-
async
|
|
49
|
-
return this.request("
|
|
38
|
+
async ChatCompletions(req, cb) {
|
|
39
|
+
return this.request("ChatCompletions", req, cb);
|
|
50
40
|
}
|
|
51
41
|
/**
|
|
52
42
|
* 混元生图接口基于混元大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
|
|
@@ -58,27 +48,13 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
58
48
|
return this.request("QueryHunyuanImageJob", req, cb);
|
|
59
49
|
}
|
|
60
50
|
/**
|
|
61
|
-
*
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
1. 本接口暂不支持返回图片内容。
|
|
66
|
-
2. 默认单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
67
|
-
3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
|
|
68
|
-
*/
|
|
69
|
-
async ChatStd(req, cb) {
|
|
70
|
-
return this.request("ChatStd", req, cb);
|
|
71
|
-
}
|
|
72
|
-
/**
|
|
73
|
-
* 腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
|
|
74
|
-
|
|
75
|
-
1. 本接口暂不支持返回图片内容。
|
|
76
|
-
2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
77
|
-
3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
|
|
78
|
-
4. 我们推荐您使用 API Explorer,方便快速地在线调试接口和下载各语言的示例代码,[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。
|
|
51
|
+
* 混元生图接口基于混元大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
|
|
52
|
+
提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。
|
|
53
|
+
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
|
|
54
|
+
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
|
|
79
55
|
*/
|
|
80
|
-
async
|
|
81
|
-
return this.request("
|
|
56
|
+
async SubmitHunyuanImageJob(req, cb) {
|
|
57
|
+
return this.request("SubmitHunyuanImageJob", req, cb);
|
|
82
58
|
}
|
|
83
59
|
/**
|
|
84
60
|
* 该接口用于计算文本对应Token数、字符数。
|
|
@@ -48,14 +48,14 @@ export interface ChatCompletionsRequest {
|
|
|
48
48
|
/**
|
|
49
49
|
* 说明:
|
|
50
50
|
1. 影响输出文本的多样性,取值越大,生成文本的多样性越强。
|
|
51
|
-
2.
|
|
51
|
+
2. 取值区间为 [0.0, 1.0],未传值时使用各模型推荐值。
|
|
52
52
|
3. 非必要不建议使用,不合理的取值会影响效果。
|
|
53
53
|
*/
|
|
54
54
|
TopP?: number;
|
|
55
55
|
/**
|
|
56
56
|
* 说明:
|
|
57
57
|
1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
|
|
58
|
-
2.
|
|
58
|
+
2. 取值区间为 [0.0, 2.0],未传值时使用各模型推荐值。
|
|
59
59
|
3. 非必要不建议使用,不合理的取值会影响效果。
|
|
60
60
|
*/
|
|
61
61
|
Temperature?: number;
|
|
@@ -69,27 +69,6 @@ export interface ChatCompletionsRequest {
|
|
|
69
69
|
*/
|
|
70
70
|
EnableEnhancement?: boolean;
|
|
71
71
|
}
|
|
72
|
-
/**
|
|
73
|
-
* GetTokenCount返回参数结构体
|
|
74
|
-
*/
|
|
75
|
-
export interface GetTokenCountResponse {
|
|
76
|
-
/**
|
|
77
|
-
* token计数
|
|
78
|
-
*/
|
|
79
|
-
TokenCount?: number;
|
|
80
|
-
/**
|
|
81
|
-
* 字符计数
|
|
82
|
-
*/
|
|
83
|
-
CharacterCount?: number;
|
|
84
|
-
/**
|
|
85
|
-
* 切分后的列表
|
|
86
|
-
*/
|
|
87
|
-
Tokens?: Array<string>;
|
|
88
|
-
/**
|
|
89
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
90
|
-
*/
|
|
91
|
-
RequestId?: string;
|
|
92
|
-
}
|
|
93
72
|
/**
|
|
94
73
|
* GetEmbedding返回参数结构体
|
|
95
74
|
*/
|
|
@@ -132,42 +111,6 @@ export interface ErrorMsg {
|
|
|
132
111
|
*/
|
|
133
112
|
Code?: number;
|
|
134
113
|
}
|
|
135
|
-
/**
|
|
136
|
-
* ChatStd返回参数结构体
|
|
137
|
-
*/
|
|
138
|
-
export interface ChatStdResponse {
|
|
139
|
-
/**
|
|
140
|
-
* Unix 时间戳,单位为秒。
|
|
141
|
-
*/
|
|
142
|
-
Created?: number;
|
|
143
|
-
/**
|
|
144
|
-
* Token 统计信息。
|
|
145
|
-
按照总 Token 数量计费。
|
|
146
|
-
*/
|
|
147
|
-
Usage?: Usage;
|
|
148
|
-
/**
|
|
149
|
-
* 免责声明。
|
|
150
|
-
*/
|
|
151
|
-
Note?: string;
|
|
152
|
-
/**
|
|
153
|
-
* 本轮对话的 ID。
|
|
154
|
-
*/
|
|
155
|
-
Id?: string;
|
|
156
|
-
/**
|
|
157
|
-
* 回复内容。
|
|
158
|
-
*/
|
|
159
|
-
Choices?: Array<Choice>;
|
|
160
|
-
/**
|
|
161
|
-
* 错误信息。
|
|
162
|
-
如果流式返回中服务处理异常,返回该错误信息。
|
|
163
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
164
|
-
*/
|
|
165
|
-
ErrorMsg?: ErrorMsg;
|
|
166
|
-
/**
|
|
167
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
|
|
168
|
-
*/
|
|
169
|
-
RequestId?: string;
|
|
170
|
-
}
|
|
171
114
|
/**
|
|
172
115
|
* GetEmbedding请求参数结构体
|
|
173
116
|
*/
|
|
@@ -177,42 +120,6 @@ export interface GetEmbeddingRequest {
|
|
|
177
120
|
*/
|
|
178
121
|
Input: string;
|
|
179
122
|
}
|
|
180
|
-
/**
|
|
181
|
-
* ChatPro返回参数结构体
|
|
182
|
-
*/
|
|
183
|
-
export interface ChatProResponse {
|
|
184
|
-
/**
|
|
185
|
-
* Unix 时间戳,单位为秒。
|
|
186
|
-
*/
|
|
187
|
-
Created?: number;
|
|
188
|
-
/**
|
|
189
|
-
* Token 统计信息。
|
|
190
|
-
按照总 Token 数量计费。
|
|
191
|
-
*/
|
|
192
|
-
Usage?: Usage;
|
|
193
|
-
/**
|
|
194
|
-
* 免责声明。
|
|
195
|
-
*/
|
|
196
|
-
Note?: string;
|
|
197
|
-
/**
|
|
198
|
-
* 本轮对话的 ID。
|
|
199
|
-
*/
|
|
200
|
-
Id?: string;
|
|
201
|
-
/**
|
|
202
|
-
* 回复内容。
|
|
203
|
-
*/
|
|
204
|
-
Choices?: Array<Choice>;
|
|
205
|
-
/**
|
|
206
|
-
* 错误信息。
|
|
207
|
-
如果流式返回中服务处理异常,返回该错误信息。
|
|
208
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
209
|
-
*/
|
|
210
|
-
ErrorMsg?: ErrorMsg;
|
|
211
|
-
/**
|
|
212
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
|
|
213
|
-
*/
|
|
214
|
-
RequestId?: string;
|
|
215
|
-
}
|
|
216
123
|
/**
|
|
217
124
|
* SubmitHunyuanImageJob返回参数结构体
|
|
218
125
|
*/
|
|
@@ -247,56 +154,25 @@ export interface Choice {
|
|
|
247
154
|
Message?: Message;
|
|
248
155
|
}
|
|
249
156
|
/**
|
|
250
|
-
*
|
|
157
|
+
* GetTokenCount返回参数结构体
|
|
251
158
|
*/
|
|
252
|
-
export interface
|
|
253
|
-
/**
|
|
254
|
-
* 聊天上下文信息。
|
|
255
|
-
说明:
|
|
256
|
-
1. 长度最多为 40,按对话时间从旧到新在数组中排列。
|
|
257
|
-
2. Message.Role 可选值:system、user、assistant。
|
|
258
|
-
其中,system 角色可选,如存在则必须位于列表的最开始。user 和 assistant 需交替出现(一问一答),以 user 提问开始和结束,且 Content 不能为空。Role 的顺序示例:[system(可选) user assistant user assistant user ...]。
|
|
259
|
-
3. Messages 中 Content 总长度不能超过 hunyuan-pro 模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。
|
|
260
|
-
*/
|
|
261
|
-
Messages: Array<Message>;
|
|
159
|
+
export interface GetTokenCountResponse {
|
|
262
160
|
/**
|
|
263
|
-
*
|
|
264
|
-
1. 影响输出文本的多样性,取值越大,生成文本的多样性越强。
|
|
265
|
-
2. 默认 1.0,取值区间为 [0.0, 1.0]。
|
|
266
|
-
3. 非必要不建议使用,不合理的取值会影响效果。
|
|
161
|
+
* token计数
|
|
267
162
|
*/
|
|
268
|
-
|
|
163
|
+
TokenCount?: number;
|
|
269
164
|
/**
|
|
270
|
-
*
|
|
271
|
-
1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
|
|
272
|
-
2. 默认 1.0,取值区间为 [0.0, 2.0]。
|
|
273
|
-
3. 非必要不建议使用,不合理的取值会影响效果。
|
|
165
|
+
* 字符计数
|
|
274
166
|
*/
|
|
275
|
-
|
|
167
|
+
CharacterCount?: number;
|
|
276
168
|
/**
|
|
277
|
-
*
|
|
278
|
-
说明:
|
|
279
|
-
1. 未传值时默认为流式调用。
|
|
280
|
-
2. 流式调用时以 SSE 协议增量返回结果。
|
|
281
|
-
3. 非流式调用时接口响应耗时较长,非必要不建议使用。
|
|
282
|
-
4. 非流式调用时只返回一次最终结果,调用方式与普通 HTTP 请求无异。
|
|
283
|
-
|
|
284
|
-
注意:
|
|
285
|
-
通过 SDK 调用时,流式和非流式调用需要用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
|
|
169
|
+
* 切分后的列表
|
|
286
170
|
*/
|
|
287
|
-
|
|
171
|
+
Tokens?: Array<string>;
|
|
288
172
|
/**
|
|
289
|
-
*
|
|
290
|
-
说明:
|
|
291
|
-
1. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。
|
|
292
|
-
2. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
|
|
293
|
-
3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
|
|
294
|
-
4. 如果未传值或值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
|
|
295
|
-
|
|
296
|
-
注意:
|
|
297
|
-
当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
|
|
173
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
298
174
|
*/
|
|
299
|
-
|
|
175
|
+
RequestId?: string;
|
|
300
176
|
}
|
|
301
177
|
/**
|
|
302
178
|
* Embedding 信息。
|
|
@@ -362,17 +238,39 @@ export interface QueryHunyuanImageJobResponse {
|
|
|
362
238
|
RequestId?: string;
|
|
363
239
|
}
|
|
364
240
|
/**
|
|
365
|
-
*
|
|
241
|
+
* SubmitHunyuanImageJob请求参数结构体
|
|
366
242
|
*/
|
|
367
|
-
export interface
|
|
243
|
+
export interface SubmitHunyuanImageJobRequest {
|
|
368
244
|
/**
|
|
369
|
-
*
|
|
245
|
+
* 文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空,推荐使用中文。最多可传100个 utf-8 字符。
|
|
370
246
|
*/
|
|
371
|
-
|
|
247
|
+
Prompt: string;
|
|
372
248
|
/**
|
|
373
|
-
*
|
|
249
|
+
* 绘画风格。
|
|
250
|
+
请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格,传入风格编号。
|
|
251
|
+
不传默认不指定风格。
|
|
374
252
|
*/
|
|
375
|
-
|
|
253
|
+
Style?: string;
|
|
254
|
+
/**
|
|
255
|
+
* 生成图分辨率。
|
|
256
|
+
支持生成以下分辨率的图片: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。
|
|
257
|
+
*/
|
|
258
|
+
Resolution?: string;
|
|
259
|
+
/**
|
|
260
|
+
* 为生成结果图添加显式水印标识的开关,默认为1。
|
|
261
|
+
1:添加。
|
|
262
|
+
0:不添加。
|
|
263
|
+
其他数值:默认按1处理。
|
|
264
|
+
建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
|
|
265
|
+
*/
|
|
266
|
+
LogoAdd?: number;
|
|
267
|
+
/**
|
|
268
|
+
* prompt 扩写开关。1为开启,0为关闭,不传默认开启。
|
|
269
|
+
开启扩写后,将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片,返回生成图片结果时将一并返回扩写后的 prompt 文本。
|
|
270
|
+
如果关闭扩写,将直接使用原始输入的 prompt 生成图片。
|
|
271
|
+
建议开启,在多数场景下可提升生成图片效果、丰富生成图片细节。
|
|
272
|
+
*/
|
|
273
|
+
Revise?: number;
|
|
376
274
|
}
|
|
377
275
|
/**
|
|
378
276
|
* 返回的内容(流式返回)
|
|
@@ -463,89 +361,15 @@ export interface ChatCompletionsResponse {
|
|
|
463
361
|
RequestId?: string;
|
|
464
362
|
}
|
|
465
363
|
/**
|
|
466
|
-
*
|
|
467
|
-
*/
|
|
468
|
-
export interface ChatStdRequest {
|
|
469
|
-
/**
|
|
470
|
-
* 聊天上下文信息。
|
|
471
|
-
说明:
|
|
472
|
-
1. 长度最多为 40,按对话时间从旧到新在数组中排列。
|
|
473
|
-
2. Message 的 Role 当前可选值:user、assistant。
|
|
474
|
-
其中,user 和 assistant 需交替出现(一问一答),以 user 提问开始和结束,且 Content 不能为空。Role 的顺序示例:[user assistant user assistant user ...]。
|
|
475
|
-
3. Messages 中 Content 总长度不能超过 hunyuan-standard 模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。
|
|
476
|
-
*/
|
|
477
|
-
Messages: Array<Message>;
|
|
478
|
-
/**
|
|
479
|
-
* 说明:
|
|
480
|
-
1. 影响输出文本的多样性,取值越大,生成文本的多样性越强。
|
|
481
|
-
2. 默认 1.0,取值区间为 [0.0, 1.0]。
|
|
482
|
-
3. 非必要不建议使用,不合理的取值会影响效果。
|
|
483
|
-
*/
|
|
484
|
-
TopP?: number;
|
|
485
|
-
/**
|
|
486
|
-
* 说明:
|
|
487
|
-
1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
|
|
488
|
-
2. 默认 1.0,取值区间为 [0.0, 2.0]。
|
|
489
|
-
3. 非必要不建议使用,不合理的取值会影响效果。
|
|
490
|
-
*/
|
|
491
|
-
Temperature?: number;
|
|
492
|
-
/**
|
|
493
|
-
* 流式调用开关。
|
|
494
|
-
说明:
|
|
495
|
-
1. 未传值时默认为流式调用。
|
|
496
|
-
2. 流式调用时以 SSE 协议增量返回结果。
|
|
497
|
-
3. 非流式调用时接口响应耗时较长,非必要不建议使用。
|
|
498
|
-
4. 非流式调用时只返回一次最终结果,调用方式与普通 HTTP 请求无异。
|
|
499
|
-
|
|
500
|
-
注意:
|
|
501
|
-
通过 SDK 调用时,流式和非流式调用需要用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
|
|
502
|
-
*/
|
|
503
|
-
Stream?: boolean;
|
|
504
|
-
/**
|
|
505
|
-
* 流式输出审核开关。
|
|
506
|
-
说明:
|
|
507
|
-
1. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。
|
|
508
|
-
2. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
|
|
509
|
-
3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
|
|
510
|
-
4. 如果未传值或值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
|
|
511
|
-
|
|
512
|
-
注意:
|
|
513
|
-
当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
|
|
514
|
-
*/
|
|
515
|
-
StreamModeration?: boolean;
|
|
516
|
-
}
|
|
517
|
-
/**
|
|
518
|
-
* SubmitHunyuanImageJob请求参数结构体
|
|
364
|
+
* Token 使用计数。
|
|
519
365
|
*/
|
|
520
|
-
export interface
|
|
521
|
-
/**
|
|
522
|
-
* 文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空,推荐使用中文。最多可传100个 utf-8 字符。
|
|
523
|
-
*/
|
|
524
|
-
Prompt: string;
|
|
525
|
-
/**
|
|
526
|
-
* 绘画风格。
|
|
527
|
-
请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格,传入风格编号。
|
|
528
|
-
不传默认不指定风格。
|
|
529
|
-
*/
|
|
530
|
-
Style?: string;
|
|
531
|
-
/**
|
|
532
|
-
* 生成图分辨率。
|
|
533
|
-
支持生成以下分辨率的图片: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。
|
|
534
|
-
*/
|
|
535
|
-
Resolution?: string;
|
|
366
|
+
export interface EmbeddingUsage {
|
|
536
367
|
/**
|
|
537
|
-
*
|
|
538
|
-
1:添加。
|
|
539
|
-
0:不添加。
|
|
540
|
-
其他数值:默认按1处理。
|
|
541
|
-
建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
|
|
368
|
+
* 输入 Token 数。
|
|
542
369
|
*/
|
|
543
|
-
|
|
370
|
+
PromptTokens?: number;
|
|
544
371
|
/**
|
|
545
|
-
*
|
|
546
|
-
开启扩写后,将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片,返回生成图片结果时将一并返回扩写后的 prompt 文本。
|
|
547
|
-
如果关闭扩写,将直接使用原始输入的 prompt 生成图片。
|
|
548
|
-
建议开启,在多数场景下可提升生成图片效果、丰富生成图片细节。
|
|
372
|
+
* 总 Token 数。
|
|
549
373
|
*/
|
|
550
|
-
|
|
374
|
+
TotalTokens?: number;
|
|
551
375
|
}
|
|
@@ -88,7 +88,9 @@ export declare class Client extends AbstractClient {
|
|
|
88
88
|
*/
|
|
89
89
|
DescribePrometheusClusterAgents(req: DescribePrometheusClusterAgentsRequest, cb?: (error: string, rep: DescribePrometheusClusterAgentsResponse) => void): Promise<DescribePrometheusClusterAgentsResponse>;
|
|
90
90
|
/**
|
|
91
|
-
*
|
|
91
|
+
* 接口功能是检查是否为prometheus新用户,已有其他功能更加全面的接口替代
|
|
92
|
+
|
|
93
|
+
判断用户是否为云原生监控新用户,即在任何地域下均未创建过监控实例的用户
|
|
92
94
|
*/
|
|
93
95
|
CheckIsPrometheusNewUser(req?: CheckIsPrometheusNewUserRequest, cb?: (error: string, rep: CheckIsPrometheusNewUserResponse) => void): Promise<CheckIsPrometheusNewUserResponse>;
|
|
94
96
|
/**
|
|
@@ -470,7 +472,7 @@ export declare class Client extends AbstractClient {
|
|
|
470
472
|
*/
|
|
471
473
|
DescribePrometheusTempSync(req: DescribePrometheusTempSyncRequest, cb?: (error: string, rep: DescribePrometheusTempSyncResponse) => void): Promise<DescribePrometheusTempSyncResponse>;
|
|
472
474
|
/**
|
|
473
|
-
* 列出 Prometheus
|
|
475
|
+
* 列出 Prometheus 服务可用区。
|
|
474
476
|
*/
|
|
475
477
|
DescribePrometheusZones(req: DescribePrometheusZonesRequest, cb?: (error: string, rep: DescribePrometheusZonesResponse) => void): Promise<DescribePrometheusZonesResponse>;
|
|
476
478
|
/**
|
|
@@ -589,7 +591,9 @@ export declare class Client extends AbstractClient {
|
|
|
589
591
|
*/
|
|
590
592
|
DescribePolicyGroupInfo(req: DescribePolicyGroupInfoRequest, cb?: (error: string, rep: DescribePolicyGroupInfoResponse) => void): Promise<DescribePolicyGroupInfoResponse>;
|
|
591
593
|
/**
|
|
592
|
-
*
|
|
594
|
+
* DescribePrometheusRecordRules 接口可完全代替该接口。近30天仅有3次调用,且都是报错请求
|
|
595
|
+
|
|
596
|
+
拉取Prometheus聚合规则yaml列表
|
|
593
597
|
*/
|
|
594
598
|
DescribePrometheusRecordRuleYaml(req: DescribePrometheusRecordRuleYamlRequest, cb?: (error: string, rep: DescribePrometheusRecordRuleYamlResponse) => void): Promise<DescribePrometheusRecordRuleYamlResponse>;
|
|
595
599
|
/**
|
|
@@ -647,7 +651,7 @@ export declare class Client extends AbstractClient {
|
|
|
647
651
|
*/
|
|
648
652
|
CreatePrometheusConfig(req: CreatePrometheusConfigRequest, cb?: (error: string, rep: CreatePrometheusConfigResponse) => void): Promise<CreatePrometheusConfigResponse>;
|
|
649
653
|
/**
|
|
650
|
-
* 列出可安装的所有 Grafana
|
|
654
|
+
* 列出可安装的所有 Grafana 插件。
|
|
651
655
|
*/
|
|
652
656
|
DescribePluginOverviews(req?: DescribePluginOverviewsRequest, cb?: (error: string, rep: DescribePluginOverviewsResponse) => void): Promise<DescribePluginOverviewsResponse>;
|
|
653
657
|
/**
|