更新时间:2024-05-30 GMT+08:00

创建AI应用

功能介绍

导入元模型创建AI应用。 执行代码、模型需先上传至OBS(训练作业生成的模型已默认存储到OBS)。

接口约束

使用模板导入模型与不使用模板导入这两类导入方式的Body参数要求不一样。以下Body参数说明中以模板参数表示适合使用模板导入模型时填写的参数,非模板参数表示适合不使用模板导入时填写的参数,公共参数表示与导入方式无关的参数。

  • 使用模板导入模型时(model_type为Template),template字段必填,source_location不需要填。

  • 不使用模板导入模型时(即model_type不为Template),source_location必填,template不需要填。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/models

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

model_docs

Array of GuideDoc objects

模型说明文档列表,最多三篇。公共参数

template

template object

模板的相关配置项。使用模板导入模型(即model_type为Template)时必选。模板参数

model_version

String

模型版本,格式需为“数值.数值.数值”,其中数值为1-2位正整数, 注意:版本不可以出现例如01.01.01等以0开头的版本号形式。公共参数

source_job_version

String

来源训练作业的版本,模型是从训练作业产生的可填写,用于溯源;如模型是从第三方元模型导入,则为空。默认值为空。非模板参数

source_location

String

模型所在的OBS路径或SWR镜像地址。

source_copy

String

镜像复制开关,仅当“model_type”为“Image”时有效。

取值范围:

  • true:默认值,复制镜像模式,无法极速创建AI应用,SWR源目录中的镜像更改或删除不影响服务部署。

  • false:不复制镜像模式,可极速创建AI应用,更改或删除SWR源目录中的镜像会影响服务部署。

initial_config

String

模型配置文件转成的字符串。建议通过配置文件initial_config来提供“apis”、“dependencies”、“input_params”、“output_params”等字段的信息。非模板参数

execution_code

String

执行代码存放的OBS地址,默认值为空,名称固定为“customize_service.py”。推理代码文件需存放在模型“model”目录。该字段不需要填,系统也能自动识别出model目录下的推理代码。公共参数

source_job_id

String

来源训练作业的ID,模型是从训练作业产生的可填写,用于溯源;如模型是从第三方元模型导入,则为空。默认值为空。非模板参数

model_type

String

模型类型,取值为TensorFlow/Image/PyTorch/Template/MindSpore,从配置文件读取。公共参数

output_params

Array of CreateModelRequestInferParams objects

模型的输出参数集,默认为空,params结构如表 params结构所示。从配置文件的apis读取,用户提供“initial_config”字段即可,可不填该字段。非模板参数

description

String

模型备注信息,1-100位长度,不能包含&!'"<>=。公共参数

runtime

String

模型运行时环境,runtime可选值与model_type相关,详细见推理支持的常用引擎及其Runtime

model_metrics

String

模型精度信息,从配置文件读取,可不填。非模板参数

source_type

String

模型来源的类型,当前仅可取值“auto”,用于区分通过自动学习部署过来的模型(不提供模型下载功能);用户通过训练作业和其他方式部署的模型不设置此值。默认值为空。非模板参数

dependencies

Array of ModelDependencies objects

推理代码及模型需安装的包,默认为空。从配置文件读取,可不填。非模板参数

workspace_id

String

工作空间id,默认为0。公共参数

model_algorithm

String

模型算法,从配置文件读取,可不填。如:“predict_analysis”、“object_detection ”、“image_classification”。非模板参数

apis

Array of CreateModelRequestModelApis objects

模型所有的apis入参出参信息,从配置文件中解析出来的,可不填。非模板参数

model_name

String

模型名称,支持1-64位可见字符(含中文),名称可以包含字母、中文、数字、中划线、下划线。公共参数

install_type

Array of strings

部署类型,只支持小写。可选real-time、edge、batch,默认为["real-time","edge","batch"]。

input_params

Array of CreateModelRequestInferParams objects

模型的输入参数集,默认为空,params结构如表 params结构所示。从配置文件的apis读取,用户提供“initial_config”字段即可,可不填该字段。非模板参数

表4 GuideDoc

参数

是否必选

参数类型

描述

doc_url

String

文档http(s)链接。

doc_name

String

文档名称,支持1-48位可见字符(含中文),只能以英文大小写字母或者中文字符开头,名称可以包含字母、中文、数字、中划线、下划线。

表5 template

参数

是否必选

参数类型

描述

infer_format

String

输入输出模式id,提供时覆盖模板中的内置输入输出模式。

template_inputs

Array of CreateModelRequestTemplateInput objects

模板输入项配置,即配置模型的源路径。

