RetrieveKnowledgePoints - 检索知识点-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

在授权的一个或多个知识库中检索知识点，返回摘要、关系路径和歧义候选。

接口说明

在当前调用者授权范围内检索一个或多个知识库，返回知识点摘要、关系路径和歧义候选。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:RetrieveKnowledgePoints

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Query	string	是	自然语言问题，去首尾空白后不超过 256 个 Unicode 码点。	销售额如何计算，来自哪些表？
KnowledgeBaseIds	array	否	限定检索的知识库 ID 列表，1～50 个且不能重复。省略时在当前调用者授权范围内发现；显式指定的知识库逐一鉴权，任一无权限则整次请求失败。
	string	否	知识库 ID。	12345678-1234-4234-8234-123456789abc
MaxResults	integer	否	所有知识库合并后的最多命中数量，默认 10，取值 1～50；不是每个知识库的配额，也不是翻页大小。	10
FocusObjects	array<object>	否	聚焦检索的图对象，最多 2 个且不能重复。对象必须处于当前授权检索范围内，不扩大权限。
	object	否
KnowledgeBaseId	string	是	知识点所属的知识库 ID。与 Type、Id 一起定位知识点。	12345678-1234-4234-8234-123456789abc
Type	string	是	知识点读取类别。当前聚焦对象和图节点使用 GRAPH。	GRAPH
Id	string	是	知识点定位 ID。请从检索结果原样复制，并与所属 KnowledgeBaseId、Type 一起使用，不要自行解析或转换。	node-sales

返回参数

名称	类型	描述	示例值
	object	接口成功响应。
RequestId	string	本次请求的唯一标识，可用于定位问题。	00000000-0000-4000-8000-000000000001
Success	boolean	本次请求是否成功。
Data	object	本次检索的知识点摘要、关系路径、歧义候选和提示。
Results	array<object>	按统一相关性返回的知识点摘要，跨库总数不超过 MaxResults。可包含 GRAPH、WIKI 和 KNOWLEDGE_CONTENT。
	array<object>
KnowledgeBaseId	string	知识点所属的知识库 ID。与 Type、Id 一起定位知识点。	12345678-1234-4234-8234-123456789abc
Type	string	知识点读取类别：GRAPH 为局部图，WIKI 为主题页面，KNOWLEDGE_CONTENT 为知识内容。	GRAPH
Id	string	知识点定位 ID。请从检索结果原样复制，并与所属 KnowledgeBaseId、Type 一起使用，不要自行解析或转换。	node-sales
Title	string	当前知识点的展示标题。	销售额
Summary	string	知识点的可读摘要，不保证包含完整内容；需要详情时调用 GetKnowledgePoint。	销售额指标及其关联订单表。
Sources	array<object>	当前内容明确关联的上传原文档下载信息。无可靠来源或无原文件读取权限时省略；可检索知识点不代表可以下载完整原文件。
	object
FileName	string	构建使用的完整原文档文件名，不是当前知识点片段名称。	销售制度.pdf
DownloadUrl	string	原文件的 HTTPS 临时下载地址，有效期为 2 小时。仅在来源可可靠定位且调用者有原文件读取权限时返回；请勿公开转发或长期保存。	https://example.com/sales-policy.pdf
ExpirationTime	integer	下载地址的过期时间，Unix 毫秒时间戳。	1794376800000
Paths	array<object>	本次检索匹配的对象关系路径，与 Results 不按数组下标配对；不承诺穷尽全部关系。
	array<object>
Nodes	array<object>	本条关系路径中的图节点。每个节点可通过 KnowledgeBaseId、Type、Id 读取详情。
	object
KnowledgeBaseId	string	知识点所属的知识库 ID。与 Type、Id 一起定位知识点。	12345678-1234-4234-8234-123456789abc
Type	string	知识点读取类别。当前聚焦对象和图节点使用 GRAPH。	GRAPH
Id	string	知识点定位 ID。请从检索结果原样复制，并与所属 KnowledgeBaseId、Type 一起使用，不要自行解析或转换。	node-sales
Title	string	当前知识点的展示标题。	销售额
Edges	array<object>	连接本条路径 Nodes 中节点的有向关系。
	object
FromId	string	同一路径 Nodes 中起点节点的 Id。	node-sales
ToId	string	同一路径 Nodes 中终点节点的 Id。	node-orders
RelationType	string	从起点指向终点的公开关系类型。例如 CALCULATED_FROM 表示起点基于终点计算；不能仅凭类型推断完整公式。	CALCULATED_FROM
Ambiguities	array<object>	尚未确认目标时返回的歧义描述及候选对象。
	array<object>
Mention	string	查询中尚未确定所指对象的名称或描述。	销售额
Candidates	array<object>	存在歧义时的候选图节点。候选携带可读取详情的 KnowledgeBaseId、Type、Id，不表示用户已确认选择。
	object
KnowledgeBaseId	string	知识点所属的知识库 ID。与 Type、Id 一起定位知识点。	12345678-1234-4234-8234-123456789abc
Type	string	知识点读取类别。当前聚焦对象和图节点使用 GRAPH。	GRAPH
Id	string	知识点定位 ID。请从检索结果原样复制，并与所属 KnowledgeBaseId、Type 一起使用，不要自行解析或转换。	node-sales
Title	string	当前知识点的展示标题。	销售额
Warnings	array<object>	本次调用的裁剪、范围受限或降级提示。根据 Code 判断，Message 仅用于阅读说明。
	object
Code	string	裁剪或降级提示码。例如 CONTENT_TRUNCATED 表示内容有裁剪，SOURCE_UNAVAILABLE 表示原文下载暂不可用。	CONTENT_TRUNCATED
Message	string	当前提示的安全化可读说明。程序判断请使用 Code，不依赖文案。	部分内容超过长度限制，已裁剪。
Code	string	业务错误代码。成功时可省略；失败遵循公共错误响应协议。	InvalidParameter
Message	string	业务错误的可读说明，成功时可省略。失败定位时请同时提供 RequestId。	The request parameters are invalid.

示例

正常返回示例

JSON格式

{
  "RequestId": "00000000-0000-4000-8000-000000000001",
  "Success": true,
  "Data": {
    "Results": [
      {
        "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
        "Type": "GRAPH",
        "Id": "node-sales",
        "Title": "销售额",
        "Summary": "销售额指标及其关联订单表。",
        "Sources": [
          {
            "FileName": "销售制度.pdf",
            "DownloadUrl": "https://example.com/sales-policy.pdf",
            "ExpirationTime": 1794376800000
          }
        ]
      }
    ],
    "Paths": [
      {
        "Nodes": [
          {
            "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
            "Type": "GRAPH",
            "Id": "node-sales",
            "Title": "销售额"
          }
        ],
        "Edges": [
          {
            "FromId": "node-sales",
            "ToId": "node-orders",
            "RelationType": "CALCULATED_FROM"
          }
        ]
      }
    ],
    "Ambiguities": [
      {
        "Mention": "销售额",
        "Candidates": [
          {
            "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
            "Type": "GRAPH",
            "Id": "node-sales",
            "Title": "销售额"
          }
        ]
      }
    ],
    "Warnings": [
      {
        "Code": "CONTENT_TRUNCATED",
        "Message": "部分内容超过长度限制，已裁剪。"
      }
    ]
  },
  "Code": "InvalidParameter",
  "Message": "The request parameters are invalid."
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	The request parameters are invalid.
403	Forbidden	You are not authorized to perform this operation.
404	ResourceNotFound	The requested resource does not exist or is not visible.
503	ServiceUnavailable	The service is temporarily unavailable.

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

变更历史

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