Retrieve
在指定的知识库中检索信息
服务地址：
华东2 金融云
输入参数
只看必填
Query输入文本（原始输入prompt）
DenseSimilarityTopK向量检索 Top K
EnableReranking是否开启 Rerank 重排序
请选择布尔值
EnableRewrite是否开启多轮会话改写
请选择布尔值
RerankRank配置
0Rank配置对象
ModelNameRank 模型名称
添加
RerankMinScore相似度阈值
RerankTopNRerank 后的 Top N 返回数据
Rewrite会话改写配置
0会话改写配置对象
ModelName会话改写模型名称
添加
SparseSimilarityTopK关键词检索TopK
WorkspaceId知识库所属的业务空间 ID
IndexId知识库 ID
SaveRetrieverHistory是否保存历史文本切片召回测试数据
请选择布尔值
SearchFilters支持通过SearchFilter设置个...
0检索条件对象
:
添加
添加
Images
0
添加
QueryHistory历史对话内容
0
role角色
content对应角色的问题或者回答内容
添加
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

  • RAM 用户（子账号）需要首先获取百炼的数据权限（需要AliyunBailianDataFullAccess，已包括 sfm:Retrieve 权限点），然后才能调用本接口，详见为 RAM 用户授予数据权限。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
  • 调用本接口前，请确保您的知识库已经创建完成且未被删除（即知识库 IDIndexId有效）。
  • 由于接口调用包含复杂的检索和匹配，响应时间可能较长，建议您合理设置请求的超时与重试策略。
  • 本接口具有幂等性。

限流说明： 本接口频繁调用会被限流，频率请勿超过 20 次/秒。如遇限流，请稍后重试。

请求语法

POST /{WorkspaceId}/index/retrieve HTTP/1.1

路径参数

字段名称字段详情
WorkspaceIdstring

知识库所属的业务空间 ID。获取方式请参见如何使用业务空间。

示例值:llm-3shx2gu255oqxxxx

请求参数

字段名称字段详情
Querystring

输入文本（原始输入 prompt）。Query 的长度和字符没有限制。

示例值:百炼平台介绍
DenseSimilarityTopKinteger<int32>

向量检索 Top K，通过生成输入文本的向量并在知识库中检索与其向量表示最相似的 K 个文本切片。K 的取值范围[0-100]。展开详情

示例值:100
EnableRerankingboolean

是否开启 Rerank 重排序。更多信息，请参见知识库。取值范围：展开详情

示例值:true枚举值:truefalse
EnableRewriteboolean
示例值:false枚举值:truefalse
Rerankarray<object>

Rank 配置。

RerankMinScorenumber<float>

相似度阈值。该阈值表示允许召回的文本切片的最低相似度分数，用于筛选 Rank 模型返回的文本切片，即只有分数超过此数值的文本切片才会被召回。更多信息，请参见知识库。取值范围[0.01-1.00]。此参数的优先级大于知识库相似度阈值配置。展开详情

示例值:0.20
RerankTopNinteger<int32>

Rerank 后的 Top N 返回数据。取值范围[1-20]，默认值为 5。

示例值:5
Rewritearray<object>

会话改写配置。

SparseSimilarityTopKinteger<int32>

关键词检索 TopK，即在知识库中查找与输入文本的关键词精确匹配的切片。它可以帮助您过滤掉无关的文本切片，提供更准确的结果。展开详情

示例值:100
IndexIdstring

知识库 ID，即 CreateIndex 接口返回的Data.Id。

示例值:5pwe0mxxxx参考取值来源:
    SubmitIndexJob
SaveRetrieverHistoryboolean

是否保存历史文本切片召回测试数据。取值范围：展开详情

示例值:false
SearchFiltersarray<map<string>>

支持通过 SearchFilter 设置个性化的检索条件，对语义检索结果进行过滤，以排除与查询 Query 无关的信息。使用方法请参见 知识库 SearchFilters。

Imagesarray<string>
QueryHistoryarray<object>

历史对话内容。展开详情

返回参数

字段名称字段详情
Codestring

错误状态码。

示例值:Index.InvalidParameter
Dataobject

接口业务数据字段。

Messagestring

错误信息。

示例值:Required parameter(%s) missing or invalid, please check the request parameters.
RequestIdstring

请求 ID。

示例值:17204B98-7734-4F9A-8464-2446A84821CA
Statusstring

接口返回的状态码。

示例值:200
Successboolean

接口调用是否成功，可能值为：展开详情

示例值:true
变更历史
暂无变更历史