请求参数
4.1.3 修改在线服务参数
功能介绍
修改指定在线服务的元数据内容。
URI
PUT /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/service-instance/{job_id}
表4-116 路径参数
参数 是否必选 参数类型 描述
job_id 是 String 作业id。
project_id 是 String 项目id，获取方式请参见获取项
目ID。
resource_id 是 String 资源id（数据源id或场景id）。
workspace_id 是 String 工作空间id。
表4-117 Query 参数
参数 是否必选 参数类型 描述
Content-Type 是 String 内容类型，取值为application/
json。
请求参数
表4-118 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户token，获取方式请参见获
取用户Token。
表4-119 请求 Body 参数
参数 是否必选 参数类型 描述
category 是 String 类别。
description 否 String 描述。
参数 是否必选 参数类型 描述 job_config 是 jobConfig
object 作业配置。
job_name 是 String 作业名称。
job_type 是 String 作业类型。
schedule 是 String 调度参数。
表4-120 jobConfig
参数 是否必选 参数类型 描述
nearline_recal
l_param 否 NearLineRec allParam object
近线召回作业参数（近线召回作 业需要提供此参数）。
max_recomm
ended_num 否 Integer 最大候选集个数（所有召回作业 需提供此参数）。
最小值：1 最大值：200 match_featur
e_pairs 否 Array of MatchFeatur ePair objects
匹配特征对（属性匹配召回作业 需要提供此参数）。
striping 否 Striping
object 行条化策略（属性匹配召回作 业、物品协同过滤召回作业、用 户协同过滤召回作业需要提供此 参数）。
match_type 否 String 匹配类型（属性匹配召回作业需 提供此参数）：
zation 否 MatrixFactori
zation object 矩阵分解参数配置（交替最小二 乘协同过滤作业需提供此参 数）。
behavior_freq
uencys 否 Array of BehaviorFreq uency objects
行为频率信息（历史行为记忆召 回作业、历史行为过滤作业需提 供此参数）。
file_path 否 String 文件路径（人工配置候选集作业
需要提供此参数）。
参数 是否必选 参数类型 描述 ucb_param 否 UcbParam
object UCB作业参数（UCB召回作业需 要提供此参数）。
behavior_grav
ity 否 BehaviorGrav
ity object 重力衰减因子（综合行为热度召
回作业需要提供此参数）。
category 否 Category
object 类别（综合行为热度召回作业需 要提供此参数）。
behavior_logic 否 String 行为逻辑过滤（历史行为过滤作 业需提供此参数）：
● AND，同时满足则过滤
● OR， 满足一个则过滤 features_engi
neering 否 EtlBasicPara
meter object 特征参数（离线特征工程作业需 要提供此参数）。
sample_para
m 否 SamplePara
m object 样本参数（离线特征工程作业需
要提供此参数）。
deep_learning
_parameters 否 DeepLearing
Param object 排序作业通用参数（LR、
DEEPFM、AutoGroup需要提供 此参数）。
algorithm_spe cify_paramete rs
否 AlgorithmSp
ecifyParamet ers object
排序算法特定参数（LR、
load_profile 否 Boolean 导入画像（离线数据导入作业需 要提供此参数）。
save_mode 否 String 保留已有宽表（离线数据导入作
业需要提供此参数）：
● append，是
● new，否
● overwirte，覆盖 indicators 否 Array of
Indicator objects
统计指标（效果评估作业需要提 供此参数）。
offline_rank_j
ob_name 否 String 离线排序作业名称（在线训练任
务需要提供此参数）。
update_interv
al 否 Integer 更新周期（在线训练任务需要提
供此参数）。
optimizer 否 Optimizer
object 优化器（在线训练任务需要提供 此参数）。
参数 是否必选 参数类型 描述
flows 否 Flow object 在线流程（在线训练任务需要提 供此参数）。
表4-121 NearLineRecallParam
参数 是否必选 参数类型 描述
time_limit 否 Boolean 时间过滤。
timeFeature 否 String 时间特征。
retainDays 否 Integer 保留期(天)。
recall_fileds 否 Array of RecallFiled objects
召回字段。
itemCF_job_n
ame 否 String 物品协同过滤作业名称。
表4-122 RecallFiled
参数 是否必选 参数类型 描述
name 否 String 字段名称。
value 否 Integer 使用字段值的个数。
最小值：1 最大值：10 缺省值：1
表4-123 MatchFeaturePair
参数 是否必选 参数类型 描述
user_feature_
name 否 String 用户特征。
item_feature_
name 否 String 物品特征。
weight 否 Double 权重。
match_count 否 Boolean 匹配个数度量。
表4-124 Striping
参数 是否必选 参数类型 描述
nearest_neigh
borhood 是 Integer 最近领域个数。
band 是 Integer 相似程度。
最小值：1 最大值：20
row 是 Integer 相似距离。
最小值：1 最大值：10
表4-125 MatrixFactorization
参数 是否必选 参数类型 描述
implicit_vecto
r_rank 是 Integer 隐向量维度。
最小值：1 最大值：100 regular_para
m 是 Double 优化正则化系数。
最小值：1.0E-8 最大值：1 max_iterator_
num 是 Integer 迭代次数。
最小值：1 最大值：50
表4-126 BehaviorFrequency
参数 是否必选 参数类型 描述
behavior_type 是 String 行为类型：
● view，曝光
● click，点击
● collect，收藏
● uncollect，取消收藏
● search_click，搜索后点击
● comment，评论
● share，分享
● like，点赞
● dislike，点衰
● grade，评分
● consume，消费
● use，观看视频/听音乐/阅读
● download，下载
● tip，打赏
● subscribe，关注 lower_limit 否 Integer 最小次数。
最小值：1 upper_limit 否 Integer 最大次数。
最小值：1 time_interval 是 Integer 时间区间。
最小值：1
表4-127 UcbParam
参数 是否必选 参数类型 描述
alpha 是 Double 折中参数。
最小值：0 最大值：1 min_used_nu
m 是 Integer 最小行为次数。
最小值：30 最大值：1000
表4-128 BehaviorGravity
参数 是否必选 参数类型 描述
weaken_facto
r 否 Double 衰减因子。
最小值：0.1 最大值：5
view_type 否 String 行为次数统计方法：
● pv，访问量
● uv，独立访客
algo_type 否 String 算法类型:
● normal，通用
● time，时间
表4-129 Category
参数 是否必选 参数类型 描述
user_meta_list 否 Array of
strings 用户特征。
item_meta_lis
t 否 Array of
strings 物品特征。
表4-130 EtlBasicParameter
参数 是否必选 参数类型 描述
user_features 否 Array of FeatureTrans formation objects
用户特征。
item_features 否 Array of FeatureTrans formation objects
物品特征。
rank_etl_filter 否 RankETLFilte
r object 过滤参数。
表4-131 FeatureTransformation
参数 是否必选 参数类型 描述
attr 否 Attribute
object 特征。
discrete_meth
od 否 String 离散方法：
● equal_distance_discrete，等 距离散
● user_define_discrete，自定 义离散
● normalize，归一化
● null，不离散
params 否 Object 具体处理参数。
表4-132 Attribute
参数 是否必选 参数类型 描述
name 是 String 名称。
data_type 否 String 数据类型。
other_uses 否 Array of
strings 其他用途。
表4-133 RankETLFilter
参数 是否必选 参数类型 描述
filter_type 是 String 行为去重方式：
● abs_weight，权重绝对值
● date，日期
time_type 是 String 时间类型：
● day，天
● week，周
● month，月 is_monday_fir
st 否 Boolean 周一是否是第一天。
表4-134 SampleParam
参数 是否必选 参数类型 描述
divide_type 是 String 训练集测试集划分方式：
● TIME，时间比例
● RAMDOM，个数比例
train_rate 否 Double 训练数据占比。
最小值：0.01 最大值：1
test_rate 否 Double 测试数据占比。
最小值：0.01 最大值：1
表4-135 DeepLearingParam
参数 是否必选 参数类型 描述
initial_parame
ters 否 Initial object 初始化参数。
optimize_para
meters 否 Optimizer
object 优化参数。
regular_para
meters 否 Regular
object 正则化参数。
max_iteration
s 否 Integer 最大迭代轮数。
最小值：1 最大值：1000 early_stop_ite
rations 否 Integer 提前终止训练轮数。
最小值：1 最大值：1000 batch_size 否 Integer 批量大小。
最小值：1 dataset_split_
parts 否 Integer 训练数据集切分数量。
最小值：1 最大值：10 restart_train 否 Boolean 重新训练。
表4-136 Initial
参数 是否必选 参数类型 描述
initial_metho
d 是 String 初始化方法。
枚举值：
● normal
● uniform
● xavier
mean_value 否 Double 平均值。
最小值：-1 最大值：1 standard_devi
ation 否 Double 标准差。
最小值：0 最大值：1
min_value 否 Double 最小值。
最小值：-1 最大值：0
max_value 否 Double 最大值。
最小值：0 最大值：1
表4-137 Optimizer
参数 是否必选 参数类型 描述
type 否 String 优化器类型。
枚举值：
● adam
● adagrad
● ftrl learning_rate 否 Integer 学习率。
最小值：0 最大值：1 initial_accum
ulator_value 否 Double 初始梯度累加和。
最小值：0 最大值：1
参数 是否必选 参数类型 描述
lambda1 否 Double L1正则项系数。
最小值：0 最大值：1
lambda2 否 Double L2正则项系数。
最小值：0 最大值：1
epsilon 否 Double 数值稳定常量。
最小值：0 最大值：1
decay_rate 否 Double 衰减因子。
最小值：0 最大值：1 decay_steps 否 Double 衰减步长。
最小值：1
表4-138 Regular
参数 是否必选 参数类型 描述
ularization 否 Double 隐向量层L2正则化系数。
最小值：0 最大值：1 wide_l2_regul
arization 否 Double wide部分L2正则化系数。
最小值：0 最大值：1 structure_l2_r
egularization 否 Double 结构化部分L2正则化系数。
最小值：0 最大值：1
表4-139 AlgorithmSpecifyParameters
参数 是否必选 参数类型 描述
latent_vector_
length 否 Integer 隐向量长度(DEEPFM需要提供
此参数)。
最小值：1 最大值：100 architecture 否 Array of
integers 神经网络结构(DEEPFM需要提 供此参数)。
active_functio
n 否 String 激活函数(DEEPFM需要提供此
参数,AutoGroup需要提供此参 数)。
枚举值：
● relu
● sigmoid
● tanh value_keep_pr
obability 否 Double 神经元值保留概率(DEEPFM需 要提供此参数,AutoGroup需要 提供此参数)。
最小值：0 最大值：1 embed_size 否 Array of
integers 各阶隐向量长度(AutoGroup需 要提供此参数)。
mlp_architect
ure 否 Array of
integers 神经网络结构(AutoGroup需要 提供此参数)。
max_order 否 Integer 最大交互阶数(AutoGroup需要 提供此参数)。
hash_sizes 否 Array of
integers 哈希长度(AutoGroup需要提供 此参数)。
hash_compen
sation 否 Array of
numbers 特征交互层惩罚项系数
(AutoGroup需要提供此参数)。
use_wide_part 否 Boolean 使用线性部分(AutoGroup需要 提供此参数)。
structure_opti
mizer 否 Optimizer
object 优化器参数(AutoGroup需要提 供此参数)。
merge_multi_
hot 否 Boolean 融合多值特征(AutoGroup需要
提供此参数)。
fix_structure 否 Boolean 固定哈希结构(AutoGroup需要 提供此参数)。
表4-140 Indicator
参数 是否必选 参数类型 描述
indicator_nam
e 否 String 指标名称：
● clickPVRate，点击PV率
● clickUVRate，点击UV率
● customize，自定义 indicator_para
ms 否 IndicatorPara
m object 指标参数（自定义指标需要提
供）。
表4-141 IndicatorParam
参数 是否必选 参数类型 描述
customize_par
ameter 否 CustomizePa rameter object
自定义参数。
customize_for
mula 否 CustomizeFor
mula object 自定义公式。
表4-142 CustomizeParameter
参数 是否必选 参数类型 描述
alias 是 String 别名。
behavior_type 是 String 行为类型。
threshold 否 Double 阈值。
最小值：0 最大值：1 deduplication 是 String 去重。
表4-143 CustomizeFormula
参数 是否必选 参数类型 描述
alias 否 String 别名。
formula 否 String 公式。
表4-144 Flow
参数 是否必选 参数类型 描述
flow_id 是 String 流程id。
attr_pair_rules
_filter 否 Array of AttrPairRules objects
属性对过滤。
attr_pair_rules
_reserve 否 Array of AttrPairRules objects
属性对保留。
deduplication
_list 否 Array of
Deduplicatio n objects
属性去重。
attribute_info 否 AttributeInfo
object 综合排序信息。
bloom_filter_c
onf 否 BloomFilterC
onf object 布隆过滤器配置。
group_attr 否 String 分组打散属性。
pre_deal 否 Boolean 在排序前去重。
rank_setting 否 String 排序配置信息。
rules 否 Rule object 候选集融合。
filter_sets 否 Array of
strings 过滤配置信息。
attr_value_rul
es_filter 否 Array of AttrValueRul es objects
属性值过滤。
attr_value_rul
es_reserve 否 Array of AttrValueRul es objects
属性值保留。
ctr_job 否 String 排序作业（使用点击率预估时需
要提供此参数）。
ratio 否 Integer 流量占比。
最小值：1 最大值：100 toppings 否 Array of
strings 需要置顶的候选集列表。
表4-145 AttrPairRules
参数 是否必选 参数类型 描述
attr_pairs 否 Array of AttrPair objects
属性对。
表4-146 AttrPair
参数 是否必选 参数类型 描述
party_a 否 String 被推荐对象的属性名。
party_b 否 String 被推荐对象的属性名。
表4-147 Deduplication
参数 是否必选 参数类型 描述
attributes 否 Array of
strings 属性。
表4-148 AttributeInfo
参数 是否必选 参数类型 描述
rank_feature_
pairs 否 Array of
RankFeature Pair objects
属性匹配对。
numerical_att
rs 否 Array of
NumericalAtt r objects
属性权重。
num_statistics
_type 否 String 统计方式：
● ORDER，顺序
● ABS，绝对值 枚举值：
● ORDER
● ABS
表4-149 RankFeaturePair
参数 是否必选 参数类型 描述
feature_name
_a 否 String 待推荐对象的属性。
feature_name
_b 否 String 被推荐对象的属性。
weight 否 Float 权重。
最小值：0.01 最大值：1
表4-150 NumericalAttr
参数 是否必选 参数类型 描述
name 是 String 特征名。
weight 是 Float 权重。
最小值：0.001 最大值：1
表4-151 BloomFilterConf
参数 是否必选 参数类型 描述
参数 是否必选 参数类型 描述