文档首页/ 医疗智能体/ API参考/ API（盘古辅助制药平台）/ 分子搜索作业管理/ 创建分子搜索作业
更新时间：2024-12-13 GMT+08:00
查看PDF
分享

创建分子搜索作业

功能介绍

创建分子搜索作业。

URI

POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/search

表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参数

参数

是否必选

参数类型

描述

basic_info

是

CreateDrugJobBasicInfo object

创建药物作业基本信息。

smiles

是

String

分子SMILES表达式。

最小长度：1

最大长度：1024

scaffold

否

String

分子骨架表达式。

最小长度：1

最大长度：1024

top_n

否

Integer

最相似的top_n个。

最小值：1

最大值：1000

缺省值：100

databases

否

Array of strings

可供搜索分子的公共数据库名称列表。

最小长度：1

最大长度：128

数组长度：0 - 10

custom_databases

否

Array of strings

可供搜索分子的自定义数据库id列表。

最小长度：1

最大长度：128

数组长度：0 - 10

model_ids

否

Array of strings

模型id列表。

最小长度：1

最大长度：128

数组长度：0 - 10

search_method

否

String

分子搜索方法。

枚举值：

  • ECFP_4
  • SCAFFOLD
表4 CreateDrugJobBasicInfo

参数

是否必选

参数类型

描述

name

是

String

作业的名称，取值范围：[5,64]，允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。

最小长度：5

最大长度：64

labels

否

Array of strings

标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。

最小长度：1

最大长度：32

数组长度：0 - 5

upstream_job_info

否

String

上游作业信息。

最小长度：1

最大长度：10240

响应参数

状态码： 201

表5 响应Body参数

参数

参数类型

描述

id

String

作业id。

limit_concurrency

Integer

限制的并发量。

请求示例

创建分子搜索作业，作业名称为demo-job，分子SMILES表达式为string,从数据库中找到最相似top100的分子。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/search

{
  "basic_info" : {
    "name" : "demo-job",
    "labels" : [ "labelA" ]
  },
  "smiles" : "string",
  "top_n" : 100,
  "databases" : [ "databaseA", "databaseB" ],
  "custom_databases" : [ "custom_databaseA_id", "custom_databaseB_id" ],
  "model_ids" : [ "model_id" ],
  "search_method" : [ "ECFP_4" ]
}

响应示例

状态码： 201

CREATED

  • 创建分子搜索作业成功。 
    {
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1"
}
  • 创建分子搜索作业成功，当前运行作业数已达配额限制，此作业会等待。 
    {
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
  "limit_concurrency" : 50
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码。

相关文档