获取模型列表
功能介绍
获取模型列表。
URI
GET /v1/{project_id}/drug-models
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
search_key |
否 |
String |
参数解释: 模糊搜索值。 约束限制: 不涉及 取值范围: 长度为[0-1024]个字符。 默认取值: 不涉及 |
|
creator_list |
否 |
Array of strings |
参数解释: 创建者列表。 约束限制: 创建者数量范围为[0-50], 创建者长度为[1-128]个字符。 取值范围: 不涉及 默认取值: 不涉及 |
|
type_list |
否 |
Array of strings |
参数解释: 模型类型列表。 约束限制: 模型数量范围为[0-10]。 取值范围:
默认取值: 不涉及 |
|
status_list |
否 |
Array of strings |
参数解释: 模型状态列表。 约束限制: 模型状态数量范围为[0-10]。 取值范围:
默认取值: 不涉及 |
|
sort_key |
否 |
String |
参数解释: 排序规则。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
sort_dir |
否 |
String |
参数解释: 排序规则。 约束限制: 不涉及 取值范围:
默认取值: DESC |
|
create_start_time |
否 |
Long |
参数解释: 最小创建时间。 约束限制: 不涉及 取值范围: 1000000000000-9999999999999 默认取值: 不涉及 |
|
create_end_time |
否 |
Long |
参数解释: 最大创建时间。 约束限制: 不涉及 取值范围: 1000000000000-9999999999999 默认取值: 不涉及 |
|
finish_start_time |
否 |
Long |
参数解释: 最小结束时间。 约束限制: 不涉及 取值范围: 1000000000000-9999999999999 默认取值: 不涉及 |
|
finish_end_time |
否 |
Long |
参数解释: 最大结束时间。 约束限制: 不涉及 取值范围: 1000000000000-9999999999999 默认取值: 不涉及 |
|
limit |
否 |
Integer |
参数解释: 限制量,单次查询总量。 约束限制: 不涉及 取值范围: 1-1000 默认取值: 100 |
|
offset |
否 |
Integer |
参数解释: 偏移量,查询起始偏移。 约束限制: 不涉及 取值范围: 0-100000000 默认取值: 0 |
|
base_model_list |
否 |
Array of strings |
参数解释: 基模型ID列表。 约束限制: 基模型ID数量范围为[0-10],基模型ID长度为[0-128]个字符,基模型ID目前仅支持pangu-drug-model或租户专属基模型。 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
models |
Array of ModelDto objects |
参数解释: 模型列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
count |
Integer |
参数解释: 模型总数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 模型名称。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
id |
String |
参数解释: 模型ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
type |
String |
参数解释: 模型类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
create_time |
String |
参数解释: 模型创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
finish_time |
String |
参数解释: 模型结束时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
creator |
String |
参数解释: 创建模型的用户名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
status |
String |
参数解释: 作业状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
shareable |
Boolean |
参数解释: 是否打开组织共享。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
data_quantity |
Integer |
参数解释: 模型数据量。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
file |
ModelFile object |
参数解释: 模型数据来源。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
value_range |
ValueRange object |
区间上下限,仅回归型存在。 |
|
description |
String |
参数解释: 模型描述信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
failed_message |
String |
参数解释: 失败提示,当作业执行失败时会返回。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
losses |
Array of floats |
参数解释: 模型训练loss信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
metrics |
Array of ModelMetric objects |
参数解释: 模型评估指标。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
base_model_id |
String |
参数解释: 基模型ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: pangu-drug-model |
|
base_model_name |
String |
参数解释: 基模型名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: pangu-drug-model |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
source |
String |
参数解释: 模型数据文件来源。 约束限制: 当数据源source为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。 取值范围:
默认取值: 不涉及 |
|
url |
String |
参数解释: 文件URL。 约束限制: 当数据源source为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。 取值范围: 文件URL仅支持以.csv结尾。 默认取值: 不涉及 |
|
eihealth_project_id |
String |
参数解释: 模型文件所在空间ID。 约束限制: 仅文件为数据中心时填写。 取值范围: 长度范围[1-128]个字符,只能包含字母、数字、下划线和连字符。 默认取值: 不涉及 |
请求示例
获取模型列表。
https://{endpoint}/v1/{project_id}/drug-models
响应示例
状态码:200
OK
{
"count" : 1,
"models" : [ {
"id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
"name" : "demo_name",
"description" : "description.",
"status" : "FINISHED",
"create_time" : "2021-01-30T02:34:36Z",
"finish_time" : "2021-01-30T02:53:26Z",
"creator" : "demo-user",
"shareable" : true,
"data_quantity" : 1000,
"type" : "binary",
"file" : {
"source" : "PRIVATE",
"url" : "project:/file/data.csv"
},
"losses" : [ 6.2, 1.2, 4.54 ],
"metrics" : [ {
"name" : "rmse",
"value" : 0.3744
}, {
"name" : "mae",
"value" : 0.2844
}, {
"name" : "pcc",
"value" : 0.4871
} ],
"base_model_id" : "pangu-drug-model",
"base_model_name" : "pangu-drug-model"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。