DecayRanker (milvus-sdk-java 2.6.15 API)

java.lang.Object
- io.milvus.v2.service.collection.request.CreateCollectionReq.Function
- - io.milvus.v2.service.vector.request.ranker.DecayRanker

```
public class DecayRanker
extends CreateCollectionReq.Function
```
The Decay reranking strategy, which by adjusting search rankings based on numeric field values. Read the doc for more info: https://milvus.io/docs/decay-ranker-overview.md
Example: DecayRanker decay = DecayRanker.builder() .name("time_decay") .description("time decay") .inputFieldNames(Collections.singletonList("timestamp")) .function("gauss") .origin(100) .scale(50) .offset(24) .decay(0.5) .build()
You also can declare a decay ranker by Function: CreateCollectionReq.Function decay = CreateCollectionReq.Function.builder() .functionType(FunctionType.RERANK) .name("time_decay") .description("time decay") .inputFieldNames(Collections.singletonList("timestamp")) .param("reranker", "decay") .param("function", "gauss") .param("origin", "100") .param("scale", "50") .param("offset", "24") .param("decay", "0.5") .build();

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DecayRanker.DecayRankerBuilder
- Nested classes/interfaces inherited from class io.milvus.v2.service.collection.request.CreateCollectionReq.Function
  CreateCollectionReq.Function.FunctionBuilder<T extends CreateCollectionReq.Function.FunctionBuilder<T>>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DecayRanker.DecayRankerBuilder`	`builder()`
`Number`	`getDecay()`
`String`	`getFunction()`
`FunctionType`	`getFunctionType()`
`Number`	`getOffset()`
`Number`	`getOrigin()`
`Map<String,String>`	`getParams()`
`Number`	`getScale()`
`void`	`setDecay(Number decay)`
`void`	`setFunction(String function)`
`void`	`setOffset(Number offset)`
`void`	`setOrigin(Number origin)`
`void`	`setScale(Number scale)`
`String`	`toString()`

Methods inherited from class io.milvus.v2.service.collection.request.CreateCollectionReq.Function
getDescription, getInputFieldNames, getName, getOutputFieldNames, setDescription, setFunctionType, setInputFieldNames, setName, setOutputFieldNames, setParams

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getFunction
```
public String getFunction()
```

setFunction

public void setFunction(String function)

getOrigin
```
public Number getOrigin()
```

setOrigin

public void setOrigin(Number origin)

getOffset
```
public Number getOffset()
```

setOffset

public void setOffset(Number offset)

getScale
```
public Number getScale()
```

setScale

public void setScale(Number scale)

getDecay
```
public Number getDecay()
```

setDecay

public void setDecay(Number decay)

getFunctionType
```
public FunctionType getFunctionType()
```
Overrides:

getFunctionType in class CreateCollectionReq.Function

getParams
```
public Map<String,String> getParams()
```
Overrides:

getParams in class CreateCollectionReq.Function

toString
```
public String toString()
```
Overrides:

toString in class CreateCollectionReq.Function

builder

public static DecayRanker.DecayRankerBuilder builder()