获取关系概览

接口说明

读取知识库文件关系的简要概览。

接口信息

字段	值
方法	GET
路径	/openapi/v2/knowledge-bases/{knowledgeBaseId}/graph/overview
Operation ID	getGraphOverview
鉴权	Bearer OpenAPI key

入参

名称	位置	必填	类型	示例	说明
knowledgeBaseId	path	是	string	knowledge-base-11111111-1111-4111-8111-111111111111	知识库 API 返回的知识库标识。

请求体

这个接口没有请求体。

请求示例

curl -X GET "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/graph/overview" \
  -H "Authorization: Bearer <openapi-key>"

成功响应

200

返回当前可读取知识库版本的文件关系数量和继续探索链接。

字段	必填	类型	说明
activeContentRevision	是	integer	当前可读取知识库内容的修订号。
availability	是	available | empty | unavailable	当前可读取知识库版本是否包含可读取的关系数据。空结果不表示知识库为空。
summary	是	object	当前文件关系的节点、边和质量摘要。
resources	是	object	可继续读取的关系文件和接口链接。
readActions	是	object	用于读取文件或继续探索文件关系的 Developer OpenAPI 链接。

成功响应示例

{
  "activeContentRevision": 1,
  "availability": "available",
  "summary": {
    "readableFileCount": 24,
    "relationshipCount": 18
  },
  "resources": {
    "graphIndexPath": "_graph/index.md",
    "byDirectoryPath": "_graph/by-directory",
    "byFilePath": "_graph/by-file"
  },
  "readActions": {
    "graphIndexContent": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/files/content?path=_graph%2Findex.md",
    "listGraphRoot": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/tree?parentPath=_graph",
    "listRelationshipsByDirectory": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/tree?parentPath=_graph%2Fby-directory",
    "listRelationshipsByFile": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/tree?parentPath=_graph%2Fby-file"
  }
}

错误码

下表列出这个接口已声明的全部错误响应。

HTTP 状态	错误码	说明
401	UNAUTHORIZED	Bearer API key 缺失、格式错误、未知、已撤销或已删除。
404	NOT_FOUND	请求的资源不存在。
429	RATE_LIMITED	请求超过当前配置的速率限制。
500	INTERNAL_ERROR	API 遇到内部错误。
503	DATABASE_REPOSITORY_UNAVAILABLE	当前接口所需的数据暂时不可用。

后续操作

• 列出文件树
• 搜索文件