com.huaweicloud.pangu.dev.sdk.api.retriever

Interface ToolRetriever

All Known Implementing Classes:

AbstractToolRetriever, CSSToolRetriever, ToolRetrieverImpl

public interface ToolRetriever

工具检索器接口类

Since:

2023-10-21

Method Summary

Modifier and Type	Method and Description
void	addTools(List<Tool> tools) 工具入库
void	addToolsFromMetadata(List<ToolMetadata> toolMetadataList) 工具入库
Function<List<ConversationMessage>,String>	getQueryPreprocessor() 获取query请求的预处理器
void	remove(List<String> toolIds) 删除工具
List<Tool>	search(String query) 工具检索
List<Tool>	search(String query, int topK) 工具检索
List<Tool>	search(String query, int topK, float scoreThreshold) 工具检索
List<Tool>	search(String query, String dsl) 工具检索
void	setQueryPreprocessor(Function<List<ConversationMessage>,String> preprocessor) 设置query请求的预处理器， 当ToolRetriever被设置在Agent中时，Agent在Retrieve工具前，先会调用query预处理器对多轮对话进行改写， 如果不设置，默认使用多轮中的最后一轮对话

Method Detail

addTools

void addTools(List<Tool> tools)

工具入库

Parameters:

tools - 工具

addToolsFromMetadata

void addToolsFromMetadata(List<ToolMetadata> toolMetadataList)

工具入库

Parameters:

toolMetadataList - 需要入库的工具

search

List<Tool> search(String query)

工具检索

Parameters:

query - 查询语句

Returns:

相似工具列表

search

List<Tool> search(String query,
                  String dsl)

工具检索

Parameters:

query - 查询语句

dsl - dsl

Returns:

相似工具列表

setQueryPreprocessor

void setQueryPreprocessor(Function<List<ConversationMessage>,String> preprocessor)

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

Parameters:

preprocessor - query预处理器

getQueryPreprocessor

Function<List<ConversationMessage>,String> getQueryPreprocessor()

获取query请求的预处理器

Returns:

query预处理器

search

List<Tool> search(String query,
                  int topK)

工具检索

Parameters:

query - 查询语句

topK - top k条

Returns:

相似工具列表

search

List<Tool> search(String query,
                  int topK,
                  float scoreThreshold)

工具检索

Parameters:

query - 查询语句

topK - top k条

scoreThreshold - 评分阈值

Returns:

相似工具列表

remove

void remove(List<String> toolIds)

删除工具

Parameters:

toolIds - 工具ID列表