AI 助理
文档备案控制台
官方文档
首页 大数据开发治理平台 DataWorks 开发参考 API参考（2024-05-18） API目录 其他 ListKnowledgeObjects - 查询知识对象列表

ListKnowledgeObjects - 查询知识对象列表

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

分页查询知识库中的知识对象。

接口说明

列出知识对象。租户和调用者身份由 POP 认证上下文确定。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值
KnowledgeBaseId

string

是

目标知识库

12345678-1234-4234-8234-123456789abc
Type

string

否

SEMANTIC_MODEL 或 DOCUMENT

枚举值：

  • DOCUMENT
  • SEMANTIC_MODEL

DOCUMENT
MaxResults

integer

否

每页最多条数

20
NextToken

string

否

分页游标

eyJvZmZzZXQiOjIwfQ

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

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

00000000-0000-4000-8000-000000000001
Success

boolean

请求是否成功

Data

object

成功时返回的业务数据。

Objects

array<object>

本页有权读取的知识对象。

array<object>

KnowledgeBaseId

string

所属知识库

12345678-1234-4234-8234-123456789abc
KnowledgeObjectId

string

按类型定位：语义模型沿用语义层 modelId；文档使用本地文档表生成的稳定 ID；调用者不解析 ID，不使用检索 ID

obj-001
Type

string

当前 SEMANTIC_MODEL 或 DOCUMENT；未来可扩展

DOCUMENT
Name

string

面向用户的名称，可编辑；重命名不改变 KnowledgeObjectId

销售制度
Description

string

简述，可编辑；传空字符串可清空

销售指标与制度文档
FileName

string

上传文档的原始文件名，只读；重命名 Name 不改变该值；外部文档和语义模型不返回

policy.md
Content

object

知识对象的类型化内容；按 Type 返回语义模型内容或文档内容。

Document

object

仅 Type=DOCUMENT 时存在

Text

string

可公开的当前文档正文，可选；尚未完成解析、未授权或无法完整、安全地提供时省略，不把单个检索片段冒充整篇文档

更新后的完整正文
ContentFormat

string

Text 存在时必填，首期 MARKDOWN 或 TEXT

MARKDOWN
SemanticModel

object

仅 Type=SEMANTIC_MODEL 时存在

Datasets

array<object>

模型包含的逻辑数据集；没有可公开数据集时为空数组

array<object>

Name

string

面向用户的名称，可编辑；重命名不改变 KnowledgeObjectId

销售制度
Description

string

简述，可编辑；传空字符串可清空

销售指标与制度文档
EntityId

string

数据地图返回的元数据实体 ID，客户端原样传递，不自行拼接。

maxcompute-table:::project_name:schema_name:table_name
PrimaryKey

array

已明确声明的主键字段名，可选；每项必须存在于本数据集 Fields

string

已明确声明的主键字段名，可选；每项必须存在于本数据集 Fields

order_id
Fields

array<object>

数据集已定义且允许公开的字段；未提供字段定义时为空数组

object

Name

string

面向用户的名称，可编辑；重命名不改变 KnowledgeObjectId

销售制度
Description

string

简述，可编辑；传空字符串可清空

销售指标与制度文档
DataType

string

字段数据类型；公开的模型字段必须提供，不由服务端猜测

BIGINT
Metrics

array<object>

模型中可执行的指标；没有时为空数组，不混入只有候选公式的指标

array<object>

Name

string

面向用户的名称，可编辑；重命名不改变 KnowledgeObjectId

销售制度
Description

string

简述，可编辑；传空字符串可清空

销售指标与制度文档
DatasetName

string

所属 SemanticDataset.Name，必须能在本模型 Datasets 中定位

orders
Unit

string

明确声明的指标单位，可选；没有可靠来源时不返回

CNY
Expression

object

可执行表达式，必须包含至少一个方言版本；不由模型补写

Dialects

array<object>

同一指标在不同 SQL 方言下的表达式，至少一项；同一方言不重复

object

Dialect

string

SQL 方言，例如 MaxCompute 或 ANSI_SQL

MaxCompute
Sql

string

该方言下的非空计算表达式，不是完整查询语句

SUM(pay_amount)
Relationships

array<object>

模型内已定义且可用字段配对表达的关联关系；没有时为空数组，不从图路径猜测

array<object>

Name

string

面向用户的名称，可编辑；重命名不改变 KnowledgeObjectId

销售制度
FromDataset

string

起点 SemanticDataset.Name

orders
ToDataset

string

终点 SemanticDataset.Name

customers
JoinKeys

array<object>

关系两端字段的等值关联配对；复合关联按字段逐项配对。

object

FromField

string

起点数据集中参与关联的字段名，须在 FromDataset 对应数据集的 Fields 中定义。

