AI 助理
文档备案控制台
官方文档
首页 大数据开发治理平台 DataWorks 开发参考 API参考（2024-05-18） API目录 其他 GetKnowledgePoint - 获取知识点详情

GetKnowledgePoint - 获取知识点详情

更新时间：
复制 MD 格式
产品详情
我的收藏

读取单个知识点的当前详情，支持局部图、主题页面和知识内容。

接口说明

读取一个知识点的当前详情。GRAPH 返回以指定节点为中心的一跳局部图；WIKI 和 KNOWLEDGE_CONTENT 返回可读内容。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:GetKnowledgePoint

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
KnowledgeBaseId

string

是

知识点所属的知识库 ID。与 Type、Id 一起定位知识点。

12345678-1234-4234-8234-123456789abc
Type

string

是

知识点读取类别：GRAPH 为局部图，WIKI 为主题页面，KNOWLEDGE_CONTENT 为知识内容。

枚举值：

  • GRAPH
  • WIKI
  • KNOWLEDGE_CONTENT

GRAPH
Id

string

是

知识点定位 ID。请从检索结果原样复制，并与所属 KnowledgeBaseId、Type 一起使用，不要自行解析或转换。

node-sales
MaxResults

integer

否

仅 Type=GRAPH 可传，表示每页最多返回的关系数，默认 20，取值 1～100。WIKI 和 KNOWLEDGE_CONTENT 不接受此参数。

20
NextToken

string

否

分页游标。请求第一页时不传；后续页原样使用上次响应的 NextToken。响应为空表示没有下一页；即使当前页为空，游标非空仍应继续。仅 Type=GRAPH 使用，须保持同一知识库、入口和 MaxResults。

eyJvZmZzZXQiOjIwfQ

返回参数

名称

类型

描述

示例值

object

接口成功响应。

RequestId

string

本次请求的唯一标识，可用于定位问题。

00000000-0000-4000-8000-000000000001
Success

boolean

本次请求是否成功。

Data

object

单个知识点的类型化详情。Graph、Wiki、KnowledgeContent 仅返回与 Type 对应的一项。

KnowledgeBaseId

string

知识点所属的知识库 ID。与 Type、Id 一起定位知识点。

12345678-1234-4234-8234-123456789abc
Type

string

知识点读取类别：GRAPH 为局部图，WIKI 为主题页面，KNOWLEDGE_CONTENT 为知识内容。

GRAPH
Id

string

知识点定位 ID。请从检索结果原样复制，并与所属 KnowledgeBaseId、Type 一起使用，不要自行解析或转换。

node-sales
NextToken

string

分页游标。请求第一页时不传；后续页原样使用上次响应的 NextToken。响应为空表示没有下一页；即使当前页为空，游标非空仍应继续。仅 Type=GRAPH 使用，须保持同一知识库、入口和 MaxResults。

eyJvZmZzZXQiOjIwfQ
Graph

object

仅 Type=GRAPH 返回。以请求 Id 为入口的一跳局部图，包含入口、本页关系及其可见端点。

KnowledgeBaseId

string

知识点所属的知识库 ID。与 Type、Id 一起定位知识点。

12345678-1234-4234-8234-123456789abc
RootNodeId

string

本次局部图入口节点 ID，与请求 Id 一致。

node-sales
Nodes

array<object>

入口节点和本页关系涉及的全部可见端点，按 NodeId 去重；后续页仍包含入口。

object

KnowledgeBaseId

string

知识点所属的知识库 ID。与 Type、Id 一起定位知识点。

12345678-1234-4234-8234-123456789abc
NodeId

string

当前知识库图内的节点 ID，可作为 Type=GRAPH 的 Id 读取该节点局部图。

node-sales
Type

string

图节点的业务类别，例如 TABLE 表示数据表；不是知识点读取类别。

TABLE
Name

string

图节点的展示名称。

销售额
Definition

string

图节点的可靠业务定义；没有可公开定义时省略。

已支付订单的实付金额之和。
Description

string

当前节点或关系的可读补充说明，无可靠内容时省略。

销售额基于订单实付金额计算。
EntityId

string

可可靠定位的 DataWorks 数据地图资产 ID；不是图节点 NodeId，无唯一可靠资产映射时省略。

maxcompute-table:::sales:public:orders
Aliases

array

节点的可靠别名列表，无别名时可省略。

string

当前节点的一个别名。

实付销售额
Edges

array<object>

本页可见的一跳邻接关系，每条边至少一端为 RootNodeId，两端都在本页 Nodes 中。

array<object>

KnowledgeBaseId

string

知识点所属的知识库 ID。与 Type、Id 一起定位知识点。

12345678-1234-4234-8234-123456789abc
EdgeId

string

当前知识库图内的关系 ID。

edge-sales-orders
FromNodeId

string

关系起点节点的 NodeId，起点应存在于同页 Graph.Nodes。

node-sales
ToNodeId

string

关系终点节点的 NodeId，终点应存在于同页 Graph.Nodes。

