文档首页/ AI科学计算服务/ API参考/ API/ 小分子药物设计/ 靶点口袋分子设计作业管理/ 创建靶点口袋分子设计作业 - CreatePocketMolDesignJob
更新时间:2025-12-26 GMT+08:00
分享

创建靶点口袋分子设计作业 - CreatePocketMolDesignJob

功能介绍

创建靶点口袋分子设计作业。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-mol-design

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

eihealth_project_id

是

String

参数解释:

空间ID,您可以从获取空间ID中获取。

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

basic_info

是

CreateDrugJobBasicInfo object

参数解释:

创建药物作业基本信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

receptor

是

PocketMolDesignReceptorDto object

参数解释:

靶点文件。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

ligands

否

Array of PocketFragment objects

参数解释:

配体文件列表。

约束限制:

配体数量范围为[0-1]。

取值范围:

不涉及

默认取值:

不涉及

num_trials

否

Integer

参数解释:

生成分子数量。

约束限制:

不涉及

取值范围:

1-5000

默认取值:

1000

model_ids

否

Array of strings

参数解释:

模型ID列表。

约束限制:

模型ID数量范围为[0-10],模型ID长度为[1-128]个字符。

取值范围:

不涉及

默认取值:

不涉及

molecular_weight

否

Array of integers

参数解释:

分子量范围。

约束限制:

数组数量固定为2,数组元素取值范围为[1-1000]。

取值范围:

不涉及

默认取值:

不涉及

optimization_mode

否

String

参数解释:

优化类型。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

base_model_id

否

String

参数解释:

基模型ID。

约束限制:

当optimization_mode为generation时,可选择PanguDrug3D、Lingo3DMol,当为其他方式时,仅可选择可选择PanguDrug3D。

取值范围:

  • PanguDrug3D

  • Lingo3DMol

默认取值:

不涉及

表4 CreateDrugJobBasicInfo

参数

是否必选

参数类型

描述

name

是

String

参数解释:

作业名称。

约束限制:

不涉及

取值范围:

长度范围[5-64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。

默认取值:

不涉及

labels

否

Array of strings

参数解释:

标签。

约束限制:

标签数量范围为[0-5],单个标签长度为[1-32]个字符,支持中文、字母、数字、空格、下划线(_)和中划线(-),且不能以空格开头或结尾。

取值范围:

不涉及

默认取值:

不涉及

upstream_job_info

否

String

参数解释:

上游作业信息。

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表5 PocketMolDesignReceptorDto

参数

是否必选

参数类型

描述

file

是

ReceptorDrugFile object

参数解释:

靶点文件。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

bounding_box

否

BoundingBoxDto object

参数解释:

结合口袋,包含口袋中心位置和尺寸大小。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

remove_ion

否

Boolean

参数解释:

去除受体中的离子。

约束限制:

不涉及

取值范围:

  • true:去除

  • false:不去除

默认取值:

true。

remove_water

否

Boolean

参数解释:

去除受体中的水分子。

约束限制:

不涉及

取值范围:

  • true:去除

  • false:不去除

默认取值:

true。

remove_ligand

否

Boolean

参数解释:

去除受体中的配体分子。

约束限制:

不涉及

取值范围:

  • true:去除

  • false:不去除

默认取值:

true

add_hydrogen

否

Boolean

参数解释:

增加氢原子。

约束限制:

不涉及

取值范围:

  • true:增加氢原子。

  • false:不增加氢原子。

默认取值:

false。

表6 ReceptorDrugFile

参数

是否必选

参数类型

描述

source

是

String

参数解释:

受体的数据源。

约束限制:

不涉及

取值范围:

  • EXTRANET:外部网络数据

  • PRIVATE:私有数据

  • PUBLIC:公共数据

  • RAW :源数据

默认取值:

不涉及

url

否

String

参数解释:

文件URL。

约束限制:

当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。

取值范围:

文件URL仅支持以.pdb格式结尾,长度为[1-2000]个字符。

默认取值:

不涉及

format

否

String

参数解释:

文件格式。

约束限制:

仅数据源source为RAW时提供。

取值范围:

  • PDB:PDB文件

默认取值:

不涉及

data

否

String

参数解释:

文件原始数据。

约束限制:

仅数据源source为RAW时提供。

取值范围:

长度为[0-10000000]个字符

默认取值:

不涉及

表7 BoundingBoxDto

参数

是否必选

参数类型

描述

center

是

Array of doubles

参数解释:

口袋中心坐标,x、y、z 轴的坐标。

约束限制:

坐标数量固定为3,坐标大小范围为[-9999999-99999999]。

取值范围:

不涉及

默认取值:

不涉及

size

是

Array of floats

参数解释:

口袋尺寸大小,x、y、z轴的大小。

约束限制:

数组元素数量固定为3,x、y、z轴的大小范围为[2-500]。

取值范围:

不涉及

默认取值:

不涉及

padding

否

Float

参数解释:

填充。

约束限制:

不涉及

取值范围:

0-20

默认取值:

不涉及

表8 PocketFragment

参数

是否必选

参数类型

描述

source

否

String

参数解释:

文件来源。

约束限制:

仅支持RAW。

取值范围:

不涉及

默认取值:

不涉及

url

否

String

参数解释:

文件URL。

约束限制:

当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。

取值范围:

文件仅支持以.pdb、.mol2、.sdf、.smi、.cif为结尾,长度为[1-2000]个字符。

默认取值:

不涉及

format

否

String

参数解释:

文件格式。

约束限制:

仅数据源source为RAW时提供。

取值范围:

  • PDB:

  • SDF:

  • MOL2:

  • SMI:

默认取值:

不涉及

name

否

String

参数解释:

原始配体名称。

约束限制:

仅RAW类型时用于配体名称标识。

取值范围:

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

默认取值:

不涉及

data

否

String

参数解释:

文件原始数据。

约束限制:

仅数据源source为RAW时提供。

取值范围:

长度为[0-10000000]个字符。

默认取值:

不涉及

edited

否

EditedLigand object

参数解释:

编辑后的配体。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

label_sites

否

LabelSite object

参数解释:

标记位点。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表9 EditedLigand

参数

是否必选

参数类型

描述

source

否

String

参数解释:

文件来源,仅支持RAW。

约束限制:

不涉及

取值范围:

  • RAW:源数据。

默认取值:

不涉及

format

否

String

参数解释:

文件格式,仅支持CIF。

约束限制:

不涉及

取值范围:

  • CIF

默认取值:

不涉及

data

是

String

参数解释:

文件原始数据。

约束限制:

仅数据源source为RAW时提供。

取值范围:

长度为[0-10000000]个字符。

默认取值:

不涉及

表10 LabelSite

参数

是否必选

参数类型

描述

index

否

Array of integers

参数解释:

索引。

约束限制:

索引数量为[0-50],索引大小取值范围为[0-9999]。

取值范围:

不涉及

默认取值:

不涉及

name

否

Array of strings

参数解释:

标记位点名称。

约束限制:

标记位点数量为[0-50],标记位点长度为[1-128]个字符。

取值范围:

不涉及

默认取值:

不涉及

coordinate

否

Array<Array<Number>>

参数解释:

位点三维坐标集。

约束限制:

位点数量范围为[0-50]。

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:201

表11 响应Body参数

参数

参数类型

描述

id

String

参数解释:

作业ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit_concurrency

Integer

参数解释:

限制的并发量。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

创建靶点口袋分子设计作业,作业名称为demo-job, 受体文件为project:/dir/file,小分子片段文件为project:/dir/file,自定义属性预测id为xxxxxx,分子量约束为200-600,预期的最大输出为5000个。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-mol-design

{
  "basic_info" : {
    "name" : "demo-job",
    "labels" : [ "labelA" ]
  },
  "receptor" : {
    "file" : {
      "source" : "PRIVATE",
      "url" : "project:/dir/file"
    },
    "bounding_box" : {
      "center" : [ 0, 0, 0 ],
      "size" : [ 10, 10, 10 ],
      "padding" : 10
    },
    "remove_water" : false,
    "remove_ion" : false
  },
  "ligands" : [ {
    "source" : "PRIVATE",
    "url" : "project:/dir/file"
  } ],
  "model_ids" : [ "xxxxxx" ],
  "molecular_weight" : [ 200, 600 ],
  "optimization_mode" : "generation",
  "base_model_id" : "PanguDrug3D"
}

响应示例

状态码:201

CREATED

  • 创建靶点口袋分子设计作业成功。

    {
      "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1"
    }
  • 创建靶点口袋分子设计作业成功,当前运行作业数已达配额限制,此作业会等待。

    {
      "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
      "limit_concurrency" : 50
    }

状态码

状态码

描述

201

CREATED

错误码

请参见错误码。

相关文档