customer_id
ToField

string

终点数据集中参与关联的字段名，须在 ToDataset 对应数据集的 Fields 中定义。

id
SizeBytes

integer

上传原文件的字节数，只读；不是编辑后的正文长度

1024
SourceReferences

array<object>

来源引用数组，当前返回空数组。

object

Type

string

来源引用类别，结构保留 KNOWLEDGE_SOURCE；当前 SourceReferences 为空数组。

DOCUMENT
SourceId

string

仅 KNOWLEDGE_SOURCE 时存在，本库登记的 KnowledgeSource.SourceId

src-001
CreateTime

integer

对象首次形成时间

1790200800000
ModifyTime

integer

当前内容最近更新时间

1790200800000
Editable

boolean

当前调用者是否具备完整内容编辑权限；OWNER、ADMIN 为 true，VIEWER 为 false，写入仍重新鉴权

VersionNo

integer

SEMANTIC_MODEL 当前读取的版本；更新内容时传此值，版本可原地编辑

1
DownloadUrl

string

该规范 YAML 文件的临时下载地址，有效期以 ExpiresIn 为准。

https://example.invalid/short-lived-result-download
ExpiresIn

integer

知识对象下载链接有效期，单位为秒；当前为 300 秒。

300
DownloadFiles

array<object>

多文件规范 YAML 的下载项，包含文件名与临时下载地址。

object

FileName

string

上传文档的原始文件名，只读；重命名 Name 不改变该值；外部文档和语义模型不返回

policy.md
DownloadUrl

string

该规范 YAML 文件的临时下载地址，有效期以 ExpiresIn 为准。

https://example.invalid/short-lived-result-download
NextToken

string

下一页游标；没有下一页时为 null

eyJvZmZzZXQiOjIwfQ
Code

string

业务错误码；请求失败时用于判断错误类型。

InvalidParameter
Message

string

请求失败时的安全错误信息。

请求参数不合法。
MaxResults

integer

每页最多条数

20

示例

正常返回示例

JSON格式

{
  "RequestId": "00000000-0000-4000-8000-000000000001",
  "Success": true,
  "Data": {
    "Objects": [
      {
        "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
        "KnowledgeObjectId": "obj-001",
        "Type": "DOCUMENT",
        "Name": "销售制度",
        "Description": "销售指标与制度文档",
        "FileName": "policy.md",
        "Content": {
          "Document": {
            "Text": "更新后的完整正文",
            "ContentFormat": "MARKDOWN"
          },
          "SemanticModel": {
            "Datasets": [
              {
                "Name": "销售制度",
                "Description": "销售指标与制度文档",
                "EntityId": "maxcompute-table:::project_name:schema_name:table_name",
                "PrimaryKey": [
                  "order_id"
                ],
                "Fields": [
                  {
                    "Name": "销售制度",
                    "Description": "销售指标与制度文档",
                    "DataType": "BIGINT"
                  }
                ]
              }
            ],
            "Metrics": [
              {
                "Name": "销售制度",
                "Description": "销售指标与制度文档",
                "DatasetName": "orders",
                "Unit": "CNY",
                "Expression": {
                  "Dialects": [
                    {
                      "Dialect": "MaxCompute",
                      "Sql": "SUM(pay_amount)"
                    }
                  ]
                }
              }
            ],
            "Relationships": [
              {
                "Name": "销售制度",
                "FromDataset": "orders",
                "ToDataset": "customers",
                "JoinKeys": [
                  {
                    "FromField": "customer_id",
                    "ToField": "id"
                  }
                ]
              }
            ]
          }
        },
        "SizeBytes": 1024,
        "SourceReferences": [
          {
            "Type": "DOCUMENT",
            "SourceId": "src-001"
          }
        ],
        "CreateTime": 1790200800000,
        "ModifyTime": 1790200800000,
        "Editable": true,
        "VersionNo": 1,
        "DownloadUrl": "https://example.invalid/short-lived-result-download",
        "ExpiresIn": 300,
        "DownloadFiles": [
          {
            "FileName": "policy.md",
            "DownloadUrl": "https://example.invalid/short-lived-result-download"
          }
        ]
      }
    ],
    "NextToken": "eyJvZmZzZXQiOjIwfQ"
  },
  "Code": "InvalidParameter",
  "Message": "请求参数不合法。",
  "MaxResults": 20
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidParameter The request parameters are invalid.
400 UploadIncomplete The upload or content is invalid.
400 InputTooLarge The upload or content is 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.
409 Conflict The resource state conflicts with this operation.

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

变更历史

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

上一篇：UpdateKnowledgeBaseBuildTask - 更新知识库构建任务下一篇：RetryKnowledgeBaseBuildTaskInstance - 重试知识库构建任务实例