Retrieve

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

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

向量检索 Top K，通过生成输入文本的向量并在知识库中检索与其向量表示最相似的 K 个文本切片。K 的取值范围[0-100]。 DenseSimilarityTopK和SparseSimilarityTopK二者之和小于等于 200。

默认值为 100。

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

• true：开启。

• false：不开启。

默认值为 true。

枚举值：

• true :

  开启

• false :

  不开启

是否开启多轮对话改写。 取值范围：

• true：开启。

• false：不开启。

默认值为 false。

枚举值：

• true :

  开启

• false :

  不开启

重排序配置。

重排序配置对象。

使用指定的排序模型。此处指定值将覆盖创建知识库时所选择的排序模型。取值范围：

• qwen3-rerank-hybrid：qwen3-rerank(hybrid)排序。

• qwen3-rerank：qwen3-rerank 排序。

• gte-rerank-hybrid：gte-rerank(hybrid)排序。

• gte-rerank：gte-rerank 排序。

默认值为空，使用创建知识库时选择的排序模型。

枚举值：

• gte-rerank-hybrid :

  gte-rerank(hybrid)排序

• gte-rerank :

  gte-rerank 排序

枚举值：

• similar: 相似模式。 :

  similar: 相似模式。

• custom: 自定义模式。 :

  custom: 自定义模式。

• qa:（默认值） 问答模式。 :

  qa:（默认值） 问答模式。

提供一个自然语言指令，用于精细化控制重排序模型的行为。

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

当未指定具体值时，默认采用该知识库配置的相似度阈值。

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

多轮对话改写配置。

多轮对话改写配置对象。

多轮对话改写模型名称。它会基于会话上下文自动调整原始输入 prompt（用户问题）以提升检索效果。取值范围：

• conv-rewrite-qwen-1.8b：conv-rewrite-qwen-1.8b 模型（目前只支持该模型）

默认值为空，采用 conv-rewrite-qwen-1.8b 模型。

枚举值：

• conv-rewrite-qwen-1.8b :

  conv-rewrite-qwen-1.8b 模型

关键词检索 TopK，即在知识库中查找与输入文本的关键词精确匹配的切片。它可以帮助您过滤掉无关的文本切片，提供更准确的结果。 取值范围[0-100]。 DenseSimilarityTopK和SparseSimilarityTopK二者之和小于等于 200。

默认值为：100。

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

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

• true：保存。

• false：不保存。

默认值为：false。

支持通过 SearchFilter 设置个性化的检索条件（比如标签），对语义检索结果进行过滤，以排除与查询 Query 无关的信息。 设置 is_displayed_chunk_content 参数为 true 生效筛选逻辑，具体内容请参见知识库 SearchFilters。

检索条件对象。

支持在提问时传入图片 URL 地址。

多轮对话改写支持您传入自己管理的对话历史。仅在 EnableRewrite=true 时生效（否则即使传入也不生效）。

角色。

取值范围：

• user：传入此角色，此时 content 表示您输入给阿里云百炼应用的文本。

• assistant：传入此角色，此时 content 表示阿里云百炼应用的回复。

对应角色的问题或者回答内容。

错误状态码。

接口业务数据字段。

命中的文本切片列表。

文本切片对象。

文本切片的相似度得分，可能值范围：[0-1]。

文本切片内容。

错误信息。

请求 ID。

接口返回的状态码。

接口调用是否成功，可能值为：

• true：成功。

• false：失败。