文档首页 > > API参考> API> 在线服务相关API> 部署服务

部署服务

分享
更新时间: 2019/08/09 16:32

功能介绍

该接口用于部署推理服务。

URI

POST /v1/{project_id}/infer-services

参数说明请参见表1

表1 URI参数说明

名称

是否必选

类型

说明

project_id

String

来自公有云的Project ID,用于资源隔离。

请求消息

请求参数请参见表2

表2 请求参数说明

参数名称

是否必选

字段类型

描述信息

service_name

String

服务名称,服务名称必须以res-开头,由数字、字母、下划线、中划线组成,不能以中划线结束,最大长度48字符。

service_type

String

服务类型, 可选值为infer、rank、nlp。

description

String

服务描述信息。

flows

List

流程列表,请参见表3

表3 flows参数说明

参数名称

是否必选

字段类型

描述信息

name

String

流程名称,由汉字、数字、字母、下划线、中划线、空格组成,最大长度60字符。

rules

List

每个Flow配置不同流量和候选集的规则,请参见表4

backup_uuid

String

人工导入召回策略生成的uuid。

need_preferences

Boolean

是否开启优选项功能,需匹配global_features_info_path,profile_uuid和attr_weight。例如,在购物车场景,使用的召回候选集来自于离线计算基于物品的协同过滤生成的候选集,而为了尽可能保证推荐的匹配度,要求推荐出来的物品尽可能的与用户性别、体质和年龄等属性吻合,所以考虑基于用户性别、体质和年龄等属性用标签索引得到的满足条件物品列表item1, 对离线生成的items2进行如下处理:先从items2中取在item1中出现的物品,如果个数不够,再从item2中取其余的物品填补。

global_features_info_path

String

全局特征配置文件路径。

profile_uuid

String

特征工程初始用户画像-物品画像-标准宽表算子生成的uuid。

  • 线上预测需要对候选集进行过滤时为必选项。

attr_weight

List

可用于属性权重排序或优选项搜索功能。请参见表11,属性权重列表。

filter_conf

Object

请参见表6,过滤配置列表。

rank_conf

Object

请参见表9,排序配置列表。

config

Json

请参见表5

表4 rules参数说明

参数名称

是否必选

字段类型

描述信息

candidate_uuid

String

候选集ID。

rule_ratio

Integer

同优先级数据占比( 0-100 整数 同级别占比和为100)。

priority

String

优先级,1-10的整数(1优先级最高),最大长度32。

表5 config参数说明

参数名称

是否必选

字段类型

描述信息

model_name

String

模型名称。

model_version

String

模型版本。

weight

Integer

ABtest流量占比(0-100 整数 所有流程总和为100)。

specification

String

节点规格信息, 目前只支持c2.m8.g0。

instance_count

Integer

节点实例个数, 最大2个实例。

表6 filter_conf参数说明

参数名称

是否必选

字段类型

描述信息

filter_uuid

String

过滤规则生成的uuid。

  • 线上预测需要对候选集进行属性过滤时为必选项。

duplicate_info

Objcet

请参见表7,去重相关的配置。

attribute_rules

List

请参见表8,属性过滤相关的配置。

表7 duplicate_info参数说明

参数名称

是否必选

字段类型

描述信息

item_properties

List

要去重的属性列表,例如:填写product_color,则对候选集中相同产品颜色的物品进行去重,留下召回分数高的物品。

item_id_ignore_length

String

要忽略的物品ID末尾长度,例如:候选集中有两个物品为SKU_A000123和SKU_A000456,指定忽略长度为3,则对该物品去重,留下召回分数高的物品。。

表8 attribute_rules参数说明

参数名称

是否必选

字段类型

描述信息

user_attributes

List

需过滤的用户的属性(现只支持string和numerical特征的属性),例如:一线城市用户,则属性名为city,属性值为一线城市。

item_attributes

List

需过滤的物品的属性(现只支持string和numerical特征的属性),例如:重量为0的物品,则属性名为weight,属性值为0.00。

表9 rank_conf参数说明

参数名称

是否必选

字段类型

描述信息

model_path

String

排序策略生成的模型在obs的文件路径。

etl_uuid

String

特征工程中生成排序训练样本生成的uuid。

is_attrWeight_rank

Boolean

是否配置属性排序。

表10 config参数说明

参数名称

是否必选

字段类型

描述信息

weight

Integer

设置当前模型版本的流量占比。

specification

String

计算节点规格。

instance_count

Integer

计算节点个数,即当前版本模型的实例个数。

image_id

String

镜像id,跟model_id互斥,二者只能取一。

model_id

String

模型id,跟model_id互斥,二者只能选一个。

表11 attr_weight参数说明

参数名称

是否必选

字段类型

描述信息

attribute

String

属性权重匹配排序中的属性,例如年龄(age)。

weight

Double

属性权重匹配排序中的权重,例如0.8。

响应消息

响应参数请参见表12

表12 响应参数说明

参数名称

是否必选

字段类型

描述信息

is_success

Boolean

是否成功。

service_id

String

服务id。

示例

  • 请求示例
    {
        "service_name": "res-service",
        "service_type": "infer",
        "description": "",
        "flows": [
            {
                "name": "lc",
                "ratio": 100,
                "rules": [
                    {
                        "rule_ratio": 100,
                        "priority": "1",
                        "candidate_uuid": "d7f23ad959bb409a89ec53b0e7346982"
                    }
                ],
                "backup_uuid": "d7djdad959bb409a89ec53b0e7346982",
                "global_features_info_path": "s3a://obs-res/hhx/etl-api-test/global_features_info.txt",
                "profile_uuid": "593f1466661e40f58a7bda615b588d2e",
                "filter_conf": {
                    "filter_uuid": "ca2b02b83338498da3b551b66d9654c3",
                    "duplicate_info": {
                        "item_properties": [
                            "product_name"
                        ],
                        "item_id_ignore_length": ""
                    },
                    "attribute_rules": [
                        {
                            "user_attributes": [
                                {
                                    "name": "gender",
                                    "value": "male"
                                }
                            ],
                            "item_attributes": [
                                {
                                    "name": "color",
                                    "value": "red"
                                }
                            ]
                        }
                    ]
                },
                "rank_conf": {
                    "model_path": "s3a://res-obs/yushji/tezhengongcheng/cegengxin/baocungen/model/LR/LR_frozen_model.pb",
                    "etl_uuid": "593f1466661e40f58a7bda615b588d2e"
                },
                "config": {
    		"weight": 100,
    		"specification": "modelarts.vm.cpu.2u",
    		"instance_count": 1,
    		"model_id": "5bbd6911-02d8-4109-80a1-e3dafc5a2cec"
    	    }
            }
        ]
    }
    
  • 成功响应示例
    {
        "is_success": true,
        "service_id": "bf024976-5ade-49bf-83bf-5600191922db"
    }
  • 失败响应示例
    { 
        "is_success": false, 
        "error_code": "res.1001", 
        "error_msg": "The value of request parameter(service_name) is invalid." 
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区