com.huaweicloud.pangu.dev.sdk.vectorstore

Class AbstractVector

java.lang.Object

com.huaweicloud.pangu.dev.sdk.vectorstore.AbstractVector

All Implemented Interfaces:

Vector

Direct Known Subclasses:

CSSVectorStore, RedisVectorStore

public abstract class AbstractVector
extends Object
implements Vector

Vector抽象类实现

Since:

2023.11.15

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_SCORE_THRESHOLD
static int	DEFAULT_TOP_K
protected VectorStoreConfig	vectorStoreConfig

Constructor Summary

Constructors

Constructor and Description
AbstractVector(VectorStoreConfig vectorStoreConfig)

Method Summary

Modifier and Type	Method and Description
void	addDocs(List<BulkData> bulkDataList) 批量添加文档
protected abstract void	addDocsWithBuildInEmbedding(List<BulkData> bulkDataList) 使用内置embedding模型添加数据
protected abstract void	addDocsWithExternalEmbedding(List<BulkData> bulkDataList, List<List<Float>> embedded) 使用外部embedding模型添加数据
protected abstract List<Document>	searchWithBuildInEmbedding(String query, int topK) 使用内置embedding做向量查询
protected abstract List<Document>	searchWithExternalEmbedding(List<Float> embedding, int topK) 使用外部embedding做向量查询
List<Document>	similaritySearch(String query) 相似检索
List<Document>	similaritySearch(String query, int topK) 相似检索，指定返回条数
List<Document>	similaritySearch(String query, int topK, float scoreThreshold) 相似检索，指定过滤评分值

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.memory.vector.Vector

clear, remove, search

Field Detail

vectorStoreConfig

protected VectorStoreConfig vectorStoreConfig

DEFAULT_TOP_K

public static final int DEFAULT_TOP_K

See Also:

Constant Field Values

DEFAULT_SCORE_THRESHOLD

public static final float DEFAULT_SCORE_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

AbstractVector

public AbstractVector(VectorStoreConfig vectorStoreConfig)

Method Detail

addDocsWithExternalEmbedding

protected abstract void addDocsWithExternalEmbedding(List<BulkData> bulkDataList,
                                                     List<List<Float>> embedded)

使用外部embedding模型添加数据

Parameters:

bulkDataList - 数据

embedded - embedding后的数据

addDocsWithBuildInEmbedding

protected abstract void addDocsWithBuildInEmbedding(List<BulkData> bulkDataList)

使用内置embedding模型添加数据

Parameters:

bulkDataList - 数据

searchWithExternalEmbedding

protected abstract List<Document> searchWithExternalEmbedding(List<Float> embedding,
                                                              int topK)

使用外部embedding做向量查询

Parameters:

embedding - embedding后的数据

topK - topK

Returns:

查询结果

searchWithBuildInEmbedding

protected abstract List<Document> searchWithBuildInEmbedding(String query,
                                                             int topK)

使用内置embedding做向量查询

Parameters:

query - 用户请求

topK - topK

Returns:

查询结果

addDocs

public void addDocs(List<BulkData> bulkDataList)

Description copied from interface: Vector

批量添加文档

Specified by:

addDocs in interface Vector

Parameters:

bulkDataList - 批量添加的文档

similaritySearch

public List<Document> similaritySearch(String query)

Description copied from interface: Vector

相似检索

Specified by:

similaritySearch in interface Vector

Parameters:

query - 查询文本

Returns:

相关性文档

similaritySearch

public List<Document> similaritySearch(String query,
                                       int topK)

Description copied from interface: Vector

相似检索，指定返回条数

Specified by:

similaritySearch in interface Vector

Parameters:

query - 查询文本

topK - top记录数

Returns:

相关性文档

similaritySearch

public List<Document> similaritySearch(String query,
                                       int topK,
                                       float scoreThreshold)

Description copied from interface: Vector

相似检索，指定过滤评分值

Specified by:

similaritySearch in interface Vector

Parameters:

query - 查询文本

topK - top记录数

scoreThreshold - 阈值

Returns:

相关性文档