更新时间:2024-12-03 GMT+08:00

infomap算法(infomap)

功能介绍

根据输入参数,执行infomap算法。

infomap算法是一种基于信息论的社区发现算法,该算法在效率和效果上都表现较好,并且能够发现层次性的社区结构,其优化目标为找到最优的社区结构,使节点的层次编码长度最小。

URI

POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
表1 路径参数

参数

是否必选

类型

说明

project_id

String

项目ID。获取方法请参见获取项目ID

graph_name

String

图名称。

请求参数

表2 请求Body参数

参数

是否必选

类型

说明

algorithmName

String

算法名字。

parameters

parameters Object

算法参数。

表3 parameters

参数

是否必选

类型

说明

convergence

Double

收敛精度,取值范围为(0,1),默认值为0.00001。

max_iterations

Integer

最大迭代次数。API调用限制为[1,2147483647],前端调用限制为[1,2000],默认值为100。

weight

String

边上权重。取值为:空或字符串,当图中的边没有配置该属性时,算法会报错。

  • 空:边上的权重、距离默认为1。
  • 字符串:对应的边上的属性将作为权重。

响应参数

参数

类型

说明

errorMessage

String

系统提示信息,执行成功时,字段可能为空。

执行失败时,用于显示错误信息。

errorCode

String

系统提示信息,执行成功时,字段可能为空。

执行失败时,用于显示错误码。

jobId

String

执行算法任务ID。请求失败时,字段为空。

说明:

可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)

jobType

Integer

任务类型。请求失败时,字段为空。

请求示例

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm   
{
 "algorithmName":"infomap",
 "parameters":{
        "convergence":0.00001,
        "max_iterations":100
 }
}

SERVER_URL:图的访问地址,取值请参考业务面API使用限制

响应示例

状态码: 200

成功响应示例

Http Status Code: 200
{  
"jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122",
"jobType": 1
}

状态码: 400

失败响应示例

Http Status Code: 400
{
"errorMessage":"graph [demo] is not found",
"errorCode":"GES.8402"
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码