template_id

String

所使用的模板id,模板中会内置一个输入输出模式。

表6 CreateModelRequestTemplateInput

参数

是否必选

参数类型

描述

input

String

模板输入路径,可以是obs文件路径,obs目录路径,使用多输入项的模板创建模型时,如果模板定义的目标路径input_properties是一样的,则此处输入的obs目录或者obs文件不能重名,否则会覆盖。

input_id

String

输入项id,从模板详情中获取。

表7 ModelDependencies

参数

是否必选

参数类型

描述

installer

String

安装方式,当前只支持pip。

packages

Array of Packages objects

依赖包集合。

表8 Packages

参数

是否必选

参数类型

描述

package_version

String

依赖包版本。不填时默认安装最新版本。不能含有中文及特殊字符&!'"<>=。

package_name

String

依赖包名称。请确保包名正确且存在。不能含有中文及特殊字符&!'"<>=。

restraint

String

版本限制条件,取值为EXACT/ATLEAST/ATMOST,当且仅当package_version存在时必填。

表9 CreateModelRequestModelApis

参数

是否必选

参数类型

描述

protocol

String

请求协议,可选HTTP和HTTPS。

method

String

请求方法,可选post、get。

input_params

ModelInOutputParams object

apis中的输入输出参数,以JSON Schema格式描述。

output_params

ModelInOutputParams object

apis中的输入输出参数,以JSON Schema格式描述。

url

String

推理请求URL路径

表10 ModelInOutputParams

参数

是否必选

参数类型

描述

type

String

JSON Schema中表示类型的字段,可选object。

properties

Object

JSON Schema中表示对象元素的properties字段,可在其中定义参数,包括参数名及其类型。

表11 CreateModelRequestInferParams

参数

是否必选

参数类型

描述

protocol

String

请求协议,可选HTTP和HTTPS。

min

Number

参数的最小值。当param_type为int或float时可选填,默认为空。

method

String

请求方法,可选“post”、“get”。

max

Number

参数的最大值。当param_type为int或float时可选填,默认为空。

param_desc

String

参数描述,建议长度设置不超过100个字符,默认为空。

param_name

String

参数名,建议长度设置不超过64个字符。

url

String

api代表的url路径。

param_type

String

参数类型,取值可选int/string/float/timestamp/date/file。

响应参数

状态码: 200

表12 响应Body参数

参数

参数类型

描述

model_id

String

模型id。

请求示例

创建AI应用。设置AI应用名称为“mnist”,版本为“1.0.0”,类型为“TensorFlow”,模型文件来源于OBS桶。

POST https://{endpoint}/v1/{project_id}/models

{
  "model_name" : "mnist",
  "model_version" : "1.0.0",
  "source_location" : "https://models.obs.xxxxx.com/mnist",
  "source_job_id" : "55",
  "source_job_version" : "V100",
  "model_type" : "TensorFlow",
  "runtime" : "python2.7",
  "description" : "mnist model",
  "execution_code" : "https://testmodel.obs.xxxxx.com/customize_service.py",
  "input_params" : [ {
    "url" : "/v1/xxx/image",
    "protocol" : "http",
    "method" : "post",
    "param_name" : "image_url",
    "param_type" : "string",
    "min" : 0,
    "max" : 9,
    "param_desc" : "http://test/test.jpeg"
  } ],
  "output_params" : [ {
    "url" : "/v1/xxx/image",
    "protocol" : "http",
    "method" : "post",
    "param_name" : "face_location",
    "param_type" : "box",
    "param_desc" : "face_location param value description"
  } ],
  "dependencies" : [ {
    "installer" : "pip",
    "packages" : [ {
      "package_name" : "numpy",
      "package_version" : "1.5.0",
      "restraint" : "ATLEAST"
    } ]
  } ],
  "model_algorithm" : "object_detection",
  "model_metrics" : "{\"f1\":0.52381,\"recall\":0.666667,\"precision\":0.466667,\"accuracy\":0.625}",
  "apis" : [ {
    "url" : "/v1/xxx/image",
    "protocol" : "http",
    "method" : "post",
    "input_params" : {
      "type" : "object",
      "properties" : {
        "image_url" : {
          "type" : "string"
        }
      }
    },
    "output_params" : {
      "type" : "object",
      "properties" : {
        "face_location" : {
          "type" : "box"
        }
      }
    }
  } ]
}

响应示例

状态码: 200

模型创建成功。

{
  "model_id" : "7feb7235-ed9c-48ae-9833-2876b2458445"
}

状态码

状态码

描述

200

模型创建成功。

错误码

请参见错误码