全部产品

API说明

更新时间:2017-06-07 13:26:11   分享:   

RecEng提供7个API供客户用于对接,如下:

  1. 启动数据预处理任务API:启动离线任务之前需要执行数据预处理任务。数据预处理任务是针对业务的,数据上传完成后整个业务只需要执行一次预处理任务即可

  2. 启动离线任务API:客户把离线数据导入输入表完成后,通过本API启动离线计算。本API是针对场景的,且只能启动场景中已发布的推荐流程。本API执行成功时除了完成离线计算,还负责把离线计算结果导入在线存储

  3. 启动效果计算任务API:客户在完成行为数据上传后可以启动效果计算API。要注意的是行为数据必须要符合RecEng的埋点要求,即埋入Trace ID,否则的话计算是不会成功的

  4. 查询任务状态API:可查询最近一次启动的离线任务和效果计算任务的状态,共有正在运行,计算完成,运行失败三种状态。客户可以根据实际情况自行选择是否使用本API。

  5. 在线获取推荐结果API(推荐API):推荐API集成在终端产品或推荐服务器中,当用户浏览相应页面,如首页或详情页时,可通过推荐API向RecEng请求展示给用户的物品列表。推荐API是RecEng中最重要的API,通常需要用户ID,物品ID等参数,客户可以根据业务需求增加参数。如推荐O2O服务时,可以增加用户的位置坐标参数,方便进行位置过滤,优先推荐附近的商家或服务提供者。

  6. 在线数据更新API:当客户有新物品上架,或老物品下架,希望能够及时体现在推荐物品中,可以通过本API通知RecEng,实时生效。

  7. 系统日志采集API(日志API):日志API用于实时收集用户的行为日志,用于实时修正。建议每次调用日志API时处理多条日志,压缩后上传,提高性能,节省带宽。通常情况下建议在一次日志API调用中上传100-1000条打包压缩后的日志。日志API除了可以提交日志,客户也可以通过这个API向RecEng提交用户和物品数据,从而可以不再需要离线把数据导入MaxCompute(原ODPS)。

这些API需要客户集成,如前所述,RecEng建议客户端将这些API统一集成在RecEng Client中,通常部署在推荐服务器上。下图展示了一个典型的API集成场景:

apipic

图中用不同的颜色表示API的类型。

  • 下方紫色的日志API和红色的数据修正API是实时API,前者用于实时日志采集,后者用于实时修正数据。

  • 中间一组蓝色的API(离线数据上传没有API,需要客户自己通过tunnel或DataX工具实现)实现数据上传和离线计算,两个计算跟踪的API是可选的,如果不接入,通过设置告警也能获得任务运行异常信息。

  • 上方黑色的推荐API是使用频率最高的,也是业务最关注的,用于获取推荐结果。

事实上,推荐API和日志API是可以直接从终端对接到RecEng的,但是这样做的话对未来的扩展性不好;而且从图中也能看到,推荐服务器的角色是必不可少的,数据上传,离线计算,以及数据修正都需要在推荐服务器上发起,所以还是那句话,建议客户把所有对RecEng的访问都集中起来,部署在推荐服务器上。

本文导读目录
本文导读目录
以上内容是否对您有帮助?