cto

排序模型

POST

https://api.agicto.cn/v1/rerank

请求参数

Header 参数

Authorization

string

必需

示例值:

Bearer $API_KEY

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

model

string

模型

必需

query

string

需匹配内容

必需

top_n

integer

必需

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

documents

array[string]

必需

待排序的候选document列表

示例

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

返回响应

🟢200成功

application/json

Body

results

array [object {2}]

必需

请求的算法输出内容，是一个结构化的数组。每一个数组中包含一个对应的输入text的算法输出内容

index

integer

必需

本结构中的算法结果对应的document在输入候选documents数组中的位置索引值

relevance_score

number

必需

相似度分数取值0.0-1.0之间（浮点型）

usage

object

必需

total_tokens

integer

必需

示例

{
    "results": [
        {
            "index": 0,
            "relevance_score": 0.72042775
        },
        {
            "index": 1,
            "relevance_score": 0.60077465
        }
    ],
    "usage": {
        "total_tokens": 0
    }
}

生成图片

图片生成(Imagine)