List rerankers

GET 
/v2/rerankers

Rerankers are used to improve the ranking (ordering) of search results.

Request

Query Parameters

filter string

A regular expression against reranker names and descriptions.

limit int32

Possible values: >= 1 and <= 100

Default value: 10

The maximum number of rerankers to return in the list.

page_key string

Used to retrieve the next page of rerankers after the limit has been reached.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

200

List of rerankers.

application/json

Schema

Schema

rerankers object[]
An array of rerankers.
Array [
id string
Possible values: Value must match regular expression rnk_[0-9]+$
The ID of the reranker.
name string
The name of the reranker.
description string
The description of the reranker.
enabled boolean
Whether the reranker is enabled.
]
metadata object

The standard metadata in the response of a list operation.

page_key string

When requesting the next page of this list, this is needed as a query parameter.

Example (from schema)

{
  "rerankers": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "enabled": true
    }
  ],
  "metadata": {
    "page_key": "string"
  }
}

403

Permissions do not allow listing rerankers.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

Loading...