API Key

POST /v1/rerank

API Key · POST /v1/rerank

根据查询对文档列表进行相关性重排序

POST/v1/rerank

Authorizations

Authorizationstringrequired

Use a OneAster inference API Key (Bearer sk-…).

Authorization: Bearer $ONEASTER_API_KEY

Body · application/json

modelstringrequired
querystringrequired

查询文本

documentsarrayrequired

要重排序的文档列表

top_ninteger

返回前 N 个结果

return_documentsboolean
JSON Schema
{
  "type": "object",
  "required": [
    "model",
    "query",
    "documents"
  ],
  "properties": {
    "model": {
      "type": "string",
      "example": "rerank-english-v2.0"
    },
    "query": {
      "type": "string",
      "description": "查询文本"
    },
    "documents": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "object",
            "properties": {}
          }
        ]
      },
      "description": "要重排序的文档列表"
    },
    "top_n": {
      "type": "integer",
      "description": "返回前 N 个结果"
    },
    "return_documents": {
      "type": "boolean",
      "default": false
    }
  }
}