计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

创建AI应用

更新时间:2025-01-27 GMT+08:00

功能介绍

导入元模型创建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

ModelTemplate 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”、"health"、"readiness_health"、"startup_health"等字段的信息。非模板参数

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”字段即可,可不填该字段。非模板参数

cmd

String

镜像启动命令

deployment_constraints

deployment_constraints object

模型部署约束(tag:hc,hk)

表4 GuideDoc

参数

是否必选

参数类型

描述

doc_url

String

文档http(s)链接。

doc_name

String

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

表5 ModelTemplate

参数

是否必选

参数类型

描述

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

版本限制条件,当且仅当package_version存在时必填,取值包含:

  • EXACT:和指定的版本完全一致。

  • ATLEAST:不低于指定的版本。

  • ATMOST:不高于指定的版本。

表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。

表12 deployment_constraints

参数

是否必选

参数类型

描述

request_mode

String

模型部署为服务时作业的请求模型

cpu_type

String

cpu类型

input_types

Array of strings

在异步模式、视频业务场景下使用,表示输入输出类型如OBS,VIS。为自定义镜像导入使用,非自定义进行在runtime声明

outputTypes

Array of strings

在异步模式、视频业务场景下使用,表示输入输出类型如OBS,DIS。自定义镜像导入使用,非自定义进行在runtime声明

service_config

String

服务部署字段声明,服务部署时可指定具体的值。自定义镜像导入使用,非自定义进行在runtime声明。由于结构较为复杂,改值为xml格式

task_config

String

作业相关的配置字段声明,作业创建时可指定具体的值。自定义镜像导入使用,非自定义进行在runtime声明。由于结构较为复杂,改值为xml格式

model_security

model_security object

使用Edge加密模型后,可获取Root Key和modelKey,以及加密后的模型

表13 model_security

参数

是否必选

参数类型

描述

model_key

String

使用Edge加密模型后,获取模型key

rootKey

String

使用Edge加密模型后,获取模型rootKey

security_policy

String

使用Edge加密模型后,获取模型加密策略

is_verify_app

Boolean

Edge边缘场景,是否校验技能中的文件,包括配置文件、容器镜像、库文件等

响应参数

状态码:200

表14 响应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"
        }
      }
    }
  } ],
  "initial_config" : "{\"protocol\":\"http\",\"port\":\"8080\",\"health\":{\"check_method\":\"HTTP\",\"protocol\":\"http\",\"url\":\"/health\",\"period_seconds\":\"5\",\"failure_threshold\":\"10\",\"initial_delay_seconds\":\"12\"},\"readiness_health\":{\"check_method\":\"HTTP\",\"protocol\":\"http\",\"url\":\"/readiness_health\",\"period_seconds\":\"5\",\"failure_threshold\":\"20\",\"initial_delay_seconds\":\"12\"},\"startup_health\":{\"check_method\":\"HTTP\",\"protocol\":\"http\",\"url\":\"/startup_health\",\"period_seconds\":\"5\",\"failure_threshold\":\"10\",\"initial_delay_seconds\":\"12\"}}"
}

响应示例

状态码:200

模型创建成功。

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

状态码

状态码

描述

200

模型创建成功。

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容