华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功。 workspaces Array of workspaces objects 工作空间详情。 message String 返回消息(请求成功时,不返回此字段)。 error_code String 错误码(请求成功时,不返回此字段)。 表4 workspaces 参数 参数类型 描述 created_at Long 创建时间。 description String 描述。 enterprise_project_id String 企业项目id。 enterprise_project_name String 企业项目名称。 id String 工作空间id。 name String 工作空间名称。 owner String 创建者。 status String 状态。 update_at Long 更新时间。 userId String 用户id。 projectId String 调用账户的项目Id
  • 响应示例 状态码: 200 OK { "is_success" : true, "workspaces" : [ { "userId" : "06a7c49bb080d3311f77c011850266e5", "projectId" : "06a7c49afc00d4972ff1c0113d8c49ba", "id" : "06a7c49afc00d4972ff1c0113d8c49ba", "name" : "default", "description" : "--", "enterprise_project_id" : "0", "enterprise_project_name" : "default", "status" : "NORMAL", "owner" : "ei_res_01", "created_at" : 1587090097881, "update_at" : 1587090097881 }, { "userId" : "06a7c49bb080d3311f77c011850266e5", "projectId" : "06a7c49afc00d4972ff1c0113d8c49ba", "id" : "3b3c7f8a36614d359d919089d4805901", "name" : "res_atuo-test", "description" : "test", "enterprise_project_id" : "0", "enterprise_project_name" : "default", "status" : "NORMAL", "owner" : "ei_res_01", "created_at" : 1585721614279, "update_at" : 1585721614279 } ]}
  • 响应示例 状态码: 200 OK { "is_success" : true, "workspaces" : [ { "userId" : "06a7c49bb080d3311f77c011850266e5", "projectId" : "06a7c49afc00d4972ff1c0113d8c49ba", "id" : "3b3c7f8a36614d359d919089d4805901", "name" : "res_atuo-test", "description" : "test", "enterprise_project_id" : "0", "enterprise_project_name" : "default", "status" : "NORMAL", "owner" : "ei_res_01", "created_at" : 1585721614279, "update_at" : 1585721614279 } ]}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功。 workspaces Array of workspaces objects 工作空间列表。 message String 返回消息(请求成功时,不返回此字段)。 error_code String 错误码(请求成功时,不返回此字段)。 表4 workspaces 参数 参数类型 描述 created_at Long 创建时间。 description String 描述。 enterprise_project_id String 企业项目id。 enterprise_project_name String 企业项目名称。 id String 工作空间id。 name String 工作空间名称。 owner String 创建者。 status String 状态。 update_at Long 更新时间。 userId String 用户id。 projectId String 调用账户的项目Id
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 datasources Array of datasources objects 数据源详情列表。 is_success Boolean 是否成功。 message String 返回消息(请求成功时,不返回此字段)。 error_code String 错误码(请求成功时,不返回此字段)。 表4 datasources 参数 参数类型 描述 datasource_id String 数据源id。 datasource_name String 名称。 status String 状态。 structure String 结构。 workspace_id String 工作空间编号。 data_config DataConfig object 数据配置。 specs_config SpecsConfig object 计算规格配置。 created_at String 创建时间。 update_at Long 更新时间。 表5 DataConfig 参数 参数类型 描述 offline Offline object 离线计算规格。 nearline Nearline object 近线数据源。 表6 Offline 参数 参数类型 描述 user_url String 用户数据url。 item_url String 物品数据url。 behavior_url String 行为数据url。 表7 Nearline 参数 参数类型 描述 item_topic Topic object 物品topic。 user_topic Topic object 用户topic。 behavior_topic Topic object 行为topic。 表8 Topic 参数 参数类型 描述 name String 名称。 id String id。 表9 SpecsConfig 参数 参数类型 描述 offline String 离线计算规格。 nearline String 实时计算规格。 rank String 深度学习计算规格。 online_tps Integer 在线服务最大并发数。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型,取值为application/json。 X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 datasource_name 是 String 数据源名称,1-64位字母、数字、下划线、中划线组合。 最小长度:1 最大长度:64 specs_config 是 SpecsConfig object 计算规格配置。 data_config 是 DataConfig object 数据源配置。 表4 SpecsConfig 参数 是否必选 参数类型 描述 offline 是 String 离线计算规格。 nearline 否 String 实时计算规格。 rank 否 String 深度学习计算规格。 online_tps 否 Integer 在线服务最大并发数。 表5 DataConfig 参数 是否必选 参数类型 描述 offline 是 Offline object 离线计算规格。 nearline 否 Nearline object 近线数据源。 表6 Offline 参数 是否必选 参数类型 描述 user_url 是 String 用户数据url。 item_url 是 String 物品数据url。 behavior_url 是 String 行为数据url。 表7 Nearline 参数 是否必选 参数类型 描述 item_topic 否 Topic object 物品topic。 user_topic 否 Topic object 用户topic。 behavior_topic 否 Topic object 行为topic。 表8 Topic 参数 是否必选 参数类型 描述 name 否 String 名称。 id 否 String id。
  • 响应参数 状态码: 200 表9 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功。 datasource Datasource object 数据源信息。 message String 返回消息(请求成功时,不返回此字段)。 error_code String 错误码(请求成功时,不返回此字段)。 表10 Datasource 参数 参数类型 描述 datasource_name String 数据源名称。 workspace_id String 工作空间id。 datasource_id String 数据源id。 status String 状态。 created_at Long 创建时间。
  • 响应示例 状态码: 200 OK { "is_success" : true, "datasource" : { "datasource_name" : "test", "workspace_id" : "06a7c49afc00d4972ff1c0113d8c49ba", "datasource_id" : "51d48ed2da324cefa1c8336136b36557", "status" : "Draft", "created_at" : 1588850804912 }}
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型,取值为application/json 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 数据源名称:,1-64位字母、数字、下划线、中划线组合。 最小长度:1 最大长度:64 data_config 是 DataConfig object 数据配置。 specs_config 是 SpecsConfig object 计算规格配置。 表5 DataConfig 参数 是否必选 参数类型 描述 offline 是 Offline object 离线计算规格。 nearline 否 Nearline object 近线数据源。 表6 Offline 参数 是否必选 参数类型 描述 user_url 是 String 用户数据url。 item_url 是 String 物品数据url。 behavior_url 是 String 行为数据url。 表7 Nearline 参数 是否必选 参数类型 描述 item_topic 否 Topic object 物品topic。 user_topic 否 Topic object 用户topic。 behavior_topic 否 Topic object 行为topic。 表8 Topic 参数 是否必选 参数类型 描述 name 否 String 名称。 id 否 String id。 表9 SpecsConfig 参数 是否必选 参数类型 描述 offline 是 String 离线计算规格。 nearline 否 String 实时计算规格。 rank 否 String 深度学习计算规格。 online_tps 否 Integer 在线服务最大并发数。
  • URI PUT /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
  • 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。
  • 请求示例 确认数据源中的特征 /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 } ] }}
  • 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。
  • 请求参数 表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 GET /v2.0/{project_id}/workspaces/{workspace_id}/data-sources/{resource_id}/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目ID。 resource_id 是 String 资源id。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token。 type 是 String 任务类型: DATA_STRUCT,数据结构 DATA_INSPECTION,数据检测 DATA_EXPLORATION,数据探索
  • 响应示例 状态码: 200 OK { "is_success" : true, "data_sturct" : { "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 } ] } }}
  • URI DELETE /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/job-instance/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 作业id project_id 是 String 项目id,获取方式请参见获取项目ID resource_id 是 String 资源id(数据源id或场景id) workspace_id 是 String 工作空间id 表2 Query参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,获取方式请参见获取用户Token
  • 响应参数 状态码: 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,时间比例 RAM DOM,个数比例 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/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 属性值。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 datasource datasources object 数据源详情。 jobs Array of jobs objects 数据源相关任务详情。 is_success Boolean 是否成功。 message String 返回消息(请求成功时,不返回此字段)。 error_code String 错误码(请求成功时,不返回此字段)。 表4 datasources 参数 参数类型 描述 datasource_id String 数据源id。 datasource_name String 名称。 status String 状态。 structure String 结构。 workspace_id String 工作空间编号。 data_config DataConfig object 数据配置。 specs_config SpecsConfig object 计算规格配置。 created_at String 创建时间。 update_at Long 更新时间。 表5 DataConfig 参数 参数类型 描述 offline Offline object 离线计算规格。 nearline Nearline object 近线数据源。 表6 Offline 参数 参数类型 描述 user_url String 用户数据url。 item_url String 物品数据url。 behavior_url String 行为数据url。 表7 Nearline 参数 参数类型 描述 item_topic Topic object 物品topic。 user_topic Topic object 用户topic。 behavior_topic Topic object 行为topic。 表8 Topic 参数 参数类型 描述 name String 名称。 id String id。 表9 SpecsConfig 参数 参数类型 描述 offline String 离线计算规格。 nearline String 实时计算规格。 rank String 深度学习计算规格。 online_tps Integer 在线服务最大并发数。 表10 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 作业配置。 表11 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 在线流程(在线训练任务需要提供此参数)。 表12 NearLineRecallParam 参数 参数类型 描述 time_limit Boolean 时间过滤。 timeFeature String 时间特征。 retainDays Integer 保留期(天)。 recall_fileds Array of RecallFiled objects 召回字段。 itemCF_job_name String 物品协同过滤作业名称。 表13 RecallFiled 参数 参数类型 描述 name String 字段名称。 value Integer 使用字段值的个数。 最小值:1 最大值:10 缺省值:1 表14 MatchFeaturePair 参数 参数类型 描述 user_feature_name String 用户特征。 item_feature_name String 物品特征。 weight Double 权重。 match_count Boolean 匹配个数度量。 表15 Striping 参数 参数类型 描述 nearest_neighborhood Integer 最近领域个数。 band Integer 相似程度。 最小值:1 最大值:20 row Integer 相似距离。 最小值:1 最大值:10 表16 MatrixFactorization 参数 参数类型 描述 implicit_vector_rank Integer 隐向量维度。 最小值:1 最大值:100 regular_param Double 优化正则化系数。 最小值:1.0E-8 最大值:1 max_iterator_num Integer 迭代次数。 最小值:1 最大值:50 表17 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 表18 UcbParam 参数 参数类型 描述 alpha Double 折中参数。 最小值:0 最大值:1 min_used_num Integer 最小行为次数。 最小值:30 最大值:1000 表19 BehaviorGravity 参数 参数类型 描述 weaken_factor Double 衰减因子。 最小值:0.1 最大值:5 view_type String 行为次数统计方法: pv,访问量 uv,独立访客 algo_type String 算法类型: normal,通用 time,时间 表20 Category 参数 参数类型 描述 user_meta_list Array of strings 用户特征。 item_meta_list Array of strings 物品特征。 表21 EtlBasicParameter 参数 参数类型 描述 user_features Array of FeatureTransformation objects 用户特征。 item_features Array of FeatureTransformation objects 物品特征。 rank_etl_filter RankETLFilter object 过滤参数。 表22 FeatureTransformation 参数 参数类型 描述 attr Attribute object 特征。 discrete_method String 离散方法: equal_distance_discrete,等距离散 user_define_discrete,自定义离散 normalize,归一化 null,不离散 params Object 具体处理参数。 表23 Attribute 参数 参数类型 描述 name String 名称。 data_type String 数据类型。 other_uses Array of strings 其他用途。 表24 RankETLFilter 参数 参数类型 描述 filter_type String 行为去重方式: abs_weight,权重绝对值 date,日期 time_type String 时间类型: day,天 week,周 month,月 is_monday_first Boolean 周一是否是第一天。 表25 SampleParam 参数 参数类型 描述 divide_type String 训练集测试集划分方式: TIME,时间比例 RAMDOM,个数比例 train_rate Double 训练数据占比。 最小值:0.01 最大值:1 test_rate Double 测试数据占比。 最小值:0.01 最大值:1 表26 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 重新训练。 表27 Initial 参数 参数类型 描述 initial_method String 初始化方法。 mean_value Double 平均值。 最小值:-1 最大值:1 standard_deviation Double 标准差。 最小值:0 最大值:1 min_value Double 最小值。 最小值:-1 最大值:0 max_value Double 最大值。 最小值:0 最大值:1 表28 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 表29 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 表30 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需要提供此参数)。 表31 Indicator 参数 参数类型 描述 indicator_name String 指标名称: clickPVRate,点击PV率 clickUVRate,点击UV率 customize,自定义 indicator_params IndicatorParam object 指标参数(自定义指标需要提供)。 表32 IndicatorParam 参数 参数类型 描述 customize_parameter CustomizeParameter object 自定义参数。 customize_formula CustomizeFormula object 自定义公式。 表33 CustomizeParameter 参数 参数类型 描述 alias String 别名。 behavior_type String 行为类型。 threshold Double 阈值。 最小值:0 最大值:1 deduplication String 去重。 表34 CustomizeFormula 参数 参数类型 描述 alias String 别名。 formula String 公式。 表35 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 需要置顶的候选集列表。 表36 AttrPairRules 参数 参数类型 描述 attr_pairs Array of AttrPair objects 属性对。 表37 AttrPair 参数 参数类型 描述 party_a String 被推荐对象的属性名。 party_b String 被推荐对象的属性名。 表38 Deduplication 参数 参数类型 描述 attributes Array of strings 属性。 表39 AttributeInfo 参数 参数类型 描述 rank_feature_pairs Array of RankFeaturePair objects 属性匹配对。 numerical_attrs Array of NumericalAttr objects 属性权重。 num_statistics_type String 统计方式: ORDER,顺序 ABS,绝对值 表40 RankFeaturePair 参数 参数类型 描述 feature_name_a String 待推荐对象的属性。 feature_name_b String 被推荐对象的属性。 weight Float 权重。 最小值:0.01 最大值:1 表41 NumericalAttr 参数 参数类型 描述 name String 特征名。 weight Float 权重。 最小值:0.001 最大值:1 表42 BloomFilterConf 参数 参数类型 描述 behaviors Array of strings 待过滤行为类型。 interval Integer 过滤时间。 最小值:1 最大值:7 表43 Rule 参数 参数类型 描述 table_name String 候选集表名。 rule_ratio Integer 规则占比。 最小值:1 最大值:100 priority Integer 优先级。 最小值:1 最大值:10 表44 AttrValueRules 参数 参数类型 描述 attr_values_a Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b Array of AttrValue objects 待推荐对象的属性-值配置。 表45 AttrValue 参数 参数类型 描述 name String 属性名称。 value String 属性值。
  • URI GET /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。
  • 请求示例 同时新建作业多个 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instances[ { "job_name" : "WriteItemProfile-test", "description" : "item", "category" : "DATASOURCE", "job_type" : "WriteItemProfile", "job_config" : { }}, { "job_name" : "EncodeProfile-test", "description" : "universal", "category" : "SORTING", "job_type" : "EncodeProfile", "job_config" : { }} ]
  • 请求参数 表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位字母、数字、下划线、中划线组合 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-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目ID resource_id 是 String 资源id workspace_id 是 String 工作空间id
  • 响应示例 状态码: 200 OK { "job" : { "category" : "SERVICE", "job_name" : "online1", "job_id" : "testuuidxxxxxxxxxxxxxxxxxxxxxxxx", "description" : "inference service", "job_type" : "infer", "status" : "Draft", "platform" : "AIP", "workspace_id" : "testuuidxxxxxxxxxxxxxxxxxxxxxxxx", "resource_id" : "testuuidxxxxxxxxxxxxxxxxxxxxxxxx" }, "is_success" : true}
共100000条