跳转到主要内容
/v1/rerank 端点接收一个查询字符串和一组候选文档，按与查询的相关性排序后返回。重排序通常用于快速初始检索后的二次过滤——例如在 RAG 流程中进行向量相似度搜索后——以提升传递给语言模型的结果质量。 OpenOpen8 的重排序端点同时兼容 Cohere Rerank API 格式和 Jina Rerank API 格式。

​
POST /v1/rerank

​
请求体

​
model
string
必填
重排序模型，例如 rerank-english-v3.0（Cohere）或 jina-reranker-v2-base-multilingual（Jina）。可用模型取决于你配置的渠道。
​
query
string
必填
用于对文档排序的搜索查询。
​
documents
string[] | object[]
必填
要排序的文档列表。每个元素可以是字符串，或包含 text 字段的对象。
​
top_n
integer
返回的最高排名结果数。省略时返回所有文档，按相关性分数排序。
​
return_documents
boolean
设为 true 时，每个结果除索引和相关性分数外还包含原始文档文本。默认 false。
​
max_chunk_per_doc
integer
服务商内部拆分长文档时每个文档的最大分块数。
​
overlap_tokens
integer
服务商拆分长文档时分块之间的重叠 token 数。

​
响应

​
results
object[]
排序后的文档结果列表，从最相关到最不相关。
​
usage
object
请求的 token 用量。

​
示例

curl https://openopen8.ai/v1/rerank \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "rerank-english-v3.0",
    "query": "What is the capital of France?",
    "documents": [
      "Paris is the capital and largest city of France.",
      "The Eiffel Tower is located in Paris.",
      "Berlin is the capital of Germany.",
      "France has a population of over 67 million."
    ],
    "top_n": 2,
    "return_documents": true
  }'

​
响应示例

{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.9921,
      "document": { "text": "Paris is the capital and largest city of France." }
    },
    {
      "index": 1,
      "relevance_score": 0.4103,
      "document": { "text": "The Eiffel Tower is located in Paris." }
    }
  ],
  "usage": {
    "prompt_tokens": 62,
    "total_tokens": 62
  }
}

​
支持的服务商

服务商示例模型
Coherererank-english-v3.0、rerank-multilingual-v3.0
Jinajina-reranker-v2-base-multilingual、jina-reranker-v1-base-en