华为云用户手册

  • 响应参数 状态码: 200 表39 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功 job jobs object 服务描述信息 message String 返回消息(请求成功时,不返回此字段) error_code String 错误码(请求成功时,不返回此字段) 表40 jobs 参数 参数类型 描述 category String 类别。 config_info String 配置信息。 description String 描述。 job_id String 作业id。 job_name String 作业名称。 job_type String 作业类型。 next_schedule_time Integer 下次调度时间。 platform String 平台。 resource_id String 资源id。 schedule String 调度参数。 status String 状态。 workspace_id String 工作空间id。 job_config jobConfig object 作业配置。 表41 jobConfig 参数 参数类型 描述 nearline_recall_param NearLineRecallParam object 近线召回作业参数(近线召回作业需要提供此参数)。 max_recommended_num Integer 最大候选集个数(所有召回作业需提供此参数)。 最小值:1 最大值:200 match_feature_pairs Array of MatchFeaturePair objects 匹配特征对(属性匹配召回作业需要提供此参数)。 striping Striping object 行条化策略(属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数)。 match_type String 匹配类型(属性匹配召回作业需提供此参数): UI,基于用户推荐物品 UU,基于用户推荐用户 II,基于物品推荐物品 IU,基于物品推荐用户 matrix_factorization MatrixFactorization object 矩阵分解参数配置(交替最小二乘协同过滤作业需提供此参数)。 behavior_frequencys Array of BehaviorFrequency objects 行为频率信息(历史行为记忆召回作业、历史行为过滤作业需提供此参数)。 file_path String 文件路径(人工配置候选集作业需要提供此参数)。 ucb_param UcbParam object UCB作业参数(UCB召回作业需要提供此参数)。 behavior_gravity BehaviorGravity object 重力衰减因子(综合行为热度召回作业需要提供此参数)。 category Category object 类别(综合行为热度召回作业需要提供此参数)。 behavior_logic String 行为逻辑过滤(历史行为过滤作业需提供此参数): AND,同时满足则过滤 OR, 满足一个则过滤 features_engineering EtlBasicParameter object 特征参数(离线特征工程作业需要提供此参数)。 sample_param SampleParam object 样本参数(离线特征工程作业需要提供此参数)。 deep_learning_parameters DeepLearingParam object 排序作业通用参数(LR、DEEPFM、AutoGroup需要提供此参数)。 algorithm_specify_parameters AlgorithmSpecifyParameters object 排序算法特定参数(LR、DEEPFM、AutoGroup需要提供此参数)。 load_widetable Boolean 导入宽表(离线数据导入作业需要提供此参数)。 load_profile Boolean 导入画像(离线数据导入作业需要提供此参数)。 save_mode String 保留已有宽表(离线数据导入作业需要提供此参数): append,是 new,否 overwirte,覆盖 indicators Array of Indicator objects 统计指标(效果评估作业需要提供此参数)。 offline_rank_job_name String 离线排序作业名称(在线训练任务需要提供此参数)。 update_interval Integer 更新周期(在线训练任务需要提供此参数)。 optimizer Optimizer object 优化器(在线训练任务需要提供此参数)。 flows Flow object 在线流程(在线训练任务需要提供此参数)。 表42 NearLineRecallParam 参数 参数类型 描述 time_limit Boolean 时间过滤。 timeFeature String 时间特征。 retainDays Integer 保留期(天)。 recall_fileds Array of RecallFiled objects 召回字段。 itemCF_job_name String 物品协同过滤作业名称。 表43 RecallFiled 参数 参数类型 描述 name String 字段名称。 value Integer 使用字段值的个数。 最小值:1 最大值:10 缺省值:1 表44 MatchFeaturePair 参数 参数类型 描述 user_feature_name String 用户特征。 item_feature_name String 物品特征。 weight Double 权重。 match_count Boolean 匹配个数度量。 表45 Striping 参数 参数类型 描述 nearest_neighborhood Integer 最近领域个数。 band Integer 相似程度。 最小值:1 最大值:20 row Integer 相似距离。 最小值:1 最大值:10 表46 MatrixFactorization 参数 参数类型 描述 implicit_vector_rank Integer 隐向量维度。 最小值:1 最大值:100 regular_param Double 优化正则化系数。 最小值:1.0E-8 最大值:1 max_iterator_num Integer 迭代次数。 最小值:1 最大值:50 表47 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 表48 UcbParam 参数 参数类型 描述 alpha Double 折中参数。 最小值:0 最大值:1 min_used_num Integer 最小行为次数。 最小值:30 最大值:1000 表49 BehaviorGravity 参数 参数类型 描述 weaken_factor Double 衰减因子。 最小值:0.1 最大值:5 view_type String 行为次数统计方法: pv,访问量 uv,独立访客 algo_type String 算法类型: normal,通用 time,时间 表50 Category 参数 参数类型 描述 user_meta_list Array of strings 用户特征。 item_meta_list Array of strings 物品特征。 表51 EtlBasicParameter 参数 参数类型 描述 user_features Array of FeatureTransformation objects 用户特征。 item_features Array of FeatureTransformation objects 物品特征。 rank_etl_filter RankETLFilter object 过滤参数。 表52 FeatureTransformation 参数 参数类型 描述 attr Attribute object 特征。 discrete_method String 离散方法: equal_distance_discrete,等距离散 user_define_discrete,自定义离散 normalize,归一化 null,不离散 params Object 具体处理参数。 表53 Attribute 参数 参数类型 描述 name String 名称。 data_type String 数据类型。 other_uses Array of strings 其他用途。 表54 RankETLFilter 参数 参数类型 描述 filter_type String 行为去重方式: abs_weight,权重绝对值 date,日期 time_type String 时间类型: day,天 week,周 month,月 is_monday_first Boolean 周一是否是第一天。 表55 SampleParam 参数 参数类型 描述 divide_type String 训练集测试集划分方式: TIME,时间比例 RAM DOM,个数比例 train_rate Double 训练数据占比。 最小值:0.01 最大值:1 test_rate Double 测试数据占比。 最小值:0.01 最大值:1 表56 DeepLearingParam 参数 参数类型 描述 initial_parameters Initial object 初始化参数。 optimize_parameters Optimizer object 优化参数。 regular_parameters Regular object 正则化参数。 max_iterations Integer 最大迭代轮数。 最小值:1 最大值:1000 early_stop_iterations Integer 提前终止训练轮数。 最小值:1 最大值:1000 batch_size Integer 批量大小。 最小值:1 dataset_split_parts Integer 训练数据集切分数量。 最小值:1 最大值:10 restart_train Boolean 重新训练。 表57 Initial 参数 参数类型 描述 initial_method String 初始化方法。 mean_value Double 平均值。 最小值:-1 最大值:1 standard_deviation Double 标准差。 最小值:0 最大值:1 min_value Double 最小值。 最小值:-1 最大值:0 max_value Double 最大值。 最小值:0 最大值:1 表58 Optimizer 参数 参数类型 描述 type String 优化器类型。 learning_rate Double 学习率。 initial_accumulator_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 表59 Regular 参数 参数类型 描述 l2_regularization Double L2正则项系数。 最小值:0 最大值:1 regular_loss_compute_mode String 正则损失计算方式。 embed_l2_regularization Double 隐向量层L2正则化系数。 最小值:0 最大值:1 wide_l2_regularization Double wide部分L2正则化系数。 最小值:0 最大值:1 structure_l2_regularization Double 结构化部分L2正则化系数。 最小值:0 最大值:1 表60 AlgorithmSpecifyParameters 参数 参数类型 描述 latent_vector_length Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值:1 最大值:100 architecture Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值:0 最大值:1 embed_size Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表61 Indicator 参数 参数类型 描述 indicator_name String 指标名称: clickPVRate,点击PV率 clickUVRate,点击UV率 customize,自定义 indicator_params IndicatorParam object 指标参数(自定义指标需要提供)。 表62 IndicatorParam 参数 参数类型 描述 customize_parameter CustomizeParameter object 自定义参数。 customize_formula CustomizeFormula object 自定义公式。 表63 CustomizeParameter 参数 参数类型 描述 alias String 别名。 behavior_type String 行为类型。 threshold Double 阈值。 最小值:0 最大值:1 deduplication String 去重。 表64 CustomizeFormula 参数 参数类型 描述 alias String 别名。 formula String 公式。 表65 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 Deduplication objects 属性去重。 attribute_info AttributeInfo object 综合排序信息。 bloom_filter_conf BloomFilterConf object 布隆过滤器配置。 group_attr String 分组打散属性。 pre_deal Boolean 在排序前去重。 rank_setting String 排序配置信息。 rules Rule object 候选集融合。 filter_sets Array of strings 过滤配置信息。 attr_value_rules_filter Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve Array of AttrValueRules objects 属性值保留。 ctr_job String 排序作业(使用点击率预估时需要提供此参数)。 ratio Integer 流量占比。 最小值:1 最大值:100 toppings Array of strings 需要置顶的候选集列表。 表66 AttrPairRules 参数 参数类型 描述 attr_pairs Array of AttrPair objects 属性对。 表67 AttrPair 参数 参数类型 描述 party_a String 被推荐对象的属性名。 party_b String 被推荐对象的属性名。 表68 Deduplication 参数 参数类型 描述 attributes Array of strings 属性。 表69 AttributeInfo 参数 参数类型 描述 rank_feature_pairs Array of RankFeaturePair objects 属性匹配对。 numerical_attrs Array of NumericalAttr objects 属性权重。 num_statistics_type String 统计方式: ORDER,顺序 ABS,绝对值 表70 RankFeaturePair 参数 参数类型 描述 feature_name_a String 待推荐对象的属性。 feature_name_b String 被推荐对象的属性。 weight Float 权重。 最小值:0.01 最大值:1 表71 NumericalAttr 参数 参数类型 描述 name String 特征名。 weight Float 权重。 最小值:0.001 最大值:1 表72 BloomFilterConf 参数 参数类型 描述 behaviors Array of strings 待过滤行为类型。 interval Integer 过滤时间。 最小值:1 最大值:7 表73 Rule 参数 参数类型 描述 table_name String 候选集表名。 rule_ratio Integer 规则占比。 最小值:1 最大值:100 priority Integer 优先级。 最小值:1 最大值:10 表74 AttrValueRules 参数 参数类型 描述 attr_values_a Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b Array of AttrValue objects 待推荐对象的属性-值配置。 表75 AttrValue 参数 参数类型 描述 name String 属性名称。 value String 属性值。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型,取值为application/json。 X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 job_name 是 String 作业名称,1-64位的字母、数字、下划线、中划线组合。 最小长度:1 最大长度:64 description 否 String 描述。 category 是 String 类别: SERVICE,在线服务 job_type 是 String 作业类型: infer,推理服务 job_config 是 jobConfig object 作业配置。 topicUrn 否 String 通知消息配置。 表4 jobConfig 参数 是否必选 参数类型 描述 nearline_recall_param 否 NearLineRecallParam object 近线召回作业参数(近线召回作业需要提供此参数)。 max_recommended_num 否 Integer 最大候选集个数(所有召回作业需提供此参数)。 最小值:1 最大值:200 match_feature_pairs 否 Array of MatchFeaturePair objects 匹配特征对(属性匹配召回作业需要提供此参数)。 striping 否 Striping object 行条化策略(属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数)。 match_type 否 String 匹配类型(属性匹配召回作业需提供此参数): UI,基于用户推荐物品 UU,基于用户推荐用户 II,基于物品推荐物品 IU,基于物品推荐用户 matrix_factorization 否 MatrixFactorization object 矩阵分解参数配置(交替最小二乘协同过滤作业需提供此参数)。 behavior_frequencys 否 Array of BehaviorFrequency objects 行为频率信息(历史行为记忆召回作业、历史行为过滤作业需提供此参数)。 file_path 否 String 文件路径(人工配置候选集作业需要提供此参数)。 ucb_param 否 UcbParam object UCB作业参数(UCB召回作业需要提供此参数)。 behavior_gravity 否 BehaviorGravity object 重力衰减因子(综合行为热度召回作业需要提供此参数)。 category 否 Category object 类别(综合行为热度召回作业需要提供此参数)。 behavior_logic 否 String 行为逻辑过滤(历史行为过滤作业需提供此参数): AND,同时满足则过滤 OR, 满足一个则过滤 features_engineering 否 EtlBasicParameter object 特征参数(离线特征工程作业需要提供此参数)。 sample_param 否 SampleParam object 样本参数(离线特征工程作业需要提供此参数)。 deep_learning_parameters 否 DeepLearingParam object 排序作业通用参数(LR、DEEPFM、AutoGroup需要提供此参数)。 algorithm_specify_parameters 否 AlgorithmSpecifyParameters object 排序算法特定参数(LR、DEEPFM、AutoGroup需要提供此参数)。 load_widetable 否 Boolean 导入宽表(离线数据导入作业需要提供此参数)。 load_profile 否 Boolean 导入画像(离线数据导入作业需要提供此参数)。 save_mode 否 String 保留已有宽表(离线数据导入作业需要提供此参数): append,是 new,否 overwirte,覆盖 indicators 否 Array of Indicator objects 统计指标(效果评估作业需要提供此参数)。 offline_rank_job_name 否 String 离线排序作业名称(在线训练任务需要提供此参数)。 update_interval 否 Integer 更新周期(在线训练任务需要提供此参数)。 optimizer 否 Optimizer object 优化器(在线训练任务需要提供此参数)。 flows 否 Flow object 在线流程(在线训练任务需要提供此参数)。 表5 NearLineRecallParam 参数 是否必选 参数类型 描述 time_limit 否 Boolean 时间过滤。 timeFeature 否 String 时间特征。 retainDays 否 Integer 保留期(天)。 recall_fileds 否 Array of RecallFiled objects 召回字段。 itemCF_job_name 否 String 物品协同过滤作业名称。 表6 RecallFiled 参数 是否必选 参数类型 描述 name 否 String 字段名称。 value 否 Integer 使用字段值的个数。 最小值:1 最大值:10 缺省值:1 表7 MatchFeaturePair 参数 是否必选 参数类型 描述 user_feature_name 否 String 用户特征。 item_feature_name 否 String 物品特征。 weight 否 Double 权重。 match_count 否 Boolean 匹配个数度量。 表8 Striping 参数 是否必选 参数类型 描述 nearest_neighborhood 是 Integer 最近领域个数。 band 是 Integer 相似程度。 最小值:1 最大值:20 row 是 Integer 相似距离。 最小值:1 最大值:10 表9 MatrixFactorization 参数 是否必选 参数类型 描述 implicit_vector_rank 是 Integer 隐向量维度。 最小值:1 最大值:100 regular_param 是 Double 优化正则化系数。 最小值:1.0E-8 最大值:1 max_iterator_num 是 Integer 迭代次数。 最小值:1 最大值:50 表10 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 表11 UcbParam 参数 是否必选 参数类型 描述 alpha 是 Double 折中参数。 最小值:0 最大值:1 min_used_num 是 Integer 最小行为次数。 最小值:30 最大值:1000 表12 BehaviorGravity 参数 是否必选 参数类型 描述 weaken_factor 否 Double 衰减因子。 最小值:0.1 最大值:5 view_type 否 String 行为次数统计方法: pv,访问量 uv,独立访客 algo_type 否 String 算法类型: normal,通用 time,时间 表13 Category 参数 是否必选 参数类型 描述 user_meta_list 否 Array of strings 用户特征。 item_meta_list 否 Array of strings 物品特征。 表14 EtlBasicParameter 参数 是否必选 参数类型 描述 user_features 否 Array of FeatureTransformation objects 用户特征。 item_features 否 Array of FeatureTransformation objects 物品特征。 rank_etl_filter 否 RankETLFilter object 过滤参数。 表15 FeatureTransformation 参数 是否必选 参数类型 描述 attr 否 Attribute object 特征。 discrete_method 否 String 离散方法: equal_distance_discrete,等距离散 user_define_discrete,自定义离散 normalize,归一化 null,不离散 params 否 Object 具体处理参数。 表16 Attribute 参数 是否必选 参数类型 描述 name 是 String 名称。 data_type 否 String 数据类型。 other_uses 否 Array of strings 其他用途。 表17 RankETLFilter 参数 是否必选 参数类型 描述 filter_type 是 String 行为去重方式: abs_weight,权重绝对值 date,日期 time_type 是 String 时间类型: day,天 week,周 month,月 is_monday_first 否 Boolean 周一是否是第一天。 表18 SampleParam 参数 是否必选 参数类型 描述 divide_type 是 String 训练集测试集划分方式: TIME,时间比例 RAMDOM,个数比例 train_rate 否 Double 训练数据占比。 最小值:0.01 最大值:1 test_rate 否 Double 测试数据占比。 最小值:0.01 最大值:1 表19 DeepLearingParam 参数 是否必选 参数类型 描述 initial_parameters 否 Initial object 初始化参数。 optimize_parameters 否 Optimizer object 优化参数。 regular_parameters 否 Regular object 正则化参数。 max_iterations 否 Integer 最大迭代轮数。 最小值:1 最大值:1000 early_stop_iterations 否 Integer 提前终止训练轮数。 最小值:1 最大值:1000 batch_size 否 Integer 批量大小。 最小值:1 dataset_split_parts 否 Integer 训练数据集切分数量。 最小值:1 最大值:10 restart_train 否 Boolean 重新训练。 表20 Initial 参数 是否必选 参数类型 描述 initial_method 是 String 初始化方法。 mean_value 否 Double 平均值。 最小值:-1 最大值:1 standard_deviation 否 Double 标准差。 最小值:0 最大值:1 min_value 否 Double 最小值。 最小值:-1 最大值:0 max_value 否 Double 最大值。 最小值:0 最大值:1 表21 Optimizer 参数 是否必选 参数类型 描述 type 否 String 优化器类型。 learning_rate 否 Double 学习率。 initial_accumulator_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 表22 Regular 参数 是否必选 参数类型 描述 l2_regularization 否 Double L2正则项系数。 最小值:0 最大值:1 regular_loss_compute_mode 否 String 正则损失计算方式。 embed_l2_regularization 否 Double 隐向量层L2正则化系数。 最小值:0 最大值:1 wide_l2_regularization 否 Double wide部分L2正则化系数。 最小值:0 最大值:1 structure_l2_regularization 否 Double 结构化部分L2正则化系数。 最小值:0 最大值:1 表23 AlgorithmSpecifyParameters 参数 是否必选 参数类型 描述 latent_vector_length 否 Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值:1 最大值:100 architecture 否 Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function 否 String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability 否 Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值:0 最大值:1 embed_size 否 Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture 否 Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order 否 Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes 否 Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation 否 Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part 否 Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer 否 Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot 否 Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure 否 Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表24 Indicator 参数 是否必选 参数类型 描述 indicator_name 否 String 指标名称: clickPVRate,点击PV率 clickUVRate,点击UV率 customize,自定义 indicator_params 否 IndicatorParam object 指标参数(自定义指标需要提供)。 表25 IndicatorParam 参数 是否必选 参数类型 描述 customize_parameter 否 CustomizeParameter object 自定义参数。 customize_formula 否 CustomizeFormula object 自定义公式。 表26 CustomizeParameter 参数 是否必选 参数类型 描述 alias 是 String 别名。 behavior_type 是 String 行为类型。 threshold 否 Double 阈值。 最小值:0 最大值:1 deduplication 是 String 去重。 表27 CustomizeFormula 参数 是否必选 参数类型 描述 alias 否 String 别名。 formula 否 String 公式。 表28 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 Deduplication objects 属性去重。 attribute_info 否 AttributeInfo object 综合排序信息。 bloom_filter_conf 否 BloomFilterConf object 布隆过滤器配置。 group_attr 否 String 分组打散属性。 pre_deal 否 Boolean 在排序前去重。 rank_setting 否 String 排序配置信息。 rules 否 Rule object 候选集融合。 filter_sets 否 Array of strings 过滤配置信息。 attr_value_rules_filter 否 Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve 否 Array of AttrValueRules objects 属性值保留。 ctr_job 否 String 排序作业(使用点击率预估时需要提供此参数)。 ratio 否 Integer 流量占比。 最小值:1 最大值:100 toppings 否 Array of strings 需要置顶的候选集列表。 表29 AttrPairRules 参数 是否必选 参数类型 描述 attr_pairs 否 Array of AttrPair objects 属性对。 表30 AttrPair 参数 是否必选 参数类型 描述 party_a 否 String 被推荐对象的属性名。 party_b 否 String 被推荐对象的属性名。 表31 Deduplication 参数 是否必选 参数类型 描述 attributes 否 Array of strings 属性。 表32 AttributeInfo 参数 是否必选 参数类型 描述 rank_feature_pairs 否 Array of RankFeaturePair objects 属性匹配对。 numerical_attrs 否 Array of NumericalAttr objects 属性权重。 num_statistics_type 否 String 统计方式: ORDER,顺序 ABS,绝对值 表33 RankFeaturePair 参数 是否必选 参数类型 描述 feature_name_a 否 String 待推荐对象的属性。 feature_name_b 否 String 被推荐对象的属性。 weight 否 Float 权重。 最小值:0.01 最大值:1 表34 NumericalAttr 参数 是否必选 参数类型 描述 name 是 String 特征名。 weight 是 Float 权重。 最小值:0.001 最大值:1 表35 BloomFilterConf 参数 是否必选 参数类型 描述 behaviors 否 Array of strings 待过滤行为类型。 interval 否 Integer 过滤时间。 最小值:1 最大值:7 表36 Rule 参数 是否必选 参数类型 描述 table_name 是 String 候选集表名。 rule_ratio 是 Integer 规则占比。 最小值:1 最大值:100 priority 是 Integer 优先级。 最小值:1 最大值:10 表37 AttrValueRules 参数 是否必选 参数类型 描述 attr_values_a 否 Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b 是 Array of AttrValue objects 待推荐对象的属性-值配置。 表38 AttrValue 参数 是否必选 参数类型 描述 name 是 String 属性名称。 value 是 String 属性值。
  • URI POST /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/service-instance 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目ID。 resource_id 是 String 资源id(数据源id或场景id)。 workspace_id 是 String 工作空间id。
  • URI DELETE /v2.0/{project_id}/workspaces/{workspace_id}/data-sources/{datasource_id} 表1 路径参数 参数 是否必选 参数类型 描述 datasource_id 是 String 数据源id。 project_id 是 String 项目id,获取方式请参见获取项目ID。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token。
  • 响应消息 响应参数请参见表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。
  • 请求消息 请求参请参见表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)对应的全局特征配置文件的特征基础上新增的一些特征或者删除一些特征;两份文件重复的特征名对应的特征类型必须保持一致。
  • 响应参数 状态码: 200 表41 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功。 message String 返回消息(请求成功时,不返回此字段)。 error_code String 错误码(请求成功时,不返回此字段)。 scene scene object 场景信息。 表42 scene 参数 参数类型 描述 category String 类型。 type String 场景类型。 scene_name String 场景名称。 scene_id String 场景id。 datasource_id String 数据源id。 status String 状态。 created_at Integer 创建时间。 update_at Integer 更新时间。 workspace_id String 工作空间id。 service_type String 服务类型。
  • 请求示例 创建场景 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/intelligent-scenes{ "category" : "popularity", "job_configs" : { }, "schedule" : "00 50 01 * * ?", "specs_config" : { "online_tps" : 5, "offline" : "4CU", "nearline" : "2CU", "rank" : "8CU" }, "description" : "", "datasource_id" : "aa6d657026de42a2927a50400ae69a4b", "scene_name" : "ceshi3"}
  • 响应示例 状态码: 200 OK { "scene" : { "type" : "UI", "service_type" : "rec", "scene_name" : "ceshi3", "category" : "popularity", "scene_id" : "ae1d4f1ee659404eaefb7a3a3f1c716f", "datasource_id" : "aa6d657026de42a2927a50400ae69a4b", "status" : "Draft", "created_at" : 1588857123744, "update_at" : 0, "schedule" : "00 50 01 * * ?", "next_schedule_time" : 1588873800000, "workspace_id" : "06a7c49afc00d4972ff1c0113d8c49ba", "description" : "" }, "is_success" : true}
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型,取值为application/json。 表4 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 场景类型: popularity,热门推荐 relation,关联推荐 personalization,猜你喜欢 datasource_id 是 String 数据源id。 scene_name 是 String 场景名称:字母、数字、下划线、中划线组合。 最小长度:1 最大长度:64 specs_config 是 SpecsConfig object 计算规格。 schedule 否 String 调度信息。 job_configs 是 jobConfig object 作业配置。 表5 SpecsConfig 参数 是否必选 参数类型 描述 offline 是 String 离线计算规格。 nearline 否 String 实时计算规格。 rank 否 String 深度学习计算规格。 online_tps 否 Integer 在线服务最大并发数。 表6 jobConfig 参数 是否必选 参数类型 描述 nearline_recall_param 否 NearLineRecallParam object 近线召回作业参数(近线召回作业需要提供此参数)。 max_recommended_num 否 Integer 最大候选集个数(所有召回作业需提供此参数)。 最小值:1 最大值:200 match_feature_pairs 否 Array of MatchFeaturePair objects 匹配特征对(属性匹配召回作业需要提供此参数)。 striping 否 Striping object 行条化策略(属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数)。 match_type 否 String 匹配类型(属性匹配召回作业需提供此参数): UI,基于用户推荐物品 UU,基于用户推荐用户 II,基于物品推荐物品 IU,基于物品推荐用户 matrix_factorization 否 MatrixFactorization object 矩阵分解参数配置(交替最小二乘协同过滤作业需提供此参数)。 behavior_frequencys 否 Array of BehaviorFrequency objects 行为频率信息(历史行为记忆召回作业、历史行为过滤作业需提供此参数)。 file_path 否 String 文件路径(人工配置候选集作业需要提供此参数)。 ucb_param 否 UcbParam object UCB作业参数(UCB召回作业需要提供此参数)。 behavior_gravity 否 BehaviorGravity object 重力衰减因子(综合行为热度召回作业需要提供此参数)。 category 否 Category object 类别(综合行为热度召回作业需要提供此参数)。 behavior_logic 否 String 行为逻辑过滤(历史行为过滤作业需提供此参数): AND,同时满足则过滤 OR, 满足一个则过滤 features_engineering 否 EtlBasicParameter object 特征参数(离线特征工程作业需要提供此参数)。 sample_param 否 SampleParam object 样本参数(离线特征工程作业需要提供此参数)。 deep_learning_parameters 否 DeepLearingParam object 排序作业通用参数(LR、DEEPFM、AutoGroup需要提供此参数)。 algorithm_specify_parameters 否 AlgorithmSpecifyParameters object 排序算法特定参数(LR、DEEPFM、AutoGroup需要提供此参数)。 load_widetable 否 Boolean 导入宽表(离线数据导入作业需要提供此参数)。 load_profile 否 Boolean 导入画像(离线数据导入作业需要提供此参数)。 save_mode 否 String 保留已有宽表(离线数据导入作业需要提供此参数): append,是 new,否 overwirte,覆盖 indicators 否 Array of Indicator objects 统计指标(效果评估作业需要提供此参数)。 offline_rank_job_name 否 String 离线排序作业名称(在线训练任务需要提供此参数)。 update_interval 否 Integer 更新周期(在线训练任务需要提供此参数)。 optimizer 否 Optimizer object 优化器(在线训练任务需要提供此参数)。 flows 否 Flow object 在线流程(在线训练任务需要提供此参数)。 表7 NearLineRecallParam 参数 是否必选 参数类型 描述 time_limit 否 Boolean 时间过滤。 timeFeature 否 String 时间特征。 retainDays 否 Integer 保留期(天)。 recall_fileds 否 Array of RecallFiled objects 召回字段。 itemCF_job_name 否 String 物品协同过滤作业名称。 表8 RecallFiled 参数 是否必选 参数类型 描述 name 否 String 字段名称。 value 否 Integer 使用字段值的个数。 最小值:1 最大值:10 缺省值:1 表9 MatchFeaturePair 参数 是否必选 参数类型 描述 user_feature_name 否 String 用户特征。 item_feature_name 否 String 物品特征。 weight 否 Double 权重。 match_count 否 Boolean 匹配个数度量。 表10 Striping 参数 是否必选 参数类型 描述 nearest_neighborhood 是 Integer 最近领域个数。 band 是 Integer 相似程度。 最小值:1 最大值:20 row 是 Integer 相似距离。 最小值:1 最大值:10 表11 MatrixFactorization 参数 是否必选 参数类型 描述 implicit_vector_rank 是 Integer 隐向量维度。 最小值:1 最大值:100 regular_param 是 Double 优化正则化系数。 最小值:1.0E-8 最大值:1 max_iterator_num 是 Integer 迭代次数。 最小值:1 最大值:50 表12 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 表13 UcbParam 参数 是否必选 参数类型 描述 alpha 是 Double 折中参数。 最小值:0 最大值:1 min_used_num 是 Integer 最小行为次数。 最小值:30 最大值:1000 表14 BehaviorGravity 参数 是否必选 参数类型 描述 weaken_factor 否 Double 衰减因子。 最小值:0.1 最大值:5 view_type 否 String 行为次数统计方法: pv,访问量 uv,独立访客 algo_type 否 String 算法类型: normal,通用 time,时间 表15 Category 参数 是否必选 参数类型 描述 user_meta_list 否 Array of strings 用户特征。 item_meta_list 否 Array of strings 物品特征。 表16 EtlBasicParameter 参数 是否必选 参数类型 描述 user_features 否 Array of FeatureTransformation objects 用户特征。 item_features 否 Array of FeatureTransformation objects 物品特征。 rank_etl_filter 否 RankETLFilter object 过滤参数。 表17 FeatureTransformation 参数 是否必选 参数类型 描述 attr 否 Attribute object 特征。 discrete_method 否 String 离散方法: equal_distance_discrete,等距离散 user_define_discrete,自定义离散 normalize,归一化 null,不离散 params 否 Object 具体处理参数。 表18 Attribute 参数 是否必选 参数类型 描述 name 是 String 名称。 data_type 否 String 数据类型。 other_uses 否 Array of strings 其他用途。 表19 RankETLFilter 参数 是否必选 参数类型 描述 filter_type 是 String 行为去重方式: abs_weight,权重绝对值 date,日期 time_type 是 String 时间类型: day,天 week,周 month,月 is_monday_first 否 Boolean 周一是否是第一天。 表20 SampleParam 参数 是否必选 参数类型 描述 divide_type 是 String 训练集测试集划分方式: TIME,时间比例 RAMDOM,个数比例 train_rate 否 Double 训练数据占比。 最小值:0.01 最大值:1 test_rate 否 Double 测试数据占比。 最小值:0.01 最大值:1 表21 DeepLearingParam 参数 是否必选 参数类型 描述 initial_parameters 否 Initial object 初始化参数。 optimize_parameters 否 Optimizer object 优化参数。 regular_parameters 否 Regular object 正则化参数。 max_iterations 否 Integer 最大迭代轮数。 最小值:1 最大值:1000 early_stop_iterations 否 Integer 提前终止训练轮数。 最小值:1 最大值:1000 batch_size 否 Integer 批量大小。 最小值:1 dataset_split_parts 否 Integer 训练数据集切分数量。 最小值:1 最大值:10 restart_train 否 Boolean 重新训练。 表22 Initial 参数 是否必选 参数类型 描述 initial_method 是 String 初始化方法。 mean_value 否 Double 平均值。 最小值:-1 最大值:1 standard_deviation 否 Double 标准差。 最小值:0 最大值:1 min_value 否 Double 最小值。 最小值:-1 最大值:0 max_value 否 Double 最大值。 最小值:0 最大值:1 表23 Optimizer 参数 是否必选 参数类型 描述 type 否 String 优化器类型。 learning_rate 否 Double 学习率。 initial_accumulator_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 表24 Regular 参数 是否必选 参数类型 描述 l2_regularization 否 Double L2正则项系数。 最小值:0 最大值:1 regular_loss_compute_mode 否 String 正则损失计算方式。 embed_l2_regularization 否 Double 隐向量层L2正则化系数。 最小值:0 最大值:1 wide_l2_regularization 否 Double wide部分L2正则化系数。 最小值:0 最大值:1 structure_l2_regularization 否 Double 结构化部分L2正则化系数。 最小值:0 最大值:1 表25 AlgorithmSpecifyParameters 参数 是否必选 参数类型 描述 latent_vector_length 否 Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值:1 最大值:100 architecture 否 Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function 否 String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability 否 Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值:0 最大值:1 embed_size 否 Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture 否 Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order 否 Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes 否 Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation 否 Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part 否 Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer 否 Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot 否 Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure 否 Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表26 Indicator 参数 是否必选 参数类型 描述 indicator_name 否 String 指标名称: clickPVRate,点击PV率 clickUVRate,点击UV率 customize,自定义 indicator_params 否 IndicatorParam object 指标参数(自定义指标需要提供)。 表27 IndicatorParam 参数 是否必选 参数类型 描述 customize_parameter 否 CustomizeParameter object 自定义参数。 customize_formula 否 CustomizeFormula object 自定义公式。 表28 CustomizeParameter 参数 是否必选 参数类型 描述 alias 是 String 别名。 behavior_type 是 String 行为类型。 threshold 否 Double 阈值。 最小值:0 最大值:1 deduplication 是 String 去重。 表29 CustomizeFormula 参数 是否必选 参数类型 描述 alias 否 String 别名。 formula 否 String 公式。 表30 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 Deduplication objects 属性去重。 attribute_info 否 AttributeInfo object 综合排序信息。 bloom_filter_conf 否 BloomFilterConf object 布隆过滤器配置。 group_attr 否 String 分组打散属性。 pre_deal 否 Boolean 在排序前去重。 rank_setting 否 String 排序配置信息。 rules 否 Rule object 候选集融合。 filter_sets 否 Array of strings 过滤配置信息。 attr_value_rules_filter 否 Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve 否 Array of AttrValueRules objects 属性值保留。 ctr_job 否 String 排序作业(使用点击率预估时需要提供此参数)。 ratio 否 Integer 流量占比。 最小值:1 最大值:100 toppings 否 Array of strings 需要置顶的候选集列表。 表31 AttrPairRules 参数 是否必选 参数类型 描述 attr_pairs 否 Array of AttrPair objects 属性对。 表32 AttrPair 参数 是否必选 参数类型 描述 party_a 否 String 被推荐对象的属性名。 party_b 否 String 被推荐对象的属性名。 表33 Deduplication 参数 是否必选 参数类型 描述 attributes 否 Array of strings 属性。 表34 AttributeInfo 参数 是否必选 参数类型 描述 rank_feature_pairs 否 Array of RankFeaturePair objects 属性匹配对。 numerical_attrs 否 Array of NumericalAttr objects 属性权重。 num_statistics_type 否 String 统计方式: ORDER,顺序 ABS,绝对值 表35 RankFeaturePair 参数 是否必选 参数类型 描述 feature_name_a 否 String 待推荐对象的属性。 feature_name_b 否 String 被推荐对象的属性。 weight 否 Float 权重。 最小值:0.01 最大值:1 表36 NumericalAttr 参数 是否必选 参数类型 描述 name 是 String 特征名。 weight 是 Float 权重。 最小值:0.001 最大值:1 表37 BloomFilterConf 参数 是否必选 参数类型 描述 behaviors 否 Array of strings 待过滤行为类型。 interval 否 Integer 过滤时间。 最小值:1 最大值:7 表38 Rule 参数 是否必选 参数类型 描述 table_name 是 String 候选集表名。 rule_ratio 是 Integer 规则占比。 最小值:1 最大值:100 priority 是 Integer 优先级。 最小值:1 最大值:10 表39 AttrValueRules 参数 是否必选 参数类型 描述 attr_values_a 否 Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b 是 Array of AttrValue objects 待推荐对象的属性-值配置。 表40 AttrValue 参数 是否必选 参数类型 描述 name 是 String 属性名称。 value 是 String 属性值。
  • URI POST /v2.0/{project_id}/workspaces/{workspace_id}/intelligent-scenes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目ID。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token。
  • 请求示例 确认数据源中的特征 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/data-source/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/data-struct{ "user_attrs" : [ { "name" : "age", "data_type" : "long", "modify_able" : false }, { "name" : "extend_float", "data_type" : "float", "modify_able" : false }, { "name" : "extend_long", "data_type" : "long", "modify_able" : false }, { "name" : "extend_strArray", "data_type" : "strArray", "modify_able" : false }, { "name" : "extend_string", "data_type" : "string", "modify_able" : false }, { "name" : "gender", "data_type" : "string", "modify_able" : false }, { "name" : "location", "data_type" : "location", "modify_able" : false }, { "name" : "tags", "data_type" : "strArray", "modify_able" : false }, { "name" : "userId", "data_type" : "string", "modify_able" : false } ], "item_attrs" : [ { "name" : "author", "data_type" : "strArray", "modify_able" : false }, { "name" : "category", "data_type" : "string", "modify_able" : false }, { "name" : "expireTime", "data_type" : "long", "modify_able" : false }, { "name" : "extend_float", "data_type" : "float", "modify_able" : false }, { "name" : "extend_long", "data_type" : "long", "modify_able" : false }, { "name" : "extend_strArray", "data_type" : "strArray", "modify_able" : false }, { "name" : "extend_string", "data_type" : "string", "modify_able" : false }, { "name" : "itemId", "data_type" : "string", "modify_able" : false }, { "name" : "itemType", "data_type" : "string", "modify_able" : false }, { "name" : "location", "data_type" : "location", "modify_able" : false }, { "name" : "publishTime", "data_type" : "long", "modify_able" : false }, { "name" : "score", "data_type" : "long", "modify_able" : false }, { "name" : "status", "data_type" : "long", "modify_able" : false }, { "name" : "tags", "data_type" : "strArray", "modify_able" : false } ], "behaviors" : { "positive_behaviors" : [ { "behavior_type" : "click", "weight" : 0.3 }, { "behavior_type" : "like", "weight" : 0.8 } ], "negative_behaviors" : [ { "behavior_type" : "view", "weight" : 0.1 }, { "behavior_type" : "dislike", "weight" : 0.8 } ] }}
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型,取值为application/json。 表4 请求Body参数 参数 是否必选 参数类型 描述 item_attrs 是 Array of item_attrs objects 物品特征信息。 user_attrs 是 Array of user_attrs objects 用户特征信息。 behaviors 是 BehaviorsConfig object 行为信息。 表5 item_attrs 参数 是否必选 参数类型 描述 data_type 否 String 数据类型。 name 否 String 物品。 other_uses 否 Array of strings 其他用途。 表6 user_attrs 参数 是否必选 参数类型 描述 data_type 否 String 数据类型。 name 否 String 用户名称。 表7 BehaviorsConfig 参数 是否必选 参数类型 描述 positive_behaviors 否 Array of behaviorWeights objects 正向行为。 negative_behaviors 否 Array of behaviorWeights objects 负向行为。 表8 behaviorWeights 参数 是否必选 参数类型 描述 behavior_type 否 String 行为类型。 weight 否 Integer 行为权重。 other_uses 否 Array of strings 其他用途。
  • URI PUT /v2.0/{project_id}/workspaces/{workspace_id}/data-sources/{datasource_id}/data-struct 表1 路径参数 参数 是否必选 参数类型 描述 datasource_id 是 String 数据源id。 project_id 是 String 项目id,获取方式请参见获取项目ID。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token。
  • 响应消息 响应参数请参见表17。 表17 响应参数说明 参数名称 参数类型 说明 job_name String 作业名称。 job_id String 作业的ID。 is_success Boolean 请求是否成功。 error_message String 请求失败时的错误信息,请求成功时无此字段。 error_code String 请求失败时的错误码,请求成功时无此字段。 create_time Long 作业的创建时间。 etl_uuid String 候选集ID。
  • 请求消息 请求参请参见表2。 表2 请求参数说明 参数名称 是否必选 参数类型 说明 workspace_id 否 String 工作空间ID,默认为0 job_name 是 String 训练作业名称,最大长度为20字符。 job_description 否 String 训练作业描述,最大长度为256字符。 algorithm_type 是 String 算法类型 INITIAL_PROFILES_GENERATION BUILD_RANK_UNIFORM_DATA_FROM_JSON algorithm_parameters 是 JSON 算法参数,每一种算法都有其特定的参数。 INITIAL_PROFILES_GENERATION,请参见表8 BUILD_RANK_UNIFORM_DATA_FROM_JSON,请参见表9。 data_source 是 List 算法数据源配置 INITIAL_PROFILES_GENERATION,数据源选择通用模板数据, BUILD_RANK_UNIFORM_DATA_FROM_JSON,数据源选择通用格式。 storage 是 JSON 请参见表6,存储平台。 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 data_source参数说明 参数名称 是否必选 参数类型 描述信息 table_type_id 是 String 推荐通用数据模板 用户属性表USER_META 物品属性表ITEM_META 用户操作行为表USER_BEHAVIOR 数据格式请参见推荐系统离线数据源。 通用格式 GENERAL_FORMAT data_source_url 是 String 数据源路径,最大长度1000字符。 data_format 是 String 输入数据格式,可选值:csv、parquet、json、orc。 data_param 否 JSON 请参见表7,数据格式是csv的时候必选,其他可选。 start_time 否 String 文件开始时间,数据格式是json的时候必选,其他可选。 end_time 否 String 文件结束时间,数据格式是json的时候必选,其他可选。 表6 storage参数说明 参数名称 是否必选 参数类型 说明 user_profiles_table 否 JSON 用户属性存储表.请参见表8, algorithm_type为INITIAL_PROFILES_GENERATION时必选。 item_profiles_table 否 JSON 物品属性存储表请参见表8, algorithm_type为INITIAL_PROFILES_GENERATION时必选。 表7 data_param参数说明 参数名称 是否必选 参数类型 说明 header 是 Boolean 是否显示表头。 delimiter 是 String 分割符,最大长度10个字符。 quote 是 String 引用字符,最大长度10个字符。 escape 是 String 转义字符,最大长度10个字符。 表8 algorithm_parameters参数说明-INITIAL_PROFILES_GENERATION算子 参数名称 是否必选 参数类型 说明 输出路径(result_path) 是 String 所有输出数据(用户物品特征、特征映射、域特征值数目统计结果、训练集、测试集)的存储都路径,文件夹。 全局特征配置文件路径(global_features_information_path) 是 String 该文件为JSON格式,包含特征名、特征大类、特征值类型。全局特征文件详细内容可以通过查询全局特征配置获取。 高级设置(writer_parameters) 否 JSON 请参见表10。 表9 algorithm_parameters参数说明-BUILD_RANK_UNIFORM_DATA_FROM_JSON算子 参数名称 是否必选 参数类型 说明 输出路径(result_path) 是 String 所有输出数据(用户物品特征、特征映射、域特征值数目统计结果、训练集、测试集)的存储都路径,文件夹。 全局特征配置文件路径(global_features_information_path) 是 String 该文件为JSON格式,包含特征名、特征大类、特征值类型。全局特征文件详细内容可以通过查询全局特征配置获取。 算子类型(rank_etl_type) 是 Enum 排序数据处理算子类型。 每一种排序算法都需要进行特定的数据处理,需要根据使用的排序算法来选择排序数据处理类型。 LR、FM、FFM、DEEPFM和Pin这五种算法的数据处理互相通用。 策略参数(rank_etl_parameters) 是 JSON 请参见表11,每一种排序算法的数据预处理参数。 表10 writer_parameters高级设置参数说明 参数名称 是否必选 参数类型 说明 save_mode 否 String 对结果保存路径中已有宽表数据的保留方式: new(否,不保留任何已有的数据) append(是,保留全部已有的数据) overwrite(覆盖,将相同日期下的数据覆盖掉,保留不同日期下的数据) 表11 rank_etl_parameters参数说明-LR、FM、FFM、DEEPFM、PIN排序预处理算子共用 参数名称 是否必选 参数类型 描述信息 训练集测试集划分方式 (divide_by_time_or_rate) 是 String 按时间或比例划分训练集测试集。 可选值为TIME或RATE。 训练数据起始时间 (training_data_start_time) 否 Long 训练数据起始时间。 divide_by_time_or_rate为TIME时必填。取值不大于行为数据中的最大时间且不大于training_data_end_time。如:1541987933 训练数据终止时间 (training_data_end_time) 否 Long 训练数据终止时间。 divide_by_time_or_rate为TIME时必填。取值不大于行为数据中的最大时间且不小于training_data_start_time。如:1541987933 测试数据起始时间 (test_data_start_time) 否 Long 测试数据起始时间。 divide_by_time_or_rate为TIME时必填。取值不大于行为数据中的最大时间且不大于test_data_end_time。如:1541987933 测试数据终止时间 (test_data_end_time) 否 Long 测试数据终止时间。 divide_by_time_or_rate为TIME时必填。取值不大于行为数据中的最大时间且不小于test_data_start_time。如:1541987933 训练数据占比 (training_data_rate) 否 Double 训练数据在输入数据中的占比。divide_by_time_or_rate为RATE时必填。取值范围[0,1]。 测试数据占比 (test_data_rate) 否 Double 测试数据在输入数据中的占比。divide_by_time_or_rate为RATE时必填。取值范围[0,1]。 待提取用户特征 (user_features) 是 JSONArray 从全局特征文件提取输入的用户特征,对不同类型的特征进行相应的处理,处理后的数据用于排序模型训练。 特征必须来自用户属性配置表中定义的特征。 [{ "feature_name": "age", "feature_type": "numerical", "feature_type":"BASIC_INFO", "feature_process_parameters": { "discrete_method": "equal_distance_discrete", "lower_limit": 0.0, "upper_limit": 120.0, "distance": 20 } }, { "feature_name": "user_tag", "feature_type": "map", "feature_type":"TAGS", "feature_process_parameters": { "value_preserve_number": 4 } }] 待提取物品特征 (item_features) 是 JSONArray 从全局特征文件中提取输入的物品特征,对不同类型的特征进行相应的处理,处理后的数据用于排序模型训练。特征必须来自物品属性配置表中定义的特征。 [{ "feature_name": "product_name", "feature_type": "string", "feature_type":"BASIC_INFO", "feature_process_parameters": { } }, { "feature_name": "categories", "feature_type": "strArray", "feature_type":"BASIC_INFO", "feature_process_parameters": { "value_preserve_number": 3 } }] 正反馈行为类型 (positive_behaviors) 是 List[String] 正反馈行为类型的样本将被转换为排序数据中的正样本。取值必须来自行为表中”actionType”字段的值。示例: [click,collect,purchase,share] 负反馈行为类型 (negative_behaviors) 是 List[String] 负反馈行为类型的样本将被转换为排序数据中的负样本。取值必须来自行为表中”actionType”字段的值。示例:[view,dislike] 表12 特征信息及其处理方式 参数名称 是否必选 参数类型 说明 特征名称 (feature_name) 是 String 该特征的名称。 特征类型 (feature_type) 是 String 用户特征类型 : BASIC_INFO,基础信息类 TAGS,标签类 CONTEXT,上下文类 物品特征类型 BASIC_INFO,基础信息类 TAGS标签类 特征值类型 (feature_value _type) 是 String 该特征值的类型,支持4种不同类型的特征值,分别为: 单值枚举型(string):字符串型,每一个值都被当做是字符串来进行处理,大部分的特征值都属于这种类型; 单值数值型(numerical):每一个值都是一个数值,一般需要对这种类型的特征值进行离散化处理以降低特征维度; 多值枚举型(strArray):字符串数组型,每一个特征值都是一个不定长的字符串数组,例如商品的类别特征、用户的兴趣爱好等。排序预处理算子会将所有特征值规范到统一长度以便后续处理; KV数值型(map):Map[String,Double]型,每一个特征值都是一个不定长的key-value对,例如用户画像、物品画像等特征。排序预处理算子会将所有特征值规范到统一长度以便后续处理。 特征处理参数 (feature_process_parameters) 是 JSON 每一种类型的特征都有其对应的处理方式,需要用户提供相应处理所需要的参数。示例: { "discrete_method":"equal_distance_discrete", "lower_limit":0.0, "upper_limit":120.0, "distance":20 } 表13 离散方法及其对应的参数 参数名称 是否必选 参数类型 说明 离散方法(discrete_method) 等距离散 (equal_distance_discrete) 最小值 (lower_limit) 否 Double 如果特征值小于该值,则会被视为异常值进行处理。 用户可根据业务经验来确定该值,如果用户未提供该值,则会统计出数据中该特征的最小值作为输入。取值为 [Double.Minvalue, Double.MaxValue), 且必须小于参数“最大值”。 最大值 (upper_limit) 否 Double 如果特征值大于该值,则会被视为异常值进行处理。 用户可根据业务经验来确定该值,如果用户未提供该值,则会统计出数据中该特征的最大值作为输入。取值为 (Double.Minvalue, Double.Maxvalue], 且必须大于参数“最小值”。 距离 (distance) 是 Double 以该距离为间隔将特征区间划分为若干个片段,每一个片段对应一个离散值。取值为(0, Double.Maxvalue)。 等频离散 (equal_frequency_discrete) 最小值 (lower_limit) 否 Double 如果特征值小于该值,则会被视为异常值进行处理。 用户可根据业务经验来确定该值,如果用户未提供该值,则会统计出数据中该特征的最小值作为输入。取值为 [Double.Minvalue, Double.Maxvalue) ,且必须小于参数“最大值”。 最大值 (upper_limit) 否 Double 如果特征值大于该值,则会被视为异常值进行处理。 用户可根据业务经验来确定该值,如果用户未提供该值,则会统计出数据中该特征的最大值作为输入。取值为 (Double.Minvalue, Double.Maxvalue], 且必须大于参数“最小值”。 频率 (frequency) 是 Int 将特征值从小到大排列,每“频率”个值被划分为一个片段,每一个片段对应一个离散值。取值为(0, Int.Maxvalue)。 用户自定义离散 (user_define_discrete) 自定义区间列表 (period_list) 是 JSONArray 每一个区间的最小值、最大值、离散值都由用户来定义。 如果特征值位于某个区间的最小值最大值之间,则该特征值被离散为这个区间的离散值。 如果特征值不在用户定义的任何一个区间内,则被作为异常值进行处理。每一个区间都是半闭半开区间,即包含最小值但不包含最大值,不同区间之间不能重叠。示例: [ { "period_name": "young", "lower_limit": 0.0, "upper_limit": 18.0 } ,{ "period_name": "mid", "lower_limit": 18.0, "upper_limit": 60.0 } ,{ "period_name": "old", "lower_limit": 60.0, "upper_limit": 120.0 } ] 表14 用户自定义离散方法参数列表 参数名称 是否必选 参数类型 说明 最小值 (lower_limit) 是 Double 该区间的最小值。取值范围 [Double.Minvalue, Double.Maxvalue), 且必须小于参数“最大值”。 最大值 (upper_limit) 是 Double 该区间的最大值。取值范围 (Double.Minvalue, Double.Maxvalue], 且必须大于参数“最小值”。 区间名称 (period_name) 是 String 该区间对应的名称。 表15 多值枚举型特征处理参数列表 参数名称 是否必选 参数类型 说明 值保留个数 (value_preserve_number) 否 Int 多值枚举型特征的特征值保留个数,如果实际的值数目大于该值, 则多余的值会被删除;如果实际的值数目小于该值, 则保留所有值;如果用户未提供该参数,则会统计出 数据中该多值特征的最大取值数目作为输入。取值范围[1, 100]。 表16 KV数值型特征处理参数列表 参数名称 是否必选 参数类型 说明 值保留个数 (value_preserve_number) 否 Int KV数值型特征的特征值保留个数,如果实际的值数目大于该值, 则多余的值会被删除;如果实际的值数目小于该值, 则保留所有值;如果用户未提供该参数,则会统计出 数据中该KV数值型特征的最大取值数目作为输入。取值范围[1, 100]。
  • 响应消息 响应参数请参见表2。 表2 响应参数说明 参数名称 是否必选 参数类型 说明 is_success 是 Boolean 是否成功。 service 是 Object 返回服务信息详情,请参见表3。 表3 service参数说明 参数名称 是否必选 参数类型 说明 service_id 是 String 服务ID。 service_name 是 String 服务名称。 description 否 String 服务描述信息。 infer_type 是 String 服务类型,real-time表示实时服务。 status 是 String 服务状态,deploying、running、stopped、concerning。 is_shared 是 Boolean 是否是共享服务。 access_address 是 String 服务推理接口URL。 invocation_times 是 String 服务总调用次数。 failed_times 是 String 服务失败调用次数。 publish_time 是 Long 服务发布时间。 flows 是 List 服务流程信息。 update_time 是 Long 服务更新时间。
  • 示例 成功响应示例 { "is_success": true, "message":"Succeed to modify job!"} 失败响应示例 { "is_success": false, "error_code": "res.2301", "error_msg": "Failed to resolve the token from the request."}
  • 请求示例 更新场景的内容 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/intelligent-scenes/testuuidxxxxxxxxxxxxxxxxxxxxxxxx{ "category" : "popularity", "job_configs" : { }, "schedule" : "00 50 01 * * ?", "specs_config" : { "online_tps" : 5, "offline" : "4CU", "nearline" : "2CU", "rank" : "8CU" }, "description" : "", "datasource_id" : "aa6d657026de42a2927a50400ae69a4b", "scene_name" : "ceshi3"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型,取值为application/json X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 场景类型: customize,自定义场景 intelligent,智能场景 datasource_id 是 String 数据源id,字母、数字、下划线、减号组合32位。 specs_config 是 SpecsConfig object 计算规格。 schedule 否 String 调度信息。 job_configs 是 jobConfig object 作业配置信息。 scene_name 是 String 场景名称,1-64位字母、数字、下划线、中划线组合。 最小长度:1 最大长度:64 表4 SpecsConfig 参数 是否必选 参数类型 描述 offline 是 String 离线计算规格。 nearline 否 String 实时计算规格。 rank 否 String 深度学习计算规格。 online_tps 否 Integer 在线服务最大并发数。 表5 jobConfig 参数 是否必选 参数类型 描述 nearline_recall_param 否 NearLineRecallParam object 近线召回作业参数(近线召回作业需要提供此参数)。 max_recommended_num 否 Integer 最大候选集个数(所有召回作业需提供此参数)。 最小值:1 最大值:200 match_feature_pairs 否 Array of MatchFeaturePair objects 匹配特征对(属性匹配召回作业需要提供此参数)。 striping 否 Striping object 行条化策略(属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数)。 match_type 否 String 匹配类型(属性匹配召回作业需提供此参数): UI,基于用户推荐物品 UU,基于用户推荐用户 II,基于物品推荐物品 IU,基于物品推荐用户 matrix_factorization 否 MatrixFactorization object 矩阵分解参数配置(交替最小二乘协同过滤作业需提供此参数)。 behavior_frequencys 否 Array of BehaviorFrequency objects 行为频率信息(历史行为记忆召回作业、历史行为过滤作业需提供此参数)。 file_path 否 String 文件路径(人工配置候选集作业需要提供此参数)。 ucb_param 否 UcbParam object UCB作业参数(UCB召回作业需要提供此参数)。 behavior_gravity 否 BehaviorGravity object 重力衰减因子(综合行为热度召回作业需要提供此参数)。 category 否 Category object 类别(综合行为热度召回作业需要提供此参数)。 behavior_logic 否 String 行为逻辑过滤(历史行为过滤作业需提供此参数): AND,同时满足则过滤 OR, 满足一个则过滤 features_engineering 否 EtlBasicParameter object 特征参数(离线特征工程作业需要提供此参数)。 sample_param 否 SampleParam object 样本参数(离线特征工程作业需要提供此参数)。 deep_learning_parameters 否 DeepLearingParam object 排序作业通用参数(LR、DEEPFM、AutoGroup需要提供此参数)。 algorithm_specify_parameters 否 AlgorithmSpecifyParameters object 排序算法特定参数(LR、DEEPFM、AutoGroup需要提供此参数)。 load_widetable 否 Boolean 导入宽表(离线数据导入作业需要提供此参数)。 load_profile 否 Boolean 导入画像(离线数据导入作业需要提供此参数)。 save_mode 否 String 保留已有宽表(离线数据导入作业需要提供此参数): append,是 new,否 overwirte,覆盖 indicators 否 Array of Indicator objects 统计指标(效果评估作业需要提供此参数)。 offline_rank_job_name 否 String 离线排序作业名称(在线训练任务需要提供此参数)。 update_interval 否 Integer 更新周期(在线训练任务需要提供此参数)。 optimizer 否 Optimizer object 优化器(在线训练任务需要提供此参数)。 flows 否 Flow object 在线流程(在线训练任务需要提供此参数)。 表6 NearLineRecallParam 参数 是否必选 参数类型 描述 time_limit 否 Boolean 时间过滤。 timeFeature 否 String 时间特征。 retainDays 否 Integer 保留期(天)。 recall_fileds 否 Array of RecallFiled objects 召回字段。 itemCF_job_name 否 String 物品协同过滤作业名称。 表7 RecallFiled 参数 是否必选 参数类型 描述 name 否 String 字段名称。 value 否 Integer 使用字段值的个数。 最小值:1 最大值:10 缺省值:1 表8 MatchFeaturePair 参数 是否必选 参数类型 描述 user_feature_name 否 String 用户特征。 item_feature_name 否 String 物品特征。 weight 否 Double 权重。 match_count 否 Boolean 匹配个数度量。 表9 Striping 参数 是否必选 参数类型 描述 nearest_neighborhood 是 Integer 最近领域个数。 band 是 Integer 相似程度。 最小值:1 最大值:20 row 是 Integer 相似距离。 最小值:1 最大值:10 表10 MatrixFactorization 参数 是否必选 参数类型 描述 implicit_vector_rank 是 Integer 隐向量维度。 最小值:1 最大值:100 regular_param 是 Double 优化正则化系数。 最小值:1.0E-8 最大值:1 max_iterator_num 是 Integer 迭代次数。 最小值:1 最大值:50 表11 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 表12 UcbParam 参数 是否必选 参数类型 描述 alpha 是 Double 折中参数。 最小值:0 最大值:1 min_used_num 是 Integer 最小行为次数。 最小值:30 最大值:1000 表13 BehaviorGravity 参数 是否必选 参数类型 描述 weaken_factor 否 Double 衰减因子。 最小值:0.1 最大值:5 view_type 否 String 行为次数统计方法: pv,访问量 uv,独立访客 algo_type 否 String 算法类型: normal,通用 time,时间 表14 Category 参数 是否必选 参数类型 描述 user_meta_list 否 Array of strings 用户特征。 item_meta_list 否 Array of strings 物品特征。 表15 EtlBasicParameter 参数 是否必选 参数类型 描述 user_features 否 Array of FeatureTransformation objects 用户特征。 item_features 否 Array of FeatureTransformation objects 物品特征。 rank_etl_filter 否 RankETLFilter object 过滤参数。 表16 FeatureTransformation 参数 是否必选 参数类型 描述 attr 否 Attribute object 特征。 discrete_method 否 String 离散方法: equal_distance_discrete,等距离散 user_define_discrete,自定义离散 normalize,归一化 null,不离散 params 否 Object 具体处理参数。 表17 Attribute 参数 是否必选 参数类型 描述 name 是 String 名称。 data_type 否 String 数据类型。 other_uses 否 Array of strings 其他用途。 表18 RankETLFilter 参数 是否必选 参数类型 描述 filter_type 是 String 行为去重方式: abs_weight,权重绝对值 date,日期 time_type 是 String 时间类型: day,天 week,周 month,月 is_monday_first 否 Boolean 周一是否是第一天。 表19 SampleParam 参数 是否必选 参数类型 描述 divide_type 是 String 训练集测试集划分方式: TIME,时间比例 RAMDOM,个数比例 train_rate 否 Double 训练数据占比。 最小值:0.01 最大值:1 test_rate 否 Double 测试数据占比。 最小值:0.01 最大值:1 表20 DeepLearingParam 参数 是否必选 参数类型 描述 initial_parameters 否 Initial object 初始化参数。 optimize_parameters 否 Optimizer object 优化参数。 regular_parameters 否 Regular object 正则化参数。 max_iterations 否 Integer 最大迭代轮数。 最小值:1 最大值:1000 early_stop_iterations 否 Integer 提前终止训练轮数。 最小值:1 最大值:1000 batch_size 否 Integer 批量大小。 最小值:1 dataset_split_parts 否 Integer 训练数据集切分数量。 最小值:1 最大值:10 restart_train 否 Boolean 重新训练。 表21 Initial 参数 是否必选 参数类型 描述 initial_method 是 String 初始化方法。 mean_value 否 Double 平均值。 最小值:-1 最大值:1 standard_deviation 否 Double 标准差。 最小值:0 最大值:1 min_value 否 Double 最小值。 最小值:-1 最大值:0 max_value 否 Double 最大值。 最小值:0 最大值:1 表22 Optimizer 参数 是否必选 参数类型 描述 type 否 String 优化器类型。 learning_rate 否 Double 学习率。 initial_accumulator_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 表23 Regular 参数 是否必选 参数类型 描述 l2_regularization 否 Double L2正则项系数。 最小值:0 最大值:1 regular_loss_compute_mode 否 String 正则损失计算方式。 embed_l2_regularization 否 Double 隐向量层L2正则化系数。 最小值:0 最大值:1 wide_l2_regularization 否 Double wide部分L2正则化系数。 最小值:0 最大值:1 structure_l2_regularization 否 Double 结构化部分L2正则化系数。 最小值:0 最大值:1 表24 AlgorithmSpecifyParameters 参数 是否必选 参数类型 描述 latent_vector_length 否 Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值:1 最大值:100 architecture 否 Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function 否 String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability 否 Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值:0 最大值:1 embed_size 否 Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture 否 Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order 否 Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes 否 Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation 否 Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part 否 Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer 否 Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot 否 Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure 否 Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表25 Indicator 参数 是否必选 参数类型 描述 indicator_name 否 String 指标名称: clickPVRate,点击PV率 clickUVRate,点击UV率 customize,自定义 indicator_params 否 IndicatorParam object 指标参数(自定义指标需要提供)。 表26 IndicatorParam 参数 是否必选 参数类型 描述 customize_parameter 否 CustomizeParameter object 自定义参数。 customize_formula 否 CustomizeFormula object 自定义公式。 表27 CustomizeParameter 参数 是否必选 参数类型 描述 alias 是 String 别名。 behavior_type 是 String 行为类型。 threshold 否 Double 阈值。 最小值:0 最大值:1 deduplication 是 String 去重。 表28 CustomizeFormula 参数 是否必选 参数类型 描述 alias 否 String 别名。 formula 否 String 公式。 表29 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 Deduplication objects 属性去重。 attribute_info 否 AttributeInfo object 综合排序信息。 bloom_filter_conf 否 BloomFilterConf object 布隆过滤器配置。 group_attr 否 String 分组打散属性。 pre_deal 否 Boolean 在排序前去重。 rank_setting 否 String 排序配置信息。 rules 否 Rule object 候选集融合。 filter_sets 否 Array of strings 过滤配置信息。 attr_value_rules_filter 否 Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve 否 Array of AttrValueRules objects 属性值保留。 ctr_job 否 String 排序作业(使用点击率预估时需要提供此参数)。 ratio 否 Integer 流量占比。 最小值:1 最大值:100 toppings 否 Array of strings 需要置顶的候选集列表。 表30 AttrPairRules 参数 是否必选 参数类型 描述 attr_pairs 否 Array of AttrPair objects 属性对。 表31 AttrPair 参数 是否必选 参数类型 描述 party_a 否 String 被推荐对象的属性名。 party_b 否 String 被推荐对象的属性名。 表32 Deduplication 参数 是否必选 参数类型 描述 attributes 否 Array of strings 属性。 表33 AttributeInfo 参数 是否必选 参数类型 描述 rank_feature_pairs 否 Array of RankFeaturePair objects 属性匹配对。 numerical_attrs 否 Array of NumericalAttr objects 属性权重。 num_statistics_type 否 String 统计方式: ORDER,顺序 ABS,绝对值 表34 RankFeaturePair 参数 是否必选 参数类型 描述 feature_name_a 否 String 待推荐对象的属性。 feature_name_b 否 String 被推荐对象的属性。 weight 否 Float 权重。 最小值:0.01 最大值:1 表35 NumericalAttr 参数 是否必选 参数类型 描述 name 是 String 特征名。 weight 是 Float 权重。 最小值:0.001 最大值:1 表36 BloomFilterConf 参数 是否必选 参数类型 描述 behaviors 否 Array of strings 待过滤行为类型。 interval 否 Integer 过滤时间。 最小值:1 最大值:7 表37 Rule 参数 是否必选 参数类型 描述 table_name 是 String 候选集表名。 rule_ratio 是 Integer 规则占比。 最小值:1 最大值:100 priority 是 Integer 优先级。 最小值:1 最大值:10 表38 AttrValueRules 参数 是否必选 参数类型 描述 attr_values_a 否 Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b 是 Array of AttrValue objects 待推荐对象的属性-值配置。 表39 AttrValue 参数 是否必选 参数类型 描述 name 是 String 属性名称。 value 是 String 属性值。
  • 请求示例 物品协同过滤召回作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instance{ "job_name" : "itemcf-test", "description" : "itemcf", "category" : "RECALL", "job_type" : "ItemCf", "job_config" : { "striping" : { "nearest_neighborhood" : 50, "band" : 4, "row" : 5 }, "max_recommended_num" : 10 }} 智能ETL参数生成作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instance{ "job_name" : "AutoPreRank-test", "description" : "AutoPreRank", "category" : "SORTING", "job_type" : "AutoPreRank", "job_config" : { }} 属性匹配召回作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instance{ "job_name" : "attribute-test", "description" : "attribute", "category" : "RECALL", "job_type" : "AttributeMatch", "job_config" : { "match_feature_pairs" : [ { "user_feature_name" : "tags", "item_feature_name" : "tags", "weight" : 1 } ], "striping" : { "nearest_neighborhood" : 50, "band" : 4, "row" : 5 }, "max_recommended_num" : 10 }} 离线特征工程作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instance{ "job_name" : "ETL-test", "description" : "ETL", "category" : "SORTING", "job_type" : "ETL", "job_config" : { "features_engineering" : { "user_features" : [ { "attr" : { "name" : "age", "data_type" : "long" }, "discrete_method" : "user_define_discrete", "params" : { "discrete_periods" : [ 1, 31, 52, 73, 94, 100 ] } }, { "attr" : { "name" : "gender", "data_type" : "string" }, "params" : { } }, { "attr" : { "name" : "tags", "data_type" : "strArray" }, "params" : { "value_preserve_number" : 3 } }, { "attr" : { "name" : "extend_float", "data_type" : "float" }, "discrete_method" : "normalize", "params" : { "lower_limit" : 1, "upper_limit" : 10 } } ], "item_features" : [ { "attr" : { "name" : "extend_float", "data_type" : "float" }, "discrete_method" : "null" }, { "attr" : { "name" : "extend_string", "data_type" : "string" }, "params" : { } }, { "attr" : { "name" : "extend_strArray", "data_type" : "strArray" }, "params" : { "value_preserve_number" : 3 } } ], "rank_etl_filter" : { "filter_type" : "date", "time_type" : "day", "is_monday_first" : true } }, "sample_param" : { "divide_type" : "TIME", "train_rate" : 0.7, "test_rate" : 0.3 } }} 近线召回作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/instance{ "job_name" : "NearlineRecall-test", "description" : "nearlinerecall", "category" : "RECALL", "job_type" : "NearlineRecall", "job_config" : { "nearline_recall_param" : { "time_limit" : true, "time_feature" : "publishTime", "retain_days" : 2, "recall_fileds" : [ { "name" : "author", "value" : 1 }, { "name" : "category", "value" : 1 }, { "name" : "tags", "value" : 3 } ], "max_recommended_num" : 100 } }} 离线数据导入作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx//workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx//resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx//job-instance{ "job_name" : "dataimport-test", "description" : "dataimport", "category" : "DATASOURCE", "job_type" : "DataImport", "job_config" : { "load_widetable" : true, "load_profile" : true }} 物品画像实时导入作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/instance{ "job_name" : "WriteItemProfile-test", "description" : "item", "category" : "DATASOURCE", "job_type" : "WriteItemProfile", "job_config" : { }} 历史行为过滤作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instance{ "job_name" : "Filter-test", "description" : "Filter", "category" : "FILTER", "job_type" : "Filter", "job_config" : { "behavior_frequencys" : [ { "behavior_type" : "view", "lower_limit" : 1, "upper_limit" : 200, "time_interval" : 1000 }, { "behavior_type" : "click", "lower_limit" : 1, "upper_limit" : 200, "time_interval" : 1000 } ], "behavior_logic" : "OR", "max_recommended_num" : 10 }} LR作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/instance{ "job_name" : "LR-test", "description" : "lr", "category" : "SORTING", "job_type" : "LR", "job_config" : { "algorithm_specify_parameters" : { }, "deep_learning_parameters" : { "max_iterations" : 50, "regular_parameters" : { "l2_regularization" : 0, "regular_loss_compute_mode" : "full" }, "early_stop_iterations" : 5, "initial_parameters" : { "initial_method" : "normal", "mean_value" : 0, "standard_deviation" : 0.001 }, "optimize_parameters" : { "type" : "adam", "learning_rate" : 0.001, "epsilon" : 1.0E-8 } } }} 数据探索作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instance{ "job_name" : "DataExploration-test", "description" : "DataExploration", "category" : "DATASOURCE", "job_type" : "DataExploration", "job_config" : { }}
  • 响应示例 状态码: 200 OK { "job" : { "category" : "RECALL", "job_name" : "ae1", "job_id" : "388af6ad73cb49dcaf058b929fe2ecbb", "description" : "", "job_type" : "AlsCF", "schedule" : "00 50 01 * * ?", "status" : "Draft", "next_schedule_time" : 1588873800000, "platform" : "OFFLINE", "workspace_id" : "06a7c49afc00d4972ff1c0113d8c49ba", "resource_id" : "286f3ab20331476b9c731ac32c97236f" }, "is_success" : true}
  • 响应参数 状态码: 200 表42 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功 job jobs object 作业信息 message String 返回消息(请求成功时,不返回此字段) error_code String 错误码(请求成功时,不返回此字段) 表43 jobs 参数 参数类型 描述 category String 类别。 config_info String 配置信息。 description String 描述。 job_id String 作业id。 job_name String 作业名称。 job_type String 作业类型。 next_schedule_time Integer 下次调度时间。 platform String 平台。 resource_id String 资源id。 schedule String 调度参数。 status String 状态。 workspace_id String 工作空间id。 job_config jobConfig object 作业配置。 表44 jobConfig 参数 参数类型 描述 nearline_recall_param NearLineRecallParam object 近线召回作业参数(近线召回作业需要提供此参数)。 max_recommended_num Integer 最大候选集个数(所有召回作业需提供此参数)。 最小值:1 最大值:200 match_feature_pairs Array of MatchFeaturePair objects 匹配特征对(属性匹配召回作业需要提供此参数)。 striping Striping object 行条化策略(属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数)。 match_type String 匹配类型(属性匹配召回作业需提供此参数): UI,基于用户推荐物品 UU,基于用户推荐用户 II,基于物品推荐物品 IU,基于物品推荐用户 matrix_factorization MatrixFactorization object 矩阵分解参数配置(交替最小二乘协同过滤作业需提供此参数)。 behavior_frequencys Array of BehaviorFrequency objects 行为频率信息(历史行为记忆召回作业、历史行为过滤作业需提供此参数)。 file_path String 文件路径(人工配置候选集作业需要提供此参数)。 ucb_param UcbParam object UCB作业参数(UCB召回作业需要提供此参数)。 behavior_gravity BehaviorGravity object 重力衰减因子(综合行为热度召回作业需要提供此参数)。 category Category object 类别(综合行为热度召回作业需要提供此参数)。 behavior_logic String 行为逻辑过滤(历史行为过滤作业需提供此参数): AND,同时满足则过滤 OR, 满足一个则过滤 features_engineering EtlBasicParameter object 特征参数(离线特征工程作业需要提供此参数)。 sample_param SampleParam object 样本参数(离线特征工程作业需要提供此参数)。 deep_learning_parameters DeepLearingParam object 排序作业通用参数(LR、DEEPFM、AutoGroup需要提供此参数)。 algorithm_specify_parameters AlgorithmSpecifyParameters object 排序算法特定参数(LR、DEEPFM、AutoGroup需要提供此参数)。 load_widetable Boolean 导入宽表(离线数据导入作业需要提供此参数)。 load_profile Boolean 导入画像(离线数据导入作业需要提供此参数)。 save_mode String 保留已有宽表(离线数据导入作业需要提供此参数): append,是 new,否 overwirte,覆盖 indicators Array of Indicator objects 统计指标(效果评估作业需要提供此参数)。 offline_rank_job_name String 离线排序作业名称(在线训练任务需要提供此参数)。 update_interval Integer 更新周期(在线训练任务需要提供此参数)。 optimizer Optimizer object 优化器(在线训练任务需要提供此参数)。 flows Flow object 在线流程(在线训练任务需要提供此参数)。 表45 NearLineRecallParam 参数 参数类型 描述 time_limit Boolean 时间过滤。 timeFeature String 时间特征。 retainDays Integer 保留期(天)。 recall_fileds Array of RecallFiled objects 召回字段。 itemCF_job_name String 物品协同过滤作业名称。 表46 RecallFiled 参数 参数类型 描述 name String 字段名称。 value Integer 使用字段值的个数。 最小值:1 最大值:10 缺省值:1 表47 MatchFeaturePair 参数 参数类型 描述 user_feature_name String 用户特征。 item_feature_name String 物品特征。 weight Double 权重。 match_count Boolean 匹配个数度量。 表48 Striping 参数 参数类型 描述 nearest_neighborhood Integer 最近领域个数。 band Integer 相似程度。 最小值:1 最大值:20 row Integer 相似距离。 最小值:1 最大值:10 表49 MatrixFactorization 参数 参数类型 描述 implicit_vector_rank Integer 隐向量维度。 最小值:1 最大值:100 regular_param Double 优化正则化系数。 最小值:1.0E-8 最大值:1 max_iterator_num Integer 迭代次数。 最小值:1 最大值:50 表50 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 表51 UcbParam 参数 参数类型 描述 alpha Double 折中参数。 最小值:0 最大值:1 min_used_num Integer 最小行为次数。 最小值:30 最大值:1000 表52 BehaviorGravity 参数 参数类型 描述 weaken_factor Double 衰减因子。 最小值:0.1 最大值:5 view_type String 行为次数统计方法: pv,访问量 uv,独立访客 algo_type String 算法类型: normal,通用 time,时间 表53 Category 参数 参数类型 描述 user_meta_list Array of strings 用户特征。 item_meta_list Array of strings 物品特征。 表54 EtlBasicParameter 参数 参数类型 描述 user_features Array of FeatureTransformation objects 用户特征。 item_features Array of FeatureTransformation objects 物品特征。 rank_etl_filter RankETLFilter object 过滤参数。 表55 FeatureTransformation 参数 参数类型 描述 attr Attribute object 特征。 discrete_method String 离散方法: equal_distance_discrete,等距离散 user_define_discrete,自定义离散 normalize,归一化 null,不离散 params Object 具体处理参数。 表56 Attribute 参数 参数类型 描述 name String 名称。 data_type String 数据类型。 other_uses Array of strings 其他用途。 表57 RankETLFilter 参数 参数类型 描述 filter_type String 行为去重方式: abs_weight,权重绝对值 date,日期 time_type String 时间类型: day,天 week,周 month,月 is_monday_first Boolean 周一是否是第一天。 表58 SampleParam 参数 参数类型 描述 divide_type String 训练集测试集划分方式: TIME,时间比例 RAMDOM,个数比例 train_rate Double 训练数据占比。 最小值:0.01 最大值:1 test_rate Double 测试数据占比。 最小值:0.01 最大值:1 表59 DeepLearingParam 参数 参数类型 描述 initial_parameters Initial object 初始化参数。 optimize_parameters Optimizer object 优化参数。 regular_parameters Regular object 正则化参数。 max_iterations Integer 最大迭代轮数。 最小值:1 最大值:1000 early_stop_iterations Integer 提前终止训练轮数。 最小值:1 最大值:1000 batch_size Integer 批量大小。 最小值:1 dataset_split_parts Integer 训练数据集切分数量。 最小值:1 最大值:10 restart_train Boolean 重新训练。 表60 Initial 参数 参数类型 描述 initial_method String 初始化方法。 mean_value Double 平均值。 最小值:-1 最大值:1 standard_deviation Double 标准差。 最小值:0 最大值:1 min_value Double 最小值。 最小值:-1 最大值:0 max_value Double 最大值。 最小值:0 最大值:1 表61 Optimizer 参数 参数类型 描述 type String 优化器类型。 learning_rate Double 学习率。 initial_accumulator_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 表62 Regular 参数 参数类型 描述 l2_regularization Double L2正则项系数。 最小值:0 最大值:1 regular_loss_compute_mode String 正则损失计算方式。 embed_l2_regularization Double 隐向量层L2正则化系数。 最小值:0 最大值:1 wide_l2_regularization Double wide部分L2正则化系数。 最小值:0 最大值:1 structure_l2_regularization Double 结构化部分L2正则化系数。 最小值:0 最大值:1 表63 AlgorithmSpecifyParameters 参数 参数类型 描述 latent_vector_length Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值:1 最大值:100 architecture Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值:0 最大值:1 embed_size Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表64 Indicator 参数 参数类型 描述 indicator_name String 指标名称: clickPVRate,点击PV率 clickUVRate,点击UV率 customize,自定义 indicator_params IndicatorParam object 指标参数(自定义指标需要提供)。 表65 IndicatorParam 参数 参数类型 描述 customize_parameter CustomizeParameter object 自定义参数。 customize_formula CustomizeFormula object 自定义公式。 表66 CustomizeParameter 参数 参数类型 描述 alias String 别名。 behavior_type String 行为类型。 threshold Double 阈值。 最小值:0 最大值:1 deduplication String 去重。 表67 CustomizeFormula 参数 参数类型 描述 alias String 别名。 formula String 公式。 表68 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 Deduplication objects 属性去重。 attribute_info AttributeInfo object 综合排序信息。 bloom_filter_conf BloomFilterConf object 布隆过滤器配置。 group_attr String 分组打散属性。 pre_deal Boolean 在排序前去重。 rank_setting String 排序配置信息。 rules Rule object 候选集融合。 filter_sets Array of strings 过滤配置信息。 attr_value_rules_filter Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve Array of AttrValueRules objects 属性值保留。 ctr_job String 排序作业(使用点击率预估时需要提供此参数)。 ratio Integer 流量占比。 最小值:1 最大值:100 toppings Array of strings 需要置顶的候选集列表。 表69 AttrPairRules 参数 参数类型 描述 attr_pairs Array of AttrPair objects 属性对。 表70 AttrPair 参数 参数类型 描述 party_a String 被推荐对象的属性名。 party_b String 被推荐对象的属性名。 表71 Deduplication 参数 参数类型 描述 attributes Array of strings 属性。 表72 AttributeInfo 参数 参数类型 描述 rank_feature_pairs Array of RankFeaturePair objects 属性匹配对。 numerical_attrs Array of NumericalAttr objects 属性权重。 num_statistics_type String 统计方式: ORDER,顺序 ABS,绝对值 表73 RankFeaturePair 参数 参数类型 描述 feature_name_a String 待推荐对象的属性。 feature_name_b String 被推荐对象的属性。 weight Float 权重。 最小值:0.01 最大值:1 表74 NumericalAttr 参数 参数类型 描述 name String 特征名。 weight Float 权重。 最小值:0.001 最大值:1 表75 BloomFilterConf 参数 参数类型 描述 behaviors Array of strings 待过滤行为类型。 interval Integer 过滤时间。 最小值:1 最大值:7 表76 Rule 参数 参数类型 描述 table_name String 候选集表名。 rule_ratio Integer 规则占比。 最小值:1 最大值:100 priority Integer 优先级。 最小值:1 最大值:10 表77 AttrValueRules 参数 参数类型 描述 attr_values_a Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b Array of AttrValue objects 待推荐对象的属性-值配置。 表78 AttrValue 参数 参数类型 描述 name String 属性名称。 value String 属性值。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型,取值为application/json X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 类别: RECALL,召回作业 DATASOURCE,数据源作业 FILTER,过滤作业 SORTING,排序作业 EVALUATE,效果评估作业 description 否 String 描述 job_config 是 jobConfig object 作业配置 exec_config 否 ResExecConfig object 作业执行配置项(仅离线任务可提供此配置) job_name 是 String 作业名称,1-64位字母、数字、下划线、中划线组合 最小长度:1 最大长度:64 job_type 是 String 作业类型: WriteUserProfile,用户画像实时导入作业 WriteItemProfile,物品画像实时导入作业 UniversalProcess,行为数据实时导入作业 NearlineRecall,近线召回作业 EncodeProfile,近线特征工程作业 AttributeMatch,属性匹配召回作业 AlsCF,交替最小二乘协同过滤作业 BhvHistory,历史行为记忆召回作业 ItemCf,物品协同过滤召回作业 MenEdit,人工配置候选集作业 Ucb,UCB召回作业 UserCf,用户协同过滤召回作业 WeightBehavior,综合行为热度召回作业 Filter,历史行为过滤作业 AutoPreRank,智能ETL参数生成作业 ETL,离线特征工程作业 LR,LR作业 DEEPFM,DEEPFM作业 AutoGroup,AutoGroup作业 StreamRank,在线训练作业 DataStruct,识别数据结构作业 DataExploration,数据探索作业 DataImport,离线数据导入作业 Evaluate,效果评估作业 schedule 否 String 调度参数 表4 jobConfig 参数 是否必选 参数类型 描述 nearline_recall_param 否 NearLineRecallParam object 近线召回作业参数(近线召回作业需要提供此参数)。 max_recommended_num 否 Integer 最大候选集个数(所有召回作业需提供此参数)。 最小值:1 最大值:200 match_feature_pairs 否 Array of MatchFeaturePair objects 匹配特征对(属性匹配召回作业需要提供此参数)。 striping 否 Striping object 行条化策略(属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数)。 match_type 否 String 匹配类型(属性匹配召回作业需提供此参数): UI,基于用户推荐物品 UU,基于用户推荐用户 II,基于物品推荐物品 IU,基于物品推荐用户 matrix_factorization 否 MatrixFactorization object 矩阵分解参数配置(交替最小二乘协同过滤作业需提供此参数)。 behavior_frequencys 否 Array of BehaviorFrequency objects 行为频率信息(历史行为记忆召回作业、历史行为过滤作业需提供此参数)。 file_path 否 String 文件路径(人工配置候选集作业需要提供此参数)。 ucb_param 否 UcbParam object UCB作业参数(UCB召回作业需要提供此参数)。 behavior_gravity 否 BehaviorGravity object 重力衰减因子(综合行为热度召回作业需要提供此参数)。 category 否 Category object 类别(综合行为热度召回作业需要提供此参数)。 behavior_logic 否 String 行为逻辑过滤(历史行为过滤作业需提供此参数): AND,同时满足则过滤 OR, 满足一个则过滤 features_engineering 否 EtlBasicParameter object 特征参数(离线特征工程作业需要提供此参数)。 sample_param 否 SampleParam object 样本参数(离线特征工程作业需要提供此参数)。 deep_learning_parameters 否 DeepLearingParam object 排序作业通用参数(LR、DEEPFM、AutoGroup需要提供此参数)。 algorithm_specify_parameters 否 AlgorithmSpecifyParameters object 排序算法特定参数(LR、DEEPFM、AutoGroup需要提供此参数)。 load_widetable 否 Boolean 导入宽表(离线数据导入作业需要提供此参数)。 load_profile 否 Boolean 导入画像(离线数据导入作业需要提供此参数)。 save_mode 否 String 保留已有宽表(离线数据导入作业需要提供此参数): append,是 new,否 overwirte,覆盖 indicators 否 Array of Indicator objects 统计指标(效果评估作业需要提供此参数)。 offline_rank_job_name 否 String 离线排序作业名称(在线训练任务需要提供此参数)。 update_interval 否 Integer 更新周期(在线训练任务需要提供此参数)。 optimizer 否 Optimizer object 优化器(在线训练任务需要提供此参数)。 flows 否 Flow object 在线流程(在线训练任务需要提供此参数)。 表5 NearLineRecallParam 参数 是否必选 参数类型 描述 time_limit 否 Boolean 时间过滤。 timeFeature 否 String 时间特征。 retainDays 否 Integer 保留期(天)。 recall_fileds 否 Array of RecallFiled objects 召回字段。 itemCF_job_name 否 String 物品协同过滤作业名称。 表6 RecallFiled 参数 是否必选 参数类型 描述 name 否 String 字段名称。 value 否 Integer 使用字段值的个数。 最小值:1 最大值:10 缺省值:1 表7 MatchFeaturePair 参数 是否必选 参数类型 描述 user_feature_name 否 String 用户特征。 item_feature_name 否 String 物品特征。 weight 否 Double 权重。 match_count 否 Boolean 匹配个数度量。 表8 Striping 参数 是否必选 参数类型 描述 nearest_neighborhood 是 Integer 最近领域个数。 band 是 Integer 相似程度。 最小值:1 最大值:20 row 是 Integer 相似距离。 最小值:1 最大值:10 表9 MatrixFactorization 参数 是否必选 参数类型 描述 implicit_vector_rank 是 Integer 隐向量维度。 最小值:1 最大值:100 regular_param 是 Double 优化正则化系数。 最小值:1.0E-8 最大值:1 max_iterator_num 是 Integer 迭代次数。 最小值:1 最大值:50 表10 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 表11 UcbParam 参数 是否必选 参数类型 描述 alpha 是 Double 折中参数。 最小值:0 最大值:1 min_used_num 是 Integer 最小行为次数。 最小值:30 最大值:1000 表12 BehaviorGravity 参数 是否必选 参数类型 描述 weaken_factor 否 Double 衰减因子。 最小值:0.1 最大值:5 view_type 否 String 行为次数统计方法: pv,访问量 uv,独立访客 algo_type 否 String 算法类型: normal,通用 time,时间 表13 Category 参数 是否必选 参数类型 描述 user_meta_list 否 Array of strings 用户特征。 item_meta_list 否 Array of strings 物品特征。 表14 EtlBasicParameter 参数 是否必选 参数类型 描述 user_features 否 Array of FeatureTransformation objects 用户特征。 item_features 否 Array of FeatureTransformation objects 物品特征。 rank_etl_filter 否 RankETLFilter object 过滤参数。 表15 FeatureTransformation 参数 是否必选 参数类型 描述 attr 否 Attribute object 特征。 discrete_method 否 String 离散方法: equal_distance_discrete,等距离散 user_define_discrete,自定义离散 normalize,归一化 null,不离散 params 否 Object 具体处理参数。 表16 Attribute 参数 是否必选 参数类型 描述 name 是 String 名称。 data_type 否 String 数据类型。 other_uses 否 Array of strings 其他用途。 表17 RankETLFilter 参数 是否必选 参数类型 描述 filter_type 是 String 行为去重方式: abs_weight,权重绝对值 date,日期 time_type 是 String 时间类型: day,天 week,周 month,月 is_monday_first 否 Boolean 周一是否是第一天。 表18 SampleParam 参数 是否必选 参数类型 描述 divide_type 是 String 训练集测试集划分方式: TIME,时间比例 RAMDOM,个数比例 train_rate 否 Double 训练数据占比。 最小值:0.01 最大值:1 test_rate 否 Double 测试数据占比。 最小值:0.01 最大值:1 表19 DeepLearingParam 参数 是否必选 参数类型 描述 initial_parameters 否 Initial object 初始化参数。 optimize_parameters 否 Optimizer object 优化参数。 regular_parameters 否 Regular object 正则化参数。 max_iterations 否 Integer 最大迭代轮数。 最小值:1 最大值:1000 early_stop_iterations 否 Integer 提前终止训练轮数。 最小值:1 最大值:1000 batch_size 否 Integer 批量大小。 最小值:1 dataset_split_parts 否 Integer 训练数据集切分数量。 最小值:1 最大值:10 restart_train 否 Boolean 重新训练。 表20 Initial 参数 是否必选 参数类型 描述 initial_method 是 String 初始化方法。 mean_value 否 Double 平均值。 最小值:-1 最大值:1 standard_deviation 否 Double 标准差。 最小值:0 最大值:1 min_value 否 Double 最小值。 最小值:-1 最大值:0 max_value 否 Double 最大值。 最小值:0 最大值:1 表21 Optimizer 参数 是否必选 参数类型 描述 type 否 String 优化器类型。 learning_rate 否 Double 学习率。 initial_accumulator_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 表22 Regular 参数 是否必选 参数类型 描述 l2_regularization 否 Double L2正则项系数。 最小值:0 最大值:1 regular_loss_compute_mode 否 String 正则损失计算方式。 embed_l2_regularization 否 Double 隐向量层L2正则化系数。 最小值:0 最大值:1 wide_l2_regularization 否 Double wide部分L2正则化系数。 最小值:0 最大值:1 structure_l2_regularization 否 Double 结构化部分L2正则化系数。 最小值:0 最大值:1 表23 AlgorithmSpecifyParameters 参数 是否必选 参数类型 描述 latent_vector_length 否 Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值:1 最大值:100 architecture 否 Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function 否 String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability 否 Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值:0 最大值:1 embed_size 否 Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture 否 Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order 否 Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes 否 Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation 否 Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part 否 Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer 否 Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot 否 Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure 否 Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表24 Indicator 参数 是否必选 参数类型 描述 indicator_name 否 String 指标名称: clickPVRate,点击PV率 clickUVRate,点击UV率 customize,自定义 indicator_params 否 IndicatorParam object 指标参数(自定义指标需要提供)。 表25 IndicatorParam 参数 是否必选 参数类型 描述 customize_parameter 否 CustomizeParameter object 自定义参数。 customize_formula 否 CustomizeFormula object 自定义公式。 表26 CustomizeParameter 参数 是否必选 参数类型 描述 alias 是 String 别名。 behavior_type 是 String 行为类型。 threshold 否 Double 阈值。 最小值:0 最大值:1 deduplication 是 String 去重。 表27 CustomizeFormula 参数 是否必选 参数类型 描述 alias 否 String 别名。 formula 否 String 公式。 表28 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 Deduplication objects 属性去重。 attribute_info 否 AttributeInfo object 综合排序信息。 bloom_filter_conf 否 BloomFilterConf object 布隆过滤器配置。 group_attr 否 String 分组打散属性。 pre_deal 否 Boolean 在排序前去重。 rank_setting 否 String 排序配置信息。 rules 否 Rule object 候选集融合。 filter_sets 否 Array of strings 过滤配置信息。 attr_value_rules_filter 否 Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve 否 Array of AttrValueRules objects 属性值保留。 ctr_job 否 String 排序作业(使用点击率预估时需要提供此参数)。 ratio 否 Integer 流量占比。 最小值:1 最大值:100 toppings 否 Array of strings 需要置顶的候选集列表。 表29 AttrPairRules 参数 是否必选 参数类型 描述 attr_pairs 否 Array of AttrPair objects 属性对。 表30 AttrPair 参数 是否必选 参数类型 描述 party_a 否 String 被推荐对象的属性名。 party_b 否 String 被推荐对象的属性名。 表31 Deduplication 参数 是否必选 参数类型 描述 attributes 否 Array of strings 属性。 表32 AttributeInfo 参数 是否必选 参数类型 描述 rank_feature_pairs 否 Array of RankFeaturePair objects 属性匹配对。 numerical_attrs 否 Array of NumericalAttr objects 属性权重。 num_statistics_type 否 String 统计方式: ORDER,顺序 ABS,绝对值 表33 RankFeaturePair 参数 是否必选 参数类型 描述 feature_name_a 否 String 待推荐对象的属性。 feature_name_b 否 String 被推荐对象的属性。 weight 否 Float 权重。 最小值:0.01 最大值:1 表34 NumericalAttr 参数 是否必选 参数类型 描述 name 是 String 特征名。 weight 是 Float 权重。 最小值:0.001 最大值:1 表35 BloomFilterConf 参数 是否必选 参数类型 描述 behaviors 否 Array of strings 待过滤行为类型。 interval 否 Integer 过滤时间。 最小值:1 最大值:7 表36 Rule 参数 是否必选 参数类型 描述 table_name 是 String 候选集表名。 rule_ratio 是 Integer 规则占比。 最小值:1 最大值:100 priority 是 Integer 优先级。 最小值:1 最大值:10 表37 AttrValueRules 参数 是否必选 参数类型 描述 attr_values_a 否 Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b 是 Array of AttrValue objects 待推荐对象的属性-值配置。 表38 AttrValue 参数 是否必选 参数类型 描述 name 是 String 属性名称。 value 是 String 属性值。 表39 ResExecConfig 参数 是否必选 参数类型 描述 spark_calc_spec 否 SparkCalcSpec object spark自定义计算规格 spark_option_confs 否 Array of SparkOptionConf objects spark可选配置项 表40 SparkCalcSpec 参数 是否必选 参数类型 描述 driver_memory 是 String driver内存 driver_cores 是 Integer driver核数 executor_memory 是 String executor内存 executor_cores 是 Integer executor核数 num_executors 是 Integer executor个数 表41 SparkOptionConf 参数 是否必选 参数类型 描述 name 否 String 参数名称 value 否 String 参数值
  • URI POST /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/job-instance 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目ID resource_id 是 String 资源id workspace_id 是 String 工作空间id
  • 响应消息 响应参数请参见表14-响应参数说明。 表14 响应参数说明 参数名称 是否必选 参数类型 描述信息 is_success 是 Boolean 是否成功。 strategies 是 List 请参见表15,返回策略结果集。 job_id 是 String 作业ID。 filter_uuid 是 String 过滤规则生成的uuid。 表15 strategies参数说明 参数名称 是否必选 参数类型 描述信息 strategy_type 是 String 策略类型(可选值) 召回策略:recall 排序策略:sorting name 是 String 策略别名。 algorithm_type 是 String 算法类型 。 parameter 是 JSON 请参见策略参数说明,算法参数。 candidate_set 是 List 请参见表16,候选结果集。 表16 candidate_set参数说明 参数名称 是否必选 参数类型 说明 uuid 是 String 候选集ID。 description 是 String 候选集描述。 表17 region_info参数说明 参数名称 是否必选 参数类型 说明 region_num 是 Integer 预分区个数。默认推荐预分区8个。 index_region_num 否 Integer 索引表预分区个数。只有特种工程中,初始用户画像-物品画像-标准宽表生成算子需要使用索引表预分区个数,其他离线算子因为不生成索引表不需要此参数。
  • 请求消息 请求参数请参见表2-请求参数说明。 表2 请求参数说明 参数名称 是否必选 参数类型 说明 workspace_id 否 String 工作空间ID,默认为0 job_name 是 String 训练作业名称,只能由数字,字母,下划线,中划线组成,最大长度为20字符。 job_description 否 String 训练作业描述,最大长度为256字符。 offline_platform 是 List 请参见表3,离线计算平台信息。 data_source 是 List 请参见表5数据源。 storage 是 List 请参见表8,信息存储。 algorithm_setting 是 JSON 请参见表10,算法配置。 filter_rules 否 JSON 请参见表12,过滤配置列表。 表3 offline_platform参数说明 参数名称 是否必选 参数类型 说明 platform 是 String 平台名称,支持DLI。 platform_parameter 是 JSON 请参见表4,平台参数。 computing_resource 否 String 指定DLI运行任务的资源规格。 config_load_path 是 String 配置加载路径。 表4 platform_parameter 参数说明 参数名称 是否必选 参数类型 说明 cluster_name 是 String 集群名称,最大长度64。 表5 data_source参数说明 参数名称 是否必选 参数类型 说明 offline 是 List 请参见表6,离线数据源。 表6 offline参数说明 参数名称 是否必选 参数类型 说明 table_type_id 是 String 推荐通用数据模板 用户属性表USER_META 物品属性表ITEM_META 用户操作行为表USER_BEHAVIOR 通用格式GENERAL_FORMAT 数据格式请参见推荐系统离线数据源。 data_source_url 是 String 数据源路径,最大长度1000字符。 data_format 是 String 数据格式,可选值:csv、parquet、json、orc。 data_param 否 JSON 请参见表7,数据格式是csv的时候必选,其他可选。 start_time 否 String 通用格式数据源开始时间。例如,“2018-01-01”。 end_time 否 String 通用格式数据源结束时间。例如,“2018-02-01”。 表7 data_param参数说明 参数名称 是否必选 参数类型 说明 header 是 String 是否显示表头,有表头"true"或无表头"false"。 delimiter 是 String 分隔符,最大长度10字符。 quote 是 String 引用字符,最大长度10字符。 escape 是 String 转义字符,最大长度10字符。 表8 storage参数说明 参数名称 是否必选 参数类型 说明 platform 是 String 平台名称,现支持CloudTable。 platform_parameter 是 JSON 请参见表9,数据存储参数。 表9 platform_parameter 参数说明 参数名称 是否必选 参数类型 说明 cluster_id 是 String 集群ID。 table_name 是 String 表名称,最大长度64字符。 cluster_name 否 String 集群名称。 data_version 否 String 数据版本号。V1或者V2。 region_info 否 JSON 预分区信息。如果选择数据版本为V2时,才需要设置预分区信息。V1则默认不进行预分区。请参见表17,预分区信息。 表10 algorithm_setting参数说明 参数名称 是否必选 参数类型 说明 start_time 否 Long 训练数据开始时间,以毫秒为单位的时间戳。 end_time 否 Long 训练数据结束时间,以毫秒为单位的时间戳。 strategy 是 List 请参见表11,策略集合。 表11 strategy参数说明 参数名称 是否必选 参数类型 说明 strategy_type 是 String 策略类型(可选值) 召回策略:recall 排序策略:sorting name 是 String 策略别名,最大长度60字符。 algorithm_type 是 String 算法类型。 parameter 是 JSON 算法参数,JSON格式。 说明: 提交模板作业接口,根据选择策略的不同,参数也有不同。 召回策略 parameter中包含的参数,请参见策略参数说明中召回策略(recall)各策略参数说明。 排序策略 parameter中包含的参数有以下几部分: spec_id :参数类型Long,训练作业选择的资源规格ID。 run_path:参数类型String,训练结果保存根路径,训练完成后,会将模型和日志文件保存在该路径下。 training_data_path:参数类型String,训练数据的obs路径。 test_data_path:参数类型String,测试数据的obs路径。 策略参数说明中排序策略(sorting)各策略参数说明。 表12 filter_rules参数说明 参数名称 是否必选 参数类型 说明 behavior_rules 否 List 请参见表13,用户行为过滤配置。 blacklist 否 String 黑名单过滤配置。 whitelist 否 String 白名单过滤配置。 etl_uuid 否 String 特征工程-用户物品特征抽取生成的uuid,用于属性过滤配置。 表13 behavior_rules参数说明 参数名称 是否必选 参数类型 说明 behavior_type 是 String 行为类型 。 view:物品曝光 click:用户点击物品 collect:用户收藏了某个物品 uncollect:用户取消收藏某个物品 search_click:用户点击搜索结果中的物品 comment:用户对物品的评论 share: 分享 like:点赞 dislike:点衰 grade:评分 consume:消费 use:观看视频/听音乐/阅读 interval 是 Integer 代表过去几天的天数,取值[1,10000]。 frequency 是 Integer 代表频率次数,取值[1,10000]。
  • 响应消息 响应参数请参见表3。 表3 响应参数说明 参数名称 参数类型 说明 is_success Boolean 请求是否成功。 global_features Object 全局特征表4。 error_code String 请求失败时的错误码,请求成功时无此字段。 error_msg String 请求失败时的错误信息,请求成功时无此字段。 表4 global_features参数说明 参数名称 参数类型 说明 user_features List 用户特征列表。 item_features List 物品特征列表。 表5 user_features 和 item_features参数说明 参数名称 参数类型 说明 feature_name String 特征名称。 feature_type String 特征类型。 feature_value_type String 特征值类型。
  • 请求消息 请求参数请参见表2。 表2 请求参数说明 参数名称 是否必选 参数类型 说明 workspace_id 否 String 工作空间ID,默认为0 job_name 是 String 训练作业名称,最大长度为20字符。 job_description 否 String 训练作业描述,最大长度为256字符。 offline_platform 是 JSON 请参见表3,离线计算平台信息。 storage 是 JSON 请参见表8,信息存储。 strategy 是 JSON 请参见表5,策略信息 表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 strategy参数说明 参数名称 是否必选 参数类型 说明 strategy_type 是 String 策略类型(可选值) 召回策略:recall。 name 是 String 策略别名,最大长度60字符。 algorithm_type 是 String 算法类型。 parameter 是 JSON 请参见策略参数说明,算法参数,JSON字符串。 data_source 是 List 请参见表6,数据源。
  • 响应消息 响应参数请参见表6。 表6 响应参数说明 参数名称 是否必选 参数类型 说明 is_success 是 Boolean 是否成功。 strategy 是 List 请参见表7,返回策略结果。 job_id 是 String 作业ID。 表7 strategy参数说明 参数名称 是否必选 参数类型 说明 strategy_type 是 String 策略类型(可选值) 召回策略:recall name 是 String 策略别名,由汉字、数字、字母、下划线、中划线、空格组成。 algorithm_type 是 String 算法类型。 parameter 是 String 请参见策略参数说明,算法参数,JSON字符串。 表8 candidate_set参数说明 参数名称 是否必选 参数类型 说明 uuid 是 String 候选集ID。 description 是 String 候选集描述。
共100000条