生成知识点网络

开发中

POST

http://127.0.0.1:5100/network

上传本地的所有课程的topic和point，返回由这些知识点构成的图数据结构。数据结构由ECharts定义。

注意对应关系：Node.name - NodeLink.source/NodeLink.target，NodeCategory.idx - Node.category。

请求参数

Body 参数application/json

lectures

array [object {3}]

必需

integer

课程id

必需

是节点路由的一部分。

topic

string

课程主题

必需

是节点名。

points

array[object (Point) {5}]

必需

其中的name是节点名，也是节点路由的一部分。importance和节点大小有关。

示例

{
    "lectures": [
        {
            "id": 0,
            "topic": "string",
            "points": [
                {
                    "name": "string",
                    "importance": 1,
                    "subtitles": [
                        {
                            "subtitle": "string",
                            "md": "string",
                            "raw_recognition": [
                                {
                                    "start": 0,
                                    "end": 0,
                                    "text": "string"
                                }
                            ]
                        }
                    ],
                    "links": [
                        {
                            "name": "string",
                            "href": "string"
                        }
                    ],
                    "summary": "string"
                }
            ]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1:5100/network' \
--header 'Content-Type: application/json' \
--data-raw '{
    "lectures": [
        {
            "id": 0,
            "topic": "string",
            "points": [
                {
                    "name": "string",
                    "importance": 1,
                    "subtitles": [
                        {
                            "subtitle": "string",
                            "md": "string",
                            "raw_recognition": [
                                {
                                    "start": 0,
                                    "end": 0,
                                    "text": "string"
                                }
                            ]
                        }
                    ],
                    "links": [
                        {
                            "name": "string",
                            "href": "string"
                        }
                    ],
                    "summary": "string"
                }
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

nodes

array[object (Node) {5}]

节点

必需

注意：课程主题topic和课程的所有知识点point都会作为节点。

idx

integer | null

节点索引

已废弃

节点编号，从0开始。

>= 0

name

string

节点名称

必需

可能是topic或者point.name，主键，关联NodeLink.source/target

categories

array[object (NodeCategory) {2}]

节点类别

必需

注意：每个topic为一个category。

idx

integer

类别索引

必需

主键，从0开始依次编号，和Node中的category节点相对应。

name

string

类别名

必需

值和topic相同。

links

array[object (NodeLink) {4}]

节点链接

必需

注意：topic节点和其子point节点之间需要建立链接、各point之间也可以建立链接。

source

string

来源节点

必需

关联Node.name，外键。

target

string

目标节点

必需

关联Node.name，外键。

weight

integer

关系权重

必需

1-5。数字越大表示关系越紧密。

>= 1<= 5

isUserGenerated

boolean

是否由用户自己链接

可选

所有从后端传来的NodeLink此字段均为false.

默认值:

false

示例

{
    "nodes": [
        {
            "idx": 0,
            "name": "string",
            "category": 0,
            "size": 1,
            "route": {
                "id": 0,
                "point": "string",
                "subtitle": "string"
            }
        }
    ],
    "categories": [
        {
            "idx": 0,
            "name": "string"
        }
    ],
    "links": [
        {
            "source": "string",
            "target": "string",
            "weight": 1,
            "isUserGenerated": false
        }
    ]
}

修改于 2025-02-15 11:07:10

生成笔记要素

导出笔记PDF