算法公共参数

algorithmName

是

String

参数解释：

算法名字。

约束限制：

不涉及。

取值范围：

以下显示的均为算法实际调用时的名称：

• pagerank
• personalrank
• kcore
• k_hop
• shortest_path
• all_shortest_paths
• filtered_shortest_path
• sssp
• shortest_path_of_vertex_sets
• n_paths
• closeness
• subgraph_matching
• topicrank
• label_propagation
• louvain
• link_prediction
• node2vec
• realtime_recommendation
• common_neighbors
• connected_component
• degree_correlation
• triangle_count
• cluster_coefficient
• common_neighbors_of_vertex_sets
• all_shortest_paths_of_vertex_sets
• filtered_circle_detection
• filtered_all_pairs_shortest_paths
• filtered_all_shortest_paths
• filtered_n_paths

默认取值：

不涉及。

parameters

是

Object

参数解释：

算法参数。详情请参考各算法参数描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

executionMode

否

String

参数解释：

算法参数。详情请参考各算法参数描述。

约束限制：

支持的算法（以下显示的均为算法实际调用时的名称）：

• k_hop
• shortest_path
• all_shortest_paths
• filtered_shortest_path
• shortest_path_of_vertex_sets
• n_paths
• realtime_recommendation
• filtered_all_pairs_shortest_paths
• filtered_all_shortest_paths

取值范围：

• sync：同步
• async：异步

默认取值：

“async”。

offset

否

Integer

参数解释：

同步结果的偏移量。

约束限制：

executionMode=sync时有效。

支持的算法（以下显示的均为算法实际调用时的名称）：

• k_hop
• shortest_path
• all_shortest_paths
• shortest_path_of_vertex_sets
• n_paths
• realtime_recommendation
• filtered_all_pairs_shortest_paths
• filtered_all_shortest_paths

取值范围：

不涉及。

默认取值：

“0”。

limit

否

Integer

参数解释：

算法参数。详情请参考各算法参数描述。

约束限制：

executionMode=sync时有效。

支持的算法（以下显示的均为算法实际调用时的名称）：

• k_hop
• shortest_path
• all_shortest_paths
• shortest_path_of_vertex_sets
• n_paths
• realtime_recommendation
• filtered_all_pairs_shortest_paths
• filtered_all_shortest_paths

取值范围：

同步结果返回的最大数量，最大值为100000。

默认取值：

“100000”。

vertex_filter

否

Object

参数解释：

路径中对节点的过滤条件。

约束限制：

支持的算法（以下显示的均为算法实际调用时的名称）：

• filtered_shortest_path
• filtered_all_pairs_shortest_paths
• filtered_all_shortest_paths

具体格式请见 Filtered-query API中的property_filter元素格式。

取值范围：

不涉及。

默认取值：

不涉及。

edge_filter

否

Object

参数解释：

路径中对边（关系）的过滤条件。

约束限制：

支持的算法（以下显示的均为算法实际调用时的名称）：

• filtered_shortest_path
• filtered_all_pairs_shortest_paths
• filtered_all_shortest_paths

具体格式请见 Filtered-query API中的property_filter元素格式。

取值范围：

不涉及。

默认取值：

不涉及。

filters

否

Object

参数解释：

过滤条件列表，数组的每个元素分别对应每一层要做的查询和过滤条件。

约束限制：

支持的算法：

• filtered_n_paths
• filtered_circle_detection
• topicrank

具体格式请见filters元素格式。

取值范围：

不涉及。

默认取值：

不涉及。

errorMessage

String

参数解释：

系统提示信息。

• 执行成功时，字段可能为空。
• 执行失败时，用于显示错误信息。

取值范围：

不涉及。

errorCode

String

参数解释：

系统提示信息。

• 执行成功时，字段可能为空。
• 执行失败时，用于显示错误码。

取值范围：

不涉及。

status

String

参数解释：

查询成功时返回任务状态。

取值范围：

可选值为pending，running，success。查询失败时字段为空。

data

Object

参数解释：

算法运行的结果。查询失败时字段为空。

取值范围：

不涉及。