更新时间:2024-02-07 GMT+08:00
分享

查询自定义属性任务

功能介绍

通过自定义属性任务ID查询任务状态及结果。

URI

GET /v1/{project_id}/custom-props/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

华为云项目id

task_id

String

自定义属性任务ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户 token

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

异步任务的状态:等待中、运行中、已完成、失败

枚举值:

  • waiting

  • running

  • finished

  • failed

task_data

CustomPropsTaskData object

自定义属性任务的请求体

result

CustomPropsResult object

自定义属性任务的返回结果

表4 CustomPropsTaskData

参数

参数类型

描述

name

String

自定义属性名称

最小长度:1

最大长度:32

description

String

自定义属性描述信息

最小长度:0

最大长度:256

type

String

属性预测类型

枚举值:

  • binary

  • numerical

smiles

Array of strings

用于建模的smiles列表

values

Array of numbers

用于建模的属性值列表

表5 CustomPropsResult

参数

参数类型

描述

id

String

自定义属性ID(API侧)

最小长度:1

最大长度:64

prop_definition

PropDefinition object

自定义属性元信息

metrics

Array of CustomPropsModelMetric objects

自定义属性建模的评估指标集合

表6 PropDefinition

参数

参数类型

描述

id

String

属性业务侧ID

最小长度:1

最大长度:128

name

String

属性名称

最小长度:1

最大长度:32

type

String

属性类型

枚举值:

  • binary

  • numerical

description

String

属性具体描述信息

最小长度:0

最大长度:256

value_range

ValueRange object

属性有效值域区间

optimal_range

ValueRange object

属性最优值域区间

warning_range

ValueRange object

属性欠佳值域区间

style

String

模型参数呈现类型

枚举值:

  • number

  • probability

confidential_interval

Boolean

模型推理是否呈现置信区间

表7 ValueRange

参数

参数类型

描述

lower

Number

值域下限

lower_inclusive

Boolean

是否包含值域下限

upper

Number

值域上限

upper_inclusive

Boolean

是否包含值域上限

表8 CustomPropsModelMetric

参数

参数类型

描述

name

String

评估指标的名称

最小长度:1

最大长度:32

value

Float

评估指标的评估结果

请求示例

查询一个自定义属性

GET https://{endpoint}/v1/{project_id}/custom-props/{task_id}

响应示例

状态码: 200

自定义属性任务查询成功响应

{
  "status" : "finished",
  "result" : {
    "id" : "3b2dce64-c244-11ed-acf5-0255ac100017",
    "prop_definition" : {
      "id" : null,
      "name" : "custom_prop_name",
      "type" : "binary",
      "description" : "custom_prop_description"
    },
    "metrics" : [ {
      "name" : "rmsd",
      "value" : 0.73
    } ]
  }
}

状态码

状态码

描述

200

自定义属性任务查询成功响应

404

自定义属性任务ID不存在

错误码

请参见错误码

相关文档