-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathknowledgebase.py
More file actions
922 lines (784 loc) · 33.4 KB
/
Copy pathknowledgebase.py
File metadata and controls
922 lines (784 loc) · 33.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
"""
This file is auto generated by the code generation script.
Do not modify this file manually.
Use the `make codegen` command to regenerate.
当前文件为自动生成的控制 API 客户端代码。请勿手动修改此文件。
使用 `make codegen` 命令重新生成。
source: agentrun/knowledgebase/__knowledgebase_async_template.py
KnowledgeBase 高层 API / KnowledgeBase High-Level API
此模块定义知识库资源的高级API。
This module defines the high-level API for knowledge base resources.
"""
import asyncio
from typing import Any, Dict, List, Optional
from agentrun.utils.config import Config
from agentrun.utils.log import logger
from agentrun.utils.model import PageableInput
from agentrun.utils.resource import ResourceBase
from .api.data import get_data_api
from .model import (
ADBProviderSettings,
ADBRetrieveSettings,
BailianProviderSettings,
BailianRetrieveSettings,
KnowledgeBaseCreateInput,
KnowledgeBaseImmutableProps,
KnowledgeBaseListInput,
KnowledgeBaseListOutput,
KnowledgeBaseMutableProps,
KnowledgeBaseProvider,
KnowledgeBaseSystemProps,
KnowledgeBaseUpdateInput,
OTSDenseVectorSearchConfig,
OTSEmbeddingConfiguration,
OTSFullTextSearchConfig,
OTSMetadataField,
OTSModelConfig,
OTSProviderSettings,
OTSRerankingConfig,
OTSRetrieveSettings,
OTSRRFConfig,
OTSWeightConfig,
RagFlowProviderSettings,
RagFlowRetrieveSettings,
RetrieveInput,
)
class KnowledgeBase(
KnowledgeBaseMutableProps,
KnowledgeBaseImmutableProps,
KnowledgeBaseSystemProps,
ResourceBase,
):
"""知识库资源 / KnowledgeBase Resource
提供知识库的完整生命周期管理,包括创建、删除、更新、查询。
Provides complete lifecycle management for knowledge bases, including create, delete, update, and query.
"""
@classmethod
def __get_client(cls, config: Optional[Config] = None):
"""获取客户端实例 / Get client instance
Args:
config: 配置对象,可选 / Configuration object, optional
Returns:
KnowledgeBaseClient: 客户端实例 / Client instance
"""
from .client import KnowledgeBaseClient
return KnowledgeBaseClient(config=config)
@classmethod
async def create_async(
cls, input: KnowledgeBaseCreateInput, config: Optional[Config] = None
):
"""创建知识库(异步)/ Create knowledge base asynchronously
Args:
input: 知识库输入参数 / KnowledgeBase input parameters
config: 配置 / Configuration
Returns:
KnowledgeBase: 创建的知识库对象 / Created knowledge base object
"""
return await cls.__get_client(config=config).create_async(
input, config=config
)
@classmethod
def create(
cls, input: KnowledgeBaseCreateInput, config: Optional[Config] = None
):
"""创建知识库(同步)/ Create knowledge base synchronously
Args:
input: 知识库输入参数 / KnowledgeBase input parameters
config: 配置 / Configuration
Returns:
KnowledgeBase: 创建的知识库对象 / Created knowledge base object
"""
return cls.__get_client(config=config).create(input, config=config)
@classmethod
async def delete_by_name_async(
cls, knowledge_base_name: str, config: Optional[Config] = None
):
"""根据名称删除知识库(异步)/ Delete knowledge base by name asynchronously
Args:
knowledge_base_name: 知识库名称 / KnowledgeBase name
config: 配置 / Configuration
"""
return await cls.__get_client(config=config).delete_async(
knowledge_base_name, config=config
)
@classmethod
def delete_by_name(
cls, knowledge_base_name: str, config: Optional[Config] = None
):
"""根据名称删除知识库(同步)/ Delete knowledge base by name synchronously
Args:
knowledge_base_name: 知识库名称 / KnowledgeBase name
config: 配置 / Configuration
"""
return cls.__get_client(config=config).delete(
knowledge_base_name, config=config
)
@classmethod
async def update_by_name_async(
cls,
knowledge_base_name: str,
input: KnowledgeBaseUpdateInput,
config: Optional[Config] = None,
):
"""根据名称更新知识库(异步)/ Update knowledge base by name asynchronously
Args:
knowledge_base_name: 知识库名称 / KnowledgeBase name
input: 知识库更新输入参数 / KnowledgeBase update input parameters
config: 配置 / Configuration
Returns:
KnowledgeBase: 更新后的知识库对象 / Updated knowledge base object
"""
return await cls.__get_client(config=config).update_async(
knowledge_base_name, input, config=config
)
@classmethod
def update_by_name(
cls,
knowledge_base_name: str,
input: KnowledgeBaseUpdateInput,
config: Optional[Config] = None,
):
"""根据名称更新知识库(同步)/ Update knowledge base by name synchronously
Args:
knowledge_base_name: 知识库名称 / KnowledgeBase name
input: 知识库更新输入参数 / KnowledgeBase update input parameters
config: 配置 / Configuration
Returns:
KnowledgeBase: 更新后的知识库对象 / Updated knowledge base object
"""
return cls.__get_client(config=config).update(
knowledge_base_name, input, config=config
)
@classmethod
async def get_by_name_async(
cls, knowledge_base_name: str, config: Optional[Config] = None
):
"""根据名称获取知识库(异步)/ Get knowledge base by name asynchronously
Args:
knowledge_base_name: 知识库名称 / KnowledgeBase name
config: 配置 / Configuration
Returns:
KnowledgeBase: 知识库对象 / KnowledgeBase object
"""
return await cls.__get_client(config=config).get_async(
knowledge_base_name, config=config
)
@classmethod
def get_by_name(
cls, knowledge_base_name: str, config: Optional[Config] = None
):
"""根据名称获取知识库(同步)/ Get knowledge base by name synchronously
Args:
knowledge_base_name: 知识库名称 / KnowledgeBase name
config: 配置 / Configuration
Returns:
KnowledgeBase: 知识库对象 / KnowledgeBase object
"""
return cls.__get_client(config=config).get(
knowledge_base_name, config=config
)
@classmethod
async def _list_page_async(
cls, page_input: PageableInput, config: Config | None = None, **kwargs
):
return await cls.__get_client(config=config).list_async(
input=KnowledgeBaseListInput(
**kwargs,
**page_input.model_dump(),
),
config=config,
)
@classmethod
def _list_page(
cls, page_input: PageableInput, config: Config | None = None, **kwargs
):
return cls.__get_client(config=config).list(
input=KnowledgeBaseListInput(
**kwargs,
**page_input.model_dump(),
),
config=config,
)
@classmethod
async def list_all_async(
cls,
*,
provider: Optional[str] = None,
config: Optional[Config] = None,
) -> List[KnowledgeBaseListOutput]:
"""列出所有知识库(异步)/ List all knowledge bases asynchronously
Args:
provider: 提供商 / Provider
config: 配置 / Configuration
Returns:
List[KnowledgeBaseListOutput]: 知识库列表 / KnowledgeBase list
"""
return await cls._list_all_async(
lambda kb: kb.knowledge_base_id or "",
config=config,
provider=provider,
)
@classmethod
def list_all(
cls,
*,
provider: Optional[str] = None,
config: Optional[Config] = None,
) -> List[KnowledgeBaseListOutput]:
"""列出所有知识库(同步)/ List all knowledge bases synchronously
Args:
provider: 提供商 / Provider
config: 配置 / Configuration
Returns:
List[KnowledgeBaseListOutput]: 知识库列表 / KnowledgeBase list
"""
return cls._list_all(
lambda kb: kb.knowledge_base_id or "",
config=config,
provider=provider,
)
async def update_async(
self, input: KnowledgeBaseUpdateInput, config: Optional[Config] = None
):
"""更新知识库(异步)/ Update knowledge base asynchronously
Args:
input: 知识库更新输入参数 / KnowledgeBase update input parameters
config: 配置 / Configuration
Returns:
KnowledgeBase: 更新后的知识库对象 / Updated knowledge base object
"""
if self.knowledge_base_name is None:
raise ValueError(
"knowledge_base_name is required to update a KnowledgeBase"
)
result = await self.update_by_name_async(
self.knowledge_base_name, input, config=config
)
self.update_self(result)
return self
def update(
self, input: KnowledgeBaseUpdateInput, config: Optional[Config] = None
):
"""更新知识库(同步)/ Update knowledge base synchronously
Args:
input: 知识库更新输入参数 / KnowledgeBase update input parameters
config: 配置 / Configuration
Returns:
KnowledgeBase: 更新后的知识库对象 / Updated knowledge base object
"""
if self.knowledge_base_name is None:
raise ValueError(
"knowledge_base_name is required to update a KnowledgeBase"
)
result = self.update_by_name(
self.knowledge_base_name, input, config=config
)
self.update_self(result)
return self
async def delete_async(self, config: Optional[Config] = None):
"""删除知识库(异步)/ Delete knowledge base asynchronously
Args:
config: 配置 / Configuration
"""
if self.knowledge_base_name is None:
raise ValueError(
"knowledge_base_name is required to delete a KnowledgeBase"
)
return await self.delete_by_name_async(
self.knowledge_base_name, config=config
)
def delete(self, config: Optional[Config] = None):
"""删除知识库(同步)/ Delete knowledge base synchronously
Args:
config: 配置 / Configuration
"""
if self.knowledge_base_name is None:
raise ValueError(
"knowledge_base_name is required to delete a KnowledgeBase"
)
return self.delete_by_name(self.knowledge_base_name, config=config)
async def get_async(self, config: Optional[Config] = None):
"""刷新知识库信息(异步)/ Refresh knowledge base info asynchronously
Args:
config: 配置 / Configuration
Returns:
KnowledgeBase: 刷新后的知识库对象 / Refreshed knowledge base object
"""
if self.knowledge_base_name is None:
raise ValueError(
"knowledge_base_name is required to refresh a KnowledgeBase"
)
result = await self.get_by_name_async(
self.knowledge_base_name, config=config
)
self.update_self(result)
return self
def get(self, config: Optional[Config] = None):
"""刷新知识库信息(同步)/ Refresh knowledge base info synchronously
Args:
config: 配置 / Configuration
Returns:
KnowledgeBase: 刷新后的知识库对象 / Refreshed knowledge base object
"""
if self.knowledge_base_name is None:
raise ValueError(
"knowledge_base_name is required to refresh a KnowledgeBase"
)
result = self.get_by_name(self.knowledge_base_name, config=config)
self.update_self(result)
return self
async def refresh_async(self, config: Optional[Config] = None):
"""刷新知识库信息(异步)/ Refresh knowledge base info asynchronously
Args:
config: 配置 / Configuration
Returns:
KnowledgeBase: 刷新后的知识库对象 / Refreshed knowledge base object
"""
return await self.get_async(config=config)
# =========================================================================
# 数据链路方法 / Data API Methods
# =========================================================================
def refresh(self, config: Optional[Config] = None):
"""刷新知识库信息(同步)/ Refresh knowledge base info synchronously
Args:
config: 配置 / Configuration
Returns:
KnowledgeBase: 刷新后的知识库对象 / Refreshed knowledge base object
"""
return self.get(config=config)
# =========================================================================
# 数据链路方法 / Data API Methods
# =========================================================================
def _get_data_api(self, config: Optional[Config] = None):
"""获取数据链路 API 实例 / Get data API instance
根据当前知识库的 provider 类型返回对应的数据链路 API。
Returns the corresponding data API based on current knowledge base provider type.
Args:
config: 配置 / Configuration
Returns:
KnowledgeBaseDataAPI: 数据链路 API 实例 / Data API instance
Raises:
ValueError: 如果 provider 未设置 / If provider is not set
"""
if self.provider is None:
raise ValueError("provider is required to get data API")
provider = (
self.provider
if isinstance(self.provider, KnowledgeBaseProvider)
else KnowledgeBaseProvider(self.provider)
)
# 转换 provider_settings 和 retrieve_settings 为正确的类型
# Convert provider_settings and retrieve_settings to correct types
converted_provider_settings = None
converted_retrieve_settings = None
if provider == KnowledgeBaseProvider.BAILIAN:
# 百炼设置 / Bailian settings
if self.provider_settings:
if isinstance(self.provider_settings, BailianProviderSettings):
converted_provider_settings = self.provider_settings
elif isinstance(self.provider_settings, dict):
converted_provider_settings = BailianProviderSettings(
**self.provider_settings
)
if self.retrieve_settings:
if isinstance(self.retrieve_settings, BailianRetrieveSettings):
converted_retrieve_settings = self.retrieve_settings
elif isinstance(self.retrieve_settings, dict):
converted_retrieve_settings = BailianRetrieveSettings(
**self.retrieve_settings
)
elif provider == KnowledgeBaseProvider.RAGFLOW:
# RagFlow 设置 / RagFlow settings
if self.provider_settings:
if isinstance(self.provider_settings, RagFlowProviderSettings):
converted_provider_settings = self.provider_settings
elif isinstance(self.provider_settings, dict):
converted_provider_settings = RagFlowProviderSettings(
**self.provider_settings
)
if self.retrieve_settings:
if isinstance(self.retrieve_settings, RagFlowRetrieveSettings):
converted_retrieve_settings = self.retrieve_settings
elif isinstance(self.retrieve_settings, dict):
converted_retrieve_settings = RagFlowRetrieveSettings(
**self.retrieve_settings
)
elif provider == KnowledgeBaseProvider.ADB:
# ADB 设置 / ADB settings
if self.provider_settings:
if isinstance(self.provider_settings, ADBProviderSettings):
converted_provider_settings = self.provider_settings
elif isinstance(self.provider_settings, dict):
converted_provider_settings = ADBProviderSettings(
db_instance_id=self.provider_settings.get(
"DBInstanceId", ""
),
namespace=self.provider_settings.get("Namespace", ""),
namespace_password=self.provider_settings.get(
"NamespacePassword", ""
),
embedding_model=self.provider_settings.get(
"EmbeddingModel"
),
metrics=self.provider_settings.get("Metrics"),
metadata=self.provider_settings.get("Metadata"),
)
if self.retrieve_settings:
if isinstance(self.retrieve_settings, ADBRetrieveSettings):
converted_retrieve_settings = self.retrieve_settings
elif isinstance(self.retrieve_settings, dict):
converted_retrieve_settings = ADBRetrieveSettings(
top_k=self.retrieve_settings.get("TopK"),
use_full_text_retrieval=self.retrieve_settings.get(
"UseFullTextRetrieval"
),
rerank_factor=self.retrieve_settings.get(
"RerankFactor"
),
recall_window=self.retrieve_settings.get(
"RecallWindow"
),
hybrid_search=self.retrieve_settings.get(
"HybridSearch"
),
hybrid_search_args=self.retrieve_settings.get(
"HybridSearchArgs"
),
)
elif provider == KnowledgeBaseProvider.OTS:
# OTS 设置 / OTS settings (camelCase → snake_case)
if self.provider_settings:
if isinstance(self.provider_settings, OTSProviderSettings):
converted_provider_settings = self.provider_settings
elif isinstance(self.provider_settings, dict):
ps = self.provider_settings
metadata = None
raw_metadata = ps.get("metadata")
if raw_metadata and isinstance(raw_metadata, list):
metadata = [
OTSMetadataField(
name=m.get("name", ""),
type=m.get("type", ""),
)
for m in raw_metadata
]
embedding_config = None
raw_ec = ps.get("embeddingConfiguration")
if raw_ec and isinstance(raw_ec, dict):
embedding_config = OTSEmbeddingConfiguration(
provider=raw_ec.get("provider", ""),
model=raw_ec.get("model", ""),
dimension=raw_ec.get("dimension", 0),
url=raw_ec.get("url"),
api_key=raw_ec.get("apiKey"),
)
converted_provider_settings = OTSProviderSettings(
ots_instance_name=ps.get("otsInstanceName", ""),
tags=ps.get("tags"),
metadata=metadata,
embedding_configuration=embedding_config,
)
if self.retrieve_settings:
if isinstance(self.retrieve_settings, OTSRetrieveSettings):
converted_retrieve_settings = self.retrieve_settings
elif isinstance(self.retrieve_settings, dict):
rs = self.retrieve_settings
dvsc = None
raw_dvsc = rs.get("denseVectorSearchConfiguration")
if raw_dvsc and isinstance(raw_dvsc, dict):
dvsc = OTSDenseVectorSearchConfig(
number_of_results=raw_dvsc.get("numberOfResults"),
)
ftsc = None
raw_ftsc = rs.get("fullTextSearchConfiguration")
if raw_ftsc and isinstance(raw_ftsc, dict):
ftsc = OTSFullTextSearchConfig(
number_of_results=raw_ftsc.get("numberOfResults"),
)
reranking = None
raw_rr = rs.get("rerankingConfiguration")
if raw_rr and isinstance(raw_rr, dict):
rrf_config = None
raw_rrf = raw_rr.get("rrfConfiguration")
if raw_rrf and isinstance(raw_rrf, dict):
rrf_config = OTSRRFConfig(
dense_vector_search_weight=raw_rrf.get(
"denseVectorSearchWeight"
),
full_text_search_weight=raw_rrf.get(
"fullTextSearchWeight"
),
k=raw_rrf.get("k"),
)
weight_config = None
raw_wc = raw_rr.get("weightConfiguration")
if raw_wc and isinstance(raw_wc, dict):
weight_config = OTSWeightConfig(
dense_vector_search_weight=raw_wc.get(
"denseVectorSearchWeight"
),
full_text_search_weight=raw_wc.get(
"fullTextSearchWeight"
),
)
model_config = None
raw_mc = raw_rr.get("modelConfiguration")
if raw_mc and isinstance(raw_mc, dict):
model_config = OTSModelConfig(
provider=raw_mc.get("provider"),
model=raw_mc.get("model"),
)
reranking = OTSRerankingConfig(
type=raw_rr.get("type"),
number_of_results=raw_rr.get("numberOfResults"),
rrf_configuration=rrf_config,
weight_configuration=weight_config,
model_configuration=model_config,
)
converted_retrieve_settings = OTSRetrieveSettings(
search_type=rs.get("searchType"),
dense_vector_search_configuration=dvsc,
full_text_search_configuration=ftsc,
reranking_configuration=reranking,
filter=rs.get("filter"),
)
return get_data_api(
provider=provider,
knowledge_base_name=self.knowledge_base_name or "",
config=config,
provider_settings=converted_provider_settings,
retrieve_settings=converted_retrieve_settings,
credential_name=self.credential_name,
)
async def retrieve_async(
self,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""检索知识库(异步)/ Retrieve from knowledge base asynchronously
根据当前知识库的 provider 类型和配置执行检索。
Executes retrieval based on current knowledge base provider type and configuration.
Args:
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
data_api = self._get_data_api(config)
return await data_api.retrieve_async(query, config=config)
def retrieve(
self,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""检索知识库(同步)/ Retrieve from knowledge base synchronously
根据当前知识库的 provider 类型和配置执行检索。
Executes retrieval based on current knowledge base provider type and configuration.
Args:
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
data_api = self._get_data_api(config)
return data_api.retrieve(query, config=config)
@classmethod
async def _safe_get_kb_async(
cls,
kb_name: str,
config: Optional[Config] = None,
) -> Any:
"""安全获取知识库(异步)/ Safely get knowledge base asynchronously
Args:
kb_name: 知识库名称 / Knowledge base name
config: 配置 / Configuration
Returns:
Any: 知识库对象或异常 / Knowledge base object or exception
"""
try:
return await cls.get_by_name_async(kb_name, config=config)
except Exception as e:
return e
@classmethod
def _safe_get_kb(
cls,
kb_name: str,
config: Optional[Config] = None,
) -> Any:
"""安全获取知识库(同步)/ Safely get knowledge base synchronously
Args:
kb_name: 知识库名称 / Knowledge base name
config: 配置 / Configuration
Returns:
Any: 知识库对象或异常 / Knowledge base object or exception
"""
try:
return cls.get_by_name(kb_name, config=config)
except Exception as e:
return e
@classmethod
async def _safe_retrieve_kb_async(
cls,
kb_name: str,
kb_or_error: Any,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""安全执行知识库检索(异步)/ Safely retrieve from knowledge base asynchronously
Args:
kb_name: 知识库名称 / Knowledge base name
kb_or_error: 知识库对象或异常 / Knowledge base object or exception
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
if isinstance(kb_or_error, Exception):
logger.warning(
f"Failed to get knowledge base '{kb_name}': {kb_or_error}"
)
return {
"data": f"Failed to retrieve: {kb_or_error}",
"query": query,
"knowledge_base_name": kb_name,
"error": True,
}
try:
return await kb_or_error.retrieve_async(query, config=config)
except Exception as e:
logger.warning(
f"Failed to retrieve from knowledge base '{kb_name}': {e}"
)
return {
"data": f"Failed to retrieve: {e}",
"query": query,
"knowledge_base_name": kb_name,
"error": True,
}
@classmethod
def _safe_retrieve_kb(
cls,
kb_name: str,
kb_or_error: Any,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""安全执行知识库检索(同步)/ Safely retrieve from knowledge base synchronously
Args:
kb_name: 知识库名称 / Knowledge base name
kb_or_error: 知识库对象或异常 / Knowledge base object or exception
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
if isinstance(kb_or_error, Exception):
logger.warning(
f"Failed to get knowledge base '{kb_name}': {kb_or_error}"
)
return {
"data": f"Failed to retrieve: {kb_or_error}",
"query": query,
"knowledge_base_name": kb_name,
"error": True,
}
try:
return kb_or_error.retrieve(query, config=config)
except Exception as e:
logger.warning(
f"Failed to retrieve from knowledge base '{kb_name}': {e}"
)
return {
"data": f"Failed to retrieve: {e}",
"query": query,
"knowledge_base_name": kb_name,
"error": True,
}
@classmethod
async def multi_retrieve_async(
cls,
query: str,
knowledge_base_names: List[str],
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""多知识库检索(异步)/ Multi knowledge base retrieval asynchronously
根据知识库名称列表进行检索,自动获取各知识库的配置并执行检索。
如果某个知识库查询失败,不影响其他知识库的查询。
Retrieves from multiple knowledge bases by name list, automatically fetching
configuration for each knowledge base and executing retrieval.
If one knowledge base fails, it won't affect other knowledge bases.
Args:
query: 查询文本 / Query text
knowledge_base_names: 知识库名称列表 / List of knowledge base names
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果,按知识库名称分组 / Retrieval results grouped by knowledge base name
"""
# 1. 根据 knowledge_base_names 并发获取各知识库配置(安全方式)
# Fetch all knowledge bases concurrently by name (safely)
knowledge_base_results = await asyncio.gather(*[
cls._safe_get_kb_async(name, config=config)
for name in knowledge_base_names
])
# 2. 并发执行各知识库的检索(安全方式)
# Execute retrieval for each knowledge base concurrently (safely)
retrieve_results = await asyncio.gather(*[
cls._safe_retrieve_kb_async(
kb_name, kb_or_error, query, config=config
)
for kb_name, kb_or_error in zip(
knowledge_base_names, knowledge_base_results
)
])
# 3. 合并返回结果,按知识库名称分组
# Merge results, grouped by knowledge base name
results: Dict[str, Any] = {}
for kb_name, result in zip(knowledge_base_names, retrieve_results):
results[kb_name] = result
return {
"results": results,
"query": query,
}
@classmethod
def multi_retrieve(
cls,
query: str,
knowledge_base_names: List[str],
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""多知识库检索(同步)/ Multi knowledge base retrieval synchronously
根据知识库名称列表进行检索,自动获取各知识库的配置并执行检索。
如果某个知识库查询失败,不影响其他知识库的查询。
Retrieves from multiple knowledge bases by name list, automatically fetching
configuration for each knowledge base and executing retrieval.
If one knowledge base fails, it won't affect other knowledge bases.
Args:
query: 查询文本 / Query text
knowledge_base_names: 知识库名称列表 / List of knowledge base names
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果,按知识库名称分组 / Retrieval results grouped by knowledge base name
"""
# 1. 根据 knowledge_base_names 并发获取各知识库配置(安全方式)
# Fetch all knowledge bases concurrently by name (safely)
knowledge_base_results = [
cls._safe_get_kb(name, config=config)
for name in knowledge_base_names
]
# 2. 并发执行各知识库的检索(安全方式)
# Execute retrieval for each knowledge base concurrently (safely)
retrieve_results = [
cls._safe_retrieve_kb(kb_name, kb_or_error, query, config=config)
for kb_name, kb_or_error in zip(
knowledge_base_names, knowledge_base_results
)
]
# 3. 合并返回结果,按知识库名称分组
# Merge results, grouped by knowledge base name
results: Dict[str, Any] = {}
for kb_name, result in zip(knowledge_base_names, retrieve_results):
results[kb_name] = result
return {
"results": results,
"query": query,
}