SearchLumaKnowledgeBase - 在 Luma Agent 绑定的知识库中检索内容-事件总线(EventBridge)-阿里云帮助中心

在 Luma Agent 绑定的知识库中检索内容，返回相关文本块及其相关性得分。

接口说明

在 Luma Agent 绑定的知识库中检索内容，返回相关文本块及其相关性得分。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
AgentName	string	是	Agent 名称	my_agent
Catalog	string	是	Agent 已绑定的数据目录名称。可通过 ListLumaCatalogs 获取	my_catalog
Namespace	string	是	Agent 已绑定的命名空间名称。可通过 ListLumaNamespaces 获取	my_namespace
KnowledgeBaseName	string	是	Agent 已绑定的知识库名称。可通过 ListLumaKnowledgeBases 获取	my-knowledge-base
Query	string	是	自然语言检索内容	如何配置事件规则
Mode	string	否	取值：vector（向量检索）、keyword（关键词检索）、hybrid（混合检索）。不传时由知识库的检索配置决定	hybrid
TopK	integer	否	取值范围 1~100，不传时由知识库的检索配置决定	5
Rerank	boolean	否	启用后对召回结果做重排序，精度更高、耗时更长。不传时由知识库的检索配置决定	true
MetadataFilter	string	否	JSON 字符串，按文档元数据过滤召回范围。可用字段见知识库的 MetadataSchema	{"category":"faq"}

返回参数

名称	类型	描述	示例值
	object
Message	string	接口返回的提示信息，成功时为 Operation success，失败时为具体错误描述	Operation success
RequestId	string	本次请求的唯一标识，用于问题排查与工单反馈	34AD682D-5B91-5773-8132-AA38C130****
Data	object	Agent 绑定知识库的检索结果
Chunks	array	检索命中的切片列表，按相关度排序	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","ChunkSeq":3,"Content":"EventBridge 支持事件路由"}]
	KnowledgeBaseSearchChunk	单个检索命中的切片详细信息，包含相关性分数、切片正文与定位信息
TimeSpent	integer	本次检索耗时，单位毫秒	1200
Code	string	接口返回码，Success 表示成功，失败时为具体错误码	Success
Success	boolean	本次调用是否成功，true 表示成功	true

示例

正常返回示例

JSON格式

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Data": {
    "Chunks": [
      {
        "ChunkSeq": 12,
        "Content": "EventBridge 支持将事件路由到多种目标服务。",
        "DocumentId": "doc-bp1xxxxxxxxxxxx",
        "FileName": "product-handbook.pdf",
        "Score": 0.92,
        "Scores": {
          "Fusion": 0.78,
          "Keyword": 0.62,
          "Rerank": 0.91,
          "Vector": 0.85
        },
        "SourceLocation": "p.3",
        "TitlePath": "安装指南>前置条件"
      }
    ],
    "TimeSpent": 1200
  },
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	The specified parameter is invalid
403	ServiceNotEnable	Service not enable
404	AgentNotFound	Agent not found
404	ResourceNotFound	The specified resource is not bound to the agent

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

变更历史

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