调用RetrieveKnowledgeBase对知识库进行语义混合检索与元数据过滤-人工智能平台PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

检索知识库。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pailangstudio:RetrieveKnowledgeBase

none

*全部资源

*

无

请求语法

POST /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/action/retrieve HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
KnowledgeBaseId	string	否	知识库 ID。	d-ksicx823d

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求体。
WorkspaceId	string	是	知识库所在工作空间 ID。	174***
Query	string	是	检索内容。	red car
TopK	integer	否	返回排名最高的结果数。	5
ScoreThreshold	number	否	相似度分数阈值。浮点型，取值范围[0, 1]。	0.5
MetaDataFilterConditions	string	否	选填。元数据过滤检索条件。格式为 JSON 格式字符串，JSON 字段定义如下： FilterCondition: 逻辑关系，取值：and、or。 MetaDataFilters：过滤条件。多个条件之间按 FilterCondition 的逻辑关系处理。其中 Key 表示元数据 Key；Value 表示元数据值；Operator 表示运算符，取值：==、!=、contains，contains 仅支持 file_name 字段。	{ "FilterCondition": "and", "MetaDataFilters": [ { "Key": "key1", "Value": "value1", "Operator": "==" }, { "Key": "key2", "Value": "value2", "Operator": "!=" }, { "Key": "file_name", "Value": "prefix", "Operator": "contains" } ] }
QueryMode	string	否	检索模式。 dense: 语义检索。 hybrid: 混合检索。枚举值： hybrid : hybrid dense : dense	dense
VersionName	string	否	知识库版本。默认 v1。	v1
RerankConfig	string	否	Rerank 配置，选填。JSON 格式字符串，JSON 字段定义如下： ConnectionId：模型服务连接 ID Model：模型名称。若为百炼类型连接，支持的模型为 gte-rerank-v2 TopK：返回排名最高的结果数	{ "ConnectionId":"conn-xxx", "Model": "qwen-max", "TopK": 5 }
RewriteConfig	string	否	Rewrite 配置，选填。JSON 格式字符串，JSON 字段定义如下： ConnectionId：模型服务连接 ID Model：模型名称。百炼连接支持的模型为 qwen3-max、qwen-plus、qwen-flash Temprature：用于控制大模型生成内容的随机性，值越高结果越随机。取值范围 [0, 2.0]。 TopP：生成过程中的核采样方法概率阈值，取值范围 [0, 1.0] PresensePenalty：存在惩罚，取值范围 [-2.0, 2.0] FrequencyPenalty：频率惩罚，取值范围 [-2.0~2.0] Seed：随机数种子，取值范围 [0, 2147483647] MaxTokens：控制模型生成结果的长度 Stop：停止序列列表。遇到列表中的任何一个序列，模型停止输出。最多支持 4 个序列。 EnableThingking：是否启用推理	{ "ConnectionId":"conn-xxx", "Model": "qwen-max", "Temperature": 0.7, "TopP": 0.9, "PresencePenalty": 0.5, "FrequencyPenalty": 0.5, "Seed": 0, "MaxTokens": 1024, "Stop": [], "EnableThinking": true }
HybridStrategyConfig	string	否	混合检索策略配置，选填。JSON 格式字符串，JSON 字段定义如下： Strategy：混合检索策略。取值为 rrf（RRF 融合）和 weighted（加权融合） RRFK：RRF 融合平滑参数，取值范围 [1, 100] Weight：weighted 策略的权重，该值表示向量语义检索对最终得分的贡献比例。取值范围 [0, 1.0]	{ "Strategy": "rrf", "RRFK":60, "Weight": 0.5 }

返回参数

名称	类型	描述	示例值
	object
KnowledgeBaseFileChunks	array	知识库切片列表。
	KnowledgeBaseFileChunk	知识库切片详情。

示例

正常返回示例

JSON格式

{
  "KnowledgeBaseFileChunks": [
    {
      "Score": 0.9832,
      "ChunkId": "7fjs******90fs",
      "ChunkStart": 0,
      "ChunkEnd": 30000,
      "ChunkSequence": 0,
      "ChunkContent": "content of chunk",
      "ChunkSize": 3452,
      "ChunkStatus": "Enable",
      "DownloadUrl": "https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******",
      "ThumbnailUrl": "https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******",
      "ChunkAttachment": [
        {
          "PlaceholderId": "IMAGE_PLACEHOLDER_0",
          "Type": "image",
          "Uri": "oss://mybucket/file1/img1.jpg",
          "DownloadUrl": "https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNm******"
        }
      ],
      "MetaData": {
        "FileName": "abc.txt",
        "FileUri": "oss://mybucket/path/abc.txt",
        "FileMetaId": "sd8c******67ux"
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。