更新时间:2022-04-25 GMT+08:00
分享

提交效果评估任务

功能介绍

该接口用于提交推荐效果评估任务。

URI

POST /v1/{project_id}/evaluate

参数说明请参见表1

表1 URI参数说明

名称

是否必选

类型

说明

project_id

String

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

请求消息

请求参数请参见表2

表2 请求参数说明

参数名称

是否必选

参数类型

说明

workspace_id

String

工作空间ID,默认为0

job_name

String

作业名称,只能由字母、数字、中划线和下划线组成,并且长度为1~20个字符。

job_description

String

作业描述,最大长度256字符。

online_services

List

需要进行效果评估的在线服务;

indicators

List

请参见表3,需要统计的指标列表及其对应的参数。

start_time

Long

被统计数据的起始时间戳。

end_time

Long

被统计数据的终止时间戳。

interval

Double

统计间隔,以天为单位,每隔interval天计算一次指标,大于0。

result_path

String

结果保存路径。

offline_platform

JSON

请参见表8,配置信息。

表3 indicators参数说明

参数名称

是否必选

参数类型

说明

indicator_name

String

指标名称,可选名称如下:

  • clickPV:点击PV
  • clickPVRate:推荐点击PV率
  • clickUV:点击UV
  • clickUVRate:推荐点击UV率
  • customize:自定义指标

indicator_params

-

JSON

请参见表4,指标参数,indicator_name为customize时必选。

表4 indicator_params 参数说明

参数名称

是否必选

参数类型

说明

customize_parameter

JSON

请参见表 表5

customize_formula

JSON

请参见表 表6

表5 customize_parameter参数说明

参数名称

是否必选

参数类型

说明

alias

String

参数别名,在自定义公式中进行调用,字母表示。

behavior_type

String

行为类型 。

  • view:物品曝光
  • click:用户点击物品
  • collect:用户收藏了某个物品
  • uncollect:用户取消收藏某个物品
  • search_click:用户点击搜索结果中的物品
  • comment:用户对物品的评论
  • share: 分享
  • like:点赞
  • dislike:点衰
  • grade:评分
  • consume:消费
  • use:观看视频/听音乐/阅读

threshold

String

行为阈值,阈值内的行为记录有效。

表6 culstomize_formula参数说明

参数名称

是否必选

参数类型

说明

alias

String

指标别名,字母、下划线、数字组成。

formula

String

用户指定自定义指标公式,由参数别名和计算符号组成。如:A/(A+B),参数A、B代表自定义参数的参数别名。计算符号只支持+、-、*、/。

表7 data_param参数说明

参数名称

是否必选

参数类型

说明

header

Boolean

是否显示表头。

delimiter

String

分割符,最大长度10。

quote

String

引用字符,最大长度10。

escape

String

转义字符,最大长度10。

表8 offline_platform参数说明

参数名称

是否必选

参数类型

说明

platform

String

平台名称,支持DLI。

platform_parameter

JSON

请参见表9,平台参数。

computing_resource

String

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

config_load_path

String

配置加载路径。

表9 platform_parameter 参数说明

参数名称

是否必选

参数类型

说明

cluster_name

String

集群名称,最大长度64。

cluster_id

String

集群ID。

响应消息

响应参数请参见表10

表10 响应参数说明

参数名称

参数类型

说明

is_success

Boolean

请求是否成功。

job_name

String

作业名称。

job_id

String

作业的ID。

create_time

Long

作业的创建时间。

error_code

String

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

error_msg

String

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

示例

  • 请求示例
    {
        "job_name": "Evaluate-job",
        "job_description": "",
        "data_source": {
            "table_type_id": "GENERAL_FORMAT",
            "data_format": "json",
            "data_source_url": "<数据源存储路径>"
        },
        "online_services": [
            "res-test1",
            "res-test2"
        ],
        "indicators": [
            {
                "indicator_name": "clickPVRate",
                "indicator_params": {}
            },
            {
                "indicator_name": "customize",
                "indicator_params": {
                    "customize_parameter": [
                        {
                            "alias": "A",
                            "behavior_type": "click",
                            "threshold": "1"
                        },
                        {
                            "alias": "B",
                            "behavior_type": "click",
                            "threshold": "0.6"
                        },
                        {
                            "alias": "C",
                            "behavior_type": "consume",
                            "threshold": "1"
                        }
                    ],
                    "customize_formula": [
                        {
                            "alias": "indicator1",
                            "formula": "A+B"
                        },
                        {
                            "alias": "indicator2",
                            "formula": "A+B-C"
                        }
                    ]
                }
            }
        ],
        "start_time": "1560960000",
        "end_time": "1561305600",
        "interval": 1,
        "result_path": "<输出数据的存储都路径>",
        "offline_platform": {
            "platform": "DLI",
            "platform_parameter": {
                "cluster_name": "test",
                "cluster_id": "7f1781ff-438a-40f7-b2b8-8f3f5e464104"
            },
            "config_load_path": "<配置源路径>",
            "computing_resource": ""
        }
    }
  • 成功响应示例
    {
        "is_success": true,
        "job_id": "6b9848b8f2ac4c479855734e354459c1",
        "job_name": "evaluation-job",
        "create_time": "1543978717768"
    }
  • 失败响应示例
    { 
        "is_success": false, 
        "error_code": "res.xxxx", 
        "error_msg": "Failed to submit job." 
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

close