文档首页/图引擎服务 GES/API参考/业务面API/持久化版/HyG算法API/算法API参数参考/算法公共参数
更新时间：2025-03-13 GMT+08:00
查看PDF
分享

算法公共参数

请求参数

表1 请求Body参数说明

参数

是否必选

类型

说明

algorithmName

是

String

算法名字，详见具体的各个算法。

parameters

否

Object

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

output

否

Object

结果输出参数。具体请见表2。

timeout

否

Integer

超时时间，单位为秒，超时范围为

(0, 2147483648)。

表2 output参数说明

参数

是否必选

类型

说明

format

否

String

算法结果的输出格式。可选值是["JSON", "TXT"]，默认值是"JSON"。TXT格式请参考算法结果TXT格式说明。

mode

否

String

算法结果的输出模式。可选值是["FULL", "TRUNCATED"]。默认值是"TRUNCATED"。

  • "FULL"表示算法结果全量输出。"FULL"模式下，当前只支持"TXT"这个格式，且算法结果会写到集群节点的本地目录，需要通过"export-result"接口将全量结果写到obs才能访问。
  • "TRUNCATED"表示算法结果截断输出，当前只支持"JSON"这种格式。

对于存在默认值的参数，如果传参数值为null，按默认值处理。

响应示例

根据输入参数，执行指定算法，查询算法结果（根据算法请求返回的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
{
    "status": "complete",
    "errorMessage": "Unknown algorithm name: pagerank12",
    "errorCode": "GES.8301",
    "result": "failed"
}