Jina Rerank

The Jina Rerank API ranks candidate documents by relevance to a query and returns the original document, index, relevance score, and token usage. Requests and responses use the Jina AI-style field structure.

POST/v1/rerank

Calculate the relevance score of candidate documents based on the query text and return the ranking result according to relevance. AGTCloud returns sorting results using the Jina AI style, and some compatible interfaces will also convert to this structure.

queries and documents can be used in multiple languages. To obtain more stable ranking results, clear and specific queries should be used to keep the document content complete and avoid a single document exceeding the token limit of the selected model. It is recommended to process large numbers of documents in batches; Stable and repetitive queries can be cached on the application side

Authorization

bearerAuth

AuthorizationBearer <token>

Use Bearer your-api-key in the Authorization Header.

In: header

Request Body

application/json

Document reranking request parameters.

TypeScript Definitions

Use the request body type in TypeScript.

model?string

Reranking model ID, such as jina-reranker-v2-base-multilingual. Use a model available to the current account.

query*string

Query text used for relevance ranking of candidate documents. It is recommended to use clear and specific queries; Queries expressed in similar language to documents usually yield stable results.

top_n?integer

Number of highest-relevance documents to return. When omitted, all results are returned. Set this value to reduce unnecessary result transfer and processing.

documents*array<string>

Documents to rerank. Keep each document complete and semantically clear, and within the selected model's token limit. Process large collections in batches; documents may contain multiple languages.

Response Body

`application/json`

curl -X POST "https://example.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "query": "Organic skincare products for sensitive skin",    "top_n": 3,    "documents": [      "Organic skincare for sensitive skin with aloe vera and chamomile...",      "New makeup trends focus on bold colors and innovative techniques...",      "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."    ]  }'

{
  "results": [
    {
      "document": {
        "text": "Organic skincare for sensitive skin with aloe vera and chamomile..."
      },
      "index": 0,
      "relevance_score": 0.8783142566680908
    },
    {
      "document": {
        "text": "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
      },
      "index": 2,
      "relevance_score": 0.762467586994171
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`