创建重排序

POST /openai/v1/rerank

创建重排序

cURL

curl --request POST \
  --url https://api.highwayapi.ai/openai/v1/rerank \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "model": "<string>",
  "query": "<string>",
  "documents": [
    "<string>"
  ],
  "top_n": 123
}
'

import requests

url = "https://api.highwayapi.ai/openai/v1/rerank"

payload = {
    "model": "<string>",
    "query": "<string>",
    "documents": ["<string>"],
    "top_n": 123
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({model: '<string>', query: '<string>', documents: ['<string>'], top_n: 123})
};

fetch('https://api.highwayapi.ai/openai/v1/rerank', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.highwayapi.ai/openai/v1/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' => '<string>',
    'query' => '<string>',
    'documents' => [
        '<string>'
    ],
    'top_n' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.highwayapi.ai/openai/v1/rerank"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 123\n}")

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

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.highwayapi.ai/openai/v1/rerank")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.highwayapi.ai/openai/v1/rerank")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "results": [
    {
      "document": {
        "text": "<string>"
      },
      "index": 123,
      "relevance_score": 123
    }
  ],
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}

创建重排序

​

请求头

Content-Type · string · 必填

枚举值: application/json

Authorization · string · 必填

Bearer 身份验证格式: Bearer {{API 秘钥}}。

​

请求体

model · string · 必填

要使用的模型名称。

query · string · 必填

搜索查询。

documents · string[] · 必填

文档列表。

top_n · integer

返回的最相关文档或索引的数量。

​

响应信息

id · string · 必填

ID

results · object[] · 必填

显示 properties

document · object

原始文档内容。

显示 properties

text · string

index · integer

输入候选文档数组中位置的索引值。

relevance_score · number

相似度分数。

usage · object

Tokens 使用统计。

显示 properties

completion_tokens · integer · 必填

生成的完成中的 tokens 数量。

prompt_tokens · integer · 必填

提示中的 tokens 数量。

total_tokens · integer · 必填

请求中使用的 tokens 总数（prompt + completion）。