文档首页> 图引擎服务 GES> API参考> 业务面API> 内存版> 算法API> 算法API参数参考> 算法公共参数
更新时间：2022-12-19 GMT+08:00
查看PDF

算法公共参数

算法请求示例

{
 "algorithmName":"XXX",
 "parameters":{
         ...
 }
}

请求参数

表1 Body参数说明

参数

是否必选

类型

说明

algorithmName

是

String

算法名字。

取值范围（以下显示的均为算法实际调用时的名称）：

  • pagerank
  • personalrank
  • kcore
  • k_hop
  • shortest_path
  • all_shortest_paths
  • filtered_shortest_path
  • sssp
  • shortest_path_of_vertex_sets
  • n_paths
  • closeness
  • 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

算法参数。详情请参考各算法参数描述。
表2 2.1.7版本新增Body参数说明

参数

是否必选

类型

说明

executionMode

否

String
  • sync：同步
  • async：异步

默认值为“async”。

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

  • k_hop
  • shortest_path
  • all_shortest_paths
  • filtered_shortest_path
  • shortest_path_of_vertex_sets
  • n_paths
  • realtime_recommandation

offset

否

Integer

同步结果的偏移量，默认值为“0”。

说明：

executionMode=sync时有效。

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

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

limit

否

Integer

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

说明：

executionMode=sync时有效。

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

  • k_hop
  • shortest_path
  • all_shortest_paths
  • shortest_path_of_vertex_sets
  • n_paths
  • realtime_recommandation
  • filtered_all_pairs_shortest_paths
  • filtered_all_shortest_paths
表3 2.2.4版本新增Body参数说明

参数

是否必选

类型

说明

vertex_filter

否

Object

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

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

  • filtered_shortest_path
  • filtered_all_pairs_shortest_paths
  • filtered_all_shortest_paths

具体格式请见 Filtered-query API中的表6。

edge_filter

否

Object

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

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

  • filtered_shortest_path
  • filtered_all_pairs_shortest_paths
  • filtered_all_shortest_paths

具体格式请见 Filtered-query API中的表6。

filters

否

Object

过滤条件列表，数组的每个元素分别对应每一层要做的查询和过滤条件。该参数仅适用于带一般过滤条件环路检测（filtered circle detection）,具体格式请见filters元素格式。

支持的算法：

  • filtered_n_paths

响应示例

根据输入参数，执行指定算法，查询算法结果（根据算法请求返回的job_id，调用查询job_id接口获取算法结果）。

状态码： 200

成功响应示例

{
    "data": {

   "outputs": {
           $response_data //各算法的具体返回结果，不同算法返回结果不同
           "runtime": 1.365867,
           "data_return_size": 3,
           "data_offset": 0,
           "data_total_size": 100
    }
  },
  "status": "complete"
}

response_data 表示各算法的具体返回结果，不同算法返回结果不同。

状态码： 400

失败响应示例

Http Status Code: 400
{
"errorMessage":"Running algorithm [XXXX] error: YYYYYYYYY!",
"errorCode":"GES.8301"
}

响应参数

表4 响应Body参数说明

参数

类型

说明

errorMessage

String

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

errorCode

String

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

status

String

查询成功时返回任务状态，可选值为waiting，running，complete。查询失败时字段为空。

data

Object

算法运行的结果。查询失败时字段为空。
父主题： 算法API参数参考