Sign in
Rerank

Create rerank

Rerank a list of documents based on their relevance to a query.

post/v2/router/rerank

Request body

querystring required

The search query

documentsstring[] required

A list of texts that will be compared to the query. For optimal performance we recommend against sending more than 1,000 documents in a single request.

modelstring required

The identifier of the model to use

top_ninteger

The number of most relevant documents or indices to return, defaults to the length of the documents

return_documentsboolean

Whether to return the documents in the response

filenamestring nullable

The filename of the document to rerank

namestring

The name to display on the trace. If not specified, the default system name will be used.

Example request

{
  "retry": {
    "count": 3,
    "on_codes": [
      429,
      500,
      502,
      503,
      504
    ]
  },
  "cache": {
    "ttl": 3600
  },
  "load_balancer": {
    "models": [
      {
        "model": "openai/gpt-4o",
        "weight": 0.7
      }
    ]
  },
  "timeout": {
    "call_timeout": 30000
  },
  "orq": {
    "fallbacks": [
      {
        "model": "openai/gpt-4o-mini"
      }
    ],
    "cache": {
      "ttl": 3600
    },
    "retry": {
      "count": 3,
      "on_codes": [
        429,
        500,
        502,
        503,
        504
      ]
    },
    "identity": {
      "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "display_name": "Jane Doe",
      "email": "jane.doe@example.com",
      "metadata": [
        {
          "department": "Engineering",
          "role": "Senior Developer"
        }
      ],
      "logo_url": "https://example.com/avatars/jane-doe.jpg",
      "tags": [
        "hr",
        "engineering"
      ]
    },
    "contact": {
      "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "display_name": "Jane Doe",
      "email": "jane.doe@example.com",
      "metadata": [
        {
          "department": "Engineering",
          "role": "Senior Developer"
        }
      ],
      "logo_url": "https://example.com/avatars/jane-doe.jpg",
      "tags": [
        "hr",
        "engineering"
      ]
    },
    "load_balancer": {
      "type": "weight_based",
      "models": [
        {
          "model": "openai/gpt-4o",
          "weight": 0.7
        },
        {
          "model": "anthropic/claude-3-5-sonnet",
          "weight": 0.3
        }
      ]
    },
    "timeout": {
      "call_timeout": 30000
    }
  }
}

Response

Returns the reranked documents.

idstring

A unique identifier for the rerank.

object'list' required

Changes

Changed in 12 of the 271 revisions of this API.9912

  • addad33219df111See the full diff
    • ▲

      the request property type changed from number to integer

      request-property-type-changed

    • ●

      the request property's min was set to 1.00

      request-property-min-set

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1586760a252f11See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      the request property type was generalized from integer to number

      request-property-type-generalized

    This revision also has 173 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4fdc24e562eb111See the full diff
    • ▲

      the request property type changed from number to integer

      request-property-type-changed

    • ●

      the request property's min was set to 1.00

      request-property-min-set

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • be3fe58ce38911See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      the request property type was generalized from integer to number

      request-property-type-generalized

    This revision also has 175 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f54fa34db0f4111See the full diff
    • ▲

      the request property type changed from number to integer

      request-property-type-changed

    • ●

      the request property's min was set to 1.00

      request-property-min-set

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ed68e8b009d711See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      the request property type was generalized from integer to number

      request-property-type-generalized

    This revision also has 173 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d46bd23ae34c111See the full diff
    • ▲

      the request property type changed from number to integer

      request-property-type-changed

    • ●

      the request property's min was set to 1.00

      request-property-min-set

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f459ad9381eb11See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      the request property type was generalized from integer to number

      request-property-type-generalized

    This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • deb8d376faee111See the full diff
    • ▲

      the request property type changed from number to integer

      request-property-type-changed

    • ●

      the request property's min was set to 1.00

      request-property-min-set

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f54a057bf6823See the full diff
    • ▲

      removed the enum value EMAIL of the request property ////

      request-property-enum-value-removed

    • ▲

      removed the enum value EMAIL of the request property ////

      request-property-enum-value-removed

    • ▲

      removed the enum value EMAIL of the request property ////

      request-property-enum-value-removed

Of the 271 revisions, 82 have no diff computed.