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

查询配体相似性图计算任务

功能介绍

查询配体相似性图计算任务。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/similarity-graph/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,您可以从获取项目ID中获取。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

eihealth_project_id

String

参数解释

空间ID。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

task_id

String

参数解释

任务ID,通过创建任务接口取得。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

任务状态。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

result

LigandSimilarityGraphTaskResultDto object

配体相似度图任务结果。

表4 LigandSimilarityGraphTaskResultDto

参数

参数类型

描述

pairs

Array of LigandSimilarityGraphTaskResultPairDto objects

参数解释

配体相似度图任务结果对列表。

约束限制

结果对数量范围为[1-100]。

取值范围

不涉及

默认取值

不涉及

表5 LigandSimilarityGraphTaskResultPairDto

参数

参数类型

描述

ligands

Array of strings

参数解释

两个配体名称。

约束限制

配体数量固定为2,配体名称长度为[1-32]个字符。

取值范围

不涉及

默认取值

不涉及

success

Boolean

参数解释

相似度计算是否成功。

约束限制

不涉及

取值范围

  • true:成功

  • false:失败

默认取值

不涉及

similarity

Float

参数解释

配体对之间的相似度。

约束限制

不涉及

取值范围

0-1

默认取值

不涉及

reason

String

参数解释

相似度计算失败的理由。

约束限制

不涉及

取值范围

长度为[1-512]个字符。

默认取值

不涉及

请求示例

查询配体相似性图计算任务。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/similarity-graph/{task_id}

响应示例

状态码:200

查询配体相似性图计算任务成功响应。

{
  "status" : "finished",
  "result" : {
    "pairs" : [ {
      "success" : true,
      "ligands" : [ "FXR_74", "ligand" ],
      "similarity" : 0,
      "reason" : null
    } ]
  }
}

状态码

状态码

描述

200

查询配体相似性图计算任务成功响应。

错误码

请参见错误码

相关文档