Package io.milvus.response

Class SearchResultsWrapper

java.lang.Object

io.milvus.response.basic.RowRecordWrapper

io.milvus.response.SearchResultsWrapper

public class SearchResultsWrapper
extends RowRecordWrapper

Utility class to wrap response of search interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchResultsWrapper.IDScore	Internal-use class to wrap response of search interface.

Constructor Summary

Constructors

Constructor	Description
SearchResultsWrapper(@NonNull SearchResultData results)

Method Summary

Modifier and Type	Method	Description
List<?>	getFieldData(@NonNull String fieldName, int indexOfTarget)	Gets data for an output field which is specified by search request.
protected List<FieldData>	getFieldDataList()
FieldDataWrapper	getFieldWrapper(@NonNull String fieldName)	Gets FieldDataWrapper for a field.
List<SearchResultsWrapper.IDScore>	getIDScore(int indexOfTarget)	Gets ID-score pairs returned by search interface.
protected List<String>	getOutputFields()
List<QueryResultsWrapper.RowRecord>	getRowRecords()	Deprecated.
List<QueryResultsWrapper.RowRecord>	getRowRecords(int indexOfTarget)	Note: this method's function is duplicated with getIDScore(), it is for high-level search.

Methods inherited from class io.milvus.response.basic.RowRecordWrapper

buildRowRecord, getDynamicWrapper, getFieldWrapperInternal

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResultsWrapper

public SearchResultsWrapper(@NonNull
 @NonNull SearchResultData results)

Method Details

getFieldWrapper

public FieldDataWrapper getFieldWrapper(@NonNull
 @NonNull String fieldName)
                                 throws ParamException

Gets FieldDataWrapper for a field. Throws ParamException if the field doesn't exist.

Parameters:

fieldName - field name to get output data

Returns:

FieldDataWrapper

Throws:

ParamException

getRowRecords

@Deprecated
public List<QueryResultsWrapper.RowRecord> getRowRecords()

Deprecated.

Note: this method only can return the first target vector's topk result and its function is duplicated with getIDScore(), so we mark it as deprecated.

Specified by:

getRowRecords in class RowRecordWrapper

getRowRecords

public List<QueryResultsWrapper.RowRecord> getRowRecords(int indexOfTarget)

Note: this method's function is duplicated with getIDScore(), it is for high-level search.

Parameters:

indexOfTarget - index of a row

Returns:

List of QueryResultsWrapper.RowRecord

getFieldDataList

protected List<FieldData> getFieldDataList()

Specified by:

getFieldDataList in class RowRecordWrapper

getOutputFields

protected List<String> getOutputFields()

Specified by:

getOutputFields in class RowRecordWrapper

getFieldData

public List<?> getFieldData(@NonNull
 @NonNull String fieldName,
 int indexOfTarget)

Gets data for an output field which is specified by search request. Throws ParamException if the field doesn't exist. Throws ParamException if the indexOfTarget is illegal.

Parameters:

fieldName - field name to get output data

indexOfTarget - which target vector the field data belongs to

Returns:

FieldDataWrapper

getIDScore

public List<SearchResultsWrapper.IDScore> getIDScore(int indexOfTarget)
                                              throws ParamException,
IllegalResponseException

Gets ID-score pairs returned by search interface. Throws ParamException if the indexOfTarget is illegal. Throws IllegalResponseException if the returned results is illegal.

Parameters:

indexOfTarget - which target vector the result belongs to

Returns:

List of IDScore, ID-score pairs returned by search interface

Throws:

ParamException

IllegalResponseException