文档首页/ 推荐系统 RES/ API参考/ API（V1不推荐）/ 作业相关API/ 更新索引结构
更新时间：2023-05-24 GMT+08:00
查看PDF
分享

更新索引结构

功能介绍

当用户想要新增或者删除用户、物品特征的时候，该功能可以用于更新CloudTable表的索引结构。

URI

POST /v1/{project_id}/update-htable

参数说明请参见表1。

表1 URI参数说明

名称

是否必选

类型

说明

project_id

是

String

项目编号，用于资源隔离。获取方法请参见获取项目ID。

请求消息

请求参请参见表2。

表2 请求参数说明

参数名称

是否必选

参数类型

说明

workspace_id

否

String

默认为0

job_name

是

String

训练作业名称，最大长度为20字符。

job_description

否

String

训练作业描述，最大长度为256字符。

algorithm_type

是

String

算法类型

  • UPDATE_INDEX_SCHEMA

algorithm_parameters

是

JSON

算法参数。

  • UPDATE_INDEX_SCHEMA，请参见表6。

storage

是

JSON

请参见表5，存储平台。

offline_platform

是

JSON

请参见表3，离线计算平台信息。
表3 offline_platform参数说明

参数名称

是否必选

参数类型

说明

platform

是

String

平台名称，最大长度64，支持DLI。

platform_parameter

是

JSON

请参见表4，平台参数。

computing_resource

否

String

指定DLI运行任务的资源规格。

config_load_path

是

String

读取配置源路径。
表4 platform_parameter参数说明

参数名称

是否必选

参数类型

说明

cluster_name

是

String

集群名称。

cluster_id

否

String

集群ID。
表5 storage参数说明

参数名称

是否必选

参数类型

说明

user_profiles_table

否

JSON

用户属性存储表.请参见表8，

algorithm_type为INITIAL_PROFILES_GENERATION时必选。

item_profiles_table

否

JSON

物品属性存储表请参见表8，

algorithm_type为INITIAL_PROFILES_GENERATION时必选。
表6 algorithm_parameters参数说明

参数名称

是否必选

参数类型

说明

作业ID(job_id)

是

String

作业的ID。离线策略特征工程-初始用户画像-物品画像-标准宽表算子、近线策略基于用户数据更新用户画像算子、近线策略基于物品数据更新物品画像算子可以作为此处的作业ID。

新的全局特征配置文件路径(new_global_features_info)

是

String

该文件为JSON格式，包含特征名、特征大类、特征值类型。

新的全局特征配置文件（new_global_features_info）包含的特征是在原作业ID（job_id）对应的全局特征配置文件的特征基础上新增的一些特征或者删除一些特征；两份文件重复的特征名对应的特征类型必须保持一致。

响应消息

响应参数请参见表7。

表7 响应参数说明

参数名称

参数类型

说明

job_name

String

作业名称。

job_id

String

作业的ID。

is_success

Boolean

请求是否成功。

error_message

String

请求失败时的错误信息，请求成功时无此字段。

error_code

String

请求失败时的错误码，请求成功时无此字段。

create_time

Long

作业的创建时间。

etl_uuid

String

候选集ID。

示例

  • 请求示例 
    {
	"job_name": "update_schema",
	"job_description": "online test",
	"algorithm_type": "UPDATE_INDEX_SCHEMA", 
	"algorithm_parameters": {
		"job_id": "29587a920dc3434b8ab9c5896f471103",
		"new_global_features_info": "<新的全局特征配置文件路径>"
	},
	"offline_platform": {
		"platform": "DLI",
		"platform_parameter": {
			"cluster_name": "res_cluster"
		},
		"config_load_path": "<配置源路径>",
		"computing_resource": "",
		"job_log": "<作业日志存储路径>"
	},
	"storage": {
		"user_profiles_table": {
			"platform": "CloudTable",
			"platform_parameter": {
				"cluster_id": "a9cefd7a-ce85-44fa-bda5-0d0ae8dd8500",
				"cluster_name": "cloudtable-res",
				"table_name": "user-test-10",
				"data_version": "V2",
				"region_info": {
					"region_num": 8,
					"index_region_num": 8
				}
			}
		},
		"item_profiles_table": {
			"platform": "CloudTable",
			"platform_parameter": {
				"cluster_id": "a9cefd7a-ce85-44fa-bda5-0d0ae8dd8500",
				"cluster_name": "cloudtable-res",
				"table_name": "item-test-10",
				"data_version": "V2",
				"region_info": {
					"region_num": 8,
					"index_region_num": 8
				}
			}
		}
	}
}
  • 成功响应示例 
    {
    "is_success": true,
    "job_id": "d832b07540594ea980c140fea5a10849",
    "job_name": "gggggggggggggggg",
    "create_time": "1543891781990",
    "etl_uuid": "a53a685c52f4476f833d256620b6fc80"
}
  • 失败响应示例 
    {
"is_success": false,
"error_code": "res.2006",
"error_msg": "The datasourceUrl(<数据源存储路径>) is not match Bucket structure."
}
父主题： 作业相关API

相关文档