文档中心 > API类目 > 三方AI项目

taobao.agent.model.rerank.capacity (文档重排序能力)

根据查询文本对文档列表进行相关性重排序,文本排序模型能对召回的文档进行二次精准排序,确保将与用户查询最相关的结果排在最前,有效提升应用准确率。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
origin_biz_params String 可选 {"a":"aaaa","b","bbbbb"} 业务参数,平台会针对具体的业务要求调用方上传不同格式的业务参数用于平台校验,具体格式在对接时的文档中体现
documents Document 可选 待排序的候选文档列表。每个元素是一个字符串。最多包含500个文档,每个文档长度不超过4,000个Token
  • └ text
  • String
  • 可选
  • 文本排序模型广泛用于搜索引擎和推荐系统中,它们根据文本相关性对候选文本进行排序
  • 待重排的文档内容,长度不超过4,000个Token
query String 可选 什么是文本排序模型 查询文本。最大长度不能超过4000个Token
model String 可选 gte-rerank-v2 指定具体的模型,可选的模型列表由平台定义给出枚举,接入文档中说明
top_n Number 可选 1 返回排序后的top_n个文档。默认返回全部文档。如果指定的值大于文档总数,将返回全部文档

响应参数

名称 类型 示例值 描述
documents DocumentWithScore [] 返回排序后的文档集合
  • └ score
  • String
  • 0.34343
  • 权重分数
  • └ text
  • String
  • 文本排序模型广泛用于搜索引擎和推荐系统中,它们根据文本相关性对候选文本进行排序
  • 与用户查询最相关的结果文档内容

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AgentModelRerankCapacityRequest req = new AgentModelRerankCapacityRequest();
req.setOriginBizParams("{\"a\":\"aaaa\",\"b\",\"bbbbb\"}");
AgentModelRerankCapacityRequest.Document obj1 = new AgentModelRerankCapacityRequest.Document();
obj1.setText("文本排序模型广泛用于搜索引擎和推荐系统中,它们根据文本相关性对候选文本进行排序");
req.setDocuments(obj1);
req.setQuery("什么是文本排序模型");
req.setModel("gte-rerank-v2");
req.setTopN(1L);
AgentModelRerankCapacityResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<agent_model_rerank_capacity_response>
    <documents>
        <document_with_score>
            <score>0.34343</score>
            <text>文本排序模型广泛用于搜索引擎和推荐系统中,它们根据文本相关性对候选文本进行排序</text>
        </document_with_score>
    </documents>
</agent_model_rerank_capacity_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部