NeonAPI Docs

POST /v1/rerank

身份验证

将 NeonAPI 密钥放入 Authorization: Bearer YOUR_API_KEY 请求头，在可信应用环境中保管密钥。

可用性与兼容性

调用前核对模型的协议、权限、报价和支持参数。不支持的参数可能被拒绝。示例中的密钥与模型均为占位符。

请求参数

application/json

字段	类型	必填	约束	含义
`model`	`string`	是	—	模型广场发布的准确 ID。
`query`	`string`	是	—	用于文档排序的查询。
`documents`	`string / object[]`	是	—	待排序的候选文档。
`top_n`	`integer`	否	—	—
`return_documents`	`boolean`	否	default: `false`	—

完整字段定义、嵌套对象和引用结构可在下载的规范中查看。

请求示例

export NEON_API_KEY="YOUR_API_KEY"
curl https://neon-api.com/v1/rerank \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "YOUR_MODEL_ID",
  "query": "constellation",
  "documents": [
    "A star map",
    "A travel guide"
  ]
}'

响应说明

实际字段因模型与协议而异。下方结构描述文档中的成功响应；流式请求使用对应协议的事件。

状态码	含义
200	请求成功

响应结构

字段	类型	必填	约束	含义
`id`	`string`	否	—	该结果或任务的标识符。
`results`	`object[]`	否	—	—
`meta`	`object`	否	—	—

下载用户侧 OpenAPI 规范

另见常见错误与流式响应和异步任务。

文档重排序