Skip to main content
POST
/
v1
/
rerank
curl -X POST https://www.geeknow.top/v1/rerank \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "bge-reranker-large",
    "query": "如何开启流式对话?",
    "documents": [
      "Chat Completions 请求中传入 stream true 后返回 SSE。",
      "Embedding 接口用于生成文本向量。",
      "模型列表接口用于查询可用模型。"
    ],
    "top_n": 2,
    "return_documents": true
  }'
{
  "id": "rerank_abc123",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.982,
      "document": {
        "text": "Chat Completions 请求中传入 stream true 后返回 SSE。"
      }
    },
    {
      "index": 2,
      "relevance_score": 0.417,
      "document": {
        "text": "模型列表接口用于查询可用模型。"
      }
    }
  ],
  "usage": {
    "total_tokens": 36
  }
}

Documentation Index

Fetch the complete documentation index at: https://mercury-eab3b728.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

重排序接口

Rerank 接口接收查询语句和候选文档列表,返回按相关性排序的结果。适用于 RAG 检索后重排、搜索结果优化和知识库问答。

请求体

model
string
required
重排序模型名称。
query
string
required
查询语句。
documents
array<string | object>
required
候选文档列表。可传字符串数组,也可传带元数据的对象数组,具体支持取决于上游模型。
top_n
integer
最多返回的文档数量。
return_documents
boolean
是否在响应中返回原始文档内容。
max_chunk_per_doc
integer
每个文档最多切分的 chunk 数。是否生效取决于上游重排序模型。
overlap_tokens
integer
文档切分时的重叠 token 数。是否生效取决于上游重排序模型。

请求示例

curl -X POST https://www.geeknow.top/v1/rerank \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "bge-reranker-large",
    "query": "如何开启流式对话?",
    "documents": [
      "Chat Completions 请求中传入 stream true 后返回 SSE。",
      "Embedding 接口用于生成文本向量。",
      "模型列表接口用于查询可用模型。"
    ],
    "top_n": 2,
    "return_documents": true
  }'

响应示例

{
  "id": "rerank_abc123",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.982,
      "document": {
        "text": "Chat Completions 请求中传入 stream true 后返回 SSE。"
      }
    },
    {
      "index": 2,
      "relevance_score": 0.417,
      "document": {
        "text": "模型列表接口用于查询可用模型。"
      }
    }
  ],
  "usage": {
    "total_tokens": 36
  }
}

相关接口