跳转到主要内容
POST
/
v1
/
rerank
cURL
curl --request POST \
  --url https://proxy.innk.cc/v1/rerank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "query": "<string>",
  "documents": [
    "<string>"
  ],
  "top_n": 123,
  "return_documents": true,
  "max_chunk_per_doc": 123,
  "overlap_tokens": 79
}
'
{
  "id": "<string>",
  "results": [
    {
      "document": {
        "text": "<string>"
      },
      "index": 123,
      "relevance_score": 123
    }
  ],
  "tokens": {
    "input_tokens": 123,
    "output_tokens": 123
  }
}

Authorizations

Authorization
string
header
required

身份验证标头格式为 Bearer <API_KEY>,其中 <API_KEY> 是您的API令牌。

Body

application/json
model
string
required

对应模型名称。为提升服务质量,我们将定期对本服务提供的模型进行调整,包括但不限于模型上线/下线以及模型服务功能的调整。我们将尽可能通过公告或消息推送等适当方式通知您此类变更。

query
string
required

搜索查询

documents
string[]
required

目前仅支持字符串列表。未来将支持文档对象。

Minimum array length: 1
top_n
integer

要返回的最相关文档或索引的数量。

return_documents
boolean

如果为假,则响应不包含文档文本;如果为真,则响应包含输入文档文本。

max_chunk_per_doc
integer

文档中生成的最大数据块数。长文档会被分割成多个数据块进行计算,取其中得分最高的数据块作为文档的最终得分。

overlap_tokens
integer

文档分块时相邻块之间的标记重叠数量。

必填范围: x <= 80

Response

200 - application/json

Rerank response

id
string
required
results
object[]
required
tokens
object
required