node-orders
RelationType

string

从起点指向终点的公开关系类型。例如 CALCULATED_FROM 表示起点基于终点计算；不能仅凭类型推断完整公式。

CALCULATED_FROM
Description

string

当前节点或关系的可读补充说明，无可靠内容时省略。

销售额基于订单实付金额计算。
Join

object

已验证关联关系的类型化字段关联信息；无可靠、完整字段配对时省略。

JoinKeys

array<object>

两端节点的等值关联字段配对；复合键完整返回。

object

FromField

string

FromNodeId 对应节点的关联字段名。

customer_id
ToField

string

ToNodeId 对应节点的关联字段名。

id
Cardinality

string

从起点指向终点的关联基数，可靠时返回 ONE_TO_ONE、ONE_TO_MANY、MANY_TO_ONE 或 MANY_TO_MANY。

MANY_TO_ONE
UpdateTime

integer

当前图最近完成发布的时间，可靠时返回。

1794373200000
Wiki

object

仅 Type=WIKI 返回的主题页面标题、Markdown 正文及可选来源。

Title

string

当前知识点的展示标题。

销售额
Content

string

当前可公开的 Markdown 正文；知识内容可能是文档片段或结构化知识的可读投影，不保证是原文件全文。

销售额按已支付订单的实付金额汇总。
Sources

array<object>

当前内容明确关联的上传原文档下载信息。无可靠来源或无原文件读取权限时省略；可检索知识点不代表可以下载完整原文件。

object

FileName

string

构建使用的完整原文档文件名，不是当前知识点片段名称。

销售制度.pdf
DownloadUrl

string

原文件的 HTTPS 临时下载地址，有效期为 2 小时。仅在来源可可靠定位且调用者有原文件读取权限时返回；请勿公开转发或长期保存。

https://example.com/sales-policy.pdf
ExpirationTime

integer

下载地址的过期时间，Unix 毫秒时间戳。

1794376800000
KnowledgeContent

object

仅 Type=KNOWLEDGE_CONTENT 返回的知识内容标题、Markdown 正文及可选来源。

Title

string

当前知识点的展示标题。

销售额
Content

string

当前可公开的 Markdown 正文；知识内容可能是文档片段或结构化知识的可读投影，不保证是原文件全文。

销售额按已支付订单的实付金额汇总。
Sources

array<object>

当前内容明确关联的上传原文档下载信息。无可靠来源或无原文件读取权限时省略；可检索知识点不代表可以下载完整原文件。

object

FileName

string

构建使用的完整原文档文件名，不是当前知识点片段名称。

销售制度.pdf
DownloadUrl

string

原文件的 HTTPS 临时下载地址，有效期为 2 小时。仅在来源可可靠定位且调用者有原文件读取权限时返回；请勿公开转发或长期保存。

https://example.com/sales-policy.pdf
ExpirationTime

integer

下载地址的过期时间，Unix 毫秒时间戳。

1794376800000
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": {
    "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
    "Type": "GRAPH",
    "Id": "node-sales",
    "NextToken": "eyJvZmZzZXQiOjIwfQ",
    "Graph": {
      "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
      "RootNodeId": "node-sales",
      "Nodes": [
        {
          "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
          "NodeId": "node-sales",
          "Type": "TABLE",
          "Name": "销售额",
          "Definition": "已支付订单的实付金额之和。",
          "Description": "销售额基于订单实付金额计算。",
          "EntityId": "maxcompute-table:::sales:public:orders",
          "Aliases": [
            "实付销售额"
          ]
        }
      ],
      "Edges": [
        {
          "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
          "EdgeId": "edge-sales-orders",
          "FromNodeId": "node-sales",
          "ToNodeId": "node-orders",
          "RelationType": "CALCULATED_FROM",
          "Description": "销售额基于订单实付金额计算。",
          "Join": {
            "JoinKeys": [
              {
                "FromField": "customer_id",
                "ToField": "id"
              }
            ],
            "Cardinality": "MANY_TO_ONE"
          }
        }
      ],
      "UpdateTime": 1794373200000
    },
    "Wiki": {
      "Title": "销售额",
      "Content": "销售额按已支付订单的实付金额汇总。",
      "Sources": [
        {
          "FileName": "销售制度.pdf",
          "DownloadUrl": "https://example.com/sales-policy.pdf",
          "ExpirationTime": 1794376800000
        }
      ]
    },
    "KnowledgeContent": {
      "Title": "销售额",
      "Content": "销售额按已支付订单的实付金额汇总。",
      "Sources": [
        {
          "FileName": "销售制度.pdf",
          "DownloadUrl": "https://example.com/sales-policy.pdf",
          "ExpirationTime": 1794376800000
        }
      ]
    },
    "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.

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

变更历史

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

上一篇：GrantKnowledgeBaseRetrieval - 授予知识库检索权限下一篇：RemoveKnowledgeBaseAdministrator - 移除知识库管理员