创建靶点口袋分子设计作业
功能介绍
创建靶点口袋分子设计作业。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-mol-design
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 |
eihealth_project_id |
是 |
String |
平台项目ID。 最小长度:1 最大长度:128 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
basic_info |
是 |
CreateDrugJobBasicInfo object |
作业基本信息。 |
receptor |
是 |
PocketMolDesignReceptorDto object |
靶点文件。 |
ligands |
否 |
Array of PocketFragment objects |
配体文件列表,最多支持1个。 数组长度:0 - 1 |
num_trials |
否 |
Integer |
生成分子数量。 最小值:1 最大值:5000 缺省值:1000 |
model_ids |
否 |
Array of strings |
模型id列表。 最小长度:1 最大长度:128 数组长度:0 - 10 |
molecular_weight |
否 |
Array of integers |
分子量范围。 最小值:1 最大值:1000 数组长度:2 - 2 |
optimization_mode |
否 |
String |
优化类型。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度:5 最大长度:64 |
labels |
否 |
Array of strings |
标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
file |
是 |
ReceptorDrugFile object |
靶点文件。 |
bounding_box |
否 |
BoundingBoxDto object |
结合口袋,包含口袋中心位置和尺寸大小。 |
remove_ion |
否 |
Boolean |
去除受体中的离子。 缺省值:true |
remove_water |
否 |
Boolean |
去除受体中的水分子。 缺省值:true |
remove_ligand |
否 |
Boolean |
去除受体中的配体分子。 缺省值:true |
add_hydrogen |
否 |
Boolean |
增加氢原子。 缺省值:false |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source |
是 |
String |
受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值:
|
url |
否 |
String |
文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 |
format |
否 |
String |
文件格式,仅支持PDB,仅数据源为RAW时提供。 最小长度:1 最大长度:6 |
data |
否 |
String |
文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
center |
是 |
Array of floats |
口袋中心坐标; x, y, z轴的坐标。 最小值:-9999999 最大值:99999999 数组长度:3 - 3 |
size |
是 |
Array of floats |
口袋尺寸大小; x, y, z轴的大小。 最小值:2 最大值:500 数组长度:3 - 3 |
padding |
否 |
Float |
填充。 最小值:0 最大值:20 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source |
否 |
String |
受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值:
|
url |
否 |
String |
文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 |
format |
否 |
String |
文件格式,支持PDB、SDF、MOL2、SMI,仅数据源为RAW时提供。 最小长度:1 最大长度:6 |
name |
否 |
String |
原始配体名称,仅RAW类型时用于配体名称标识。 最小长度:1 最大长度:128 |
data |
否 |
String |
文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 |
edited |
否 |
EditedLigand object |
编辑后的配体。 |
label_sites |
否 |
LabelSite object |
标记位点。 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
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 ] }
响应示例
状态码: 201
CREATED
- 创建靶点口袋分子设计作业成功。
{ "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" }
- 创建靶点口袋分子设计作业成功,当前运行作业数已达配额限制,此作业会等待。
{ "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }
状态码
状态码 |
描述 |
---|---|
201 |
CREATED |
错误码
请参见错误码。