API reference · Kjarni 0.2.7

Class Reranker

Namespace: Kjarni
Assembly: Kjarni.dll

Text reranking model using cross-encoders.

public class Reranker : IDisposable

Inheritance

object ← Reranker

Implements

IDisposable

Constructors

Reranker(string?, string, string?, bool)

Create a new Reranker with default settings.

public Reranker(string? model = null, string device = "cpu", string? cacheDir = null, bool quiet = false)

Parameters

model string?

device string

cacheDir string?

quiet bool

Methods

Dispose()

Releases the native model. The object cannot be used afterwards.

public void Dispose()

~Reranker()

Releases the native model if was not called.

protected ~Reranker()

Rerank(string, string[])

Rerank documents by relevance to query.

public RerankResult[] Rerank(string query, string[] documents)

Parameters

query string

documents string[]

Returns

RerankResult[]

RerankTopK(string, string[], int)

Rerank and return top-k results.

public RerankResult[] RerankTopK(string query, string[] documents, int k)

Parameters

query string

documents string[]

k int

Returns

RerankResult[]

Score(string, string)

Score a single query-document pair.

public float Score(string query, string document)

Parameters

query string

document string

Returns

float

Kjarni runs the same engine on every platform: