Rerank documents

Request body

• modelstring必填

  Rerank model id; list candidates with listModels?type=reranking. Router support (supported): Verified to take effect.

  Verified to take effect.

• querystring必填

  Query to rank the documents against, at least 1 character. Router support (supported): Verified to take effect.

  Verified to take effect.

• documentsarray必填◐ Partially supported

  Documents to rank, as plain strings, at least one. Router support (partial): Only string arrays are supported; object arrays return 400.

  Only string arrays are supported; object arrays return 400.

• top_ninteger可选

  Number of best results to return, at least 1; omit it to return every document. Router support (supported): Controls returned result count; zero returns 400.

  Controls returned result count; zero returns 400.

• return_documentsboolean可选○ Unsupported

  bge-reranker-base returns 400; only model, query, documents and top_n are supported.

• max_tokens_per_docinteger可选○ Unsupported

  bge-reranker-base returns 400; only model, query, documents and top_n are supported.

• rank_fieldsarray可选○ Unsupported

  bge-reranker-base returns 400; only model, query, documents and top_n are supported.

• max_chunks_per_docinteger可选○ Unsupported

  bge-reranker-base returns 400; only model, query, documents and top_n are supported.

• userstring可选○ Unsupported

  bge-reranker-base returns 400; only model, query, documents and top_n are supported.

Returns

200

Standard request fields; unrepresentable parameters return input_not_representable.

Platform errors (auth, rate limits, validation) and OCR errors use problem+json; other model call errors follow the endpoint's own format (OpenAI or Anthropic) — see error codes