Xinference Rerank

Xinference Rerank uses a Jina AI-compatible format to rank candidate documents by relevance. Select an available Xinference rerank model; AGTCloud converts the response to the Jina AI-style structure.

Provider settings in Dify and similar clients

In clients that ask you to select a rerank provider type, choose Jina AI and enter an available Xinference rerank model ID.

POST/v1/rerank

Call a Xinference reranking model with the Jina AI-compatible format. AGTCloud normalizes the response to the Jina AI structure, so the request method, fields, and response shape match Jina Rerank.

Use a Xinference Rerank model visible to the current API key. Keep the query clear and specific, keep candidate documents semantically complete and within the model's token limit, process large collections in batches, and use top_n to limit the returned results.

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Request Body

application/json

Xinference document reranking request parameters.

TypeScript Definitions

Use the request body type in TypeScript.

model*string

The Xinference Rerank model ID visible to the current API Key.

Length1 <= length

query*string

Query text used for ranking the relevance of candidate documents. It is recommended to use clear and specific expressions to avoid queries that are too broad or vague.

Length1 <= length

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.

Items1 <= items

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.

Response Body

`application/json`

curl -X POST "https://example.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "query": "What is the capital of the United States?",    "documents": [      "The capital of Nevada is Carson City.",      "The Northern Mariana Islands are a group of islands in the Pacific Ocean, with Saipan as its capital.",      "Washington, D.C. (also known as Washington or D.C., officially the District of Columbia) is the capital of the United States.",      "In English grammar, capitalization is used at the beginning of words. English usage differs from other languages.",      "The death penalty existed in the United States before it became a nation. As of 2017, the death penalty was legal in 30 out of 50 states."    ],    "top_n": 3  }'

{
  "results": [
    {
      "document": {
        "text": "Washington, D.C. (also known as Washington or D.C., officially the District of Columbia) is the capital of the United States."
      },
      "index": 2,
      "relevance_score": 0.999071
    },
    {
      "document": {
        "text": "The capital of Nevada is Carson City."
      },
      "index": 0,
      "relevance_score": 0.32713068
    },
    {
      "document": {
        "text": "The Northern Mariana Islands are a group of islands in the Pacific Ocean, with Saipan as its capital."
      },
      "index": 1,
      "relevance_score": 0.1867867
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

Authorization

Request Body

Response Body

200application/json

400

401

429

500

`application/json`