@petercatai/whisker-client 0.0.1760329074-dev → 0.0.1760329155-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.
Files changed (3) hide show
  1. package/dist/api.d.ts +89 -329
  2. package/dist/api.js +55 -82
  3. package/package.json +1 -1
package/dist/api.d.ts CHANGED
@@ -127,14 +127,6 @@ export declare enum IKnowledgeSourceEnum {
127
127
  CloudStorageImage = "cloud_storage_image",
128
128
  Yuque = "yuque"
129
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
130
  /** Action */
139
131
  export declare enum IAction {
140
132
  Create = "create",
@@ -180,7 +172,7 @@ export interface IAPIKey {
180
172
  * Permissions
181
173
  * permissions config
182
174
  */
183
- permissions?: IPermission[];
175
+ permissions?: Record<string, any>[];
184
176
  /**
185
177
  * Rate Limit
186
178
  * rate limit per minute
@@ -231,29 +223,25 @@ export interface IAPIKeyCreate {
231
223
  }
232
224
  /** APIKeyUpdate */
233
225
  export interface IAPIKeyUpdate {
234
- /**
235
- * Key Name
236
- * @default ""
237
- */
238
- key_name?: string;
226
+ /** Key Id */
227
+ key_id: string;
228
+ /** Key Name */
229
+ key_name?: string | null;
239
230
  /** Description */
240
231
  description?: string | null;
241
232
  /** Permissions */
242
- permissions?: IPermission[];
243
- /**
244
- * Rate Limit
245
- * @default 0
246
- */
233
+ permissions?: IPermission[] | null;
234
+ /** Rate Limit */
247
235
  rate_limit?: number | null;
248
236
  /**
249
237
  * Expires At
250
238
  * Expiration time in ISO8601 format with timezone (e.g., 2024-12-31T23:59:59+00:00)
251
239
  */
252
240
  expires_at?: string | null;
241
+ /** Is Active */
242
+ is_active?: boolean | null;
253
243
  /** Metadata */
254
244
  metadata?: Record<string, any> | null;
255
- /** Key Id */
256
- key_id: string;
257
245
  }
258
246
  /** ActiveStatusUpdate */
259
247
  export interface IActiveStatusUpdate {
@@ -356,11 +344,6 @@ export interface IArtifactSpaceUpdate {
356
344
  /** New Space Id */
357
345
  new_space_id: string;
358
346
  }
359
- /** Audio */
360
- export interface IAudio {
361
- /** Id */
362
- id: string;
363
- }
364
347
  /**
365
348
  * BaseCharSplitConfig
366
349
  * Base char split configuration class
@@ -418,108 +401,6 @@ export interface IBaseCodeSplitConfig {
418
401
  */
419
402
  chunk_overlap?: number;
420
403
  }
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
404
  /** Chunk */
524
405
  export interface IChunk {
525
406
  /**
@@ -572,7 +453,7 @@ export interface IChunk {
572
453
  * Embedding Model Name
573
454
  * name of the embedding model
574
455
  */
575
- embedding_model_name?: string;
456
+ embedding_model_name: string;
576
457
  /**
577
458
  * Metadata
578
459
  * Arbitrary metadata associated with the content.
@@ -621,11 +502,23 @@ export interface IChunkSave {
621
502
  embedding_model_name: string;
622
503
  /** Metadata */
623
504
  metadata?: Record<string, any> | null;
505
+ /** Tags */
506
+ tags?: string[] | null;
507
+ /** F1 */
508
+ f1?: string | null;
509
+ /** F2 */
510
+ f2?: string | null;
511
+ /** F3 */
512
+ f3?: string | null;
513
+ /** F4 */
514
+ f4?: string | null;
515
+ /** F5 */
516
+ f5?: string | null;
624
517
  }
625
518
  /** ChunkUpdate */
626
519
  export interface IChunkUpdate {
627
520
  /** Chunk Id */
628
- chunk_id?: string;
521
+ chunk_id?: string | null;
629
522
  /** Context */
630
523
  context?: string | null;
631
524
  /** Embedding Model Name */
@@ -642,13 +535,6 @@ export interface ICondition {
642
535
  /** Value */
643
536
  value: any;
644
537
  }
645
- /** Custom */
646
- export interface ICustom {
647
- /** Input */
648
- input: string;
649
- /** Name */
650
- name: string;
651
- }
652
538
  /** EnableStatusUpdate */
653
539
  export interface IEnableStatusUpdate {
654
540
  /** Knowledge Id */
@@ -656,41 +542,12 @@ export interface IEnableStatusUpdate {
656
542
  /** Status */
657
543
  status: boolean;
658
544
  }
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
545
  /** FilterGroup */
675
546
  export interface IFilterGroup {
676
547
  operator: IOperator;
677
548
  /** Conditions */
678
549
  conditions: (ICondition | IFilterGroup)[];
679
550
  }
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
551
  /**
695
552
  * GeaGraphSplitConfig
696
553
  * JSON document split configuration
@@ -772,9 +629,8 @@ export interface IGithubRepoCreate {
772
629
  /**
773
630
  * Embedding Model Name
774
631
  * name of the embedding model. you can set any other model if target embedding service registered
775
- * @default "openai"
776
632
  */
777
- embedding_model_name?: IEmbeddingModelEnum | string;
633
+ embedding_model_name: string;
778
634
  /**
779
635
  * File Sha
780
636
  * SHA of the file
@@ -922,9 +778,8 @@ export interface IImageCreate {
922
778
  /**
923
779
  * Embedding Model Name
924
780
  * name of the embedding model. you can set any other model if target embedding service registered
925
- * @default "openai"
926
781
  */
927
- embedding_model_name?: IEmbeddingModelEnum | string;
782
+ embedding_model_name: string;
928
783
  /**
929
784
  * File Sha
930
785
  * SHA of the file, if source_type is cloud_storage_text, this field is the sha of the text file
@@ -959,20 +814,6 @@ export interface IImageSplitConfig {
959
814
  */
960
815
  type?: "image";
961
816
  }
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
817
  /** JSONCreate */
977
818
  export interface IJSONCreate {
978
819
  /**
@@ -1003,9 +844,8 @@ export interface IJSONCreate {
1003
844
  /**
1004
845
  * Embedding Model Name
1005
846
  * name of the embedding model. you can set any other model if target embedding service registered
1006
- * @default "openai"
1007
847
  */
1008
- embedding_model_name?: IEmbeddingModelEnum | string;
848
+ embedding_model_name: string;
1009
849
  /**
1010
850
  * File Sha
1011
851
  * SHA of the file
@@ -1105,9 +945,8 @@ export interface IKnowledgeInput {
1105
945
  /**
1106
946
  * Embedding Model Name
1107
947
  * name of the embedding model. you can set any other model if target embedding service registered
1108
- * @default "openai"
1109
948
  */
1110
- embedding_model_name?: IEmbeddingModelEnum | string;
949
+ embedding_model_name: string;
1111
950
  /**
1112
951
  * Split Config
1113
952
  * configuration for splitting the knowledge
@@ -1193,7 +1032,7 @@ export interface IKnowledgeOutput {
1193
1032
  * Embedding Model Name
1194
1033
  * name of the embedding model. you can set any other model if target embedding service registered
1195
1034
  */
1196
- embedding_model_name?: string;
1035
+ embedding_model_name: string;
1197
1036
  /**
1198
1037
  * Split Config
1199
1038
  * configuration for splitting the knowledge
@@ -1232,13 +1071,6 @@ export interface IKnowledgeOutput {
1232
1071
  */
1233
1072
  enabled?: boolean;
1234
1073
  }
1235
- /** KnowledgeScope */
1236
- export interface IKnowledgeScope {
1237
- /** Space Ids */
1238
- space_ids?: string[] | null;
1239
- /** Auth Info */
1240
- auth_info: string;
1241
- }
1242
1074
  /** MarkdownCreate */
1243
1075
  export interface IMarkdownCreate {
1244
1076
  /**
@@ -1269,9 +1101,8 @@ export interface IMarkdownCreate {
1269
1101
  /**
1270
1102
  * Embedding Model Name
1271
1103
  * name of the embedding model. you can set any other model if target embedding service registered
1272
- * @default "openai"
1273
1104
  */
1274
- embedding_model_name?: IEmbeddingModelEnum | string;
1105
+ embedding_model_name: string;
1275
1106
  /**
1276
1107
  * File Sha
1277
1108
  * SHA of the file
@@ -1395,9 +1226,8 @@ export interface IPDFCreate {
1395
1226
  /**
1396
1227
  * Embedding Model Name
1397
1228
  * name of the embedding model. you can set any other model if target embedding service registered
1398
- * @default "openai"
1399
1229
  */
1400
- embedding_model_name?: IEmbeddingModelEnum | string;
1230
+ embedding_model_name: string;
1401
1231
  /**
1402
1232
  * File Sha
1403
1233
  * SHA of the file
@@ -1874,53 +1704,6 @@ export interface IPermission {
1874
1704
  /** Conditions */
1875
1705
  conditions?: Record<string, any> | null;
1876
1706
  }
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
1707
  /** QACreate */
1925
1708
  export interface IQACreate {
1926
1709
  /**
@@ -1955,9 +1738,8 @@ export interface IQACreate {
1955
1738
  /**
1956
1739
  * Embedding Model Name
1957
1740
  * name of the embedding model. you can set any other model if target embedding service registered
1958
- * @default "openai"
1959
1741
  */
1960
- embedding_model_name?: IEmbeddingModelEnum | string;
1742
+ embedding_model_name: string;
1961
1743
  /**
1962
1744
  * File Sha
1963
1745
  * SHA of the file
@@ -2246,7 +2028,7 @@ export interface IRetrievalByKnowledgeRequest {
2246
2028
  * Embedding Model Name
2247
2029
  * The name of the embedding model
2248
2030
  */
2249
- embedding_model_name: IEmbeddingModelEnum | string;
2031
+ embedding_model_name: string;
2250
2032
  /**
2251
2033
  * Similarity Threshold
2252
2034
  * The similarity threshold, ranging from 0.0 to 1.0.
@@ -2285,7 +2067,7 @@ export interface IRetrievalBySpaceRequest {
2285
2067
  * Embedding Model Name
2286
2068
  * The name of the embedding model
2287
2069
  */
2288
- embedding_model_name: IEmbeddingModelEnum | string;
2070
+ embedding_model_name: string;
2289
2071
  /**
2290
2072
  * Similarity Threshold
2291
2073
  * The similarity threshold, ranging from 0.0 to 1.0.
@@ -2370,7 +2152,7 @@ export interface IRetrievalChunk {
2370
2152
  * Embedding Model Name
2371
2153
  * name of the embedding model
2372
2154
  */
2373
- embedding_model_name?: string;
2155
+ embedding_model_name: string;
2374
2156
  /**
2375
2157
  * Metadata
2376
2158
  * Arbitrary metadata associated with the content.
@@ -2900,8 +2682,6 @@ export interface ITenantLogQuery {
2900
2682
  }
2901
2683
  /** TenantUpdate */
2902
2684
  export interface ITenantUpdate {
2903
- /** Tenant Id */
2904
- tenant_id: string;
2905
2685
  /** Tenant Name */
2906
2686
  tenant_name?: string | null;
2907
2687
  /** Email */
@@ -2939,9 +2719,8 @@ export interface ITextCreate {
2939
2719
  /**
2940
2720
  * Embedding Model Name
2941
2721
  * name of the embedding model. you can set any other model if target embedding service registered
2942
- * @default "openai"
2943
2722
  */
2944
- embedding_model_name?: IEmbeddingModelEnum | string;
2723
+ embedding_model_name: string;
2945
2724
  /**
2946
2725
  * File Sha
2947
2726
  * SHA of the file
@@ -3065,9 +2844,8 @@ export interface IYuqueCreate {
3065
2844
  /**
3066
2845
  * Embedding Model Name
3067
2846
  * name of the embedding model. you can set any other model if target embedding service registered
3068
- * @default "openai"
3069
2847
  */
3070
- embedding_model_name?: IEmbeddingModelEnum | string;
2848
+ embedding_model_name: string;
3071
2849
  /**
3072
2850
  * File Sha
3073
2851
  * SHA of the file
@@ -3229,7 +3007,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3229
3007
  homePageGet: (params?: RequestParams) => Promise<HttpResponse<any, any>>;
3230
3008
  knowledge: {
3231
3009
  /**
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."
3010
+ * @description 添加知识 使用DDD架构创建新的知识,禁止重复的file_sha条目。 通过TaskCoordinationService统一协调知识创建和任务执行,确保事务一致性。
3233
3011
  *
3234
3012
  * @tags knowledge
3235
3013
  * @name AddKnowledge
@@ -3238,7 +3016,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3238
3016
  */
3239
3017
  addKnowledge: (data: (ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate | IYuqueCreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
3240
3018
  /**
3241
- * No description
3019
+ * @description 更新知识 使用DDD架构更新知识信息,支持元数据和状态更新。
3242
3020
  *
3243
3021
  * @tags knowledge
3244
3022
  * @name UpdateKnowledge
@@ -3247,7 +3025,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3247
3025
  */
3248
3026
  updateKnowledge: (data: IKnowledgeInput, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
3249
3027
  /**
3250
- * No description
3028
+ * @description 更新知识启用状态 使用DDD架构更新知识的启用状态。
3251
3029
  *
3252
3030
  * @tags knowledge
3253
3031
  * @name UpdateKnowledgeEnableStatus
@@ -3256,7 +3034,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3256
3034
  */
3257
3035
  updateKnowledgeEnableStatus: (data: IEnableStatusUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
3258
3036
  /**
3259
- * No description
3037
+ * @description 获取知识列表 使用DDD架构的KnowledgeService进行分页查询,支持条件过滤和排序。
3260
3038
  *
3261
3039
  * @tags knowledge
3262
3040
  * @name GetKnowledgeList
@@ -3265,7 +3043,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3265
3043
  */
3266
3044
  getKnowledgeList: (data: IPageQueryParamsKnowledge, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseKnowledge, void | IHTTPValidationError>>;
3267
3045
  /**
3268
- * No description
3046
+ * @description 根据ID获取知识详情 使用DDD架构获取知识详细信息。
3269
3047
  *
3270
3048
  * @tags knowledge
3271
3049
  * @name GetKnowledgeById
@@ -3277,7 +3055,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3277
3055
  knowledge_id: string;
3278
3056
  }, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
3279
3057
  /**
3280
- * @description Deletes a knowledge entry by its ID.
3058
+ * @description 删除知识 包括级联删除相关的任务和向量数据。
3281
3059
  *
3282
3060
  * @tags knowledge
3283
3061
  * @name DeleteKnowledge
@@ -3297,15 +3075,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3297
3075
  * @request GET:/api/knowledge/embedding/models
3298
3076
  */
3299
3077
  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
3078
  };
3310
3079
  retrieval: {
3311
3080
  /**
@@ -3318,7 +3087,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3318
3087
  */
3319
3088
  retrieveKnowledgeContent: (data: IRetrievalByKnowledgeRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListRetrievalChunk, void | IHTTPValidationError>>;
3320
3089
  /**
3321
- * @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id.
3090
+ * @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id. 使用DDD架构的RetrievalService进行空间检索。
3322
3091
  *
3323
3092
  * @tags retrieval
3324
3093
  * @name RetrieveSpaceContent
@@ -3327,7 +3096,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3327
3096
  */
3328
3097
  retrieveSpaceContent: (data: IRetrievalBySpaceRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListRetrievalChunk, void | IHTTPValidationError>>;
3329
3098
  /**
3330
- * @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id.
3099
+ * @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id. 使用DDD架构的RetrievalService进行检索。
3331
3100
  *
3332
3101
  * @tags retrieval
3333
3102
  * @name Retrieve
@@ -3338,7 +3107,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3338
3107
  };
3339
3108
  task: {
3340
3109
  /**
3341
- * No description
3110
+ * @description 重启任务 使用DDD架构的TaskService进行任务重启并执行。
3342
3111
  *
3343
3112
  * @tags task
3344
3113
  * @name RestartTask
@@ -3347,7 +3116,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3347
3116
  */
3348
3117
  restartTask: (data: ITaskRestartRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListTask, void | IHTTPValidationError>>;
3349
3118
  /**
3350
- * No description
3119
+ * @description 取消任务 使用DDD架构的TaskService进行任务取消。
3351
3120
  *
3352
3121
  * @tags task
3353
3122
  * @name CancelTask
@@ -3356,7 +3125,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3356
3125
  */
3357
3126
  cancelTask: (data: ITaskRestartRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListTask, void | IHTTPValidationError>>;
3358
3127
  /**
3359
- * No description
3128
+ * @description 获取任务列表 使用DDD架构的TaskService进行分页查询。
3360
3129
  *
3361
3130
  * @tags task
3362
3131
  * @name GetTaskList
@@ -3365,7 +3134,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3365
3134
  */
3366
3135
  getTaskList: (data: IPageQueryParamsTask, params?: RequestParams) => Promise<HttpResponse<IResponseModelStatusStatisticsPageResponseTask, void | IHTTPValidationError>>;
3367
3136
  /**
3368
- * No description
3137
+ * @description 获取任务详情 使用DDD架构的TaskService获取任务详情。
3369
3138
  *
3370
3139
  * @tags task
3371
3140
  * @name GetTaskDetail
@@ -3377,7 +3146,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3377
3146
  task_id: string;
3378
3147
  }, params?: RequestParams) => Promise<HttpResponse<IResponseModelTask, void | IHTTPValidationError>>;
3379
3148
  /**
3380
- * No description
3149
+ * @description 删除任务 使用DDD架构的TaskService进行任务删除。
3381
3150
  *
3382
3151
  * @tags task
3383
3152
  * @name DeleteTaskById
@@ -3391,7 +3160,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3391
3160
  };
3392
3161
  chunk: {
3393
3162
  /**
3394
- * No description
3163
+ * @description 获取Chunk列表
3395
3164
  *
3396
3165
  * @tags chunk
3397
3166
  * @name GetChunkList
@@ -3400,7 +3169,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3400
3169
  */
3401
3170
  getChunkList: (data: IPageQueryParamsChunk, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseChunk, void | IHTTPValidationError>>;
3402
3171
  /**
3403
- * No description
3172
+ * @description 根据ID删除Chunk 使用DDD架构删除指定的Chunk。
3404
3173
  *
3405
3174
  * @tags chunk
3406
3175
  * @name DeleteChunkById
@@ -3409,7 +3178,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3409
3178
  */
3410
3179
  deleteChunkById: (id: string, modelName: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelObject, void | IHTTPValidationError>>;
3411
3180
  /**
3412
- * No description
3181
+ * @description 根据ID获取Chunk 使用DDD架构获取指定的Chunk详情。
3413
3182
  *
3414
3183
  * @tags chunk
3415
3184
  * @name GetChunkById
@@ -3418,7 +3187,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3418
3187
  */
3419
3188
  getChunkById: (id: string, modelName: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelChunk, void | IHTTPValidationError>>;
3420
3189
  /**
3421
- * No description
3190
+ * @description 添加Chunk 使用DDD架构创建新的Chunk。
3422
3191
  *
3423
3192
  * @tags chunk
3424
3193
  * @name AddChunk
@@ -3427,7 +3196,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3427
3196
  */
3428
3197
  addChunk: (data: IChunkSave, params?: RequestParams) => Promise<HttpResponse<IResponseModelChunk, void | IHTTPValidationError>>;
3429
3198
  /**
3430
- * No description
3199
+ * @description 更新Chunk 使用DDD架构更新指定的Chunk。
3431
3200
  *
3432
3201
  * @tags chunk
3433
3202
  * @name UpdateChunk
@@ -3438,7 +3207,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3438
3207
  };
3439
3208
  tenant: {
3440
3209
  /**
3441
- * No description
3210
+ * @description 创建租户
3442
3211
  *
3443
3212
  * @tags tenant
3444
3213
  * @name CreateTenant
@@ -3447,7 +3216,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3447
3216
  */
3448
3217
  createTenant: (data: ITenantCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
3449
3218
  /**
3450
- * No description
3219
+ * @description 根据ID查询租户
3451
3220
  *
3452
3221
  * @tags tenant
3453
3222
  * @name GetTenantById
@@ -3456,7 +3225,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3456
3225
  */
3457
3226
  getTenantById: (id: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
3458
3227
  /**
3459
- * No description
3228
+ * @description 删除租户
3460
3229
  *
3461
3230
  * @tags tenant
3462
3231
  * @name DeleteTenantById
@@ -3465,7 +3234,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3465
3234
  */
3466
3235
  deleteTenantById: (id: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelObject, void | IHTTPValidationError>>;
3467
3236
  /**
3468
- * No description
3237
+ * @description 更新租户
3469
3238
  *
3470
3239
  * @tags tenant
3471
3240
  * @name UpdateTenant
@@ -3474,7 +3243,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3474
3243
  */
3475
3244
  updateTenant: (data: ITenantUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
3476
3245
  /**
3477
- * No description
3246
+ * @description 获取租户列表
3478
3247
  *
3479
3248
  * @tags tenant
3480
3249
  * @name GetTenantList
@@ -3494,18 +3263,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3494
3263
  page_size?: number;
3495
3264
  }, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTenant, void | IHTTPValidationError>>;
3496
3265
  /**
3497
- * No description
3266
+ * @description 获取当前租户信息 直接返回认证系统中的租户信息。 get_tenant_with_permissions 已经包含了完整的认证和权限检查。
3498
3267
  *
3499
3268
  * @tags tenant
3500
3269
  * @name GetTenant
3501
3270
  * @summary Get Tenant
3502
3271
  * @request GET:/api/tenant/me
3503
3272
  */
3504
- getTenant: (params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
3273
+ getTenant: (params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
3505
3274
  };
3506
3275
  space: {
3507
3276
  /**
3508
- * No description
3277
+ * @description 获取空间列表 使用DDD架构的SpaceService进行分页查询,支持条件过滤和排序。
3509
3278
  *
3510
3279
  * @tags space
3511
3280
  * @name GetSpaceList
@@ -3514,7 +3283,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3514
3283
  */
3515
3284
  getSpaceList: (data: IPageQueryParamsSpace, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseSpaceResponse, void | IHTTPValidationError>>;
3516
3285
  /**
3517
- * No description
3286
+ * @description 创建空间,使用DDD架构创建新的空间,支持KIS集成和元数据配置。
3518
3287
  *
3519
3288
  * @tags space
3520
3289
  * @name AddSpace
@@ -3523,7 +3292,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3523
3292
  */
3524
3293
  addSpace: (data: ISpaceCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelSpaceResponse, void | IHTTPValidationError>>;
3525
3294
  /**
3526
- * No description
3295
+ * @description 删除空间,包括级联删除相关的知识、任务和向量数据。
3527
3296
  *
3528
3297
  * @tags space
3529
3298
  * @name DeleteSpace
@@ -3532,7 +3301,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3532
3301
  */
3533
3302
  deleteSpace: (spaceId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
3534
3303
  /**
3535
- * No description
3304
+ * @description 更新空间 使用DDD架构更新空间信息,支持KIS集成配置更新。
3536
3305
  *
3537
3306
  * @tags space
3538
3307
  * @name UpdateSpace
@@ -3541,7 +3310,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3541
3310
  */
3542
3311
  updateSpace: (spaceId: string, data: ISpaceCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelSpaceResponse, void | IHTTPValidationError>>;
3543
3312
  /**
3544
- * No description
3313
+ * @description 根据ID获取空间详情 使用DDD架构获取空间详细信息,包括统计数据。
3545
3314
  *
3546
3315
  * @tags space
3547
3316
  * @name GetSpaceById
@@ -3552,7 +3321,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3552
3321
  };
3553
3322
  v1: {
3554
3323
  /**
3555
- * No description
3324
+ * @description 获取系统全局统计信息 使用DDD架构的DashboardService获取系统级别的统计数据。
3556
3325
  *
3557
3326
  * @tags dashboard
3558
3327
  * @name GetGlobalInfo
@@ -3561,23 +3330,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3561
3330
  */
3562
3331
  getGlobalInfo: (params?: RequestParams) => Promise<HttpResponse<IResponseModelGlobalInfo, void>>;
3563
3332
  /**
3564
- * No description
3333
+ * @description 获取租户日志 使用DDD架构的DashboardService获取租户级别的日志数据。 注意:改为POST方法以支持复杂的查询参数。
3565
3334
  *
3566
3335
  * @tags dashboard
3567
3336
  * @name GetTenantLog
3568
3337
  * @summary Get Tenant Log
3569
- * @request GET:/api/v1/dashboard/tenant_log
3338
+ * @request POST:/api/v1/dashboard/tenant_log
3570
3339
  */
3571
3340
  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
3341
  /**
3582
3342
  * @description whisker 通用 webhook
3583
3343
  *
@@ -3588,7 +3348,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3588
3348
  */
3589
3349
  handleWebhookApiV1WebhookWebhookTypeSourceAuthInfoKnowledgeBaseIdPost: (webhookType: string, source: string, authInfo: string, knowledgeBaseId: string, data: Record<string, any>, params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
3590
3350
  /**
3591
- * No description
3351
+ * @description 分页获取标签关联列表 使用DDD架构的TaggingService进行分页查询。
3592
3352
  *
3593
3353
  * @tags tagging
3594
3354
  * @name GetTaggingList
@@ -3597,7 +3357,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3597
3357
  */
3598
3358
  getTaggingList: (data: IPageQueryParamsTagging, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTagging, void | IHTTPValidationError>>;
3599
3359
  /**
3600
- * No description
3360
+ * @description 批量新增标签关联 使用DDD架构创建新的标签关联列表。
3601
3361
  *
3602
3362
  * @tags tagging
3603
3363
  * @name AddTaggingList
@@ -3606,7 +3366,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3606
3366
  */
3607
3367
  addTaggingList: (data: ITaggingCreate[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListTagging, void | IHTTPValidationError>>;
3608
3368
  /**
3609
- * No description
3369
+ * @description 删除标签关联 使用DDD架构删除标签关联记录。
3610
3370
  *
3611
3371
  * @tags tagging
3612
3372
  * @name DeleteTaggingById
@@ -3624,7 +3384,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3624
3384
  */
3625
3385
  getTagList: (data: IPageQueryParamsTag, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTag, void | IHTTPValidationError>>;
3626
3386
  /**
3627
- * @description 批量新增标签 注意:根据接口定义,DB 插件方法签名为 add_tag_list(tag_list: List[TagCreate]), 因此此处直接传入 body。若 TagCreate 需要携带 tenant_id,应由模型或插件内部处理。
3387
+ * @description 批量新增标签
3628
3388
  *
3629
3389
  * @tags tag
3630
3390
  * @name AddTagList
@@ -3642,7 +3402,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3642
3402
  */
3643
3403
  getTagById: (tagId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelTag, void | IHTTPValidationError>>;
3644
3404
  /**
3645
- * No description
3405
+ * @description 删除标签
3646
3406
  *
3647
3407
  * @tags tag
3648
3408
  * @name DeleteTagById
@@ -3651,7 +3411,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3651
3411
  */
3652
3412
  deleteTagById: (tagId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
3653
3413
  /**
3654
- * No description
3414
+ * @description 更新标签
3655
3415
  *
3656
3416
  * @tags tag
3657
3417
  * @name UpdateTag
@@ -3660,7 +3420,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3660
3420
  */
3661
3421
  updateTag: (data: ITagUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTag, void | IHTTPValidationError>>;
3662
3422
  /**
3663
- * No description
3423
+ * @description 分页获取工件列表 使用DDD架构的ArtifactService进行分页查询。
3664
3424
  *
3665
3425
  * @tags artifact
3666
3426
  * @name GetArtifactList
@@ -3669,7 +3429,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3669
3429
  */
3670
3430
  getArtifactList: (data: IPageQueryParamsArtifactIndex, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseArtifactIndex, void | IHTTPValidationError>>;
3671
3431
  /**
3672
- * No description
3432
+ * @description 批量新增工件 使用DDD架构创建新的工件列表。
3673
3433
  *
3674
3434
  * @tags artifact
3675
3435
  * @name AddArtifactList
@@ -3678,7 +3438,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3678
3438
  */
3679
3439
  addArtifactList: (data: IArtifactIndexCreate[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListArtifactIndex, void | IHTTPValidationError>>;
3680
3440
  /**
3681
- * No description
3441
+ * @description 获取工件详情 使用DDD架构获取工件详细信息。
3682
3442
  *
3683
3443
  * @tags artifact
3684
3444
  * @name GetArtifactById
@@ -3687,7 +3447,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3687
3447
  */
3688
3448
  getArtifactById: (artifactId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelArtifactIndex, void | IHTTPValidationError>>;
3689
3449
  /**
3690
- * No description
3450
+ * @description 删除工件 使用DDD架构删除工件记录。
3691
3451
  *
3692
3452
  * @tags artifact
3693
3453
  * @name DeleteArtifactById
@@ -3696,18 +3456,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3696
3456
  */
3697
3457
  deleteArtifactById: (artifactId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
3698
3458
  /**
3699
- * No description
3459
+ * @description 更新工件空间绑定 使用DDD架构更新工件的空间关联。
3700
3460
  *
3701
3461
  * @tags artifact
3702
3462
  * @name UpdateArtifactSpaceId
3703
3463
  * @summary Update Artifact Space Id
3704
- * @request POST:/api/v1/artifact/update_space
3464
+ * @request POST:/api/v1/artifact/update/space_id
3705
3465
  */
3706
3466
  updateArtifactSpaceId: (data: IArtifactSpaceUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelArtifactIndex, void | IHTTPValidationError>>;
3707
3467
  };
3708
3468
  rule: {
3709
3469
  /**
3710
- * No description
3470
+ * @description 获取租户全局规则 使用DDD架构的RuleService获取租户级别的规则配置。
3711
3471
  *
3712
3472
  * @tags rule
3713
3473
  * @name GetGlobalRule
@@ -3716,7 +3476,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3716
3476
  */
3717
3477
  getGlobalRule: (params?: RequestParams) => Promise<HttpResponse<IResponseModelStr, void | IHTTPValidationError>>;
3718
3478
  /**
3719
- * No description
3479
+ * @description 获取空间规则 使用DDD架构的RuleService获取空间级别的规则配置。
3720
3480
  *
3721
3481
  * @tags rule
3722
3482
  * @name GetSpaceRule
@@ -3727,7 +3487,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3727
3487
  };
3728
3488
  apiKey: {
3729
3489
  /**
3730
- * No description
3490
+ * @description 创建API Key
3731
3491
  *
3732
3492
  * @tags api key
3733
3493
  * @name CreateApiKey
@@ -3736,7 +3496,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3736
3496
  */
3737
3497
  createApiKey: (data: IAPIKeyCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelAPIKey, void | IHTTPValidationError>>;
3738
3498
  /**
3739
- * No description
3499
+ * @description 更新API Key
3740
3500
  *
3741
3501
  * @tags api key
3742
3502
  * @name UpdateApiKey
@@ -3745,7 +3505,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3745
3505
  */
3746
3506
  updateApiKey: (data: IAPIKeyUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelAPIKey, void | IHTTPValidationError>>;
3747
3507
  /**
3748
- * No description
3508
+ * @description 获取API Key列表
3749
3509
  *
3750
3510
  * @tags api key
3751
3511
  * @name GetApiKeyList
@@ -3754,7 +3514,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3754
3514
  */
3755
3515
  getApiKeyList: (data: IPageQueryParamsAPIKey, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseAPIKey, void | IHTTPValidationError>>;
3756
3516
  /**
3757
- * No description
3517
+ * @description 删除API Key
3758
3518
  *
3759
3519
  * @tags api key
3760
3520
  * @name DeleteApiKey
@@ -3763,7 +3523,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3763
3523
  */
3764
3524
  deleteApiKey: (keyId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
3765
3525
  /**
3766
- * No description
3526
+ * @description 更改API Key激活状态
3767
3527
  *
3768
3528
  * @tags api key
3769
3529
  * @name DeactivateApiKey
@@ -3772,7 +3532,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3772
3532
  */
3773
3533
  deactivateApiKey: (keyId: string, data: IActiveStatusUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
3774
3534
  /**
3775
- * No description
3535
+ * @description 获取所有过期的API Key
3776
3536
  *
3777
3537
  * @tags api key
3778
3538
  * @name GetAllExpiredApiKeys