文档重排序

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

文档重排序

POST /v1/rerank

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

认证

BearerAuth

请求体

必填：是

application/json

字段	必填	类型	说明
model	是	string	Examples: rerank-english-v2.0
query	是	string	查询文本
documents	是	array<oneOf<string | object>>	要重排序的文档列表
top_n	否	integer	返回前 N 个结果
return_documents	否	boolean	Default: false

原始 Schema

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

响应

200 成功重排序

application/json

字段	必填	类型	说明
id	否	string	-
results	否	array<object>	-
results[].index	否	integer	-
results[].relevance_score	否	number	-
results[].document	否	object	-
meta	否	object	-

原始 Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "index": {
            "type": "integer"
          },
          "relevance_score": {
            "type": "number"
          },
          "document": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": []
          }
        },
        "x-apifox-orders": [
          "index",
          "relevance_score",
          "document"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {},
      "x-apifox-orders": []
    }
  },
  "x-apifox-orders": [
    "id",
    "results",
    "meta"
  ]
}