---
title: "TextRankingPipeline"
sidebar_label: "TextRankingPipeline"
description: "Kotlin binding reference: TextRankingPipeline."
---

<!-- Generated by tools/api_reference/generate_api_docs.py. Do not edit. -->

//[clika-runtime](../../../index.md)/[io.clika.modelverse](../index.md)/[TextRankingPipeline](index.md)

# TextRankingPipeline

[common]\
class [TextRankingPipeline](index.md) : [Pipeline](../Pipeline/index.md)

Reranking over a [RerankerModel](../RerankerModel/index.md): a query and documents answer one relevance score per document, in the documents' order (`text-ranking` and its alias `reranking`); a higher score is a better match, and the caller sorts.

## Properties

| Name | Summary |
|---|---|
| [model](model.md) | [common]<br>open override val [model](model.md): [RerankerModel](../RerankerModel/index.md)<br>The loaded model the pipeline runs. |
| [task](../Pipeline/task.md) | [common]<br>val [task](../Pipeline/task.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)<br>The task the pipeline serves, in transformers' spelling. |

## Functions

| Name | Summary |
|---|---|
| [close](../Pipeline/close.md) | [common]<br>open fun [close](../Pipeline/close.md)(): &lt;Error class: unknown class&gt; |
| [invoke](invoke.md) | [common]<br>operator fun [invoke](invoke.md)(query: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), documents: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)&lt;[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)&gt;, instruction: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)? = null): [FloatArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float-array/index.html) |