tccli 3.0.1245.1__py2.py3-none-any.whl → 3.0.1247.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (58) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/billing/v20180709/api.json +55 -1
  4. tccli/services/cam/v20190116/api.json +14 -14
  5. tccli/services/ccc/v20200210/api.json +61 -1
  6. tccli/services/cdb/cdb_client.py +53 -0
  7. tccli/services/cdb/v20170320/api.json +72 -0
  8. tccli/services/cdb/v20170320/examples.json +8 -0
  9. tccli/services/cls/v20201016/api.json +3 -3
  10. tccli/services/dbbrain/v20210527/api.json +14 -5
  11. tccli/services/dbdc/v20201029/api.json +72 -72
  12. tccli/services/dcdb/v20180411/api.json +3 -3
  13. tccli/services/dcdb/v20180411/examples.json +1 -1
  14. tccli/services/ecm/v20190719/api.json +17 -11
  15. tccli/services/ecm/v20190719/examples.json +1 -1
  16. tccli/services/ess/v20201111/api.json +1 -1
  17. tccli/services/essbasic/v20210526/api.json +1 -1
  18. tccli/services/hunyuan/v20230901/api.json +4 -4
  19. tccli/services/iotexplorer/iotexplorer_client.py +216 -4
  20. tccli/services/iotexplorer/v20190423/api.json +146 -1
  21. tccli/services/iotexplorer/v20190423/examples.json +34 -2
  22. tccli/services/lcic/v20220817/api.json +110 -111
  23. tccli/services/lcic/v20220817/examples.json +40 -40
  24. tccli/services/lkeap/__init__.py +4 -0
  25. tccli/services/lkeap/lkeap_client.py +1479 -0
  26. tccli/services/lkeap/v20240522/api.json +1973 -0
  27. tccli/services/lkeap/v20240522/examples.json +223 -0
  28. tccli/services/mna/v20210119/api.json +7 -7
  29. tccli/services/mna/v20210119/examples.json +9 -9
  30. tccli/services/mongodb/v20180408/api.json +153 -112
  31. tccli/services/mongodb/v20180408/examples.json +2 -2
  32. tccli/services/mongodb/v20190725/api.json +202 -167
  33. tccli/services/mongodb/v20190725/examples.json +8 -8
  34. tccli/services/monitor/v20180724/api.json +19 -0
  35. tccli/services/ocr/v20181119/api.json +10 -10
  36. tccli/services/ocr/v20181119/examples.json +15 -15
  37. tccli/services/sqlserver/v20180328/api.json +43 -5
  38. tccli/services/sqlserver/v20180328/examples.json +2 -2
  39. tccli/services/ssl/v20191205/api.json +1 -1
  40. tccli/services/tcb/v20180608/api.json +281 -258
  41. tccli/services/tcb/v20180608/examples.json +18 -18
  42. tccli/services/tcbr/v20220217/api.json +46 -13
  43. tccli/services/tcbr/v20220217/examples.json +2 -8
  44. tccli/services/tcr/v20190924/api.json +125 -121
  45. tccli/services/tcr/v20190924/examples.json +53 -53
  46. tccli/services/tdmq/tdmq_client.py +57 -4
  47. tccli/services/tdmq/v20200217/api.json +107 -0
  48. tccli/services/tdmq/v20200217/examples.json +8 -0
  49. tccli/services/trtc/v20190722/api.json +33 -33
  50. tccli/services/vdb/v20230616/api.json +2 -2
  51. tccli/services/vpc/v20170312/api.json +38 -25
  52. tccli/services/vpc/v20170312/examples.json +29 -7
  53. tccli/services/wedata/v20210820/api.json +34 -1
  54. {tccli-3.0.1245.1.dist-info → tccli-3.0.1247.1.dist-info}/METADATA +2 -2
  55. {tccli-3.0.1245.1.dist-info → tccli-3.0.1247.1.dist-info}/RECORD +58 -54
  56. {tccli-3.0.1245.1.dist-info → tccli-3.0.1247.1.dist-info}/WHEEL +0 -0
  57. {tccli-3.0.1245.1.dist-info → tccli-3.0.1247.1.dist-info}/entry_points.txt +0 -0
  58. {tccli-3.0.1245.1.dist-info → tccli-3.0.1247.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/lkeap/v20240522/api.json ADDED
@@ -0,0 +1,1973 @@
1
+ {
2
+ "actions": {
3
+ "CreateAttributeLabel": {
4
+ "document": "用于为问答对创建属性标签，以便对内容进行分类和管理。 使用场景：当需要为问答对添加分类标签和属性标记时使用，比如为问答对添加“售后”标签。",
5
+ "input": "CreateAttributeLabelRequest",
6
+ "name": "创建属性标签",
7
+ "output": "CreateAttributeLabelResponse",
8
+ "status": "online"
9
+ },
10
+ "CreateKnowledgeBase": {
11
+ "document": "用于在系统中创建一个新的知识库。知识库是一个用于存储和管理知识条目的集合，可以包括文档、问答对、属性标签等。创建知识库后，可以向其中添加各种知识条目，以便在后续的知识检索中使用。 使用场景：当需要在系统中建立一个新的知识库以存储和管理特定领域或项目的知识条目时使用。例如，一个用户可能需要创建一个知识库，以存储用户指南、常见问题解答和技术文档。",
12
+ "input": "CreateKnowledgeBaseRequest",
13
+ "name": "创建知识库",
14
+ "output": "CreateKnowledgeBaseResponse",
15
+ "status": "online"
16
+ },
17
+ "CreateQA": {
18
+ "document": "用于创建新的问答对。问答对可以在SearchKnowledge接口知识检索时提供匹配的答案。 使用场景：当需要添加新的知识点和对应的问答对时使用，比如为产品添加新的常见问题解答。",
19
+ "input": "CreateQARequest",
20
+ "name": "创建问答对",
21
+ "output": "CreateQAResponse",
22
+ "status": "online"
23
+ },
24
+ "CreateReconstructDocumentFlow": {
25
+ "document": "本接口为异步接口的发起请求接口，用于发起文档解析任务。\n文档解析支持将图片或PDF文件转换成Markdown格式文件，可解析包括表格、公式、图片、标题、段落、页眉、页脚等内容元素，并将内容智能转换成阅读顺序。\n\n体验期间单账号限制qps仅为1，若有正式接入需要请与产研团队沟通开放。",
26
+ "input": "CreateReconstructDocumentFlowRequest",
27
+ "name": "创建文档解析任务",
28
+ "output": "CreateReconstructDocumentFlowResponse",
29
+ "status": "online"
30
+ },
31
+ "CreateSplitDocumentFlow": {
32
+ "document": "创建文档拆分任务",
33
+ "input": "CreateSplitDocumentFlowRequest",
34
+ "name": "创建文档拆分任务",
35
+ "output": "CreateSplitDocumentFlowResponse",
36
+ "status": "online"
37
+ },
38
+ "DeleteAttributeLabels": {
39
+ "document": "用于删除不再需要的属性标签。 使用场景：当某个标签不再使用时，可以将其删除以保持标签系统的整洁。",
40
+ "input": "DeleteAttributeLabelsRequest",
41
+ "name": "批量删除属性标签",
42
+ "output": "DeleteAttributeLabelsResponse",
43
+ "status": "online"
44
+ },
45
+ "DeleteDocs": {
46
+ "document": "用于删除已有的文档。 使用场景：当某个文档不再需要时，可以将其删除以保持文档库的整洁。",
47
+ "input": "DeleteDocsRequest",
48
+ "name": "删除文档",
49
+ "output": "DeleteDocsResponse",
50
+ "status": "online"
51
+ },
52
+ "DeleteKnowledgeBase": {
53
+ "document": "用于从系统中删除一个现有的知识库。删除知识库将移除该知识库及其所有关联的知识条目（如文档、问答对、属性标签等）。该操作是不可逆的，请在执行前确认是否需要删除。**使用场景**：当某个知识库不再需要时，可以使用此接口将其从系统中删除。例如，一个项目结束后，其相关的知识库可能不再需要存储，可以使用该接口进行删除。",
54
+ "input": "DeleteKnowledgeBaseRequest",
55
+ "name": "删除知识库",
56
+ "output": "DeleteKnowledgeBaseResponse",
57
+ "status": "online"
58
+ },
59
+ "DeleteQAs": {
60
+ "document": "用于删除已有的问答对。 使用场景：当某个问答对不再适用或需要移除时使用。",
61
+ "input": "DeleteQAsRequest",
62
+ "name": "删除问答对",
63
+ "output": "DeleteQAsResponse",
64
+ "status": "online"
65
+ },
66
+ "DescribeDoc": {
67
+ "document": "用于查询特定文档的详细信息。 使用场景：当需要查看某个文档的具体内容和属性时使用。",
68
+ "input": "DescribeDocRequest",
69
+ "name": "查询文档详情",
70
+ "output": "DescribeDocResponse",
71
+ "status": "online"
72
+ },
73
+ "GetEmbedding": {
74
+ "document": "本接口（GetEmbedding）调用文本表示模型，将文本转化为用数值表示的向量形式，可用于文本检索、信息推荐、知识挖掘等场景。\n本接口（GetEmbedding）有单账号调用上限控制，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
75
+ "input": "GetEmbeddingRequest",
76
+ "name": "获取特征向量",
77
+ "output": "GetEmbeddingResponse",
78
+ "status": "online"
79
+ },
80
+ "GetReconstructDocumentResult": {
81
+ "document": "本接口为异步接口的查询结果接口，用于获取文档解析处理结果。",
82
+ "input": "GetReconstructDocumentResultRequest",
83
+ "name": "查询文档解析任务结果",
84
+ "output": "GetReconstructDocumentResultResponse",
85
+ "status": "online"
86
+ },
87
+ "GetSplitDocumentResult": {
88
+ "document": "查询文档拆分任务结果",
89
+ "input": "GetSplitDocumentResultRequest",
90
+ "name": "查询文档拆分任务结果",
91
+ "output": "GetSplitDocumentResultResponse",
92
+ "status": "online"
93
+ },
94
+ "ImportQAs": {
95
+ "document": "用于批量导入问答对，最多支持50,000条数据导入。通过此接口，可以将多个问答对一次性导入系统中，以便在后续的知识检索中使用。导入的问答对可以来自外部系统、文件或其他数据源。使用场景：当需要一次性导入大量的问答对时使用。例如，一个公司可能需要将其产品的常见问题解答从一个文档或外部系统批量导入到知识库中，以便用户可以通过知识检索系统进行查询。",
96
+ "input": "ImportQAsRequest",
97
+ "name": "批量导入问答对",
98
+ "output": "ImportQAsResponse",
99
+ "status": "online"
100
+ },
101
+ "ListAttributeLabels": {
102
+ "document": "用于获取所有属性标签的列表。 使用场景：用于查看当前系统中所有已有的属性标签，方便进行管理和维护。",
103
+ "input": "ListAttributeLabelsRequest",
104
+ "name": "获取属性标签列表",
105
+ "output": "ListAttributeLabelsResponse",
106
+ "status": "online"
107
+ },
108
+ "ListDocs": {
109
+ "document": "用于获取所有文档的列表。 使用场景：用于查看当前系统中所有已有的文档，方便进行管理和维护。",
110
+ "input": "ListDocsRequest",
111
+ "name": "获取文档列表",
112
+ "output": "ListDocsResponse",
113
+ "status": "online"
114
+ },
115
+ "ListQAs": {
116
+ "document": "用于获取所有问答对的列表。 使用场景：用于查看当前系统中所有已有的问答对，方便进行管理和维护。",
117
+ "input": "ListQAsRequest",
118
+ "name": "获取问答对列表",
119
+ "output": "ListQAsResponse",
120
+ "status": "online"
121
+ },
122
+ "ModifyAttributeLabel": {
123
+ "document": "用于修改已有的属性标签。 使用场景：当需要更改属性标签的名称或描述时使用，比如将“售后”标签改为“售前”。",
124
+ "input": "ModifyAttributeLabelRequest",
125
+ "name": "修改属性标签",
126
+ "output": "ModifyAttributeLabelResponse",
127
+ "status": "online"
128
+ },
129
+ "ModifyQA": {
130
+ "document": "用于修改已有的问答对。 使用场景：当需要更新问答对的内容或答案时使用。",
131
+ "input": "ModifyQARequest",
132
+ "name": "修改问答对",
133
+ "output": "ModifyQAResponse",
134
+ "status": "online"
135
+ },
136
+ "QueryRewrite": {
137
+ "document": "多轮改写（QueryRewrite）主要用于多轮对话中，进行指代消解和省略补全。使用本接口，无需输入prompt描述，根据对话历史即可生成更精确的用户查询。在应用场景上，本接口可应用于智能问答、对话式搜索等多种场景。\n开通[产品体验](https://lke.cloud.tencent.com/lke/#/trialProduct)后可获得50wtoken体验额度。本接口（QueryRewrite）有单账号调用上限控制，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
138
+ "input": "QueryRewriteRequest",
139
+ "name": "多轮改写",
140
+ "output": "QueryRewriteResponse",
141
+ "status": "online"
142
+ },
143
+ "ReconstructDocumentSSE": {
144
+ "document": "准实时文档解析接口，使用HTTP SSE 协议通信。",
145
+ "input": "ReconstructDocumentSSERequest",
146
+ "name": "实时文档解析",
147
+ "output": "ReconstructDocumentSSEResponse",
148
+ "status": "online"
149
+ },
150
+ "RetrieveKnowledge": {
151
+ "document": "用于检索知识库中的文档和问答对内容。 使用场景：适用于查询长期存储在知识库中的文档和问答对，比如产品手册、用户指南等内容的检索。",
152
+ "input": "RetrieveKnowledgeRequest",
153
+ "name": "检索知识库内容",
154
+ "output": "RetrieveKnowledgeResponse",
155
+ "status": "online"
156
+ },
157
+ "RunRerank": {
158
+ "document": "基于知识引擎精调模型技术的rerank模型，支持对多路召回的结果进行重排序，根据query与切片内容的相关性，按分数由高到低对切片进行排序，并输出对应的打分结果。",
159
+ "input": "RunRerankRequest",
160
+ "name": "重排序",
161
+ "output": "RunRerankResponse",
162
+ "status": "online"
163
+ },
164
+ "UploadDoc": {
165
+ "document": "用于上传文档内容。上传的文档将存储在知识库中，可以通过SearchKnowledge知识库内容检索接口进行检索。 \n使用场景：适用于需要长期存储和检索的文档内容，如产品手册、用户指南等。",
166
+ "input": "UploadDocRequest",
167
+ "name": "上传文档",
168
+ "output": "UploadDocResponse",
169
+ "status": "online"
170
+ },
171
+ "UploadDocRealtime": {
172
+ "document": "用于上传实时文档内容。实时文档在上传后可以立即通过SearchRealtime进行实时检索，适用于在会话中对文档进行问答的场景。",
173
+ "input": "UploadDocRealtimeRequest",
174
+ "name": "实时文档上传",
175
+ "output": "UploadDocRealtimeResponse",
176
+ "status": "online"
177
+ }
178
+ },
179
+ "metadata": {
180
+ "apiVersion": "2024-05-22",
181
+ "api_brief": "支持直接通过API调用大模型能力。",
182
+ "serviceNameCN": "知识引擎原子能力",
183
+ "serviceShortName": "lkeap"
184
+ },
185
+ "objects": {
186
+ "AttributeItem": {
187
+ "document": "属性信息",
188
+ "members": [
189
+ {
190
+ "disabled": false,
191
+ "document": "属性id\n注意：此字段可能返回 null，表示取不到有效值。",
192
+ "example": "无",
193
+ "member": "string",
194
+ "name": "AttributeId",
195
+ "output_required": false,
196
+ "required": false,
197
+ "type": "string",
198
+ "value_allowed_null": true
199
+ },
200
+ {
201
+ "disabled": false,
202
+ "document": "属性标识\n注意：此字段可能返回 null，表示取不到有效值。",
203
+ "example": "无",
204
+ "member": "string",
205
+ "name": "AttributeKey",
206
+ "output_required": false,
207
+ "required": false,
208
+ "type": "string",
209
+ "value_allowed_null": true
210
+ },
211
+ {
212
+ "disabled": false,
213
+ "document": "属性名称\n注意：此字段可能返回 null，表示取不到有效值。",
214
+ "example": "无",
215
+ "member": "string",
216
+ "name": "AttributeName",
217
+ "output_required": false,
218
+ "required": false,
219
+ "type": "string",
220
+ "value_allowed_null": true
221
+ },
222
+ {
223
+ "disabled": false,
224
+ "document": "标签名称\n注意：此字段可能返回 null，表示取不到有效值。",
225
+ "example": "无",
226
+ "member": "AttributeLabelItem",
227
+ "name": "Labels",
228
+ "output_required": false,
229
+ "required": false,
230
+ "type": "list",
231
+ "value_allowed_null": true
232
+ }
233
+ ],
234
+ "usage": "both"
235
+ },
236
+ "AttributeLabelItem": {
237
+ "document": "属性标签信息",
238
+ "members": [
239
+ {
240
+ "disabled": false,
241
+ "document": "标签id\n注意：此字段可能返回 null，表示取不到有效值。",
242
+ "example": "无",
243
+ "member": "string",
244
+ "name": "LabelId",
245
+ "output_required": false,
246
+ "required": false,
247
+ "type": "string",
248
+ "value_allowed_null": true
249
+ },
250
+ {
251
+ "disabled": false,
252
+ "document": "标签名称，最大80个英文字符\n注意：此字段可能返回 null，表示取不到有效值。",
253
+ "example": "无",
254
+ "member": "string",
255
+ "name": "LabelName",
256
+ "output_required": false,
257
+ "required": false,
258
+ "type": "string",
259
+ "value_allowed_null": true
260
+ }
261
+ ],
262
+ "usage": "both"
263
+ },
264
+ "AttributeLabelReferItem": {
265
+ "document": "属性标签引用",
266
+ "members": [
267
+ {
268
+ "disabled": false,
269
+ "document": "属性id\n注意：此字段可能返回 null，表示取不到有效值。",
270
+ "example": "无",
271
+ "member": "string",
272
+ "name": "AttributeId",
273
+ "output_required": false,
274
+ "required": false,
275
+ "type": "string",
276
+ "value_allowed_null": true
277
+ },
278
+ {
279
+ "disabled": false,
280
+ "document": "标签id\n注意：此字段可能返回 null，表示取不到有效值。",
281
+ "example": "无",
282
+ "member": "string",
283
+ "name": "LabelIds",
284
+ "output_required": false,
285
+ "required": false,
286
+ "type": "list",
287
+ "value_allowed_null": true
288
+ }
289
+ ],
290
+ "usage": "both"
291
+ },
292
+ "CreateAttributeLabelRequest": {
293
+ "document": "CreateAttributeLabel请求参数结构体",
294
+ "members": [
295
+ {
296
+ "disabled": false,
297
+ "document": "属性标签信息",
298
+ "example": "无",
299
+ "member": "AttributeLabelItem",
300
+ "name": "Labels",
301
+ "required": false,
302
+ "type": "list"
303
+ }
304
+ ],
305
+ "type": "object"
306
+ },
307
+ "CreateAttributeLabelResponse": {
308
+ "document": "CreateAttributeLabel返回参数结构体",
309
+ "members": [
310
+ {
311
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
312
+ "member": "string",
313
+ "name": "RequestId",
314
+ "type": "string"
315
+ }
316
+ ],
317
+ "type": "object"
318
+ },
319
+ "CreateKnowledgeBaseRequest": {
320
+ "document": "CreateKnowledgeBase请求参数结构体",
321
+ "members": [],
322
+ "type": "object"
323
+ },
324
+ "CreateKnowledgeBaseResponse": {
325
+ "document": "CreateKnowledgeBase返回参数结构体",
326
+ "members": [
327
+ {
328
+ "disabled": false,
329
+ "document": "知识库ID",
330
+ "example": "4901991032",
331
+ "member": "string",
332
+ "name": "KnowledgeBaseId",
333
+ "output_required": false,
334
+ "type": "string",
335
+ "value_allowed_null": false
336
+ },
337
+ {
338
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
339
+ "member": "string",
340
+ "name": "RequestId",
341
+ "type": "string"
342
+ }
343
+ ],
344
+ "type": "object"
345
+ },
346
+ "CreateQARequest": {
347
+ "document": "CreateQA请求参数结构体",
348
+ "members": [
349
+ {
350
+ "disabled": false,
351
+ "document": "属性标签",
352
+ "example": "无",
353
+ "member": "AttributeLabelReferItem",
354
+ "name": "AttributeLabels",
355
+ "required": false,
356
+ "type": "list"
357
+ }
358
+ ],
359
+ "type": "object"
360
+ },
361
+ "CreateQAResponse": {
362
+ "document": "CreateQA返回参数结构体",
363
+ "members": [
364
+ {
365
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
366
+ "member": "string",
367
+ "name": "RequestId",
368
+ "type": "string"
369
+ }
370
+ ],
371
+ "type": "object"
372
+ },
373
+ "CreateReconstructDocumentFlowConfig": {
374
+ "document": "创建智能文档解析任务的配置信息",
375
+ "members": [
376
+ {
377
+ "disabled": false,
378
+ "document": "Markdown文件中表格返回的形式\n0，表格以MD形式返回\n1，表格以HTML形式返回\n默认为1",
379
+ "example": "1",
380
+ "member": "string",
381
+ "name": "TableResultType",
382
+ "required": false,
383
+ "type": "string"
384
+ },
385
+ {
386
+ "disabled": false,
387
+ "document": "智能文档解析返回结果的格式\n0：只返回全文MD；\n1：只返回每一页的OCR原始Json；\n2：只返回每一页的MD，\n3：返回全文MD + 每一页的OCR原始Json；\n4：返回全文MD + 每一页的MD，\n默认值为3（返回全文MD + 每一页的OCR原始Json）\n\n",
388
+ "example": "3",
389
+ "member": "string",
390
+ "name": "ResultType",
391
+ "required": false,
392
+ "type": "string"
393
+ }
394
+ ],
395
+ "usage": "in"
396
+ },
397
+ "CreateReconstructDocumentFlowRequest": {
398
+ "document": "CreateReconstructDocumentFlow请求参数结构体",
399
+ "members": [
400
+ {
401
+ "disabled": false,
402
+ "document": "文件类型。\n\n**支持的文件类型：**\n- `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`\n\n**支持的文件大小：**\n - `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M\n - `TXT`、`MD` 最大10M\n - 其他 最大20M\n",
403
+ "example": "PDF",
404
+ "member": "string",
405
+ "name": "FileType",
406
+ "required": true,
407
+ "type": "string"
408
+ },
409
+ {
410
+ "disabled": false,
411
+ "document": "文件的 URL 地址。\n文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。\n参考：[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)",
412
+ "example": "无",
413
+ "member": "string",
414
+ "name": "FileUrl",
415
+ "required": false,
416
+ "type": "string"
417
+ },
418
+ {
419
+ "disabled": false,
420
+ "document": "文件的 Base64 值。\n支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。\n支持的图片像素：单边介于20-10000px之间。\n文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。",
421
+ "example": "无",
422
+ "member": "string",
423
+ "name": "FileBase64",
424
+ "required": false,
425
+ "type": "string"
426
+ },
427
+ {
428
+ "disabled": false,
429
+ "document": "文档的起始页码。\n当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的起始页码，识别的页码包含当前值。",
430
+ "example": "1",
431
+ "member": "int64",
432
+ "name": "FileStartPageNumber",
433
+ "required": false,
434
+ "type": "int"
435
+ },
436
+ {
437
+ "disabled": false,
438
+ "document": "文档的结束页码。\n当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的结束页码，识别的页码包含当前值。",
439
+ "example": "100",
440
+ "member": "int64",
441
+ "name": "FileEndPageNumber",
442
+ "required": false,
443
+ "type": "int"
444
+ },
445
+ {
446
+ "disabled": false,
447
+ "document": "创建文档解析任务配置信息。",
448
+ "example": "{\"TableResultType\":\"1\"}",
449
+ "member": "CreateReconstructDocumentFlowConfig",
450
+ "name": "Config",
451
+ "required": false,
452
+ "type": "object"
453
+ }
454
+ ],
455
+ "type": "object"
456
+ },
457
+ "CreateReconstructDocumentFlowResponse": {
458
+ "document": "CreateReconstructDocumentFlow返回参数结构体",
459
+ "members": [
460
+ {
461
+ "disabled": false,
462
+ "document": "任务唯一id。30天内可以通过GetReconstructDocumentResult接口查询TaskId对应的处理结果。",
463
+ "example": "无",
464
+ "member": "string",
465
+ "name": "TaskId",
466
+ "output_required": true,
467
+ "type": "string",
468
+ "value_allowed_null": false
469
+ },
470
+ {
471
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
472
+ "member": "string",
473
+ "name": "RequestId",
474
+ "type": "string"
475
+ }
476
+ ],
477
+ "type": "object"
478
+ },
479
+ "CreateSplitDocumentFlowConfig": {
480
+ "document": "创建智能文档拆分任务的配置信息",
481
+ "members": [
482
+ {
483
+ "disabled": true,
484
+ "document": "Markdown文件中表格返回的形式\n0，表格以MD形式返回\n1，表格以HTML形式返回\n默认为",
485
+ "example": "1",
486
+ "member": "string",
487
+ "name": "TableResultType",
488
+ "required": false,
489
+ "type": "string"
490
+ },
491
+ {
492
+ "disabled": true,
493
+ "document": "智能文档解析返回结果的格式\n0：只返回全文MD；\n1：只返回每一页的OCR原始Json；\n2：只返回每一页的MD，\n3：返回全文MD + 每一页的OCR原始Json；\n4：返回全文MD + 每一页的MD，\n默认值为3（返回全文MD + 每一页的OCR原始Json）\n\n",
494
+ "example": "3",
495
+ "member": "string",
496
+ "name": "ResultType",
497
+ "required": false,
498
+ "type": "string"
499
+ },
500
+ {
501
+ "disabled": false,
502
+ "document": "是否开启mllm",
503
+ "example": "true",
504
+ "member": "bool",
505
+ "name": "EnableMllm",
506
+ "required": false,
507
+ "type": "bool"
508
+ },
509
+ {
510
+ "disabled": false,
511
+ "document": "最大分片长度",
512
+ "example": "4800",
513
+ "member": "int64",
514
+ "name": "MaxChunkSize",
515
+ "required": false,
516
+ "type": "int"
517
+ }
518
+ ],
519
+ "usage": "in"
520
+ },
521
+ "CreateSplitDocumentFlowRequest": {
522
+ "document": "CreateSplitDocumentFlow请求参数结构体",
523
+ "members": [
524
+ {
525
+ "disabled": false,
526
+ "document": "文件类型。支持的文件类型：PDF、DOC、DOCX、XLS、XLSX、PPT、PPTX、MD、TXT、PNG、JPG、JPEG、CSV",
527
+ "example": "PDF",
528
+ "member": "string",
529
+ "name": "FileType",
530
+ "required": true,
531
+ "type": "string"
532
+ },
533
+ {
534
+ "disabled": false,
535
+ "document": "文件的 Url 地址。文件存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
536
+ "example": "无",
537
+ "member": "string",
538
+ "name": "FileUrl",
539
+ "required": true,
540
+ "type": "string"
541
+ },
542
+ {
543
+ "disabled": false,
544
+ "document": "文件名，可选，当文件名无法从传入的FileUrl获取时需要通过该字段来明确",
545
+ "example": "yourfile.pdf",
546
+ "member": "string",
547
+ "name": "FileName",
548
+ "required": false,
549
+ "type": "string"
550
+ },
551
+ {
552
+ "disabled": true,
553
+ "document": "文件的 Base64 值。支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。支持的图片像素：单边介于20-10000px之间。文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。",
554
+ "example": "无",
555
+ "member": "string",
556
+ "name": "FileBase64",
557
+ "required": false,
558
+ "type": "string"
559
+ },
560
+ {
561
+ "disabled": false,
562
+ "document": "当传入文件是PDF类型时，用来指定pdf识别的起始页码，识别的页码包含当前值",
563
+ "example": "1",
564
+ "member": "int64",
565
+ "name": "FileStartPageNumber",
566
+ "required": false,
567
+ "type": "int"
568
+ },
569
+ {
570
+ "disabled": false,
571
+ "document": "当传入文件是PDF类型时，用来指定pdf识别的结束页码，识别的页码包含当前值。",
572
+ "example": "100",
573
+ "member": "int64",
574
+ "name": "FileEndPageNumber",
575
+ "required": false,
576
+ "type": "int"
577
+ },
578
+ {
579
+ "disabled": false,
580
+ "document": "创建文档拆分任务配置信息创建文档解析任务配置信息\t\t",
581
+ "example": "{\"TableResultType\":\"1\"}\t",
582
+ "member": "CreateSplitDocumentFlowConfig",
583
+ "name": "Config",
584
+ "required": false,
585
+ "type": "object"
586
+ }
587
+ ],
588
+ "type": "object"
589
+ },
590
+ "CreateSplitDocumentFlowResponse": {
591
+ "document": "CreateSplitDocumentFlow返回参数结构体",
592
+ "members": [
593
+ {
594
+ "disabled": false,
595
+ "document": "任务唯一id。30天内可以通过GetSplitDocumentResult接口查询TaskId对应的处理结果。",
596
+ "example": "无",
597
+ "member": "string",
598
+ "name": "TaskId",
599
+ "output_required": true,
600
+ "type": "string",
601
+ "value_allowed_null": false
602
+ },
603
+ {
604
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
605
+ "member": "string",
606
+ "name": "RequestId",
607
+ "type": "string"
608
+ }
609
+ ],
610
+ "type": "object"
611
+ },
612
+ "DeleteAttributeLabelsRequest": {
613
+ "document": "DeleteAttributeLabels请求参数结构体",
614
+ "members": [],
615
+ "type": "object"
616
+ },
617
+ "DeleteAttributeLabelsResponse": {
618
+ "document": "DeleteAttributeLabels返回参数结构体",
619
+ "members": [
620
+ {
621
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
622
+ "member": "string",
623
+ "name": "RequestId",
624
+ "type": "string"
625
+ }
626
+ ],
627
+ "type": "object"
628
+ },
629
+ "DeleteDocsRequest": {
630
+ "document": "DeleteDocs请求参数结构体",
631
+ "members": [],
632
+ "type": "object"
633
+ },
634
+ "DeleteDocsResponse": {
635
+ "document": "DeleteDocs返回参数结构体",
636
+ "members": [
637
+ {
638
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
639
+ "member": "string",
640
+ "name": "RequestId",
641
+ "type": "string"
642
+ }
643
+ ],
644
+ "type": "object"
645
+ },
646
+ "DeleteKnowledgeBaseRequest": {
647
+ "document": "DeleteKnowledgeBase请求参数结构体",
648
+ "members": [
649
+ {
650
+ "disabled": false,
651
+ "document": "知识库ID",
652
+ "example": "41019910164",
653
+ "member": "string",
654
+ "name": "KnowledgeBaseId",
655
+ "required": true,
656
+ "type": "string"
657
+ }
658
+ ],
659
+ "type": "object"
660
+ },
661
+ "DeleteKnowledgeBaseResponse": {
662
+ "document": "DeleteKnowledgeBase返回参数结构体",
663
+ "members": [
664
+ {
665
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
666
+ "member": "string",
667
+ "name": "RequestId",
668
+ "type": "string"
669
+ }
670
+ ],
671
+ "type": "object"
672
+ },
673
+ "DeleteQAsRequest": {
674
+ "document": "DeleteQAs请求参数结构体",
675
+ "members": [],
676
+ "type": "object"
677
+ },
678
+ "DeleteQAsResponse": {
679
+ "document": "DeleteQAs返回参数结构体",
680
+ "members": [
681
+ {
682
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
683
+ "member": "string",
684
+ "name": "RequestId",
685
+ "type": "string"
686
+ }
687
+ ],
688
+ "type": "object"
689
+ },
690
+ "DescribeDocRequest": {
691
+ "document": "DescribeDoc请求参数结构体",
692
+ "members": [],
693
+ "type": "object"
694
+ },
695
+ "DescribeDocResponse": {
696
+ "document": "DescribeDoc返回参数结构体",
697
+ "members": [
698
+ {
699
+ "disabled": false,
700
+ "document": "属性标签",
701
+ "example": "无",
702
+ "member": "AttributeLabelReferItem",
703
+ "name": "AttributeLabels",
704
+ "output_required": false,
705
+ "type": "list",
706
+ "value_allowed_null": false
707
+ },
708
+ {
709
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
710
+ "member": "string",
711
+ "name": "RequestId",
712
+ "type": "string"
713
+ }
714
+ ],
715
+ "type": "object"
716
+ },
717
+ "DocItem": {
718
+ "document": "离线文档列表回包",
719
+ "members": [
720
+ {
721
+ "disabled": false,
722
+ "document": "文档id\n注意：此字段可能返回 null，表示取不到有效值。",
723
+ "example": "无",
724
+ "member": "string",
725
+ "name": "DocId",
726
+ "output_required": false,
727
+ "required": false,
728
+ "type": "string",
729
+ "value_allowed_null": true
730
+ },
731
+ {
732
+ "disabled": false,
733
+ "document": " 状态，\n- Uploading 上传中 \n- Parsing 解析中 \n- ParseFailed 解析失败\n- Indexing 创建索引中 \n- IndexFailed 创建索引失败\n- Success 发布成功\n- Failed 失败\n注意：此字段可能返回 null，表示取不到有效值。",
734
+ "example": "无",
735
+ "member": "string",
736
+ "name": "Status",
737
+ "output_required": false,
738
+ "required": false,
739
+ "type": "string",
740
+ "value_allowed_null": true
741
+ },
742
+ {
743
+ "disabled": false,
744
+ "document": "文件名\n注意：此字段可能返回 null，表示取不到有效值。",
745
+ "example": "无",
746
+ "member": "string",
747
+ "name": "FileName",
748
+ "output_required": false,
749
+ "required": false,
750
+ "type": "string",
751
+ "value_allowed_null": true
752
+ },
753
+ {
754
+ "disabled": false,
755
+ "document": "更新时间\n注意：此字段可能返回 null，表示取不到有效值。",
756
+ "example": "无",
757
+ "member": "string",
758
+ "name": "UpdateTime",
759
+ "output_required": false,
760
+ "required": false,
761
+ "type": "string",
762
+ "value_allowed_null": true
763
+ },
764
+ {
765
+ "disabled": false,
766
+ "document": "属性标签\n注意：此字段可能返回 null，表示取不到有效值。",
767
+ "example": "无",
768
+ "member": "AttributeLabelReferItem",
769
+ "name": "AttributeLabels",
770
+ "output_required": false,
771
+ "required": false,
772
+ "type": "list",
773
+ "value_allowed_null": true
774
+ }
775
+ ],
776
+ "usage": "both"
777
+ },
778
+ "DocumentUsage": {
779
+ "document": "文档拆分任务的用量",
780
+ "members": [
781
+ {
782
+ "disabled": false,
783
+ "document": "文档拆分任务的页数",
784
+ "example": "10",
785
+ "member": "int64",
786
+ "name": "PageNumber",
787
+ "output_required": false,
788
+ "type": "int",
789
+ "value_allowed_null": false
790
+ },
791
+ {
792
+ "disabled": true,
793
+ "document": "文档拆分任务消耗的总token数",
794
+ "example": "2048",
795
+ "member": "int64",
796
+ "name": "TotalToken",
797
+ "output_required": false,
798
+ "type": "int",
799
+ "value_allowed_null": false
800
+ },
801
+ {
802
+ "disabled": false,
803
+ "document": "文档拆分任务消耗的总token数",
804
+ "example": "2048",
805
+ "member": "int64",
806
+ "name": "TotalTokens",
807
+ "output_required": false,
808
+ "type": "int",
809
+ "value_allowed_null": false
810
+ }
811
+ ],
812
+ "usage": "out"
813
+ },
814
+ "EmbeddingObject": {
815
+ "document": "向量",
816
+ "members": [
817
+ {
818
+ "disabled": false,
819
+ "document": "向量",
820
+ "example": "无",
821
+ "member": "float",
822
+ "name": "Embedding",
823
+ "output_required": false,
824
+ "required": false,
825
+ "type": "list",
826
+ "value_allowed_null": false
827
+ }
828
+ ],
829
+ "usage": "both"
830
+ },
831
+ "GetEmbeddingRequest": {
832
+ "document": "GetEmbedding请求参数结构体",
833
+ "members": [
834
+ {
835
+ "disabled": false,
836
+ "document": "模型名称",
837
+ "example": "lke-text-embedding-v1",
838
+ "member": "string",
839
+ "name": "Model",
840
+ "required": true,
841
+ "type": "string"
842
+ },
843
+ {
844
+ "disabled": false,
845
+ "document": "需要 embedding 的文本, 单条文本最大长度500个字符, 总条数最大7条",
846
+ "example": "[\"hello\", \"world\"]",
847
+ "member": "string",
848
+ "name": "Inputs",
849
+ "required": true,
850
+ "type": "list"
851
+ }
852
+ ],
853
+ "type": "object"
854
+ },
855
+ "GetEmbeddingResponse": {
856
+ "document": "GetEmbedding返回参数结构体",
857
+ "members": [
858
+ {
859
+ "disabled": false,
860
+ "document": "特征",
861
+ "example": "无",
862
+ "member": "EmbeddingObject",
863
+ "name": "Data",
864
+ "output_required": true,
865
+ "type": "list",
866
+ "value_allowed_null": false
867
+ },
868
+ {
869
+ "disabled": false,
870
+ "document": "消耗量，返回TotalToken",
871
+ "example": "{\"TotalTokens\":3}",
872
+ "member": "Usage",
873
+ "name": "Usage",
874
+ "output_required": false,
875
+ "type": "object",
876
+ "value_allowed_null": false
877
+ },
878
+ {
879
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
880
+ "member": "string",
881
+ "name": "RequestId",
882
+ "type": "string"
883
+ }
884
+ ],
885
+ "type": "object"
886
+ },
887
+ "GetReconstructDocumentResultRequest": {
888
+ "document": "GetReconstructDocumentResult请求参数结构体",
889
+ "members": [
890
+ {
891
+ "disabled": false,
892
+ "document": "解析任务ID",
893
+ "example": "无",
894
+ "member": "string",
895
+ "name": "TaskId",
896
+ "required": true,
897
+ "type": "string"
898
+ }
899
+ ],
900
+ "type": "object"
901
+ },
902
+ "GetReconstructDocumentResultResponse": {
903
+ "document": "GetReconstructDocumentResult返回参数结构体",
904
+ "members": [
905
+ {
906
+ "disabled": false,
907
+ "document": "任务状态。- `Success`：执行完成- `Processing`：执行中- `Pause`: 暂停- `Failed`：执行失败- `WaitExecute`：等待执行",
908
+ "example": "Success",
909
+ "member": "string",
910
+ "name": "Status",
911
+ "output_required": false,
912
+ "type": "string",
913
+ "value_allowed_null": false
914
+ },
915
+ {
916
+ "disabled": false,
917
+ "document": "解析结果的临时下载地址。文件类型为zip压缩包，下载链接有效期30分钟",
918
+ "example": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.zip",
919
+ "member": "string",
920
+ "name": "DocumentRecognizeResultUrl",
921
+ "output_required": false,
922
+ "type": "string",
923
+ "value_allowed_null": false
924
+ },
925
+ {
926
+ "disabled": false,
927
+ "document": "文档解析失败的页码",
928
+ "example": "无",
929
+ "member": "ReconstructDocumentFailedPage",
930
+ "name": "FailedPages",
931
+ "output_required": false,
932
+ "type": "list",
933
+ "value_allowed_null": false
934
+ },
935
+ {
936
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
937
+ "member": "string",
938
+ "name": "RequestId",
939
+ "type": "string"
940
+ }
941
+ ],
942
+ "type": "object"
943
+ },
944
+ "GetSplitDocumentResultRequest": {
945
+ "document": "GetSplitDocumentResult请求参数结构体",
946
+ "members": [
947
+ {
948
+ "disabled": false,
949
+ "document": "拆分任务ID",
950
+ "example": "236e51fd-827b-41cb-b303-56003a817ce5",
951
+ "member": "string",
952
+ "name": "TaskId",
953
+ "required": true,
954
+ "type": "string"
955
+ }
956
+ ],
957
+ "type": "object"
958
+ },
959
+ "GetSplitDocumentResultResponse": {
960
+ "document": "GetSplitDocumentResult返回参数结构体",
961
+ "members": [
962
+ {
963
+ "disabled": false,
964
+ "document": "任务状态。\n\n- `Success`：执行完成\n- `Processing`：执行中\n- `Pause`: 暂停\n- `Failed`：执行失败\n- `WaitExecute`：等待执行",
965
+ "example": "Success",
966
+ "member": "string",
967
+ "name": "Status",
968
+ "output_required": false,
969
+ "type": "string",
970
+ "value_allowed_null": false
971
+ },
972
+ {
973
+ "disabled": false,
974
+ "document": "拆分结果的临时下载地址。\n文件类型为zip压缩包，下载链接有效期30分钟。\n压缩包内包含\\*.md、\\*.jsonl、\\*mllm.json以及images文件夹。\n\n> **jsonl** 结构说明：\n- `page_content`:\n 用于生成嵌入（embedding）库，以便于检索使用。该字段中的图片将使用占位符替换。\n- `org_data`:\n 表示与 page_content 对应的最小语义完整性块，用于问答模型的处理。\n- `big_data`:\n 表示与 page_content 对应的最大语义完整性块，也用于问答模型的处理。",
975
+ "example": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.zip",
976
+ "member": "string",
977
+ "name": "DocumentRecognizeResultUrl",
978
+ "output_required": false,
979
+ "type": "string",
980
+ "value_allowed_null": false
981
+ },
982
+ {
983
+ "disabled": true,
984
+ "document": "文档拆分失败的页码",
985
+ "example": "无",
986
+ "member": "SplitDocumentFailedPage",
987
+ "name": "FailedPages",
988
+ "output_required": false,
989
+ "type": "list",
990
+ "value_allowed_null": false
991
+ },
992
+ {
993
+ "disabled": false,
994
+ "document": "文档拆分任务的用量",
995
+ "example": "{\"PageNumber\":10,\"TotalTokens\":2048}",
996
+ "member": "DocumentUsage",
997
+ "name": "Usage",
998
+ "output_required": false,
999
+ "type": "object",
1000
+ "value_allowed_null": false
1001
+ },
1002
+ {
1003
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1004
+ "member": "string",
1005
+ "name": "RequestId",
1006
+ "type": "string"
1007
+ }
1008
+ ],
1009
+ "type": "object"
1010
+ },
1011
+ "ImportQAsRequest": {
1012
+ "document": "ImportQAs请求参数结构体",
1013
+ "members": [],
1014
+ "type": "object"
1015
+ },
1016
+ "ImportQAsResponse": {
1017
+ "document": "ImportQAs返回参数结构体",
1018
+ "members": [
1019
+ {
1020
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1021
+ "member": "string",
1022
+ "name": "RequestId",
1023
+ "type": "string"
1024
+ }
1025
+ ],
1026
+ "type": "object"
1027
+ },
1028
+ "LabelItem": {
1029
+ "document": "属性标签",
1030
+ "members": [
1031
+ {
1032
+ "disabled": false,
1033
+ "document": "属性key",
1034
+ "example": "key1",
1035
+ "member": "string",
1036
+ "name": "Name",
1037
+ "required": false,
1038
+ "type": "string"
1039
+ },
1040
+ {
1041
+ "disabled": false,
1042
+ "document": "标签值",
1043
+ "example": "[\"v1\",\"v2\"]",
1044
+ "member": "string",
1045
+ "name": "Values",
1046
+ "required": false,
1047
+ "type": "list"
1048
+ }
1049
+ ],
1050
+ "usage": "in"
1051
+ },
1052
+ "ListAttributeLabelsRequest": {
1053
+ "document": "ListAttributeLabels请求参数结构体",
1054
+ "members": [],
1055
+ "type": "object"
1056
+ },
1057
+ "ListAttributeLabelsResponse": {
1058
+ "document": "ListAttributeLabels返回参数结构体",
1059
+ "members": [
1060
+ {
1061
+ "disabled": false,
1062
+ "document": "属性标签列表",
1063
+ "example": "无",
1064
+ "member": "AttributeItem",
1065
+ "name": "List",
1066
+ "output_required": false,
1067
+ "type": "list",
1068
+ "value_allowed_null": false
1069
+ },
1070
+ {
1071
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1072
+ "member": "string",
1073
+ "name": "RequestId",
1074
+ "type": "string"
1075
+ }
1076
+ ],
1077
+ "type": "object"
1078
+ },
1079
+ "ListDocsRequest": {
1080
+ "document": "ListDocs请求参数结构体",
1081
+ "members": [],
1082
+ "type": "object"
1083
+ },
1084
+ "ListDocsResponse": {
1085
+ "document": "ListDocs返回参数结构体",
1086
+ "members": [
1087
+ {
1088
+ "disabled": false,
1089
+ "document": "文档信息",
1090
+ "example": "无",
1091
+ "member": "DocItem",
1092
+ "name": "List",
1093
+ "output_required": false,
1094
+ "type": "list",
1095
+ "value_allowed_null": false
1096
+ },
1097
+ {
1098
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1099
+ "member": "string",
1100
+ "name": "RequestId",
1101
+ "type": "string"
1102
+ }
1103
+ ],
1104
+ "type": "object"
1105
+ },
1106
+ "ListQAsRequest": {
1107
+ "document": "ListQAs请求参数结构体",
1108
+ "members": [],
1109
+ "type": "object"
1110
+ },
1111
+ "ListQAsResponse": {
1112
+ "document": "ListQAs返回参数结构体",
1113
+ "members": [
1114
+ {
1115
+ "disabled": false,
1116
+ "document": "问答对信息",
1117
+ "example": "无",
1118
+ "member": "QaItem",
1119
+ "name": "List",
1120
+ "output_required": false,
1121
+ "type": "list",
1122
+ "value_allowed_null": false
1123
+ },
1124
+ {
1125
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1126
+ "member": "string",
1127
+ "name": "RequestId",
1128
+ "type": "string"
1129
+ }
1130
+ ],
1131
+ "type": "object"
1132
+ },
1133
+ "Message": {
1134
+ "document": "会话内容",
1135
+ "members": [
1136
+ {
1137
+ "disabled": false,
1138
+ "document": "角色",
1139
+ "example": "user",
1140
+ "member": "string",
1141
+ "name": "Role",
1142
+ "output_required": false,
1143
+ "required": false,
1144
+ "type": "string",
1145
+ "value_allowed_null": false
1146
+ },
1147
+ {
1148
+ "disabled": false,
1149
+ "document": "内容",
1150
+ "example": "content",
1151
+ "member": "string",
1152
+ "name": "Content",
1153
+ "output_required": false,
1154
+ "required": false,
1155
+ "type": "string",
1156
+ "value_allowed_null": false
1157
+ }
1158
+ ],
1159
+ "usage": "both"
1160
+ },
1161
+ "ModifyAttributeLabelRequest": {
1162
+ "document": "ModifyAttributeLabel请求参数结构体",
1163
+ "members": [
1164
+ {
1165
+ "disabled": false,
1166
+ "document": "属性标签",
1167
+ "example": "无",
1168
+ "member": "AttributeLabelItem",
1169
+ "name": "Labels",
1170
+ "required": false,
1171
+ "type": "list"
1172
+ }
1173
+ ],
1174
+ "type": "object"
1175
+ },
1176
+ "ModifyAttributeLabelResponse": {
1177
+ "document": "ModifyAttributeLabel返回参数结构体",
1178
+ "members": [
1179
+ {
1180
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1181
+ "member": "string",
1182
+ "name": "RequestId",
1183
+ "type": "string"
1184
+ }
1185
+ ],
1186
+ "type": "object"
1187
+ },
1188
+ "ModifyQARequest": {
1189
+ "document": "ModifyQA请求参数结构体",
1190
+ "members": [
1191
+ {
1192
+ "disabled": false,
1193
+ "document": "属性标签",
1194
+ "example": "无",
1195
+ "member": "AttributeLabelReferItem",
1196
+ "name": "AttributeLabels",
1197
+ "required": false,
1198
+ "type": "list"
1199
+ }
1200
+ ],
1201
+ "type": "object"
1202
+ },
1203
+ "ModifyQAResponse": {
1204
+ "document": "ModifyQA返回参数结构体",
1205
+ "members": [
1206
+ {
1207
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1208
+ "member": "string",
1209
+ "name": "RequestId",
1210
+ "type": "string"
1211
+ }
1212
+ ],
1213
+ "type": "object"
1214
+ },
1215
+ "QaItem": {
1216
+ "document": "问答对信息",
1217
+ "members": [
1218
+ {
1219
+ "disabled": false,
1220
+ "document": "问答id\n注意：此字段可能返回 null，表示取不到有效值。",
1221
+ "example": "无",
1222
+ "member": "string",
1223
+ "name": "QaId",
1224
+ "output_required": false,
1225
+ "required": false,
1226
+ "type": "string",
1227
+ "value_allowed_null": true
1228
+ },
1229
+ {
1230
+ "disabled": false,
1231
+ "document": "问题\n注意：此字段可能返回 null，表示取不到有效值。",
1232
+ "example": "无",
1233
+ "member": "string",
1234
+ "name": "Question",
1235
+ "output_required": false,
1236
+ "required": false,
1237
+ "type": "string",
1238
+ "value_allowed_null": true
1239
+ },
1240
+ {
1241
+ "disabled": false,
1242
+ "document": "答案\n注意：此字段可能返回 null，表示取不到有效值。",
1243
+ "example": "无",
1244
+ "member": "string",
1245
+ "name": "Answer",
1246
+ "output_required": false,
1247
+ "required": false,
1248
+ "type": "string",
1249
+ "value_allowed_null": true
1250
+ },
1251
+ {
1252
+ "disabled": false,
1253
+ "document": "属性标签\n注意：此字段可能返回 null，表示取不到有效值。",
1254
+ "example": "无",
1255
+ "member": "AttributeLabelReferItem",
1256
+ "name": "AttributeLabels",
1257
+ "output_required": false,
1258
+ "required": false,
1259
+ "type": "list",
1260
+ "value_allowed_null": true
1261
+ },
1262
+ {
1263
+ "disabled": false,
1264
+ "document": "创建时间\n注意：此字段可能返回 null，表示取不到有效值。",
1265
+ "example": "无",
1266
+ "member": "string",
1267
+ "name": "CreateTime",
1268
+ "output_required": false,
1269
+ "required": false,
1270
+ "type": "string",
1271
+ "value_allowed_null": true
1272
+ },
1273
+ {
1274
+ "disabled": false,
1275
+ "document": "更新时间\n注意：此字段可能返回 null，表示取不到有效值。",
1276
+ "example": "无",
1277
+ "member": "string",
1278
+ "name": "UpdateTime",
1279
+ "output_required": false,
1280
+ "required": false,
1281
+ "type": "string",
1282
+ "value_allowed_null": true
1283
+ }
1284
+ ],
1285
+ "usage": "both"
1286
+ },
1287
+ "QueryRewriteRequest": {
1288
+ "document": "QueryRewrite请求参数结构体",
1289
+ "members": [
1290
+ {
1291
+ "disabled": false,
1292
+ "document": "需要改写的多轮历史会话，每轮历史对话需要包含user（问）和assistant（答）成对输入，由于模型字符限制，最多提供4轮对话。针对最后一轮对话进行改写",
1293
+ "example": "[{\"Role\":\"user\",\"Content\":\"你家在哪里\"},{\"Role\":\"assistant\",\"Content\":“我家在国内”}]",
1294
+ "member": "Message",
1295
+ "name": "Messages",
1296
+ "required": true,
1297
+ "type": "list"
1298
+ },
1299
+ {
1300
+ "disabled": false,
1301
+ "document": "模型名称",
1302
+ "example": "lke-query-rewrite-base",
1303
+ "member": "string",
1304
+ "name": "Model",
1305
+ "required": false,
1306
+ "type": "string"
1307
+ }
1308
+ ],
1309
+ "type": "object"
1310
+ },
1311
+ "QueryRewriteResponse": {
1312
+ "document": "QueryRewrite返回参数结构体",
1313
+ "members": [
1314
+ {
1315
+ "disabled": false,
1316
+ "document": "改写结果",
1317
+ "example": "无",
1318
+ "member": "string",
1319
+ "name": "Content",
1320
+ "output_required": true,
1321
+ "type": "string",
1322
+ "value_allowed_null": false
1323
+ },
1324
+ {
1325
+ "disabled": false,
1326
+ "document": "消耗量，返回输入token数，输出token数以及总token数",
1327
+ "example": "{\"InputTokens\":45,\"OutputTokens\":6,\"TotalTokens\":51}",
1328
+ "member": "Usage",
1329
+ "name": "Usage",
1330
+ "output_required": false,
1331
+ "type": "object",
1332
+ "value_allowed_null": false
1333
+ },
1334
+ {
1335
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1336
+ "member": "string",
1337
+ "name": "RequestId",
1338
+ "type": "string"
1339
+ }
1340
+ ],
1341
+ "type": "object"
1342
+ },
1343
+ "ReconstructDocumentFailedPage": {
1344
+ "document": "文档解析失败记录",
1345
+ "members": [
1346
+ {
1347
+ "disabled": false,
1348
+ "document": "失败页码\t\n注意：此字段可能返回 null，表示取不到有效值。",
1349
+ "example": "无",
1350
+ "member": "int64",
1351
+ "name": "PageNumber",
1352
+ "output_required": false,
1353
+ "type": "int",
1354
+ "value_allowed_null": true
1355
+ }
1356
+ ],
1357
+ "usage": "out"
1358
+ },
1359
+ "ReconstructDocumentSSEConfig": {
1360
+ "document": "ReconstructDocumentSSE 功能配置参数",
1361
+ "members": [
1362
+ {
1363
+ "disabled": false,
1364
+ "document": "Markdown文件中表格返回的形式\n0，表格以MD形式返回\n1，表格以HTML形式返回\n默认为0",
1365
+ "example": "0",
1366
+ "member": "string",
1367
+ "name": "TableResultType",
1368
+ "required": false,
1369
+ "type": "string"
1370
+ },
1371
+ {
1372
+ "disabled": false,
1373
+ "document": "Markdown文件中图片返回的形式\n0:markdown中图片以链接形式返回\n1:markdown中图片只返回图片中提取的文本内容\n默认是0",
1374
+ "example": "0",
1375
+ "member": "string",
1376
+ "name": "MarkdownImageResponseType",
1377
+ "required": false,
1378
+ "type": "string"
1379
+ },
1380
+ {
1381
+ "disabled": false,
1382
+ "document": "Markdown文件中是否包含页码信息",
1383
+ "example": "true",
1384
+ "member": "bool",
1385
+ "name": "ReturnPageFormat",
1386
+ "required": false,
1387
+ "type": "bool"
1388
+ },
1389
+ {
1390
+ "disabled": false,
1391
+ "document": "自定义输出页码样式,{{p}}为页码占位符，开启ReturnPageFormat生效。未填默认样式:<page_num>page {{p}}</page_num>",
1392
+ "example": "<page_num>page {{p}}</page_num>",
1393
+ "member": "string",
1394
+ "name": "PageFormat",
1395
+ "required": false,
1396
+ "type": "string"
1397
+ }
1398
+ ],
1399
+ "usage": "in"
1400
+ },
1401
+ "ReconstructDocumentSSERequest": {
1402
+ "document": "ReconstructDocumentSSE请求参数结构体",
1403
+ "members": [
1404
+ {
1405
+ "disabled": false,
1406
+ "document": "文件类型。\n**支持的文件类型**：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\n**支持的文件大小**：\n- PDF、DOC、DOCX、PPT、PPTX 支持100M\n- MD、TXT 支持10M\n- 其他支持20M\n",
1407
+ "example": "PDF",
1408
+ "member": "string",
1409
+ "name": "FileType",
1410
+ "required": true,
1411
+ "type": "string"
1412
+ },
1413
+ {
1414
+ "disabled": false,
1415
+ "document": "文件的 URL 地址。\n文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。\n参考：[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)",
1416
+ "example": "无",
1417
+ "member": "string",
1418
+ "name": "FileUrl",
1419
+ "required": false,
1420
+ "type": "string"
1421
+ },
1422
+ {
1423
+ "disabled": false,
1424
+ "document": "文件的 Base64 值。\n支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。\n支持的图片像素：单边介于20-10000px之间。\n文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。",
1425
+ "example": "无",
1426
+ "member": "string",
1427
+ "name": "FileBase64",
1428
+ "required": false,
1429
+ "type": "string"
1430
+ },
1431
+ {
1432
+ "disabled": false,
1433
+ "document": "文档的起始页码。\n当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的起始页码，识别的页码包含当前值。",
1434
+ "example": "1",
1435
+ "member": "int64",
1436
+ "name": "FileStartPageNumber",
1437
+ "required": false,
1438
+ "type": "int"
1439
+ },
1440
+ {
1441
+ "disabled": false,
1442
+ "document": "文档的结束页码。\n当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的结束页码，识别的页码包含当前值。",
1443
+ "example": "100",
1444
+ "member": "int64",
1445
+ "name": "FileEndPageNumber",
1446
+ "required": false,
1447
+ "type": "int"
1448
+ },
1449
+ {
1450
+ "disabled": false,
1451
+ "document": "文档解析配置信息\t",
1452
+ "example": "无",
1453
+ "member": "ReconstructDocumentSSEConfig",
1454
+ "name": "Config",
1455
+ "required": false,
1456
+ "type": "object"
1457
+ }
1458
+ ],
1459
+ "type": "object"
1460
+ },
1461
+ "ReconstructDocumentSSEResponse": {
1462
+ "document": "ReconstructDocumentSSE返回参数结构体",
1463
+ "members": [
1464
+ {
1465
+ "disabled": false,
1466
+ "document": "任务ID。本次请求的唯一标识",
1467
+ "example": "无",
1468
+ "member": "string",
1469
+ "name": "TaskId",
1470
+ "output_required": false,
1471
+ "type": "string",
1472
+ "value_allowed_null": false
1473
+ },
1474
+ {
1475
+ "disabled": false,
1476
+ "document": "响应类型。1：返回进度信息，2：返回解析结果",
1477
+ "example": "无",
1478
+ "member": "string",
1479
+ "name": "ResponseType",
1480
+ "output_required": false,
1481
+ "type": "string",
1482
+ "value_allowed_null": false
1483
+ },
1484
+ {
1485
+ "disabled": false,
1486
+ "document": "进度。0~100",
1487
+ "example": "无",
1488
+ "member": "string",
1489
+ "name": "Progress",
1490
+ "output_required": false,
1491
+ "type": "string",
1492
+ "value_allowed_null": false
1493
+ },
1494
+ {
1495
+ "disabled": false,
1496
+ "document": "进度信息。",
1497
+ "example": "无",
1498
+ "member": "string",
1499
+ "name": "ProgressMessage",
1500
+ "output_required": false,
1501
+ "type": "string",
1502
+ "value_allowed_null": false
1503
+ },
1504
+ {
1505
+ "disabled": false,
1506
+ "document": "文档解析结果URL。存储在腾讯云cos，可以通过http请求下载，URL十分钟内有效。",
1507
+ "example": "无",
1508
+ "member": "string",
1509
+ "name": "DocumentRecognizeResultUrl",
1510
+ "output_required": false,
1511
+ "type": "string",
1512
+ "value_allowed_null": false
1513
+ },
1514
+ {
1515
+ "disabled": false,
1516
+ "document": "文档解析失败的页码。",
1517
+ "example": "无",
1518
+ "member": "ReconstructDocumentFailedPage",
1519
+ "name": "FailedPages",
1520
+ "output_required": false,
1521
+ "type": "list",
1522
+ "value_allowed_null": false
1523
+ },
1524
+ {
1525
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header \"X-TC-RequestId\" 中。",
1526
+ "member": "string",
1527
+ "name": "RequestId",
1528
+ "type": "string"
1529
+ }
1530
+ ],
1531
+ "type": "object"
1532
+ },
1533
+ "RetrievalRecord": {
1534
+ "document": "检索的结果",
1535
+ "members": [
1536
+ {
1537
+ "disabled": false,
1538
+ "document": "检索结果的元数据",
1539
+ "example": "{\"Type\":\"DOC\",\"ResultSource\":\"SEMANTIC\",\"ChunkPageNumbers\":[1,2]}",
1540
+ "member": "RetrievalRecordMetadata",
1541
+ "name": "Metadata",
1542
+ "output_required": false,
1543
+ "type": "object",
1544
+ "value_allowed_null": false
1545
+ },
1546
+ {
1547
+ "disabled": false,
1548
+ "document": "检索到的标题",
1549
+ "example": "example.pdf",
1550
+ "member": "string",
1551
+ "name": "Title",
1552
+ "output_required": false,
1553
+ "type": "string",
1554
+ "value_allowed_null": false
1555
+ },
1556
+ {
1557
+ "disabled": false,
1558
+ "document": "检索到的内容",
1559
+ "example": "国庆放7天假",
1560
+ "member": "string",
1561
+ "name": "Content",
1562
+ "output_required": false,
1563
+ "type": "string",
1564
+ "value_allowed_null": false
1565
+ }
1566
+ ],
1567
+ "usage": "out"
1568
+ },
1569
+ "RetrievalRecordMetadata": {
1570
+ "document": "检索结果的元数据",
1571
+ "members": [
1572
+ {
1573
+ "disabled": false,
1574
+ "document": "结果的类型。\n- `DOC`：文档\n- `QA`：问答对",
1575
+ "example": "DOC",
1576
+ "member": "string",
1577
+ "name": "Type",
1578
+ "output_required": false,
1579
+ "type": "string",
1580
+ "value_allowed_null": false
1581
+ },
1582
+ {
1583
+ "disabled": false,
1584
+ "document": "检索结果的来源。\n- `SEMANTIC`：从语义检索中得到的结果\n- `FULL_TEXT`：从全文检索中得到的结果",
1585
+ "example": "SEMANTIC",
1586
+ "member": "string",
1587
+ "name": "ResultSource",
1588
+ "output_required": false,
1589
+ "type": "string",
1590
+ "value_allowed_null": false
1591
+ },
1592
+ {
1593
+ "disabled": false,
1594
+ "document": "切片在文档中的页码，仅部分文档支持",
1595
+ "example": "[1,2]",
1596
+ "member": "int64",
1597
+ "name": "ChunkPageNumbers",
1598
+ "output_required": false,
1599
+ "type": "list",
1600
+ "value_allowed_null": false
1601
+ }
1602
+ ],
1603
+ "usage": "out"
1604
+ },
1605
+ "RetrievalSetting": {
1606
+ "document": "检索参数设置",
1607
+ "members": [
1608
+ {
1609
+ "disabled": false,
1610
+ "document": "检索的类型，不填该参数则检索全部。\n- `DOC`：文档\n- `QA`：QA\n\n仅RetrieveKnowledge接口支持该参数",
1611
+ "example": "DOC",
1612
+ "member": "string",
1613
+ "name": "Type",
1614
+ "required": false,
1615
+ "type": "string"
1616
+ },
1617
+ {
1618
+ "disabled": false,
1619
+ "document": "返回个数",
1620
+ "example": "5",
1621
+ "member": "int64",
1622
+ "name": "TopK",
1623
+ "required": false,
1624
+ "type": "int"
1625
+ },
1626
+ {
1627
+ "disabled": false,
1628
+ "document": "分数过滤",
1629
+ "example": "0.7",
1630
+ "member": "float",
1631
+ "name": "ScoreThreshold",
1632
+ "required": false,
1633
+ "type": "float"
1634
+ }
1635
+ ],
1636
+ "usage": "in"
1637
+ },
1638
+ "RetrieveKnowledgeRequest": {
1639
+ "document": "RetrieveKnowledge请求参数结构体",
1640
+ "members": [
1641
+ {
1642
+ "disabled": false,
1643
+ "document": "知识库ID。",
1644
+ "example": "1840331836752986944",
1645
+ "member": "string",
1646
+ "name": "KnowledgeBaseId",
1647
+ "required": true,
1648
+ "type": "string"
1649
+ },
1650
+ {
1651
+ "disabled": false,
1652
+ "document": "用于检索的文本。",
1653
+ "example": "国庆放几天假",
1654
+ "member": "string",
1655
+ "name": "Query",
1656
+ "required": true,
1657
+ "type": "string"
1658
+ },
1659
+ {
1660
+ "disabled": false,
1661
+ "document": "检索方法，默认使用`HYBRID`混合检索。\n- `SEMANTIC`：语义检索\n- `FULL_TEXT`：全文检索\n- `HYBRID`：混合检索",
1662
+ "example": "SEMANTIC",
1663
+ "member": "string",
1664
+ "name": "RetrievalMethod",
1665
+ "required": false,
1666
+ "type": "string"
1667
+ },
1668
+ {
1669
+ "disabled": false,
1670
+ "document": "检索设置。",
1671
+ "example": "{\"TopK\":3,\"ScoreThreshold\":0.7}",
1672
+ "member": "RetrievalSetting",
1673
+ "name": "RetrievalSetting",
1674
+ "required": false,
1675
+ "type": "object"
1676
+ },
1677
+ {
1678
+ "disabled": false,
1679
+ "document": "标签过滤。",
1680
+ "example": "无",
1681
+ "member": "LabelItem",
1682
+ "name": "AttributeLabels",
1683
+ "required": false,
1684
+ "type": "list"
1685
+ }
1686
+ ],
1687
+ "type": "object"
1688
+ },
1689
+ "RetrieveKnowledgeResponse": {
1690
+ "document": "RetrieveKnowledge返回参数结构体",
1691
+ "members": [
1692
+ {
1693
+ "disabled": false,
1694
+ "document": "检索结果",
1695
+ "example": "[{\"Metadata\":{\"Type\":\"DOC\",\"ResultSource\":\"SEMANTIC\",\"ChunkPageNumbers\":[1,2]},\"Score\":0,\"Title\":\"example.pdf\",\"Content\":\"国庆放7天假\"}]",
1696
+ "member": "RetrievalRecord",
1697
+ "name": "Records",
1698
+ "output_required": false,
1699
+ "type": "list",
1700
+ "value_allowed_null": false
1701
+ },
1702
+ {
1703
+ "disabled": false,
1704
+ "document": "检索结果数量",
1705
+ "example": "3",
1706
+ "member": "uint64",
1707
+ "name": "TotalCount",
1708
+ "output_required": false,
1709
+ "type": "int",
1710
+ "value_allowed_null": false
1711
+ },
1712
+ {
1713
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1714
+ "member": "string",
1715
+ "name": "RequestId",
1716
+ "type": "string"
1717
+ }
1718
+ ],
1719
+ "type": "object"
1720
+ },
1721
+ "RunRerankRequest": {
1722
+ "document": "RunRerank请求参数结构体",
1723
+ "members": [
1724
+ {
1725
+ "disabled": false,
1726
+ "document": "查询内容",
1727
+ "example": "腾讯知识引擎大模型",
1728
+ "member": "string",
1729
+ "name": "Query",
1730
+ "required": true,
1731
+ "type": "string"
1732
+ },
1733
+ {
1734
+ "disabled": false,
1735
+ "document": "文档列表，最多20个",
1736
+ "example": "[\"腾讯知识引擎\",\"知识引擎大模型\"]",
1737
+ "member": "string",
1738
+ "name": "Docs",
1739
+ "required": true,
1740
+ "type": "list"
1741
+ },
1742
+ {
1743
+ "disabled": false,
1744
+ "document": "模型名称, 默认: lke-reranker-base",
1745
+ "example": "lke-reranker-base",
1746
+ "member": "string",
1747
+ "name": "Model",
1748
+ "required": false,
1749
+ "type": "string"
1750
+ }
1751
+ ],
1752
+ "type": "object"
1753
+ },
1754
+ "RunRerankResponse": {
1755
+ "document": "RunRerank返回参数结构体",
1756
+ "members": [
1757
+ {
1758
+ "disabled": false,
1759
+ "document": "相关性, 数值越大越相关",
1760
+ "example": "[-19.681953, -19.414124]",
1761
+ "member": "float",
1762
+ "name": "ScoreList",
1763
+ "output_required": true,
1764
+ "type": "list",
1765
+ "value_allowed_null": false
1766
+ },
1767
+ {
1768
+ "disabled": false,
1769
+ "document": "消耗量，仅返回TotalToken",
1770
+ "example": "{\"TotalTokens\":3}",
1771
+ "member": "Usage",
1772
+ "name": "Usage",
1773
+ "output_required": false,
1774
+ "type": "object",
1775
+ "value_allowed_null": false
1776
+ },
1777
+ {
1778
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1779
+ "member": "string",
1780
+ "name": "RequestId",
1781
+ "type": "string"
1782
+ }
1783
+ ],
1784
+ "type": "object"
1785
+ },
1786
+ "SegmentationConfig": {
1787
+ "document": "分段配置",
1788
+ "members": [
1789
+ {
1790
+ "disabled": false,
1791
+ "document": "最大分片长度",
1792
+ "example": "4800",
1793
+ "member": "int64",
1794
+ "name": "MaxChunkSize",
1795
+ "required": false,
1796
+ "type": "int"
1797
+ }
1798
+ ],
1799
+ "usage": "in"
1800
+ },
1801
+ "SplitDocumentFailedPage": {
1802
+ "document": "文档解析失败记录",
1803
+ "members": [
1804
+ {
1805
+ "disabled": false,
1806
+ "document": "失败页码\t\n注意：此字段可能返回 null，表示取不到有效值。",
1807
+ "example": "无",
1808
+ "member": "int64",
1809
+ "name": "PageNumber",
1810
+ "output_required": false,
1811
+ "type": "int",
1812
+ "value_allowed_null": true
1813
+ }
1814
+ ],
1815
+ "usage": "out"
1816
+ },
1817
+ "UploadDocRealtimeRequest": {
1818
+ "document": "UploadDocRealtime请求参数结构体",
1819
+ "members": [],
1820
+ "type": "object"
1821
+ },
1822
+ "UploadDocRealtimeResponse": {
1823
+ "document": "UploadDocRealtime返回参数结构体",
1824
+ "members": [
1825
+ {
1826
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header \"X-TC-RequestId\" 中。",
1827
+ "member": "string",
1828
+ "name": "RequestId",
1829
+ "type": "string"
1830
+ }
1831
+ ],
1832
+ "type": "object"
1833
+ },
1834
+ "UploadDocRequest": {
1835
+ "document": "UploadDoc请求参数结构体",
1836
+ "members": [
1837
+ {
1838
+ "disabled": false,
1839
+ "document": "知识库ID",
1840
+ "example": "4901991032",
1841
+ "member": "string",
1842
+ "name": "KnowledgeBaseId",
1843
+ "required": true,
1844
+ "type": "string"
1845
+ },
1846
+ {
1847
+ "disabled": false,
1848
+ "document": "文件名，可选。\n**需带文件类型后缀**，当文件名无法从传入的`FileUrl`获取时需要通过该字段来明确。",
1849
+ "example": "example.pdf",
1850
+ "member": "string",
1851
+ "name": "FileName",
1852
+ "required": true,
1853
+ "type": "string"
1854
+ },
1855
+ {
1856
+ "disabled": false,
1857
+ "document": "文件类型。\n\n**支持的文件类型：**\n- `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`\n\n**支持的文件大小：**\n - `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M\n - `TXT`、`MD` 最大10M\n - 其他 最大20M\n",
1858
+ "example": "PDF",
1859
+ "member": "string",
1860
+ "name": "FileType",
1861
+ "required": true,
1862
+ "type": "string"
1863
+ },
1864
+ {
1865
+ "disabled": false,
1866
+ "document": "文件的 URL 地址。\n文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。\n参考：[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)",
1867
+ "example": "https://example.com/example.pdf",
1868
+ "member": "string",
1869
+ "name": "FileUrl",
1870
+ "required": true,
1871
+ "type": "string"
1872
+ },
1873
+ {
1874
+ "disabled": true,
1875
+ "document": "属性标签引用",
1876
+ "example": "无",
1877
+ "member": "AttributeLabelReferItem",
1878
+ "name": "AttributeLabel",
1879
+ "required": false,
1880
+ "type": "list"
1881
+ },
1882
+ {
1883
+ "disabled": false,
1884
+ "document": "属性标签引用",
1885
+ "example": "无",
1886
+ "member": "AttributeLabelReferItem",
1887
+ "name": "AttributeLabels",
1888
+ "required": false,
1889
+ "type": "list"
1890
+ },
1891
+ {
1892
+ "disabled": false,
1893
+ "document": "分段信息",
1894
+ "example": "{\"MaxChunkSize\":4800}",
1895
+ "member": "SegmentationConfig",
1896
+ "name": "Config",
1897
+ "required": false,
1898
+ "type": "object"
1899
+ }
1900
+ ],
1901
+ "type": "object"
1902
+ },
1903
+ "UploadDocResponse": {
1904
+ "document": "UploadDoc返回参数结构体",
1905
+ "members": [
1906
+ {
1907
+ "disabled": false,
1908
+ "document": "文档ID",
1909
+ "example": "1830996257452865536",
1910
+ "member": "string",
1911
+ "name": "DocId",
1912
+ "output_required": false,
1913
+ "type": "string",
1914
+ "value_allowed_null": false
1915
+ },
1916
+ {
1917
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1918
+ "member": "string",
1919
+ "name": "RequestId",
1920
+ "type": "string"
1921
+ }
1922
+ ],
1923
+ "type": "object"
1924
+ },
1925
+ "Usage": {
1926
+ "document": "消耗量",
1927
+ "members": [
1928
+ {
1929
+ "disabled": false,
1930
+ "document": "文档页数",
1931
+ "example": "10",
1932
+ "member": "int64",
1933
+ "name": "TotalPages",
1934
+ "output_required": false,
1935
+ "type": "int",
1936
+ "value_allowed_null": false
1937
+ },
1938
+ {
1939
+ "disabled": false,
1940
+ "document": "输入token数",
1941
+ "example": "10",
1942
+ "member": "int64",
1943
+ "name": "InputTokens",
1944
+ "output_required": false,
1945
+ "type": "int",
1946
+ "value_allowed_null": false
1947
+ },
1948
+ {
1949
+ "disabled": false,
1950
+ "document": "输出token数",
1951
+ "example": "10",
1952
+ "member": "int64",
1953
+ "name": "OutputTokens",
1954
+ "output_required": false,
1955
+ "type": "int",
1956
+ "value_allowed_null": false
1957
+ },
1958
+ {
1959
+ "disabled": false,
1960
+ "document": "总token数",
1961
+ "example": "10",
1962
+ "member": "int64",
1963
+ "name": "TotalTokens",
1964
+ "output_required": false,
1965
+ "type": "int",
1966
+ "value_allowed_null": false
1967
+ }
1968
+ ],
1969
+ "usage": "out"
1970
+ }
1971
+ },
1972
+ "version": "1.0"
1973
+ }