文本重排序

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

POST /paas/v4/rerank

文本重排序

cURL

curl --request POST \
  --url https://open.bigmodel.cn/api/paas/v4/rerank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "rerank",
  "query": "查询候选文本A",
  "top_n": 4,
  "documents": [
    "需要打分的候选文本A",
    "需要打分的候选文本B"
  ]
}
'

import requests

url = "https://open.bigmodel.cn/api/paas/v4/rerank"

payload = {
    "model": "rerank",
    "query": "查询候选文本A",
    "top_n": 4,
    "documents": ["需要打分的候选文本A", "需要打分的候选文本B"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'rerank',
    query: '查询候选文本A',
    top_n: 4,
    documents: ['需要打分的候选文本A', '需要打分的候选文本B']
  })
};

fetch('https://open.bigmodel.cn/api/paas/v4/rerank', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://open.bigmodel.cn/api/paas/v4/rerank")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"rerank\",\n  \"query\": \"查询候选文本A\",\n  \"top_n\": 4,\n  \"documents\": [\n    \"需要打分的候选文本A\",\n    \"需要打分的候选文本B\"\n  ]\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://open.bigmodel.cn/api/paas/v4/rerank"

	payload := strings.NewReader("{\n  \"model\": \"rerank\",\n  \"query\": \"查询候选文本A\",\n  \"top_n\": 4,\n  \"documents\": [\n    \"需要打分的候选文本A\",\n    \"需要打分的候选文本B\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.bigmodel.cn/api/paas/v4/rerank",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => 'rerank',
    'query' => '查询候选文本A',
    'top_n' => 4,
    'documents' => [
        '需要打分的候选文本A',
        '需要打分的候选文本B'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

{
  "id": "20241120141244890ab4ee4af84acf",
  "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
  },
  "created": 1732083164,
  "request_id": "1111111111"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

标准的 HTTP Bearer 认证方式，在 API Keys 页面获取密钥。

Body

application/json

model · enum<string> · required

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

Available options: rerank

Example:

"rerank"

query · string · required

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

Example:

"查询候选文本A"

documents · string[] · required

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

Example:

["需要打分的候选文本A", "需要打分的候选文本B"]

top_n · integer

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

return_documents · boolean

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

return_raw_scores · boolean

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

request_id · string

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

Required string length: 6 - 64

user_id · string

终端用户的唯一ID

Response

200

application/json

业务处理成功

id · string · required

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

Example:

"20241120141244890ab4ee4af84acf"

results · object[] · required

Show child attributes

usage · object · required

Show child attributes

created · integer<int64>

Example:

1732083164

request_id · string

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

Example:

"1111111111"