tencentcloud-sdk-nodejs 4.0.1005 → 4.0.1007
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 +303 -0
- package/SERVICE_CHANGELOG.md +343 -134
- package/package.json +1 -1
- package/products.md +24 -23
- package/src/common/sdk_version.ts +1 -1
- package/src/services/cdb/v20170320/cdb_client.ts +13 -1
- package/src/services/cdb/v20170320/cdb_models.ts +55 -19
- package/src/services/dbbrain/v20210527/dbbrain_client.ts +13 -0
- package/src/services/dbbrain/v20210527/dbbrain_models.ts +70 -0
- package/src/services/dbdc/v20201029/dbdc_models.ts +36 -36
- package/src/services/dcdb/v20180411/dcdb_models.ts +2 -2
- package/src/services/essbasic/v20210526/essbasic_client.ts +3 -3
- package/src/services/hunyuan/v20230901/hunyuan_models.ts +1 -1
- package/src/services/index.ts +1 -0
- package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +49 -1
- package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +95 -11
- package/src/services/lighthouse/v20200324/lighthouse_models.ts +1 -1
- package/src/services/lke/v20231130/lke_models.ts +12 -0
- package/src/services/lkeap/index.ts +5 -0
- package/src/services/lkeap/v20240522/index.ts +6 -0
- package/src/services/lkeap/v20240522/lkeap_client.ts +342 -0
- package/src/services/lkeap/v20240522/lkeap_models.ts +1112 -0
- package/src/services/monitor/v20180724/monitor_client.ts +1 -0
- package/src/services/monitor/v20180724/monitor_models.ts +34 -0
- package/src/services/ocr/v20181119/ocr_client.ts +106 -92
- package/src/services/ocr/v20181119/ocr_models.ts +209 -113
- package/src/services/sqlserver/v20180328/sqlserver_models.ts +19 -2
- package/src/services/tcb/v20180608/tcb_models.ts +26 -26
- package/src/services/tcm/v20210413/tcm_models.ts +1 -1
- package/src/services/tcr/v20190924/tcr_models.ts +21 -21
- package/src/services/teo/v20220901/teo_models.ts +10 -7
- package/src/services/tke/v20180525/tke_models.ts +148 -133
- package/src/services/trocket/v20230308/trocket_client.ts +14 -0
- package/src/services/trocket/v20230308/trocket_models.ts +45 -0
- package/src/services/vclm/v20240523/vclm_models.ts +3 -2
- package/src/services/vpc/v20170312/vpc_client.ts +2 -2
- package/src/services/vpc/v20170312/vpc_models.ts +13 -13
- package/src/services/waf/v20180125/waf_models.ts +1 -1
- package/src/services/wedata/v20210820/wedata_models.ts +25 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +5 -1
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +6 -0
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +53 -19
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +5 -1
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +6 -0
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +67 -0
- package/tencentcloud/services/dbdc/v20201029/dbdc_models.d.ts +36 -36
- package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +2 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -3
- package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +1 -1
- package/tencentcloud/services/index.d.ts +1 -0
- package/tencentcloud/services/index.js +2 -0
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +17 -1
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +24 -0
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +87 -11
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +1 -1
- package/tencentcloud/services/lke/v20231130/lke_models.d.ts +12 -0
- package/tencentcloud/services/lkeap/index.d.ts +6 -0
- package/tencentcloud/services/lkeap/index.js +7 -0
- package/tencentcloud/services/lkeap/v20240522/index.d.ts +6 -0
- package/tencentcloud/services/lkeap/v20240522/index.js +9 -0
- package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts +111 -0
- package/tencentcloud/services/lkeap/v20240522/lkeap_client.js +180 -0
- package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts +1030 -0
- package/tencentcloud/services/lkeap/v20240522/lkeap_models.js +18 -0
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +33 -0
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +79 -73
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +84 -76
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +206 -112
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +19 -2
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +26 -26
- package/tencentcloud/services/tcm/v20210413/tcm_models.d.ts +1 -1
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +21 -21
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +10 -7
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +148 -133
- package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +7 -1
- package/tencentcloud/services/trocket/v20230308/trocket_client.js +8 -0
- package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +43 -0
- package/tencentcloud/services/vclm/v20240523/vclm_models.d.ts +3 -2
- package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +2 -2
- package/tencentcloud/services/vpc/v20170312/vpc_client.js +2 -2
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +13 -13
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +1 -1
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +25 -1
- package/test/cdb.v20170320.test.js +10 -0
- package/test/dbbrain.v20210527.test.js +10 -0
- package/test/iotexplorer.v20190423.test.js +40 -0
- package/test/lkeap.v20240522.test.js +261 -0
- package/test/ocr.v20181119.test.js +24 -14
- package/test/trocket.v20230308.test.js +10 -0
|
@@ -0,0 +1,1030 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateSplitDocumentFlow请求参数结构体
|
|
3
|
+
*/
|
|
4
|
+
export interface CreateSplitDocumentFlowRequest {
|
|
5
|
+
/**
|
|
6
|
+
* 文件类型。支持的文件类型:PDF、DOC、DOCX、XLS、XLSX、PPT、PPTX、MD、TXT、PNG、JPG、JPEG、CSV
|
|
7
|
+
*/
|
|
8
|
+
FileType: string;
|
|
9
|
+
/**
|
|
10
|
+
* 文件的 Url 地址。文件存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
|
|
11
|
+
*/
|
|
12
|
+
FileUrl: string;
|
|
13
|
+
/**
|
|
14
|
+
* 文件名,可选,当文件名无法从传入的FileUrl获取时需要通过该字段来明确
|
|
15
|
+
*/
|
|
16
|
+
FileName?: string;
|
|
17
|
+
/**
|
|
18
|
+
* 文件的 Base64 值。支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。支持的图片像素:单边介于20-10000px之间。文件的 FileUrl、FileBase64 必须提供一个,如果都提供,只使用 FileUrl。
|
|
19
|
+
* @deprecated
|
|
20
|
+
*/
|
|
21
|
+
FileBase64?: string;
|
|
22
|
+
/**
|
|
23
|
+
* 当传入文件是PDF类型时,用来指定pdf识别的起始页码,识别的页码包含当前值
|
|
24
|
+
*/
|
|
25
|
+
FileStartPageNumber?: number;
|
|
26
|
+
/**
|
|
27
|
+
* 当传入文件是PDF类型时,用来指定pdf识别的结束页码,识别的页码包含当前值。
|
|
28
|
+
*/
|
|
29
|
+
FileEndPageNumber?: number;
|
|
30
|
+
/**
|
|
31
|
+
* 创建文档拆分任务配置信息创建文档解析任务配置信息
|
|
32
|
+
*/
|
|
33
|
+
Config?: CreateSplitDocumentFlowConfig;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* ImportQAs返回参数结构体
|
|
37
|
+
*/
|
|
38
|
+
export interface ImportQAsResponse {
|
|
39
|
+
/**
|
|
40
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
41
|
+
*/
|
|
42
|
+
RequestId?: string;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* 检索结果的元数据
|
|
46
|
+
*/
|
|
47
|
+
export interface RetrievalRecordMetadata {
|
|
48
|
+
/**
|
|
49
|
+
* 结果的类型。
|
|
50
|
+
- `DOC`:文档
|
|
51
|
+
- `QA`:问答对
|
|
52
|
+
*/
|
|
53
|
+
Type?: string;
|
|
54
|
+
/**
|
|
55
|
+
* 检索结果的来源。
|
|
56
|
+
- `SEMANTIC`:从语义检索中得到的结果
|
|
57
|
+
- `FULL_TEXT`:从全文检索中得到的结果
|
|
58
|
+
*/
|
|
59
|
+
ResultSource?: string;
|
|
60
|
+
/**
|
|
61
|
+
* 切片在文档中的页码,仅部分文档支持
|
|
62
|
+
*/
|
|
63
|
+
ChunkPageNumbers?: Array<number | bigint>;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* ListQAs请求参数结构体
|
|
67
|
+
*/
|
|
68
|
+
export declare type ListQAsRequest = null;
|
|
69
|
+
/**
|
|
70
|
+
* ReconstructDocumentSSE返回参数结构体
|
|
71
|
+
*/
|
|
72
|
+
export interface ReconstructDocumentSSEResponse {
|
|
73
|
+
/**
|
|
74
|
+
* 任务ID。本次请求的唯一标识
|
|
75
|
+
*/
|
|
76
|
+
TaskId?: string;
|
|
77
|
+
/**
|
|
78
|
+
* 响应类型。1:返回进度信息,2:返回解析结果
|
|
79
|
+
*/
|
|
80
|
+
ResponseType?: string;
|
|
81
|
+
/**
|
|
82
|
+
* 进度。0~100
|
|
83
|
+
*/
|
|
84
|
+
Progress?: string;
|
|
85
|
+
/**
|
|
86
|
+
* 进度信息。
|
|
87
|
+
*/
|
|
88
|
+
ProgressMessage?: string;
|
|
89
|
+
/**
|
|
90
|
+
* 文档解析结果URL。存储在腾讯云cos,可以通过http请求下载,URL十分钟内有效。
|
|
91
|
+
*/
|
|
92
|
+
DocumentRecognizeResultUrl?: string;
|
|
93
|
+
/**
|
|
94
|
+
* 文档解析失败的页码。
|
|
95
|
+
*/
|
|
96
|
+
FailedPages?: Array<ReconstructDocumentFailedPage>;
|
|
97
|
+
/**
|
|
98
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
|
|
99
|
+
*/
|
|
100
|
+
RequestId?: string;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* 离线文档列表回包
|
|
104
|
+
*/
|
|
105
|
+
export interface DocItem {
|
|
106
|
+
/**
|
|
107
|
+
* 文档id
|
|
108
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
109
|
+
*/
|
|
110
|
+
DocId?: string;
|
|
111
|
+
/**
|
|
112
|
+
* 状态,
|
|
113
|
+
- Uploading 上传中
|
|
114
|
+
- Parsing 解析中
|
|
115
|
+
- ParseFailed 解析失败
|
|
116
|
+
- Indexing 创建索引中
|
|
117
|
+
- IndexFailed 创建索引失败
|
|
118
|
+
- Success 发布成功
|
|
119
|
+
- Failed 失败
|
|
120
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
121
|
+
*/
|
|
122
|
+
Status?: string;
|
|
123
|
+
/**
|
|
124
|
+
* 文件名
|
|
125
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
126
|
+
*/
|
|
127
|
+
FileName?: string;
|
|
128
|
+
/**
|
|
129
|
+
* 更新时间
|
|
130
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
131
|
+
*/
|
|
132
|
+
UpdateTime?: string;
|
|
133
|
+
/**
|
|
134
|
+
* 属性标签
|
|
135
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
136
|
+
*/
|
|
137
|
+
AttributeLabels?: Array<AttributeLabelReferItem>;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* GetEmbedding请求参数结构体
|
|
141
|
+
*/
|
|
142
|
+
export interface GetEmbeddingRequest {
|
|
143
|
+
/**
|
|
144
|
+
* 模型名称
|
|
145
|
+
*/
|
|
146
|
+
Model: string;
|
|
147
|
+
/**
|
|
148
|
+
* 需要 embedding 的文本, 单条文本最大长度500个字符, 总条数最大7条
|
|
149
|
+
*/
|
|
150
|
+
Inputs: Array<string>;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* UploadDocRealtime请求参数结构体
|
|
154
|
+
*/
|
|
155
|
+
export declare type UploadDocRealtimeRequest = null;
|
|
156
|
+
/**
|
|
157
|
+
* DescribeDoc返回参数结构体
|
|
158
|
+
*/
|
|
159
|
+
export interface DescribeDocResponse {
|
|
160
|
+
/**
|
|
161
|
+
* 属性标签
|
|
162
|
+
*/
|
|
163
|
+
AttributeLabels?: Array<AttributeLabelReferItem>;
|
|
164
|
+
/**
|
|
165
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
166
|
+
*/
|
|
167
|
+
RequestId?: string;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* 属性标签引用
|
|
171
|
+
*/
|
|
172
|
+
export interface AttributeLabelReferItem {
|
|
173
|
+
/**
|
|
174
|
+
* 属性id
|
|
175
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
176
|
+
*/
|
|
177
|
+
AttributeId?: string;
|
|
178
|
+
/**
|
|
179
|
+
* 标签id
|
|
180
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
181
|
+
*/
|
|
182
|
+
LabelIds?: Array<string>;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* DeleteQAs请求参数结构体
|
|
186
|
+
*/
|
|
187
|
+
export declare type DeleteQAsRequest = null;
|
|
188
|
+
/**
|
|
189
|
+
* ModifyQA请求参数结构体
|
|
190
|
+
*/
|
|
191
|
+
export interface ModifyQARequest {
|
|
192
|
+
/**
|
|
193
|
+
* 属性标签
|
|
194
|
+
*/
|
|
195
|
+
AttributeLabels?: Array<AttributeLabelReferItem>;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* 消耗量
|
|
199
|
+
*/
|
|
200
|
+
export interface Usage {
|
|
201
|
+
/**
|
|
202
|
+
* 文档页数
|
|
203
|
+
*/
|
|
204
|
+
TotalPages?: number;
|
|
205
|
+
/**
|
|
206
|
+
* 输入token数
|
|
207
|
+
*/
|
|
208
|
+
InputTokens?: number;
|
|
209
|
+
/**
|
|
210
|
+
* 输出token数
|
|
211
|
+
*/
|
|
212
|
+
OutputTokens?: number;
|
|
213
|
+
/**
|
|
214
|
+
* 总token数
|
|
215
|
+
*/
|
|
216
|
+
TotalTokens?: number;
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* GetReconstructDocumentResult请求参数结构体
|
|
220
|
+
*/
|
|
221
|
+
export interface GetReconstructDocumentResultRequest {
|
|
222
|
+
/**
|
|
223
|
+
* 解析任务ID
|
|
224
|
+
*/
|
|
225
|
+
TaskId: string;
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* ListQAs返回参数结构体
|
|
229
|
+
*/
|
|
230
|
+
export interface ListQAsResponse {
|
|
231
|
+
/**
|
|
232
|
+
* 问答对信息
|
|
233
|
+
*/
|
|
234
|
+
List?: Array<QaItem>;
|
|
235
|
+
/**
|
|
236
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
237
|
+
*/
|
|
238
|
+
RequestId?: string;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* DeleteAttributeLabels返回参数结构体
|
|
242
|
+
*/
|
|
243
|
+
export interface DeleteAttributeLabelsResponse {
|
|
244
|
+
/**
|
|
245
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
246
|
+
*/
|
|
247
|
+
RequestId?: string;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* 检索参数设置
|
|
251
|
+
*/
|
|
252
|
+
export interface RetrievalSetting {
|
|
253
|
+
/**
|
|
254
|
+
* 检索的类型,不填该参数则检索全部。
|
|
255
|
+
- `DOC`:文档
|
|
256
|
+
- `QA`:QA
|
|
257
|
+
|
|
258
|
+
仅RetrieveKnowledge接口支持该参数
|
|
259
|
+
*/
|
|
260
|
+
Type?: string;
|
|
261
|
+
/**
|
|
262
|
+
* 返回个数
|
|
263
|
+
*/
|
|
264
|
+
TopK?: number;
|
|
265
|
+
/**
|
|
266
|
+
* 分数过滤
|
|
267
|
+
*/
|
|
268
|
+
ScoreThreshold?: number;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* ListDocs请求参数结构体
|
|
272
|
+
*/
|
|
273
|
+
export declare type ListDocsRequest = null;
|
|
274
|
+
/**
|
|
275
|
+
* CreateAttributeLabel返回参数结构体
|
|
276
|
+
*/
|
|
277
|
+
export interface CreateAttributeLabelResponse {
|
|
278
|
+
/**
|
|
279
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
280
|
+
*/
|
|
281
|
+
RequestId?: string;
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* RetrieveKnowledge返回参数结构体
|
|
285
|
+
*/
|
|
286
|
+
export interface RetrieveKnowledgeResponse {
|
|
287
|
+
/**
|
|
288
|
+
* 检索结果
|
|
289
|
+
*/
|
|
290
|
+
Records?: Array<RetrievalRecord>;
|
|
291
|
+
/**
|
|
292
|
+
* 检索结果数量
|
|
293
|
+
*/
|
|
294
|
+
TotalCount?: number;
|
|
295
|
+
/**
|
|
296
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
297
|
+
*/
|
|
298
|
+
RequestId?: string;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* CreateSplitDocumentFlow返回参数结构体
|
|
302
|
+
*/
|
|
303
|
+
export interface CreateSplitDocumentFlowResponse {
|
|
304
|
+
/**
|
|
305
|
+
* 任务唯一id。30天内可以通过GetSplitDocumentResult接口查询TaskId对应的处理结果。
|
|
306
|
+
*/
|
|
307
|
+
TaskId?: string;
|
|
308
|
+
/**
|
|
309
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
310
|
+
*/
|
|
311
|
+
RequestId?: string;
|
|
312
|
+
}
|
|
313
|
+
/**
|
|
314
|
+
* 分段配置
|
|
315
|
+
*/
|
|
316
|
+
export interface SegmentationConfig {
|
|
317
|
+
/**
|
|
318
|
+
* 最大分片长度
|
|
319
|
+
*/
|
|
320
|
+
MaxChunkSize?: number;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* CreateQA返回参数结构体
|
|
324
|
+
*/
|
|
325
|
+
export interface CreateQAResponse {
|
|
326
|
+
/**
|
|
327
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
328
|
+
*/
|
|
329
|
+
RequestId?: string;
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* ModifyAttributeLabel请求参数结构体
|
|
333
|
+
*/
|
|
334
|
+
export interface ModifyAttributeLabelRequest {
|
|
335
|
+
/**
|
|
336
|
+
* 属性标签
|
|
337
|
+
*/
|
|
338
|
+
Labels?: Array<AttributeLabelItem>;
|
|
339
|
+
}
|
|
340
|
+
/**
|
|
341
|
+
* ReconstructDocumentSSE 功能配置参数
|
|
342
|
+
*/
|
|
343
|
+
export interface ReconstructDocumentSSEConfig {
|
|
344
|
+
/**
|
|
345
|
+
* Markdown文件中表格返回的形式
|
|
346
|
+
0,表格以MD形式返回
|
|
347
|
+
1,表格以HTML形式返回
|
|
348
|
+
默认为0
|
|
349
|
+
*/
|
|
350
|
+
TableResultType?: string;
|
|
351
|
+
/**
|
|
352
|
+
* Markdown文件中图片返回的形式
|
|
353
|
+
0:markdown中图片以链接形式返回
|
|
354
|
+
1:markdown中图片只返回图片中提取的文本内容
|
|
355
|
+
默认是0
|
|
356
|
+
*/
|
|
357
|
+
MarkdownImageResponseType?: string;
|
|
358
|
+
/**
|
|
359
|
+
* Markdown文件中是否包含页码信息
|
|
360
|
+
*/
|
|
361
|
+
ReturnPageFormat?: boolean;
|
|
362
|
+
/**
|
|
363
|
+
* 自定义输出页码样式,{{p}}为页码占位符,开启ReturnPageFormat生效。未填默认样式:<page_num>page {{p}}</page_num>
|
|
364
|
+
*/
|
|
365
|
+
PageFormat?: string;
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* ListDocs返回参数结构体
|
|
369
|
+
*/
|
|
370
|
+
export interface ListDocsResponse {
|
|
371
|
+
/**
|
|
372
|
+
* 文档信息
|
|
373
|
+
*/
|
|
374
|
+
List?: Array<DocItem>;
|
|
375
|
+
/**
|
|
376
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
377
|
+
*/
|
|
378
|
+
RequestId?: string;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* 文档拆分任务的用量
|
|
382
|
+
*/
|
|
383
|
+
export interface DocumentUsage {
|
|
384
|
+
/**
|
|
385
|
+
* 文档拆分任务的页数
|
|
386
|
+
*/
|
|
387
|
+
PageNumber?: number;
|
|
388
|
+
/**
|
|
389
|
+
* 文档拆分任务消耗的总token数
|
|
390
|
+
* @deprecated
|
|
391
|
+
*/
|
|
392
|
+
TotalToken?: number;
|
|
393
|
+
/**
|
|
394
|
+
* 文档拆分任务消耗的总token数
|
|
395
|
+
*/
|
|
396
|
+
TotalTokens?: number;
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* ListAttributeLabels请求参数结构体
|
|
400
|
+
*/
|
|
401
|
+
export declare type ListAttributeLabelsRequest = null;
|
|
402
|
+
/**
|
|
403
|
+
* DeleteAttributeLabels请求参数结构体
|
|
404
|
+
*/
|
|
405
|
+
export declare type DeleteAttributeLabelsRequest = null;
|
|
406
|
+
/**
|
|
407
|
+
* RetrieveKnowledge请求参数结构体
|
|
408
|
+
*/
|
|
409
|
+
export interface RetrieveKnowledgeRequest {
|
|
410
|
+
/**
|
|
411
|
+
* 知识库ID。
|
|
412
|
+
*/
|
|
413
|
+
KnowledgeBaseId: string;
|
|
414
|
+
/**
|
|
415
|
+
* 用于检索的文本。
|
|
416
|
+
*/
|
|
417
|
+
Query: string;
|
|
418
|
+
/**
|
|
419
|
+
* 检索方法,默认使用`HYBRID`混合检索。
|
|
420
|
+
- `SEMANTIC`:语义检索
|
|
421
|
+
- `FULL_TEXT`:全文检索
|
|
422
|
+
- `HYBRID`:混合检索
|
|
423
|
+
*/
|
|
424
|
+
RetrievalMethod?: string;
|
|
425
|
+
/**
|
|
426
|
+
* 检索设置。
|
|
427
|
+
*/
|
|
428
|
+
RetrievalSetting?: RetrievalSetting;
|
|
429
|
+
/**
|
|
430
|
+
* 标签过滤。
|
|
431
|
+
*/
|
|
432
|
+
AttributeLabels?: Array<LabelItem>;
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* GetReconstructDocumentResult返回参数结构体
|
|
436
|
+
*/
|
|
437
|
+
export interface GetReconstructDocumentResultResponse {
|
|
438
|
+
/**
|
|
439
|
+
* 任务状态。- `Success`:执行完成- `Processing`:执行中- `Pause`: 暂停- `Failed`:执行失败- `WaitExecute`:等待执行
|
|
440
|
+
*/
|
|
441
|
+
Status?: string;
|
|
442
|
+
/**
|
|
443
|
+
* 解析结果的临时下载地址。文件类型为zip压缩包,下载链接有效期30分钟
|
|
444
|
+
*/
|
|
445
|
+
DocumentRecognizeResultUrl?: string;
|
|
446
|
+
/**
|
|
447
|
+
* 文档解析失败的页码
|
|
448
|
+
*/
|
|
449
|
+
FailedPages?: Array<ReconstructDocumentFailedPage>;
|
|
450
|
+
/**
|
|
451
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
452
|
+
*/
|
|
453
|
+
RequestId?: string;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* 创建智能文档解析任务的配置信息
|
|
457
|
+
*/
|
|
458
|
+
export interface CreateReconstructDocumentFlowConfig {
|
|
459
|
+
/**
|
|
460
|
+
* Markdown文件中表格返回的形式
|
|
461
|
+
0,表格以MD形式返回
|
|
462
|
+
1,表格以HTML形式返回
|
|
463
|
+
默认为1
|
|
464
|
+
*/
|
|
465
|
+
TableResultType?: string;
|
|
466
|
+
/**
|
|
467
|
+
* 智能文档解析返回结果的格式
|
|
468
|
+
0:只返回全文MD;
|
|
469
|
+
1:只返回每一页的OCR原始Json;
|
|
470
|
+
2:只返回每一页的MD,
|
|
471
|
+
3:返回全文MD + 每一页的OCR原始Json;
|
|
472
|
+
4:返回全文MD + 每一页的MD,
|
|
473
|
+
默认值为3(返回全文MD + 每一页的OCR原始Json)
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
*/
|
|
477
|
+
ResultType?: string;
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* RunRerank请求参数结构体
|
|
481
|
+
*/
|
|
482
|
+
export interface RunRerankRequest {
|
|
483
|
+
/**
|
|
484
|
+
* 查询内容
|
|
485
|
+
*/
|
|
486
|
+
Query: string;
|
|
487
|
+
/**
|
|
488
|
+
* 文档列表,最多20个
|
|
489
|
+
*/
|
|
490
|
+
Docs: Array<string>;
|
|
491
|
+
/**
|
|
492
|
+
* 模型名称, 默认: lke-reranker-base
|
|
493
|
+
*/
|
|
494
|
+
Model?: string;
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* GetSplitDocumentResult请求参数结构体
|
|
498
|
+
*/
|
|
499
|
+
export interface GetSplitDocumentResultRequest {
|
|
500
|
+
/**
|
|
501
|
+
* 拆分任务ID
|
|
502
|
+
*/
|
|
503
|
+
TaskId: string;
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* ReconstructDocumentSSE请求参数结构体
|
|
507
|
+
*/
|
|
508
|
+
export interface ReconstructDocumentSSERequest {
|
|
509
|
+
/**
|
|
510
|
+
* 文件类型。
|
|
511
|
+
**支持的文件类型**:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2
|
|
512
|
+
**支持的文件大小**:
|
|
513
|
+
- PDF、DOC、DOCX、PPT、PPTX 支持100M
|
|
514
|
+
- MD、TXT 支持10M
|
|
515
|
+
- 其他支持20M
|
|
516
|
+
|
|
517
|
+
*/
|
|
518
|
+
FileType: string;
|
|
519
|
+
/**
|
|
520
|
+
* 文件的 URL 地址。
|
|
521
|
+
文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。
|
|
522
|
+
参考:[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)
|
|
523
|
+
*/
|
|
524
|
+
FileUrl?: string;
|
|
525
|
+
/**
|
|
526
|
+
* 文件的 Base64 值。
|
|
527
|
+
支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。
|
|
528
|
+
支持的图片像素:单边介于20-10000px之间。
|
|
529
|
+
文件的 FileUrl、FileBase64 必须提供一个,如果都提供,只使用 FileUrl。
|
|
530
|
+
*/
|
|
531
|
+
FileBase64?: string;
|
|
532
|
+
/**
|
|
533
|
+
* 文档的起始页码。
|
|
534
|
+
当传入文件是PDF、PDF、PPT、PPTX、DOC类型时,用来指定识别的起始页码,识别的页码包含当前值。
|
|
535
|
+
*/
|
|
536
|
+
FileStartPageNumber?: number;
|
|
537
|
+
/**
|
|
538
|
+
* 文档的结束页码。
|
|
539
|
+
当传入文件是PDF、PDF、PPT、PPTX、DOC类型时,用来指定识别的结束页码,识别的页码包含当前值。
|
|
540
|
+
*/
|
|
541
|
+
FileEndPageNumber?: number;
|
|
542
|
+
/**
|
|
543
|
+
* 文档解析配置信息
|
|
544
|
+
*/
|
|
545
|
+
Config?: ReconstructDocumentSSEConfig;
|
|
546
|
+
}
|
|
547
|
+
/**
|
|
548
|
+
* ListAttributeLabels返回参数结构体
|
|
549
|
+
*/
|
|
550
|
+
export interface ListAttributeLabelsResponse {
|
|
551
|
+
/**
|
|
552
|
+
* 属性标签列表
|
|
553
|
+
*/
|
|
554
|
+
List?: Array<AttributeItem>;
|
|
555
|
+
/**
|
|
556
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
557
|
+
*/
|
|
558
|
+
RequestId?: string;
|
|
559
|
+
}
|
|
560
|
+
/**
|
|
561
|
+
* 检索的结果
|
|
562
|
+
*/
|
|
563
|
+
export interface RetrievalRecord {
|
|
564
|
+
/**
|
|
565
|
+
* 检索结果的元数据
|
|
566
|
+
*/
|
|
567
|
+
Metadata?: RetrievalRecordMetadata;
|
|
568
|
+
/**
|
|
569
|
+
* 检索到的标题
|
|
570
|
+
*/
|
|
571
|
+
Title?: string;
|
|
572
|
+
/**
|
|
573
|
+
* 检索到的内容
|
|
574
|
+
*/
|
|
575
|
+
Content?: string;
|
|
576
|
+
}
|
|
577
|
+
/**
|
|
578
|
+
* 属性标签信息
|
|
579
|
+
*/
|
|
580
|
+
export interface AttributeLabelItem {
|
|
581
|
+
/**
|
|
582
|
+
* 标签id
|
|
583
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
584
|
+
*/
|
|
585
|
+
LabelId?: string;
|
|
586
|
+
/**
|
|
587
|
+
* 标签名称,最大80个英文字符
|
|
588
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
589
|
+
*/
|
|
590
|
+
LabelName?: string;
|
|
591
|
+
}
|
|
592
|
+
/**
|
|
593
|
+
* CreateAttributeLabel请求参数结构体
|
|
594
|
+
*/
|
|
595
|
+
export interface CreateAttributeLabelRequest {
|
|
596
|
+
/**
|
|
597
|
+
* 属性标签信息
|
|
598
|
+
*/
|
|
599
|
+
Labels?: Array<AttributeLabelItem>;
|
|
600
|
+
}
|
|
601
|
+
/**
|
|
602
|
+
* ImportQAs请求参数结构体
|
|
603
|
+
*/
|
|
604
|
+
export declare type ImportQAsRequest = null;
|
|
605
|
+
/**
|
|
606
|
+
* DescribeDoc请求参数结构体
|
|
607
|
+
*/
|
|
608
|
+
export declare type DescribeDocRequest = null;
|
|
609
|
+
/**
|
|
610
|
+
* DeleteKnowledgeBase返回参数结构体
|
|
611
|
+
*/
|
|
612
|
+
export interface DeleteKnowledgeBaseResponse {
|
|
613
|
+
/**
|
|
614
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
615
|
+
*/
|
|
616
|
+
RequestId?: string;
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* DeleteDocs返回参数结构体
|
|
620
|
+
*/
|
|
621
|
+
export interface DeleteDocsResponse {
|
|
622
|
+
/**
|
|
623
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
624
|
+
*/
|
|
625
|
+
RequestId?: string;
|
|
626
|
+
}
|
|
627
|
+
/**
|
|
628
|
+
* 属性标签
|
|
629
|
+
*/
|
|
630
|
+
export interface LabelItem {
|
|
631
|
+
/**
|
|
632
|
+
* 属性key
|
|
633
|
+
*/
|
|
634
|
+
Name?: string;
|
|
635
|
+
/**
|
|
636
|
+
* 标签值
|
|
637
|
+
*/
|
|
638
|
+
Values?: Array<string>;
|
|
639
|
+
}
|
|
640
|
+
/**
|
|
641
|
+
* CreateReconstructDocumentFlow请求参数结构体
|
|
642
|
+
*/
|
|
643
|
+
export interface CreateReconstructDocumentFlowRequest {
|
|
644
|
+
/**
|
|
645
|
+
* 文件类型。
|
|
646
|
+
|
|
647
|
+
**支持的文件类型:**
|
|
648
|
+
- `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`、`BMP`、`GIF`、`WEBP`、`HEIC`、`EPS`、`ICNS`、`IM`、`PCX`、`PPM`、`TIFF`、`XBM`、`HEIF`、`JP2`
|
|
649
|
+
|
|
650
|
+
**支持的文件大小:**
|
|
651
|
+
- `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M
|
|
652
|
+
- `TXT`、`MD` 最大10M
|
|
653
|
+
- 其他 最大20M
|
|
654
|
+
|
|
655
|
+
*/
|
|
656
|
+
FileType: string;
|
|
657
|
+
/**
|
|
658
|
+
* 文件的 URL 地址。
|
|
659
|
+
文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。
|
|
660
|
+
参考:[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)
|
|
661
|
+
*/
|
|
662
|
+
FileUrl?: string;
|
|
663
|
+
/**
|
|
664
|
+
* 文件的 Base64 值。
|
|
665
|
+
支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。
|
|
666
|
+
支持的图片像素:单边介于20-10000px之间。
|
|
667
|
+
文件的 FileUrl、FileBase64 必须提供一个,如果都提供,只使用 FileUrl。
|
|
668
|
+
*/
|
|
669
|
+
FileBase64?: string;
|
|
670
|
+
/**
|
|
671
|
+
* 文档的起始页码。
|
|
672
|
+
当传入文件是PDF、PDF、PPT、PPTX、DOC类型时,用来指定识别的起始页码,识别的页码包含当前值。
|
|
673
|
+
*/
|
|
674
|
+
FileStartPageNumber?: number;
|
|
675
|
+
/**
|
|
676
|
+
* 文档的结束页码。
|
|
677
|
+
当传入文件是PDF、PDF、PPT、PPTX、DOC类型时,用来指定识别的结束页码,识别的页码包含当前值。
|
|
678
|
+
*/
|
|
679
|
+
FileEndPageNumber?: number;
|
|
680
|
+
/**
|
|
681
|
+
* 创建文档解析任务配置信息。
|
|
682
|
+
*/
|
|
683
|
+
Config?: CreateReconstructDocumentFlowConfig;
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* GetSplitDocumentResult返回参数结构体
|
|
687
|
+
*/
|
|
688
|
+
export interface GetSplitDocumentResultResponse {
|
|
689
|
+
/**
|
|
690
|
+
* 任务状态。
|
|
691
|
+
|
|
692
|
+
- `Success`:执行完成
|
|
693
|
+
- `Processing`:执行中
|
|
694
|
+
- `Pause`: 暂停
|
|
695
|
+
- `Failed`:执行失败
|
|
696
|
+
- `WaitExecute`:等待执行
|
|
697
|
+
*/
|
|
698
|
+
Status?: string;
|
|
699
|
+
/**
|
|
700
|
+
* 拆分结果的临时下载地址。
|
|
701
|
+
文件类型为zip压缩包,下载链接有效期30分钟。
|
|
702
|
+
压缩包内包含\*.md、\*.jsonl、\*mllm.json以及images文件夹。
|
|
703
|
+
|
|
704
|
+
> **jsonl** 结构说明:
|
|
705
|
+
- `page_content`:
|
|
706
|
+
用于生成嵌入(embedding)库,以便于检索使用。该字段中的图片将使用占位符替换。
|
|
707
|
+
- `org_data`:
|
|
708
|
+
表示与 page_content 对应的最小语义完整性块,用于问答模型的处理。
|
|
709
|
+
- `big_data`:
|
|
710
|
+
表示与 page_content 对应的最大语义完整性块,也用于问答模型的处理。
|
|
711
|
+
*/
|
|
712
|
+
DocumentRecognizeResultUrl?: string;
|
|
713
|
+
/**
|
|
714
|
+
* 文档拆分失败的页码
|
|
715
|
+
* @deprecated
|
|
716
|
+
*/
|
|
717
|
+
FailedPages?: Array<SplitDocumentFailedPage>;
|
|
718
|
+
/**
|
|
719
|
+
* 文档拆分任务的用量
|
|
720
|
+
*/
|
|
721
|
+
Usage?: DocumentUsage;
|
|
722
|
+
/**
|
|
723
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
724
|
+
*/
|
|
725
|
+
RequestId?: string;
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* ModifyQA返回参数结构体
|
|
729
|
+
*/
|
|
730
|
+
export interface ModifyQAResponse {
|
|
731
|
+
/**
|
|
732
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
733
|
+
*/
|
|
734
|
+
RequestId?: string;
|
|
735
|
+
}
|
|
736
|
+
/**
|
|
737
|
+
* 文档解析失败记录
|
|
738
|
+
*/
|
|
739
|
+
export interface ReconstructDocumentFailedPage {
|
|
740
|
+
/**
|
|
741
|
+
* 失败页码
|
|
742
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
743
|
+
*/
|
|
744
|
+
PageNumber?: number;
|
|
745
|
+
}
|
|
746
|
+
/**
|
|
747
|
+
* UploadDocRealtime返回参数结构体
|
|
748
|
+
*/
|
|
749
|
+
export interface UploadDocRealtimeResponse {
|
|
750
|
+
/**
|
|
751
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
|
|
752
|
+
*/
|
|
753
|
+
RequestId?: string;
|
|
754
|
+
}
|
|
755
|
+
/**
|
|
756
|
+
* 文档解析失败记录
|
|
757
|
+
*/
|
|
758
|
+
export interface SplitDocumentFailedPage {
|
|
759
|
+
/**
|
|
760
|
+
* 失败页码
|
|
761
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
762
|
+
*/
|
|
763
|
+
PageNumber?: number;
|
|
764
|
+
}
|
|
765
|
+
/**
|
|
766
|
+
* ModifyAttributeLabel返回参数结构体
|
|
767
|
+
*/
|
|
768
|
+
export interface ModifyAttributeLabelResponse {
|
|
769
|
+
/**
|
|
770
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
771
|
+
*/
|
|
772
|
+
RequestId?: string;
|
|
773
|
+
}
|
|
774
|
+
/**
|
|
775
|
+
* DeleteQAs返回参数结构体
|
|
776
|
+
*/
|
|
777
|
+
export interface DeleteQAsResponse {
|
|
778
|
+
/**
|
|
779
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
780
|
+
*/
|
|
781
|
+
RequestId?: string;
|
|
782
|
+
}
|
|
783
|
+
/**
|
|
784
|
+
* CreateKnowledgeBase返回参数结构体
|
|
785
|
+
*/
|
|
786
|
+
export interface CreateKnowledgeBaseResponse {
|
|
787
|
+
/**
|
|
788
|
+
* 知识库ID
|
|
789
|
+
*/
|
|
790
|
+
KnowledgeBaseId?: string;
|
|
791
|
+
/**
|
|
792
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
793
|
+
*/
|
|
794
|
+
RequestId?: string;
|
|
795
|
+
}
|
|
796
|
+
/**
|
|
797
|
+
* GetEmbedding返回参数结构体
|
|
798
|
+
*/
|
|
799
|
+
export interface GetEmbeddingResponse {
|
|
800
|
+
/**
|
|
801
|
+
* 特征
|
|
802
|
+
*/
|
|
803
|
+
Data?: Array<EmbeddingObject>;
|
|
804
|
+
/**
|
|
805
|
+
* 消耗量,返回TotalToken
|
|
806
|
+
*/
|
|
807
|
+
Usage?: Usage;
|
|
808
|
+
/**
|
|
809
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
810
|
+
*/
|
|
811
|
+
RequestId?: string;
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* 问答对信息
|
|
815
|
+
*/
|
|
816
|
+
export interface QaItem {
|
|
817
|
+
/**
|
|
818
|
+
* 问答id
|
|
819
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
820
|
+
*/
|
|
821
|
+
QaId?: string;
|
|
822
|
+
/**
|
|
823
|
+
* 问题
|
|
824
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
825
|
+
*/
|
|
826
|
+
Question?: string;
|
|
827
|
+
/**
|
|
828
|
+
* 答案
|
|
829
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
830
|
+
*/
|
|
831
|
+
Answer?: string;
|
|
832
|
+
/**
|
|
833
|
+
* 属性标签
|
|
834
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
835
|
+
*/
|
|
836
|
+
AttributeLabels?: Array<AttributeLabelReferItem>;
|
|
837
|
+
/**
|
|
838
|
+
* 创建时间
|
|
839
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
840
|
+
*/
|
|
841
|
+
CreateTime?: string;
|
|
842
|
+
/**
|
|
843
|
+
* 更新时间
|
|
844
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
845
|
+
*/
|
|
846
|
+
UpdateTime?: string;
|
|
847
|
+
}
|
|
848
|
+
/**
|
|
849
|
+
* 创建智能文档拆分任务的配置信息
|
|
850
|
+
*/
|
|
851
|
+
export interface CreateSplitDocumentFlowConfig {
|
|
852
|
+
/**
|
|
853
|
+
* Markdown文件中表格返回的形式
|
|
854
|
+
0,表格以MD形式返回
|
|
855
|
+
1,表格以HTML形式返回
|
|
856
|
+
默认为
|
|
857
|
+
* @deprecated
|
|
858
|
+
*/
|
|
859
|
+
TableResultType?: string;
|
|
860
|
+
/**
|
|
861
|
+
* 智能文档解析返回结果的格式
|
|
862
|
+
0:只返回全文MD;
|
|
863
|
+
1:只返回每一页的OCR原始Json;
|
|
864
|
+
2:只返回每一页的MD,
|
|
865
|
+
3:返回全文MD + 每一页的OCR原始Json;
|
|
866
|
+
4:返回全文MD + 每一页的MD,
|
|
867
|
+
默认值为3(返回全文MD + 每一页的OCR原始Json)
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
* @deprecated
|
|
871
|
+
*/
|
|
872
|
+
ResultType?: string;
|
|
873
|
+
/**
|
|
874
|
+
* 是否开启mllm
|
|
875
|
+
*/
|
|
876
|
+
EnableMllm?: boolean;
|
|
877
|
+
/**
|
|
878
|
+
* 最大分片长度
|
|
879
|
+
*/
|
|
880
|
+
MaxChunkSize?: number;
|
|
881
|
+
}
|
|
882
|
+
/**
|
|
883
|
+
* RunRerank返回参数结构体
|
|
884
|
+
*/
|
|
885
|
+
export interface RunRerankResponse {
|
|
886
|
+
/**
|
|
887
|
+
* 相关性, 数值越大越相关
|
|
888
|
+
*/
|
|
889
|
+
ScoreList?: Array<number>;
|
|
890
|
+
/**
|
|
891
|
+
* 消耗量,仅返回TotalToken
|
|
892
|
+
*/
|
|
893
|
+
Usage?: Usage;
|
|
894
|
+
/**
|
|
895
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
896
|
+
*/
|
|
897
|
+
RequestId?: string;
|
|
898
|
+
}
|
|
899
|
+
/**
|
|
900
|
+
* CreateReconstructDocumentFlow返回参数结构体
|
|
901
|
+
*/
|
|
902
|
+
export interface CreateReconstructDocumentFlowResponse {
|
|
903
|
+
/**
|
|
904
|
+
* 任务唯一id。30天内可以通过GetReconstructDocumentResult接口查询TaskId对应的处理结果。
|
|
905
|
+
*/
|
|
906
|
+
TaskId?: string;
|
|
907
|
+
/**
|
|
908
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
909
|
+
*/
|
|
910
|
+
RequestId?: string;
|
|
911
|
+
}
|
|
912
|
+
/**
|
|
913
|
+
* CreateQA请求参数结构体
|
|
914
|
+
*/
|
|
915
|
+
export interface CreateQARequest {
|
|
916
|
+
/**
|
|
917
|
+
* 属性标签
|
|
918
|
+
*/
|
|
919
|
+
AttributeLabels?: Array<AttributeLabelReferItem>;
|
|
920
|
+
}
|
|
921
|
+
/**
|
|
922
|
+
* UploadDoc返回参数结构体
|
|
923
|
+
*/
|
|
924
|
+
export interface UploadDocResponse {
|
|
925
|
+
/**
|
|
926
|
+
* 文档ID
|
|
927
|
+
*/
|
|
928
|
+
DocId?: string;
|
|
929
|
+
/**
|
|
930
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
931
|
+
*/
|
|
932
|
+
RequestId?: string;
|
|
933
|
+
}
|
|
934
|
+
/**
|
|
935
|
+
* 属性信息
|
|
936
|
+
*/
|
|
937
|
+
export interface AttributeItem {
|
|
938
|
+
/**
|
|
939
|
+
* 属性id
|
|
940
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
941
|
+
*/
|
|
942
|
+
AttributeId?: string;
|
|
943
|
+
/**
|
|
944
|
+
* 属性标识
|
|
945
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
946
|
+
*/
|
|
947
|
+
AttributeKey?: string;
|
|
948
|
+
/**
|
|
949
|
+
* 属性名称
|
|
950
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
951
|
+
*/
|
|
952
|
+
AttributeName?: string;
|
|
953
|
+
/**
|
|
954
|
+
* 标签名称
|
|
955
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
956
|
+
*/
|
|
957
|
+
Labels?: Array<AttributeLabelItem>;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* 向量
|
|
961
|
+
*/
|
|
962
|
+
export interface EmbeddingObject {
|
|
963
|
+
/**
|
|
964
|
+
* 向量
|
|
965
|
+
*/
|
|
966
|
+
Embedding?: Array<number>;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* UploadDoc请求参数结构体
|
|
970
|
+
*/
|
|
971
|
+
export interface UploadDocRequest {
|
|
972
|
+
/**
|
|
973
|
+
* 知识库ID
|
|
974
|
+
*/
|
|
975
|
+
KnowledgeBaseId: string;
|
|
976
|
+
/**
|
|
977
|
+
* 文件名,可选。
|
|
978
|
+
**需带文件类型后缀**,当文件名无法从传入的`FileUrl`获取时需要通过该字段来明确。
|
|
979
|
+
*/
|
|
980
|
+
FileName: string;
|
|
981
|
+
/**
|
|
982
|
+
* 文件类型。
|
|
983
|
+
|
|
984
|
+
**支持的文件类型:**
|
|
985
|
+
- `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`
|
|
986
|
+
|
|
987
|
+
**支持的文件大小:**
|
|
988
|
+
- `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M
|
|
989
|
+
- `TXT`、`MD` 最大10M
|
|
990
|
+
- 其他 最大20M
|
|
991
|
+
|
|
992
|
+
*/
|
|
993
|
+
FileType: string;
|
|
994
|
+
/**
|
|
995
|
+
* 文件的 URL 地址。
|
|
996
|
+
文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。
|
|
997
|
+
参考:[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)
|
|
998
|
+
*/
|
|
999
|
+
FileUrl: string;
|
|
1000
|
+
/**
|
|
1001
|
+
* 属性标签引用
|
|
1002
|
+
* @deprecated
|
|
1003
|
+
*/
|
|
1004
|
+
AttributeLabel?: Array<AttributeLabelReferItem>;
|
|
1005
|
+
/**
|
|
1006
|
+
* 属性标签引用
|
|
1007
|
+
*/
|
|
1008
|
+
AttributeLabels?: Array<AttributeLabelReferItem>;
|
|
1009
|
+
/**
|
|
1010
|
+
* 分段信息
|
|
1011
|
+
*/
|
|
1012
|
+
Config?: SegmentationConfig;
|
|
1013
|
+
}
|
|
1014
|
+
/**
|
|
1015
|
+
* CreateKnowledgeBase请求参数结构体
|
|
1016
|
+
*/
|
|
1017
|
+
export declare type CreateKnowledgeBaseRequest = null;
|
|
1018
|
+
/**
|
|
1019
|
+
* DeleteKnowledgeBase请求参数结构体
|
|
1020
|
+
*/
|
|
1021
|
+
export interface DeleteKnowledgeBaseRequest {
|
|
1022
|
+
/**
|
|
1023
|
+
* 知识库ID
|
|
1024
|
+
*/
|
|
1025
|
+
KnowledgeBaseId: string;
|
|
1026
|
+
}
|
|
1027
|
+
/**
|
|
1028
|
+
* DeleteDocs请求参数结构体
|
|
1029
|
+
*/
|
|
1030
|
+
export declare type DeleteDocsRequest = null;
|