对文档重新排序

发布 /rerank

API 密钥身份验证

根据文档列表与查询的相关性对文档列表重新排名。

此终结点接受查询和文档列表，然后返回按相关性分数降序排序的文档。

application/json

body 必需

查询字符串必需
字符串形式的搜索查询。

最大查询长度：
- rerank-2.5 和 rerank-2.5-lite 的 8、000 词元
- 4,000 tokens for rerank-2
- 2,000 tokens for rerank-2-lite
最小长度为 1。
文档 array[string] 必需
要重新排名的文档列表，以字符串形式提供。

约束条件：
- 最大文档数：1,000
- 每个查询+文档对的最大词元数：
  - 32、000（针对 rerank-2.5 和 rerank-2.5-lite）
  - 16,000 for rerank-2
  - 8,000 for rerank-2-lite
- 最大总词元（查询词元 × 文档数量 + 所有文档词元总和）：
  - 600K 用于 rerank-2.5、rerank-2.5-lite、rerank-2 和 rerank-2-lite
至少 1 个但不超过 1000 个元素。每个的最小长度为 1。
模型字符串必需

要使用的重排序模型。推荐型号：rerank-2.5、rerank-2.5-lite。

取值为 rerank-2.5、rerank-2.5-lite、rerank-2 或 rerank-2-lite。
top_k 整数 | null

要返回的最相关文档的数量。如果未指定，则返回所有文档及其重新排名分数。

最小值为 1。
return_documents 布尔
是否在响应中包含文档文本。
- false （默认）：仅为每个文档返回 {"index", "relevance_score"}
- true：为每个文档返回 {"index", "document", "relevance_score"}
默认值为false 。
截断布尔
是否截断超过上下文长度限制的输入。
- true （默认）：查询和文档会自动截断以适应上下文长度限制。
- false：如果查询或任何查询-文档对超过上下文长度限制，则会返回错误。
默认值为true 。

响应

200 application/json

Success
隐藏响应属性显示响应属性对象
- 对象字符串必需
  
  Realm 对象类型。始终返回“列表”。
  
  值为 list。
- 数据大量[对象] 必需
  
  数组重排名结果，按相关性分数降序排序。
  
  隐藏数据属性显示数据属性对象
  
  索引（index）整型必需
  
  文档在原始输入列表中的索引。
  
  相关性分数数字必需
  
  文档与查询的相关性分数。
  
  文档字符串
  
  文档文本。仅当 return_documents设立为 true 时包括在内。
- 模型字符串必需
  
  用于重新排名的模型的名称。
- 使用对象必需
  
  隐藏用法属性显示用法属性对象
  
  total_tokens 整型必需
  
  为重新排名操作处理的词元总数。
400 application/json

Invalid Request
隐藏响应属性显示响应属性对象
- 详细信息字符串
  
  请求无效。发生此错误的原因可能是无效的JSON、无效的参数类型、不正确的数据类型、批处理过大、词元总数超过限制或示例中的词元超过上下文长度。
401 application/json

Unauthorized
隐藏响应属性显示响应属性对象
- 详细信息字符串
  
  身份验证无效。确保您的模型API密钥在授权标头中正确指定为 Bearer VOYAGE_API_KEY。
403 application/json

Forbidden
隐藏响应属性显示响应属性对象
- 详细信息字符串
  
  禁止访问。如果发送请求的IP不被允许，则可能会发生这种情况。
429 application/json

已超过速率限制
隐藏响应属性显示响应属性对象
- 详细信息字符串
  
  已超出速率限制。您的请求频率或令牌使用量过高。降低请求速率或等待后再重试。
500 application/json

内部服务器错误
隐藏响应属性显示响应属性对象
- 详细信息字符串
  
  服务器出现意外错误。短暂等待后重试请求。
502 application/json

错误网关
隐藏响应属性显示响应属性对象
- 详细信息字符串
  
  服务器从上游服务器收到无效响应。短暂等待后重试请求。
503 application/json

服务不可用
隐藏响应属性显示响应属性对象
- 详细信息字符串
  
  由于流量过大或进行维护，该服务暂时不可用。短暂等待后重试请求。
504 application/json

网关超时
隐藏响应属性显示响应属性对象
- 详细信息字符串
  
  服务器未收到来自上游服务器的及时响应。短暂等待后重试请求。

POST /rerank

curl \
 --request POST 'https://ai.mongodb.com/v1/rerank' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"query":"string","documents":["string"],"model":"rerank-2.5","top_k":42,"return_documents":false,"truncation":true}'

请求示例

{
  "query": "string",
  "documents": [
    "string"
  ],
  "model": "rerank-2.5",
  "top_k": 42,
  "return_documents": false,
  "truncation": true
}

响应示例 (200)

{
  "object": "list",
  "data": [
    {
      "index": 42,
      "relevance_score": 42.0,
      "document": "string"
    }
  ],
  "model": "string",
  "usage": {
    "total_tokens": 42
  }
}

响应示例 (400)

{
  "detail": "string"
}

响应示例 (401)

{
  "detail": "string"
}

响应示例 (403)

{
  "detail": "string"
}

响应示例 (429)

{
  "detail": "string"
}

响应示例 (500)

{
  "detail": "string"
}

响应示例 (502)

{
  "detail": "string"
}

响应示例 (503)

{
  "detail": "string"
}

响应示例 (504)

{
  "detail": "string"
}