Class RRFRanker
- java.lang.Object
-
- io.milvus.v2.service.collection.request.CreateCollectionReq.Function
-
- io.milvus.v2.service.vector.request.ranker.RRFRanker
-
public class RRFRanker extends CreateCollectionReq.Function
The RRF reranking strategy, which merges results from multiple searches, favoring items that consistently appear. Read the doc for more info: https://milvus.io/docs/rrf-ranker.mdNote: In v2.6, the Function and Rerank have been unified to support more rerank types: decay and model ranker https://milvus.io/docs/decay-ranker-overview.md https://milvus.io/docs/model-ranker-overview.md So we have to inherit the BaseRanker from Function, this change will lead to uncomfortable issues with RRFRanker/WeightedRanker in some users client code. We will mention it in release note. * In old client code, to declare a WeightedRanker: * RRFRanker ranker = new RRFRanker(20) * After this change, the client code should be changed accordingly: * RRFRanker ranker = RRFRanker.builder().k(20).build()
You also can declare a rrf ranker by Function CreateCollectionReq.Function rr = CreateCollectionReq.Function.builder() .functionType(FunctionType.RERANK) .param("reranker", "rrf") .param("k", "60") .build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRRFRanker.RRFRankerBuilder-
Nested classes/interfaces inherited from class io.milvus.v2.service.collection.request.CreateCollectionReq.Function
CreateCollectionReq.Function.FunctionBuilder<T extends CreateCollectionReq.Function.FunctionBuilder<T>>
-
-
Constructor Summary
Constructors Constructor Description RRFRanker(int k)Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RRFRanker.RRFRankerBuilderbuilder()FunctionTypegetFunctionType()intgetK()Map<String,String>getParams()voidsetK(int k)StringtoString()-
Methods inherited from class io.milvus.v2.service.collection.request.CreateCollectionReq.Function
getDescription, getInputFieldNames, getName, getOutputFieldNames, setDescription, setFunctionType, setInputFieldNames, setName, setOutputFieldNames, setParams
-
-
-
-
Constructor Detail
-
RRFRanker
@Deprecated public RRFRanker(int k)
Deprecated.
-
-
Method Detail
-
getK
public int getK()
-
setK
public void setK(int k)
-
getFunctionType
public FunctionType getFunctionType()
- Overrides:
getFunctionTypein classCreateCollectionReq.Function
-
getParams
public Map<String,String> getParams()
- Overrides:
getParamsin classCreateCollectionReq.Function
-
toString
public String toString()
- Overrides:
toStringin classCreateCollectionReq.Function
-
builder
public static RRFRanker.RRFRankerBuilder builder()
-
-