算法公共参数

算法请求

• 请求Body样例

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

• Body参数说明

  表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 filtered_circle_detection
  parameters	是	Json	算法参数。详情请参考各算法参数描述。

  表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
  limit	否	Integer	同步结果返回的最大数量，最大值为100000。默认值为“100000”。 说明： executionMode=sync时有效。 支持的算法： k_hop shortest_path all_shortest_paths shortest_path_of_vertex_sets n_paths realtime_recommandation

  表3 2.2.4版本新增Body参数说明

  参数	是否必选	类型	说明
  vertex_filter	否	Json	路径中对节点的过滤条件。 支持的算法： filtered_shortest_path 具体格式请见 Filtered-query API中的表6。
  edge_filter	否	Json	路径中对边（关系）的过滤条件。 支持的算法： filtered_shortest_path 具体格式请见 Filtered-query API中的表6。
  filters	否	Json	过滤条件列表，数组的每个元素分别对应每一层要做的查询和过滤条件。该参数仅适用于带一般过滤条件环路检测（filtered circle detection）,具体格式请见filters元素格式。

返回结果

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

• 正常返回response

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

  

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

• 失败返回response

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

• 要素说明

  表4 要素说明

  参数	是否必选	类型	说明
  errorMessage	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。
  errorCode	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。
  status	否	String	查询成功时返回任务状态，可选值为waiting，running，complete。查询失败时字段为空。
  data	否	Json	算法运行的结果。查询失败时字段为空。

• 参数说明

  表5 outputs参数说明

  参数	类型	说明
  response_data	Json	算法具体返回结果。 说明： 不同算法的返回结果各不相同，具体可参考各算法参数描述。
  runtime	Double	算法执行时间，单位：秒。
  data_return_size	Integer	本次查询返回结果数量。
  data_offset	Integer	本次查询返回结果偏移量。
  data_total_size	Integer	异步任务产生的结果数据总量。

  

  data_return_size,data_offset,data_total_size 主要用于分页查询，对于部分算法（ 最短路径, 紧密中心度, 关联预测，度数关联度，三角计数，聚类系数），其返回结果只有一个值，不进行分页，返回结果中不包含这些参数。