pangukitsappdev.api.retriever package

Submodules

pangukitsappdev.api.retriever.base module

class pangukitsappdev.api.retriever.base.AbstractToolRetriever(tool_provider: ToolProvider, vector_store_config: VectorStoreConfig)

基类：ToolRetriever, ABC

RETRIEVER_SCORE_DEFAULT = 0.2
RETRIEVER_SIZE_DEFAULT = 5
add_tools_from_metadata(tool_metadata_list: List[ToolMetadata])

工具入库 :param tool_metadata_list: 需要入库的工具

get_query_preprocessor() → Callable[[List[ConversationMessage]], str]

获取query请求的预处理器 :return: query预处理器

instantiation_tool(documents: List[Document], query: str) → List[AbstractTool]
remove(tool_ids: List[str])

删除工具 :param tool_ids: tools工具

search(query: str, top_k: int = 5, score_threshold: float = 0.2) → List[AbstractTool]

工具检索 :param query: 查询语句 :param top_k: top k条 :param score_threshold: 评分阈值 :return: 相似工具列表

set_query_preprocessor(preprocessor: Callable[[List[ConversationMessage]], str])

设置query请求的预处理器 :param preprocessor: 当ToolRetriever被设置在Agent中时，Agent在Retrieve工具前， 先会调用query预处理器对多轮对话进行改写，如果不设置，默认使用多轮中的最后一轮对话

class pangukitsappdev.api.retriever.base.ToolRetriever

基类：ABC

工具检索器接口类

abstract add_tools(tools: List[AbstractTool])

工具入库 :param tools: tools工具

abstract add_tools_from_metadata(tool_metadata_list: List[ToolMetadata])

工具入库 :param tool_metadata_list: 需要入库的工具

工具检索 :param query : 查询语句 :param dsl : dsl :return: 相似工具列表

abstract get_query_preprocessor() → Callable[[List[ConversationMessage]], str]

获取query请求的预处理器 :return: query预处理器

abstract remove(tool_ids: List[str])

删除工具 :param tool_ids: tools工具

abstract search(query: str, top_k: Optional[int] = None, score_threshold: Optional[float] = None) → List[AbstractTool]

工具检索 :param query: 查询语句 :param top_k: top k条 :param score_threshold: 评分阈值 :return: 相似工具列表

abstract set_query_preprocessor(preprocessor: Callable[[List[ConversationMessage]], str])

设置query请求的预处理器 :param preprocessor: 当ToolRetriever被设置在Agent中时，Agent在Retrieve工具前， 先会调用query预处理器对多轮对话进行改写，如果不设置，默认使用多轮中的最后一轮对话

pangukitsappdev.api.retriever.retriever_config module

class pangukitsappdev.api.retriever.retriever_config.KGConfig(_env_file: Optional[Union[str, PathLike, List[Union[str, PathLike]], Tuple[Union[str, PathLike], ...]]] = '<object object>', _env_file_encoding: Optional[str] = None, _env_nested_delimiter: Optional[str] = None, _secrets_dir: Optional[Union[str, PathLike]] = None, *, server_info: ServerInfo = None, http_config: HttpConfig = None)

基类：SdkBaseSettings

http_config: HttpConfig
server_info: ServerInfo
class pangukitsappdev.api.retriever.retriever_config.WebSearchConfig(_env_file: Optional[Union[str, PathLike, List[Union[str, PathLike]], Tuple[Union[str, PathLike], ...]]] = '<object object>', _env_file_encoding: Optional[str] = None, _env_nested_delimiter: Optional[str] = None, _secrets_dir: Optional[Union[str, PathLike]] = None, *, server_info: ServerInfo = None, http_config: HttpConfig = None)

基类：SdkBaseSettings

http_config: HttpConfig
server_info: ServerInfo

Module contents