获取模型列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| paimodel:ListModels | list |
|
| 无 |
请求语法
GET /api/v1/models HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageNumber | integer | 否 | 模型列表的页码。起始值为 1，默认为 1。 | 1 |
| PageSize | integer | 否 | 分页查询时设置的每页显示的模型数量，默认为 10。 | 10 |
| Order | string | 否 | 分页查询时，对指定的排序字段进行升序或降序。默认 ASC。
| DESC |
| SortBy | string | 否 | 分页查询时的排序字段。目前使用 GmtCreateTime 字段用于排序。 | GmtCreateTime |
| WorkspaceId | string | 否 | 配置工作空间 ID，返回列表中只获取该工作空间内的模型列表。如何获取工作空间 ID，请参见 ListWorkspaces 。 | 324** |
| ModelName | string | 否 | 配置模型名称，用来过滤获取的模型列表。 | 情感分析 |
| Label | string | 否 | 标签串。用于列表过滤，标签中 key 或 value 中，有指定字符串的，都会被过滤出来。 | key1 |
| Provider | string | 否 | 提供者。指定提供者，则只返回该提供者公开的模型。不填则返回用户自己的模型。 | pai |
| Domain | string | 否 | 配置领域来过滤该领域内的模型列表。例如：nlp（自然语言处理）、cv（计算机视觉）等。 | nlp |
| Task | string | 否 | 配置任务来过滤属于该任务类型的模型列表。例如：text-classification（文本分类）等。 | text-classification |
| Origin | string | 否 | 配置模型源，来过滤属于该社区或组织的模型列表。例如 ModelScope，HuggingFace 等。 | ModelScope |
| Query | string | 否 | 配置查询条件。ModelName、Domain、Task、LabelKey、LabelValue 相似匹配。 例如输入为 nlp，则 ModelName、Domain、Task、LabelKey、LabelValue 中匹配的模型都会返回。 | nlp |
| ModelType | string | 否 | 模型类型 | Endpoint |
| Collections | string | 否 | 模型所在 Collection，支持填写多个，用英文逗号分割 | AI4D,QuickStart |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "5A14FA81-DD4E-******-6343FE44B941",
"Models": [
{
"ModelId": "model-1123*****",
"ModelName": "情感分析",
"GmtCreateTime": "2021-01-21T17:12:35Z",
"GmtModifiedTime": "2021-01-21T17:12:35Z",
"WorkspaceId": "234**",
"UserId": "1557702098******",
"OwnerId": "1557702098******",
"ModelDescription": "情感分析。",
"Accessibility": "PUBLIC",
"LatestVersion": {
"VersionName": "0.1.0",
"GmtCreateTime": "2021-01-21T17:12:35Z",
"GmtModifiedTime": "2021-01-21T17:12:35Z",
"UserId": "155770209******",
"OwnerId": "155770209******",
"Uri": "oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/",
"VersionDescription": "情感分析。",
"Labels": [
{
"Key": "env",
"Value": "test"
}
],
"FormatType": "SavedModel",
"FrameworkType": "TensorFlow",
"Options": "{}",
"Metrics": {
"Results": [
{
"Dataset": {
"DatasetId": "d-sdkjanksaklerhfd"
},
"Metrics": {
"cer": 0.175
}
},
{
"Dataset": {
"Uri": "oss://xxxx/"
},
"Metrics": {
"cer": 0.172
}
}
]
},
"TrainingSpec": {},
"InferenceSpec": {
"processor": "tensorflow_gpu_1.12"
},
"EvaluationSpec": {
"test": "test",
"test2": 1
},
"CompressionSpec": {
"test": "test",
"test2": 1
},
"SourceType": "PAIFlow",
"SourceId": "region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf",
"ApprovalStatus": "Approved",
"ExtraInfo": {
"CoverUris": [
"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"
],
"TrainedWords": [
"albedo_overlord"
]
}
},
"Labels": [
{
"Key": "env",
"Value": "test"
}
],
"OrderNumber": 101,
"Origin": "ModelScope",
"Domain": "nlp",
"Task": "text-classifiaction",
"ModelDoc": "https://***.md",
"Provider": "pai",
"ExtraInfo": {
"RatingCount": 2866,
"Rating": 4.94,
"FavoriteCount": 34992,
"CommentCount": 754,
"CoverUris": [
"https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"
],
"TippedAmountCount": 32,
"DownloadCount": 606056
},
"ModelType": "Checkpoint"
}
],
"TotalCount": 15
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-19 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-10-26 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-09-01 | OpenAPI 入参发生变更 | 查看变更详情 |