com.volcengine.service.vikingDB

Class Index

java.lang.Object

com.volcengine.service.vikingDB.Index

Direct Known Subclasses:

IndexClient

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	collectionName
protected String	indexName
protected Boolean	isClient
protected String	primaryKey
protected VikingDBService	vikingDBService

Constructor Summary

Constructors

Constructor and Description
Index()
Index(String collectionName, String indexName, VectorIndexParams vectorIndex, List<String> scalarIndex, String stat, VikingDBService vikingDBService)

Method Summary

Modifier and Type	Method and Description
List<DataObject>	fetchData(List<?> ids, FetchDataParam fetchDataParam)
<T> DataObject	fetchData(T id, FetchDataParam fetchDataParam)
List<DataObject>	getDatas(com.google.gson.internal.LinkedTreeMap<String,Object> resData, List<String> outputFields)
PageDataObject	getPageData(com.google.gson.internal.LinkedTreeMap<String,Object> resData, List<String> outputFields)
String	requestPrimaryKey()
List<DataObject>	search(SearchParam searchParam)
SearchAggResult	searchAgg(SearchAggParam searchAggParam)
List<DataObject>	searchById(SearchByIdParam searchByIdParam)
List<DataObject>	searchByText(SearchByTextParam searchByTextParam) 推荐使用多模态检索方法。支持 纯文本、图片、图文对 的方式检索
List<DataObject>	searchByVector(SearchByVectorParam searchByVectorParam)
PageDataObject	searchPagination(SearchParam searchParam)
List<DataObject>	searchWithMultiModal(SearchWithMultiModalParam searchWithMultiModalParam)
void	setCpuQuota(Integer cpuQuota)
void	setCpuQuota(Long cpuQuota)
void	setShardCount(Integer shardCount)
void	setShardCount(Long shardCount)
void	setShardPolicy(String shardPolicy)
<T> IndexSortResult<T>	sort(IndexSortParam<T> indexSortParam)

Methods inherited from class java.lang.Object

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

Field Detail

collectionName

protected String collectionName

indexName

protected String indexName

vikingDBService

protected VikingDBService vikingDBService

primaryKey

protected String primaryKey

isClient

protected Boolean isClient

Constructor Detail

Index

public Index()

Index

public Index(String collectionName,
             String indexName,
             VectorIndexParams vectorIndex,
             List<String> scalarIndex,
             String stat,
             VikingDBService vikingDBService)

Method Detail

setCpuQuota

public void setCpuQuota(Integer cpuQuota)

setCpuQuota

public void setCpuQuota(Long cpuQuota)

setShardCount

public void setShardCount(Integer shardCount)

setShardCount

public void setShardCount(Long shardCount)

setShardPolicy

public void setShardPolicy(String shardPolicy)

requestPrimaryKey

public String requestPrimaryKey()
                         throws Exception

Throws:

Exception

search

public List<DataObject> search(SearchParam searchParam)
                        throws Exception

Throws:

Exception

searchPagination

public PageDataObject searchPagination(SearchParam searchParam)
                                throws Exception

Throws:

Exception

searchById

public List<DataObject> searchById(SearchByIdParam searchByIdParam)
                            throws Exception

Throws:

Exception

searchByVector

public List<DataObject> searchByVector(SearchByVectorParam searchByVectorParam)
                                throws Exception

Throws:

Exception

searchWithMultiModal

public List<DataObject> searchWithMultiModal(SearchWithMultiModalParam searchWithMultiModalParam)
                                      throws Exception

Throws:

Exception

searchByText

public List<DataObject> searchByText(SearchByTextParam searchByTextParam)
                              throws Exception

推荐使用多模态检索方法。支持 纯文本、图片、图文对 的方式检索

Throws:

Exception

See Also:

searchWithMultiModal(com.volcengine.service.vikingDB.common.SearchWithMultiModalParam)

searchAgg

public SearchAggResult searchAgg(SearchAggParam searchAggParam)
                          throws Exception

Throws:

Exception

sort

public <T> IndexSortResult<T> sort(IndexSortParam<T> indexSortParam)
                            throws Exception

Throws:

Exception

fetchData

public <T> DataObject fetchData(T id,
                                FetchDataParam fetchDataParam)
                         throws Exception

Throws:

Exception

fetchData

public List<DataObject> fetchData(List<?> ids,
                                  FetchDataParam fetchDataParam)
                           throws Exception

Throws:

Exception

getPageData

public PageDataObject getPageData(com.google.gson.internal.LinkedTreeMap<String,Object> resData,
                                  List<String> outputFields)
                           throws Exception

Throws:

Exception

getDatas

public List<DataObject> getDatas(com.google.gson.internal.LinkedTreeMap<String,Object> resData,
                                 List<String> outputFields)
                          throws Exception

Throws:

Exception