獲取模型列表。
調試
您可以在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 入參發生變更 | 查看變更詳情 |