Package org.mockserver.model

Class RerankResponse

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.RerankResponse

public class RerankResponse
extends ObjectWithJsonToString

Configuration for a mocked rerank response (Cohere /v1/rerank, Voyage /v1/rerank, ...). A rerank endpoint scores a list of candidate documents against a query and returns them ordered by relevance.

MockServer derives one result per candidate document from the request, scoring each with a relevance score (descending) — reproducible when deterministicFromInput is set, otherwise random. Each result is a {"index":N,"relevance_score":F} entry; the surrounding envelope is provider-specific (Cohere: top-level results; Voyage: OpenAI-style data list with an object/usage wrapper).

Constructor Summary

Constructors

Constructor	Description
RerankResponse()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Boolean	getDeterministicFromInput()
Long	getSeed()
Integer	getTopN()
int	hashCode()
static RerankResponse	rerank()
RerankResponse	withDeterministicFromInput(Boolean deterministicFromInput)
RerankResponse	withSeed(Long seed)
RerankResponse	withTopN(Integer topN)	Cap the number of returned results to the top N most-relevant documents (mirrors the provider top_n request parameter).

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

fieldsExcludedFromEqualsAndHashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RerankResponse

public RerankResponse()

Method Details

rerank

public static RerankResponse rerank()

withTopN

public RerankResponse withTopN(Integer topN)

Cap the number of returned results to the top N most-relevant documents (mirrors the provider top_n request parameter). When null, every candidate document is returned.

getTopN

public Integer getTopN()

withDeterministicFromInput

public RerankResponse withDeterministicFromInput(Boolean deterministicFromInput)

getDeterministicFromInput

public Boolean getDeterministicFromInput()

withSeed

public RerankResponse withSeed(Long seed)

getSeed

public Long getSeed()

equals

public boolean equals(Object o)

Overrides:

equals in class ObjectWithReflectiveEqualsHashCodeToString

hashCode

public int hashCode()

Overrides:

hashCode in class ObjectWithReflectiveEqualsHashCodeToString