---
title: "文本重排序"
method: POST
path: "/paas/v4/rerank"
tags: ["模型 API"]
---

# 文本重排序

`POST /paas/v4/rerank`

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

## Request body

- RerankRequest
  - `model` 'rerank', required — 要调用的模型编码，默认为`rerank`。
  - `query` string, required — 查询文本，用于与候选文本进行匹配`query`，最大长度为 `4096` 字符。
  - `top_n` integer — 返回得分最高的前 `n` 条结果，默认`0`返回所有。
  - `documents` string[], required — 需要打分的候选文本数组,最多容纳 `128` 条。单条最大长度为 `4096` 字符。
  - `return_documents` boolean — 是否返回原始文本，默认值为`FALSE`。
  - `return_raw_scores` boolean — 是否返回原始分数。默认 `FALSE`。
  - `request_id` string — 请求唯一标识符。由用户端传递，`ID`长度要求：最少`6`个字符，最多`64`个字符，建议使用`UUID`格式确保唯一性，若未提供平台将自动生成。
  - `user_id` string — 终端用户的唯一`ID`

## Response `200`

业务处理成功

- RerankResponse
  - `created` integer
  - `id` string, required — 智谱开放平台生成的任务序号，调用请求结果接口时请使用此序号
  - `request_id` string — 用户在客户端请求时提交的任务编号或者平台生成的任务编号
  - `results` RerankResult[], required
    - `document` string, required — 原文本
    - `index` integer, required
    - `relevance_score` number, float, required
  - `usage` RerankUsage, required
    - `prompt_tokens` integer, required
    - `total_tokens` integer, required

## Other responses

- `default` — 请求失败。

---

[API](https://skmtc.net/bigmodel/apis/zhipu-ai-api.md) · [All operations](https://skmtc.net/bigmodel/apis/zhipu-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigmodel/zhipu-ai-api/versions/37de2d7b73de/schema)