v1

latestOpenAPI 3.0.1ZHIPU AI 开发者协议和政策2026-07-2649130210.9 KB
模型 API

文本重排序

Rerank 用于文本重排序,通过接收用户的查询文本及候选文本列表,使用模型计算候选文本与查询文本的相关性得分并返回分数。适用于智能问答、信息检索等场景。点击 Try it 按钮可快速试用。

post/paas/v4/rerank

Request body

model'rerank' required

要调用的模型编码,默认为rerank

querystring required

查询文本,用于与候选文本进行匹配query,最大长度为 4096 字符。

top_ninteger

返回得分最高的前 n 条结果,默认0返回所有。

documentsstring[] required

需要打分的候选文本数组,最多容纳 128 条。单条最大长度为 4096 字符。

return_documentsboolean

是否返回原始文本,默认值为FALSE

return_raw_scoresboolean

是否返回原始分数。默认 FALSE

request_idstring

请求唯一标识符。由用户端传递,ID长度要求:最少6个字符,最多64个字符,建议使用UUID格式确保唯一性,若未提供平台将自动生成。

user_idstring

终端用户的唯一ID

Example request

{
  "model": "rerank",
  "query": "查询候选文本A",
  "documents": [
    "需要打分的候选文本A",
    "需要打分的候选文本B"
  ]
}

Response

业务处理成功

createdinteger
idstring required

智谱开放平台生成的任务序号,调用请求结果接口时请使用此序号

request_idstring

用户在客户端请求时提交的任务编号或者平台生成的任务编号

Example response

{
  "created": 1732083164,
  "id": "20241120141244890ab4ee4af84acf",
  "request_id": "1111111111",
  "results": [
    {
      "document": "Washington, D.C. is the capital of the United States.",
      "index": 1,
      "relevance_score": 0.99866986
    }
  ],
  "usage": {
    "prompt_tokens": 72,
    "total_tokens": 72
  }
}