检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用说明 推荐系统提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
API概览 类型 API 说明 工作空间 查询企业项目列表 查询用户在当前项目id下的企业项目列表。 创建工作空间 用于在推荐系统下面创建独立的工作空间,用于资源的隔离 查询工作空间列表 用于查询当前用户具有操作权限的工作空间列表。 查询工作空间详情 查询指定工作空间的具体信息。
配额说明 为防止资源滥用,平台限定了各服务资源的配额,对用户的资源数量和容量做了限制。 表1 RES服务配额 资源 限制条件 建议 推荐引擎预测接口中最多请求结果数量 20 可提工单支持更高规格。 单份画像数据中最多支持的特征数量 30 单场景在线服务最多支持每秒请求的次数(TPS)
作业相关API 提交组合作业 提交召回作业 提交过滤作业 提交特征工程作业 提交排序作业 提交实时流近线作业 提交流式训练作业 提交数据质量作业 策略参数说明 停止算子作业 查询作业列表 查询作业详情 重新执行作业 删除作业 提交效果评估任务 查询效果指标 编辑修改作业 更新索引结构
API版本选择建议 当前RES服务对外API开放存在2种: RES新版本的API接口,推荐使用。 RES旧版本的API接口,现仅为存量用户提供,即将下线。 父主题: 使用前必读
平台资源API 绑定依赖资源 获取资源列表 解绑依赖资源 创建跨源连接 获取跨源连接 删除跨源连接 开启公共终端节点 父主题: API(V1不推荐)
API 在线服务 场景 工作空间 数据源 查询规格 训练作业 调度
计费说明 计费项 RES服务根据用户使用的不同资源分别进行收费。 计费支持区域:华北-北京四。 由于RES使用的离线数据需存储在OBS中,数据存储产生的费用,请参见《OBS价格说明》。 表1 推荐系统计费项说明 计费项 说明 存储资源 应用于物品画像和用户画像的存储计费,对用户和物品的总条目数统计进行收费。
algorithm_config参数说明 参数名称 是否必选 参数类型 说明 similar_metric 是 String 相似性度量方式('cosine')。 表12 candidate_set_config参数说明 参数名称 是否必选 参数类型 说明 max_recommended_num
通过调用API查询作业详情 功能介绍 该接口用于查询作业详情。 URI GET/v1/{project_id}/jobs/{job_id} 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。
如何调用API 构造请求 认证鉴权 返回结果
API(V1不推荐) 平台资源API 作业相关API 全局配置API 在线服务API
提交数据质量作业API 功能介绍 该接口用于提交数据质量作业并进行离线计算。 URI POST /v1/{project_id}/data-quality 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用
提交排序任务API 功能介绍 用于提交排序训练作业。 URI POST /v1/{project_id}/rank-job 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。
在线服务API 获取规格列表 部署服务 预测接口 预测接口(排序) 预测接口(文本标签) 更新服务 查询服务列表 查询服务详情 订阅服务 停止/启动服务 删除服务 查询镜像列表 父主题: API(V1不推荐)
全局配置API 计算资源配置 新增场景 查询场景 删除场景 全局指标配置 获取全局配置指标 查询配额信息 父主题: API(V1不推荐)
提交组合作业 功能介绍 该接口用于提交组合作业进行离线计算,并完成对应策略的候选集生成。 URI POST /v1/{project_id}/training 参数说明请参见表1-URI参数说明。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String
通过调用API重新执行作业 功能介绍 该接口用于重新执行作业。 URI POST /v1/{project_id}/rerun-job 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。
响应参数请参见表2-响应参数说明。 表2 响应参数说明 参数名称 是否必选 参数类型 说明 is_success 是 Boolean true表示预测成功,false表示预测失败。 data 是 JSON 请参见表3 data参数说明。 表3 data参数说明 参数名称 是否必选 参数类型 说明 trace_id
查询场景 功能介绍 该接口用于查询场景信息。 URI GET /v1/{project_id}/scene 参数说明请参见表1-URI参数说明。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。