文本排序 - V-API

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

model

string

模型名称

必需

要使用的模型名称

query

string

输入文本

必需

查询提示词，将从documents中查询匹配的提示词排序在前方

documents

array[string]

必需

待排序的候选document列表，为字符串数组

top_n

integer

可选

排序返回的top文档数量，未指定时默认返回全部候选文档，如果指定的top_n值大于输入的候选document数量，返回全部候选文档

return_documents

boolean

可选

返回的排序结果列表中是否返回每一条document原文，默认值false

默认值:

false

示例

{
    "model": "gte-rerank-v2",
    "query": "什么是文本排序模型",
    "documents": [
        "文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序",
        "量子计算是计算科学的一个前沿领域",
        "预训练语言模型的发展给文本排序模型带来了新的进展"
    ],
    "return_documents": true,
    "top_n": 5
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.gpt.ge/v1/rerank' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gte-rerank-v2",
    "query": "什么是文本排序模型",
    "documents": [
        "文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序",
        "量子计算是计算科学的一个前沿领域",
        "预训练语言模型的发展给文本排序模型带来了新的进展"
    ],
    "return_documents": true,
    "top_n": 5
}'

返回响应

🟢200成功

application/json

Body

results

array [object {3}]

必需

document

object

必需

index

integer

必需

relevance_score

number

必需

usage

object

必需

prompt_tokens

integer

必需

total_tokens

integer

必需

示例

{
    "results": [
        {
            "document": {
                "text": "文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序"
            },
            "index": 0,
            "relevance_score": 0.9334521178273196
        },
        {
            "document": {
                "text": "预训练语言模型的发展给文本排序模型带来了新的进展"
            },
            "index": 2,
            "relevance_score": 0.34100082626411193
        },
        {
            "document": {
                "text": "量子计算是计算科学的一个前沿领域"
            },
            "index": 1,
            "relevance_score": 0.005814161578735119
        }
    ],
    "usage": {
        "prompt_tokens": 79,
        "total_tokens": 79
    }
}