tencentcloud-sdk-nodejs 4.1.234 → 4.1.236
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/es/common/sdk_version.js +1 -1
- package/es/services/cam/v20190116/cam_client.js +6 -0
- package/es/services/ckafka/v20190819/ckafka_client.js +0 -3
- package/es/services/cynosdb/v20190107/cynosdb_client.js +3 -0
- package/es/services/dlc/v20210125/dlc_client.js +3 -0
- package/es/services/emr/v20190103/emr_client.js +5 -2
- package/es/services/faceid/v20180301/faceid_client.js +8 -2
- package/es/services/ga2/v20250115/ga2_client.js +3 -0
- package/es/services/ioa/v20220601/ioa_client.js +3 -0
- package/es/services/lkeap/v20240522/lkeap_client.js +14 -62
- package/es/services/mna/v20210119/mna_client.js +6 -0
- package/es/services/mongodb/v20190725/mongodb_client.js +12 -0
- package/es/services/monitor/v20180724/monitor_client.js +9 -0
- package/es/services/mps/v20190612/mps_client.js +3 -0
- package/es/services/tcb/v20180608/tcb_client.js +9 -0
- package/es/services/tdmysql/v20211122/tdmysql_client.js +77 -26
- package/es/services/tione/v20211111/tione_client.js +5 -2
- package/es/services/trp/v20210515/trp_client.js +30 -6
- package/es/services/tse/v20201207/tse_client.js +115 -25
- package/es/services/waf/v20180125/waf_client.js +6 -0
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/ai3d/v20250513/ai3d_models.d.ts +1 -1
- package/tencentcloud/services/apis/v20240801/apis_models.d.ts +7 -2
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +1 -1
- package/tencentcloud/services/billing/v20180709/billing_models.d.ts +29 -47
- package/tencentcloud/services/cam/v20190116/cam_client.d.ts +9 -1
- package/tencentcloud/services/cam/v20190116/cam_client.js +12 -0
- package/tencentcloud/services/cam/v20190116/cam_models.d.ts +86 -8
- package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +52 -52
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +46 -30
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +32 -32
- package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +1 -5
- package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +0 -6
- package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +40 -70
- package/tencentcloud/services/cloudhsm/v20191112/cloudhsm_models.d.ts +58 -52
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +6 -6
- package/tencentcloud/services/config/v20220802/config_models.d.ts +53 -53
- package/tencentcloud/services/csip/v20221121/csip_models.d.ts +18 -28
- package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +4 -4
- package/tencentcloud/services/cvm/v20170312/cvm_client.js +4 -4
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +2 -12
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +43 -27
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -0
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +217 -85
- package/tencentcloud/services/dbbrain/v20191016/dbbrain_models.d.ts +2 -2
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +45 -41
- package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
- package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +272 -234
- package/tencentcloud/services/emr/v20190103/emr_client.d.ts +7 -3
- package/tencentcloud/services/emr/v20190103/emr_client.js +9 -3
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +363 -116
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +9 -13
- package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +11 -3
- package/tencentcloud/services/faceid/v20180301/faceid_client.js +15 -3
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +129 -0
- package/tencentcloud/services/ga2/v20250115/ga2_client.d.ts +5 -1
- package/tencentcloud/services/ga2/v20250115/ga2_client.js +6 -0
- package/tencentcloud/services/ga2/v20250115/ga2_models.d.ts +49 -27
- package/tencentcloud/services/ioa/v20220601/ioa_client.d.ts +5 -1
- package/tencentcloud/services/ioa/v20220601/ioa_client.js +6 -0
- package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +26 -0
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +43 -6
- package/tencentcloud/services/live/v20180801/live_models.d.ts +41 -61
- package/tencentcloud/services/lke/v20231130/lke_models.d.ts +31 -124
- package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts +22 -87
- package/tencentcloud/services/lkeap/v20240522/lkeap_client.js +29 -126
- package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts +131 -873
- package/tencentcloud/services/mna/v20210119/mna_client.d.ts +9 -1
- package/tencentcloud/services/mna/v20210119/mna_client.js +12 -0
- package/tencentcloud/services/mna/v20210119/mna_models.d.ts +56 -0
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +17 -1
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +24 -0
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +97 -19
- package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +44 -2
- package/tencentcloud/services/monitor/v20180724/monitor_client.js +49 -1
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +128 -16
- package/tencentcloud/services/mps/v20190612/mps_client.d.ts +5 -1
- package/tencentcloud/services/mps/v20190612/mps_client.js +6 -0
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +92 -65
- package/tencentcloud/services/rce/v20250425/rce_models.d.ts +1 -1
- package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +105 -94
- package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +26 -1
- package/tencentcloud/services/tcb/v20180608/tcb_client.js +31 -0
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +105 -11
- package/tencentcloud/services/tdai/v20250717/tdai_models.d.ts +14 -2
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +102 -82
- package/tencentcloud/services/tdmysql/v20211122/tdmysql_client.d.ts +95 -27
- package/tencentcloud/services/tdmysql/v20211122/tdmysql_client.js +141 -39
- package/tencentcloud/services/tdmysql/v20211122/tdmysql_models.d.ts +2753 -519
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +96 -1
- package/tencentcloud/services/tione/v20211111/tione_client.d.ts +7 -3
- package/tencentcloud/services/tione/v20211111/tione_client.js +9 -3
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +36 -6
- package/tencentcloud/services/tke/v20180525/tke_client.d.ts +1 -1
- package/tencentcloud/services/tke/v20180525/tke_client.js +1 -1
- package/tencentcloud/services/trp/v20210515/trp_client.d.ts +39 -7
- package/tencentcloud/services/trp/v20210515/trp_client.js +57 -9
- package/tencentcloud/services/trp/v20210515/trp_models.d.ts +904 -276
- package/tencentcloud/services/tse/v20201207/tse_client.d.ts +147 -27
- package/tencentcloud/services/tse/v20201207/tse_client.js +219 -39
- package/tencentcloud/services/tse/v20201207/tse_models.d.ts +1840 -215
- package/tencentcloud/services/tts/v20190823/tts_models.d.ts +1 -1
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +26 -12
- 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 +238 -40
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +64 -58
- package/tencentcloud/services/wedata/v20250806/wedata_models.d.ts +26 -195
|
@@ -3412,69 +3412,53 @@ export interface RestartLivePullStreamTaskResponse {
|
|
|
3412
3412
|
*/
|
|
3413
3413
|
export interface CreateCasterRequest {
|
|
3414
3414
|
/**
|
|
3415
|
-
*
|
|
3415
|
+
* <p>导播台名称</p>
|
|
3416
3416
|
*/
|
|
3417
3417
|
CasterName?: string;
|
|
3418
3418
|
/**
|
|
3419
|
-
*
|
|
3420
|
-
最大允许长度256
|
|
3419
|
+
* <p>导播台的描述<br>最大允许长度256</p>
|
|
3421
3420
|
*/
|
|
3422
3421
|
Description?: string;
|
|
3423
3422
|
/**
|
|
3424
|
-
*
|
|
3425
|
-
默认值为-1。
|
|
3426
|
-
当值为-1时,表示该导播台永不过期。
|
|
3427
|
-
当值为正常unix时间戳时,导播台将在该时间过期。
|
|
3428
|
-
导播台过期后,预监与主监画面将自动停止,转推自动停止。
|
|
3429
|
-
点播、直播url将停止转拉,推流url需自行停止推流。
|
|
3423
|
+
* <p>导播台的过期时间戳。值为-1或unix时间戳。<br>默认值为-1。<br>当值为-1时,表示该导播台永不过期。<br>当值为正常unix时间戳时,导播台将在该时间过期。<br>导播台过期后,预监与主监画面将自动停止,转推自动停止。<br>点播、直播url将停止转拉,推流url需自行停止推流。</p>
|
|
3430
3424
|
*/
|
|
3431
3425
|
ExpireTime?: number;
|
|
3432
3426
|
/**
|
|
3433
|
-
*
|
|
3434
|
-
默认为0,最大支持300秒
|
|
3427
|
+
* <p>导播台延时播放时间,单位为秒。<br>默认为0,最大支持300秒</p>
|
|
3435
3428
|
*/
|
|
3436
3429
|
DelayTime?: number;
|
|
3437
3430
|
/**
|
|
3438
|
-
*
|
|
3439
|
-
默认为空。
|
|
3440
|
-
允许使用通过DescribeCasterTransitionTypes接口中查询到的转场类型。
|
|
3431
|
+
* <p>导播台转场类型。<br>默认为空。<br>允许使用通过DescribeCasterTransitionTypes接口中查询到的转场类型。</p>
|
|
3441
3432
|
*/
|
|
3442
3433
|
TransitionType?: string;
|
|
3443
3434
|
/**
|
|
3444
|
-
*
|
|
3445
|
-
默认为1280,最大允许4096。
|
|
3435
|
+
* <p>导播台主监输出的宽度,单位为像素。<br>默认为1280,最大允许4096。</p>
|
|
3446
3436
|
*/
|
|
3447
3437
|
PgmWidth?: number;
|
|
3448
3438
|
/**
|
|
3449
|
-
*
|
|
3450
|
-
默认为720,最大允许2160。
|
|
3439
|
+
* <p>导播台主监输出的高度,单位为像素。<br>默认为720,最大允许2160。</p>
|
|
3451
3440
|
*/
|
|
3452
3441
|
PgmHeight?: number;
|
|
3453
3442
|
/**
|
|
3454
|
-
*
|
|
3455
|
-
默认为0,表示随源输出。
|
|
3456
|
-
最大支持60。
|
|
3443
|
+
* <p>导播台主监输出的帧率。<br>默认为0,表示随源输出。<br>最大支持60。</p>
|
|
3457
3444
|
*/
|
|
3458
3445
|
PgmFps?: number;
|
|
3459
3446
|
/**
|
|
3460
|
-
*
|
|
3461
|
-
默认为0,表示随源的码率输出。
|
|
3462
|
-
最大允许10000kbps。
|
|
3447
|
+
* <p>导播台主监输出的码率,单位为kbps。<br>默认为0,表示随源的码率输出。<br>最大允许10000kbps。</p>
|
|
3463
3448
|
*/
|
|
3464
3449
|
PgmBitRate?: number;
|
|
3465
3450
|
/**
|
|
3466
|
-
*
|
|
3467
|
-
0 通用型
|
|
3468
|
-
1 播单型。
|
|
3469
|
-
注: 本参数暂无作用。
|
|
3451
|
+
* <p>导播台的计费类型。<br>0 通用型<br>1 播单型。<br>注: 本参数暂无作用。</p>
|
|
3470
3452
|
*/
|
|
3471
3453
|
FeeType?: number;
|
|
3472
3454
|
/**
|
|
3473
|
-
*
|
|
3474
|
-
可选项:[0, 128, 192, 256]
|
|
3475
|
-
默认值为0,表示随源的音频码率输出。
|
|
3455
|
+
* <p>导播台主监输出的音频码率,单位为kbps。<br>可选项:[0, 128, 192, 256]<br>默认值为0,表示随源的音频码率输出。</p>
|
|
3476
3456
|
*/
|
|
3477
3457
|
PgmAudioBitRate?: number;
|
|
3458
|
+
/**
|
|
3459
|
+
* <p>导播台主监输出的编码方式</p><p>枚举值:</p><ul><li>h264: h264编码</li><li>h265: h265编码</li></ul><p>默认值:h264</p>
|
|
3460
|
+
*/
|
|
3461
|
+
PgmVcodec?: string;
|
|
3478
3462
|
}
|
|
3479
3463
|
/**
|
|
3480
3464
|
* AddCasterOutputInfo请求参数结构体
|
|
@@ -8195,7 +8179,7 @@ export interface DeleteCasterMarkPicInfoRequest {
|
|
|
8195
8179
|
*/
|
|
8196
8180
|
export interface CreateCasterResponse {
|
|
8197
8181
|
/**
|
|
8198
|
-
*
|
|
8182
|
+
* <p>导播台ID</p>
|
|
8199
8183
|
*/
|
|
8200
8184
|
CasterId?: number;
|
|
8201
8185
|
/**
|
|
@@ -8985,85 +8969,77 @@ export type DescribeLiveCallbackRulesRequest = null;
|
|
|
8985
8969
|
*/
|
|
8986
8970
|
export interface CasterInfo {
|
|
8987
8971
|
/**
|
|
8988
|
-
*
|
|
8972
|
+
* <p>导播台ID</p>
|
|
8989
8973
|
*/
|
|
8990
8974
|
CasterId?: number;
|
|
8991
8975
|
/**
|
|
8992
|
-
*
|
|
8976
|
+
* <p>导播台名称</p>
|
|
8993
8977
|
*/
|
|
8994
8978
|
CasterName?: string;
|
|
8995
8979
|
/**
|
|
8996
|
-
*
|
|
8980
|
+
* <p>导播台上一次启动pgm的时间,值为unix时间戳。</p>
|
|
8997
8981
|
*/
|
|
8998
8982
|
StartLiveTime?: number;
|
|
8999
8983
|
/**
|
|
9000
|
-
*
|
|
8984
|
+
* <p>导播台的描述</p>
|
|
9001
8985
|
*/
|
|
9002
8986
|
Description?: string;
|
|
9003
8987
|
/**
|
|
9004
|
-
*
|
|
8988
|
+
* <p>导播台创建时间,值为unix时间戳。</p>
|
|
9005
8989
|
*/
|
|
9006
8990
|
CreateTime?: number;
|
|
9007
8991
|
/**
|
|
9008
|
-
*
|
|
9009
|
-
0:停止状态,无预监,无主监
|
|
9010
|
-
1:无预监,有主监
|
|
9011
|
-
2:有预监,无主监
|
|
9012
|
-
3:有预监,有主监
|
|
8992
|
+
* <p>导播台状态<br>0:停止状态,无预监,无主监<br>1:无预监,有主监<br>2:有预监,无主监<br>3:有预监,有主监</p>
|
|
9013
8993
|
*/
|
|
9014
8994
|
Status?: number;
|
|
9015
8995
|
/**
|
|
9016
|
-
*
|
|
9017
|
-
默认值为-1。 当值为-1时,表示该导播台永不过期。
|
|
9018
|
-
当值为正常unix时间戳时,导播台将在该时间过期。
|
|
9019
|
-
导播台过期后,预监与主监画面将自动停止,转推自动停止。
|
|
9020
|
-
点播、直播url将停止转拉,推流url需自行停止推流。
|
|
8996
|
+
* <p>导播台的过期时间戳。值为-1或unix时间戳。<br>默认值为-1。 当值为-1时,表示该导播台永不过期。<br>当值为正常unix时间戳时,导播台将在该时间过期。<br>导播台过期后,预监与主监画面将自动停止,转推自动停止。<br>点播、直播url将停止转拉,推流url需自行停止推流。</p>
|
|
9021
8997
|
*/
|
|
9022
8998
|
ExpireTime?: number;
|
|
9023
8999
|
/**
|
|
9024
|
-
*
|
|
9000
|
+
* <p>导播台延时播放时间,单位为秒。</p>
|
|
9025
9001
|
*/
|
|
9026
9002
|
DelayTime?: number;
|
|
9027
9003
|
/**
|
|
9028
|
-
*
|
|
9004
|
+
* <p>导播台主监输出的宽度,单位为像素。</p>
|
|
9029
9005
|
*/
|
|
9030
9006
|
PgmWidth?: number;
|
|
9031
9007
|
/**
|
|
9032
|
-
*
|
|
9008
|
+
* <p>导播台主监输出的高度,单位为像素。</p>
|
|
9033
9009
|
*/
|
|
9034
9010
|
PgmHeight?: number;
|
|
9035
9011
|
/**
|
|
9036
|
-
*
|
|
9012
|
+
* <p>导播台主监输出的帧率。</p>
|
|
9037
9013
|
*/
|
|
9038
9014
|
PgmFps?: number;
|
|
9039
9015
|
/**
|
|
9040
|
-
*
|
|
9016
|
+
* <p>导播台主监输出的码率,单位为kbps</p>
|
|
9041
9017
|
*/
|
|
9042
9018
|
PgmBitRate?: number;
|
|
9043
9019
|
/**
|
|
9044
|
-
*
|
|
9020
|
+
* <p>导播台主监输出的音频码率,单位为kbps。</p>
|
|
9045
9021
|
*/
|
|
9046
9022
|
PgmAudioBitRate?: number;
|
|
9047
9023
|
/**
|
|
9048
|
-
*
|
|
9049
|
-
0 通用型 1 播单型。
|
|
9050
|
-
注: 本参数暂无作用。
|
|
9024
|
+
* <p>导播台的计费类型。<br>0 通用型 1 播单型。<br>注: 本参数暂无作用。</p>
|
|
9051
9025
|
*/
|
|
9052
9026
|
FeeType?: number;
|
|
9053
9027
|
/**
|
|
9054
|
-
*
|
|
9028
|
+
* <p>录制模板id。</p>
|
|
9055
9029
|
*/
|
|
9056
9030
|
RecordTemplateId?: number;
|
|
9057
9031
|
/**
|
|
9058
|
-
*
|
|
9059
|
-
0:未录制
|
|
9060
|
-
1:录制中
|
|
9032
|
+
* <p>录制状态。<br>0:未录制<br>1:录制中</p>
|
|
9061
9033
|
*/
|
|
9062
9034
|
RecordStatus?: number;
|
|
9063
9035
|
/**
|
|
9064
|
-
*
|
|
9036
|
+
* <p>录制接口返回的taskid</p>
|
|
9065
9037
|
*/
|
|
9066
9038
|
RecordTaskId?: string;
|
|
9039
|
+
/**
|
|
9040
|
+
* <p>导播台主监输出的编码方式</p><p>枚举值:</p><ul><li>h264: h264编码</li><li>h265: h265编码</li></ul><p>默认值:h264</p>
|
|
9041
|
+
*/
|
|
9042
|
+
PgmVcodec?: string;
|
|
9067
9043
|
}
|
|
9068
9044
|
/**
|
|
9069
9045
|
* DescribeConcurrentRecordStreamNum请求参数结构体
|
|
@@ -11318,6 +11294,10 @@ export interface ModifyCasterRequest {
|
|
|
11318
11294
|
* <p>导播台主监输出的音频码率,单位为kbps。<br>可选项:[0, 128, 192, 256]<br>默认值为0,表示随源的音频码率输出。</p>
|
|
11319
11295
|
*/
|
|
11320
11296
|
PgmAudioBitRate?: number;
|
|
11297
|
+
/**
|
|
11298
|
+
* <p>导播台主监输出的编码方式</p><p>枚举值:</p><ul><li>h264: h264编码</li><li>h265: h265编码</li></ul><p>默认值:h264</p>
|
|
11299
|
+
*/
|
|
11300
|
+
PgmVcodec?: string;
|
|
11321
11301
|
}
|
|
11322
11302
|
/**
|
|
11323
11303
|
* DescribeCasterEmergencyStatus请求参数结构体
|
|
@@ -1044,190 +1044,97 @@ export interface ClarificationConfig {
|
|
|
1044
1044
|
*/
|
|
1045
1045
|
export interface SaveDocRequest {
|
|
1046
1046
|
/**
|
|
1047
|
-
*
|
|
1048
|
-
导入知识库文档时,该参数填入知识库 ID。
|
|
1049
|
-
|
|
1047
|
+
* <p>应用ID。应用ID 获取方法参看<a href="https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa">如何获取 BotBizId</a><br>导入知识库文档时,该参数填入知识库 ID。</p>
|
|
1050
1048
|
*/
|
|
1051
1049
|
BotBizId: string;
|
|
1052
1050
|
/**
|
|
1053
|
-
*
|
|
1051
|
+
* <p>文件名,需要包含文件扩展名</p>
|
|
1054
1052
|
*/
|
|
1055
1053
|
FileName: string;
|
|
1056
1054
|
/**
|
|
1057
|
-
*
|
|
1058
|
-
pdf、doc、docx、ppt、mhtml、pptx、wps、ppsx,单个文件不超过200MB;
|
|
1059
|
-
xlsx、xls、md、txt、csv、html,单个文件不超过20MB;
|
|
1060
|
-
|
|
1061
|
-
图片支持下面类型:
|
|
1062
|
-
jpg、png、jpeg、tiff、bmp、gif,单个文件不超过50MB
|
|
1055
|
+
* <p>文档支持下面类型<br>pdf、doc、docx、ppt、mhtml、pptx、wps、ppsx,单个文件不超过200MB;<br>xlsx、xls、md、txt、csv、html,单个文件不超过20MB;</p><p>图片支持下面类型:<br>jpg、png、jpeg、tiff、bmp、gif,单个文件不超过50MB</p>
|
|
1063
1056
|
*/
|
|
1064
1057
|
FileType: string;
|
|
1065
1058
|
/**
|
|
1066
|
-
*
|
|
1059
|
+
* <p>平台cos路径,与DescribeStorageCredential接口查询UploadPath参数保持一致</p>
|
|
1067
1060
|
*/
|
|
1068
1061
|
CosUrl: string;
|
|
1069
1062
|
/**
|
|
1070
|
-
* ETag 全称为 Entity Tag,是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化 成功上传cos
|
|
1063
|
+
* <p>ETag 全称为 Entity Tag,是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化 成功上传cos后,从返回头中获取</p>
|
|
1071
1064
|
*/
|
|
1072
1065
|
ETag: string;
|
|
1073
1066
|
/**
|
|
1074
|
-
* cos_hash x-cos-hash-crc64ecma 头部中的 CRC64
|
|
1075
|
-
成功上传cos后,从返回头中获取
|
|
1076
|
-
|
|
1077
|
-
请注意:
|
|
1078
|
-
cos_hash为文档唯一性标识,与文件名无关 相同的cos_hash会被判定为重复文档
|
|
1067
|
+
* <p>cos_hash x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性<br>成功上传cos后,从返回头中获取</p><p>请注意:<br>cos_hash为文档唯一性标识,与文件名无关 相同的cos_hash会被判定为重复文档</p>
|
|
1079
1068
|
*/
|
|
1080
1069
|
CosHash: string;
|
|
1081
1070
|
/**
|
|
1082
|
-
*
|
|
1071
|
+
* <p>文件大小</p>
|
|
1083
1072
|
*/
|
|
1084
1073
|
Size: string;
|
|
1085
1074
|
/**
|
|
1086
|
-
*
|
|
1075
|
+
* <p>标签适用范围,1:全部,2:按条件。默认为1。</p>
|
|
1087
1076
|
*/
|
|
1088
1077
|
AttrRange?: number;
|
|
1089
1078
|
/**
|
|
1090
|
-
*
|
|
1079
|
+
* <p>来源(0 从本地文档导入),默认值为0</p>
|
|
1091
1080
|
*/
|
|
1092
1081
|
Source?: number;
|
|
1093
1082
|
/**
|
|
1094
|
-
*
|
|
1083
|
+
* <p>自定义链接地址, IsRefer为true的时候,该值才有意义</p>
|
|
1095
1084
|
*/
|
|
1096
1085
|
WebUrl?: string;
|
|
1097
1086
|
/**
|
|
1098
|
-
*
|
|
1087
|
+
* <p>标签引用</p>
|
|
1099
1088
|
*/
|
|
1100
1089
|
AttrLabels?: Array<AttrLabelRefer>;
|
|
1101
1090
|
/**
|
|
1102
|
-
*
|
|
1103
|
-
值为1时,WebUrl 字段不能为空,否则不生效。
|
|
1091
|
+
* <p>外部引用链接类型 0:系统链接 1:自定义链接<br>值为1时,WebUrl 字段不能为空,否则不生效。</p>
|
|
1104
1092
|
*/
|
|
1105
1093
|
ReferUrlType?: number;
|
|
1106
1094
|
/**
|
|
1107
|
-
*
|
|
1095
|
+
* <p>有效开始时间,unix秒级时间戳,默认为0</p>
|
|
1108
1096
|
*/
|
|
1109
1097
|
ExpireStart?: string;
|
|
1110
1098
|
/**
|
|
1111
|
-
*
|
|
1099
|
+
* <p>有效结束时间,unix秒级时间戳,默认为0代表永久有效</p>
|
|
1112
1100
|
*/
|
|
1113
1101
|
ExpireEnd?: string;
|
|
1114
1102
|
/**
|
|
1115
|
-
*
|
|
1103
|
+
* <p>是否显示引用的文档来源(false不显示 true显示)默认false</p>
|
|
1116
1104
|
*/
|
|
1117
1105
|
IsRefer?: boolean;
|
|
1118
1106
|
/**
|
|
1119
|
-
*
|
|
1107
|
+
* <p>文档操作类型:1:批量导入(批量导入问答对);2:文档导入(正常导入单个文档) 默认为2 <br> 请注意,opt=1的时候请从腾讯云智能体开发平台页面下载excel模板</p>
|
|
1120
1108
|
*/
|
|
1121
1109
|
Opt?: number;
|
|
1122
1110
|
/**
|
|
1123
|
-
*
|
|
1111
|
+
* <p>分类ID</p>
|
|
1124
1112
|
*/
|
|
1125
1113
|
CateBizId?: string;
|
|
1126
1114
|
/**
|
|
1127
|
-
*
|
|
1115
|
+
* <p>是否可下载,IsRefer为true并且ReferUrlType为0时,该值才有意义</p>
|
|
1128
1116
|
*/
|
|
1129
1117
|
IsDownload?: boolean;
|
|
1130
1118
|
/**
|
|
1131
|
-
*
|
|
1119
|
+
* <p>重复文档处理方式,按顺序匹配第一个满足条件的方式处理</p>
|
|
1132
1120
|
*/
|
|
1133
1121
|
DuplicateFileHandles?: Array<DuplicateFileHandle>;
|
|
1134
1122
|
/**
|
|
1135
|
-
*
|
|
1136
|
-
|
|
1137
|
-
请求参数为一个 **JSON Object**,具体格式可参见接口示例值。包含以下主要字段:
|
|
1138
|
-
|
|
1139
|
-
| 字段名 | 类型 | 说明 |
|
|
1140
|
-
|--------------------|--------|----------------------------------------|
|
|
1141
|
-
| `xlsx_splitter` | Object | **Excel(xlsx)文件切分策略配置**,仅当处理 Excel 文件时有效 |
|
|
1142
|
-
| `common_splitter` | Object | **通用文件(如 txt、pdf 等)切分策略配置**,按页或按标签切分 |
|
|
1143
|
-
| `table_style` | String | 表格内容的输出格式,如 HTML 或 Markdown |
|
|
1144
|
-
|
|
1145
|
-
---
|
|
1146
|
-
|
|
1147
|
-
## `xlsx_splitter`(Excel 切分策略)
|
|
1148
|
-
|
|
1149
|
-
用于配置 **表格文件的切分方式**。
|
|
1150
|
-
**类型:Object**
|
|
1151
|
-
|
|
1152
|
-
```json
|
|
1153
|
-
"xlsx_splitter": {
|
|
1154
|
-
"header_interval": [1, 2],
|
|
1155
|
-
"content_start": 10,
|
|
1156
|
-
"split_row": 2
|
|
1157
|
-
}
|
|
1158
|
-
```
|
|
1159
|
-
|
|
1160
|
-
### 字段说明:
|
|
1161
|
-
|
|
1162
|
-
| 字段名 | 类型 | 说明 |
|
|
1163
|
-
|-------------------|--------|----------------------------------------------------------------------|
|
|
1164
|
-
| `header_interval` | Array\<Number\> | 表头所在的行区间,格式为 `[起始行, 结束行]`,**行号从 1 开始计数**。例如 `[1, 2]` 表示第 1~2 行为表头。 |
|
|
1165
|
-
| `content_start` | Number | **表格内容的起始行号(从 1 开始)**。 |
|
|
1166
|
-
| `split_row` | Number | **切分行数**。 |
|
|
1167
|
-
|
|
1168
|
-
---
|
|
1169
|
-
## `common_splitter`(通用文件切分策略)
|
|
1170
|
-
|
|
1171
|
-
用于配置 **非 Excel 文件(如 TXT、PDF、DOCX 等)的切分方式**,支持两种策略:**按页切分(page)** 或 **按标识符切分(tag)**。
|
|
1172
|
-
|
|
1173
|
-
**类型:Object**
|
|
1174
|
-
|
|
1175
|
-
```json
|
|
1176
|
-
"common_splitter": {
|
|
1177
|
-
"splitter": "page",
|
|
1178
|
-
"page_splitter": {
|
|
1179
|
-
"chunk_length": 1000,
|
|
1180
|
-
"chunk_overlap_length": 100
|
|
1181
|
-
}
|
|
1182
|
-
}
|
|
1183
|
-
```
|
|
1184
|
-
|
|
1185
|
-
### 字段说明:
|
|
1186
|
-
|
|
1187
|
-
| 字段名 | 类型 | 说明 |
|
|
1188
|
-
|-------------------|--------|---------------------------------------------------|
|
|
1189
|
-
| `splitter` | String | 切分策略类型,可选值为:`"page"`(按页切分) 或 `"tag"`(按标识符切分)。 |
|
|
1190
|
-
| `page_splitter` | Object | **按页切分的配置**。 |
|
|
1191
|
-
| `page_splitter.chunk_length` | 1000 | **切片最大长度**。 |
|
|
1192
|
-
| `page_splitter.chunk_overlap_length` | 100 | **切片重叠长度**。 |
|
|
1193
|
-
| `tag_splitter` | Object | **自定义切分配置**。 |
|
|
1194
|
-
| `tag_splitter.tag` | Array\<String\> | **切分标识符**。 |
|
|
1195
|
-
| `tag_splitter.chunk_length`| Number | **切片最大长度**。 |
|
|
1196
|
-
| `tag_splitter.chunk_overlap_length` | Number | **切块重叠长度**。 |
|
|
1197
|
-
|
|
1198
|
-
🔹 **补充说明:**
|
|
1199
|
-
|
|
1200
|
-
- `splitter` 字段的值可以是:
|
|
1201
|
-
- `"page"`:只使用按页切分逻辑,此时只需要关心 `page_splitter` 相关字段。
|
|
1202
|
-
- `"tag"`:只使用按标识符(如分号、换行等)切分逻辑,此时关注 `tag_splitter`。
|
|
1203
|
-
---
|
|
1204
|
-
|
|
1205
|
-
## `table_style`(表格输出样式)
|
|
1206
|
-
|
|
1207
|
-
用于指定 **表格类内容(比如从 Excel 或 CSV 中提取的表格)最终以何种格式返回**,方便前端展示或后续处理。
|
|
1208
|
-
|
|
1209
|
-
**类型:String**
|
|
1210
|
-
|
|
1211
|
-
```json
|
|
1212
|
-
"table_style": "md"
|
|
1213
|
-
```
|
|
1214
|
-
|
|
1215
|
-
### 字段说明:
|
|
1216
|
-
|
|
1217
|
-
| 字段名 | 类型 | 说明 |
|
|
1218
|
-
|--------------|--------|----------------------------------------------------------------------|
|
|
1219
|
-
| `table_style` | String | 指定表格内容的输出格式。可用值:<br>• `"html"`:以 HTML 表格形式返回,适合网页展示。<br>• `"md"`:以 Markdown 表格语法返回,适合文档或 Markdown 渲染环境。|
|
|
1123
|
+
* <p>自定义切分规则</p><p>请求参数为一个 <strong>JSON Object</strong>,具体格式可参见接口示例值。包含以下主要字段:</p><table><thead><tr><th>字段名</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>xlsx_splitter</code></td><td>Object</td><td><strong>Excel(xlsx)文件切分策略配置</strong>,仅当处理 Excel 文件时有效</td></tr><tr><td><code>common_splitter</code></td><td>Object</td><td><strong>通用文件(如 txt、pdf 等)切分策略配置</strong>,按页或按标签切分</td></tr><tr><td><code>table_style</code></td><td>String</td><td>表格内容的输出格式,如 HTML 或 Markdown</td></tr></tbody></table><hr><h2 id=".3Cdx-inline-code-holder.3E.3C.2Fdx-inline-code-holder.3E.EF.BC.88Excel-.E5.88.87.E5.88.86.E7.AD.96.E7.95.A5.EF.BC.89"><code>xlsx_splitter</code>(Excel 切分策略)</h2><p>用于配置 <strong>表格文件的切分方式</strong>。<br><strong>类型:Object</strong></p><p><pre><code class="language-json"><span class="hljs-attr">"xlsx_splitter"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span> <span class="hljs-attr">"header_interval"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-number">1</span><span class="hljs-punctuation">,</span> <span class="hljs-number">2</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"content_start"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">10</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"split_row"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">2</span><span class="hljs-punctuation">}</span></code></pre></p><h3 id=".E5.AD.97.E6.AE.B5.E8.AF.B4.E6.98.8E.EF.BC.9A">字段说明:</h3><table><thead><tr><th>字段名</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>header_interval</code></td><td>Array<Number></td><td>表头所在的行区间,格式为 <code>[起始行, 结束行]</code>,<strong>行号从 1 开始计数</strong>。例如 <code>[1, 2]</code> 表示第 1~2 行为表头。</td></tr><tr><td><code>content_start</code></td><td>Number</td><td><strong>表格内容的起始行号(从 1 开始)</strong>。</td></tr><tr><td><code>split_row</code></td><td>Number</td><td><strong>切分行数</strong>。</td></tr></tbody></table><hr><h2 id=".3Cdx-inline-code-holder.3E.3C.2Fdx-inline-code-holder.3E.EF.BC.88.E9.80.9A.E7.94.A8.E6.96.87.E4.BB.B6.E5.88.87.E5.88.86.E7.AD.96.E7.95.A5.EF.BC.89"><code>common_splitter</code>(通用文件切分策略)</h2><p>用于配置 <strong>非 Excel 文件(如 TXT、PDF、DOCX 等)的切分方式</strong>,支持两种策略:<strong>按页切分(page)</strong> 或 <strong>按标识符切分(tag)</strong>。</p><p><strong>类型:Object</strong></p><p><pre><code class="language-json"><span class="hljs-attr">"common_splitter"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span> <span class="hljs-attr">"splitter"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"page"</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"page_splitter"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span> <span class="hljs-attr">"chunk_length"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">1000</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"chunk_overlap_length"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">100</span> <span class="hljs-punctuation">}</span><span class="hljs-punctuation">}</span></code></pre></p><h3 id=".E5.AD.97.E6.AE.B5.E8.AF.B4.E6.98.8E.EF.BC.9A2">字段说明:</h3><table><thead><tr><th>字段名</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>splitter</code></td><td>String</td><td>切分策略类型,可选值为:<code>"page"</code>(按页切分) 或 <code>"tag"</code>(按标识符切分)。</td></tr><tr><td><code>page_splitter</code></td><td>Object</td><td><strong>按页切分的配置</strong>。</td></tr><tr><td><code>page_splitter.chunk_length</code></td><td>1000</td><td><strong>切片最大长度</strong>。</td></tr><tr><td><code>page_splitter.chunk_overlap_length</code></td><td>100</td><td><strong>切片重叠长度</strong>。</td></tr><tr><td><code>tag_splitter</code></td><td>Object</td><td><strong>自定义切分配置</strong>。</td></tr><tr><td><code>tag_splitter.tag</code></td><td>Array<String></td><td><strong>切分标识符</strong>。</td></tr><tr><td><code>tag_splitter.chunk_length</code></td><td>Number</td><td><strong>切片最大长度</strong>。</td></tr><tr><td><code>tag_splitter.chunk_overlap_length</code></td><td>Number</td><td><strong>切块重叠长度</strong>。</td></tr></tbody></table><p>???? <strong>补充说明:</strong></p><ul><li><code>splitter</code> 字段的值可以是:<ul><li><code>"page"</code>:只使用按页切分逻辑,此时只需要关心 <code>page_splitter</code> 相关字段。</li><li><code>"tag"</code>:只使用按标识符(如分号、换行等)切分逻辑,此时关注 <code>tag_splitter</code>。</li></ul></li></ul><hr><h2 id=".3Cdx-inline-code-holder.3E.3C.2Fdx-inline-code-holder.3E.EF.BC.88.E8.A1.A8.E6.A0.BC.E8.BE.93.E5.87.BA.E6.A0.B7.E5.BC.8F.EF.BC.89"><code>table_style</code>(表格输出样式)</h2><p>用于指定 <strong>表格类内容(比如从 Excel 或 CSV 中提取的表格)最终以何种格式返回</strong>,方便前端展示或后续处理。</p><p><strong>类型:String</strong></p><p><pre><code class="language-json"><span class="hljs-attr">"table_style"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"md"</span></code></pre></p><h3 id=".E5.AD.97.E6.AE.B5.E8.AF.B4.E6.98.8E.EF.BC.9A3">字段说明:</h3><table><thead><tr><th>字段名</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>table_style</code></td><td>String</td><td>指定表格内容的输出格式。可用值:<br>• <code>"html"</code>:以 HTML 表格形式返回,适合网页展示。<br>• <code>"md"</code>:以 Markdown 表格语法返回,适合文档或 Markdown 渲染环境。</td></tr></tbody></table>
|
|
1220
1124
|
*/
|
|
1221
1125
|
SplitRule?: string;
|
|
1222
1126
|
/**
|
|
1223
|
-
*
|
|
1127
|
+
* <p>文档更新频率,默认值为0不更新</p>
|
|
1224
1128
|
*/
|
|
1225
1129
|
UpdatePeriodInfo?: UpdatePeriodInfo;
|
|
1226
1130
|
/**
|
|
1227
|
-
*
|
|
1228
|
-
默认值:应用内默认知识库为2,共享知识库为4。
|
|
1131
|
+
* <p>文档生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效<br>默认值:应用内默认知识库为2,共享知识库为4。</p>
|
|
1229
1132
|
*/
|
|
1230
1133
|
EnableScope?: number;
|
|
1134
|
+
/**
|
|
1135
|
+
* <p>文件url 文件的 FileUrl、CosUrl必须提供一个,如果都提供,只使用CosUrl</p>
|
|
1136
|
+
*/
|
|
1137
|
+
FileUrl?: string;
|
|
1231
1138
|
}
|
|
1232
1139
|
/**
|
|
1233
1140
|
* ListSharedKnowledge返回参数结构体
|
|
@@ -10457,23 +10364,23 @@ export interface KnowledgeDetailInfo {
|
|
|
10457
10364
|
*/
|
|
10458
10365
|
export interface SaveDocResponse {
|
|
10459
10366
|
/**
|
|
10460
|
-
*
|
|
10367
|
+
* <p>文档ID</p>
|
|
10461
10368
|
*/
|
|
10462
10369
|
DocBizId?: string;
|
|
10463
10370
|
/**
|
|
10464
|
-
*
|
|
10371
|
+
* <p>导入错误信息</p>
|
|
10465
10372
|
*/
|
|
10466
10373
|
ErrorMsg?: string;
|
|
10467
10374
|
/**
|
|
10468
|
-
*
|
|
10375
|
+
* <p>错误链接</p>
|
|
10469
10376
|
*/
|
|
10470
10377
|
ErrorLink?: string;
|
|
10471
10378
|
/**
|
|
10472
|
-
*
|
|
10379
|
+
* <p>错误链接文本</p>
|
|
10473
10380
|
*/
|
|
10474
10381
|
ErrorLinkText?: string;
|
|
10475
10382
|
/**
|
|
10476
|
-
*
|
|
10383
|
+
* <p>重复类型,0:未重复,其他取值请参考入参DuplicateFileHandle结构体的CheckType字段</p>
|
|
10477
10384
|
*/
|
|
10478
10385
|
DuplicateFileCheckType?: number;
|
|
10479
10386
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { ChatCompletionsRequest, CreateSplitDocumentFlowRequest,
|
|
3
|
+
import { ChatCompletionsRequest, CreateSplitDocumentFlowRequest, ReconstructDocumentSSEResponse, GetEmbeddingRequest, GetReconstructDocumentResultRequest, CancelTaskRequest, GetCharacterUsageRequest, GetReconstructDocumentResultResponse, RunRerankRequest, CreateSplitDocumentFlowResponse, ReconstructDocumentSSERequest, CreateReconstructDocumentFlowRequest, GetSplitDocumentResultResponse, CancelTaskResponse, GetEmbeddingResponse, QueryRewriteRequest, RunRerankResponse, CreateReconstructDocumentFlowResponse, QueryRewriteResponse, GetSplitDocumentResultRequest, ChatCompletionsResponse, GetCharacterUsageResponse } from "./lkeap_models";
|
|
4
4
|
/**
|
|
5
5
|
* lkeap client
|
|
6
6
|
* @class
|
|
@@ -8,25 +8,29 @@ import { ChatCompletionsRequest, CreateSplitDocumentFlowRequest, ListQAsRequest,
|
|
|
8
8
|
export declare class Client extends AbstractClient {
|
|
9
9
|
constructor(clientConfig: ClientConfig);
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* 多轮改写(QueryRewrite)主要用于多轮对话中,进行指代消解和省略补全。使用本接口,无需输入prompt描述,根据对话历史即可生成更精确的用户查询。在应用场景上,本接口可应用于智能问答、对话式搜索等多种场景。
|
|
12
|
+
开通[产品体验](https://lke.cloud.tencent.com/lke/#/trialProduct)后可获得50wtoken体验额度。本接口(QueryRewrite)有单账号调用上限控制,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
12
13
|
*/
|
|
13
|
-
|
|
14
|
+
QueryRewrite(req: QueryRewriteRequest, cb?: (error: string, rep: QueryRewriteResponse) => void): Promise<QueryRewriteResponse>;
|
|
14
15
|
/**
|
|
15
|
-
*
|
|
16
|
+
* 本接口为异步接口的发起请求接口,用于发起文档解析任务。
|
|
17
|
+
文档解析支持将图片或PDF、DOCX、PPTX、EXCEL等文件转换成Markdown格式文件,可解析包括表格、公式、图片、标题、段落、页眉、页脚等内容元素,并将内容智能转换成阅读顺序。具体支持文件类型请查看下方输入参数列表。
|
|
18
|
+
|
|
19
|
+
体验期间单账号限制qps仅为1,若有正式接入需要请与产研团队沟通开放。
|
|
16
20
|
*/
|
|
17
|
-
|
|
21
|
+
CreateReconstructDocumentFlow(req: CreateReconstructDocumentFlowRequest, cb?: (error: string, rep: CreateReconstructDocumentFlowResponse) => void): Promise<CreateReconstructDocumentFlowResponse>;
|
|
18
22
|
/**
|
|
19
|
-
*
|
|
23
|
+
* 获取字符使用量统计
|
|
20
24
|
*/
|
|
21
|
-
|
|
25
|
+
GetCharacterUsage(req?: GetCharacterUsageRequest, cb?: (error: string, rep: GetCharacterUsageResponse) => void): Promise<GetCharacterUsageResponse>;
|
|
22
26
|
/**
|
|
23
27
|
* 查询文档拆分任务结果
|
|
24
28
|
*/
|
|
25
29
|
GetSplitDocumentResult(req: GetSplitDocumentResultRequest, cb?: (error: string, rep: GetSplitDocumentResultResponse) => void): Promise<GetSplitDocumentResultResponse>;
|
|
26
30
|
/**
|
|
27
|
-
*
|
|
31
|
+
* 用于创建一个文档拆分任务,支持多种文件类型,具备mllm能力,能够解析并深入理解图表中的信息。
|
|
28
32
|
*/
|
|
29
|
-
|
|
33
|
+
CreateSplitDocumentFlow(req: CreateSplitDocumentFlowRequest, cb?: (error: string, rep: CreateSplitDocumentFlowResponse) => void): Promise<CreateSplitDocumentFlowResponse>;
|
|
30
34
|
/**
|
|
31
35
|
* 准实时文档解析接口,使用HTTP SSE 协议通信。
|
|
32
36
|
支持将图片或PDF文件转换成Markdown格式文件,可解析包括表格、公式、图片、标题、段落、页眉、页脚等内容元素,并将内容智能转换成阅读顺序。
|
|
@@ -34,92 +38,18 @@ export declare class Client extends AbstractClient {
|
|
|
34
38
|
输出:正常阅读顺序的md文件、识别结果的json(可选)等
|
|
35
39
|
*/
|
|
36
40
|
ReconstructDocumentSSE(req: ReconstructDocumentSSERequest, cb?: (error: string, rep: ReconstructDocumentSSEResponse) => void): Promise<ReconstructDocumentSSEResponse>;
|
|
37
|
-
/**
|
|
38
|
-
* 用于删除已有的文档。 使用场景:当某个文档不再需要时,可以将其删除以保持文档库的整洁。
|
|
39
|
-
*/
|
|
40
|
-
DeleteDocs(req: DeleteDocsRequest, cb?: (error: string, rep: DeleteDocsResponse) => void): Promise<DeleteDocsResponse>;
|
|
41
|
-
/**
|
|
42
|
-
* 用于删除已有的问答对。 使用场景:当某个问答对不再适用或需要移除时使用。
|
|
43
|
-
*/
|
|
44
|
-
DeleteQAs(req: DeleteQAsRequest, cb?: (error: string, rep: DeleteQAsResponse) => void): Promise<DeleteQAsResponse>;
|
|
45
|
-
/**
|
|
46
|
-
* 多轮改写(QueryRewrite)主要用于多轮对话中,进行指代消解和省略补全。使用本接口,无需输入prompt描述,根据对话历史即可生成更精确的用户查询。在应用场景上,本接口可应用于智能问答、对话式搜索等多种场景。
|
|
47
|
-
开通[产品体验](https://lke.cloud.tencent.com/lke/#/trialProduct)后可获得50wtoken体验额度。本接口(QueryRewrite)有单账号调用上限控制,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
48
|
-
*/
|
|
49
|
-
QueryRewrite(req: QueryRewriteRequest, cb?: (error: string, rep: QueryRewriteResponse) => void): Promise<QueryRewriteResponse>;
|
|
50
|
-
/**
|
|
51
|
-
* 本接口(GetEmbedding)调用文本表示模型,将文本转化为用数值表示的向量形式,可用于文本检索、信息推荐、知识挖掘等场景。
|
|
52
|
-
本接口(GetEmbedding)有单账号调用上限控制,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
53
|
-
*/
|
|
54
|
-
GetEmbedding(req: GetEmbeddingRequest, cb?: (error: string, rep: GetEmbeddingResponse) => void): Promise<GetEmbeddingResponse>;
|
|
55
|
-
/**
|
|
56
|
-
* 用于修改已有的属性标签。 使用场景:当需要更改属性标签的名称或描述时使用,比如将“售后”标签改为“售前”。
|
|
57
|
-
*/
|
|
58
|
-
ModifyAttributeLabel(req: ModifyAttributeLabelRequest, cb?: (error: string, rep: ModifyAttributeLabelResponse) => void): Promise<ModifyAttributeLabelResponse>;
|
|
59
41
|
/**
|
|
60
42
|
* 基于知识引擎精调模型技术的rerank模型,支持对多路召回的结果进行重排序,根据query与切片内容的相关性,按照顺序给出每一条结果和query的相关性分数。
|
|
61
43
|
*/
|
|
62
44
|
RunRerank(req: RunRerankRequest, cb?: (error: string, rep: RunRerankResponse) => void): Promise<RunRerankResponse>;
|
|
63
45
|
/**
|
|
64
|
-
*
|
|
65
|
-
*/
|
|
66
|
-
CancelTask(req: CancelTaskRequest, cb?: (error: string, rep: CancelTaskResponse) => void): Promise<CancelTaskResponse>;
|
|
67
|
-
/**
|
|
68
|
-
* 用于获取所有问答对的列表。 使用场景:用于查看当前系统中所有已有的问答对,方便进行管理和维护。
|
|
69
|
-
*/
|
|
70
|
-
ListQAs(req: ListQAsRequest, cb?: (error: string, rep: ListQAsResponse) => void): Promise<ListQAsResponse>;
|
|
71
|
-
/**
|
|
72
|
-
* 用于删除不再需要的属性标签。 使用场景:当某个标签不再使用时,可以将其删除以保持标签系统的整洁。
|
|
73
|
-
*/
|
|
74
|
-
DeleteAttributeLabels(req: DeleteAttributeLabelsRequest, cb?: (error: string, rep: DeleteAttributeLabelsResponse) => void): Promise<DeleteAttributeLabelsResponse>;
|
|
75
|
-
/**
|
|
76
|
-
* 用于为问答对创建属性标签,以便对内容进行分类和管理。 使用场景:当需要为问答对添加分类标签和属性标记时使用,比如为问答对添加“售后”标签。
|
|
77
|
-
*/
|
|
78
|
-
CreateAttributeLabel(req: CreateAttributeLabelRequest, cb?: (error: string, rep: CreateAttributeLabelResponse) => void): Promise<CreateAttributeLabelResponse>;
|
|
79
|
-
/**
|
|
80
|
-
* 本接口为异步接口的发起请求接口,用于发起文档解析任务。
|
|
81
|
-
文档解析支持将图片或PDF、DOCX、PPTX、EXCEL等文件转换成Markdown格式文件,可解析包括表格、公式、图片、标题、段落、页眉、页脚等内容元素,并将内容智能转换成阅读顺序。具体支持文件类型请查看下方输入参数列表。
|
|
82
|
-
|
|
83
|
-
体验期间单账号限制qps仅为1,若有正式接入需要请与产研团队沟通开放。
|
|
84
|
-
*/
|
|
85
|
-
CreateReconstructDocumentFlow(req: CreateReconstructDocumentFlowRequest, cb?: (error: string, rep: CreateReconstructDocumentFlowResponse) => void): Promise<CreateReconstructDocumentFlowResponse>;
|
|
86
|
-
/**
|
|
87
|
-
* 用于获取所有属性标签的列表。 使用场景:用于查看当前系统中所有已有的属性标签,方便进行管理和维护。
|
|
88
|
-
*/
|
|
89
|
-
ListAttributeLabels(req: ListAttributeLabelsRequest, cb?: (error: string, rep: ListAttributeLabelsResponse) => void): Promise<ListAttributeLabelsResponse>;
|
|
90
|
-
/**
|
|
91
|
-
* 用于获取所有文档的列表。 使用场景:用于查看当前系统中所有已有的文档,方便进行管理和维护。
|
|
92
|
-
*/
|
|
93
|
-
ListDocs(req: ListDocsRequest, cb?: (error: string, rep: ListDocsResponse) => void): Promise<ListDocsResponse>;
|
|
94
|
-
/**
|
|
95
|
-
* 用于在系统中创建一个新的知识库。知识库是一个用于存储和管理知识条目的集合,可以包括文档、问答对、属性标签等。创建知识库后,可以向其中添加各种知识条目,以便在后续的知识检索中使用。 使用场景:当需要在系统中建立一个新的知识库以存储和管理特定领域或项目的知识条目时使用。例如,一个用户可能需要创建一个知识库,以存储用户指南、常见问题解答和技术文档。体验用户最多可创建3个知识库,付费用户最多可创建100个知识库。
|
|
96
|
-
*/
|
|
97
|
-
CreateKnowledgeBase(req?: CreateKnowledgeBaseRequest, cb?: (error: string, rep: CreateKnowledgeBaseResponse) => void): Promise<CreateKnowledgeBaseResponse>;
|
|
98
|
-
/**
|
|
99
|
-
* 用于批量导入问答对,最多支持50,000条数据导入。通过此接口,可以将多个问答对一次性导入系统中,以便在后续的知识检索中使用。导入的问答对可以来自外部系统、文件或其他数据源。使用场景:当需要一次性导入大量的问答对时使用。例如,一个公司可能需要将其产品的常见问题解答从一个文档或外部系统批量导入到知识库中,以便用户可以通过知识检索系统进行查询。
|
|
100
|
-
*/
|
|
101
|
-
ImportQAs(req: ImportQAsRequest, cb?: (error: string, rep: ImportQAsResponse) => void): Promise<ImportQAsResponse>;
|
|
102
|
-
/**
|
|
103
|
-
* 用于创建新的问答对。问答对可以在SearchKnowledge接口知识检索时提供匹配的答案。 使用场景:当需要添加新的知识点和对应的问答对时使用,比如为产品添加新的常见问题解答。
|
|
104
|
-
*/
|
|
105
|
-
CreateQA(req: CreateQARequest, cb?: (error: string, rep: CreateQAResponse) => void): Promise<CreateQAResponse>;
|
|
106
|
-
/**
|
|
107
|
-
* 用于从系统中删除一个现有的知识库。删除知识库将移除该知识库及其所有关联的知识条目(如文档、问答对、属性标签等)。该操作是不可逆的,请在执行前确认是否需要删除。**使用场景**:当某个知识库不再需要时,可以使用此接口将其从系统中删除。例如,一个项目结束后,其相关的知识库可能不再需要存储,可以使用该接口进行删除。
|
|
108
|
-
*/
|
|
109
|
-
DeleteKnowledgeBase(req: DeleteKnowledgeBaseRequest, cb?: (error: string, rep: DeleteKnowledgeBaseResponse) => void): Promise<DeleteKnowledgeBaseResponse>;
|
|
110
|
-
/**
|
|
111
|
-
* 用于创建一个文档拆分任务,支持多种文件类型,具备mllm能力,能够解析并深入理解图表中的信息。
|
|
112
|
-
*/
|
|
113
|
-
CreateSplitDocumentFlow(req: CreateSplitDocumentFlowRequest, cb?: (error: string, rep: CreateSplitDocumentFlowResponse) => void): Promise<CreateSplitDocumentFlowResponse>;
|
|
114
|
-
/**
|
|
115
|
-
* 获取字符使用量统计
|
|
46
|
+
* 本接口为异步接口的查询结果接口,用于获取文档解析处理结果。
|
|
116
47
|
*/
|
|
117
|
-
|
|
48
|
+
GetReconstructDocumentResult(req: GetReconstructDocumentResultRequest, cb?: (error: string, rep: GetReconstructDocumentResultResponse) => void): Promise<GetReconstructDocumentResultResponse>;
|
|
118
49
|
/**
|
|
119
|
-
*
|
|
120
|
-
使用场景:适用于需要长期存储和检索的文档内容,如产品手册、用户指南等。
|
|
50
|
+
* 文档解析任务取消
|
|
121
51
|
*/
|
|
122
|
-
|
|
52
|
+
CancelTask(req: CancelTaskRequest, cb?: (error: string, rep: CancelTaskResponse) => void): Promise<CancelTaskResponse>;
|
|
123
53
|
/**
|
|
124
54
|
* ### 接口功能
|
|
125
55
|
|
|
@@ -234,4 +164,9 @@ except TencentCloudSDKException as err:
|
|
|
234
164
|
2. 避免添加system prompt,所有说明都应包含在user prompt中。
|
|
235
165
|
*/
|
|
236
166
|
ChatCompletions(req: ChatCompletionsRequest, cb?: (error: string, rep: ChatCompletionsResponse) => void): Promise<ChatCompletionsResponse>;
|
|
167
|
+
/**
|
|
168
|
+
* 本接口(GetEmbedding)调用文本表示模型,将文本转化为用数值表示的向量形式,可用于文本检索、信息推荐、知识挖掘等场景。
|
|
169
|
+
本接口(GetEmbedding)有单账号调用上限控制,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
|
|
170
|
+
*/
|
|
171
|
+
GetEmbedding(req: GetEmbeddingRequest, cb?: (error: string, rep: GetEmbeddingResponse) => void): Promise<GetEmbeddingResponse>;
|
|
237
172
|
}
|