-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path__data_async_template.py
More file actions
881 lines (753 loc) · 32.4 KB
/
__data_async_template.py
File metadata and controls
881 lines (753 loc) · 32.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
"""KnowledgeBase 数据链路 API / KnowledgeBase Data API
提供知识库检索功能的数据链路 API。
Provides data API for knowledge base retrieval operations.
根据不同的 provider 类型(ragflow / bailian / adb)分发到不同的实现。
Dispatches to different implementations based on provider type (ragflow / bailian / adb).
"""
from abc import ABC, abstractmethod
from typing import Any, Dict, List, Optional, Union
from alibabacloud_bailian20231229 import models as bailian_models
from alibabacloud_gpdb20160503 import models as gpdb_models
import httpx
from tablestore_agent_storage import AgentStorageClient
from agentrun.utils.config import Config
from agentrun.utils.control_api import ControlAPI
from agentrun.utils.data_api import DataAPI, ResourceType
from agentrun.utils.log import logger
from ..model import (
ADBProviderSettings,
ADBRetrieveSettings,
BailianProviderSettings,
BailianRetrieveSettings,
KnowledgeBaseProvider,
OTSProviderSettings,
OTSRetrieveSettings,
RagFlowProviderSettings,
RagFlowRetrieveSettings,
)
class KnowledgeBaseDataAPI(ABC):
"""知识库数据链路 API 基类 / KnowledgeBase Data API Base Class
定义知识库检索的抽象接口,由具体的 provider 实现。
Defines abstract interface for knowledge base retrieval, implemented by specific providers.
"""
def __init__(
self,
knowledge_base_name: str,
config: Optional[Config] = None,
):
"""初始化知识库数据链路 API / Initialize KnowledgeBase Data API
Args:
knowledge_base_name: 知识库名称 / Knowledge base name
config: 配置 / Configuration
"""
self.knowledge_base_name = knowledge_base_name
self.config = Config.with_configs(config)
@abstractmethod
async def retrieve_async(
self,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""检索知识库(异步)/ Retrieve from knowledge base (async)
Args:
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
raise NotImplementedError("Subclasses must implement retrieve_async")
class RagFlowDataAPI(KnowledgeBaseDataAPI):
"""RagFlow 知识库数据链路 API / RagFlow KnowledgeBase Data API
实现 RagFlow 知识库的检索逻辑。
Implements retrieval logic for RagFlow knowledge base.
"""
def __init__(
self,
knowledge_base_name: str,
config: Optional[Config] = None,
provider_settings: Optional[RagFlowProviderSettings] = None,
retrieve_settings: Optional[RagFlowRetrieveSettings] = None,
credential_name: Optional[str] = None,
):
"""初始化 RagFlow 知识库数据链路 API / Initialize RagFlow KnowledgeBase Data API
Args:
knowledge_base_name: 知识库名称 / Knowledge base name
config: 配置 / Configuration
provider_settings: RagFlow 提供商设置 / RagFlow provider settings
retrieve_settings: RagFlow 检索设置 / RagFlow retrieve settings
credential_name: 凭证名称 / Credential name
"""
super().__init__(knowledge_base_name, config)
self.provider_settings = provider_settings
self.retrieve_settings = retrieve_settings
self.credential_name = credential_name
async def _get_api_key_async(self, config: Optional[Config] = None) -> str:
"""获取 API Key(异步)/ Get API Key (async)
Args:
config: 配置 / Configuration
Returns:
str: API Key
Raises:
ValueError: 凭证名称未设置或凭证不存在 / Credential name not set or credential not found
"""
if not self.credential_name:
raise ValueError(
"credential_name is required for RagFlow retrieval"
)
from agentrun.credential import Credential
credential = await Credential.get_by_name_async(
self.credential_name, config=config
)
if not credential.credential_secret:
raise ValueError(
f"Credential '{self.credential_name}' has no secret configured"
)
return credential.credential_secret
def _build_request_body(self, query: str) -> Dict[str, Any]:
"""构建请求体 / Build request body
Args:
query: 查询文本 / Query text
Returns:
Dict[str, Any]: 请求体 / Request body
"""
if self.provider_settings is None:
raise ValueError(
"provider_settings is required for RagFlow retrieval"
)
body: Dict[str, Any] = {
"question": query,
"dataset_ids": self.provider_settings.dataset_ids,
"page": 1,
"page_size": 30,
}
# 添加检索设置 / Add retrieve settings
if self.retrieve_settings:
if self.retrieve_settings.similarity_threshold is not None:
body["similarity_threshold"] = (
self.retrieve_settings.similarity_threshold
)
if self.retrieve_settings.vector_similarity_weight is not None:
body["vector_similarity_weight"] = (
self.retrieve_settings.vector_similarity_weight
)
if self.retrieve_settings.cross_languages is not None:
body["cross_languages"] = self.retrieve_settings.cross_languages
return body
async def retrieve_async(
self,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""RagFlow 检索(异步)/ RagFlow retrieval (async)
Args:
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
try:
if self.provider_settings is None:
raise ValueError(
"provider_settings is required for RagFlow retrieval"
)
# 获取 API Key / Get API Key
api_key = await self._get_api_key_async(config)
# 构建请求 / Build request
base_url = self.provider_settings.base_url.rstrip("/")
url = f"{base_url}/api/v1/retrieval"
headers = {
"Content-Type": "application/json",
"Authorization": f"Bearer {api_key}",
}
body = self._build_request_body(query)
# 发送请求 / Send request
async with httpx.AsyncClient(
timeout=self.config.get_timeout()
) as client:
response = await client.post(url, json=body, headers=headers)
response.raise_for_status()
result = response.json()
logger.debug(f"RagFlow retrieval result: {result}")
# 返回结果 / Return result
data = result.get("data", {})
if data == False:
raise Exception(f"RagFlow retrieval failed: {result}")
return {
"data": data,
"query": query,
"knowledge_base_name": self.knowledge_base_name,
}
except Exception as e:
logger.warning(
"Failed to retrieve from RagFlow knowledge base "
f"'{self.knowledge_base_name}': {e}"
)
return {
"data": f"Failed to retrieve: {e}",
"query": query,
"knowledge_base_name": self.knowledge_base_name,
"error": True,
}
class BailianDataAPI(KnowledgeBaseDataAPI, ControlAPI):
"""百炼知识库数据链路 API / Bailian KnowledgeBase Data API
实现百炼知识库的检索逻辑。
Implements retrieval logic for Bailian knowledge base.
"""
def __init__(
self,
knowledge_base_name: str,
config: Optional[Config] = None,
provider_settings: Optional[BailianProviderSettings] = None,
retrieve_settings: Optional[BailianRetrieveSettings] = None,
):
"""初始化百炼知识库数据链路 API / Initialize Bailian KnowledgeBase Data API
Args:
knowledge_base_name: 知识库名称 / Knowledge base name
config: 配置 / Configuration
provider_settings: 百炼提供商设置 / Bailian provider settings
retrieve_settings: 百炼检索设置 / Bailian retrieve settings
"""
KnowledgeBaseDataAPI.__init__(self, knowledge_base_name, config)
ControlAPI.__init__(self, config)
self.provider_settings = provider_settings
self.retrieve_settings = retrieve_settings
async def retrieve_async(
self,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""百炼检索(异步)/ Bailian retrieval (async)
Args:
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
try:
if self.provider_settings is None:
raise ValueError(
"provider_settings is required for Bailian retrieval"
)
workspace_id = self.provider_settings.workspace_id
index_ids = self.provider_settings.index_ids
# 构建检索请求 / Build retrieve request
request_params: Dict[str, Any] = {
"query": query,
}
# 添加检索设置 / Add retrieve settings
if self.retrieve_settings:
if self.retrieve_settings.dense_similarity_top_k is not None:
request_params["dense_similarity_top_k"] = (
self.retrieve_settings.dense_similarity_top_k
)
if self.retrieve_settings.sparse_similarity_top_k is not None:
request_params["sparse_similarity_top_k"] = (
self.retrieve_settings.sparse_similarity_top_k
)
if self.retrieve_settings.rerank_min_score is not None:
request_params["rerank_min_score"] = (
self.retrieve_settings.rerank_min_score
)
if self.retrieve_settings.rerank_top_n is not None:
request_params["rerank_top_n"] = (
self.retrieve_settings.rerank_top_n
)
# 获取百炼客户端 / Get Bailian client
client = self._get_bailian_client(config)
# 对每个 index_id 进行检索并合并结果 / Retrieve from each index and merge results
all_nodes: List[Dict[str, Any]] = []
for index_id in index_ids:
request_params["index_id"] = index_id
request = bailian_models.RetrieveRequest(**request_params)
response = await client.retrieve_async(workspace_id, request)
logger.debug(f"Bailian retrieve response: {response}")
if (
response.body
and response.body.data
and response.body.data.nodes
):
for node in response.body.data.nodes:
all_nodes.append({
"text": (
node.text if hasattr(node, "text") else None
),
"score": (
node.score if hasattr(node, "score") else None
),
"metadata": (
node.metadata
if hasattr(node, "metadata")
else None
),
})
return {
"data": all_nodes,
"query": query,
"knowledge_base_name": self.knowledge_base_name,
}
except Exception as e:
logger.warning(
"Failed to retrieve from Bailian knowledge base "
f"'{self.knowledge_base_name}': {e}"
)
return {
"data": f"Failed to retrieve: {e}",
"query": query,
"knowledge_base_name": self.knowledge_base_name,
"error": True,
}
class ADBDataAPI(KnowledgeBaseDataAPI, ControlAPI):
"""ADB (AnalyticDB for PostgreSQL) 知识库数据链路 API / ADB KnowledgeBase Data API
实现 ADB 知识库的检索逻辑,通过 GPDB SDK 调用 QueryContent 接口。
Implements retrieval logic for ADB knowledge base via GPDB SDK QueryContent API.
"""
def __init__(
self,
knowledge_base_name: str,
config: Optional[Config] = None,
provider_settings: Optional[ADBProviderSettings] = None,
retrieve_settings: Optional[ADBRetrieveSettings] = None,
):
"""初始化 ADB 知识库数据链路 API / Initialize ADB KnowledgeBase Data API
Args:
knowledge_base_name: 知识库名称 / Knowledge base name
config: 配置 / Configuration
provider_settings: ADB 提供商设置 / ADB provider settings
retrieve_settings: ADB 检索设置 / ADB retrieve settings
"""
KnowledgeBaseDataAPI.__init__(self, knowledge_base_name, config)
ControlAPI.__init__(self, config)
self.provider_settings = provider_settings
self.retrieve_settings = retrieve_settings
def _build_query_content_request(
self, query: str, config: Optional[Config] = None
) -> gpdb_models.QueryContentRequest:
"""构建 QueryContent 请求 / Build QueryContent request
Args:
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
QueryContentRequest: GPDB QueryContent 请求对象
"""
if self.provider_settings is None:
raise ValueError("provider_settings is required for ADB retrieval")
cfg = Config.with_configs(self.config, config)
# 构建基础请求参数 / Build base request parameters
request_params: Dict[str, Any] = {
"content": query,
"dbinstance_id": self.provider_settings.db_instance_id,
"namespace": self.provider_settings.namespace,
"namespace_password": self.provider_settings.namespace_password,
"collection": self.knowledge_base_name,
"region_id": cfg.get_region_id(),
}
# 添加可选的提供商设置 / Add optional provider settings
if self.provider_settings.metrics is not None:
request_params["metrics"] = self.provider_settings.metrics
# 添加检索设置 / Add retrieve settings
if self.retrieve_settings:
if self.retrieve_settings.top_k is not None:
request_params["top_k"] = self.retrieve_settings.top_k
if self.retrieve_settings.use_full_text_retrieval is not None:
request_params["use_full_text_retrieval"] = (
self.retrieve_settings.use_full_text_retrieval
)
if self.retrieve_settings.rerank_factor is not None:
request_params["rerank_factor"] = (
self.retrieve_settings.rerank_factor
)
if self.retrieve_settings.recall_window is not None:
request_params["recall_window"] = (
self.retrieve_settings.recall_window
)
if self.retrieve_settings.hybrid_search is not None:
request_params["hybrid_search"] = (
self.retrieve_settings.hybrid_search
)
if self.retrieve_settings.hybrid_search_args is not None:
request_params["hybrid_search_args"] = (
self.retrieve_settings.hybrid_search_args
)
return gpdb_models.QueryContentRequest(**request_params)
def _parse_query_content_response(
self, response: gpdb_models.QueryContentResponse, query: str
) -> Dict[str, Any]:
"""解析 QueryContent 响应 / Parse QueryContent response
Args:
response: GPDB QueryContent 响应对象
query: 原始查询文本 / Original query text
Returns:
Dict[str, Any]: 格式化的检索结果 / Formatted retrieval results
"""
all_matches: List[Dict[str, Any]] = []
if response.body and response.body.matches:
match_list = response.body.matches.match_list or []
for match in match_list:
all_matches.append({
"content": (
match.content if hasattr(match, "content") else None
),
"score": match.score if hasattr(match, "score") else None,
"id": match.id if hasattr(match, "id") else None,
"file_name": (
match.file_name if hasattr(match, "file_name") else None
),
"file_url": (
match.file_url if hasattr(match, "file_url") else None
),
"metadata": (
match.metadata if hasattr(match, "metadata") else None
),
"loader_metadata": (
match.loader_metadata
if hasattr(match, "loader_metadata")
else None
),
"rerank_score": (
match.rerank_score
if hasattr(match, "rerank_score")
else None
),
"retrieval_source": (
match.retrieval_source
if hasattr(match, "retrieval_source")
else None
),
})
return {
"data": all_matches,
"query": query,
"knowledge_base_name": self.knowledge_base_name,
"request_id": (
response.body.request_id
if response.body and hasattr(response.body, "request_id")
else None
),
}
async def retrieve_async(
self,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""ADB 检索(异步)/ ADB retrieval asynchronously
通过 GPDB SDK 调用 QueryContent 接口进行知识库检索。
Retrieves from ADB knowledge base via GPDB SDK QueryContent API.
Args:
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
try:
if self.provider_settings is None:
raise ValueError(
"provider_settings is required for ADB retrieval"
)
# 获取 GPDB 客户端 / Get GPDB client
client = self._get_gpdb_client(config)
# 构建请求 / Build request
request = self._build_query_content_request(query, config)
logger.debug(f"ADB QueryContent request: {request}")
# 调用 QueryContent API / Call QueryContent API
response = await client.query_content_async(request)
logger.debug(f"ADB QueryContent response: {response}")
# 解析并返回结果 / Parse and return results
return self._parse_query_content_response(response, query)
except Exception as e:
logger.warning(
"Failed to retrieve from ADB knowledge base "
f"'{self.knowledge_base_name}': {e}"
)
return {
"data": f"Failed to retrieve: {e}",
"query": query,
"knowledge_base_name": self.knowledge_base_name,
"error": True,
}
class OTSDataAPI(KnowledgeBaseDataAPI):
"""OTS (TableStore) 知识库数据链路 API / OTS KnowledgeBase Data API
实现 OTS 知识库的检索逻辑,通过 tablestore-agent-storage 包调用 retrieve 接口。
Implements retrieval logic for OTS knowledge base via tablestore-agent-storage retrieve API.
"""
def __init__(
self,
knowledge_base_name: str,
config: Optional[Config] = None,
provider_settings: Optional[OTSProviderSettings] = None,
retrieve_settings: Optional[OTSRetrieveSettings] = None,
):
"""初始化 OTS 知识库数据链路 API / Initialize OTS KnowledgeBase Data API
Args:
knowledge_base_name: 知识库名称 / Knowledge base name
config: 配置 / Configuration
provider_settings: OTS 提供商设置 / OTS provider settings
retrieve_settings: OTS 检索设置 / OTS retrieve settings
"""
super().__init__(knowledge_base_name, config)
self.provider_settings = provider_settings
self.retrieve_settings = retrieve_settings
def _build_agent_storage_client(
self, config: Optional[Config] = None
) -> AgentStorageClient:
"""构建 AgentStorageClient / Build AgentStorageClient
Args:
config: 配置 / Configuration
Returns:
AgentStorageClient: OTS 存储客户端
"""
if self.provider_settings is None:
raise ValueError("provider_settings is required for OTS retrieval")
cfg = Config.with_configs(self.config, config)
region_id = cfg.get_region_id()
ots_endpoint = f"http://ots-{region_id}.aliyuncs.com"
return AgentStorageClient(
access_key_id=cfg.get_access_key_id(),
access_key_secret=cfg.get_access_key_secret(),
sts_token=cfg.get_security_token(),
ots_endpoint=ots_endpoint,
ots_instance_name=self.provider_settings.ots_instance_name,
)
def _build_retrieval_configuration(self) -> Optional[Dict[str, Any]]:
"""将 OTSRetrieveSettings 转换为 tablestore-agent-storage 的 dict 格式
Convert OTSRetrieveSettings to tablestore-agent-storage dict format
Returns:
Optional[Dict[str, Any]]: 检索配置字典 / Retrieval configuration dict
"""
if self.retrieve_settings is None:
return None
config: Dict[str, Any] = {}
if self.retrieve_settings.search_type is not None:
config["searchType"] = self.retrieve_settings.search_type
if self.retrieve_settings.dense_vector_search_configuration is not None:
dvsc = self.retrieve_settings.dense_vector_search_configuration
dv_config: Dict[str, Any] = {}
if dvsc.number_of_results is not None:
dv_config["numberOfResults"] = dvsc.number_of_results
config["denseVectorSearchConfiguration"] = dv_config
if self.retrieve_settings.full_text_search_configuration is not None:
ftsc = self.retrieve_settings.full_text_search_configuration
ft_config: Dict[str, Any] = {}
if ftsc.number_of_results is not None:
ft_config["numberOfResults"] = ftsc.number_of_results
config["fullTextSearchConfiguration"] = ft_config
if self.retrieve_settings.reranking_configuration is not None:
rc = self.retrieve_settings.reranking_configuration
rr_config: Dict[str, Any] = {}
if rc.type is not None:
rr_config["type"] = rc.type
if rc.number_of_results is not None:
rr_config["numberOfResults"] = rc.number_of_results
if rc.rrf_configuration is not None:
rrf: Dict[str, Any] = {}
if rc.rrf_configuration.dense_vector_search_weight is not None:
rrf["denseVectorSearchWeight"] = (
rc.rrf_configuration.dense_vector_search_weight
)
if rc.rrf_configuration.full_text_search_weight is not None:
rrf["fullTextSearchWeight"] = (
rc.rrf_configuration.full_text_search_weight
)
if rc.rrf_configuration.k is not None:
rrf["k"] = rc.rrf_configuration.k
rr_config["rrfConfiguration"] = rrf
if rc.weight_configuration is not None:
wc: Dict[str, Any] = {}
if (
rc.weight_configuration.dense_vector_search_weight
is not None
):
wc["denseVectorSearchWeight"] = (
rc.weight_configuration.dense_vector_search_weight
)
if rc.weight_configuration.full_text_search_weight is not None:
wc["fullTextSearchWeight"] = (
rc.weight_configuration.full_text_search_weight
)
rr_config["weightConfiguration"] = wc
if rc.model_configuration is not None:
mc: Dict[str, Any] = {}
if rc.model_configuration.provider is not None:
mc["provider"] = rc.model_configuration.provider
if rc.model_configuration.model is not None:
mc["model"] = rc.model_configuration.model
rr_config["modelConfiguration"] = mc
config["rerankingConfiguration"] = rr_config
if self.retrieve_settings.filter is not None:
config["filter"] = self.retrieve_settings.filter
return config if config else None
def _parse_retrieve_response(
self, response: Dict[str, Any], query: str
) -> Dict[str, Any]:
"""解析 OTS 检索响应 / Parse OTS retrieve response
Args:
response: AgentStorageClient.retrieve 的响应 / Response from retrieve
query: 原始查询文本 / Original query text
Returns:
Dict[str, Any]: 格式化的检索结果 / Formatted retrieval results
"""
all_results: List[Dict[str, Any]] = []
data = response.get("data", {})
retrieval_results = data.get("retrievalResults", [])
for item in retrieval_results:
all_results.append({
"content": item.get("content"),
"score": item.get("score"),
"doc_id": item.get("docId"),
"chunk_id": item.get("chunkId"),
"subspace": item.get("subspace"),
"oss_key": item.get("ossKey"),
"metadata": item.get("metadata"),
})
return {
"data": all_results,
"query": query,
"knowledge_base_name": self.knowledge_base_name,
}
async def retrieve_async(
self,
query: str,
config: Optional[Config] = None,
) -> Dict[str, Any]:
"""OTS 检索(异步)/ OTS retrieval asynchronously
通过 tablestore-agent-storage 调用 retrieve 接口进行知识库检索。
Retrieves from OTS knowledge base via tablestore-agent-storage retrieve API.
Args:
query: 查询文本 / Query text
config: 配置 / Configuration
Returns:
Dict[str, Any]: 检索结果 / Retrieval results
"""
try:
if self.provider_settings is None:
raise ValueError(
"provider_settings is required for OTS retrieval"
)
client = self._build_agent_storage_client(config)
retrieval_config = self._build_retrieval_configuration()
request: Dict[str, Any] = {
"knowledgeBaseName": self.knowledge_base_name,
"retrievalQuery": {"text": query, "type": "TEXT"},
}
if retrieval_config:
request["retrievalConfiguration"] = retrieval_config
logger.debug(f"OTS retrieve request: {request}")
response = client.retrieve(request)
logger.debug(f"OTS retrieve response: {response}")
return self._parse_retrieve_response(response, query)
except Exception as e:
logger.warning(
"Failed to retrieve from OTS knowledge base "
f"'{self.knowledge_base_name}': {e}"
)
return {
"data": f"Failed to retrieve: {e}",
"query": query,
"knowledge_base_name": self.knowledge_base_name,
"error": True,
}
def get_data_api(
provider: KnowledgeBaseProvider,
knowledge_base_name: str,
config: Optional[Config] = None,
provider_settings: Optional[
Union[
RagFlowProviderSettings,
BailianProviderSettings,
ADBProviderSettings,
OTSProviderSettings,
]
] = None,
retrieve_settings: Optional[
Union[
RagFlowRetrieveSettings,
BailianRetrieveSettings,
ADBRetrieveSettings,
OTSRetrieveSettings,
]
] = None,
credential_name: Optional[str] = None,
) -> KnowledgeBaseDataAPI:
"""根据 provider 类型获取对应的数据链路 API / Get data API by provider type
Args:
provider: 提供商类型 / Provider type
knowledge_base_name: 知识库名称 / Knowledge base name
config: 配置 / Configuration
provider_settings: 提供商设置 / Provider settings
retrieve_settings: 检索设置 / Retrieve settings
credential_name: 凭证名称(RagFlow 需要)/ Credential name (required for RagFlow)
Returns:
KnowledgeBaseDataAPI: 对应的数据链路 API 实例 / Corresponding data API instance
Raises:
ValueError: 不支持的 provider 类型 / Unsupported provider type
"""
if provider == KnowledgeBaseProvider.RAGFLOW or provider == "ragflow":
ragflow_provider_settings = (
provider_settings
if isinstance(provider_settings, RagFlowProviderSettings)
else None
)
ragflow_retrieve_settings = (
retrieve_settings
if isinstance(retrieve_settings, RagFlowRetrieveSettings)
else None
)
return RagFlowDataAPI(
knowledge_base_name,
config,
provider_settings=ragflow_provider_settings,
retrieve_settings=ragflow_retrieve_settings,
credential_name=credential_name,
)
elif provider == KnowledgeBaseProvider.BAILIAN or provider == "bailian":
bailian_provider_settings = (
provider_settings
if isinstance(provider_settings, BailianProviderSettings)
else None
)
bailian_retrieve_settings = (
retrieve_settings
if isinstance(retrieve_settings, BailianRetrieveSettings)
else None
)
return BailianDataAPI(
knowledge_base_name,
config,
provider_settings=bailian_provider_settings,
retrieve_settings=bailian_retrieve_settings,
)
elif provider == KnowledgeBaseProvider.ADB or provider == "adb":
adb_provider_settings = (
provider_settings
if isinstance(provider_settings, ADBProviderSettings)
else None
)
adb_retrieve_settings = (
retrieve_settings
if isinstance(retrieve_settings, ADBRetrieveSettings)
else None
)
return ADBDataAPI(
knowledge_base_name,
config,
provider_settings=adb_provider_settings,
retrieve_settings=adb_retrieve_settings,
)
elif provider == KnowledgeBaseProvider.OTS or provider == "ots":
ots_provider_settings = (
provider_settings
if isinstance(provider_settings, OTSProviderSettings)
else None
)
ots_retrieve_settings = (
retrieve_settings
if isinstance(retrieve_settings, OTSRetrieveSettings)
else None
)
return OTSDataAPI(
knowledge_base_name,
config,
provider_settings=ots_provider_settings,
retrieve_settings=ots_retrieve_settings,
)
else:
raise ValueError(f"Unsupported provider type: {provider}")