Traverser API
Traverser（图遍历）REST 接口:执行复杂的图算法和路径查询,包括最短路径、K近邻、相似度计算等高级分析功能。
3.1 traverser API 概述
HugeGraphServer 为 HugeGraph 图数据库提供了 RESTful API 接口。除了顶点和边的 CRUD 基本操作以外，还提供了一些遍历（traverser）方法，我们称为traverser API。这些遍历方法实现了一些复杂的图算法，方便用户对图进行分析和挖掘。
HugeGraph 支持的 Traverser API 包括：
- K-out API，根据起始顶点，查找恰好 N 步可达的邻居，分为基础版和高级版：
- 基础版使用 GET 方法，根据起始顶点，查找恰好 N 步可达的邻居
- 高级版使用 POST 方法，根据起始顶点，查找恰好 N 步可达的邻居，与基础版的不同在于：
- 支持只统计邻居数量
- 支持顶点和边属性过滤
- 支持返回到达邻居的最短路径
- K-neighbor API，根据起始顶点，查找 N 步以内可达的所有邻居，分为基础版和高级版：
- 基础版使用 GET 方法，根据起始顶点，查找 N 步以内可达的所有邻居
- 高级版使用 POST 方法，根据起始顶点，查找 N 步以内可达的所有邻居，与基础版的不同在于：
- 支持只统计邻居数量
- 支持顶点和边属性过滤
- 支持返回到达邻居的最短路径
- Same Neighbors, 查询两个顶点的共同邻居
- Jaccard Similarity API，计算 jaccard 相似度，包括两种：
- 一种是使用 GET 方法，计算两个顶点的邻居的相似度（交并比）
- 一种是使用 POST 方法，在全图中查找与起点的 jaccard similarity 最高的 N 个点
- Shortest Path API，查找两个顶点之间的最短路径
- All Shortest Paths，查找两个顶点间的全部最短路径
- Weighted Shortest Path，查找起点到目标点的带权最短路径
- Single Source Shortest Path，查找一个点到其他各个点的加权最短路径
- Multi Node Shortest Path，查找指定顶点集之间两两最短路径
- Paths API，查找两个顶点间的全部路径，分为基础版和高级版：
- 基础版使用 GET 方法，根据起点和终点，查找两个顶点间的全部路径
- 高级版使用 POST 方法，根据一组起点和一组终点，查找两个集合间符合条件的全部路径
- Customized Paths API，从一批顶点出发，按（一种）模式遍历经过的全部路径
- Template Path API，指定起点和终点以及起点和终点间路径信息，查找符合的路径
- Crosspoints API，查找两个顶点的交点（共同祖先或者共同子孙）
- Customized Crosspoints API，从一批顶点出发，按多种模式遍历，最后一步到达的顶点的交点
- Rings API，从起始顶点出发，可到达的环路路径
- Rays API，从起始顶点出发，可到达边界的路径（即无环路径）
- Fusiform Similarity API，查找一个顶点的梭形相似点
- Adamic-Adar API，计算两个顶点的 Adamic-Adar 指标
- Resource Allocation API，计算两个顶点的资源分配指标
- Edge Existence API，查询两个顶点之间存在的边
- Count API，统计经过若干步遍历后可达的顶点数量，不返回顶点本身
- Vertices API
- 按 ID 批量查询顶点；
- 获取顶点的分区；
- 按分区查询顶点；
- Edges API
- 按 ID 批量查询边；
- 获取边的分区；
- 按分区查询边；
3.2. traverser API 详解
使用方法中的例子，都是基于 TinkerPop 官网给出的图：
数据导入程序如下：
顶点 ID 为：
边 ID 为：
3.2.1 K-out API（GET，基础版）
3.2.1.1 功能介绍
根据起始顶点、方向、边的类型（可选）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点
Params
- source：起始顶点 id，必填项
- direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- max_depth：步数，必填项
- label：边的类型，选填项，默认代表所有 edge label
- nearest：nearest 为 true 时，代表起始顶点到达结果顶点的最短路径长度为 depth，不存在更短的路径；nearest 为 false 时，代表起始顶点到结果顶点有一条长度为 depth 的路径（未必最短且可以有环），选填项，默认为 true
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的顶点的最大数目，选填项，默认为 10000000
3.2.1.2 使用方法
Method & Url
Response Status
Response Body
3.2.1.3 适用场景
查找恰好 N 步关系可达的顶点。两个例子：
- 家族关系中，查找一个人的所有孙子，person A 通过连续的两条“儿子”边到达的顶点集合。
- 社交关系中发现潜在好友，例如：与目标用户相隔两层朋友关系的用户，可以通过连续两条“朋友”边到达的顶点。
3.2.2 K-out API（POST，高级版）
3.2.2.1 功能介绍
根据起始顶点、步骤（包括方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点。
与 K-out 基础版的不同在于：
- 支持只统计邻居数量
- 支持边属性过滤
- 支持返回到达邻居的最短路径
Params
- source：起始顶点 id，必填项
- steps: 从起始点出发的 Steps，必填项，结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- edge_steps：边 Step 集合，支持对单边的类型和属性过滤，如果为空，则不过滤
- label：边类型
- properties：边属性
- vertex_steps：顶点 Step 集合，支持对单点的类型和属性过滤，如果为空，则不过滤
- label：顶点类型
- properties：顶点属性
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注：0.12 版之前 step 内仅支持 degree 作为参数名，0.12 开始统一使用 max_degree, 并向下兼容 degree 写法)
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)
- max_depth：步数，必填项
- nearest：nearest 为 true 时，代表起始顶点到达结果顶点的最短路径长度为 depth，不存在更短的路径；nearest 为 false 时，代表起始顶点到结果顶点有一条长度为 depth 的路径（未必最短且可以有环），选填项，默认为 true
- count_only：Boolean 值，true 表示只统计结果的数目，不返回具体结果；false 表示返回具体的结果，默认为 false
- with_path：true 表示返回起始点到每个邻居的最短路径，false 表示不返回起始点到每个邻居的最短路径，选填项，默认为 false
- with_edge，选填项，默认为 false：
- 如果设置为 true，则结果将包含所有边的完整信息，即路径中的所有边
- 当 with_path 为 true 时，将返回所有路径中的边的完整信息
- 当 with_path 为 false 时，不返回任何信息
- 如果设置为 false，则仅返回边的 id
- 如果设置为 true，则结果将包含所有边的完整信息，即路径中的所有边
- with_vertex，选填项，默认为 false：
- 如果设置为 true，则结果将包含所有顶点的完整信息，即路径中的所有顶点
- 当 with_path 为 true 时，将返回所有路径中的顶点的完整信息
- 当 with_path 为 false 时，返回所有邻居顶点的完整信息
- 如果设置为 false，则仅返回顶点的 id
- 如果设置为 true，则结果将包含所有顶点的完整信息，即路径中的所有顶点
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的顶点的最大数目，选填项，默认为 10000000
- traverse_mode: 遍历方式，可选择“breadth_first_search”或“depth_first_search”作为参数，默认为“breadth_first_search”
3.2.2.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.2.3 适用场景
参见 3.2.1.3
3.2.3 K-neighbor（GET，基础版）
3.2.3.1 功能介绍
根据起始顶点、方向、边的类型（可选）和深度 depth，查找包括起始顶点在内、depth 步之内可达的所有顶点
相当于：起始顶点、K-out(1)、K-out(2)、… 、K-out(max_depth) 的并集
Params
- source: 起始顶点 id，必填项
- direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- max_depth：步数，必填项
- label：边的类型，选填项，默认代表所有 edge label
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- limit：返回的顶点的最大数目，也即遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
3.2.3.2 使用方法
Method & Url
Response Status
Response Body
3.2.3.3 适用场景
查找 N 步以内可达的所有顶点，例如：
- 家族关系中，查找一个人五服以内所有子孙，person A 通过连续的 5 条“亲子”边到达的顶点集合。
- 社交关系中发现好友圈子，例如目标用户通过 1 条、2 条、3 条“朋友”边可到达的用户可以组成目标用户的朋友圈子
3.2.4 K-neighbor API（POST，高级版）
3.2.4.1 功能介绍
根据起始顶点、步骤（包括方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发 depth 步内可达的所有顶点。
与 K-neighbor 基础版的不同在于：
- 支持只统计邻居数量
- 支持边属性过滤
- 支持返回到达邻居的最短路径
Params
- source：起始顶点 id，必填项
- steps: 从起始点出发的 Steps，必填项，结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- 从起始点出发的 Steps，必填项，结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- edge_steps：边 Step 集合，支持对单边的类型和属性过滤，如果为空，则不过滤
- label：边类型
- properties：边属性
- vertex_steps：顶点 Step 集合，支持对单点的类型和属性过滤，如果为空，则不过滤
- label：顶点类型
- properties：顶点属性
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注：0.12 版之前 step 内仅支持 degree 作为参数名，0.12 开始统一使用 max_degree, 并向下兼容 degree 写法)
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)
- max_depth：步数，必填项
- count_only：Boolean 值，true 表示只统计结果的数目，不返回具体结果；false 表示返回具体的结果，默认为 false
- with_path：true 表示返回起始点到每个邻居的最短路径，false 表示不返回起始点到每个邻居的最短路径，选填项，默认为 false
- with_edge，选填项，默认为 false：
- 如果设置为 true，则结果将包含所有边的完整信息，即路径中的所有边
- 当 with_path 为 true 时，将返回所有路径中的边的完整信息
- 当 with_path 为 false 时，不返回任何信息
- 如果设置为 false，则仅返回边的 id
- 如果设置为 true，则结果将包含所有边的完整信息，即路径中的所有边
- with_vertex，选填项，默认为 false：
- 如果设置为 true，则结果将包含所有顶点的完整信息，即路径中的所有顶点
- 当 with_path 为 true 时，将返回所有路径中的顶点的完整信息
- 当 with_path 为 false 时，返回所有邻居顶点的完整信息
- 如果设置为 false，则仅返回顶点的 id
- 如果设置为 true，则结果将包含所有顶点的完整信息，即路径中的所有顶点
- limit：返回的顶点的最大数目，选填项，默认为 10000000
3.2.4.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.4.3 适用场景
参见 3.2.3.3
3.2.5 Same Neighbors
3.2.5.1 功能介绍
查询两个点的共同邻居
Params
- vertex：一个顶点 id，必填项
- other：另一个顶点 id，必填项
- direction：顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- limit：返回的共同邻居的最大数目，选填项，默认为 10000000
3.2.5.2 使用方法
Method & Url
Response Status
Response Body
3.2.5.3 适用场景
查找两个顶点的共同邻居：
- 社交关系中发现两个用户的共同粉丝或者共同关注用户
3.2.6 Jaccard Similarity (GET)
3.2.6.1 功能介绍
计算两个顶点的 jaccard similarity（两个顶点邻居的交集比上两个顶点邻居的并集）
Params
- vertex：一个顶点 id，必填项
- other：另一个顶点 id，必填项
- direction：顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
3.2.6.2 使用方法
Method & Url
Response Status
Response Body
3.2.6.3 适用场景
用于评估两个点的相似性或者紧密度
3.2.7 Jaccard Similarity (POST)
3.2.7.1 功能介绍
计算与指定顶点的 jaccard similarity 最大的 N 个点
jaccard similarity 的计算方式为：两个顶点邻居的交集比上两个顶点邻居的并集
Params
- vertex：一个顶点 id，必填项
- 从起始点出发的 Step，必填项，结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- labels：边的类型列表
- properties：通过属性的值过滤边
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注：0.12 版之前 step 内仅支持 degree 作为参数名，0.12 开始统一使用 max_degree, 并向下兼容 degree 写法)
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)
- top：返回一个起点的 jaccard similarity 中最大的 top 个，选填项，默认为 100
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
3.2.7.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.7.3 适用场景
用于在图中找出与指定顶点相似性最高的顶点
3.2.8 Shortest Path
3.2.8.1 功能介绍
根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度，查找一条最短路径
Params
- source：起始顶点 id，必填项
- target：目的顶点 id，必填项
- direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- max_depth：最大步数，必填项
- label：边的类型，选填项，默认代表所有 edge label
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启) - capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
3.2.8.2 使用方法
Method & Url
Response Status
Response Body
3.2.8.3 适用场景
查找两个顶点间的最短路径，例如：
- 社交关系网中，查找两个用户有关系的最短路径，即最近的朋友关系链
- 设备关联网络中，查找两个设备最短的关联关系
3.2.9 All Shortest Paths
3.2.9.1 功能介绍
根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度，查找两点间所有的最短路径
Params
- source：起始顶点 id，必填项
- target：目的顶点 id，必填项
- direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- max_depth：最大步数，必填项
- label：边的类型，选填项，默认代表所有 edge label
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启) - capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
3.2.9.2 使用方法
Method & Url
Response Status
Response Body
3.2.9.3 适用场景
查找两个顶点间的所有最短路径，例如：
- 社交关系网中，查找两个用户有关系的全部最短路径，即最近的朋友关系链
- 设备关联网络中，查找两个设备全部的最短关联关系
3.2.10 Weighted Shortest Path
3.2.10.1 功能介绍
根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度，查找一条带权最短路径
Params
- source：起始顶点 id，必填项
- target：目的顶点 id，必填项
- direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- weight：边的权重属性，必填项，必须是数字类型的属性
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启) - capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- with_vertex：true 表示返回结果包含完整的顶点信息（路径中的全部顶点），false 时表示只返回顶点 id，选填项，默认为 false
3.2.10.2 使用方法
Method & Url
Response Status
Response Body
3.2.10.3 适用场景
查找两个顶点间的带权最短路径，例如：
- 交通线路中查找从 A 城市到 B 城市花钱最少的交通方式
3.2.11 Single Source Shortest Path
3.2.11.1 功能介绍
从一个顶点出发，查找该点到图中其他顶点的最短路径（可选是否带权重）
Params
- source：起始顶点 id，必填项
- direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- weight：边的权重属性，选填项，必须是数字类型的属性，如果不填或者虽然填了但是边没有该属性，则权重为 1.0
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启) - capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：查询到的目标顶点个数，也是返回的最短路径的条数，选填项，默认为 10
- with_vertex：true 表示返回结果包含完整的顶点信息（路径中的全部顶点），false 时表示只返回顶点 id，选填项，默认为 false
3.2.11.2 使用方法
Method & Url
Response Status
Response Body
3.2.11.3 适用场景
查找从一个点出发到其他顶点的带权最短路径，比如：
- 查找从北京出发到全国其他所有城市的耗时最短的乘车方案
3.2.12 Multi Node Shortest Path
3.2.12.1 功能介绍
查找指定顶点集两两之间的最短路径
Params
- vertices：定义起始顶点，必填项，指定方式包括：
- ids：通过顶点 id 列表提供起始顶点
- label 和 properties：如果没有指定 ids，则使用 label 和 properties 的联合条件查询起始顶点
- label：顶点的类型
- properties：通过属性的值查询起始顶点
注意：properties 中的属性值可以是列表，表示只要 key 对应的 value 在列表中就可以
- step：表示从起始顶点到终止顶点走过的路径，必填项，Step 的结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- labels：边的类型列表
- properties：通过属性的值过滤边
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注：0.12 版之前 step 内仅支持 degree 作为参数名，0.12 开始统一使用 max_degree, 并向下兼容 degree 写法)
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)
- max_depth：步数，必填项
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- with_vertex：true 表示返回结果包含完整的顶点信息（路径中的全部顶点），false 时表示只返回顶点 id，选填项，默认为 false
3.2.12.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.12.3 适用场景
查找多个点之间的最短路径，比如：
- 查找多个公司和法人之间的最短路径
3.2.13 Paths（GET，基础版）
3.2.13.1 功能介绍
根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度等条件查找所有路径
Params
- source：起始顶点 id，必填项
- target：目的顶点 id，必填项
- direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- max_depth：步数，必填项
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的路径的最大数目，选填项，默认为 10
3.2.13.2 使用方法
Method & Url
Response Status
Response Body
3.2.13.3 适用场景
查找两个顶点间的所有路径，例如：
- 社交网络中，查找两个用户所有可能的关系路径
- 设备关联网络中，查找两个设备之间所有的关联路径
3.2.14 Paths（POST，高级版）
3.2.14.1 功能介绍
根据起始顶点、目的顶点、步骤（step）和最大深度等条件查找所有路径
Params
- sources：定义起始顶点，必填项，指定方式包括：
- ids：通过顶点 id 列表提供起始顶点
- label 和 properties：如果没有指定 ids，则使用 label 和 properties 的联合条件查询起始顶点
- label：顶点的类型
- properties：通过属性的值查询起始顶点
注意：properties 中的属性值可以是列表，表示只要 key 对应的 value 在列表中就可以
- targets：定义终止顶点，必填项，指定方式包括：
- ids：通过顶点 id 列表提供终止顶点
- label 和 properties：如果没有指定 ids，则使用 label 和 properties 的联合条件查询终止顶点
- label：顶点的类型
- properties：通过属性的值查询终止顶点
注意：properties 中的属性值可以是列表，表示只要 key 对应的 value 在列表中就可以
- step：表示从起始顶点到终止顶点走过的路径，必填项，Step 的结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- labels：边的类型列表
- properties：通过属性的值过滤边
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注：0.12 版之前 step 内仅支持 degree 作为参数名，0.12 开始统一使用 max_degree, 并向下兼容 degree 写法)
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)
- max_depth：步数，必填项
- nearest：nearest 为 true 时，代表起始顶点到达结果顶点的最短路径长度为 depth，不存在更短的路径；nearest 为 false 时，代表起始顶点到结果顶点有一条长度为 depth 的路径（未必最短且可以有环），选填项，默认为 true
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的路径的最大数目，选填项，默认为 10
- with_vertex：true 表示返回结果包含完整的顶点信息（路径中的全部顶点），false 时表示只返回顶点 id，选填项，默认为 false
3.2.14.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.14.3 适用场景
查找两个顶点间的所有路径，例如：
- 社交网络中，查找两个用户所有可能的关系路径
- 设备关联网络中，查找两个设备之间所有的关联路径
3.2.15 Customized Paths
3.2.15.1 功能介绍
根据一批起始顶点、边规则（包括方向、边的类型和属性过滤）和最大深度等条件查找符合条件的所有的路径
Params
- sources：定义起始顶点，必填项，指定方式包括：
- ids：通过顶点 id 列表提供起始顶点
- label 和 properties：如果没有指定 ids，则使用 label 和 properties 的联合条件查询起始顶点
- label：顶点的类型
- properties：通过属性的值查询起始顶点
注意：properties 中的属性值可以是列表，表示只要 key 对应的 value 在列表中就可以
- steps：表示从起始顶点走过的路径规则，是一组 Step 的列表。必填项。每个 Step 的结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- labels：边的类型列表
- properties：通过属性的值过滤边
- weight_by：根据指定的属性计算边的权重，sort_by 不为 NONE 时有效，与 default_weight 互斥
- default_weight：当边没有属性作为权重计算值时，采取的默认权重，sort_by 不为 NONE 时有效，与 weight_by 互斥
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注：0.12 版之前 step 内仅支持 degree 作为参数名，0.12 开始统一使用 max_degree, 并向下兼容 degree 写法)
- sample：当需要对某个 step 的符合条件的边进行采样时设置，-1 表示不采样，默认为采样 100
- sort_by：根据路径的权重排序，选填项，默认为 NONE：
- NONE 表示不排序，默认值
- INCR 表示按照路径权重的升序排序
- DECR 表示按照路径权重的降序排序
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的路径的最大数目，选填项，默认为 10
- with_vertex：true 表示返回结果包含完整的顶点信息（路径中的全部顶点），false 时表示只返回顶点 id，选填项，默认为 false
3.2.15.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.15.3 适用场景
适合查找各种复杂的路径集合，例如：
- 社交网络中，查找看过张艺谋所导演的电影的用户关注的大 V 的路径（张艺谋—>电影—->用户—>大 V）
- 风控网络中，查找多个高风险用户的直系亲属的朋友的路径（高风险用户—>直系亲属—>朋友）
3.2.16 Template Paths
3.2.16.1 功能介绍
根据一批起始顶点、边规则（包括方向、边的类型和属性过滤）和最大深度等条件查找符合条件的所有的路径
Params
- sources：定义起始顶点，必填项，指定方式包括：
- ids：通过顶点 id 列表提供起始顶点
- label 和 properties：如果没有指定 ids，则使用 label 和 properties 的联合条件查询起始顶点
- label：顶点的类型
- properties：通过属性的值查询起始顶点
注意：properties 中的属性值可以是列表，表示只要 key 对应的 value 在列表中就可以
- targets：定义终止顶点，必填项，指定方式包括：
- ids：通过顶点 id 列表提供终止顶点
- label 和 properties：如果没有指定 ids，则使用 label 和 properties 的联合条件查询终止顶点
- label：顶点的类型
- properties：通过属性的值查询终止顶点
注意：properties 中的属性值可以是列表，表示只要 key 对应的 value 在列表中就可以
- steps：表示从起始顶点走过的路径规则，是一组 Step 的列表。必填项。每个 Step 的结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- labels：边的类型列表
- properties：通过属性的值过滤边
- max_times：当前 step 可以重复的次数，当为 N 时，表示从起始顶点可以经过当前 step 1-N 次
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注：0.12 版之前 step 内仅支持 degree 作为参数名，0.12 开始统一使用 max_degree, 并向下兼容 degree 写法)
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)
- with_ring：Boolean 值，true 表示包含环路；false 表示不包含环路，默认为 false
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的路径的最大数目，选填项，默认为 10
- with_vertex：true 表示返回结果包含完整的顶点信息（路径中的全部顶点），false 时表示只返回顶点 id，选填项，默认为 false
3.2.16.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.16.3 适用场景
适合查找各种复杂的模板路径，比如 personA -(朋友)-> personB -(同学)-> personC，其中"朋友"和"同学"边可以分别是最多 3 层和 4 层的情况
3.2.17 Crosspoints
3.2.17.1 功能介绍
根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度等条件查找相交点
Params
- source：起始顶点 id，必填项
- target：目的顶点 id，必填项
- direction：起始顶点到目的顶点的方向，目的点到起始点是反方向，BOTH 时不考虑方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- max_depth：步数，必填项
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的交点的最大数目，选填项，默认为 10
3.2.17.2 使用方法
Method & Url
Response Status
Response Body
3.2.17.3 适用场景
查找两个顶点的交点及其路径，例如：
- 社交网络中，查找两个用户共同关注的话题或者大 V
- 家族关系中，查找共同的祖先
3.2.18 Customized Crosspoints
3.2.18.1 功能介绍
根据一批起始顶点、多种边规则（包括方向、边的类型和属性过滤）和最大深度等条件查找符合条件的所有的路径终点的交集
Params
sources：定义起始顶点，必填项，指定方式包括：
- ids：通过顶点 id 列表提供起始顶点
- label 和 properties：如果没有指定 ids，则使用 label 和 properties 的联合条件查询起始顶点
- label：顶点的类型
- properties：通过属性的值查询起始顶点
注意：properties 中的属性值可以是列表，表示只要 key 对应的 value 在列表中就可以
path_patterns：表示从起始顶点走过的路径规则，是一组规则的列表。必填项。每个规则是一个 PathPattern
- 每个 PathPattern 是一组 Step 列表，每个 Step 结构如下：
- direction：表示边的方向（OUT,IN,BOTH），默认是 BOTH
- labels：边的类型列表
- properties：通过属性的值过滤边
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注：0.12 版之前 step 内仅支持 degree 作为参数名，0.12 开始统一使用 max_degree, 并向下兼容 degree 写法)
- skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足
skip_degree >= max_degree约束，默认为 0 (不启用)，表示不跳过任何点 (注意：开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)
- 每个 PathPattern 是一组 Step 列表，每个 Step 结构如下：
capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
limit：返回的路径的最大数目，选填项，默认为 10
with_path：true 表示返回交点所在的路径，false 表示不返回交点所在的路径，选填项，默认为 false
with_vertex，选填项，默认为 false：
- true 表示返回结果包含完整的顶点信息（路径中的全部顶点）
- with_path 为 true 时，返回所有路径中的顶点的完整信息
- with_path 为 false 时，返回所有交点的完整信息
- false 时表示只返回顶点 id
- true 表示返回结果包含完整的顶点信息（路径中的全部顶点）
3.2.18.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.18.3 适用场景
查询一组顶点通过多种路径在终点有交集的情况。例如：
- 在商品图谱中，多款手机、学习机、游戏机通过不同的低级别的类目路径，最终都属于一级类目的电子设备
3.2.19 Rings
3.2.19.1 功能介绍
根据起始顶点、方向、边的类型（可选）和最大深度等条件查找可达的环路
例如：1 -> 25 -> 775 -> 14690 -> 25, 其中环路为 25 -> 775 -> 14690 -> 25
Params
- source：起始顶点 id，必填项
- direction：起始顶点发出的边的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- max_depth：步数，必填项
- source_in_ring：环路是否包含起点，选填项，默认为 true
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的可达环路的最大数目，选填项，默认为 10
3.2.19.2 使用方法
Method & Url
Response Status
Response Body
3.2.19.3 适用场景
查询起始顶点可达的环路，例如：
- 风控项目中，查询一个用户可达的循环担保的人或者设备
- 设备关联网络中，发现一个设备周围的循环引用的设备
3.2.20 Rays
3.2.20.1 功能介绍
根据起始顶点、方向、边的类型（可选）和最大深度等条件查找发散到边界顶点的路径
例如：1 -> 25 -> 775 -> 14690 -> 2289 -> 18379, 其中 18379 为边界顶点，即没有从 18379 发出的边
Params
- source：起始顶点 id，必填项
- direction：起始顶点发出的边的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- max_depth：步数，必填项
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
- limit：返回的非环路的最大数目，选填项，默认为 10
3.2.20.2 使用方法
Method & Url
Response Status
Response Body
3.2.20.3 适用场景
查找起始顶点到某种关系的边界顶点的路径，例如：
- 家族关系中，查找一个人到所有还没有孩子的子孙的路径
- 设备关联网络中，找到某个设备到终端设备的路径
3.2.21 Fusiform Similarity
3.2.21.1 功能介绍
按照条件查询一批顶点对应的"梭形相似点"。当两个顶点跟很多共同的顶点之间有某种关系的时候，我们认为这两个点为"梭形相似点"。举个例子说明"梭形相似点"：“读者 A"读了 100 本书，可以定义读过这 100 本书中的 80 本以上的读者，是"读者 A"的"梭形相似点”
Params
sources：定义起始顶点，必填项，指定方式包括：
- ids：通过顶点 id 列表提供起始顶点
- label 和 properties：如果没有指定 ids，则使用 label 和 properties 的联合条件查询起始顶点
- label：顶点的类型
- properties：通过属性的值查询起始顶点
注意：properties 中的属性值可以是列表，表示只要 key 对应的 value 在列表中就可以
label：边的类型，选填项，默认代表所有 edge label
direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
min_neighbors：最少邻居数目，邻居数目少于这个阈值时，认为起点不具备"梭形相似点"。比如想要找一个"读者 A"读过的书的"梭形相似点"，那么
min_neighbors为 100 时，表示"读者 A"至少要读过 100 本书才可以有"梭形相似点"，必填项alpha：相似度，代表：起点与"梭形相似点"的共同邻居数目占起点的全部邻居数目的比例，必填项
min_similars：“梭形相似点"的最少个数，只有当起点的"梭形相似点"数目大于或等于该值时，才会返回起点及其"梭形相似点”，选填项，默认值为 1
top：返回一个起点的"梭形相似点"中相似度最高的 top 个，必填项，0 表示全部
group_property：与
min_groups一起使用，当起点跟其所有的"梭形相似点"某个属性的值有至少min_groups个不同值时，才会返回该起点及其"梭形相似点"。比如为"读者 A"推荐"异地"书友时，需要设置group_property为读者的"城市"属性，min_group至少为 2，选填项，不填代表不需要根据属性过滤min_groups：与
group_property一起使用，只有group_property设置时才有意义max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 10000000
limit：返回的结果数目上限（一个起点及其"梭形相似点"算一个结果），选填项，默认为 10
with_intermediary：是否返回起点及其"梭形相似点"共同关联的中间点，默认为 false
with_vertex，选填项，默认为 false：
- true 表示返回结果包含完整的顶点信息
- false 时表示只返回顶点 id
3.2.21.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.21.3 适用场景
查询一组顶点相似度很高的顶点。例如：
- 跟一个读者有类似书单的读者
- 跟一个玩家玩类似游戏的玩家
3.2.22 Vertices
3.2.22.1 根据顶点的 id 列表，批量查询顶点
Params
- ids：要查询的顶点 id 列表
Method & Url
Response Status
Response Body
3.2.22.2 获取顶点 Shard 信息
通过指定的分片大小 split_size，获取顶点分片信息（可以与 3.2.21.3 中的 Scan 配合使用来获取顶点）。
Params
- split_size：分片大小，必填项
Method & Url
Response Status
Response Body
3.2.22.3 根据 Shard 信息批量获取顶点
通过指定的分片信息批量查询顶点（Shard 信息的获取参见 3.2.21.2 Shard）。
Params
- start：分片起始位置，必填项
- end：分片结束位置，必填项
- page：分页位置，选填项，默认为 null，不分页；当 page 为“”时表示分页的第一页，从 start 指示的位置开始
- page_limit：分页获取顶点时，一页中顶点数目的上限，选填项，默认为 100000
Method & Url
Response Status
Response Body
3.2.22.4 适用场景
- 按 id 列表查询顶点，可用于批量查询顶点，比如在 path 查询到多条路径之后，可以进一步查询某条路径的所有顶点属性。
- 获取分片和按分片查询顶点，可以用来遍历全部顶点
3.2.23 Edges
3.2.23.1 根据边的 id 列表，批量查询边
Params
- ids：要查询的边 id 列表
Method & Url
Response Status
Response Body
3.2.23.2 获取边 Shard 信息
通过指定的分片大小 split_size，获取边分片信息（可以与 3.2.22.3 中的 Scan 配合使用来获取边）。
Params
- split_size：分片大小，必填项
Method & Url
Response Status
Response Body
3.2.23.3 根据 Shard 信息批量获取边
通过指定的分片信息批量查询边（Shard 信息的获取参见 3.2.22.2）。
Params
- start：分片起始位置，必填项
- end：分片结束位置，必填项
- page：分页位置，选填项，默认为 null，不分页；当 page 为“”时表示分页的第一页，从 start 指示的位置开始
- page_limit：分页获取边时，一页中边数目的上限，选填项，默认为 100000
Method & Url
Response Status
Response Body
3.2.23.4 适用场景
- 按 id 列表查询边，可用于批量查询边
- 获取分片和按分片查询边，可以用来遍历全部边
3.2.24 Adamic-Adar
3.2.24.1 功能介绍
计算两个顶点的 Adamic-Adar 指标，即每个共同邻居的度取对数后倒数之和。
Params
- vertex：一个顶点 id，必填项
- other：另一个顶点 id，必填项，不能与
vertex相同 - direction：顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- limit：参与计算的共同邻居的最大数目，选填项，默认为 10000000
3.2.24.2 使用方法
Method & Url
Response Status
Response Body
度为 0 的共同邻居会被跳过，因此两个顶点没有共同邻居时结果为 0.0。
3.2.24.3 适用场景
预测两个顶点之间是否可能出现连边，其中冷门的共同邻居比热门的共同邻居权重更高。
3.2.25 Resource Allocation
3.2.25.1 功能介绍
计算两个顶点的资源分配指标，即每个共同邻居的度的倒数之和。
Params
- vertex：一个顶点 id，必填项
- other：另一个顶点 id，必填项，不能与
vertex相同 - direction：顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- label：边的类型，选填项，默认代表所有 edge label
- max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- limit：参与计算的共同邻居的最大数目，选填项，默认为 10000000
3.2.25.2 使用方法
Method & Url
Response Status
Response Body
3.2.25.3 适用场景
连边预测，相比 Adamic-Adar 对高度数的共同邻居惩罚更强。
3.2.26 Edge Existence
3.2.26.1 功能介绍
查询起点和终点之间存在的边。
Params
- source：起始顶点 id，必填项
- target：目标顶点 id，必填项
- label：边的类型，选填项，默认代表所有 edge label
- sort_values：排序键的取值，当 edge label 的 frequency 为 MULTIPLE 时用于从多条平行边中选定一条，选填项，默认为空字符串
- limit：返回的边的最大数目，选填项，默认为 100
3.2.26.2 使用方法
Method & Url
Response Status
Response Body
3.2.26.3 适用场景
判断两个顶点之间是否直接相连，并在一次请求中拿到连接边的属性。
3.2.27 Count
3.2.27.1 功能介绍
统计从起始顶点出发，经过若干步遍历后可达的顶点数量，不返回顶点本身。
Params
- source：起始顶点 id，必填项
- steps：遍历的步骤，必填项，每个 step 支持以下字段：
- direction：顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是 BOTH
- labels：当前 step 的边类型列表，选填项，默认代表所有 edge label
- properties：当前 step 的边属性过滤条件，选填项
- max_degree：当前 step 中单个顶点遍历的最大邻接边数目，选填项，默认为 10000
- skip_degree：当前 step 中跳过超级点的阈值，选填项，默认为 100000
- contains_traversed：是否把中间各步到达的顶点也计入结果，选填项，默认为 false
- dedup_size：用于去重的顶点数上限，
-1表示不限制，选填项，默认为 1000000
3.2.27.2 使用方法
Method & Url
Request Body
Response Status
Response Body
3.2.27.3 适用场景
只关心多步邻居的规模时使用，避免序列化和传输大量顶点。