com.huaweicloud.pangu.dev.sdk.retriever

Class AbstractToolRetriever

java.lang.Object

com.huaweicloud.pangu.dev.sdk.retriever.AbstractToolRetriever

All Implemented Interfaces:

ToolRetriever

Direct Known Subclasses:

CSSToolRetriever, ToolRetrieverImpl

public abstract class AbstractToolRetriever
extends Object
implements ToolRetriever

ToolRetriever抽象实现

Since:

2023.11.16

Field Summary

Fields

Modifier and Type	Field and Description
protected ToolProvider	toolProvider 储存工具类相关信息；
protected Vector	vector 向量检索库
protected VectorStoreConfig	vectorStoreConfig

Constructor Summary

Constructors

Constructor and Description
AbstractToolRetriever(ToolProvider toolProvider, VectorStoreConfig vectorStoreConfig)

Method Summary

Modifier and Type	Method and Description
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) 工具检索
void	setQueryPreprocessor(Function<List<ConversationMessage>,String> preprocessor) 设置query请求的预处理器， 当ToolRetriever被设置在Agent中时，Agent在Retrieve工具前，先会调用query预处理器对多轮对话进行改写， 如果不设置，默认使用多轮中的最后一轮对话

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.huaweicloud.pangu.dev.sdk.api.retriever.ToolRetriever

addTools, search

Field Detail

vectorStoreConfig

protected final VectorStoreConfig vectorStoreConfig

toolProvider

protected final ToolProvider toolProvider

储存工具类相关信息；

vector

protected Vector vector

向量检索库

Constructor Detail

AbstractToolRetriever

public AbstractToolRetriever(ToolProvider toolProvider,
                             VectorStoreConfig vectorStoreConfig)

Method Detail

addToolsFromMetadata

public void addToolsFromMetadata(List<ToolMetadata> toolMetadataList)

Description copied from interface: ToolRetriever

工具入库

Specified by:

addToolsFromMetadata in interface ToolRetriever

Parameters:

toolMetadataList - 需要入库的工具

search

public List<Tool> search(String query)

Description copied from interface: ToolRetriever

工具检索

Specified by:

search in interface ToolRetriever

Parameters:

query - 查询语句

Returns:

相似工具列表

setQueryPreprocessor

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

Description copied from interface: ToolRetriever

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

Specified by:

setQueryPreprocessor in interface ToolRetriever

Parameters:

preprocessor - query预处理器

getQueryPreprocessor

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

Description copied from interface: ToolRetriever

获取query请求的预处理器

Specified by:

getQueryPreprocessor in interface ToolRetriever

Returns:

query预处理器

search

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

Description copied from interface: ToolRetriever

工具检索

Specified by:

search in interface ToolRetriever

Parameters:

query - 查询语句

topK - top k条

Returns:

相似工具列表

search

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

Description copied from interface: ToolRetriever

工具检索

Specified by:

search in interface ToolRetriever

Parameters:

query - 查询语句

topK - top k条

scoreThreshold - 评分阈值

Returns:

相似工具列表

remove

public void remove(List<String> toolIds)

Description copied from interface: ToolRetriever

删除工具

Specified by:

remove in interface ToolRetriever

Parameters:

toolIds - 工具ID列表