GetModel - 获取模型

获取指定模型详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paimodel:GetModelget
  • 全部资源
    *

请求语法

GET /api/v1/models/{ModelId} HTTP/1.1

请求参数

名称类型必填描述示例值
ModelIdstring

模型 ID。如何获取模型 ID,请参见 ListModels

model-rbvg5****c9ks92

返回参数

名称类型描述示例值
object

返回体。

RequestIdstring

请求 ID。

5A14FA81-DD4E-******-6343FE44B941
ModelIdstring

模型 ID。

model-rbvg5wzljz****ks92
ModelNamestring

模型名称。

情感分析
ModelDescriptionstring

模型描述。

通用情感分析。
GmtCreateTimestring

创建模型 UTC 时间,格式 ISO8601。

2021-01-30T12:51:33.028Z
GmtModifiedTimestring

最后更新模型 UTC 时间,格式 ISO8601。

2021-01-30T12:51:33.028Z
UserIdstring

用户 ID。

1234567890******
OwnerIdstring

阿里云账号 ID。

1234567890******
Originstring

模型源。描述源模型所属社区或组织,例如:ModelScope,HuggingFace 等。

ModelScope
Providerstring

提供者。

pai
Domainstring

领域。描述模型解决问题所属领域。例如:nlp(自然语言处理)、cv(计算机视觉)等。

cv
Taskstring

任务。描述模型解决的具体问题,例如:text-classification(文本分类)等。

text-classification
ModelDocstring

模型文档。

https://***.md
Labelsarray

模型的标签列表。

LabelsLabel

标签。

WorkspaceIdstring

工作空间 ID。

234**
Accessibilitystring

工作空间可见性,可能值为:

  • PRIVATE:在此工作空间中,仅对您和管理员可见。
  • PUBLIC:在此工作空间中,对所有人可见。
PUBLIC
LatestVersionModelVersion

模型的最新版本。

ModelTypestring

模型类型。

Checkpoint
ExtraInfoobject

模型的其它信息。

{ "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 }
OrderNumberlong

序号。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "ModelId": "model-rbvg5wzljz****ks92",
  "ModelName": "情感分析",
  "ModelDescription": "通用情感分析。",
  "GmtCreateTime": "2021-01-30T12:51:33.028Z",
  "GmtModifiedTime": "2021-01-30T12:51:33.028Z",
  "UserId": "1234567890******",
  "OwnerId": "1234567890******",
  "Origin": "ModelScope",
  "Provider": "pai",
  "Domain": "cv",
  "Task": "text-classification",
  "ModelDoc": "https://***.md",
  "Labels": [
    {
      "Key": "env",
      "Value": "test"
    }
  ],
  "WorkspaceId": "234**",
  "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"
      ]
    }
  },
  "ModelType": "Checkpoint",
  "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
  },
  "OrderNumber": 1
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-19API 内部配置变更,不影响调用查看变更详情
2023-11-13OpenAPI 返回结构发生变更查看变更详情
2023-10-26OpenAPI 返回结构发生变更查看变更详情