Amux AI

Rerank Documents

最近更新:2026年11月22日

兼容 Jina AI 与主流 RAG 框架的同步文档重排端点,对候选文档按语义相关度打分排序。

兼容 Jina AI 协议的同步文档重排端点,可直接接入 Dify、RAGFlow、LangChain、LlamaIndex 等支持 /v1/rerank 的客户端。只需将 Base URL 指向 Amux AI 并携带 Authorization: Bearer <key> 即可调用。

寻找 Jina 嵌入接口? Jina AI 的向量嵌入模型与 OpenAI 共用标准 POST /v1/embeddings 协议,因此归类在「OpenAI 兼容」分组的 Create Embeddings;各 Jina 嵌入模型的专属参数与示例请参阅「向量 / Jina AI」分区(如 Jina Embeddings v5 Text Small 与 Jina Embeddings v5 Omni Small)。

本页定义通用 POST /v1/rerank 协议结构。各模型在上下文上限、Listwise 交互架构、max_doc_length 默认值以及多模态图文输入上的差异,请参阅「重排」分区的模型文档:Jina Reranker v3.5、Jina Reranker m0 与 Jina Reranker v3。

POSThttps://gateway.amux.ai/v1/rerank

鉴权

header
Authorizationstring必填

Bearer <你的 Amux AI 密钥> 在控制台创建的 Amux AI API 密钥。

Content-Typestring必填默认 "application/json"

固定为 application/json。

请求

application/json
modelstring必填

模型规范 ID 或别名(如 jina/jina-reranker-v3.5 或 jina-reranker-v3.5)。

querystring | object必填

检索查询文本(jina-reranker-m0 亦支持传入图像对象 { image } 作为视觉查询)。

documentsarray<string | object>必填

待打分重排的非空候选文档列表(支持纯字符串、{ text },多模态模型如 jina-reranker-m0 亦支持 { image })。

top_ninteger

最多返回排名前 top_n 条结果;省略时返回全部候选文档。

return_documentsboolean默认 true

是否在返回结果中回传原始文档内容;设为 false 仅返回索引与相关度分值以节省带宽。

max_doc_lengthinteger

单篇文档最大 token 上限(1–8192,仅 v3 / v3.5 支持;省略时 v3 默认 2048、v3.5 默认 8192;m0 不提供该参数)。

return_embeddingsboolean默认 false

是否随相关度分值一并返回文档向量(仅 v3 / v3.5 支持)。

响应

200response

文档重排成功,按相关度由高到低返回。

400response

请求体格式错误、缺少 query 或 documents,或目标模型不支持重排端点。

402response

工作区账户余额不足。

协议特性说明

  • 同步非流式:重排端点不支持流式输出,传入 stream: true 将返回 400 错误。
  • 降序返回与带宽控制:响应中的 results 按 relevance_score 由高到低排序,并附带各文档在输入 documents 中的原始 index。生产检索链路可将 return_documents 设为 false,仅回传索引与分值以节省带宽。
  • 按总输入 Token 计费:重排费用按查询文本与全部候选文档合计消耗的输入 token(usage.total_tokens)结算,无输出 token 费用。
  • 端点隔离:重排模型不支持通过 /v1/chat/completions 或 /v1/embeddings 调用。

错误处理

错误响应统一采用 OpenAI 标准错误结构。上游校验失败返回 400 invalid_request 并指明具体问题字段;完整错误类型与重试策略见错误与重试。

cURL
curl https://gateway.amux.ai/v1/rerank \
  -H "Authorization: Bearer $AMUX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "jina/jina-reranker-v3.5",
    "query": "Organic skincare products for sensitive skin",
    "top_n": 2,
    "documents": [
      "Organic skincare for sensitive skin with aloe vera and chamomile.",
      "New makeup trends focus on bold colors and innovative techniques."
    ]
  }'
{
  "model": "jina/jina-reranker-v3.5",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.9421,
      "document": {
        "text": "Organic skincare for sensitive skin with aloe vera and chamomile."
      }
    }
  ],
  "usage": {
    "total_tokens": 42
  }
}