Sign in

v28

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-03-11543173.3 KB
Rerankings

Reranking

Score and rank documents by their relevance to queries with an Isaacus reranker.

post/rerankings

Request body

querystring required

The query to evaluate the relevance of the texts to.

The query must contain at least one non-whitespace character.

Unlike the texts being reranked, the query cannot be so long that it exceeds the maximum input length of the reranker.

textsstring[] required

The texts to rerank.

There must be at least one text.

Each text must contain at least one non-whitespace character.

top_ninteger nullable

A whole number greater than or equal to 1.

is_iqlboolean

Whether the query should be interpreted as an Isaacus Query Language (IQL) query, which is not the case by default.

If you allow untrusted users to construct their own queries, think carefully before enabling IQL since queries can be crafted to consume an excessively large amount of tokens.

scoring_method'auto' | 'chunk_max' | 'chunk_avg' | 'chunk_min'

The method to use for producing an overall relevance score for a text that exceeds the model's local context window and has, therefore, been split into multiple chunks.

auto is the default scoring method and is recommended for most use cases. Currently, it is equivalent to chunk_max. In the future, it will automatically select the best method based on the model and inputs.

chunk_max uses the highest relevance score of all of a text's chunks.

chunk_avg averages the relevance scores of all of a text's chunks.

chunk_min uses the lowest relevance score of all of a text's chunks.

Example request

{
  "model": "kanon-2-reranker",
  "query": "What are the essential elements required to establish a negligence claim?",
  "texts": [
    "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",
    "Criminal cases involve a completely different standard, requiring proof beyond a reasonable doubt.",
    "In a negligence claim, the plaintiff must prove duty, breach, causation, and damages.",
    "Negligence in tort law requires establishing a duty of care that the defendant owed to the plaintiff.",
    "The concept of negligence is central to tort law, with courts assessing whether a breach of duty caused harm."
  ],
  "top_n": null,
  "is_iql": false,
  "scoring_method": "auto",
  "chunking_options": {
    "size": null,
    "overlap_ratio": null,
    "overlap_tokens": null
  }
}

Response

Request fulfilled, document follows

Example response

{
  "results": [
    {
      "index": 2,
      "score": 0.7727372261985272
    },
    {
      "index": 3,
      "score": 0.7332913519466231
    },
    {
      "index": 4,
      "score": 0.32399687407609323
    },
    {
      "index": 1,
      "score": 0.09480246485705024
    },
    {
      "index": 0,
      "score": 0.06929198572432578
    }
  ],
  "usage": {
    "input_tokens": 170
  }
}