@petercatai/whisker-client 0.0.1760329074-dev
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/dist/api.d.ts +3795 -0
- package/dist/api.js +882 -0
- package/package.json +23 -0
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,3795 @@
|
|
|
1
|
+
/** TaskStatus */
|
|
2
|
+
export declare enum ITaskStatus {
|
|
3
|
+
Pending = "pending",
|
|
4
|
+
Running = "running",
|
|
5
|
+
Success = "success",
|
|
6
|
+
Failed = "failed",
|
|
7
|
+
Skipped = "skipped",
|
|
8
|
+
Canceled = "canceled",
|
|
9
|
+
PendingRetry = "pending_retry",
|
|
10
|
+
Deleted = "deleted"
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* TagObjectType
|
|
14
|
+
* 可打标签的对象类型。
|
|
15
|
+
*/
|
|
16
|
+
export declare enum ITagObjectType {
|
|
17
|
+
Space = "space",
|
|
18
|
+
Knowledge = "knowledge"
|
|
19
|
+
}
|
|
20
|
+
/** Resource */
|
|
21
|
+
export declare enum IResource {
|
|
22
|
+
Retrieval = "retrieval",
|
|
23
|
+
Tenant = "tenant",
|
|
24
|
+
Space = "space",
|
|
25
|
+
Knowledge = "knowledge",
|
|
26
|
+
Chunk = "chunk",
|
|
27
|
+
ApiKey = "api_key",
|
|
28
|
+
Task = "task",
|
|
29
|
+
Rule = "rule",
|
|
30
|
+
Public = "public",
|
|
31
|
+
Webhook = "webhook",
|
|
32
|
+
Tag = "tag",
|
|
33
|
+
Tagging = "tagging",
|
|
34
|
+
Artifact = "artifact"
|
|
35
|
+
}
|
|
36
|
+
/** Operator */
|
|
37
|
+
export declare enum IOperator {
|
|
38
|
+
And = "and",
|
|
39
|
+
Or = "or"
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Language
|
|
43
|
+
* Enum of the programming languages.
|
|
44
|
+
*/
|
|
45
|
+
export declare enum ILanguage {
|
|
46
|
+
Cpp = "cpp",
|
|
47
|
+
Go = "go",
|
|
48
|
+
Java = "java",
|
|
49
|
+
Kotlin = "kotlin",
|
|
50
|
+
Js = "js",
|
|
51
|
+
Ts = "ts",
|
|
52
|
+
Php = "php",
|
|
53
|
+
Proto = "proto",
|
|
54
|
+
Python = "python",
|
|
55
|
+
Rst = "rst",
|
|
56
|
+
Ruby = "ruby",
|
|
57
|
+
Rust = "rust",
|
|
58
|
+
Scala = "scala",
|
|
59
|
+
Swift = "swift",
|
|
60
|
+
Markdown = "markdown",
|
|
61
|
+
Latex = "latex",
|
|
62
|
+
Html = "html",
|
|
63
|
+
Sol = "sol",
|
|
64
|
+
Csharp = "csharp",
|
|
65
|
+
Cobol = "cobol",
|
|
66
|
+
C = "c",
|
|
67
|
+
Lua = "lua",
|
|
68
|
+
Perl = "perl",
|
|
69
|
+
Haskell = "haskell",
|
|
70
|
+
Elixir = "elixir",
|
|
71
|
+
Powershell = "powershell",
|
|
72
|
+
Visualbasic6 = "visualbasic6"
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* KnowledgeTypeEnum
|
|
76
|
+
* mime type of the knowledge. The type is used to determine how to process the knowledge and
|
|
77
|
+
* is also used to determine the type of the knowledge resource.
|
|
78
|
+
* different types of knowledge will be processed differently and have different load、split configurations.
|
|
79
|
+
* For example, text will be processed by splitter, while code will be processed by language parser.
|
|
80
|
+
*/
|
|
81
|
+
export declare enum IKnowledgeTypeEnum {
|
|
82
|
+
Text = "text",
|
|
83
|
+
Image = "image",
|
|
84
|
+
Markdown = "markdown",
|
|
85
|
+
Latex = "latex",
|
|
86
|
+
Json = "json",
|
|
87
|
+
Docx = "docx",
|
|
88
|
+
Pdf = "pdf",
|
|
89
|
+
Qa = "qa",
|
|
90
|
+
Yuquedoc = "yuquedoc",
|
|
91
|
+
YuqueBook = "yuque_book",
|
|
92
|
+
GithubRepo = "github_repo",
|
|
93
|
+
Cpp = "cpp",
|
|
94
|
+
Go = "go",
|
|
95
|
+
Java = "java",
|
|
96
|
+
Kotlin = "kotlin",
|
|
97
|
+
Js = "js",
|
|
98
|
+
Ts = "ts",
|
|
99
|
+
Php = "php",
|
|
100
|
+
Proto = "proto",
|
|
101
|
+
Python = "python",
|
|
102
|
+
Rst = "rst",
|
|
103
|
+
Ruby = "ruby",
|
|
104
|
+
Rust = "rust",
|
|
105
|
+
Scala = "scala",
|
|
106
|
+
Swift = "swift",
|
|
107
|
+
Html = "html",
|
|
108
|
+
Sol = "sol",
|
|
109
|
+
Csharp = "csharp",
|
|
110
|
+
Cobol = "cobol",
|
|
111
|
+
C = "c",
|
|
112
|
+
Lua = "lua",
|
|
113
|
+
Perl = "perl",
|
|
114
|
+
Haskell = "haskell",
|
|
115
|
+
Elixir = "elixir",
|
|
116
|
+
Powershell = "powershell"
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* KnowledgeSourceEnum
|
|
120
|
+
* Specifies the source of knowledge, which influences the behavior of the resource loader
|
|
121
|
+
*/
|
|
122
|
+
export declare enum IKnowledgeSourceEnum {
|
|
123
|
+
GithubRepo = "github_repo",
|
|
124
|
+
GithubFile = "github_file",
|
|
125
|
+
UserInputText = "user_input_text",
|
|
126
|
+
CloudStorageText = "cloud_storage_text",
|
|
127
|
+
CloudStorageImage = "cloud_storage_image",
|
|
128
|
+
Yuque = "yuque"
|
|
129
|
+
}
|
|
130
|
+
/** EmbeddingModelEnum */
|
|
131
|
+
export declare enum IEmbeddingModelEnum {
|
|
132
|
+
Openai = "openai",
|
|
133
|
+
SentenceTransformersAllMiniLML6V2 = "sentence-transformers/all-MiniLM-L6-v2",
|
|
134
|
+
SentenceTransformersAllMpnetBaseV2 = "sentence-transformers/all-mpnet-base-v2",
|
|
135
|
+
SentenceTransformersParaphraseMultilingualMiniLML12V2 = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
|
|
136
|
+
Shibing624Text2VecBaseChinese = "shibing624/text2vec-base-chinese"
|
|
137
|
+
}
|
|
138
|
+
/** Action */
|
|
139
|
+
export declare enum IAction {
|
|
140
|
+
Create = "create",
|
|
141
|
+
Read = "read",
|
|
142
|
+
Update = "update",
|
|
143
|
+
Delete = "delete",
|
|
144
|
+
Value = "*"
|
|
145
|
+
}
|
|
146
|
+
/** APIKey */
|
|
147
|
+
export interface IAPIKey {
|
|
148
|
+
/**
|
|
149
|
+
* Gmt Create
|
|
150
|
+
* creation time
|
|
151
|
+
*/
|
|
152
|
+
gmt_create?: string;
|
|
153
|
+
/**
|
|
154
|
+
* Gmt Modified
|
|
155
|
+
* update time
|
|
156
|
+
*/
|
|
157
|
+
gmt_modified?: string;
|
|
158
|
+
/**
|
|
159
|
+
* Key Id
|
|
160
|
+
* key id
|
|
161
|
+
*/
|
|
162
|
+
key_id?: string;
|
|
163
|
+
/**
|
|
164
|
+
* Tenant Id
|
|
165
|
+
* tenant id
|
|
166
|
+
*/
|
|
167
|
+
tenant_id: string;
|
|
168
|
+
/**
|
|
169
|
+
* Key Name
|
|
170
|
+
* key name
|
|
171
|
+
* @default ""
|
|
172
|
+
*/
|
|
173
|
+
key_name?: string;
|
|
174
|
+
/**
|
|
175
|
+
* Key Value
|
|
176
|
+
* key value
|
|
177
|
+
*/
|
|
178
|
+
key_value: string;
|
|
179
|
+
/**
|
|
180
|
+
* Permissions
|
|
181
|
+
* permissions config
|
|
182
|
+
*/
|
|
183
|
+
permissions?: IPermission[];
|
|
184
|
+
/**
|
|
185
|
+
* Rate Limit
|
|
186
|
+
* rate limit per minute
|
|
187
|
+
* @min 0
|
|
188
|
+
* @default 0
|
|
189
|
+
*/
|
|
190
|
+
rate_limit?: number;
|
|
191
|
+
/**
|
|
192
|
+
* Expires At
|
|
193
|
+
* expire time (UTC)
|
|
194
|
+
*/
|
|
195
|
+
expires_at?: string | null;
|
|
196
|
+
/**
|
|
197
|
+
* Is Active
|
|
198
|
+
* key status
|
|
199
|
+
* @default true
|
|
200
|
+
*/
|
|
201
|
+
is_active?: boolean;
|
|
202
|
+
/**
|
|
203
|
+
* Metadata
|
|
204
|
+
* key metadata
|
|
205
|
+
*/
|
|
206
|
+
metadata?: Record<string, any> | null;
|
|
207
|
+
}
|
|
208
|
+
/** APIKeyCreate */
|
|
209
|
+
export interface IAPIKeyCreate {
|
|
210
|
+
/**
|
|
211
|
+
* Key Name
|
|
212
|
+
* @default ""
|
|
213
|
+
*/
|
|
214
|
+
key_name?: string;
|
|
215
|
+
/** Description */
|
|
216
|
+
description?: string | null;
|
|
217
|
+
/** Permissions */
|
|
218
|
+
permissions?: IPermission[];
|
|
219
|
+
/**
|
|
220
|
+
* Rate Limit
|
|
221
|
+
* @default 0
|
|
222
|
+
*/
|
|
223
|
+
rate_limit?: number | null;
|
|
224
|
+
/**
|
|
225
|
+
* Expires At
|
|
226
|
+
* Expiration time in ISO8601 format with timezone (e.g., 2024-12-31T23:59:59+00:00)
|
|
227
|
+
*/
|
|
228
|
+
expires_at?: string | null;
|
|
229
|
+
/** Metadata */
|
|
230
|
+
metadata?: Record<string, any> | null;
|
|
231
|
+
}
|
|
232
|
+
/** APIKeyUpdate */
|
|
233
|
+
export interface IAPIKeyUpdate {
|
|
234
|
+
/**
|
|
235
|
+
* Key Name
|
|
236
|
+
* @default ""
|
|
237
|
+
*/
|
|
238
|
+
key_name?: string;
|
|
239
|
+
/** Description */
|
|
240
|
+
description?: string | null;
|
|
241
|
+
/** Permissions */
|
|
242
|
+
permissions?: IPermission[];
|
|
243
|
+
/**
|
|
244
|
+
* Rate Limit
|
|
245
|
+
* @default 0
|
|
246
|
+
*/
|
|
247
|
+
rate_limit?: number | null;
|
|
248
|
+
/**
|
|
249
|
+
* Expires At
|
|
250
|
+
* Expiration time in ISO8601 format with timezone (e.g., 2024-12-31T23:59:59+00:00)
|
|
251
|
+
*/
|
|
252
|
+
expires_at?: string | null;
|
|
253
|
+
/** Metadata */
|
|
254
|
+
metadata?: Record<string, any> | null;
|
|
255
|
+
/** Key Id */
|
|
256
|
+
key_id: string;
|
|
257
|
+
}
|
|
258
|
+
/** ActiveStatusUpdate */
|
|
259
|
+
export interface IActiveStatusUpdate {
|
|
260
|
+
/** Key Id */
|
|
261
|
+
key_id: string;
|
|
262
|
+
/** Status */
|
|
263
|
+
status: boolean;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* ArtifactIndex
|
|
267
|
+
* whisker_artifact_index 模型
|
|
268
|
+
*/
|
|
269
|
+
export interface IArtifactIndex {
|
|
270
|
+
/**
|
|
271
|
+
* Gmt Create
|
|
272
|
+
* creation time
|
|
273
|
+
*/
|
|
274
|
+
gmt_create?: string;
|
|
275
|
+
/**
|
|
276
|
+
* Gmt Modified
|
|
277
|
+
* update time
|
|
278
|
+
*/
|
|
279
|
+
gmt_modified?: string;
|
|
280
|
+
/**
|
|
281
|
+
* Ecosystem
|
|
282
|
+
* 制品来源生态系统(pypi / npm / maven / go / php)
|
|
283
|
+
* @maxLength 32
|
|
284
|
+
*/
|
|
285
|
+
ecosystem: string;
|
|
286
|
+
/**
|
|
287
|
+
* Name
|
|
288
|
+
* 制品名(构建产物名,如 requests / @company/sdk)
|
|
289
|
+
* @maxLength 255
|
|
290
|
+
*/
|
|
291
|
+
name: string;
|
|
292
|
+
/**
|
|
293
|
+
* Version
|
|
294
|
+
* 版本号(可为空)
|
|
295
|
+
*/
|
|
296
|
+
version?: string | null;
|
|
297
|
+
/**
|
|
298
|
+
* Space Id
|
|
299
|
+
* 关联的 whisker_space.space_id
|
|
300
|
+
* @maxLength 255
|
|
301
|
+
* @pattern ^[A-Za-z0-9._@/-]{1,255}$
|
|
302
|
+
*/
|
|
303
|
+
space_id: string;
|
|
304
|
+
/**
|
|
305
|
+
* Extra
|
|
306
|
+
* 额外元数据信息,扩展用,如构建参数、标签、扫描信息等
|
|
307
|
+
* @default {}
|
|
308
|
+
*/
|
|
309
|
+
extra?: Record<string, any>;
|
|
310
|
+
/**
|
|
311
|
+
* Artifact Id
|
|
312
|
+
* 制品索引表主键(UUID字符串)
|
|
313
|
+
*/
|
|
314
|
+
artifact_id?: string;
|
|
315
|
+
}
|
|
316
|
+
/**
|
|
317
|
+
* ArtifactIndexCreate
|
|
318
|
+
* 创建 whisker_artifact_index 条目的入参模型
|
|
319
|
+
*/
|
|
320
|
+
export interface IArtifactIndexCreate {
|
|
321
|
+
/**
|
|
322
|
+
* Ecosystem
|
|
323
|
+
* 制品来源生态系统(pypi / npm / maven / go / php)
|
|
324
|
+
* @maxLength 32
|
|
325
|
+
*/
|
|
326
|
+
ecosystem: string;
|
|
327
|
+
/**
|
|
328
|
+
* Name
|
|
329
|
+
* 制品名(构建产物名,如 requests / @company/sdk)
|
|
330
|
+
* @maxLength 255
|
|
331
|
+
*/
|
|
332
|
+
name: string;
|
|
333
|
+
/**
|
|
334
|
+
* Version
|
|
335
|
+
* 版本号(可为空)
|
|
336
|
+
*/
|
|
337
|
+
version?: string | null;
|
|
338
|
+
/**
|
|
339
|
+
* Space Id
|
|
340
|
+
* 关联的 whisker_space.space_id
|
|
341
|
+
* @maxLength 255
|
|
342
|
+
* @pattern ^[A-Za-z0-9._@/-]{1,255}$
|
|
343
|
+
*/
|
|
344
|
+
space_id: string;
|
|
345
|
+
/**
|
|
346
|
+
* Extra
|
|
347
|
+
* 额外元数据信息,扩展用,如构建参数、标签、扫描信息等
|
|
348
|
+
* @default {}
|
|
349
|
+
*/
|
|
350
|
+
extra?: Record<string, any>;
|
|
351
|
+
}
|
|
352
|
+
/** ArtifactSpaceUpdate */
|
|
353
|
+
export interface IArtifactSpaceUpdate {
|
|
354
|
+
/** Artifact Id */
|
|
355
|
+
artifact_id: string;
|
|
356
|
+
/** New Space Id */
|
|
357
|
+
new_space_id: string;
|
|
358
|
+
}
|
|
359
|
+
/** Audio */
|
|
360
|
+
export interface IAudio {
|
|
361
|
+
/** Id */
|
|
362
|
+
id: string;
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* BaseCharSplitConfig
|
|
366
|
+
* Base char split configuration class
|
|
367
|
+
*/
|
|
368
|
+
export interface IBaseCharSplitConfig {
|
|
369
|
+
/**
|
|
370
|
+
* Chunk Size
|
|
371
|
+
* chunk max size
|
|
372
|
+
* @min 1
|
|
373
|
+
* @default 1500
|
|
374
|
+
*/
|
|
375
|
+
chunk_size?: number;
|
|
376
|
+
/**
|
|
377
|
+
* Chunk Overlap
|
|
378
|
+
* chunk overlap size, must be less than chunk_size
|
|
379
|
+
* @min 0
|
|
380
|
+
* @default 150
|
|
381
|
+
*/
|
|
382
|
+
chunk_overlap?: number;
|
|
383
|
+
/**
|
|
384
|
+
* Separators
|
|
385
|
+
* separator list, if None, use default separators
|
|
386
|
+
*/
|
|
387
|
+
separators?: string[] | null;
|
|
388
|
+
/**
|
|
389
|
+
* Split Regex
|
|
390
|
+
* split_regex,if set, use it instead of separators
|
|
391
|
+
*/
|
|
392
|
+
split_regex?: string | null;
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* BaseCodeSplitConfig
|
|
396
|
+
* Code document split configuration
|
|
397
|
+
*/
|
|
398
|
+
export interface IBaseCodeSplitConfig {
|
|
399
|
+
/**
|
|
400
|
+
* Type
|
|
401
|
+
* @default "base_code"
|
|
402
|
+
*/
|
|
403
|
+
type?: "base_code";
|
|
404
|
+
/** The programming language of the code. */
|
|
405
|
+
language: ILanguage;
|
|
406
|
+
/**
|
|
407
|
+
* Chunk Size
|
|
408
|
+
* chunk max size for code
|
|
409
|
+
* @min 1
|
|
410
|
+
* @default 1500
|
|
411
|
+
*/
|
|
412
|
+
chunk_size?: number;
|
|
413
|
+
/**
|
|
414
|
+
* Chunk Overlap
|
|
415
|
+
* chunk overlap size for code, must be less than chunk_size
|
|
416
|
+
* @min 0
|
|
417
|
+
* @default 150
|
|
418
|
+
*/
|
|
419
|
+
chunk_overlap?: number;
|
|
420
|
+
}
|
|
421
|
+
/** ChatCompletionAssistantMessageParam */
|
|
422
|
+
export interface IChatCompletionAssistantMessageParam {
|
|
423
|
+
/** Role */
|
|
424
|
+
role: "assistant";
|
|
425
|
+
audio?: IAudio | null;
|
|
426
|
+
/** Content */
|
|
427
|
+
content?: string | (IChatCompletionContentPartTextParam | IChatCompletionContentPartRefusalParam)[] | null;
|
|
428
|
+
function_call?: IFunctionCall | null;
|
|
429
|
+
/** Name */
|
|
430
|
+
name?: string;
|
|
431
|
+
/** Refusal */
|
|
432
|
+
refusal?: string | null;
|
|
433
|
+
/** Tool Calls */
|
|
434
|
+
tool_calls?: (IChatCompletionMessageFunctionToolCallParam | IChatCompletionMessageCustomToolCallParam)[];
|
|
435
|
+
}
|
|
436
|
+
/** ChatCompletionContentPartImageParam */
|
|
437
|
+
export interface IChatCompletionContentPartImageParam {
|
|
438
|
+
image_url: IImageURL;
|
|
439
|
+
/** Type */
|
|
440
|
+
type: "image_url";
|
|
441
|
+
}
|
|
442
|
+
/** ChatCompletionContentPartInputAudioParam */
|
|
443
|
+
export interface IChatCompletionContentPartInputAudioParam {
|
|
444
|
+
input_audio: IInputAudio;
|
|
445
|
+
/** Type */
|
|
446
|
+
type: "input_audio";
|
|
447
|
+
}
|
|
448
|
+
/** ChatCompletionContentPartRefusalParam */
|
|
449
|
+
export interface IChatCompletionContentPartRefusalParam {
|
|
450
|
+
/** Refusal */
|
|
451
|
+
refusal: string;
|
|
452
|
+
/** Type */
|
|
453
|
+
type: "refusal";
|
|
454
|
+
}
|
|
455
|
+
/** ChatCompletionContentPartTextParam */
|
|
456
|
+
export interface IChatCompletionContentPartTextParam {
|
|
457
|
+
/** Text */
|
|
458
|
+
text: string;
|
|
459
|
+
/** Type */
|
|
460
|
+
type: "text";
|
|
461
|
+
}
|
|
462
|
+
/** ChatCompletionDeveloperMessageParam */
|
|
463
|
+
export interface IChatCompletionDeveloperMessageParam {
|
|
464
|
+
/** Content */
|
|
465
|
+
content: string | IChatCompletionContentPartTextParam[];
|
|
466
|
+
/** Role */
|
|
467
|
+
role: "developer";
|
|
468
|
+
/** Name */
|
|
469
|
+
name?: string;
|
|
470
|
+
}
|
|
471
|
+
/** ChatCompletionFunctionMessageParam */
|
|
472
|
+
export interface IChatCompletionFunctionMessageParam {
|
|
473
|
+
/** Content */
|
|
474
|
+
content: string | null;
|
|
475
|
+
/** Name */
|
|
476
|
+
name: string;
|
|
477
|
+
/** Role */
|
|
478
|
+
role: "function";
|
|
479
|
+
}
|
|
480
|
+
/** ChatCompletionMessageCustomToolCallParam */
|
|
481
|
+
export interface IChatCompletionMessageCustomToolCallParam {
|
|
482
|
+
/** Id */
|
|
483
|
+
id: string;
|
|
484
|
+
custom: ICustom;
|
|
485
|
+
/** Type */
|
|
486
|
+
type: "custom";
|
|
487
|
+
}
|
|
488
|
+
/** ChatCompletionMessageFunctionToolCallParam */
|
|
489
|
+
export interface IChatCompletionMessageFunctionToolCallParam {
|
|
490
|
+
/** Id */
|
|
491
|
+
id: string;
|
|
492
|
+
function: IFunction;
|
|
493
|
+
/** Type */
|
|
494
|
+
type: "function";
|
|
495
|
+
}
|
|
496
|
+
/** ChatCompletionSystemMessageParam */
|
|
497
|
+
export interface IChatCompletionSystemMessageParam {
|
|
498
|
+
/** Content */
|
|
499
|
+
content: string | IChatCompletionContentPartTextParam[];
|
|
500
|
+
/** Role */
|
|
501
|
+
role: "system";
|
|
502
|
+
/** Name */
|
|
503
|
+
name?: string;
|
|
504
|
+
}
|
|
505
|
+
/** ChatCompletionToolMessageParam */
|
|
506
|
+
export interface IChatCompletionToolMessageParam {
|
|
507
|
+
/** Content */
|
|
508
|
+
content: string | IChatCompletionContentPartTextParam[];
|
|
509
|
+
/** Role */
|
|
510
|
+
role: "tool";
|
|
511
|
+
/** Tool Call Id */
|
|
512
|
+
tool_call_id: string;
|
|
513
|
+
}
|
|
514
|
+
/** ChatCompletionUserMessageParam */
|
|
515
|
+
export interface IChatCompletionUserMessageParam {
|
|
516
|
+
/** Content */
|
|
517
|
+
content: string | (IChatCompletionContentPartTextParam | IChatCompletionContentPartImageParam | IChatCompletionContentPartInputAudioParam | IFile)[];
|
|
518
|
+
/** Role */
|
|
519
|
+
role: "user";
|
|
520
|
+
/** Name */
|
|
521
|
+
name?: string;
|
|
522
|
+
}
|
|
523
|
+
/** Chunk */
|
|
524
|
+
export interface IChunk {
|
|
525
|
+
/**
|
|
526
|
+
* Gmt Create
|
|
527
|
+
* creation time
|
|
528
|
+
*/
|
|
529
|
+
gmt_create?: string;
|
|
530
|
+
/**
|
|
531
|
+
* Gmt Modified
|
|
532
|
+
* update time
|
|
533
|
+
*/
|
|
534
|
+
gmt_modified?: string;
|
|
535
|
+
/**
|
|
536
|
+
* Chunk Id
|
|
537
|
+
* chunk id
|
|
538
|
+
*/
|
|
539
|
+
chunk_id?: string;
|
|
540
|
+
/**
|
|
541
|
+
* Space Id
|
|
542
|
+
* space id
|
|
543
|
+
*/
|
|
544
|
+
space_id: string;
|
|
545
|
+
/**
|
|
546
|
+
* Tenant Id
|
|
547
|
+
* tenant id
|
|
548
|
+
*/
|
|
549
|
+
tenant_id: string;
|
|
550
|
+
/**
|
|
551
|
+
* Embedding
|
|
552
|
+
* chunk embedding
|
|
553
|
+
*/
|
|
554
|
+
embedding?: number[] | null;
|
|
555
|
+
/**
|
|
556
|
+
* Context
|
|
557
|
+
* chunk content
|
|
558
|
+
*/
|
|
559
|
+
context: string;
|
|
560
|
+
/**
|
|
561
|
+
* Knowledge Id
|
|
562
|
+
* file source info
|
|
563
|
+
*/
|
|
564
|
+
knowledge_id: string;
|
|
565
|
+
/**
|
|
566
|
+
* Enabled
|
|
567
|
+
* is chunk enabled
|
|
568
|
+
* @default true
|
|
569
|
+
*/
|
|
570
|
+
enabled?: boolean;
|
|
571
|
+
/**
|
|
572
|
+
* Embedding Model Name
|
|
573
|
+
* name of the embedding model
|
|
574
|
+
*/
|
|
575
|
+
embedding_model_name?: string;
|
|
576
|
+
/**
|
|
577
|
+
* Metadata
|
|
578
|
+
* Arbitrary metadata associated with the content.
|
|
579
|
+
*/
|
|
580
|
+
metadata?: Record<string, any> | null;
|
|
581
|
+
/**
|
|
582
|
+
* Tags
|
|
583
|
+
* Tags from knowledge.metadata._tags
|
|
584
|
+
*/
|
|
585
|
+
tags?: string[] | null;
|
|
586
|
+
/**
|
|
587
|
+
* F1
|
|
588
|
+
* Field 1 from knowledge.metadata._f1
|
|
589
|
+
*/
|
|
590
|
+
f1?: string | null;
|
|
591
|
+
/**
|
|
592
|
+
* F2
|
|
593
|
+
* Field 2 from knowledge.metadata._f2
|
|
594
|
+
*/
|
|
595
|
+
f2?: string | null;
|
|
596
|
+
/**
|
|
597
|
+
* F3
|
|
598
|
+
* Field 3 from knowledge.metadata._f3
|
|
599
|
+
*/
|
|
600
|
+
f3?: string | null;
|
|
601
|
+
/**
|
|
602
|
+
* F4
|
|
603
|
+
* Field 4 from knowledge.metadata._f4
|
|
604
|
+
*/
|
|
605
|
+
f4?: string | null;
|
|
606
|
+
/**
|
|
607
|
+
* F5
|
|
608
|
+
* Field 5 from knowledge.metadata._f5
|
|
609
|
+
*/
|
|
610
|
+
f5?: string | null;
|
|
611
|
+
}
|
|
612
|
+
/** ChunkSave */
|
|
613
|
+
export interface IChunkSave {
|
|
614
|
+
/** Space Id */
|
|
615
|
+
space_id: string;
|
|
616
|
+
/** Context */
|
|
617
|
+
context: string;
|
|
618
|
+
/** Knowledge Id */
|
|
619
|
+
knowledge_id: string;
|
|
620
|
+
/** Embedding Model Name */
|
|
621
|
+
embedding_model_name: string;
|
|
622
|
+
/** Metadata */
|
|
623
|
+
metadata?: Record<string, any> | null;
|
|
624
|
+
}
|
|
625
|
+
/** ChunkUpdate */
|
|
626
|
+
export interface IChunkUpdate {
|
|
627
|
+
/** Chunk Id */
|
|
628
|
+
chunk_id?: string;
|
|
629
|
+
/** Context */
|
|
630
|
+
context?: string | null;
|
|
631
|
+
/** Embedding Model Name */
|
|
632
|
+
embedding_model_name: string;
|
|
633
|
+
/** Metadata */
|
|
634
|
+
metadata?: Record<string, any> | null;
|
|
635
|
+
}
|
|
636
|
+
/** Condition */
|
|
637
|
+
export interface ICondition {
|
|
638
|
+
/** Field */
|
|
639
|
+
field: string;
|
|
640
|
+
/** Operator */
|
|
641
|
+
operator: string;
|
|
642
|
+
/** Value */
|
|
643
|
+
value: any;
|
|
644
|
+
}
|
|
645
|
+
/** Custom */
|
|
646
|
+
export interface ICustom {
|
|
647
|
+
/** Input */
|
|
648
|
+
input: string;
|
|
649
|
+
/** Name */
|
|
650
|
+
name: string;
|
|
651
|
+
}
|
|
652
|
+
/** EnableStatusUpdate */
|
|
653
|
+
export interface IEnableStatusUpdate {
|
|
654
|
+
/** Knowledge Id */
|
|
655
|
+
knowledge_id: string;
|
|
656
|
+
/** Status */
|
|
657
|
+
status: boolean;
|
|
658
|
+
}
|
|
659
|
+
/** File */
|
|
660
|
+
export interface IFile {
|
|
661
|
+
file: IFileFile;
|
|
662
|
+
/** Type */
|
|
663
|
+
type: "file";
|
|
664
|
+
}
|
|
665
|
+
/** FileFile */
|
|
666
|
+
export interface IFileFile {
|
|
667
|
+
/** File Data */
|
|
668
|
+
file_data?: string;
|
|
669
|
+
/** File Id */
|
|
670
|
+
file_id?: string;
|
|
671
|
+
/** Filename */
|
|
672
|
+
filename?: string;
|
|
673
|
+
}
|
|
674
|
+
/** FilterGroup */
|
|
675
|
+
export interface IFilterGroup {
|
|
676
|
+
operator: IOperator;
|
|
677
|
+
/** Conditions */
|
|
678
|
+
conditions: (ICondition | IFilterGroup)[];
|
|
679
|
+
}
|
|
680
|
+
/** Function */
|
|
681
|
+
export interface IFunction {
|
|
682
|
+
/** Arguments */
|
|
683
|
+
arguments: string;
|
|
684
|
+
/** Name */
|
|
685
|
+
name: string;
|
|
686
|
+
}
|
|
687
|
+
/** FunctionCall */
|
|
688
|
+
export interface IFunctionCall {
|
|
689
|
+
/** Arguments */
|
|
690
|
+
arguments: string;
|
|
691
|
+
/** Name */
|
|
692
|
+
name: string;
|
|
693
|
+
}
|
|
694
|
+
/**
|
|
695
|
+
* GeaGraphSplitConfig
|
|
696
|
+
* JSON document split configuration
|
|
697
|
+
* @link {https://python.langchain.com/api_reference/text_splitters/json/langchain_text_splitters.json.RecursiveJsonSplitter.html}
|
|
698
|
+
*/
|
|
699
|
+
export interface IGeaGraphSplitConfig {
|
|
700
|
+
/**
|
|
701
|
+
* Type
|
|
702
|
+
* @default "geagraph"
|
|
703
|
+
*/
|
|
704
|
+
type?: "geagraph";
|
|
705
|
+
/**
|
|
706
|
+
* Kisid
|
|
707
|
+
* The Kis platform business id
|
|
708
|
+
*/
|
|
709
|
+
kisId: number;
|
|
710
|
+
}
|
|
711
|
+
/** GithubFileSourceConfig */
|
|
712
|
+
export interface IGithubFileSourceConfig {
|
|
713
|
+
/**
|
|
714
|
+
* Repo Name
|
|
715
|
+
* github repo url
|
|
716
|
+
*/
|
|
717
|
+
repo_name: string;
|
|
718
|
+
/**
|
|
719
|
+
* Url
|
|
720
|
+
* remote origin of the repo, must start with http:// or https://
|
|
721
|
+
* @default "https://github.com"
|
|
722
|
+
*/
|
|
723
|
+
url?: string;
|
|
724
|
+
/**
|
|
725
|
+
* Branch
|
|
726
|
+
* branch name of the repo
|
|
727
|
+
*/
|
|
728
|
+
branch?: string | null;
|
|
729
|
+
/**
|
|
730
|
+
* Commit Id
|
|
731
|
+
* commit id of the repo
|
|
732
|
+
*/
|
|
733
|
+
commit_id?: string | null;
|
|
734
|
+
/**
|
|
735
|
+
* Auth Info
|
|
736
|
+
* authentication information
|
|
737
|
+
*/
|
|
738
|
+
auth_info?: string | null;
|
|
739
|
+
/**
|
|
740
|
+
* Path
|
|
741
|
+
* path of the file in the repo
|
|
742
|
+
*/
|
|
743
|
+
path: string;
|
|
744
|
+
}
|
|
745
|
+
/** GithubRepoCreate */
|
|
746
|
+
export interface IGithubRepoCreate {
|
|
747
|
+
/**
|
|
748
|
+
* Space Id
|
|
749
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
750
|
+
*/
|
|
751
|
+
space_id: string;
|
|
752
|
+
/**
|
|
753
|
+
* Knowledge Type
|
|
754
|
+
* type of knowledge resource
|
|
755
|
+
* @default "github_repo"
|
|
756
|
+
*/
|
|
757
|
+
knowledge_type?: "github_repo";
|
|
758
|
+
/**
|
|
759
|
+
* Knowledge Name
|
|
760
|
+
* name of the knowledge resource
|
|
761
|
+
* @maxLength 255
|
|
762
|
+
*/
|
|
763
|
+
knowledge_name: string;
|
|
764
|
+
/**
|
|
765
|
+
* Metadata
|
|
766
|
+
* additional metadata, user can update it
|
|
767
|
+
* @default {}
|
|
768
|
+
*/
|
|
769
|
+
metadata?: Record<string, any>;
|
|
770
|
+
/** source type */
|
|
771
|
+
source_type: IKnowledgeSourceEnum;
|
|
772
|
+
/**
|
|
773
|
+
* Embedding Model Name
|
|
774
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
775
|
+
* @default "openai"
|
|
776
|
+
*/
|
|
777
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
778
|
+
/**
|
|
779
|
+
* File Sha
|
|
780
|
+
* SHA of the file
|
|
781
|
+
*/
|
|
782
|
+
file_sha?: string | null;
|
|
783
|
+
/**
|
|
784
|
+
* File Size
|
|
785
|
+
* size of the file
|
|
786
|
+
*/
|
|
787
|
+
file_size?: number | null;
|
|
788
|
+
/**
|
|
789
|
+
* Parent Id
|
|
790
|
+
* parent id of the knowledge
|
|
791
|
+
*/
|
|
792
|
+
parent_id?: string | null;
|
|
793
|
+
/** source config of the knowledge */
|
|
794
|
+
source_config: IGithubRepoSourceConfig;
|
|
795
|
+
/** split config of the knowledge */
|
|
796
|
+
split_config: IGithubRepoParseConfig;
|
|
797
|
+
}
|
|
798
|
+
/** GithubRepoParseConfig */
|
|
799
|
+
export interface IGithubRepoParseConfig {
|
|
800
|
+
/**
|
|
801
|
+
* Chunk Size
|
|
802
|
+
* chunk max size
|
|
803
|
+
* @min 1
|
|
804
|
+
* @default 1500
|
|
805
|
+
*/
|
|
806
|
+
chunk_size?: number;
|
|
807
|
+
/**
|
|
808
|
+
* Chunk Overlap
|
|
809
|
+
* chunk overlap size, must be less than chunk_size
|
|
810
|
+
* @min 0
|
|
811
|
+
* @default 150
|
|
812
|
+
*/
|
|
813
|
+
chunk_overlap?: number;
|
|
814
|
+
/**
|
|
815
|
+
* Type
|
|
816
|
+
* @default "github_repo"
|
|
817
|
+
*/
|
|
818
|
+
type?: "github_repo";
|
|
819
|
+
/**
|
|
820
|
+
* Include Patterns
|
|
821
|
+
* List of include patterns (comma-separated) to filter files in the repo.Only files matching these patterns will be included, unless excluded by ignore_patterns or .gitignore. Lower priority than ignore_patterns and .gitignore.
|
|
822
|
+
*/
|
|
823
|
+
include_patterns?: string[] | null;
|
|
824
|
+
/**
|
|
825
|
+
* Ignore Patterns
|
|
826
|
+
* Additional ignore patterns (comma-separated) to exclude files in the repo. Highest priority, overrides include_patterns and .gitignore.
|
|
827
|
+
*/
|
|
828
|
+
ignore_patterns?: string[] | null;
|
|
829
|
+
/**
|
|
830
|
+
* Use Gitignore
|
|
831
|
+
* Whether to respect .gitignore rules when filtering files. Priority is lower than ignore_patterns, higher than include_patterns.
|
|
832
|
+
* @default true
|
|
833
|
+
*/
|
|
834
|
+
use_gitignore?: boolean | null;
|
|
835
|
+
/**
|
|
836
|
+
* Use Default Ignore
|
|
837
|
+
* Whether to use default ignore patterns (e.g. .git/*, *.pyc, etc). Lowest priority.
|
|
838
|
+
* @default true
|
|
839
|
+
*/
|
|
840
|
+
use_default_ignore?: boolean | null;
|
|
841
|
+
}
|
|
842
|
+
/** GithubRepoSourceConfig */
|
|
843
|
+
export interface IGithubRepoSourceConfig {
|
|
844
|
+
/**
|
|
845
|
+
* Repo Name
|
|
846
|
+
* github repo url
|
|
847
|
+
*/
|
|
848
|
+
repo_name: string;
|
|
849
|
+
/**
|
|
850
|
+
* Url
|
|
851
|
+
* remote origin of the repo, must start with http:// or https://
|
|
852
|
+
* @default "https://github.com"
|
|
853
|
+
*/
|
|
854
|
+
url?: string;
|
|
855
|
+
/**
|
|
856
|
+
* Branch
|
|
857
|
+
* branch name of the repo
|
|
858
|
+
*/
|
|
859
|
+
branch?: string | null;
|
|
860
|
+
/**
|
|
861
|
+
* Commit Id
|
|
862
|
+
* commit id of the repo
|
|
863
|
+
*/
|
|
864
|
+
commit_id?: string | null;
|
|
865
|
+
/**
|
|
866
|
+
* Auth Info
|
|
867
|
+
* authentication information
|
|
868
|
+
*/
|
|
869
|
+
auth_info?: string | null;
|
|
870
|
+
}
|
|
871
|
+
/** GlobalInfo */
|
|
872
|
+
export interface IGlobalInfo {
|
|
873
|
+
/** Space Count */
|
|
874
|
+
space_count?: number | null;
|
|
875
|
+
/** Knowledge Count */
|
|
876
|
+
knowledge_count?: number | null;
|
|
877
|
+
/** Task Count */
|
|
878
|
+
task_count?: number | null;
|
|
879
|
+
/** Tenant Count */
|
|
880
|
+
tenant_count?: number | null;
|
|
881
|
+
/** Retrieval Count */
|
|
882
|
+
retrieval_count?: number | null;
|
|
883
|
+
/** Storage Size */
|
|
884
|
+
storage_size?: string | null;
|
|
885
|
+
}
|
|
886
|
+
/** HTTPValidationError */
|
|
887
|
+
export interface IHTTPValidationError {
|
|
888
|
+
/** Detail */
|
|
889
|
+
detail?: IValidationError[];
|
|
890
|
+
}
|
|
891
|
+
/** ImageCreate */
|
|
892
|
+
export interface IImageCreate {
|
|
893
|
+
/**
|
|
894
|
+
* Space Id
|
|
895
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
896
|
+
*/
|
|
897
|
+
space_id: string;
|
|
898
|
+
/**
|
|
899
|
+
* Knowledge Type
|
|
900
|
+
* type of knowledge resource
|
|
901
|
+
* @default "image"
|
|
902
|
+
*/
|
|
903
|
+
knowledge_type?: "image";
|
|
904
|
+
/**
|
|
905
|
+
* Knowledge Name
|
|
906
|
+
* name of the knowledge resource
|
|
907
|
+
* @maxLength 255
|
|
908
|
+
*/
|
|
909
|
+
knowledge_name: string;
|
|
910
|
+
/**
|
|
911
|
+
* Metadata
|
|
912
|
+
* additional metadata, user can update it
|
|
913
|
+
* @default {}
|
|
914
|
+
*/
|
|
915
|
+
metadata?: Record<string, any>;
|
|
916
|
+
/**
|
|
917
|
+
* Source Type
|
|
918
|
+
* image source type, if the source is image's description, the source type is text like
|
|
919
|
+
* @default "cloud_storage_image"
|
|
920
|
+
*/
|
|
921
|
+
source_type?: "cloud_storage_image" | "cloud_storage_text" | "user_input_text";
|
|
922
|
+
/**
|
|
923
|
+
* Embedding Model Name
|
|
924
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
925
|
+
* @default "openai"
|
|
926
|
+
*/
|
|
927
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
928
|
+
/**
|
|
929
|
+
* File Sha
|
|
930
|
+
* SHA of the file, if source_type is cloud_storage_text, this field is the sha of the text file
|
|
931
|
+
*/
|
|
932
|
+
file_sha: string;
|
|
933
|
+
/**
|
|
934
|
+
* File Size
|
|
935
|
+
* Byte size of the file. if source_type is cloud_storage_text, this field is the size of the text file
|
|
936
|
+
*/
|
|
937
|
+
file_size: number;
|
|
938
|
+
/**
|
|
939
|
+
* Parent Id
|
|
940
|
+
* parent id of the knowledge
|
|
941
|
+
*/
|
|
942
|
+
parent_id?: string | null;
|
|
943
|
+
/**
|
|
944
|
+
* Source Config
|
|
945
|
+
* source config of the knowledge
|
|
946
|
+
*/
|
|
947
|
+
source_config: IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig | ITextSourceConfig;
|
|
948
|
+
/**
|
|
949
|
+
* Split Config
|
|
950
|
+
* split config of the knowledge
|
|
951
|
+
*/
|
|
952
|
+
split_config: IImageSplitConfig | ITextSplitConfig;
|
|
953
|
+
}
|
|
954
|
+
/** ImageSplitConfig */
|
|
955
|
+
export interface IImageSplitConfig {
|
|
956
|
+
/**
|
|
957
|
+
* Type
|
|
958
|
+
* @default "image"
|
|
959
|
+
*/
|
|
960
|
+
type?: "image";
|
|
961
|
+
}
|
|
962
|
+
/** ImageURL */
|
|
963
|
+
export interface IImageURL {
|
|
964
|
+
/** Url */
|
|
965
|
+
url: string;
|
|
966
|
+
/** Detail */
|
|
967
|
+
detail?: "auto" | "low" | "high";
|
|
968
|
+
}
|
|
969
|
+
/** InputAudio */
|
|
970
|
+
export interface IInputAudio {
|
|
971
|
+
/** Data */
|
|
972
|
+
data: string;
|
|
973
|
+
/** Format */
|
|
974
|
+
format: "wav" | "mp3";
|
|
975
|
+
}
|
|
976
|
+
/** JSONCreate */
|
|
977
|
+
export interface IJSONCreate {
|
|
978
|
+
/**
|
|
979
|
+
* Space Id
|
|
980
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
981
|
+
*/
|
|
982
|
+
space_id: string;
|
|
983
|
+
/**
|
|
984
|
+
* Knowledge Type
|
|
985
|
+
* type of knowledge resource
|
|
986
|
+
* @default "json"
|
|
987
|
+
*/
|
|
988
|
+
knowledge_type?: "json";
|
|
989
|
+
/**
|
|
990
|
+
* Knowledge Name
|
|
991
|
+
* name of the knowledge resource
|
|
992
|
+
* @maxLength 255
|
|
993
|
+
*/
|
|
994
|
+
knowledge_name: string;
|
|
995
|
+
/**
|
|
996
|
+
* Metadata
|
|
997
|
+
* additional metadata, user can update it
|
|
998
|
+
* @default {}
|
|
999
|
+
*/
|
|
1000
|
+
metadata?: Record<string, any>;
|
|
1001
|
+
/** source type */
|
|
1002
|
+
source_type: IKnowledgeSourceEnum;
|
|
1003
|
+
/**
|
|
1004
|
+
* Embedding Model Name
|
|
1005
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
1006
|
+
* @default "openai"
|
|
1007
|
+
*/
|
|
1008
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
1009
|
+
/**
|
|
1010
|
+
* File Sha
|
|
1011
|
+
* SHA of the file
|
|
1012
|
+
*/
|
|
1013
|
+
file_sha?: string | null;
|
|
1014
|
+
/**
|
|
1015
|
+
* File Size
|
|
1016
|
+
* size of the file
|
|
1017
|
+
*/
|
|
1018
|
+
file_size?: number | null;
|
|
1019
|
+
/**
|
|
1020
|
+
* Parent Id
|
|
1021
|
+
* parent id of the knowledge
|
|
1022
|
+
*/
|
|
1023
|
+
parent_id?: string | null;
|
|
1024
|
+
/**
|
|
1025
|
+
* Source Config
|
|
1026
|
+
* source config of the knowledge
|
|
1027
|
+
*/
|
|
1028
|
+
source_config: ITextSourceConfig | IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
|
|
1029
|
+
/** split config of the knowledge */
|
|
1030
|
+
split_config: IJSONSplitConfig;
|
|
1031
|
+
}
|
|
1032
|
+
/**
|
|
1033
|
+
* JSONSplitConfig
|
|
1034
|
+
* JSON document split configuration
|
|
1035
|
+
* @link {https://python.langchain.com/api_reference/text_splitters/json/langchain_text_splitters.json.RecursiveJsonSplitter.html}
|
|
1036
|
+
*/
|
|
1037
|
+
export interface IJSONSplitConfig {
|
|
1038
|
+
/**
|
|
1039
|
+
* Type
|
|
1040
|
+
* @default "json"
|
|
1041
|
+
*/
|
|
1042
|
+
type?: "json";
|
|
1043
|
+
/**
|
|
1044
|
+
* Max Chunk Size
|
|
1045
|
+
* The maximum size for each chunk. Defaults to 2000
|
|
1046
|
+
* @default 2000
|
|
1047
|
+
*/
|
|
1048
|
+
max_chunk_size?: number;
|
|
1049
|
+
/**
|
|
1050
|
+
* Min Chunk Size
|
|
1051
|
+
* The minimum size for a chunk. If None,
|
|
1052
|
+
* defaults to the maximum chunk size minus 200, with a lower bound of 50.
|
|
1053
|
+
* @default 200
|
|
1054
|
+
*/
|
|
1055
|
+
min_chunk_size?: number | null;
|
|
1056
|
+
}
|
|
1057
|
+
/** Knowledge */
|
|
1058
|
+
export interface IKnowledgeInput {
|
|
1059
|
+
/**
|
|
1060
|
+
* Gmt Create
|
|
1061
|
+
* creation time
|
|
1062
|
+
*/
|
|
1063
|
+
gmt_create?: string | null;
|
|
1064
|
+
/**
|
|
1065
|
+
* Gmt Modified
|
|
1066
|
+
* update time
|
|
1067
|
+
*/
|
|
1068
|
+
gmt_modified?: string | null;
|
|
1069
|
+
/**
|
|
1070
|
+
* Knowledge Id
|
|
1071
|
+
* knowledge id
|
|
1072
|
+
*/
|
|
1073
|
+
knowledge_id?: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* Space Id
|
|
1076
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
1077
|
+
*/
|
|
1078
|
+
space_id: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* Tenant Id
|
|
1081
|
+
* tenant id
|
|
1082
|
+
*/
|
|
1083
|
+
tenant_id: string;
|
|
1084
|
+
/**
|
|
1085
|
+
* type of knowledge resource
|
|
1086
|
+
* @default "text"
|
|
1087
|
+
*/
|
|
1088
|
+
knowledge_type?: IKnowledgeTypeEnum;
|
|
1089
|
+
/**
|
|
1090
|
+
* Knowledge Name
|
|
1091
|
+
* name of the knowledge resource
|
|
1092
|
+
* @maxLength 255
|
|
1093
|
+
*/
|
|
1094
|
+
knowledge_name: string;
|
|
1095
|
+
/**
|
|
1096
|
+
* source type
|
|
1097
|
+
* @default "user_input_text"
|
|
1098
|
+
*/
|
|
1099
|
+
source_type?: IKnowledgeSourceEnum;
|
|
1100
|
+
/**
|
|
1101
|
+
* Source Config
|
|
1102
|
+
* source config of the knowledge
|
|
1103
|
+
*/
|
|
1104
|
+
source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig | IYuqueSourceConfig;
|
|
1105
|
+
/**
|
|
1106
|
+
* Embedding Model Name
|
|
1107
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
1108
|
+
* @default "openai"
|
|
1109
|
+
*/
|
|
1110
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
1111
|
+
/**
|
|
1112
|
+
* Split Config
|
|
1113
|
+
* configuration for splitting the knowledge
|
|
1114
|
+
*/
|
|
1115
|
+
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IYuqueSplitConfig | IGeaGraphSplitConfig | IGithubRepoParseConfig | IBaseCodeSplitConfig | IImageSplitConfig;
|
|
1116
|
+
/**
|
|
1117
|
+
* File Sha
|
|
1118
|
+
* SHA of the file
|
|
1119
|
+
*/
|
|
1120
|
+
file_sha?: string | null;
|
|
1121
|
+
/**
|
|
1122
|
+
* File Size
|
|
1123
|
+
* size of the file
|
|
1124
|
+
*/
|
|
1125
|
+
file_size?: number | null;
|
|
1126
|
+
/**
|
|
1127
|
+
* Metadata
|
|
1128
|
+
* additional metadata, user can update it
|
|
1129
|
+
* @default {}
|
|
1130
|
+
*/
|
|
1131
|
+
metadata?: Record<string, any>;
|
|
1132
|
+
/**
|
|
1133
|
+
* Retrieval Count
|
|
1134
|
+
* count of the retrieval
|
|
1135
|
+
* @default 0
|
|
1136
|
+
*/
|
|
1137
|
+
retrieval_count?: number;
|
|
1138
|
+
/**
|
|
1139
|
+
* Parent Id
|
|
1140
|
+
* parent knowledge id
|
|
1141
|
+
*/
|
|
1142
|
+
parent_id?: string | null;
|
|
1143
|
+
/**
|
|
1144
|
+
* Enabled
|
|
1145
|
+
* is knowledge enabled
|
|
1146
|
+
* @default true
|
|
1147
|
+
*/
|
|
1148
|
+
enabled?: boolean;
|
|
1149
|
+
}
|
|
1150
|
+
/** Knowledge */
|
|
1151
|
+
export interface IKnowledgeOutput {
|
|
1152
|
+
/**
|
|
1153
|
+
* Gmt Create
|
|
1154
|
+
* creation time
|
|
1155
|
+
*/
|
|
1156
|
+
gmt_create?: string;
|
|
1157
|
+
/**
|
|
1158
|
+
* Gmt Modified
|
|
1159
|
+
* update time
|
|
1160
|
+
*/
|
|
1161
|
+
gmt_modified?: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* Knowledge Id
|
|
1164
|
+
* knowledge id
|
|
1165
|
+
*/
|
|
1166
|
+
knowledge_id?: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* Space Id
|
|
1169
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
1170
|
+
*/
|
|
1171
|
+
space_id: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* Tenant Id
|
|
1174
|
+
* tenant id
|
|
1175
|
+
*/
|
|
1176
|
+
tenant_id: string;
|
|
1177
|
+
/** type of knowledge resource */
|
|
1178
|
+
knowledge_type?: string;
|
|
1179
|
+
/**
|
|
1180
|
+
* Knowledge Name
|
|
1181
|
+
* name of the knowledge resource
|
|
1182
|
+
* @maxLength 255
|
|
1183
|
+
*/
|
|
1184
|
+
knowledge_name: string;
|
|
1185
|
+
/** source type */
|
|
1186
|
+
source_type?: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* Source Config
|
|
1189
|
+
* source config of the knowledge
|
|
1190
|
+
*/
|
|
1191
|
+
source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig | IYuqueSourceConfig;
|
|
1192
|
+
/**
|
|
1193
|
+
* Embedding Model Name
|
|
1194
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
1195
|
+
*/
|
|
1196
|
+
embedding_model_name?: string;
|
|
1197
|
+
/**
|
|
1198
|
+
* Split Config
|
|
1199
|
+
* configuration for splitting the knowledge
|
|
1200
|
+
*/
|
|
1201
|
+
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IYuqueSplitConfig | IGeaGraphSplitConfig | IGithubRepoParseConfig | IBaseCodeSplitConfig | IImageSplitConfig;
|
|
1202
|
+
/**
|
|
1203
|
+
* File Sha
|
|
1204
|
+
* SHA of the file
|
|
1205
|
+
*/
|
|
1206
|
+
file_sha?: string | null;
|
|
1207
|
+
/**
|
|
1208
|
+
* File Size
|
|
1209
|
+
* size of the file
|
|
1210
|
+
*/
|
|
1211
|
+
file_size?: number | null;
|
|
1212
|
+
/**
|
|
1213
|
+
* Metadata
|
|
1214
|
+
* additional metadata, user can update it
|
|
1215
|
+
*/
|
|
1216
|
+
metadata?: Record<string, any>;
|
|
1217
|
+
/**
|
|
1218
|
+
* Retrieval Count
|
|
1219
|
+
* count of the retrieval
|
|
1220
|
+
* @default 0
|
|
1221
|
+
*/
|
|
1222
|
+
retrieval_count?: number;
|
|
1223
|
+
/**
|
|
1224
|
+
* Parent Id
|
|
1225
|
+
* parent knowledge id
|
|
1226
|
+
*/
|
|
1227
|
+
parent_id?: string | null;
|
|
1228
|
+
/**
|
|
1229
|
+
* Enabled
|
|
1230
|
+
* is knowledge enabled
|
|
1231
|
+
* @default true
|
|
1232
|
+
*/
|
|
1233
|
+
enabled?: boolean;
|
|
1234
|
+
}
|
|
1235
|
+
/** KnowledgeScope */
|
|
1236
|
+
export interface IKnowledgeScope {
|
|
1237
|
+
/** Space Ids */
|
|
1238
|
+
space_ids?: string[] | null;
|
|
1239
|
+
/** Auth Info */
|
|
1240
|
+
auth_info: string;
|
|
1241
|
+
}
|
|
1242
|
+
/** MarkdownCreate */
|
|
1243
|
+
export interface IMarkdownCreate {
|
|
1244
|
+
/**
|
|
1245
|
+
* Space Id
|
|
1246
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
1247
|
+
*/
|
|
1248
|
+
space_id: string;
|
|
1249
|
+
/**
|
|
1250
|
+
* Knowledge Type
|
|
1251
|
+
* type of knowledge resource
|
|
1252
|
+
* @default "markdown"
|
|
1253
|
+
*/
|
|
1254
|
+
knowledge_type?: "markdown";
|
|
1255
|
+
/**
|
|
1256
|
+
* Knowledge Name
|
|
1257
|
+
* name of the knowledge resource
|
|
1258
|
+
* @maxLength 255
|
|
1259
|
+
*/
|
|
1260
|
+
knowledge_name: string;
|
|
1261
|
+
/**
|
|
1262
|
+
* Metadata
|
|
1263
|
+
* additional metadata, user can update it
|
|
1264
|
+
* @default {}
|
|
1265
|
+
*/
|
|
1266
|
+
metadata?: Record<string, any>;
|
|
1267
|
+
/** source type */
|
|
1268
|
+
source_type: IKnowledgeSourceEnum;
|
|
1269
|
+
/**
|
|
1270
|
+
* Embedding Model Name
|
|
1271
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
1272
|
+
* @default "openai"
|
|
1273
|
+
*/
|
|
1274
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
1275
|
+
/**
|
|
1276
|
+
* File Sha
|
|
1277
|
+
* SHA of the file
|
|
1278
|
+
*/
|
|
1279
|
+
file_sha?: string | null;
|
|
1280
|
+
/**
|
|
1281
|
+
* File Size
|
|
1282
|
+
* size of the file
|
|
1283
|
+
*/
|
|
1284
|
+
file_size?: number | null;
|
|
1285
|
+
/**
|
|
1286
|
+
* Parent Id
|
|
1287
|
+
* parent id of the knowledge
|
|
1288
|
+
*/
|
|
1289
|
+
parent_id?: string | null;
|
|
1290
|
+
/**
|
|
1291
|
+
* Source Config
|
|
1292
|
+
* source config of the knowledge
|
|
1293
|
+
*/
|
|
1294
|
+
source_config: ITextSourceConfig | IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
|
|
1295
|
+
/** split config of the knowledge */
|
|
1296
|
+
split_config: IMarkdownSplitConfig;
|
|
1297
|
+
}
|
|
1298
|
+
/** MarkdownSplitConfig */
|
|
1299
|
+
export interface IMarkdownSplitConfig {
|
|
1300
|
+
/**
|
|
1301
|
+
* Chunk Size
|
|
1302
|
+
* chunk max size
|
|
1303
|
+
* @min 1
|
|
1304
|
+
* @default 1500
|
|
1305
|
+
*/
|
|
1306
|
+
chunk_size?: number;
|
|
1307
|
+
/**
|
|
1308
|
+
* Chunk Overlap
|
|
1309
|
+
* chunk overlap size, must be less than chunk_size
|
|
1310
|
+
* @min 0
|
|
1311
|
+
* @default 150
|
|
1312
|
+
*/
|
|
1313
|
+
chunk_overlap?: number;
|
|
1314
|
+
/**
|
|
1315
|
+
* Type
|
|
1316
|
+
* @default "markdown"
|
|
1317
|
+
*/
|
|
1318
|
+
type?: "markdown";
|
|
1319
|
+
/**
|
|
1320
|
+
* Separators
|
|
1321
|
+
* List of separators to split the text. If None, uses default separators
|
|
1322
|
+
*/
|
|
1323
|
+
separators: string[];
|
|
1324
|
+
/**
|
|
1325
|
+
* Is Separator Regex
|
|
1326
|
+
* If true, the separators should be in regular expression format.
|
|
1327
|
+
*/
|
|
1328
|
+
is_separator_regex: boolean;
|
|
1329
|
+
/**
|
|
1330
|
+
* Keep Separator
|
|
1331
|
+
* Whether to keep the separator and where to place it in each corresponding chunk (True='start')
|
|
1332
|
+
* @default false
|
|
1333
|
+
*/
|
|
1334
|
+
keep_separator?: boolean | "start" | "end" | null;
|
|
1335
|
+
/**
|
|
1336
|
+
* Extract Header First
|
|
1337
|
+
* If true, will split markdown by header first
|
|
1338
|
+
* @default false
|
|
1339
|
+
*/
|
|
1340
|
+
extract_header_first?: boolean | null;
|
|
1341
|
+
}
|
|
1342
|
+
/** OpenIdSourceConfig */
|
|
1343
|
+
export interface IOpenIdSourceConfig {
|
|
1344
|
+
/**
|
|
1345
|
+
* Id
|
|
1346
|
+
* cloud storage file id, used for afts
|
|
1347
|
+
*/
|
|
1348
|
+
id: string;
|
|
1349
|
+
/**
|
|
1350
|
+
* Auth Info
|
|
1351
|
+
* authentication information
|
|
1352
|
+
*/
|
|
1353
|
+
auth_info?: string | Record<string, any> | null;
|
|
1354
|
+
}
|
|
1355
|
+
/** OpenUrlSourceConfig */
|
|
1356
|
+
export interface IOpenUrlSourceConfig {
|
|
1357
|
+
/**
|
|
1358
|
+
* Url
|
|
1359
|
+
* cloud storage url, such as oss, cos, etc.
|
|
1360
|
+
*/
|
|
1361
|
+
url: string;
|
|
1362
|
+
/**
|
|
1363
|
+
* Auth Info
|
|
1364
|
+
* authentication information
|
|
1365
|
+
*/
|
|
1366
|
+
auth_info?: string | Record<string, any> | null;
|
|
1367
|
+
}
|
|
1368
|
+
/** PDFCreate */
|
|
1369
|
+
export interface IPDFCreate {
|
|
1370
|
+
/**
|
|
1371
|
+
* Space Id
|
|
1372
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
1373
|
+
*/
|
|
1374
|
+
space_id: string;
|
|
1375
|
+
/**
|
|
1376
|
+
* Knowledge Type
|
|
1377
|
+
* type of knowledge resource
|
|
1378
|
+
* @default "pdf"
|
|
1379
|
+
*/
|
|
1380
|
+
knowledge_type?: "pdf";
|
|
1381
|
+
/**
|
|
1382
|
+
* Knowledge Name
|
|
1383
|
+
* name of the knowledge resource
|
|
1384
|
+
* @maxLength 255
|
|
1385
|
+
*/
|
|
1386
|
+
knowledge_name: string;
|
|
1387
|
+
/**
|
|
1388
|
+
* Metadata
|
|
1389
|
+
* additional metadata, user can update it
|
|
1390
|
+
* @default {}
|
|
1391
|
+
*/
|
|
1392
|
+
metadata?: Record<string, any>;
|
|
1393
|
+
/** source type */
|
|
1394
|
+
source_type: IKnowledgeSourceEnum;
|
|
1395
|
+
/**
|
|
1396
|
+
* Embedding Model Name
|
|
1397
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
1398
|
+
* @default "openai"
|
|
1399
|
+
*/
|
|
1400
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
1401
|
+
/**
|
|
1402
|
+
* File Sha
|
|
1403
|
+
* SHA of the file
|
|
1404
|
+
*/
|
|
1405
|
+
file_sha: string;
|
|
1406
|
+
/**
|
|
1407
|
+
* File Size
|
|
1408
|
+
* Byte size of the file
|
|
1409
|
+
*/
|
|
1410
|
+
file_size: number;
|
|
1411
|
+
/**
|
|
1412
|
+
* Parent Id
|
|
1413
|
+
* parent id of the knowledge
|
|
1414
|
+
*/
|
|
1415
|
+
parent_id?: string | null;
|
|
1416
|
+
/**
|
|
1417
|
+
* Source Config
|
|
1418
|
+
* source config of the knowledge
|
|
1419
|
+
*/
|
|
1420
|
+
source_config: IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
|
|
1421
|
+
/** split config of the knowledge */
|
|
1422
|
+
split_config: IPDFSplitConfig;
|
|
1423
|
+
}
|
|
1424
|
+
/**
|
|
1425
|
+
* PDFSplitConfig
|
|
1426
|
+
* PDF document split configuration
|
|
1427
|
+
*/
|
|
1428
|
+
export interface IPDFSplitConfig {
|
|
1429
|
+
/**
|
|
1430
|
+
* Chunk Size
|
|
1431
|
+
* chunk max size
|
|
1432
|
+
* @min 1
|
|
1433
|
+
* @default 1500
|
|
1434
|
+
*/
|
|
1435
|
+
chunk_size?: number;
|
|
1436
|
+
/**
|
|
1437
|
+
* Chunk Overlap
|
|
1438
|
+
* chunk overlap size, must be less than chunk_size
|
|
1439
|
+
* @min 0
|
|
1440
|
+
* @default 150
|
|
1441
|
+
*/
|
|
1442
|
+
chunk_overlap?: number;
|
|
1443
|
+
/**
|
|
1444
|
+
* Type
|
|
1445
|
+
* @default "pdf"
|
|
1446
|
+
*/
|
|
1447
|
+
type?: "pdf";
|
|
1448
|
+
/**
|
|
1449
|
+
* Extract Images
|
|
1450
|
+
* Whether to extract images
|
|
1451
|
+
* @default false
|
|
1452
|
+
*/
|
|
1453
|
+
extract_images?: boolean;
|
|
1454
|
+
/**
|
|
1455
|
+
* Table Extract Mode
|
|
1456
|
+
* Table extraction mode: 'text' or 'structure'
|
|
1457
|
+
* @default "text"
|
|
1458
|
+
*/
|
|
1459
|
+
table_extract_mode?: string;
|
|
1460
|
+
}
|
|
1461
|
+
/** PageQueryParams[APIKey] */
|
|
1462
|
+
export interface IPageQueryParamsAPIKey {
|
|
1463
|
+
/**
|
|
1464
|
+
* Order By
|
|
1465
|
+
* order by field
|
|
1466
|
+
*/
|
|
1467
|
+
order_by?: string | null;
|
|
1468
|
+
/**
|
|
1469
|
+
* Order Direction
|
|
1470
|
+
* asc or desc
|
|
1471
|
+
* @default "asc"
|
|
1472
|
+
*/
|
|
1473
|
+
order_direction?: string | null;
|
|
1474
|
+
/**
|
|
1475
|
+
* Eq Conditions
|
|
1476
|
+
* list of equality conditions, each as a dict with key and value
|
|
1477
|
+
*/
|
|
1478
|
+
eq_conditions?: Record<string, any> | null;
|
|
1479
|
+
/** advanced filter with nested conditions */
|
|
1480
|
+
advanced_filter?: IFilterGroup | null;
|
|
1481
|
+
/** 标签过滤条件 tag_name 和 tag_id */
|
|
1482
|
+
tag_filter?: ITagFilter | null;
|
|
1483
|
+
/**
|
|
1484
|
+
* Page
|
|
1485
|
+
* page number
|
|
1486
|
+
* @min 1
|
|
1487
|
+
* @default 1
|
|
1488
|
+
*/
|
|
1489
|
+
page?: number;
|
|
1490
|
+
/**
|
|
1491
|
+
* Page Size
|
|
1492
|
+
* page size
|
|
1493
|
+
* @min 1
|
|
1494
|
+
* @max 1000
|
|
1495
|
+
* @default 10
|
|
1496
|
+
*/
|
|
1497
|
+
page_size?: number;
|
|
1498
|
+
}
|
|
1499
|
+
/** PageQueryParams[ArtifactIndex] */
|
|
1500
|
+
export interface IPageQueryParamsArtifactIndex {
|
|
1501
|
+
/**
|
|
1502
|
+
* Order By
|
|
1503
|
+
* order by field
|
|
1504
|
+
*/
|
|
1505
|
+
order_by?: string | null;
|
|
1506
|
+
/**
|
|
1507
|
+
* Order Direction
|
|
1508
|
+
* asc or desc
|
|
1509
|
+
* @default "asc"
|
|
1510
|
+
*/
|
|
1511
|
+
order_direction?: string | null;
|
|
1512
|
+
/**
|
|
1513
|
+
* Eq Conditions
|
|
1514
|
+
* list of equality conditions, each as a dict with key and value
|
|
1515
|
+
*/
|
|
1516
|
+
eq_conditions?: Record<string, any> | null;
|
|
1517
|
+
/** advanced filter with nested conditions */
|
|
1518
|
+
advanced_filter?: IFilterGroup | null;
|
|
1519
|
+
/** 标签过滤条件 tag_name 和 tag_id */
|
|
1520
|
+
tag_filter?: ITagFilter | null;
|
|
1521
|
+
/**
|
|
1522
|
+
* Page
|
|
1523
|
+
* page number
|
|
1524
|
+
* @min 1
|
|
1525
|
+
* @default 1
|
|
1526
|
+
*/
|
|
1527
|
+
page?: number;
|
|
1528
|
+
/**
|
|
1529
|
+
* Page Size
|
|
1530
|
+
* page size
|
|
1531
|
+
* @min 1
|
|
1532
|
+
* @max 1000
|
|
1533
|
+
* @default 10
|
|
1534
|
+
*/
|
|
1535
|
+
page_size?: number;
|
|
1536
|
+
}
|
|
1537
|
+
/** PageQueryParams[Chunk] */
|
|
1538
|
+
export interface IPageQueryParamsChunk {
|
|
1539
|
+
/**
|
|
1540
|
+
* Order By
|
|
1541
|
+
* order by field
|
|
1542
|
+
*/
|
|
1543
|
+
order_by?: string | null;
|
|
1544
|
+
/**
|
|
1545
|
+
* Order Direction
|
|
1546
|
+
* asc or desc
|
|
1547
|
+
* @default "asc"
|
|
1548
|
+
*/
|
|
1549
|
+
order_direction?: string | null;
|
|
1550
|
+
/**
|
|
1551
|
+
* Eq Conditions
|
|
1552
|
+
* list of equality conditions, each as a dict with key and value
|
|
1553
|
+
*/
|
|
1554
|
+
eq_conditions?: Record<string, any> | null;
|
|
1555
|
+
/** advanced filter with nested conditions */
|
|
1556
|
+
advanced_filter?: IFilterGroup | null;
|
|
1557
|
+
/** 标签过滤条件 tag_name 和 tag_id */
|
|
1558
|
+
tag_filter?: ITagFilter | null;
|
|
1559
|
+
/**
|
|
1560
|
+
* Page
|
|
1561
|
+
* page number
|
|
1562
|
+
* @min 1
|
|
1563
|
+
* @default 1
|
|
1564
|
+
*/
|
|
1565
|
+
page?: number;
|
|
1566
|
+
/**
|
|
1567
|
+
* Page Size
|
|
1568
|
+
* page size
|
|
1569
|
+
* @min 1
|
|
1570
|
+
* @max 1000
|
|
1571
|
+
* @default 10
|
|
1572
|
+
*/
|
|
1573
|
+
page_size?: number;
|
|
1574
|
+
}
|
|
1575
|
+
/** PageQueryParams[Knowledge] */
|
|
1576
|
+
export interface IPageQueryParamsKnowledge {
|
|
1577
|
+
/**
|
|
1578
|
+
* Order By
|
|
1579
|
+
* order by field
|
|
1580
|
+
*/
|
|
1581
|
+
order_by?: string | null;
|
|
1582
|
+
/**
|
|
1583
|
+
* Order Direction
|
|
1584
|
+
* asc or desc
|
|
1585
|
+
* @default "asc"
|
|
1586
|
+
*/
|
|
1587
|
+
order_direction?: string | null;
|
|
1588
|
+
/**
|
|
1589
|
+
* Eq Conditions
|
|
1590
|
+
* list of equality conditions, each as a dict with key and value
|
|
1591
|
+
*/
|
|
1592
|
+
eq_conditions?: Record<string, any> | null;
|
|
1593
|
+
/** advanced filter with nested conditions */
|
|
1594
|
+
advanced_filter?: IFilterGroup | null;
|
|
1595
|
+
/** 标签过滤条件 tag_name 和 tag_id */
|
|
1596
|
+
tag_filter?: ITagFilter | null;
|
|
1597
|
+
/**
|
|
1598
|
+
* Page
|
|
1599
|
+
* page number
|
|
1600
|
+
* @min 1
|
|
1601
|
+
* @default 1
|
|
1602
|
+
*/
|
|
1603
|
+
page?: number;
|
|
1604
|
+
/**
|
|
1605
|
+
* Page Size
|
|
1606
|
+
* page size
|
|
1607
|
+
* @min 1
|
|
1608
|
+
* @max 1000
|
|
1609
|
+
* @default 10
|
|
1610
|
+
*/
|
|
1611
|
+
page_size?: number;
|
|
1612
|
+
}
|
|
1613
|
+
/** PageQueryParams[Space] */
|
|
1614
|
+
export interface IPageQueryParamsSpace {
|
|
1615
|
+
/**
|
|
1616
|
+
* Order By
|
|
1617
|
+
* order by field
|
|
1618
|
+
*/
|
|
1619
|
+
order_by?: string | null;
|
|
1620
|
+
/**
|
|
1621
|
+
* Order Direction
|
|
1622
|
+
* asc or desc
|
|
1623
|
+
* @default "asc"
|
|
1624
|
+
*/
|
|
1625
|
+
order_direction?: string | null;
|
|
1626
|
+
/**
|
|
1627
|
+
* Eq Conditions
|
|
1628
|
+
* list of equality conditions, each as a dict with key and value
|
|
1629
|
+
*/
|
|
1630
|
+
eq_conditions?: Record<string, any> | null;
|
|
1631
|
+
/** advanced filter with nested conditions */
|
|
1632
|
+
advanced_filter?: IFilterGroup | null;
|
|
1633
|
+
/** 标签过滤条件 tag_name 和 tag_id */
|
|
1634
|
+
tag_filter?: ITagFilter | null;
|
|
1635
|
+
/**
|
|
1636
|
+
* Page
|
|
1637
|
+
* page number
|
|
1638
|
+
* @min 1
|
|
1639
|
+
* @default 1
|
|
1640
|
+
*/
|
|
1641
|
+
page?: number;
|
|
1642
|
+
/**
|
|
1643
|
+
* Page Size
|
|
1644
|
+
* page size
|
|
1645
|
+
* @min 1
|
|
1646
|
+
* @max 1000
|
|
1647
|
+
* @default 10
|
|
1648
|
+
*/
|
|
1649
|
+
page_size?: number;
|
|
1650
|
+
}
|
|
1651
|
+
/** PageQueryParams[Tag] */
|
|
1652
|
+
export interface IPageQueryParamsTag {
|
|
1653
|
+
/**
|
|
1654
|
+
* Order By
|
|
1655
|
+
* order by field
|
|
1656
|
+
*/
|
|
1657
|
+
order_by?: string | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* Order Direction
|
|
1660
|
+
* asc or desc
|
|
1661
|
+
* @default "asc"
|
|
1662
|
+
*/
|
|
1663
|
+
order_direction?: string | null;
|
|
1664
|
+
/**
|
|
1665
|
+
* Eq Conditions
|
|
1666
|
+
* list of equality conditions, each as a dict with key and value
|
|
1667
|
+
*/
|
|
1668
|
+
eq_conditions?: Record<string, any> | null;
|
|
1669
|
+
/** advanced filter with nested conditions */
|
|
1670
|
+
advanced_filter?: IFilterGroup | null;
|
|
1671
|
+
/** 标签过滤条件 tag_name 和 tag_id */
|
|
1672
|
+
tag_filter?: ITagFilter | null;
|
|
1673
|
+
/**
|
|
1674
|
+
* Page
|
|
1675
|
+
* page number
|
|
1676
|
+
* @min 1
|
|
1677
|
+
* @default 1
|
|
1678
|
+
*/
|
|
1679
|
+
page?: number;
|
|
1680
|
+
/**
|
|
1681
|
+
* Page Size
|
|
1682
|
+
* page size
|
|
1683
|
+
* @min 1
|
|
1684
|
+
* @max 1000
|
|
1685
|
+
* @default 10
|
|
1686
|
+
*/
|
|
1687
|
+
page_size?: number;
|
|
1688
|
+
}
|
|
1689
|
+
/** PageQueryParams[Tagging] */
|
|
1690
|
+
export interface IPageQueryParamsTagging {
|
|
1691
|
+
/**
|
|
1692
|
+
* Order By
|
|
1693
|
+
* order by field
|
|
1694
|
+
*/
|
|
1695
|
+
order_by?: string | null;
|
|
1696
|
+
/**
|
|
1697
|
+
* Order Direction
|
|
1698
|
+
* asc or desc
|
|
1699
|
+
* @default "asc"
|
|
1700
|
+
*/
|
|
1701
|
+
order_direction?: string | null;
|
|
1702
|
+
/**
|
|
1703
|
+
* Eq Conditions
|
|
1704
|
+
* list of equality conditions, each as a dict with key and value
|
|
1705
|
+
*/
|
|
1706
|
+
eq_conditions?: Record<string, any> | null;
|
|
1707
|
+
/** advanced filter with nested conditions */
|
|
1708
|
+
advanced_filter?: IFilterGroup | null;
|
|
1709
|
+
/** 标签过滤条件 tag_name 和 tag_id */
|
|
1710
|
+
tag_filter?: ITagFilter | null;
|
|
1711
|
+
/**
|
|
1712
|
+
* Page
|
|
1713
|
+
* page number
|
|
1714
|
+
* @min 1
|
|
1715
|
+
* @default 1
|
|
1716
|
+
*/
|
|
1717
|
+
page?: number;
|
|
1718
|
+
/**
|
|
1719
|
+
* Page Size
|
|
1720
|
+
* page size
|
|
1721
|
+
* @min 1
|
|
1722
|
+
* @max 1000
|
|
1723
|
+
* @default 10
|
|
1724
|
+
*/
|
|
1725
|
+
page_size?: number;
|
|
1726
|
+
}
|
|
1727
|
+
/** PageQueryParams[Task] */
|
|
1728
|
+
export interface IPageQueryParamsTask {
|
|
1729
|
+
/**
|
|
1730
|
+
* Order By
|
|
1731
|
+
* order by field
|
|
1732
|
+
*/
|
|
1733
|
+
order_by?: string | null;
|
|
1734
|
+
/**
|
|
1735
|
+
* Order Direction
|
|
1736
|
+
* asc or desc
|
|
1737
|
+
* @default "asc"
|
|
1738
|
+
*/
|
|
1739
|
+
order_direction?: string | null;
|
|
1740
|
+
/**
|
|
1741
|
+
* Eq Conditions
|
|
1742
|
+
* list of equality conditions, each as a dict with key and value
|
|
1743
|
+
*/
|
|
1744
|
+
eq_conditions?: Record<string, any> | null;
|
|
1745
|
+
/** advanced filter with nested conditions */
|
|
1746
|
+
advanced_filter?: IFilterGroup | null;
|
|
1747
|
+
/** 标签过滤条件 tag_name 和 tag_id */
|
|
1748
|
+
tag_filter?: ITagFilter | null;
|
|
1749
|
+
/**
|
|
1750
|
+
* Page
|
|
1751
|
+
* page number
|
|
1752
|
+
* @min 1
|
|
1753
|
+
* @default 1
|
|
1754
|
+
*/
|
|
1755
|
+
page?: number;
|
|
1756
|
+
/**
|
|
1757
|
+
* Page Size
|
|
1758
|
+
* page size
|
|
1759
|
+
* @min 1
|
|
1760
|
+
* @max 1000
|
|
1761
|
+
* @default 10
|
|
1762
|
+
*/
|
|
1763
|
+
page_size?: number;
|
|
1764
|
+
}
|
|
1765
|
+
/** PageResponse[APIKey] */
|
|
1766
|
+
export interface IPageResponseAPIKey {
|
|
1767
|
+
/** Items */
|
|
1768
|
+
items: IAPIKey[];
|
|
1769
|
+
/** Total */
|
|
1770
|
+
total: number;
|
|
1771
|
+
/** Page */
|
|
1772
|
+
page: number;
|
|
1773
|
+
/** Page Size */
|
|
1774
|
+
page_size: number;
|
|
1775
|
+
/** Total Pages */
|
|
1776
|
+
total_pages: number;
|
|
1777
|
+
}
|
|
1778
|
+
/** PageResponse[ArtifactIndex] */
|
|
1779
|
+
export interface IPageResponseArtifactIndex {
|
|
1780
|
+
/** Items */
|
|
1781
|
+
items: IArtifactIndex[];
|
|
1782
|
+
/** Total */
|
|
1783
|
+
total: number;
|
|
1784
|
+
/** Page */
|
|
1785
|
+
page: number;
|
|
1786
|
+
/** Page Size */
|
|
1787
|
+
page_size: number;
|
|
1788
|
+
/** Total Pages */
|
|
1789
|
+
total_pages: number;
|
|
1790
|
+
}
|
|
1791
|
+
/** PageResponse[Chunk] */
|
|
1792
|
+
export interface IPageResponseChunk {
|
|
1793
|
+
/** Items */
|
|
1794
|
+
items: IChunk[];
|
|
1795
|
+
/** Total */
|
|
1796
|
+
total: number;
|
|
1797
|
+
/** Page */
|
|
1798
|
+
page: number;
|
|
1799
|
+
/** Page Size */
|
|
1800
|
+
page_size: number;
|
|
1801
|
+
/** Total Pages */
|
|
1802
|
+
total_pages: number;
|
|
1803
|
+
}
|
|
1804
|
+
/** PageResponse[Knowledge] */
|
|
1805
|
+
export interface IPageResponseKnowledge {
|
|
1806
|
+
/** Items */
|
|
1807
|
+
items: IKnowledgeOutput[];
|
|
1808
|
+
/** Total */
|
|
1809
|
+
total: number;
|
|
1810
|
+
/** Page */
|
|
1811
|
+
page: number;
|
|
1812
|
+
/** Page Size */
|
|
1813
|
+
page_size: number;
|
|
1814
|
+
/** Total Pages */
|
|
1815
|
+
total_pages: number;
|
|
1816
|
+
}
|
|
1817
|
+
/** PageResponse[SpaceResponse] */
|
|
1818
|
+
export interface IPageResponseSpaceResponse {
|
|
1819
|
+
/** Items */
|
|
1820
|
+
items: ISpaceResponse[];
|
|
1821
|
+
/** Total */
|
|
1822
|
+
total: number;
|
|
1823
|
+
/** Page */
|
|
1824
|
+
page: number;
|
|
1825
|
+
/** Page Size */
|
|
1826
|
+
page_size: number;
|
|
1827
|
+
/** Total Pages */
|
|
1828
|
+
total_pages: number;
|
|
1829
|
+
}
|
|
1830
|
+
/** PageResponse[Tag] */
|
|
1831
|
+
export interface IPageResponseTag {
|
|
1832
|
+
/** Items */
|
|
1833
|
+
items: ITag[];
|
|
1834
|
+
/** Total */
|
|
1835
|
+
total: number;
|
|
1836
|
+
/** Page */
|
|
1837
|
+
page: number;
|
|
1838
|
+
/** Page Size */
|
|
1839
|
+
page_size: number;
|
|
1840
|
+
/** Total Pages */
|
|
1841
|
+
total_pages: number;
|
|
1842
|
+
}
|
|
1843
|
+
/** PageResponse[Tagging] */
|
|
1844
|
+
export interface IPageResponseTagging {
|
|
1845
|
+
/** Items */
|
|
1846
|
+
items: ITagging[];
|
|
1847
|
+
/** Total */
|
|
1848
|
+
total: number;
|
|
1849
|
+
/** Page */
|
|
1850
|
+
page: number;
|
|
1851
|
+
/** Page Size */
|
|
1852
|
+
page_size: number;
|
|
1853
|
+
/** Total Pages */
|
|
1854
|
+
total_pages: number;
|
|
1855
|
+
}
|
|
1856
|
+
/** PageResponse[Tenant] */
|
|
1857
|
+
export interface IPageResponseTenant {
|
|
1858
|
+
/** Items */
|
|
1859
|
+
items: ITenant[];
|
|
1860
|
+
/** Total */
|
|
1861
|
+
total: number;
|
|
1862
|
+
/** Page */
|
|
1863
|
+
page: number;
|
|
1864
|
+
/** Page Size */
|
|
1865
|
+
page_size: number;
|
|
1866
|
+
/** Total Pages */
|
|
1867
|
+
total_pages: number;
|
|
1868
|
+
}
|
|
1869
|
+
/** Permission */
|
|
1870
|
+
export interface IPermission {
|
|
1871
|
+
resource: IResource;
|
|
1872
|
+
/** Actions */
|
|
1873
|
+
actions: IAction[];
|
|
1874
|
+
/** Conditions */
|
|
1875
|
+
conditions?: Record<string, any> | null;
|
|
1876
|
+
}
|
|
1877
|
+
/** ProResearchRequest */
|
|
1878
|
+
export interface IProResearchRequest {
|
|
1879
|
+
/**
|
|
1880
|
+
* Messages
|
|
1881
|
+
* The messages to be sent to the agent.
|
|
1882
|
+
* @default []
|
|
1883
|
+
*/
|
|
1884
|
+
messages?: (IChatCompletionDeveloperMessageParam | IChatCompletionSystemMessageParam | IChatCompletionUserMessageParam | IChatCompletionAssistantMessageParam | IChatCompletionToolMessageParam | IChatCompletionFunctionMessageParam)[];
|
|
1885
|
+
/**
|
|
1886
|
+
* Model
|
|
1887
|
+
* The name of the language model to use for the agent's query generation.
|
|
1888
|
+
* @default "wohu_qwen3_235b_a22b"
|
|
1889
|
+
*/
|
|
1890
|
+
model?: string;
|
|
1891
|
+
/**
|
|
1892
|
+
* Number Of Initial Queries
|
|
1893
|
+
* The number of initial search queries to generate.
|
|
1894
|
+
* @default 3
|
|
1895
|
+
*/
|
|
1896
|
+
number_of_initial_queries?: number;
|
|
1897
|
+
/**
|
|
1898
|
+
* Max Research Loops
|
|
1899
|
+
* The maximum number of research loops to perform.
|
|
1900
|
+
* @default 2
|
|
1901
|
+
*/
|
|
1902
|
+
max_research_loops?: number;
|
|
1903
|
+
/**
|
|
1904
|
+
* Enable Knowledge Retrieval
|
|
1905
|
+
* Whether to enable knowledge retrieval functionality.
|
|
1906
|
+
* @default true
|
|
1907
|
+
*/
|
|
1908
|
+
enable_knowledge_retrieval?: boolean;
|
|
1909
|
+
/**
|
|
1910
|
+
* Enable Web Search
|
|
1911
|
+
* Whether to enable web search functionality.
|
|
1912
|
+
* @default false
|
|
1913
|
+
*/
|
|
1914
|
+
enable_web_search?: boolean;
|
|
1915
|
+
/**
|
|
1916
|
+
* Knowledge Scope List
|
|
1917
|
+
* List of knowledge scopes to search within.
|
|
1918
|
+
* @default []
|
|
1919
|
+
*/
|
|
1920
|
+
knowledge_scope_list?: IKnowledgeScope[];
|
|
1921
|
+
/** Knowledge retrieval configuration. */
|
|
1922
|
+
knowledge_retrieval_config?: IRetrievalConfig | null;
|
|
1923
|
+
}
|
|
1924
|
+
/** QACreate */
|
|
1925
|
+
export interface IQACreate {
|
|
1926
|
+
/**
|
|
1927
|
+
* Space Id
|
|
1928
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
1929
|
+
*/
|
|
1930
|
+
space_id: string;
|
|
1931
|
+
/**
|
|
1932
|
+
* Knowledge Type
|
|
1933
|
+
* type of knowledge resource
|
|
1934
|
+
* @default "qa"
|
|
1935
|
+
*/
|
|
1936
|
+
knowledge_type?: "qa";
|
|
1937
|
+
/**
|
|
1938
|
+
* Knowledge Name
|
|
1939
|
+
* name of the knowledge resource
|
|
1940
|
+
* @maxLength 255
|
|
1941
|
+
*/
|
|
1942
|
+
knowledge_name: string;
|
|
1943
|
+
/**
|
|
1944
|
+
* Metadata
|
|
1945
|
+
* additional metadata, user can update it
|
|
1946
|
+
* @default {}
|
|
1947
|
+
*/
|
|
1948
|
+
metadata?: Record<string, any>;
|
|
1949
|
+
/**
|
|
1950
|
+
* Source Type
|
|
1951
|
+
* source type
|
|
1952
|
+
* @default "user_input_text"
|
|
1953
|
+
*/
|
|
1954
|
+
source_type?: "user_input_text";
|
|
1955
|
+
/**
|
|
1956
|
+
* Embedding Model Name
|
|
1957
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
1958
|
+
* @default "openai"
|
|
1959
|
+
*/
|
|
1960
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
1961
|
+
/**
|
|
1962
|
+
* File Sha
|
|
1963
|
+
* SHA of the file
|
|
1964
|
+
*/
|
|
1965
|
+
file_sha?: string | null;
|
|
1966
|
+
/**
|
|
1967
|
+
* File Size
|
|
1968
|
+
* size of the file
|
|
1969
|
+
*/
|
|
1970
|
+
file_size?: number | null;
|
|
1971
|
+
/**
|
|
1972
|
+
* Parent Id
|
|
1973
|
+
* parent id of the knowledge
|
|
1974
|
+
*/
|
|
1975
|
+
parent_id?: string | null;
|
|
1976
|
+
/**
|
|
1977
|
+
* Question
|
|
1978
|
+
* question of the knowledge resource
|
|
1979
|
+
*/
|
|
1980
|
+
question: string;
|
|
1981
|
+
/**
|
|
1982
|
+
* Answer
|
|
1983
|
+
* answer of the knowledge resource
|
|
1984
|
+
*/
|
|
1985
|
+
answer: string;
|
|
1986
|
+
/** split config of the knowledge, used to split the question into chunks */
|
|
1987
|
+
split_config: ITextSplitConfig;
|
|
1988
|
+
/** source config of the knowledge */
|
|
1989
|
+
source_config?: ITextSourceConfig | null;
|
|
1990
|
+
}
|
|
1991
|
+
/** ResponseModel */
|
|
1992
|
+
export interface IResponseModel {
|
|
1993
|
+
/** Success */
|
|
1994
|
+
success: boolean;
|
|
1995
|
+
/** Data */
|
|
1996
|
+
data?: null;
|
|
1997
|
+
/** Message */
|
|
1998
|
+
message?: string | null;
|
|
1999
|
+
}
|
|
2000
|
+
/** ResponseModel[APIKey] */
|
|
2001
|
+
export interface IResponseModelAPIKey {
|
|
2002
|
+
/** Success */
|
|
2003
|
+
success: boolean;
|
|
2004
|
+
data?: IAPIKey | null;
|
|
2005
|
+
/** Message */
|
|
2006
|
+
message?: string | null;
|
|
2007
|
+
}
|
|
2008
|
+
/** ResponseModel[ArtifactIndex] */
|
|
2009
|
+
export interface IResponseModelArtifactIndex {
|
|
2010
|
+
/** Success */
|
|
2011
|
+
success: boolean;
|
|
2012
|
+
data?: IArtifactIndex | null;
|
|
2013
|
+
/** Message */
|
|
2014
|
+
message?: string | null;
|
|
2015
|
+
}
|
|
2016
|
+
/** ResponseModel[Chunk] */
|
|
2017
|
+
export interface IResponseModelChunk {
|
|
2018
|
+
/** Success */
|
|
2019
|
+
success: boolean;
|
|
2020
|
+
data?: IChunk | null;
|
|
2021
|
+
/** Message */
|
|
2022
|
+
message?: string | null;
|
|
2023
|
+
}
|
|
2024
|
+
/** ResponseModel[GlobalInfo] */
|
|
2025
|
+
export interface IResponseModelGlobalInfo {
|
|
2026
|
+
/** Success */
|
|
2027
|
+
success: boolean;
|
|
2028
|
+
data?: IGlobalInfo | null;
|
|
2029
|
+
/** Message */
|
|
2030
|
+
message?: string | null;
|
|
2031
|
+
}
|
|
2032
|
+
/** ResponseModel[Knowledge] */
|
|
2033
|
+
export interface IResponseModelKnowledge {
|
|
2034
|
+
/** Success */
|
|
2035
|
+
success: boolean;
|
|
2036
|
+
data?: IKnowledgeOutput | null;
|
|
2037
|
+
/** Message */
|
|
2038
|
+
message?: string | null;
|
|
2039
|
+
}
|
|
2040
|
+
/** ResponseModel[List[APIKey]] */
|
|
2041
|
+
export interface IResponseModelListAPIKey {
|
|
2042
|
+
/** Success */
|
|
2043
|
+
success: boolean;
|
|
2044
|
+
/** Data */
|
|
2045
|
+
data?: IAPIKey[] | null;
|
|
2046
|
+
/** Message */
|
|
2047
|
+
message?: string | null;
|
|
2048
|
+
}
|
|
2049
|
+
/** ResponseModel[List[ArtifactIndex]] */
|
|
2050
|
+
export interface IResponseModelListArtifactIndex {
|
|
2051
|
+
/** Success */
|
|
2052
|
+
success: boolean;
|
|
2053
|
+
/** Data */
|
|
2054
|
+
data?: IArtifactIndex[] | null;
|
|
2055
|
+
/** Message */
|
|
2056
|
+
message?: string | null;
|
|
2057
|
+
}
|
|
2058
|
+
/** ResponseModel[List[Knowledge]] */
|
|
2059
|
+
export interface IResponseModelListKnowledge {
|
|
2060
|
+
/** Success */
|
|
2061
|
+
success: boolean;
|
|
2062
|
+
/** Data */
|
|
2063
|
+
data?: IKnowledgeOutput[] | null;
|
|
2064
|
+
/** Message */
|
|
2065
|
+
message?: string | null;
|
|
2066
|
+
}
|
|
2067
|
+
/** ResponseModel[List[RetrievalChunk]] */
|
|
2068
|
+
export interface IResponseModelListRetrievalChunk {
|
|
2069
|
+
/** Success */
|
|
2070
|
+
success: boolean;
|
|
2071
|
+
/** Data */
|
|
2072
|
+
data?: IRetrievalChunk[] | null;
|
|
2073
|
+
/** Message */
|
|
2074
|
+
message?: string | null;
|
|
2075
|
+
}
|
|
2076
|
+
/** ResponseModel[List[Tag]] */
|
|
2077
|
+
export interface IResponseModelListTag {
|
|
2078
|
+
/** Success */
|
|
2079
|
+
success: boolean;
|
|
2080
|
+
/** Data */
|
|
2081
|
+
data?: ITag[] | null;
|
|
2082
|
+
/** Message */
|
|
2083
|
+
message?: string | null;
|
|
2084
|
+
}
|
|
2085
|
+
/** ResponseModel[List[Tagging]] */
|
|
2086
|
+
export interface IResponseModelListTagging {
|
|
2087
|
+
/** Success */
|
|
2088
|
+
success: boolean;
|
|
2089
|
+
/** Data */
|
|
2090
|
+
data?: ITagging[] | null;
|
|
2091
|
+
/** Message */
|
|
2092
|
+
message?: string | null;
|
|
2093
|
+
}
|
|
2094
|
+
/** ResponseModel[List[Task]] */
|
|
2095
|
+
export interface IResponseModelListTask {
|
|
2096
|
+
/** Success */
|
|
2097
|
+
success: boolean;
|
|
2098
|
+
/** Data */
|
|
2099
|
+
data?: ITask[] | null;
|
|
2100
|
+
/** Message */
|
|
2101
|
+
message?: string | null;
|
|
2102
|
+
}
|
|
2103
|
+
/** ResponseModel[List[TenantLog]] */
|
|
2104
|
+
export interface IResponseModelListTenantLog {
|
|
2105
|
+
/** Success */
|
|
2106
|
+
success: boolean;
|
|
2107
|
+
/** Data */
|
|
2108
|
+
data?: ITenantLog[] | null;
|
|
2109
|
+
/** Message */
|
|
2110
|
+
message?: string | null;
|
|
2111
|
+
}
|
|
2112
|
+
/** ResponseModel[NoneType] */
|
|
2113
|
+
export interface IResponseModelNoneType {
|
|
2114
|
+
/** Success */
|
|
2115
|
+
success: boolean;
|
|
2116
|
+
/** Data */
|
|
2117
|
+
data?: null;
|
|
2118
|
+
/** Message */
|
|
2119
|
+
message?: string | null;
|
|
2120
|
+
}
|
|
2121
|
+
/** ResponseModel[PageResponse[APIKey]] */
|
|
2122
|
+
export interface IResponseModelPageResponseAPIKey {
|
|
2123
|
+
/** Success */
|
|
2124
|
+
success: boolean;
|
|
2125
|
+
data?: IPageResponseAPIKey | null;
|
|
2126
|
+
/** Message */
|
|
2127
|
+
message?: string | null;
|
|
2128
|
+
}
|
|
2129
|
+
/** ResponseModel[PageResponse[ArtifactIndex]] */
|
|
2130
|
+
export interface IResponseModelPageResponseArtifactIndex {
|
|
2131
|
+
/** Success */
|
|
2132
|
+
success: boolean;
|
|
2133
|
+
data?: IPageResponseArtifactIndex | null;
|
|
2134
|
+
/** Message */
|
|
2135
|
+
message?: string | null;
|
|
2136
|
+
}
|
|
2137
|
+
/** ResponseModel[PageResponse[Chunk]] */
|
|
2138
|
+
export interface IResponseModelPageResponseChunk {
|
|
2139
|
+
/** Success */
|
|
2140
|
+
success: boolean;
|
|
2141
|
+
data?: IPageResponseChunk | null;
|
|
2142
|
+
/** Message */
|
|
2143
|
+
message?: string | null;
|
|
2144
|
+
}
|
|
2145
|
+
/** ResponseModel[PageResponse[Knowledge]] */
|
|
2146
|
+
export interface IResponseModelPageResponseKnowledge {
|
|
2147
|
+
/** Success */
|
|
2148
|
+
success: boolean;
|
|
2149
|
+
data?: IPageResponseKnowledge | null;
|
|
2150
|
+
/** Message */
|
|
2151
|
+
message?: string | null;
|
|
2152
|
+
}
|
|
2153
|
+
/** ResponseModel[PageResponse[SpaceResponse]] */
|
|
2154
|
+
export interface IResponseModelPageResponseSpaceResponse {
|
|
2155
|
+
/** Success */
|
|
2156
|
+
success: boolean;
|
|
2157
|
+
data?: IPageResponseSpaceResponse | null;
|
|
2158
|
+
/** Message */
|
|
2159
|
+
message?: string | null;
|
|
2160
|
+
}
|
|
2161
|
+
/** ResponseModel[PageResponse[Tag]] */
|
|
2162
|
+
export interface IResponseModelPageResponseTag {
|
|
2163
|
+
/** Success */
|
|
2164
|
+
success: boolean;
|
|
2165
|
+
data?: IPageResponseTag | null;
|
|
2166
|
+
/** Message */
|
|
2167
|
+
message?: string | null;
|
|
2168
|
+
}
|
|
2169
|
+
/** ResponseModel[PageResponse[Tagging]] */
|
|
2170
|
+
export interface IResponseModelPageResponseTagging {
|
|
2171
|
+
/** Success */
|
|
2172
|
+
success: boolean;
|
|
2173
|
+
data?: IPageResponseTagging | null;
|
|
2174
|
+
/** Message */
|
|
2175
|
+
message?: string | null;
|
|
2176
|
+
}
|
|
2177
|
+
/** ResponseModel[PageResponse[Tenant]] */
|
|
2178
|
+
export interface IResponseModelPageResponseTenant {
|
|
2179
|
+
/** Success */
|
|
2180
|
+
success: boolean;
|
|
2181
|
+
data?: IPageResponseTenant | null;
|
|
2182
|
+
/** Message */
|
|
2183
|
+
message?: string | null;
|
|
2184
|
+
}
|
|
2185
|
+
/** ResponseModel[SpaceResponse] */
|
|
2186
|
+
export interface IResponseModelSpaceResponse {
|
|
2187
|
+
/** Success */
|
|
2188
|
+
success: boolean;
|
|
2189
|
+
data?: ISpaceResponse | null;
|
|
2190
|
+
/** Message */
|
|
2191
|
+
message?: string | null;
|
|
2192
|
+
}
|
|
2193
|
+
/** ResponseModel[StatusStatisticsPageResponse[Task]] */
|
|
2194
|
+
export interface IResponseModelStatusStatisticsPageResponseTask {
|
|
2195
|
+
/** Success */
|
|
2196
|
+
success: boolean;
|
|
2197
|
+
data?: IStatusStatisticsPageResponseTask | null;
|
|
2198
|
+
/** Message */
|
|
2199
|
+
message?: string | null;
|
|
2200
|
+
}
|
|
2201
|
+
/** ResponseModel[Tag] */
|
|
2202
|
+
export interface IResponseModelTag {
|
|
2203
|
+
/** Success */
|
|
2204
|
+
success: boolean;
|
|
2205
|
+
data?: ITag | null;
|
|
2206
|
+
/** Message */
|
|
2207
|
+
message?: string | null;
|
|
2208
|
+
}
|
|
2209
|
+
/** ResponseModel[Task] */
|
|
2210
|
+
export interface IResponseModelTask {
|
|
2211
|
+
/** Success */
|
|
2212
|
+
success: boolean;
|
|
2213
|
+
data?: ITask | null;
|
|
2214
|
+
/** Message */
|
|
2215
|
+
message?: string | null;
|
|
2216
|
+
}
|
|
2217
|
+
/** ResponseModel[Tenant] */
|
|
2218
|
+
export interface IResponseModelTenant {
|
|
2219
|
+
/** Success */
|
|
2220
|
+
success: boolean;
|
|
2221
|
+
data?: ITenant | null;
|
|
2222
|
+
/** Message */
|
|
2223
|
+
message?: string | null;
|
|
2224
|
+
}
|
|
2225
|
+
/** ResponseModel[object] */
|
|
2226
|
+
export interface IResponseModelObject {
|
|
2227
|
+
/** Success */
|
|
2228
|
+
success: boolean;
|
|
2229
|
+
/** Data */
|
|
2230
|
+
data?: null;
|
|
2231
|
+
/** Message */
|
|
2232
|
+
message?: string | null;
|
|
2233
|
+
}
|
|
2234
|
+
/** ResponseModel[str] */
|
|
2235
|
+
export interface IResponseModelStr {
|
|
2236
|
+
/** Success */
|
|
2237
|
+
success: boolean;
|
|
2238
|
+
/** Data */
|
|
2239
|
+
data?: string | null;
|
|
2240
|
+
/** Message */
|
|
2241
|
+
message?: string | null;
|
|
2242
|
+
}
|
|
2243
|
+
/** RetrievalByKnowledgeRequest */
|
|
2244
|
+
export interface IRetrievalByKnowledgeRequest {
|
|
2245
|
+
/**
|
|
2246
|
+
* Embedding Model Name
|
|
2247
|
+
* The name of the embedding model
|
|
2248
|
+
*/
|
|
2249
|
+
embedding_model_name: IEmbeddingModelEnum | string;
|
|
2250
|
+
/**
|
|
2251
|
+
* Similarity Threshold
|
|
2252
|
+
* The similarity threshold, ranging from 0.0 to 1.0.
|
|
2253
|
+
* @min 0
|
|
2254
|
+
* @max 1
|
|
2255
|
+
* @default 0.5
|
|
2256
|
+
*/
|
|
2257
|
+
similarity_threshold?: number;
|
|
2258
|
+
/**
|
|
2259
|
+
* Top
|
|
2260
|
+
* The maximum number of results to return.
|
|
2261
|
+
* @min 1
|
|
2262
|
+
* @default 1024
|
|
2263
|
+
*/
|
|
2264
|
+
top?: number;
|
|
2265
|
+
/**
|
|
2266
|
+
* Metadata Filter
|
|
2267
|
+
* metadata filter
|
|
2268
|
+
* @default {}
|
|
2269
|
+
*/
|
|
2270
|
+
metadata_filter?: Record<string, any>;
|
|
2271
|
+
/**
|
|
2272
|
+
* Question
|
|
2273
|
+
* The query question
|
|
2274
|
+
*/
|
|
2275
|
+
question: string;
|
|
2276
|
+
/**
|
|
2277
|
+
* Knowledge Id List
|
|
2278
|
+
* knowledge id list
|
|
2279
|
+
*/
|
|
2280
|
+
knowledge_id_list: string[];
|
|
2281
|
+
}
|
|
2282
|
+
/** RetrievalBySpaceRequest */
|
|
2283
|
+
export interface IRetrievalBySpaceRequest {
|
|
2284
|
+
/**
|
|
2285
|
+
* Embedding Model Name
|
|
2286
|
+
* The name of the embedding model
|
|
2287
|
+
*/
|
|
2288
|
+
embedding_model_name: IEmbeddingModelEnum | string;
|
|
2289
|
+
/**
|
|
2290
|
+
* Similarity Threshold
|
|
2291
|
+
* The similarity threshold, ranging from 0.0 to 1.0.
|
|
2292
|
+
* @min 0
|
|
2293
|
+
* @max 1
|
|
2294
|
+
* @default 0.5
|
|
2295
|
+
*/
|
|
2296
|
+
similarity_threshold?: number;
|
|
2297
|
+
/**
|
|
2298
|
+
* Top
|
|
2299
|
+
* The maximum number of results to return.
|
|
2300
|
+
* @min 1
|
|
2301
|
+
* @default 1024
|
|
2302
|
+
*/
|
|
2303
|
+
top?: number;
|
|
2304
|
+
/**
|
|
2305
|
+
* Metadata Filter
|
|
2306
|
+
* metadata filter
|
|
2307
|
+
* @default {}
|
|
2308
|
+
*/
|
|
2309
|
+
metadata_filter?: Record<string, any>;
|
|
2310
|
+
/**
|
|
2311
|
+
* Question
|
|
2312
|
+
* The query question
|
|
2313
|
+
*/
|
|
2314
|
+
question: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* Space Id List
|
|
2317
|
+
* space id list
|
|
2318
|
+
*/
|
|
2319
|
+
space_id_list: string[];
|
|
2320
|
+
}
|
|
2321
|
+
/** RetrievalChunk */
|
|
2322
|
+
export interface IRetrievalChunk {
|
|
2323
|
+
/**
|
|
2324
|
+
* Gmt Create
|
|
2325
|
+
* creation time
|
|
2326
|
+
*/
|
|
2327
|
+
gmt_create?: string;
|
|
2328
|
+
/**
|
|
2329
|
+
* Gmt Modified
|
|
2330
|
+
* update time
|
|
2331
|
+
*/
|
|
2332
|
+
gmt_modified?: string;
|
|
2333
|
+
/**
|
|
2334
|
+
* Chunk Id
|
|
2335
|
+
* chunk id
|
|
2336
|
+
*/
|
|
2337
|
+
chunk_id?: string;
|
|
2338
|
+
/**
|
|
2339
|
+
* Space Id
|
|
2340
|
+
* space id
|
|
2341
|
+
*/
|
|
2342
|
+
space_id: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* Tenant Id
|
|
2345
|
+
* tenant id
|
|
2346
|
+
*/
|
|
2347
|
+
tenant_id: string;
|
|
2348
|
+
/**
|
|
2349
|
+
* Embedding
|
|
2350
|
+
* chunk embedding
|
|
2351
|
+
*/
|
|
2352
|
+
embedding?: number[] | null;
|
|
2353
|
+
/**
|
|
2354
|
+
* Context
|
|
2355
|
+
* chunk content
|
|
2356
|
+
*/
|
|
2357
|
+
context: string;
|
|
2358
|
+
/**
|
|
2359
|
+
* Knowledge Id
|
|
2360
|
+
* file source info
|
|
2361
|
+
*/
|
|
2362
|
+
knowledge_id: string;
|
|
2363
|
+
/**
|
|
2364
|
+
* Enabled
|
|
2365
|
+
* is chunk enabled
|
|
2366
|
+
* @default true
|
|
2367
|
+
*/
|
|
2368
|
+
enabled?: boolean;
|
|
2369
|
+
/**
|
|
2370
|
+
* Embedding Model Name
|
|
2371
|
+
* name of the embedding model
|
|
2372
|
+
*/
|
|
2373
|
+
embedding_model_name?: string;
|
|
2374
|
+
/**
|
|
2375
|
+
* Metadata
|
|
2376
|
+
* Arbitrary metadata associated with the content.
|
|
2377
|
+
*/
|
|
2378
|
+
metadata?: Record<string, any> | null;
|
|
2379
|
+
/**
|
|
2380
|
+
* Tags
|
|
2381
|
+
* Tags from knowledge.metadata._tags
|
|
2382
|
+
*/
|
|
2383
|
+
tags?: string[] | null;
|
|
2384
|
+
/**
|
|
2385
|
+
* F1
|
|
2386
|
+
* Field 1 from knowledge.metadata._f1
|
|
2387
|
+
*/
|
|
2388
|
+
f1?: string | null;
|
|
2389
|
+
/**
|
|
2390
|
+
* F2
|
|
2391
|
+
* Field 2 from knowledge.metadata._f2
|
|
2392
|
+
*/
|
|
2393
|
+
f2?: string | null;
|
|
2394
|
+
/**
|
|
2395
|
+
* F3
|
|
2396
|
+
* Field 3 from knowledge.metadata._f3
|
|
2397
|
+
*/
|
|
2398
|
+
f3?: string | null;
|
|
2399
|
+
/**
|
|
2400
|
+
* F4
|
|
2401
|
+
* Field 4 from knowledge.metadata._f4
|
|
2402
|
+
*/
|
|
2403
|
+
f4?: string | null;
|
|
2404
|
+
/**
|
|
2405
|
+
* F5
|
|
2406
|
+
* Field 5 from knowledge.metadata._f5
|
|
2407
|
+
*/
|
|
2408
|
+
f5?: string | null;
|
|
2409
|
+
/**
|
|
2410
|
+
* Similarity
|
|
2411
|
+
* The similarity of the chunk, ranging from 0.0 to 1.0.
|
|
2412
|
+
*/
|
|
2413
|
+
similarity: number;
|
|
2414
|
+
}
|
|
2415
|
+
/** RetrievalConfig */
|
|
2416
|
+
export interface IRetrievalConfig {
|
|
2417
|
+
/**
|
|
2418
|
+
* Type
|
|
2419
|
+
* The retrieval type. Each retrieval type corresponds to a specific retriever.
|
|
2420
|
+
*/
|
|
2421
|
+
type: string;
|
|
2422
|
+
[key: string]: any;
|
|
2423
|
+
}
|
|
2424
|
+
/** RetrievalRequest */
|
|
2425
|
+
export interface IRetrievalRequest {
|
|
2426
|
+
/**
|
|
2427
|
+
* Content
|
|
2428
|
+
* The content to be searched, such as a question, text, or any other query string.
|
|
2429
|
+
*/
|
|
2430
|
+
content: string;
|
|
2431
|
+
/**
|
|
2432
|
+
* Image Url
|
|
2433
|
+
* image
|
|
2434
|
+
*/
|
|
2435
|
+
image_url?: string | null;
|
|
2436
|
+
/** The configuration for the retrieval request. Must inherit from RetrievalConfig and have a 'type' attribute. */
|
|
2437
|
+
config: IRetrievalConfig;
|
|
2438
|
+
}
|
|
2439
|
+
/** S3SourceConfig */
|
|
2440
|
+
export interface IS3SourceConfig {
|
|
2441
|
+
/**
|
|
2442
|
+
* Bucket
|
|
2443
|
+
* s3 bucket name
|
|
2444
|
+
*/
|
|
2445
|
+
bucket: string;
|
|
2446
|
+
/**
|
|
2447
|
+
* Key
|
|
2448
|
+
* s3 key
|
|
2449
|
+
*/
|
|
2450
|
+
key: string;
|
|
2451
|
+
/**
|
|
2452
|
+
* Version Id
|
|
2453
|
+
* s3 version id
|
|
2454
|
+
*/
|
|
2455
|
+
version_id?: string | null;
|
|
2456
|
+
/**
|
|
2457
|
+
* Region
|
|
2458
|
+
* s3 region
|
|
2459
|
+
*/
|
|
2460
|
+
region?: string | null;
|
|
2461
|
+
/**
|
|
2462
|
+
* Access Key
|
|
2463
|
+
* s3 access key
|
|
2464
|
+
*/
|
|
2465
|
+
access_key?: string | null;
|
|
2466
|
+
/**
|
|
2467
|
+
* Secret Key
|
|
2468
|
+
* s3 secret key
|
|
2469
|
+
*/
|
|
2470
|
+
secret_key?: string | null;
|
|
2471
|
+
/**
|
|
2472
|
+
* Auth Info
|
|
2473
|
+
* s3 session token
|
|
2474
|
+
*/
|
|
2475
|
+
auth_info?: string | null;
|
|
2476
|
+
}
|
|
2477
|
+
/**
|
|
2478
|
+
* SpaceCreate
|
|
2479
|
+
* SpaceCreate model for creating space resources.
|
|
2480
|
+
* Attributes:
|
|
2481
|
+
* space_name (str): Space name, example: petercat bot group.
|
|
2482
|
+
* description (str): descrition of the space resource.
|
|
2483
|
+
* metadata (Dict[str, Any]): metadata of the space resource.such as embedding model name
|
|
2484
|
+
* and other parameters.
|
|
2485
|
+
*/
|
|
2486
|
+
export interface ISpaceCreate {
|
|
2487
|
+
/**
|
|
2488
|
+
* Space Name
|
|
2489
|
+
* name of the space resource
|
|
2490
|
+
* @maxLength 64
|
|
2491
|
+
*/
|
|
2492
|
+
space_name: string;
|
|
2493
|
+
/**
|
|
2494
|
+
* Space Id
|
|
2495
|
+
* space id, e.g. petercat/bot-group
|
|
2496
|
+
*/
|
|
2497
|
+
space_id?: string | null;
|
|
2498
|
+
/**
|
|
2499
|
+
* Description
|
|
2500
|
+
* descrition of the space
|
|
2501
|
+
* @maxLength 255
|
|
2502
|
+
*/
|
|
2503
|
+
description: string;
|
|
2504
|
+
/**
|
|
2505
|
+
* Metadata
|
|
2506
|
+
* metadata of the space resource
|
|
2507
|
+
* @default {}
|
|
2508
|
+
*/
|
|
2509
|
+
metadata?: Record<string, any>;
|
|
2510
|
+
}
|
|
2511
|
+
/**
|
|
2512
|
+
* SpaceResponse
|
|
2513
|
+
* SpaceResponse model class that extends Space.
|
|
2514
|
+
* Attributes:
|
|
2515
|
+
* (str): Space ID.
|
|
2516
|
+
* total_size Optional[int]: size of the all kowledge in this space.
|
|
2517
|
+
* knowledge_size Optional[int]: count of the knowledge in this space.
|
|
2518
|
+
*/
|
|
2519
|
+
export interface ISpaceResponse {
|
|
2520
|
+
/**
|
|
2521
|
+
* Gmt Create
|
|
2522
|
+
* creation time
|
|
2523
|
+
*/
|
|
2524
|
+
gmt_create?: string;
|
|
2525
|
+
/**
|
|
2526
|
+
* Gmt Modified
|
|
2527
|
+
* update time
|
|
2528
|
+
*/
|
|
2529
|
+
gmt_modified?: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* Space Name
|
|
2532
|
+
* name of the space resource
|
|
2533
|
+
* @maxLength 64
|
|
2534
|
+
*/
|
|
2535
|
+
space_name: string;
|
|
2536
|
+
/**
|
|
2537
|
+
* Space Id
|
|
2538
|
+
* space id
|
|
2539
|
+
*/
|
|
2540
|
+
space_id?: string;
|
|
2541
|
+
/**
|
|
2542
|
+
* Description
|
|
2543
|
+
* descrition of the space
|
|
2544
|
+
* @maxLength 255
|
|
2545
|
+
*/
|
|
2546
|
+
description: string;
|
|
2547
|
+
/**
|
|
2548
|
+
* Metadata
|
|
2549
|
+
* metadata of the space resource
|
|
2550
|
+
* @default {}
|
|
2551
|
+
*/
|
|
2552
|
+
metadata?: Record<string, any>;
|
|
2553
|
+
/**
|
|
2554
|
+
* Tenant Id
|
|
2555
|
+
* tenant id
|
|
2556
|
+
*/
|
|
2557
|
+
tenant_id: string;
|
|
2558
|
+
/**
|
|
2559
|
+
* Storage Size
|
|
2560
|
+
* size of the all kowledge in this space
|
|
2561
|
+
* @default 0
|
|
2562
|
+
*/
|
|
2563
|
+
storage_size?: number | null;
|
|
2564
|
+
/**
|
|
2565
|
+
* Knowledge Count
|
|
2566
|
+
* count of the knowledge in this space
|
|
2567
|
+
* @default 0
|
|
2568
|
+
*/
|
|
2569
|
+
knowledge_count?: number | null;
|
|
2570
|
+
}
|
|
2571
|
+
/** StatusStatisticsPageResponse[Task] */
|
|
2572
|
+
export interface IStatusStatisticsPageResponseTask {
|
|
2573
|
+
/** Items */
|
|
2574
|
+
items: ITask[];
|
|
2575
|
+
/** Total */
|
|
2576
|
+
total: number;
|
|
2577
|
+
/** Page */
|
|
2578
|
+
page: number;
|
|
2579
|
+
/** Page Size */
|
|
2580
|
+
page_size: number;
|
|
2581
|
+
/** Total Pages */
|
|
2582
|
+
total_pages: number;
|
|
2583
|
+
/**
|
|
2584
|
+
* Success
|
|
2585
|
+
* @default 0
|
|
2586
|
+
*/
|
|
2587
|
+
success?: number;
|
|
2588
|
+
/**
|
|
2589
|
+
* Failed
|
|
2590
|
+
* @default 0
|
|
2591
|
+
*/
|
|
2592
|
+
failed?: number;
|
|
2593
|
+
/**
|
|
2594
|
+
* Cancelled
|
|
2595
|
+
* @default 0
|
|
2596
|
+
*/
|
|
2597
|
+
cancelled?: number;
|
|
2598
|
+
/**
|
|
2599
|
+
* Pending
|
|
2600
|
+
* @default 0
|
|
2601
|
+
*/
|
|
2602
|
+
pending?: number;
|
|
2603
|
+
/**
|
|
2604
|
+
* Running
|
|
2605
|
+
* @default 0
|
|
2606
|
+
*/
|
|
2607
|
+
running?: number;
|
|
2608
|
+
/**
|
|
2609
|
+
* Pending Retry
|
|
2610
|
+
* @default 0
|
|
2611
|
+
*/
|
|
2612
|
+
pending_retry?: number;
|
|
2613
|
+
/**
|
|
2614
|
+
* Deleted
|
|
2615
|
+
* @default 0
|
|
2616
|
+
*/
|
|
2617
|
+
deleted?: number;
|
|
2618
|
+
}
|
|
2619
|
+
/** Tag */
|
|
2620
|
+
export interface ITag {
|
|
2621
|
+
/**
|
|
2622
|
+
* Gmt Create
|
|
2623
|
+
* creation time
|
|
2624
|
+
*/
|
|
2625
|
+
gmt_create?: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* Gmt Modified
|
|
2628
|
+
* update time
|
|
2629
|
+
*/
|
|
2630
|
+
gmt_modified?: string;
|
|
2631
|
+
/**
|
|
2632
|
+
* Name
|
|
2633
|
+
* 标签名称(租户内唯一)
|
|
2634
|
+
* @maxLength 64
|
|
2635
|
+
*/
|
|
2636
|
+
name: string;
|
|
2637
|
+
/**
|
|
2638
|
+
* Description
|
|
2639
|
+
* 标签描述
|
|
2640
|
+
*/
|
|
2641
|
+
description?: string | null;
|
|
2642
|
+
/**
|
|
2643
|
+
* 标签作用对象类型(如 "space")
|
|
2644
|
+
* @default "space"
|
|
2645
|
+
*/
|
|
2646
|
+
object_type?: ITagObjectType;
|
|
2647
|
+
/**
|
|
2648
|
+
* Tag Id
|
|
2649
|
+
* 标签ID(UUID字符串)
|
|
2650
|
+
*/
|
|
2651
|
+
tag_id?: string;
|
|
2652
|
+
/**
|
|
2653
|
+
* Tenant Id
|
|
2654
|
+
* 所属租户ID
|
|
2655
|
+
* @maxLength 64
|
|
2656
|
+
*/
|
|
2657
|
+
tenant_id: string;
|
|
2658
|
+
}
|
|
2659
|
+
/** TagCreate */
|
|
2660
|
+
export interface ITagCreate {
|
|
2661
|
+
/**
|
|
2662
|
+
* Name
|
|
2663
|
+
* 标签名称(租户内唯一)
|
|
2664
|
+
* @maxLength 64
|
|
2665
|
+
*/
|
|
2666
|
+
name: string;
|
|
2667
|
+
/**
|
|
2668
|
+
* Description
|
|
2669
|
+
* 标签描述
|
|
2670
|
+
*/
|
|
2671
|
+
description?: string | null;
|
|
2672
|
+
/**
|
|
2673
|
+
* 标签作用对象类型(如 "space")
|
|
2674
|
+
* @default "space"
|
|
2675
|
+
*/
|
|
2676
|
+
object_type?: ITagObjectType;
|
|
2677
|
+
}
|
|
2678
|
+
/**
|
|
2679
|
+
* TagFilter
|
|
2680
|
+
* 针对 Tagging 表的过滤条件(只允许使用 tag_name / tag_id 作为字段)
|
|
2681
|
+
*/
|
|
2682
|
+
export interface ITagFilter {
|
|
2683
|
+
operator: IOperator;
|
|
2684
|
+
/** Conditions */
|
|
2685
|
+
conditions: (ICondition | IFilterGroup)[];
|
|
2686
|
+
}
|
|
2687
|
+
/** TagUpdate */
|
|
2688
|
+
export interface ITagUpdate {
|
|
2689
|
+
/** Tag Id */
|
|
2690
|
+
tag_id: string;
|
|
2691
|
+
/** Name */
|
|
2692
|
+
name?: string | null;
|
|
2693
|
+
/** Description */
|
|
2694
|
+
description?: string | null;
|
|
2695
|
+
}
|
|
2696
|
+
/** Tagging */
|
|
2697
|
+
export interface ITagging {
|
|
2698
|
+
/**
|
|
2699
|
+
* Gmt Create
|
|
2700
|
+
* creation time
|
|
2701
|
+
*/
|
|
2702
|
+
gmt_create?: string;
|
|
2703
|
+
/**
|
|
2704
|
+
* Gmt Modified
|
|
2705
|
+
* update time
|
|
2706
|
+
*/
|
|
2707
|
+
gmt_modified?: string;
|
|
2708
|
+
/**
|
|
2709
|
+
* Tagging Id
|
|
2710
|
+
* 标签绑定ID(UUID字符串)
|
|
2711
|
+
*/
|
|
2712
|
+
tagging_id?: string;
|
|
2713
|
+
/**
|
|
2714
|
+
* Tenant Id
|
|
2715
|
+
* 所属租户ID
|
|
2716
|
+
* @maxLength 64
|
|
2717
|
+
*/
|
|
2718
|
+
tenant_id: string;
|
|
2719
|
+
/**
|
|
2720
|
+
* Tag Id
|
|
2721
|
+
* 标签ID(FK -> tag.tag_id,UUID字符串)
|
|
2722
|
+
*/
|
|
2723
|
+
tag_id: string;
|
|
2724
|
+
/**
|
|
2725
|
+
* Tag Name
|
|
2726
|
+
* 标签名称(在 object_type 内唯一)
|
|
2727
|
+
* @maxLength 64
|
|
2728
|
+
*/
|
|
2729
|
+
tag_name: string;
|
|
2730
|
+
/**
|
|
2731
|
+
* Object Id
|
|
2732
|
+
* 被打标签对象ID(如 space_id)
|
|
2733
|
+
* @maxLength 255
|
|
2734
|
+
*/
|
|
2735
|
+
object_id: string;
|
|
2736
|
+
/**
|
|
2737
|
+
* 对象类型,当前仅支持 "space"
|
|
2738
|
+
* @maxLength 32
|
|
2739
|
+
* @default "space"
|
|
2740
|
+
*/
|
|
2741
|
+
object_type?: ITagObjectType;
|
|
2742
|
+
}
|
|
2743
|
+
/** TaggingCreate */
|
|
2744
|
+
export interface ITaggingCreate {
|
|
2745
|
+
/**
|
|
2746
|
+
* Tag Name
|
|
2747
|
+
* 标签名称(在 object_type 内唯一)
|
|
2748
|
+
* @maxLength 64
|
|
2749
|
+
*/
|
|
2750
|
+
tag_name: string;
|
|
2751
|
+
/**
|
|
2752
|
+
* 对象类型,当前仅支持 "space"
|
|
2753
|
+
* @default "space"
|
|
2754
|
+
*/
|
|
2755
|
+
object_type?: ITagObjectType;
|
|
2756
|
+
/**
|
|
2757
|
+
* Object Id
|
|
2758
|
+
* 被打标签对象ID(如 space_id)
|
|
2759
|
+
* @maxLength 255
|
|
2760
|
+
*/
|
|
2761
|
+
object_id: string;
|
|
2762
|
+
}
|
|
2763
|
+
/** Task */
|
|
2764
|
+
export interface ITask {
|
|
2765
|
+
/**
|
|
2766
|
+
* Gmt Create
|
|
2767
|
+
* creation time
|
|
2768
|
+
*/
|
|
2769
|
+
gmt_create?: string;
|
|
2770
|
+
/**
|
|
2771
|
+
* Gmt Modified
|
|
2772
|
+
* update time
|
|
2773
|
+
*/
|
|
2774
|
+
gmt_modified?: string;
|
|
2775
|
+
/**
|
|
2776
|
+
* Task Id
|
|
2777
|
+
* Unique identifier for the task
|
|
2778
|
+
*/
|
|
2779
|
+
task_id?: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* Current status of the task
|
|
2782
|
+
* @default "pending"
|
|
2783
|
+
*/
|
|
2784
|
+
status?: ITaskStatus;
|
|
2785
|
+
/**
|
|
2786
|
+
* Knowledge Id
|
|
2787
|
+
* Identifier for the source file
|
|
2788
|
+
*/
|
|
2789
|
+
knowledge_id: string;
|
|
2790
|
+
/**
|
|
2791
|
+
* Metadata
|
|
2792
|
+
* Metadata for the task
|
|
2793
|
+
*/
|
|
2794
|
+
metadata?: Record<string, any> | null;
|
|
2795
|
+
/**
|
|
2796
|
+
* Error Message
|
|
2797
|
+
* Error message (only present if the task failed)
|
|
2798
|
+
*/
|
|
2799
|
+
error_message?: string | null;
|
|
2800
|
+
/**
|
|
2801
|
+
* Space Id
|
|
2802
|
+
* Identifier for the space
|
|
2803
|
+
*/
|
|
2804
|
+
space_id: string;
|
|
2805
|
+
/**
|
|
2806
|
+
* User Id
|
|
2807
|
+
* Identifier for the user
|
|
2808
|
+
*/
|
|
2809
|
+
user_id?: string | null;
|
|
2810
|
+
/**
|
|
2811
|
+
* Tenant Id
|
|
2812
|
+
* Identifier for the tenant
|
|
2813
|
+
*/
|
|
2814
|
+
tenant_id: string;
|
|
2815
|
+
/**
|
|
2816
|
+
* Task Type
|
|
2817
|
+
* Type of the task
|
|
2818
|
+
* @default "knowledge_chunk"
|
|
2819
|
+
*/
|
|
2820
|
+
task_type?: string;
|
|
2821
|
+
}
|
|
2822
|
+
/** TaskRestartRequest */
|
|
2823
|
+
export interface ITaskRestartRequest {
|
|
2824
|
+
/**
|
|
2825
|
+
* Task Id List
|
|
2826
|
+
* List of task IDs to restart
|
|
2827
|
+
*/
|
|
2828
|
+
task_id_list: string[];
|
|
2829
|
+
}
|
|
2830
|
+
/** Tenant */
|
|
2831
|
+
export interface ITenant {
|
|
2832
|
+
/**
|
|
2833
|
+
* Gmt Create
|
|
2834
|
+
* creation time
|
|
2835
|
+
*/
|
|
2836
|
+
gmt_create?: string;
|
|
2837
|
+
/**
|
|
2838
|
+
* Gmt Modified
|
|
2839
|
+
* update time
|
|
2840
|
+
*/
|
|
2841
|
+
gmt_modified?: string;
|
|
2842
|
+
/**
|
|
2843
|
+
* Tenant Id
|
|
2844
|
+
* tenant id
|
|
2845
|
+
*/
|
|
2846
|
+
tenant_id?: string;
|
|
2847
|
+
/**
|
|
2848
|
+
* Tenant Name
|
|
2849
|
+
* tenant name
|
|
2850
|
+
* @default ""
|
|
2851
|
+
*/
|
|
2852
|
+
tenant_name?: string;
|
|
2853
|
+
/**
|
|
2854
|
+
* Email
|
|
2855
|
+
* email
|
|
2856
|
+
*/
|
|
2857
|
+
email: string;
|
|
2858
|
+
/**
|
|
2859
|
+
* Secret Key
|
|
2860
|
+
* secret_key
|
|
2861
|
+
* @default ""
|
|
2862
|
+
*/
|
|
2863
|
+
secret_key?: string;
|
|
2864
|
+
/**
|
|
2865
|
+
* Is Active
|
|
2866
|
+
* is active
|
|
2867
|
+
* @default true
|
|
2868
|
+
*/
|
|
2869
|
+
is_active?: boolean;
|
|
2870
|
+
/**
|
|
2871
|
+
* Metadata
|
|
2872
|
+
* Metadata for the tenant
|
|
2873
|
+
*/
|
|
2874
|
+
metadata?: Record<string, any> | null;
|
|
2875
|
+
}
|
|
2876
|
+
/** TenantCreate */
|
|
2877
|
+
export interface ITenantCreate {
|
|
2878
|
+
/** Tenant Name */
|
|
2879
|
+
tenant_name: string;
|
|
2880
|
+
/** Email */
|
|
2881
|
+
email: string;
|
|
2882
|
+
/** Metadata */
|
|
2883
|
+
metadata?: Record<string, any> | null;
|
|
2884
|
+
}
|
|
2885
|
+
/** TenantLog */
|
|
2886
|
+
export interface ITenantLog {
|
|
2887
|
+
/** Content */
|
|
2888
|
+
content: string;
|
|
2889
|
+
}
|
|
2890
|
+
/** TenantLogQuery */
|
|
2891
|
+
export interface ITenantLogQuery {
|
|
2892
|
+
/** Page */
|
|
2893
|
+
page: number;
|
|
2894
|
+
/** Page Size */
|
|
2895
|
+
page_size: number;
|
|
2896
|
+
/** Start Time */
|
|
2897
|
+
start_time?: string | null;
|
|
2898
|
+
/** End Time */
|
|
2899
|
+
end_time?: string | null;
|
|
2900
|
+
}
|
|
2901
|
+
/** TenantUpdate */
|
|
2902
|
+
export interface ITenantUpdate {
|
|
2903
|
+
/** Tenant Id */
|
|
2904
|
+
tenant_id: string;
|
|
2905
|
+
/** Tenant Name */
|
|
2906
|
+
tenant_name?: string | null;
|
|
2907
|
+
/** Email */
|
|
2908
|
+
email?: string | null;
|
|
2909
|
+
/** Metadata */
|
|
2910
|
+
metadata?: Record<string, any> | null;
|
|
2911
|
+
}
|
|
2912
|
+
/** TextCreate */
|
|
2913
|
+
export interface ITextCreate {
|
|
2914
|
+
/**
|
|
2915
|
+
* Space Id
|
|
2916
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
2917
|
+
*/
|
|
2918
|
+
space_id: string;
|
|
2919
|
+
/**
|
|
2920
|
+
* Knowledge Type
|
|
2921
|
+
* type of knowledge resource
|
|
2922
|
+
* @default "text"
|
|
2923
|
+
*/
|
|
2924
|
+
knowledge_type?: "text";
|
|
2925
|
+
/**
|
|
2926
|
+
* Knowledge Name
|
|
2927
|
+
* name of the knowledge resource
|
|
2928
|
+
* @maxLength 255
|
|
2929
|
+
*/
|
|
2930
|
+
knowledge_name: string;
|
|
2931
|
+
/**
|
|
2932
|
+
* Metadata
|
|
2933
|
+
* additional metadata, user can update it
|
|
2934
|
+
* @default {}
|
|
2935
|
+
*/
|
|
2936
|
+
metadata?: Record<string, any>;
|
|
2937
|
+
/** source type */
|
|
2938
|
+
source_type: IKnowledgeSourceEnum;
|
|
2939
|
+
/**
|
|
2940
|
+
* Embedding Model Name
|
|
2941
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
2942
|
+
* @default "openai"
|
|
2943
|
+
*/
|
|
2944
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
2945
|
+
/**
|
|
2946
|
+
* File Sha
|
|
2947
|
+
* SHA of the file
|
|
2948
|
+
*/
|
|
2949
|
+
file_sha?: string | null;
|
|
2950
|
+
/**
|
|
2951
|
+
* File Size
|
|
2952
|
+
* size of the file
|
|
2953
|
+
*/
|
|
2954
|
+
file_size?: number | null;
|
|
2955
|
+
/**
|
|
2956
|
+
* Parent Id
|
|
2957
|
+
* parent id of the knowledge
|
|
2958
|
+
*/
|
|
2959
|
+
parent_id?: string | null;
|
|
2960
|
+
/**
|
|
2961
|
+
* Source Config
|
|
2962
|
+
* source config of the knowledge
|
|
2963
|
+
*/
|
|
2964
|
+
source_config: ITextSourceConfig | IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
|
|
2965
|
+
/** split config of the knowledge */
|
|
2966
|
+
split_config: ITextSplitConfig;
|
|
2967
|
+
}
|
|
2968
|
+
/** TextSourceConfig */
|
|
2969
|
+
export interface ITextSourceConfig {
|
|
2970
|
+
/**
|
|
2971
|
+
* Text
|
|
2972
|
+
* Text content, length range 1-30000 characters
|
|
2973
|
+
* @minLength 1
|
|
2974
|
+
* @maxLength 30000
|
|
2975
|
+
* @default ""
|
|
2976
|
+
*/
|
|
2977
|
+
text?: string;
|
|
2978
|
+
}
|
|
2979
|
+
/**
|
|
2980
|
+
* TextSplitConfig
|
|
2981
|
+
* Plain text split configuration
|
|
2982
|
+
*/
|
|
2983
|
+
export interface ITextSplitConfig {
|
|
2984
|
+
/**
|
|
2985
|
+
* Chunk Size
|
|
2986
|
+
* chunk max size
|
|
2987
|
+
* @min 1
|
|
2988
|
+
* @default 1500
|
|
2989
|
+
*/
|
|
2990
|
+
chunk_size?: number;
|
|
2991
|
+
/**
|
|
2992
|
+
* Chunk Overlap
|
|
2993
|
+
* chunk overlap size, must be less than chunk_size
|
|
2994
|
+
* @min 0
|
|
2995
|
+
* @default 150
|
|
2996
|
+
*/
|
|
2997
|
+
chunk_overlap?: number;
|
|
2998
|
+
/**
|
|
2999
|
+
* Separators
|
|
3000
|
+
* List of separators to split the text. If None, uses default separators
|
|
3001
|
+
*/
|
|
3002
|
+
separators: string[];
|
|
3003
|
+
/**
|
|
3004
|
+
* Split Regex
|
|
3005
|
+
* split_regex,if set, use it instead of separators
|
|
3006
|
+
*/
|
|
3007
|
+
split_regex?: string | null;
|
|
3008
|
+
/**
|
|
3009
|
+
* Type
|
|
3010
|
+
* @default "text"
|
|
3011
|
+
*/
|
|
3012
|
+
type?: "text";
|
|
3013
|
+
/**
|
|
3014
|
+
* Is Separator Regex
|
|
3015
|
+
* If true, the separators should be in regular expression format.
|
|
3016
|
+
*/
|
|
3017
|
+
is_separator_regex: boolean;
|
|
3018
|
+
/**
|
|
3019
|
+
* Keep Separator
|
|
3020
|
+
* Whether to keep the separator and where to place it in each corresponding chunk (True='start')
|
|
3021
|
+
* @default false
|
|
3022
|
+
*/
|
|
3023
|
+
keep_separator?: boolean | "start" | "end" | null;
|
|
3024
|
+
}
|
|
3025
|
+
/** ValidationError */
|
|
3026
|
+
export interface IValidationError {
|
|
3027
|
+
/** Location */
|
|
3028
|
+
loc: (string | number)[];
|
|
3029
|
+
/** Message */
|
|
3030
|
+
msg: string;
|
|
3031
|
+
/** Error Type */
|
|
3032
|
+
type: string;
|
|
3033
|
+
}
|
|
3034
|
+
/** YuqueCreate */
|
|
3035
|
+
export interface IYuqueCreate {
|
|
3036
|
+
/**
|
|
3037
|
+
* Space Id
|
|
3038
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
3039
|
+
*/
|
|
3040
|
+
space_id: string;
|
|
3041
|
+
/**
|
|
3042
|
+
* Knowledge Type
|
|
3043
|
+
* type of knowledge resource
|
|
3044
|
+
* @default "yuquedoc"
|
|
3045
|
+
*/
|
|
3046
|
+
knowledge_type?: "yuquedoc" | "github_repo";
|
|
3047
|
+
/**
|
|
3048
|
+
* Knowledge Name
|
|
3049
|
+
* name of the knowledge resource
|
|
3050
|
+
* @maxLength 255
|
|
3051
|
+
*/
|
|
3052
|
+
knowledge_name: string;
|
|
3053
|
+
/**
|
|
3054
|
+
* Metadata
|
|
3055
|
+
* additional metadata, user can update it
|
|
3056
|
+
* @default {}
|
|
3057
|
+
*/
|
|
3058
|
+
metadata?: Record<string, any>;
|
|
3059
|
+
/**
|
|
3060
|
+
* Source Type
|
|
3061
|
+
* source type
|
|
3062
|
+
* @default "yuque"
|
|
3063
|
+
*/
|
|
3064
|
+
source_type?: "yuque";
|
|
3065
|
+
/**
|
|
3066
|
+
* Embedding Model Name
|
|
3067
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
3068
|
+
* @default "openai"
|
|
3069
|
+
*/
|
|
3070
|
+
embedding_model_name?: IEmbeddingModelEnum | string;
|
|
3071
|
+
/**
|
|
3072
|
+
* File Sha
|
|
3073
|
+
* SHA of the file
|
|
3074
|
+
*/
|
|
3075
|
+
file_sha?: string | null;
|
|
3076
|
+
/**
|
|
3077
|
+
* File Size
|
|
3078
|
+
* size of the file
|
|
3079
|
+
*/
|
|
3080
|
+
file_size?: number | null;
|
|
3081
|
+
/**
|
|
3082
|
+
* Parent Id
|
|
3083
|
+
* parent id of the knowledge
|
|
3084
|
+
*/
|
|
3085
|
+
parent_id?: string | null;
|
|
3086
|
+
/**
|
|
3087
|
+
* Source Config
|
|
3088
|
+
* source config of the knowledge
|
|
3089
|
+
*/
|
|
3090
|
+
source_config: IYuqueSourceConfig | IOpenUrlSourceConfig | IOpenIdSourceConfig;
|
|
3091
|
+
/**
|
|
3092
|
+
* Split Config
|
|
3093
|
+
* split config of the knowledge
|
|
3094
|
+
*/
|
|
3095
|
+
split_config: IGeaGraphSplitConfig | IYuqueSplitConfig;
|
|
3096
|
+
}
|
|
3097
|
+
/** YuqueSourceConfig */
|
|
3098
|
+
export interface IYuqueSourceConfig {
|
|
3099
|
+
/**
|
|
3100
|
+
* Api Url
|
|
3101
|
+
* the yuque api url
|
|
3102
|
+
* @default "https://www.yuque.com"
|
|
3103
|
+
*/
|
|
3104
|
+
api_url?: string;
|
|
3105
|
+
/**
|
|
3106
|
+
* Group Login
|
|
3107
|
+
* the yuque group id
|
|
3108
|
+
*/
|
|
3109
|
+
group_login: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* Book Slug
|
|
3112
|
+
* the yuque book id, if not set, will use the group all book
|
|
3113
|
+
*/
|
|
3114
|
+
book_slug?: string | null;
|
|
3115
|
+
/**
|
|
3116
|
+
* Document Id
|
|
3117
|
+
* the yuque document id in book, if not set, will use the book all doc
|
|
3118
|
+
*/
|
|
3119
|
+
document_id?: string | number | null;
|
|
3120
|
+
/**
|
|
3121
|
+
* Auth Info
|
|
3122
|
+
* authentication information
|
|
3123
|
+
*/
|
|
3124
|
+
auth_info: string;
|
|
3125
|
+
}
|
|
3126
|
+
/** YuqueSplitConfig */
|
|
3127
|
+
export interface IYuqueSplitConfig {
|
|
3128
|
+
/**
|
|
3129
|
+
* Chunk Size
|
|
3130
|
+
* chunk max size
|
|
3131
|
+
* @min 1
|
|
3132
|
+
* @default 1500
|
|
3133
|
+
*/
|
|
3134
|
+
chunk_size?: number;
|
|
3135
|
+
/**
|
|
3136
|
+
* Chunk Overlap
|
|
3137
|
+
* chunk overlap size, must be less than chunk_size
|
|
3138
|
+
* @min 0
|
|
3139
|
+
* @default 150
|
|
3140
|
+
*/
|
|
3141
|
+
chunk_overlap?: number;
|
|
3142
|
+
/**
|
|
3143
|
+
* Type
|
|
3144
|
+
* @default "yuquedoc"
|
|
3145
|
+
*/
|
|
3146
|
+
type?: "yuquedoc";
|
|
3147
|
+
/**
|
|
3148
|
+
* Separators
|
|
3149
|
+
* List of separators to split the text. If None, uses default separators
|
|
3150
|
+
*/
|
|
3151
|
+
separators: string[];
|
|
3152
|
+
/**
|
|
3153
|
+
* Is Separator Regex
|
|
3154
|
+
* If true, the separators should be in regular expression format.
|
|
3155
|
+
*/
|
|
3156
|
+
is_separator_regex: boolean;
|
|
3157
|
+
}
|
|
3158
|
+
export type QueryParamsType = Record<string | number, any>;
|
|
3159
|
+
export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
|
|
3160
|
+
export interface FullRequestParams extends Omit<RequestInit, "body"> {
|
|
3161
|
+
/** set parameter to `true` for call `securityWorker` for this request */
|
|
3162
|
+
secure?: boolean;
|
|
3163
|
+
/** request path */
|
|
3164
|
+
path: string;
|
|
3165
|
+
/** content type of request body */
|
|
3166
|
+
type?: ContentType;
|
|
3167
|
+
/** query params */
|
|
3168
|
+
query?: QueryParamsType;
|
|
3169
|
+
/** format of response (i.e. response.json() -> format: "json") */
|
|
3170
|
+
format?: ResponseFormat;
|
|
3171
|
+
/** request body */
|
|
3172
|
+
body?: unknown;
|
|
3173
|
+
/** base url */
|
|
3174
|
+
baseUrl?: string;
|
|
3175
|
+
/** request cancellation token */
|
|
3176
|
+
cancelToken?: CancelToken;
|
|
3177
|
+
}
|
|
3178
|
+
export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
|
|
3179
|
+
export interface ApiConfig<SecurityDataType = unknown> {
|
|
3180
|
+
baseUrl?: string;
|
|
3181
|
+
baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
|
|
3182
|
+
securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
|
|
3183
|
+
customFetch?: typeof fetch;
|
|
3184
|
+
}
|
|
3185
|
+
export interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
|
|
3186
|
+
data: D;
|
|
3187
|
+
error: E;
|
|
3188
|
+
}
|
|
3189
|
+
type CancelToken = Symbol | string | number;
|
|
3190
|
+
export declare enum ContentType {
|
|
3191
|
+
Json = "application/json",
|
|
3192
|
+
JsonApi = "application/vnd.api+json",
|
|
3193
|
+
FormData = "multipart/form-data",
|
|
3194
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
3195
|
+
Text = "text/plain"
|
|
3196
|
+
}
|
|
3197
|
+
export declare class HttpClient<SecurityDataType = unknown> {
|
|
3198
|
+
baseUrl: string;
|
|
3199
|
+
private securityData;
|
|
3200
|
+
private securityWorker?;
|
|
3201
|
+
private abortControllers;
|
|
3202
|
+
private customFetch;
|
|
3203
|
+
private baseApiParams;
|
|
3204
|
+
constructor(apiConfig?: ApiConfig<SecurityDataType>);
|
|
3205
|
+
setSecurityData: (data: SecurityDataType | null) => void;
|
|
3206
|
+
protected encodeQueryParam(key: string, value: any): string;
|
|
3207
|
+
protected addQueryParam(query: QueryParamsType, key: string): string;
|
|
3208
|
+
protected addArrayQueryParam(query: QueryParamsType, key: string): any;
|
|
3209
|
+
protected toQueryString(rawQuery?: QueryParamsType): string;
|
|
3210
|
+
protected addQueryParams(rawQuery?: QueryParamsType): string;
|
|
3211
|
+
private contentFormatters;
|
|
3212
|
+
protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams;
|
|
3213
|
+
protected createAbortSignal: (cancelToken: CancelToken) => AbortSignal | undefined;
|
|
3214
|
+
abortRequest: (cancelToken: CancelToken) => void;
|
|
3215
|
+
request: <T = any, E = any>({ body, secure, path, type, query, format, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
|
|
3216
|
+
}
|
|
3217
|
+
/**
|
|
3218
|
+
* @title whisker rag server
|
|
3219
|
+
* @version 1.0.6
|
|
3220
|
+
*/
|
|
3221
|
+
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
3222
|
+
/**
|
|
3223
|
+
* No description
|
|
3224
|
+
*
|
|
3225
|
+
* @name HomePageGet
|
|
3226
|
+
* @summary Home Page
|
|
3227
|
+
* @request GET:/
|
|
3228
|
+
*/
|
|
3229
|
+
homePageGet: (params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
|
3230
|
+
knowledge: {
|
|
3231
|
+
/**
|
|
3232
|
+
* @description Duplicate file_sha entries are prohibited. Any modifications to split_config or embedding model_name parameters must be performed using dedicated API endpoints."
|
|
3233
|
+
*
|
|
3234
|
+
* @tags knowledge
|
|
3235
|
+
* @name AddKnowledge
|
|
3236
|
+
* @summary Add Knowledge
|
|
3237
|
+
* @request POST:/api/knowledge/add
|
|
3238
|
+
*/
|
|
3239
|
+
addKnowledge: (data: (ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate | IYuqueCreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
|
|
3240
|
+
/**
|
|
3241
|
+
* No description
|
|
3242
|
+
*
|
|
3243
|
+
* @tags knowledge
|
|
3244
|
+
* @name UpdateKnowledge
|
|
3245
|
+
* @summary Update Knowledge
|
|
3246
|
+
* @request POST:/api/knowledge/update
|
|
3247
|
+
*/
|
|
3248
|
+
updateKnowledge: (data: IKnowledgeInput, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
|
|
3249
|
+
/**
|
|
3250
|
+
* No description
|
|
3251
|
+
*
|
|
3252
|
+
* @tags knowledge
|
|
3253
|
+
* @name UpdateKnowledgeEnableStatus
|
|
3254
|
+
* @summary Update Knowledge Enable Status
|
|
3255
|
+
* @request POST:/api/knowledge/update/enabled
|
|
3256
|
+
*/
|
|
3257
|
+
updateKnowledgeEnableStatus: (data: IEnableStatusUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3258
|
+
/**
|
|
3259
|
+
* No description
|
|
3260
|
+
*
|
|
3261
|
+
* @tags knowledge
|
|
3262
|
+
* @name GetKnowledgeList
|
|
3263
|
+
* @summary Get Knowledge List
|
|
3264
|
+
* @request POST:/api/knowledge/list
|
|
3265
|
+
*/
|
|
3266
|
+
getKnowledgeList: (data: IPageQueryParamsKnowledge, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseKnowledge, void | IHTTPValidationError>>;
|
|
3267
|
+
/**
|
|
3268
|
+
* No description
|
|
3269
|
+
*
|
|
3270
|
+
* @tags knowledge
|
|
3271
|
+
* @name GetKnowledgeById
|
|
3272
|
+
* @summary Get Knowledge By Id
|
|
3273
|
+
* @request GET:/api/knowledge/detail
|
|
3274
|
+
*/
|
|
3275
|
+
getKnowledgeById: (query: {
|
|
3276
|
+
/** Knowledge Id */
|
|
3277
|
+
knowledge_id: string;
|
|
3278
|
+
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
|
|
3279
|
+
/**
|
|
3280
|
+
* @description Deletes a knowledge entry by its ID.
|
|
3281
|
+
*
|
|
3282
|
+
* @tags knowledge
|
|
3283
|
+
* @name DeleteKnowledge
|
|
3284
|
+
* @summary Delete Knowledge
|
|
3285
|
+
* @request DELETE:/api/knowledge/delete
|
|
3286
|
+
*/
|
|
3287
|
+
deleteKnowledge: (query: {
|
|
3288
|
+
/** Knowledge Id */
|
|
3289
|
+
knowledge_id: string;
|
|
3290
|
+
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3291
|
+
/**
|
|
3292
|
+
* No description
|
|
3293
|
+
*
|
|
3294
|
+
* @tags knowledge
|
|
3295
|
+
* @name GetEmbeddingModelsList
|
|
3296
|
+
* @summary Get Embedding Models List
|
|
3297
|
+
* @request GET:/api/knowledge/embedding/models
|
|
3298
|
+
*/
|
|
3299
|
+
getEmbeddingModelsList: (params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
|
|
3300
|
+
/**
|
|
3301
|
+
* @description 处理不同类型的webhook:knowledge, deployment, notification等
|
|
3302
|
+
*
|
|
3303
|
+
* @tags knowledge
|
|
3304
|
+
* @name HandleWebhookApiKnowledgeWebhookTypeSourceAuthInfoKnowledgeBaseIdPost
|
|
3305
|
+
* @summary 通用webhook处理器
|
|
3306
|
+
* @request POST:/api/knowledge/{webhook_type}/{source}/{auth_info}/{knowledge_base_id}
|
|
3307
|
+
*/
|
|
3308
|
+
handleWebhookApiKnowledgeWebhookTypeSourceAuthInfoKnowledgeBaseIdPost: (webhookType: string, source: string, authInfo: string, knowledgeBaseId: string, data: Record<string, any>, params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
|
|
3309
|
+
};
|
|
3310
|
+
retrieval: {
|
|
3311
|
+
/**
|
|
3312
|
+
* @description Retrieve certain chunks within a knowledge_id, for example, within a specific PDF file.
|
|
3313
|
+
*
|
|
3314
|
+
* @tags retrieval
|
|
3315
|
+
* @name RetrieveKnowledgeContent
|
|
3316
|
+
* @summary Retrieve Knowledge Content
|
|
3317
|
+
* @request POST:/api/retrieval/knowledge
|
|
3318
|
+
*/
|
|
3319
|
+
retrieveKnowledgeContent: (data: IRetrievalByKnowledgeRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListRetrievalChunk, void | IHTTPValidationError>>;
|
|
3320
|
+
/**
|
|
3321
|
+
* @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id.
|
|
3322
|
+
*
|
|
3323
|
+
* @tags retrieval
|
|
3324
|
+
* @name RetrieveSpaceContent
|
|
3325
|
+
* @summary Retrieve Space Content
|
|
3326
|
+
* @request POST:/api/retrieval/space
|
|
3327
|
+
*/
|
|
3328
|
+
retrieveSpaceContent: (data: IRetrievalBySpaceRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListRetrievalChunk, void | IHTTPValidationError>>;
|
|
3329
|
+
/**
|
|
3330
|
+
* @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id.
|
|
3331
|
+
*
|
|
3332
|
+
* @tags retrieval
|
|
3333
|
+
* @name Retrieve
|
|
3334
|
+
* @summary Retrieve
|
|
3335
|
+
* @request POST:/api/retrieval/
|
|
3336
|
+
*/
|
|
3337
|
+
retrieve: (data: IRetrievalRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListRetrievalChunk, void | IHTTPValidationError>>;
|
|
3338
|
+
};
|
|
3339
|
+
task: {
|
|
3340
|
+
/**
|
|
3341
|
+
* No description
|
|
3342
|
+
*
|
|
3343
|
+
* @tags task
|
|
3344
|
+
* @name RestartTask
|
|
3345
|
+
* @summary Restart Task
|
|
3346
|
+
* @request POST:/api/task/restart
|
|
3347
|
+
*/
|
|
3348
|
+
restartTask: (data: ITaskRestartRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListTask, void | IHTTPValidationError>>;
|
|
3349
|
+
/**
|
|
3350
|
+
* No description
|
|
3351
|
+
*
|
|
3352
|
+
* @tags task
|
|
3353
|
+
* @name CancelTask
|
|
3354
|
+
* @summary Cancel Task
|
|
3355
|
+
* @request POST:/api/task/cancel
|
|
3356
|
+
*/
|
|
3357
|
+
cancelTask: (data: ITaskRestartRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListTask, void | IHTTPValidationError>>;
|
|
3358
|
+
/**
|
|
3359
|
+
* No description
|
|
3360
|
+
*
|
|
3361
|
+
* @tags task
|
|
3362
|
+
* @name GetTaskList
|
|
3363
|
+
* @summary Get Task List
|
|
3364
|
+
* @request POST:/api/task/list
|
|
3365
|
+
*/
|
|
3366
|
+
getTaskList: (data: IPageQueryParamsTask, params?: RequestParams) => Promise<HttpResponse<IResponseModelStatusStatisticsPageResponseTask, void | IHTTPValidationError>>;
|
|
3367
|
+
/**
|
|
3368
|
+
* No description
|
|
3369
|
+
*
|
|
3370
|
+
* @tags task
|
|
3371
|
+
* @name GetTaskDetail
|
|
3372
|
+
* @summary Get Task Detail
|
|
3373
|
+
* @request GET:/api/task/detail
|
|
3374
|
+
*/
|
|
3375
|
+
getTaskDetail: (query: {
|
|
3376
|
+
/** Task Id */
|
|
3377
|
+
task_id: string;
|
|
3378
|
+
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelTask, void | IHTTPValidationError>>;
|
|
3379
|
+
/**
|
|
3380
|
+
* No description
|
|
3381
|
+
*
|
|
3382
|
+
* @tags task
|
|
3383
|
+
* @name DeleteTaskById
|
|
3384
|
+
* @summary Delete Task By Id
|
|
3385
|
+
* @request DELETE:/api/task/delete
|
|
3386
|
+
*/
|
|
3387
|
+
deleteTaskById: (query: {
|
|
3388
|
+
/** Task Id */
|
|
3389
|
+
task_id: string;
|
|
3390
|
+
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelTask, void | IHTTPValidationError>>;
|
|
3391
|
+
};
|
|
3392
|
+
chunk: {
|
|
3393
|
+
/**
|
|
3394
|
+
* No description
|
|
3395
|
+
*
|
|
3396
|
+
* @tags chunk
|
|
3397
|
+
* @name GetChunkList
|
|
3398
|
+
* @summary Get Chunk List
|
|
3399
|
+
* @request POST:/api/chunk/list
|
|
3400
|
+
*/
|
|
3401
|
+
getChunkList: (data: IPageQueryParamsChunk, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseChunk, void | IHTTPValidationError>>;
|
|
3402
|
+
/**
|
|
3403
|
+
* No description
|
|
3404
|
+
*
|
|
3405
|
+
* @tags chunk
|
|
3406
|
+
* @name DeleteChunkById
|
|
3407
|
+
* @summary Delete Chunk By Id
|
|
3408
|
+
* @request DELETE:/api/chunk/id/{id}/model_name/{model_name}
|
|
3409
|
+
*/
|
|
3410
|
+
deleteChunkById: (id: string, modelName: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelObject, void | IHTTPValidationError>>;
|
|
3411
|
+
/**
|
|
3412
|
+
* No description
|
|
3413
|
+
*
|
|
3414
|
+
* @tags chunk
|
|
3415
|
+
* @name GetChunkById
|
|
3416
|
+
* @summary Get Chunk By Id
|
|
3417
|
+
* @request GET:/api/chunk/id/{id}/model_name/{model_name}
|
|
3418
|
+
*/
|
|
3419
|
+
getChunkById: (id: string, modelName: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelChunk, void | IHTTPValidationError>>;
|
|
3420
|
+
/**
|
|
3421
|
+
* No description
|
|
3422
|
+
*
|
|
3423
|
+
* @tags chunk
|
|
3424
|
+
* @name AddChunk
|
|
3425
|
+
* @summary Add Chunk
|
|
3426
|
+
* @request POST:/api/chunk/add
|
|
3427
|
+
*/
|
|
3428
|
+
addChunk: (data: IChunkSave, params?: RequestParams) => Promise<HttpResponse<IResponseModelChunk, void | IHTTPValidationError>>;
|
|
3429
|
+
/**
|
|
3430
|
+
* No description
|
|
3431
|
+
*
|
|
3432
|
+
* @tags chunk
|
|
3433
|
+
* @name UpdateChunk
|
|
3434
|
+
* @summary Update Chunk
|
|
3435
|
+
* @request POST:/api/chunk/update
|
|
3436
|
+
*/
|
|
3437
|
+
updateChunk: (data: IChunkUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelChunk, void | IHTTPValidationError>>;
|
|
3438
|
+
};
|
|
3439
|
+
tenant: {
|
|
3440
|
+
/**
|
|
3441
|
+
* No description
|
|
3442
|
+
*
|
|
3443
|
+
* @tags tenant
|
|
3444
|
+
* @name CreateTenant
|
|
3445
|
+
* @summary Create Tenant
|
|
3446
|
+
* @request POST:/api/tenant/create
|
|
3447
|
+
*/
|
|
3448
|
+
createTenant: (data: ITenantCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
3449
|
+
/**
|
|
3450
|
+
* No description
|
|
3451
|
+
*
|
|
3452
|
+
* @tags tenant
|
|
3453
|
+
* @name GetTenantById
|
|
3454
|
+
* @summary Query Tenant
|
|
3455
|
+
* @request GET:/api/tenant/id/{id}
|
|
3456
|
+
*/
|
|
3457
|
+
getTenantById: (id: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
3458
|
+
/**
|
|
3459
|
+
* No description
|
|
3460
|
+
*
|
|
3461
|
+
* @tags tenant
|
|
3462
|
+
* @name DeleteTenantById
|
|
3463
|
+
* @summary Delete Tenant
|
|
3464
|
+
* @request DELETE:/api/tenant/{id}
|
|
3465
|
+
*/
|
|
3466
|
+
deleteTenantById: (id: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelObject, void | IHTTPValidationError>>;
|
|
3467
|
+
/**
|
|
3468
|
+
* No description
|
|
3469
|
+
*
|
|
3470
|
+
* @tags tenant
|
|
3471
|
+
* @name UpdateTenant
|
|
3472
|
+
* @summary Update Tenant
|
|
3473
|
+
* @request POST:/api/tenant/update
|
|
3474
|
+
*/
|
|
3475
|
+
updateTenant: (data: ITenantUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
3476
|
+
/**
|
|
3477
|
+
* No description
|
|
3478
|
+
*
|
|
3479
|
+
* @tags tenant
|
|
3480
|
+
* @name GetTenantList
|
|
3481
|
+
* @summary Get Tenant List
|
|
3482
|
+
* @request GET:/api/tenant/list
|
|
3483
|
+
*/
|
|
3484
|
+
getTenantList: (query?: {
|
|
3485
|
+
/**
|
|
3486
|
+
* Page
|
|
3487
|
+
* @default 1
|
|
3488
|
+
*/
|
|
3489
|
+
page?: number;
|
|
3490
|
+
/**
|
|
3491
|
+
* Page Size
|
|
3492
|
+
* @default 10
|
|
3493
|
+
*/
|
|
3494
|
+
page_size?: number;
|
|
3495
|
+
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTenant, void | IHTTPValidationError>>;
|
|
3496
|
+
/**
|
|
3497
|
+
* No description
|
|
3498
|
+
*
|
|
3499
|
+
* @tags tenant
|
|
3500
|
+
* @name GetTenant
|
|
3501
|
+
* @summary Get Tenant
|
|
3502
|
+
* @request GET:/api/tenant/me
|
|
3503
|
+
*/
|
|
3504
|
+
getTenant: (params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
|
|
3505
|
+
};
|
|
3506
|
+
space: {
|
|
3507
|
+
/**
|
|
3508
|
+
* No description
|
|
3509
|
+
*
|
|
3510
|
+
* @tags space
|
|
3511
|
+
* @name GetSpaceList
|
|
3512
|
+
* @summary Get Space List
|
|
3513
|
+
* @request POST:/api/space/list
|
|
3514
|
+
*/
|
|
3515
|
+
getSpaceList: (data: IPageQueryParamsSpace, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseSpaceResponse, void | IHTTPValidationError>>;
|
|
3516
|
+
/**
|
|
3517
|
+
* No description
|
|
3518
|
+
*
|
|
3519
|
+
* @tags space
|
|
3520
|
+
* @name AddSpace
|
|
3521
|
+
* @summary Add Space
|
|
3522
|
+
* @request POST:/api/space/add
|
|
3523
|
+
*/
|
|
3524
|
+
addSpace: (data: ISpaceCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelSpaceResponse, void | IHTTPValidationError>>;
|
|
3525
|
+
/**
|
|
3526
|
+
* No description
|
|
3527
|
+
*
|
|
3528
|
+
* @tags space
|
|
3529
|
+
* @name DeleteSpace
|
|
3530
|
+
* @summary Delete Space
|
|
3531
|
+
* @request DELETE:/api/space/{space_id}
|
|
3532
|
+
*/
|
|
3533
|
+
deleteSpace: (spaceId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3534
|
+
/**
|
|
3535
|
+
* No description
|
|
3536
|
+
*
|
|
3537
|
+
* @tags space
|
|
3538
|
+
* @name UpdateSpace
|
|
3539
|
+
* @summary Update Space
|
|
3540
|
+
* @request PUT:/api/space/{space_id}
|
|
3541
|
+
*/
|
|
3542
|
+
updateSpace: (spaceId: string, data: ISpaceCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelSpaceResponse, void | IHTTPValidationError>>;
|
|
3543
|
+
/**
|
|
3544
|
+
* No description
|
|
3545
|
+
*
|
|
3546
|
+
* @tags space
|
|
3547
|
+
* @name GetSpaceById
|
|
3548
|
+
* @summary Get Space By Id
|
|
3549
|
+
* @request GET:/api/space/{space_id}
|
|
3550
|
+
*/
|
|
3551
|
+
getSpaceById: (spaceId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelSpaceResponse, void | IHTTPValidationError>>;
|
|
3552
|
+
};
|
|
3553
|
+
v1: {
|
|
3554
|
+
/**
|
|
3555
|
+
* No description
|
|
3556
|
+
*
|
|
3557
|
+
* @tags dashboard
|
|
3558
|
+
* @name GetGlobalInfo
|
|
3559
|
+
* @summary Get System Global Info
|
|
3560
|
+
* @request GET:/api/v1/dashboard/global_info
|
|
3561
|
+
*/
|
|
3562
|
+
getGlobalInfo: (params?: RequestParams) => Promise<HttpResponse<IResponseModelGlobalInfo, void>>;
|
|
3563
|
+
/**
|
|
3564
|
+
* No description
|
|
3565
|
+
*
|
|
3566
|
+
* @tags dashboard
|
|
3567
|
+
* @name GetTenantLog
|
|
3568
|
+
* @summary Get Tenant Log
|
|
3569
|
+
* @request GET:/api/v1/dashboard/tenant_log
|
|
3570
|
+
*/
|
|
3571
|
+
getTenantLog: (data: ITenantLogQuery, params?: RequestParams) => Promise<HttpResponse<IResponseModelListTenantLog, void | IHTTPValidationError>>;
|
|
3572
|
+
/**
|
|
3573
|
+
* No description
|
|
3574
|
+
*
|
|
3575
|
+
* @tags agent
|
|
3576
|
+
* @name ProResearchApiV1AgentProResearchPost
|
|
3577
|
+
* @summary Pro Research
|
|
3578
|
+
* @request POST:/api/v1/agent/pro_research
|
|
3579
|
+
*/
|
|
3580
|
+
proResearchApiV1AgentProResearchPost: (data: IProResearchRequest, params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
|
|
3581
|
+
/**
|
|
3582
|
+
* @description whisker 通用 webhook
|
|
3583
|
+
*
|
|
3584
|
+
* @tags webhook
|
|
3585
|
+
* @name HandleWebhookApiV1WebhookWebhookTypeSourceAuthInfoKnowledgeBaseIdPost
|
|
3586
|
+
* @summary 通用webhook处理器
|
|
3587
|
+
* @request POST:/api/v1/webhook/{webhook_type}/{source}/{auth_info}/{knowledge_base_id}
|
|
3588
|
+
*/
|
|
3589
|
+
handleWebhookApiV1WebhookWebhookTypeSourceAuthInfoKnowledgeBaseIdPost: (webhookType: string, source: string, authInfo: string, knowledgeBaseId: string, data: Record<string, any>, params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
|
|
3590
|
+
/**
|
|
3591
|
+
* No description
|
|
3592
|
+
*
|
|
3593
|
+
* @tags tagging
|
|
3594
|
+
* @name GetTaggingList
|
|
3595
|
+
* @summary Get Tagging List
|
|
3596
|
+
* @request POST:/api/v1/tagging/list
|
|
3597
|
+
*/
|
|
3598
|
+
getTaggingList: (data: IPageQueryParamsTagging, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTagging, void | IHTTPValidationError>>;
|
|
3599
|
+
/**
|
|
3600
|
+
* No description
|
|
3601
|
+
*
|
|
3602
|
+
* @tags tagging
|
|
3603
|
+
* @name AddTaggingList
|
|
3604
|
+
* @summary Add Tagging List
|
|
3605
|
+
* @request POST:/api/v1/tagging/add_list
|
|
3606
|
+
*/
|
|
3607
|
+
addTaggingList: (data: ITaggingCreate[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListTagging, void | IHTTPValidationError>>;
|
|
3608
|
+
/**
|
|
3609
|
+
* No description
|
|
3610
|
+
*
|
|
3611
|
+
* @tags tagging
|
|
3612
|
+
* @name DeleteTaggingById
|
|
3613
|
+
* @summary Delete Tagging By Id
|
|
3614
|
+
* @request DELETE:/api/v1/tagging/{tagging_id}
|
|
3615
|
+
*/
|
|
3616
|
+
deleteTaggingById: (taggingId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3617
|
+
/**
|
|
3618
|
+
* @description 分页获取标签列表
|
|
3619
|
+
*
|
|
3620
|
+
* @tags tag
|
|
3621
|
+
* @name GetTagList
|
|
3622
|
+
* @summary Get Tag List
|
|
3623
|
+
* @request POST:/api/v1/tag/list
|
|
3624
|
+
*/
|
|
3625
|
+
getTagList: (data: IPageQueryParamsTag, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTag, void | IHTTPValidationError>>;
|
|
3626
|
+
/**
|
|
3627
|
+
* @description 批量新增标签 注意:根据接口定义,DB 插件方法签名为 add_tag_list(tag_list: List[TagCreate]), 因此此处直接传入 body。若 TagCreate 需要携带 tenant_id,应由模型或插件内部处理。
|
|
3628
|
+
*
|
|
3629
|
+
* @tags tag
|
|
3630
|
+
* @name AddTagList
|
|
3631
|
+
* @summary Add Tag List
|
|
3632
|
+
* @request POST:/api/v1/tag/add_list
|
|
3633
|
+
*/
|
|
3634
|
+
addTagList: (data: ITagCreate[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListTag, void | IHTTPValidationError>>;
|
|
3635
|
+
/**
|
|
3636
|
+
* @description 获取标签详情
|
|
3637
|
+
*
|
|
3638
|
+
* @tags tag
|
|
3639
|
+
* @name GetTagById
|
|
3640
|
+
* @summary Get Tag By Id
|
|
3641
|
+
* @request GET:/api/v1/tag/{tag_id}
|
|
3642
|
+
*/
|
|
3643
|
+
getTagById: (tagId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelTag, void | IHTTPValidationError>>;
|
|
3644
|
+
/**
|
|
3645
|
+
* No description
|
|
3646
|
+
*
|
|
3647
|
+
* @tags tag
|
|
3648
|
+
* @name DeleteTagById
|
|
3649
|
+
* @summary Delete Tag By Id
|
|
3650
|
+
* @request DELETE:/api/v1/tag/{tag_id}
|
|
3651
|
+
*/
|
|
3652
|
+
deleteTagById: (tagId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3653
|
+
/**
|
|
3654
|
+
* No description
|
|
3655
|
+
*
|
|
3656
|
+
* @tags tag
|
|
3657
|
+
* @name UpdateTag
|
|
3658
|
+
* @summary Update Tag
|
|
3659
|
+
* @request POST:/api/v1/tag/update
|
|
3660
|
+
*/
|
|
3661
|
+
updateTag: (data: ITagUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTag, void | IHTTPValidationError>>;
|
|
3662
|
+
/**
|
|
3663
|
+
* No description
|
|
3664
|
+
*
|
|
3665
|
+
* @tags artifact
|
|
3666
|
+
* @name GetArtifactList
|
|
3667
|
+
* @summary Get Artifact List
|
|
3668
|
+
* @request POST:/api/v1/artifact/list
|
|
3669
|
+
*/
|
|
3670
|
+
getArtifactList: (data: IPageQueryParamsArtifactIndex, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseArtifactIndex, void | IHTTPValidationError>>;
|
|
3671
|
+
/**
|
|
3672
|
+
* No description
|
|
3673
|
+
*
|
|
3674
|
+
* @tags artifact
|
|
3675
|
+
* @name AddArtifactList
|
|
3676
|
+
* @summary Add Artifact List
|
|
3677
|
+
* @request POST:/api/v1/artifact/add_list
|
|
3678
|
+
*/
|
|
3679
|
+
addArtifactList: (data: IArtifactIndexCreate[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListArtifactIndex, void | IHTTPValidationError>>;
|
|
3680
|
+
/**
|
|
3681
|
+
* No description
|
|
3682
|
+
*
|
|
3683
|
+
* @tags artifact
|
|
3684
|
+
* @name GetArtifactById
|
|
3685
|
+
* @summary Get Artifact By Id
|
|
3686
|
+
* @request GET:/api/v1/artifact/{artifact_id}
|
|
3687
|
+
*/
|
|
3688
|
+
getArtifactById: (artifactId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelArtifactIndex, void | IHTTPValidationError>>;
|
|
3689
|
+
/**
|
|
3690
|
+
* No description
|
|
3691
|
+
*
|
|
3692
|
+
* @tags artifact
|
|
3693
|
+
* @name DeleteArtifactById
|
|
3694
|
+
* @summary Delete Artifact By Id
|
|
3695
|
+
* @request DELETE:/api/v1/artifact/{artifact_id}
|
|
3696
|
+
*/
|
|
3697
|
+
deleteArtifactById: (artifactId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3698
|
+
/**
|
|
3699
|
+
* No description
|
|
3700
|
+
*
|
|
3701
|
+
* @tags artifact
|
|
3702
|
+
* @name UpdateArtifactSpaceId
|
|
3703
|
+
* @summary Update Artifact Space Id
|
|
3704
|
+
* @request POST:/api/v1/artifact/update_space
|
|
3705
|
+
*/
|
|
3706
|
+
updateArtifactSpaceId: (data: IArtifactSpaceUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelArtifactIndex, void | IHTTPValidationError>>;
|
|
3707
|
+
};
|
|
3708
|
+
rule: {
|
|
3709
|
+
/**
|
|
3710
|
+
* No description
|
|
3711
|
+
*
|
|
3712
|
+
* @tags rule
|
|
3713
|
+
* @name GetGlobalRule
|
|
3714
|
+
* @summary Get Global Rule
|
|
3715
|
+
* @request GET:/api/rule/global
|
|
3716
|
+
*/
|
|
3717
|
+
getGlobalRule: (params?: RequestParams) => Promise<HttpResponse<IResponseModelStr, void | IHTTPValidationError>>;
|
|
3718
|
+
/**
|
|
3719
|
+
* No description
|
|
3720
|
+
*
|
|
3721
|
+
* @tags rule
|
|
3722
|
+
* @name GetSpaceRule
|
|
3723
|
+
* @summary Get Space Rule
|
|
3724
|
+
* @request GET:/api/rule/space/{space_id}
|
|
3725
|
+
*/
|
|
3726
|
+
getSpaceRule: (spaceId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelStr, void | IHTTPValidationError>>;
|
|
3727
|
+
};
|
|
3728
|
+
apiKey: {
|
|
3729
|
+
/**
|
|
3730
|
+
* No description
|
|
3731
|
+
*
|
|
3732
|
+
* @tags api key
|
|
3733
|
+
* @name CreateApiKey
|
|
3734
|
+
* @summary Create Api Key
|
|
3735
|
+
* @request POST:/api/api_key/create
|
|
3736
|
+
*/
|
|
3737
|
+
createApiKey: (data: IAPIKeyCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelAPIKey, void | IHTTPValidationError>>;
|
|
3738
|
+
/**
|
|
3739
|
+
* No description
|
|
3740
|
+
*
|
|
3741
|
+
* @tags api key
|
|
3742
|
+
* @name UpdateApiKey
|
|
3743
|
+
* @summary Update Api Key
|
|
3744
|
+
* @request POST:/api/api_key/update
|
|
3745
|
+
*/
|
|
3746
|
+
updateApiKey: (data: IAPIKeyUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelAPIKey, void | IHTTPValidationError>>;
|
|
3747
|
+
/**
|
|
3748
|
+
* No description
|
|
3749
|
+
*
|
|
3750
|
+
* @tags api key
|
|
3751
|
+
* @name GetApiKeyList
|
|
3752
|
+
* @summary Get Api Key List
|
|
3753
|
+
* @request POST:/api/api_key/list
|
|
3754
|
+
*/
|
|
3755
|
+
getApiKeyList: (data: IPageQueryParamsAPIKey, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseAPIKey, void | IHTTPValidationError>>;
|
|
3756
|
+
/**
|
|
3757
|
+
* No description
|
|
3758
|
+
*
|
|
3759
|
+
* @tags api key
|
|
3760
|
+
* @name DeleteApiKey
|
|
3761
|
+
* @summary Delete Api Key
|
|
3762
|
+
* @request DELETE:/api/api_key/delete/{key_id}
|
|
3763
|
+
*/
|
|
3764
|
+
deleteApiKey: (keyId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3765
|
+
/**
|
|
3766
|
+
* No description
|
|
3767
|
+
*
|
|
3768
|
+
* @tags api key
|
|
3769
|
+
* @name DeactivateApiKey
|
|
3770
|
+
* @summary Change Api Key Status
|
|
3771
|
+
* @request POST:/api/api_key/deactivate/{key_id}
|
|
3772
|
+
*/
|
|
3773
|
+
deactivateApiKey: (keyId: string, data: IActiveStatusUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3774
|
+
/**
|
|
3775
|
+
* No description
|
|
3776
|
+
*
|
|
3777
|
+
* @tags api key
|
|
3778
|
+
* @name GetAllExpiredApiKeys
|
|
3779
|
+
* @summary Get All Expired Api Keys
|
|
3780
|
+
* @request GET:/api/api_key/expired
|
|
3781
|
+
*/
|
|
3782
|
+
getAllExpiredApiKeys: (params?: RequestParams) => Promise<HttpResponse<IResponseModelListAPIKey, void | IHTTPValidationError>>;
|
|
3783
|
+
};
|
|
3784
|
+
healthChecker: {
|
|
3785
|
+
/**
|
|
3786
|
+
* No description
|
|
3787
|
+
*
|
|
3788
|
+
* @name HealthCheckerApiHealthCheckerGet
|
|
3789
|
+
* @summary Health Checker
|
|
3790
|
+
* @request GET:/api/health_checker
|
|
3791
|
+
*/
|
|
3792
|
+
healthCheckerApiHealthCheckerGet: (params?: RequestParams) => Promise<HttpResponse<IResponseModel, any>>;
|
|
3793
|
+
};
|
|
3794
|
+
}
|
|
3795
|
+
export {};
|