621      英雄聯盟

API說明__產品簡介_推薦引擎-阿裏雲

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集成場景：

圖中用不同的顏色表示API的類型。

• 下方紫色的日誌API和紅色的數據修正API是實時API，前者用於實時日誌采集，後者用於實時修正數據。

• 中間一組藍色的API（離線數據上傳沒有API，需要客戶自己通過tunnel或DataX工具實現）實現數據上傳和離線計算，兩個計算跟蹤的API是可選的，如果不接入，通過設置告警也能獲得任務運行異常信息。

• 上方黑色的推薦API是使用頻率最高的，也是業務最關注的，用於獲取推薦結果。

事實上，推薦API和日誌API是可以直接從終端對接到RecEng的，但是這樣做的話對未來的擴展性不好；而且從圖中也能看到，推薦服務器的角色是必不可少的，數據上傳，離線計算，以及數據修正都需要在推薦服務器上發起，所以還是那句話，建議客戶把所有對RecEng的訪問都集中起來，部署在推薦服務器上。

最後更新：2016-11-23 16:04:08

  上一篇： 係統規格__產品簡介_推薦引擎-阿裏雲

  下一篇： 版本更新__產品簡介_推薦引擎-阿裏雲