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

生成相互作用2D图

功能介绍

生成相互作用2D图,若不提供配体文件,则受体文件中必须包含配体;若提供配体文件,则受体中的配体(若有)则会被忽略。

URI

POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/interaction2d

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:128

eihealth_project_id

String

平台项目ID。

最小长度:1

最大长度:128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:32768

表3 请求Body参数

参数

是否必选

参数类型

描述

receptor_file

ReceptorDrugFileReq object

受体文件。

ligand_file

DrugFile object

配体文件。

name

String

小分子名称。

最小长度:0

最大长度:128

表4 ReceptorDrugFileReq

参数

是否必选

参数类型

描述

source

String

受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。

枚举值:

  • EXTRANET
  • PRIVATE
  • PUBLIC
  • RAW

url

String

文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。

最小长度:1

最大长度:2000

format

String

文件格式,仅支持PDB,仅数据源为RAW时提供。

最小长度:1

最大长度:6

data

String

文件原始数据,仅数据源为RAW时提供。

最小长度:0

最大长度:10000000

add_hydrogen

Boolean

增加氢原子。

缺省值:true

表5 DrugFile

参数

是否必选

参数类型

描述

source

String

受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。

枚举值:

  • EXTRANET
  • PRIVATE
  • PUBLIC
  • RAW

url

String

文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。

最小长度:1

最大长度:2000

format

String

文件格式,支持PDB、SDF、MOL2、SMI,仅数据源为RAW时提供。

最小长度:1

最大长度:6

data

String

文件原始数据,仅数据源为RAW时提供。

最小长度:0

最大长度:10000000

响应参数

请求示例

{
  "receptor_file" : {
    "source" : "PRIVATE",
    "url" : "obs://bucket/path/to/file"
  },
  "ligand_file" : {
    "source" : "RAW",
    "format" : "SDF",
    "data" : "xxxxxxx"
  }
}

响应示例

状态码

状态码

描述

200

相互作用2D图生成成功响应。

错误码

请参见错误码

相关文档