Rerank¶
根据查询意图为候选内容重新排序,并返回精排结果。
POST https://token.moi.matrixorigin.cn/v1/rerank
调用前准备¶
准备具有 Genesis 权限的访问凭据、支持 Rerank 的模型 ID,以及候选内容与业务 ID 的映射。
请求体¶
将 $GENESIS_ACCESS_TOKEN 替换为访问令牌或服务账号 API Key,将 $MODEL_ID 替换为要调用的模型 ID。
curl -X POST \
"https://token.moi.matrixorigin.cn/v1/rerank" \
-H "Authorization: Bearer $GENESIS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"model": "'"$MODEL_ID"'",
"query": "什么是检索增强生成?",
"documents": [
"RAG 通过检索外部知识库增强模型回答能力。",
"深度学习是机器学习的一个分支。",
"向量数据库可以存储和检索高维向量。"
],
"top_n": 2,
"return_documents": true
}'
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
是 |
要调用的 Rerank 模型 ID。 |
|
string |
是 |
用于判断候选内容相关性的查询文本。 |
|
array of string |
是 |
待重排的文本候选内容。 |
|
integer |
否 |
要返回的最高相关性结果数量。 |
|
boolean |
否 |
是否在结果中返回原始候选内容。 |
成功响应¶
服务返回候选内容的重排结果。
{
"id": "<REQUEST_ID>",
"model": "<MODEL_ID>",
"results": [
{
"index": 0,
"relevance_score": 0.987,
"document": "RAG 通过检索外部知识库增强模型回答能力。"
}
]
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
本次重排序请求的标识。 |
|
string |
实际处理请求的模型 ID。 |
|
array of object |
按相关性排序的结果列表。 |
下面表格展开示例中 results 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
原始 |
|
number |
当前模型给出的相关性分数,仅在相同模型和业务语境内比较。 |
|
string 或 object |
|
下面表格展开示例中 results[].document 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
|
错误响应¶
{
"error": {
"message": "<可读错误信息>",
"type": "<错误类型,可能省略>",
"code": "<错误代码,可能省略>"
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
object |
错误对象。 |
下面表格展开示例中 error 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
可读错误信息。 |
|
string |
错误类别,可能省略。 |
|
string 或 null |
错误代码,可能省略。 |