切换外观
执行文本重排
Bearer 鉴权并透传到重排能力上游。
POST/v1/rerank- 鉴权与权益
- positive-balance
- 入口语境
- general-balance
POST /v1/rerank 接口
方法:
POST路径:
/v1/rerank入口家族:
general-balance计费语境:
balance调用前置:
positive-balance
鉴权
BearerAuth
请求
请求体:application/json
json
{"$ref":"#/components/schemas/RerankRequest"}响应
| 状态 | 说明 | Schema |
|---|---|---|
| 200 | 成功 | {"$ref":"#/components/schemas/OpenAiUpstreamResponse"} |
| 400 | 本地请求错误或供应商同状态响应 | {"oneOf":[{"$ref":"#/components/schemas/OpenAiError"},{"$ref":"#/components/schemas/OpenAiUpstreamResponse"}]} |
| 401 | API Key 无效或供应商同状态响应 | {"oneOf":[{"$ref":"#/components/schemas/OpenAiError"},{"$ref":"#/components/schemas/OpenAiUpstreamResponse"}]} |
| 402 | 余额或套餐权益不足或供应商同状态响应 | {"oneOf":[{"$ref":"#/components/schemas/OpenAiError"},{"$ref":"#/components/schemas/OpenAiUpstreamResponse"}]} |
| 404 | 模型不可用或供应商同状态响应 | {"oneOf":[{"$ref":"#/components/schemas/OpenAiError"},{"$ref":"#/components/schemas/OpenAiUpstreamResponse"}]} |
| 429 | 日限额、套餐额度、并发限制或供应商同状态响应 | {"oneOf":[{"$ref":"#/components/schemas/OpenAiError"},{"$ref":"#/components/schemas/OpenAiUpstreamResponse"}]} |
| 500 | 平台内部错误或供应商同状态响应 | {"oneOf":[{"$ref":"#/components/schemas/OpenAiError"},{"$ref":"#/components/schemas/OpenAiUpstreamResponse"}]} |
| 502 | 上游连接异常或供应商同状态响应 | {"oneOf":[{"$ref":"#/components/schemas/OpenAiError"},{"$ref":"#/components/schemas/OpenAiUpstreamResponse"}]} |
| 504 | 上游超时或供应商同状态响应 | {"oneOf":[{"$ref":"#/components/schemas/OpenAiError"},{"$ref":"#/components/schemas/OpenAiUpstreamResponse"}]} |
| default | 供应商非 2xx 响应按原协议开放透传 | {"$ref":"#/components/schemas/OpenAiUpstreamResponse"} |
流式行为
non-streaming
错误
invalid_api_keymodel_not_foundinsufficient_balancebalance_daily_limit_exceededinvalid_request_errorupstream_errorupstream_timeoutinternal_error
限制
受全局请求体上限约束模型上下文与输出限制依当前模型和上游事实而定
兼容性
inventory:contract-rerankprotocol:openai-compatible
可执行示例
cURL
sh
curl --request POST "${TOKENFACTORY_API_BASE_URL}/v1/rerank" --silent --show-error --fail-with-body --max-time 60 --header "Authorization: Bearer ${TOKENFACTORY_API_KEY}" --header "Content-Type: application/json" --data "{\"model\":\"${TOKENFACTORY_MODEL_ID}\",\"query\":\"你好\",\"documents\":[\"候选文本\"]}"