@petercatai/whisker-client 0.1.202504211908-dev → 0.1.202504281028
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 +266 -71
- package/dist/api.js +79 -2
- package/package.json +5 -5
package/dist/api.d.ts
CHANGED
|
@@ -20,9 +20,14 @@ export declare enum IKnowledgeTypeEnum {
|
|
|
20
20
|
Docx = "docx",
|
|
21
21
|
Pdf = "pdf",
|
|
22
22
|
Qa = "qa",
|
|
23
|
+
Yuquedoc = "yuquedoc",
|
|
24
|
+
OpenapiApp = "openapi_app",
|
|
23
25
|
Folder = "folder"
|
|
24
26
|
}
|
|
25
|
-
/**
|
|
27
|
+
/**
|
|
28
|
+
* KnowledgeSourceEnum
|
|
29
|
+
* Specifies the source of knowledge, which influences the behavior of the resource loader
|
|
30
|
+
*/
|
|
26
31
|
export declare enum IKnowledgeSourceEnum {
|
|
27
32
|
GithubRepo = "github_repo",
|
|
28
33
|
GithubFile = "github_file",
|
|
@@ -44,17 +49,28 @@ export declare enum IEmbeddingModelEnum {
|
|
|
44
49
|
export interface IBaseCharSplitConfig {
|
|
45
50
|
/**
|
|
46
51
|
* Chunk Size
|
|
52
|
+
* chunk max size
|
|
47
53
|
* @min 1
|
|
48
|
-
* @exclusiveMax 5000
|
|
49
54
|
* @default 1500
|
|
50
55
|
*/
|
|
51
56
|
chunk_size?: number;
|
|
52
57
|
/**
|
|
53
58
|
* Chunk Overlap
|
|
59
|
+
* chunk overlap size, must be less than chunk_size
|
|
54
60
|
* @min 0
|
|
55
61
|
* @default 150
|
|
56
62
|
*/
|
|
57
63
|
chunk_overlap?: number;
|
|
64
|
+
/**
|
|
65
|
+
* Separators
|
|
66
|
+
* separator list, if None, use default separators
|
|
67
|
+
*/
|
|
68
|
+
separators?: string[] | null;
|
|
69
|
+
/**
|
|
70
|
+
* Split Regex
|
|
71
|
+
* split_regex,if set, use it instead of separators
|
|
72
|
+
*/
|
|
73
|
+
split_regex?: string | null;
|
|
58
74
|
}
|
|
59
75
|
/** Chunk */
|
|
60
76
|
export interface IChunk {
|
|
@@ -97,7 +113,7 @@ export interface IChunk {
|
|
|
97
113
|
* Metadata
|
|
98
114
|
* Arbitrary metadata associated with the content.
|
|
99
115
|
*/
|
|
100
|
-
metadata?:
|
|
116
|
+
metadata?: Record<string, any> | null;
|
|
101
117
|
/**
|
|
102
118
|
* Gmt Create
|
|
103
119
|
* creation time
|
|
@@ -109,6 +125,38 @@ export interface IChunk {
|
|
|
109
125
|
*/
|
|
110
126
|
gmt_modified?: string;
|
|
111
127
|
}
|
|
128
|
+
/** ChunkSave */
|
|
129
|
+
export interface IChunkSave {
|
|
130
|
+
/** Chunk Id */
|
|
131
|
+
chunk_id?: string | null;
|
|
132
|
+
/** Space Id */
|
|
133
|
+
space_id: string;
|
|
134
|
+
/** Context */
|
|
135
|
+
context: string;
|
|
136
|
+
/** Knowledge Id */
|
|
137
|
+
knowledge_id: string;
|
|
138
|
+
/** Embedding Model Name */
|
|
139
|
+
embedding_model_name: string;
|
|
140
|
+
/** Metadata */
|
|
141
|
+
metadata?: Record<string, any> | null;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* GeaGraphSplitConfig
|
|
145
|
+
* JSON document split configuration
|
|
146
|
+
* @link {https://python.langchain.com/api_reference/text_splitters/json/langchain_text_splitters.json.RecursiveJsonSplitter.html}
|
|
147
|
+
*/
|
|
148
|
+
export interface IGeaGraphSplitConfig {
|
|
149
|
+
/**
|
|
150
|
+
* Type
|
|
151
|
+
* @default "geagraph"
|
|
152
|
+
*/
|
|
153
|
+
type?: "geagraph";
|
|
154
|
+
/**
|
|
155
|
+
* Schema Id
|
|
156
|
+
* The maximum size for each chunk. Defaults to 2000
|
|
157
|
+
*/
|
|
158
|
+
schema_id?: string | null;
|
|
159
|
+
}
|
|
112
160
|
/** GithubFileSourceConfig */
|
|
113
161
|
export interface IGithubFileSourceConfig {
|
|
114
162
|
/**
|
|
@@ -161,7 +209,7 @@ export interface IGithubRepoCreate {
|
|
|
161
209
|
* additional metadata, user can update it
|
|
162
210
|
* @default {}
|
|
163
211
|
*/
|
|
164
|
-
metadata?:
|
|
212
|
+
metadata?: Record<string, any>;
|
|
165
213
|
/** source type */
|
|
166
214
|
source_type: IKnowledgeSourceEnum;
|
|
167
215
|
/**
|
|
@@ -237,7 +285,7 @@ export interface IImageCreate {
|
|
|
237
285
|
* additional metadata, user can update it
|
|
238
286
|
* @default {}
|
|
239
287
|
*/
|
|
240
|
-
metadata?:
|
|
288
|
+
metadata?: Record<string, any>;
|
|
241
289
|
/** source type */
|
|
242
290
|
source_type: IKnowledgeSourceEnum;
|
|
243
291
|
/**
|
|
@@ -286,7 +334,7 @@ export interface IJSONCreate {
|
|
|
286
334
|
* additional metadata, user can update it
|
|
287
335
|
* @default {}
|
|
288
336
|
*/
|
|
289
|
-
metadata?:
|
|
337
|
+
metadata?: Record<string, any>;
|
|
290
338
|
/** source type */
|
|
291
339
|
source_type: IKnowledgeSourceEnum;
|
|
292
340
|
/**
|
|
@@ -316,45 +364,27 @@ export interface IJSONCreate {
|
|
|
316
364
|
/**
|
|
317
365
|
* JSONSplitConfig
|
|
318
366
|
* JSON document split configuration
|
|
367
|
+
* @link {https://python.langchain.com/api_reference/text_splitters/json/langchain_text_splitters.json.RecursiveJsonSplitter.html}
|
|
319
368
|
*/
|
|
320
369
|
export interface IJSONSplitConfig {
|
|
321
370
|
/**
|
|
322
|
-
*
|
|
323
|
-
* @
|
|
324
|
-
* @exclusiveMax 5000
|
|
325
|
-
* @default 1500
|
|
326
|
-
*/
|
|
327
|
-
chunk_size?: number;
|
|
328
|
-
/**
|
|
329
|
-
* Chunk Overlap
|
|
330
|
-
* @min 0
|
|
331
|
-
* @default 150
|
|
332
|
-
*/
|
|
333
|
-
chunk_overlap?: number;
|
|
334
|
-
/**
|
|
335
|
-
* Split Level
|
|
336
|
-
* Depth level for JSON splitting
|
|
337
|
-
* @min 1
|
|
338
|
-
* @default 1
|
|
339
|
-
*/
|
|
340
|
-
split_level?: number;
|
|
341
|
-
/**
|
|
342
|
-
* Preserve Structure
|
|
343
|
-
* Whether to preserve JSON structure
|
|
344
|
-
* @default true
|
|
371
|
+
* Type
|
|
372
|
+
* @default "json"
|
|
345
373
|
*/
|
|
346
|
-
|
|
374
|
+
type?: "json";
|
|
347
375
|
/**
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
* @default
|
|
376
|
+
* Max Chunk Size
|
|
377
|
+
* The maximum size for each chunk. Defaults to 2000
|
|
378
|
+
* @default 2000
|
|
351
379
|
*/
|
|
352
|
-
|
|
380
|
+
max_chunk_size?: number;
|
|
353
381
|
/**
|
|
354
|
-
*
|
|
355
|
-
*
|
|
382
|
+
* Min Chunk Size
|
|
383
|
+
* The minimum size for a chunk. If None,
|
|
384
|
+
* defaults to the maximum chunk size minus 200, with a lower bound of 50.
|
|
385
|
+
* @default 200
|
|
356
386
|
*/
|
|
357
|
-
|
|
387
|
+
min_chunk_size?: number | null;
|
|
358
388
|
}
|
|
359
389
|
/** Knowledge */
|
|
360
390
|
export interface IKnowledgeInput {
|
|
@@ -404,7 +434,7 @@ export interface IKnowledgeInput {
|
|
|
404
434
|
* Split Config
|
|
405
435
|
* configuration for splitting the knowledge
|
|
406
436
|
*/
|
|
407
|
-
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig |
|
|
437
|
+
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IGeaGraphSplitConfig;
|
|
408
438
|
/**
|
|
409
439
|
* File Sha
|
|
410
440
|
* SHA of the file
|
|
@@ -420,7 +450,7 @@ export interface IKnowledgeInput {
|
|
|
420
450
|
* additional metadata, user can update it
|
|
421
451
|
* @default {}
|
|
422
452
|
*/
|
|
423
|
-
metadata?:
|
|
453
|
+
metadata?: Record<string, any>;
|
|
424
454
|
/**
|
|
425
455
|
* Retrieval Count
|
|
426
456
|
* count of the retrieval
|
|
@@ -490,7 +520,7 @@ export interface IKnowledgeOutput {
|
|
|
490
520
|
* Split Config
|
|
491
521
|
* configuration for splitting the knowledge
|
|
492
522
|
*/
|
|
493
|
-
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig |
|
|
523
|
+
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IGeaGraphSplitConfig;
|
|
494
524
|
/**
|
|
495
525
|
* File Sha
|
|
496
526
|
* SHA of the file
|
|
@@ -505,7 +535,7 @@ export interface IKnowledgeOutput {
|
|
|
505
535
|
* Metadata
|
|
506
536
|
* additional metadata, user can update it
|
|
507
537
|
*/
|
|
508
|
-
metadata?:
|
|
538
|
+
metadata?: Record<string, any> | null;
|
|
509
539
|
/**
|
|
510
540
|
* Retrieval Count
|
|
511
541
|
* count of the retrieval
|
|
@@ -586,7 +616,7 @@ export interface IKnowledgeCreate {
|
|
|
586
616
|
* Split Config
|
|
587
617
|
* configuration for splitting the knowledge
|
|
588
618
|
*/
|
|
589
|
-
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig |
|
|
619
|
+
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IGeaGraphSplitConfig;
|
|
590
620
|
/**
|
|
591
621
|
* File Sha
|
|
592
622
|
* SHA of the file
|
|
@@ -602,7 +632,7 @@ export interface IKnowledgeCreate {
|
|
|
602
632
|
* additional metadata, user can update it
|
|
603
633
|
* @default {}
|
|
604
634
|
*/
|
|
605
|
-
metadata?:
|
|
635
|
+
metadata?: Record<string, any>;
|
|
606
636
|
/**
|
|
607
637
|
* Parent Id
|
|
608
638
|
* parent knowledge id
|
|
@@ -639,7 +669,7 @@ export interface IMarkdownCreate {
|
|
|
639
669
|
* additional metadata, user can update it
|
|
640
670
|
* @default {}
|
|
641
671
|
*/
|
|
642
|
-
metadata?:
|
|
672
|
+
metadata?: Record<string, any>;
|
|
643
673
|
/** source type */
|
|
644
674
|
source_type: IKnowledgeSourceEnum;
|
|
645
675
|
/**
|
|
@@ -666,34 +696,38 @@ export interface IMarkdownCreate {
|
|
|
666
696
|
/** split config of the knowledge */
|
|
667
697
|
split_config: IMarkdownSplitConfig;
|
|
668
698
|
}
|
|
669
|
-
/**
|
|
670
|
-
* MarkdownSplitConfig
|
|
671
|
-
* Markdown document split configuration
|
|
672
|
-
*/
|
|
699
|
+
/** MarkdownSplitConfig */
|
|
673
700
|
export interface IMarkdownSplitConfig {
|
|
674
701
|
/**
|
|
675
702
|
* Chunk Size
|
|
703
|
+
* chunk max size
|
|
676
704
|
* @min 1
|
|
677
|
-
* @exclusiveMax 5000
|
|
678
705
|
* @default 1500
|
|
679
706
|
*/
|
|
680
707
|
chunk_size?: number;
|
|
681
708
|
/**
|
|
682
709
|
* Chunk Overlap
|
|
710
|
+
* chunk overlap size, must be less than chunk_size
|
|
683
711
|
* @min 0
|
|
684
712
|
* @default 150
|
|
685
713
|
*/
|
|
686
714
|
chunk_overlap?: number;
|
|
687
715
|
/**
|
|
688
716
|
* Separators
|
|
689
|
-
*
|
|
717
|
+
* List of separators to split the text. If None, uses default separators
|
|
718
|
+
* @default ["\n\n"]
|
|
690
719
|
*/
|
|
691
|
-
separators
|
|
720
|
+
separators?: string[];
|
|
692
721
|
/**
|
|
693
722
|
* Split Regex
|
|
694
|
-
* split_regex
|
|
723
|
+
* split_regex,if set, use it instead of separators
|
|
695
724
|
*/
|
|
696
|
-
split_regex
|
|
725
|
+
split_regex?: string | null;
|
|
726
|
+
/**
|
|
727
|
+
* Type
|
|
728
|
+
* @default "markdown"
|
|
729
|
+
*/
|
|
730
|
+
type?: "markdown";
|
|
697
731
|
}
|
|
698
732
|
/** OpenIdSourceConfig */
|
|
699
733
|
export interface IOpenIdSourceConfig {
|
|
@@ -735,7 +769,7 @@ export interface IPDFCreate {
|
|
|
735
769
|
* additional metadata, user can update it
|
|
736
770
|
* @default {}
|
|
737
771
|
*/
|
|
738
|
-
metadata?:
|
|
772
|
+
metadata?: Record<string, any>;
|
|
739
773
|
/** source type */
|
|
740
774
|
source_type: IKnowledgeSourceEnum;
|
|
741
775
|
/**
|
|
@@ -769,17 +803,33 @@ export interface IPDFCreate {
|
|
|
769
803
|
export interface IPDFSplitConfig {
|
|
770
804
|
/**
|
|
771
805
|
* Chunk Size
|
|
806
|
+
* chunk max size
|
|
772
807
|
* @min 1
|
|
773
|
-
* @exclusiveMax 5000
|
|
774
808
|
* @default 1500
|
|
775
809
|
*/
|
|
776
810
|
chunk_size?: number;
|
|
777
811
|
/**
|
|
778
812
|
* Chunk Overlap
|
|
813
|
+
* chunk overlap size, must be less than chunk_size
|
|
779
814
|
* @min 0
|
|
780
815
|
* @default 150
|
|
781
816
|
*/
|
|
782
817
|
chunk_overlap?: number;
|
|
818
|
+
/**
|
|
819
|
+
* Separators
|
|
820
|
+
* separator list, if None, use default separators
|
|
821
|
+
*/
|
|
822
|
+
separators?: string[] | null;
|
|
823
|
+
/**
|
|
824
|
+
* Split Regex
|
|
825
|
+
* split_regex,if set, use it instead of separators
|
|
826
|
+
*/
|
|
827
|
+
split_regex?: string | null;
|
|
828
|
+
/**
|
|
829
|
+
* Type
|
|
830
|
+
* @default "pdf"
|
|
831
|
+
*/
|
|
832
|
+
type?: "pdf";
|
|
783
833
|
/**
|
|
784
834
|
* Split By Page
|
|
785
835
|
* Whether to split by pages
|
|
@@ -837,7 +887,7 @@ export interface IPageParamsChunk {
|
|
|
837
887
|
* Eq Conditions
|
|
838
888
|
* list of equality conditions, each as a dict with key and value
|
|
839
889
|
*/
|
|
840
|
-
eq_conditions?:
|
|
890
|
+
eq_conditions?: Record<string, any> | null;
|
|
841
891
|
}
|
|
842
892
|
/** PageParams[Knowledge] */
|
|
843
893
|
export interface IPageParamsKnowledge {
|
|
@@ -871,7 +921,7 @@ export interface IPageParamsKnowledge {
|
|
|
871
921
|
* Eq Conditions
|
|
872
922
|
* list of equality conditions, each as a dict with key and value
|
|
873
923
|
*/
|
|
874
|
-
eq_conditions?:
|
|
924
|
+
eq_conditions?: Record<string, any> | null;
|
|
875
925
|
}
|
|
876
926
|
/** PageParams[Space] */
|
|
877
927
|
export interface IPageParamsSpace {
|
|
@@ -905,7 +955,7 @@ export interface IPageParamsSpace {
|
|
|
905
955
|
* Eq Conditions
|
|
906
956
|
* list of equality conditions, each as a dict with key and value
|
|
907
957
|
*/
|
|
908
|
-
eq_conditions?:
|
|
958
|
+
eq_conditions?: Record<string, any> | null;
|
|
909
959
|
}
|
|
910
960
|
/** PageParams[Task] */
|
|
911
961
|
export interface IPageParamsTask {
|
|
@@ -939,7 +989,7 @@ export interface IPageParamsTask {
|
|
|
939
989
|
* Eq Conditions
|
|
940
990
|
* list of equality conditions, each as a dict with key and value
|
|
941
991
|
*/
|
|
942
|
-
eq_conditions?:
|
|
992
|
+
eq_conditions?: Record<string, any> | null;
|
|
943
993
|
}
|
|
944
994
|
/** PageResponse[Chunk] */
|
|
945
995
|
export interface IPageResponseChunk {
|
|
@@ -980,6 +1030,19 @@ export interface IPageResponseSpaceResponse {
|
|
|
980
1030
|
/** Total Pages */
|
|
981
1031
|
total_pages: number;
|
|
982
1032
|
}
|
|
1033
|
+
/** PageResponse[Tenant] */
|
|
1034
|
+
export interface IPageResponseTenant {
|
|
1035
|
+
/** Items */
|
|
1036
|
+
items: ITenant[];
|
|
1037
|
+
/** Total */
|
|
1038
|
+
total: number;
|
|
1039
|
+
/** Page */
|
|
1040
|
+
page: number;
|
|
1041
|
+
/** Page Size */
|
|
1042
|
+
page_size: number;
|
|
1043
|
+
/** Total Pages */
|
|
1044
|
+
total_pages: number;
|
|
1045
|
+
}
|
|
983
1046
|
/** QACreate */
|
|
984
1047
|
export interface IQACreate {
|
|
985
1048
|
/**
|
|
@@ -1004,7 +1067,7 @@ export interface IQACreate {
|
|
|
1004
1067
|
* additional metadata, user can update it
|
|
1005
1068
|
* @default {}
|
|
1006
1069
|
*/
|
|
1007
|
-
metadata?:
|
|
1070
|
+
metadata?: Record<string, any>;
|
|
1008
1071
|
/** source type */
|
|
1009
1072
|
source_type: IKnowledgeSourceEnum;
|
|
1010
1073
|
/**
|
|
@@ -1033,7 +1096,7 @@ export interface IQACreate {
|
|
|
1033
1096
|
* answer of the knowledge resource
|
|
1034
1097
|
*/
|
|
1035
1098
|
answer: string;
|
|
1036
|
-
/** split config of the knowledge */
|
|
1099
|
+
/** split config of the knowledge, used to split the question into chunks */
|
|
1037
1100
|
split_config: ITextSplitConfig;
|
|
1038
1101
|
/** source config of the knowledge */
|
|
1039
1102
|
source_config?: ITextSourceConfig | null;
|
|
@@ -1047,6 +1110,14 @@ export interface IResponseModel {
|
|
|
1047
1110
|
/** Message */
|
|
1048
1111
|
message?: string | null;
|
|
1049
1112
|
}
|
|
1113
|
+
/** ResponseModel[Chunk] */
|
|
1114
|
+
export interface IResponseModelChunk {
|
|
1115
|
+
/** Success */
|
|
1116
|
+
success: boolean;
|
|
1117
|
+
data?: IChunk | null;
|
|
1118
|
+
/** Message */
|
|
1119
|
+
message?: string | null;
|
|
1120
|
+
}
|
|
1050
1121
|
/** ResponseModel[Knowledge] */
|
|
1051
1122
|
export interface IResponseModelKnowledge {
|
|
1052
1123
|
/** Success */
|
|
@@ -1115,6 +1186,14 @@ export interface IResponseModelPageResponseSpaceResponse {
|
|
|
1115
1186
|
/** Message */
|
|
1116
1187
|
message?: string | null;
|
|
1117
1188
|
}
|
|
1189
|
+
/** ResponseModel[PageResponse[Tenant]] */
|
|
1190
|
+
export interface IResponseModelPageResponseTenant {
|
|
1191
|
+
/** Success */
|
|
1192
|
+
success: boolean;
|
|
1193
|
+
data?: IPageResponseTenant | null;
|
|
1194
|
+
/** Message */
|
|
1195
|
+
message?: string | null;
|
|
1196
|
+
}
|
|
1118
1197
|
/** ResponseModel[SpaceResponse] */
|
|
1119
1198
|
export interface IResponseModelSpaceResponse {
|
|
1120
1199
|
/** Success */
|
|
@@ -1147,6 +1226,15 @@ export interface IResponseModelTenant {
|
|
|
1147
1226
|
/** Message */
|
|
1148
1227
|
message?: string | null;
|
|
1149
1228
|
}
|
|
1229
|
+
/** ResponseModel[object] */
|
|
1230
|
+
export interface IResponseModelObject {
|
|
1231
|
+
/** Success */
|
|
1232
|
+
success: boolean;
|
|
1233
|
+
/** Data */
|
|
1234
|
+
data?: null;
|
|
1235
|
+
/** Message */
|
|
1236
|
+
message?: string | null;
|
|
1237
|
+
}
|
|
1150
1238
|
/** RetrievalByKnowledgeRequest */
|
|
1151
1239
|
export interface IRetrievalByKnowledgeRequest {
|
|
1152
1240
|
/**
|
|
@@ -1176,7 +1264,7 @@ export interface IRetrievalByKnowledgeRequest {
|
|
|
1176
1264
|
* metadata filter
|
|
1177
1265
|
* @default {}
|
|
1178
1266
|
*/
|
|
1179
|
-
metadata_filter?:
|
|
1267
|
+
metadata_filter?: Record<string, any>;
|
|
1180
1268
|
/**
|
|
1181
1269
|
* Knowledge Id List
|
|
1182
1270
|
* knowledge id list
|
|
@@ -1212,7 +1300,7 @@ export interface IRetrievalBySpaceRequest {
|
|
|
1212
1300
|
* metadata filter
|
|
1213
1301
|
* @default {}
|
|
1214
1302
|
*/
|
|
1215
|
-
metadata_filter?:
|
|
1303
|
+
metadata_filter?: Record<string, any>;
|
|
1216
1304
|
/**
|
|
1217
1305
|
* Space Id List
|
|
1218
1306
|
* space id list
|
|
@@ -1260,7 +1348,7 @@ export interface IRetrievalChunk {
|
|
|
1260
1348
|
* Metadata
|
|
1261
1349
|
* Arbitrary metadata associated with the content.
|
|
1262
1350
|
*/
|
|
1263
|
-
metadata?:
|
|
1351
|
+
metadata?: Record<string, any> | null;
|
|
1264
1352
|
/**
|
|
1265
1353
|
* Gmt Create
|
|
1266
1354
|
* creation time
|
|
@@ -1429,7 +1517,7 @@ export interface ITask {
|
|
|
1429
1517
|
* Metadata
|
|
1430
1518
|
* Metadata for the task
|
|
1431
1519
|
*/
|
|
1432
|
-
metadata?:
|
|
1520
|
+
metadata?: Record<string, any> | null;
|
|
1433
1521
|
/**
|
|
1434
1522
|
* Error Message
|
|
1435
1523
|
* Error message (only present if the task failed)
|
|
@@ -1503,7 +1591,7 @@ export interface ITenant {
|
|
|
1503
1591
|
* Metadata
|
|
1504
1592
|
* Metadata for the tenant
|
|
1505
1593
|
*/
|
|
1506
|
-
metadata?:
|
|
1594
|
+
metadata?: Record<string, any> | null;
|
|
1507
1595
|
/**
|
|
1508
1596
|
* Gmt Create
|
|
1509
1597
|
* tenant created time
|
|
@@ -1520,7 +1608,20 @@ export interface ITenantCreate {
|
|
|
1520
1608
|
/** Tenant Name */
|
|
1521
1609
|
tenant_name: string;
|
|
1522
1610
|
/** Email */
|
|
1611
|
+
email: string;
|
|
1612
|
+
/** Metadata */
|
|
1613
|
+
metadata?: Record<string, any> | null;
|
|
1614
|
+
}
|
|
1615
|
+
/** TenantUpdate */
|
|
1616
|
+
export interface ITenantUpdate {
|
|
1617
|
+
/** Tenant Id */
|
|
1618
|
+
tenant_id: string;
|
|
1619
|
+
/** Tenant Name */
|
|
1620
|
+
tenant_name?: string | null;
|
|
1621
|
+
/** Email */
|
|
1523
1622
|
email?: string | null;
|
|
1623
|
+
/** Metadata */
|
|
1624
|
+
metadata?: Record<string, any> | null;
|
|
1524
1625
|
}
|
|
1525
1626
|
/** TextCreate */
|
|
1526
1627
|
export interface ITextCreate {
|
|
@@ -1546,7 +1647,7 @@ export interface ITextCreate {
|
|
|
1546
1647
|
* additional metadata, user can update it
|
|
1547
1648
|
* @default {}
|
|
1548
1649
|
*/
|
|
1549
|
-
metadata?:
|
|
1650
|
+
metadata?: Record<string, any>;
|
|
1550
1651
|
/** source type */
|
|
1551
1652
|
source_type: IKnowledgeSourceEnum;
|
|
1552
1653
|
/**
|
|
@@ -1591,13 +1692,14 @@ export interface ITextSourceConfig {
|
|
|
1591
1692
|
export interface ITextSplitConfig {
|
|
1592
1693
|
/**
|
|
1593
1694
|
* Chunk Size
|
|
1695
|
+
* chunk max size
|
|
1594
1696
|
* @min 1
|
|
1595
|
-
* @exclusiveMax 5000
|
|
1596
1697
|
* @default 1500
|
|
1597
1698
|
*/
|
|
1598
1699
|
chunk_size?: number;
|
|
1599
1700
|
/**
|
|
1600
1701
|
* Chunk Overlap
|
|
1702
|
+
* chunk overlap size, must be less than chunk_size
|
|
1601
1703
|
* @min 0
|
|
1602
1704
|
* @default 150
|
|
1603
1705
|
*/
|
|
@@ -1607,7 +1709,17 @@ export interface ITextSplitConfig {
|
|
|
1607
1709
|
* List of separators to split the text. If None, uses default separators
|
|
1608
1710
|
* @default ["\n\n"]
|
|
1609
1711
|
*/
|
|
1610
|
-
separators?: string[];
|
|
1712
|
+
separators?: string[] | null;
|
|
1713
|
+
/**
|
|
1714
|
+
* Split Regex
|
|
1715
|
+
* split_regex,if set, use it instead of separators
|
|
1716
|
+
*/
|
|
1717
|
+
split_regex?: string | null;
|
|
1718
|
+
/**
|
|
1719
|
+
* Type
|
|
1720
|
+
* @default "text"
|
|
1721
|
+
*/
|
|
1722
|
+
type?: "text";
|
|
1611
1723
|
/**
|
|
1612
1724
|
* Keep Separator
|
|
1613
1725
|
* Whether to keep the separator and where to place it in each corresponding chunk (True='start')
|
|
@@ -1712,14 +1824,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1712
1824
|
*/
|
|
1713
1825
|
addKnowledge: (data: (IKnowledgeCreate | ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
|
|
1714
1826
|
/**
|
|
1715
|
-
*
|
|
1827
|
+
* No description
|
|
1716
1828
|
*
|
|
1717
1829
|
* @tags knowledge
|
|
1718
1830
|
* @name UpdateKnowledge
|
|
1719
1831
|
* @summary Update Knowledge
|
|
1720
1832
|
* @request POST:/api/knowledge/update
|
|
1721
1833
|
*/
|
|
1722
|
-
updateKnowledge: (data: IKnowledgeInput
|
|
1834
|
+
updateKnowledge: (data: IKnowledgeInput, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
|
|
1723
1835
|
/**
|
|
1724
1836
|
* No description
|
|
1725
1837
|
*
|
|
@@ -1753,6 +1865,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1753
1865
|
/** Knowledge Id */
|
|
1754
1866
|
knowledge_id: string;
|
|
1755
1867
|
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
1868
|
+
/**
|
|
1869
|
+
* No description
|
|
1870
|
+
*
|
|
1871
|
+
* @tags knowledge
|
|
1872
|
+
* @name GetEmbeddingModelsList
|
|
1873
|
+
* @summary Get Embedding Models List
|
|
1874
|
+
* @request GET:/api/knowledge/embedding/models
|
|
1875
|
+
*/
|
|
1876
|
+
getEmbeddingModelsList: (params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
|
|
1756
1877
|
};
|
|
1757
1878
|
retrieval: {
|
|
1758
1879
|
/**
|
|
@@ -1837,6 +1958,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1837
1958
|
* @request POST:/api/chunk/list
|
|
1838
1959
|
*/
|
|
1839
1960
|
getChunkList: (data: IPageParamsChunk, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseChunk, void | IHTTPValidationError>>;
|
|
1961
|
+
/**
|
|
1962
|
+
* No description
|
|
1963
|
+
*
|
|
1964
|
+
* @tags chunk
|
|
1965
|
+
* @name DeleteChunkById
|
|
1966
|
+
* @summary Delete Chunk By Id
|
|
1967
|
+
* @request DELETE:/api/chunk/id/{id}/model_name/{model_name}
|
|
1968
|
+
*/
|
|
1969
|
+
deleteChunkById: (id: string, modelName: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelObject, void | IHTTPValidationError>>;
|
|
1970
|
+
/**
|
|
1971
|
+
* No description
|
|
1972
|
+
*
|
|
1973
|
+
* @tags chunk
|
|
1974
|
+
* @name GetChunkById
|
|
1975
|
+
* @summary Get Chunk By Id
|
|
1976
|
+
* @request GET:/api/chunk/id/{id}/model_name/{model_name}
|
|
1977
|
+
*/
|
|
1978
|
+
getChunkById: (id: string, modelName: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelChunk, void | IHTTPValidationError>>;
|
|
1979
|
+
/**
|
|
1980
|
+
* No description
|
|
1981
|
+
*
|
|
1982
|
+
* @tags chunk
|
|
1983
|
+
* @name SaveChunk
|
|
1984
|
+
* @summary Save Chunk
|
|
1985
|
+
* @request POST:/api/chunk/save
|
|
1986
|
+
*/
|
|
1987
|
+
saveChunk: (data: IChunkSave, params?: RequestParams) => Promise<HttpResponse<IResponseModelChunk, void | IHTTPValidationError>>;
|
|
1840
1988
|
};
|
|
1841
1989
|
tenant: {
|
|
1842
1990
|
/**
|
|
@@ -1848,6 +1996,53 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1848
1996
|
* @request POST:/api/tenant/create
|
|
1849
1997
|
*/
|
|
1850
1998
|
createTenant: (data: ITenantCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
1999
|
+
/**
|
|
2000
|
+
* No description
|
|
2001
|
+
*
|
|
2002
|
+
* @tags tenant
|
|
2003
|
+
* @name GetTenantById
|
|
2004
|
+
* @summary Query Tenant
|
|
2005
|
+
* @request GET:/api/tenant/id/{id}
|
|
2006
|
+
*/
|
|
2007
|
+
getTenantById: (id: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
2008
|
+
/**
|
|
2009
|
+
* No description
|
|
2010
|
+
*
|
|
2011
|
+
* @tags tenant
|
|
2012
|
+
* @name DeleteTenantById
|
|
2013
|
+
* @summary Delete Tenant
|
|
2014
|
+
* @request DELETE:/api/tenant/{id}
|
|
2015
|
+
*/
|
|
2016
|
+
deleteTenantById: (id: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelObject, void | IHTTPValidationError>>;
|
|
2017
|
+
/**
|
|
2018
|
+
* No description
|
|
2019
|
+
*
|
|
2020
|
+
* @tags tenant
|
|
2021
|
+
* @name UpdateTenant
|
|
2022
|
+
* @summary Update Tenant
|
|
2023
|
+
* @request POST:/api/tenant/update
|
|
2024
|
+
*/
|
|
2025
|
+
updateTenant: (data: ITenantUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
2026
|
+
/**
|
|
2027
|
+
* No description
|
|
2028
|
+
*
|
|
2029
|
+
* @tags tenant
|
|
2030
|
+
* @name GetTenantList
|
|
2031
|
+
* @summary Get Tenant List
|
|
2032
|
+
* @request GET:/api/tenant/list
|
|
2033
|
+
*/
|
|
2034
|
+
getTenantList: (query?: {
|
|
2035
|
+
/**
|
|
2036
|
+
* Page
|
|
2037
|
+
* @default 1
|
|
2038
|
+
*/
|
|
2039
|
+
page?: number;
|
|
2040
|
+
/**
|
|
2041
|
+
* Page Size
|
|
2042
|
+
* @default 10
|
|
2043
|
+
*/
|
|
2044
|
+
page_size?: number;
|
|
2045
|
+
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTenant, void | IHTTPValidationError>>;
|
|
1851
2046
|
/**
|
|
1852
2047
|
* No description
|
|
1853
2048
|
*
|
package/dist/api.js
CHANGED
|
@@ -47,9 +47,14 @@ var IKnowledgeTypeEnum;
|
|
|
47
47
|
IKnowledgeTypeEnum["Docx"] = "docx";
|
|
48
48
|
IKnowledgeTypeEnum["Pdf"] = "pdf";
|
|
49
49
|
IKnowledgeTypeEnum["Qa"] = "qa";
|
|
50
|
+
IKnowledgeTypeEnum["Yuquedoc"] = "yuquedoc";
|
|
51
|
+
IKnowledgeTypeEnum["OpenapiApp"] = "openapi_app";
|
|
50
52
|
IKnowledgeTypeEnum["Folder"] = "folder";
|
|
51
53
|
})(IKnowledgeTypeEnum || (exports.IKnowledgeTypeEnum = IKnowledgeTypeEnum = {}));
|
|
52
|
-
/**
|
|
54
|
+
/**
|
|
55
|
+
* KnowledgeSourceEnum
|
|
56
|
+
* Specifies the source of knowledge, which influences the behavior of the resource loader
|
|
57
|
+
*/
|
|
53
58
|
var IKnowledgeSourceEnum;
|
|
54
59
|
(function (IKnowledgeSourceEnum) {
|
|
55
60
|
IKnowledgeSourceEnum["GithubRepo"] = "github_repo";
|
|
@@ -226,7 +231,7 @@ class Api extends HttpClient {
|
|
|
226
231
|
*/
|
|
227
232
|
addKnowledge: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/add`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
228
233
|
/**
|
|
229
|
-
*
|
|
234
|
+
* No description
|
|
230
235
|
*
|
|
231
236
|
* @tags knowledge
|
|
232
237
|
* @name UpdateKnowledge
|
|
@@ -261,6 +266,15 @@ class Api extends HttpClient {
|
|
|
261
266
|
* @request DELETE:/api/knowledge/delete
|
|
262
267
|
*/
|
|
263
268
|
deleteKnowledge: (query, params = {}) => this.request(Object.assign({ path: `/api/knowledge/delete`, method: "DELETE", query: query, format: "json" }, params)),
|
|
269
|
+
/**
|
|
270
|
+
* No description
|
|
271
|
+
*
|
|
272
|
+
* @tags knowledge
|
|
273
|
+
* @name GetEmbeddingModelsList
|
|
274
|
+
* @summary Get Embedding Models List
|
|
275
|
+
* @request GET:/api/knowledge/embedding/models
|
|
276
|
+
*/
|
|
277
|
+
getEmbeddingModelsList: (params = {}) => this.request(Object.assign({ path: `/api/knowledge/embedding/models`, method: "GET", format: "json" }, params)),
|
|
264
278
|
};
|
|
265
279
|
this.retrieval = {
|
|
266
280
|
/**
|
|
@@ -339,6 +353,33 @@ class Api extends HttpClient {
|
|
|
339
353
|
* @request POST:/api/chunk/list
|
|
340
354
|
*/
|
|
341
355
|
getChunkList: (data, params = {}) => this.request(Object.assign({ path: `/api/chunk/list`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
356
|
+
/**
|
|
357
|
+
* No description
|
|
358
|
+
*
|
|
359
|
+
* @tags chunk
|
|
360
|
+
* @name DeleteChunkById
|
|
361
|
+
* @summary Delete Chunk By Id
|
|
362
|
+
* @request DELETE:/api/chunk/id/{id}/model_name/{model_name}
|
|
363
|
+
*/
|
|
364
|
+
deleteChunkById: (id, modelName, params = {}) => this.request(Object.assign({ path: `/api/chunk/id/${id}/model_name/${modelName}`, method: "DELETE", format: "json" }, params)),
|
|
365
|
+
/**
|
|
366
|
+
* No description
|
|
367
|
+
*
|
|
368
|
+
* @tags chunk
|
|
369
|
+
* @name GetChunkById
|
|
370
|
+
* @summary Get Chunk By Id
|
|
371
|
+
* @request GET:/api/chunk/id/{id}/model_name/{model_name}
|
|
372
|
+
*/
|
|
373
|
+
getChunkById: (id, modelName, params = {}) => this.request(Object.assign({ path: `/api/chunk/id/${id}/model_name/${modelName}`, method: "GET", format: "json" }, params)),
|
|
374
|
+
/**
|
|
375
|
+
* No description
|
|
376
|
+
*
|
|
377
|
+
* @tags chunk
|
|
378
|
+
* @name SaveChunk
|
|
379
|
+
* @summary Save Chunk
|
|
380
|
+
* @request POST:/api/chunk/save
|
|
381
|
+
*/
|
|
382
|
+
saveChunk: (data, params = {}) => this.request(Object.assign({ path: `/api/chunk/save`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
342
383
|
};
|
|
343
384
|
this.tenant = {
|
|
344
385
|
/**
|
|
@@ -350,6 +391,42 @@ class Api extends HttpClient {
|
|
|
350
391
|
* @request POST:/api/tenant/create
|
|
351
392
|
*/
|
|
352
393
|
createTenant: (data, params = {}) => this.request(Object.assign({ path: `/api/tenant/create`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
394
|
+
/**
|
|
395
|
+
* No description
|
|
396
|
+
*
|
|
397
|
+
* @tags tenant
|
|
398
|
+
* @name GetTenantById
|
|
399
|
+
* @summary Query Tenant
|
|
400
|
+
* @request GET:/api/tenant/id/{id}
|
|
401
|
+
*/
|
|
402
|
+
getTenantById: (id, params = {}) => this.request(Object.assign({ path: `/api/tenant/id/${id}`, method: "GET", format: "json" }, params)),
|
|
403
|
+
/**
|
|
404
|
+
* No description
|
|
405
|
+
*
|
|
406
|
+
* @tags tenant
|
|
407
|
+
* @name DeleteTenantById
|
|
408
|
+
* @summary Delete Tenant
|
|
409
|
+
* @request DELETE:/api/tenant/{id}
|
|
410
|
+
*/
|
|
411
|
+
deleteTenantById: (id, params = {}) => this.request(Object.assign({ path: `/api/tenant/${id}`, method: "DELETE", format: "json" }, params)),
|
|
412
|
+
/**
|
|
413
|
+
* No description
|
|
414
|
+
*
|
|
415
|
+
* @tags tenant
|
|
416
|
+
* @name UpdateTenant
|
|
417
|
+
* @summary Update Tenant
|
|
418
|
+
* @request POST:/api/tenant/update
|
|
419
|
+
*/
|
|
420
|
+
updateTenant: (data, params = {}) => this.request(Object.assign({ path: `/api/tenant/update`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
421
|
+
/**
|
|
422
|
+
* No description
|
|
423
|
+
*
|
|
424
|
+
* @tags tenant
|
|
425
|
+
* @name GetTenantList
|
|
426
|
+
* @summary Get Tenant List
|
|
427
|
+
* @request GET:/api/tenant/list
|
|
428
|
+
*/
|
|
429
|
+
getTenantList: (query, params = {}) => this.request(Object.assign({ path: `/api/tenant/list`, method: "GET", query: query, format: "json" }, params)),
|
|
353
430
|
/**
|
|
354
431
|
* No description
|
|
355
432
|
*
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@petercatai/whisker-client",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "Generated API client (
|
|
3
|
+
"version": "0.1.202504281028",
|
|
4
|
+
"description": "Generated API client (Production)",
|
|
5
5
|
"main": "dist/api.js",
|
|
6
6
|
"types": "dist/api.d.ts",
|
|
7
7
|
"files": [
|
|
@@ -13,11 +13,11 @@
|
|
|
13
13
|
},
|
|
14
14
|
"publishConfig": {
|
|
15
15
|
"access": "public",
|
|
16
|
-
"tag": "
|
|
16
|
+
"tag": "latest"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
"@types/node": "^22.
|
|
20
|
-
"axios": "^1.
|
|
19
|
+
"@types/node": "^22.15.2",
|
|
20
|
+
"axios": "^1.9.0",
|
|
21
21
|
"typescript": "^5.8.3"
|
|
22
22
|
}
|
|
23
23
|
}
|