本產(chǎn)品（
智能推薦/2020-11-26）的OpenAPI采用ROA簽名風(fēng)格，簽名細(xì)節(jié)參見簽名機(jī)制說(shuō)明。我們已經(jīng)為開發(fā)者封裝了常見編程語(yǔ)言的SDK，開發(fā)者可通過(guò)下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無(wú)需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過(guò)簽名機(jī)制進(jìn)行自簽名對(duì)接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個(gè)工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專家指導(dǎo)下進(jìn)行簽名對(duì)接。在使用API前，您需要準(zhǔn)備好身份賬號(hào)及訪問(wèn)密鑰（AccessKey），才能有效通過(guò)客戶端工具（SDK、CLI等）訪問(wèn)API。細(xì)節(jié)請(qǐng)參見獲取AccessKey。
實(shí)例
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateInstance | 創(chuàng)建一個(gè)預(yù)付費(fèi)實(shí)例 | 創(chuàng)建一個(gè)智能推薦實(shí)例。 |
| ModifyInstance | 修改實(shí)例 | 修改指定實(shí)例配置。 |
| DescribeInstance | 查詢實(shí)例信息 | 通過(guò)指定的實(shí)例ID查看實(shí)例詳情。 |
| ListInstance | 查詢實(shí)例列表 | 查詢一個(gè)或多個(gè)實(shí)例的詳細(xì)信息。 |
| RunInstance | 運(yùn)行實(shí)例 | 啟動(dòng)實(shí)例開始全量數(shù)據(jù)導(dǎo)入任務(wù)。 |
| UpgradeInstance | 更新實(shí)例配額信息 | 更新指定實(shí)例配額（Quota）信息。 |
| ValidateInstance | 校驗(yàn)指定實(shí)例有效性 | 校驗(yàn)指定實(shí)例信息的有效性。 |
| DowngradeInstance | 降低指定實(shí)例配額 (Quota)信息 | 降低指定實(shí)例配額 （Quota）信息。 |
外部數(shù)據(jù)源
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateExtraDataSource | 創(chuàng)建數(shù)據(jù)源 | 創(chuàng)建一個(gè)數(shù)據(jù)源。 |
| DeleteExtraDataSource | 刪除數(shù)據(jù)源 | 刪除數(shù)據(jù)源。 |
| ListExtraDataSources | 獲取數(shù)據(jù)源 | 獲取特征、樣本數(shù)據(jù)源列表。 |
數(shù)據(jù)集
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DeleteDataSet | 刪除指定實(shí)例的指定數(shù)據(jù)集版本 | 刪除指定實(shí)例的指定數(shù)據(jù)集版本。 |
| AttachDataset | 開啟數(shù)據(jù)訓(xùn)練 | 指定實(shí)例的指定數(shù)據(jù)集版本提供在線服務(wù)。 |
| DescribeDataSetMessage | DescribeDataSetMessage | 獲取指定實(shí)例的指定數(shù)據(jù)集版本數(shù)據(jù)錯(cuò)誤詳情。 |
| ListDataSet | 獲取數(shù)據(jù)集列表 | 獲取指定實(shí)例的數(shù)據(jù)集列表。 |
實(shí)驗(yàn)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DeleteExperiment | 刪除實(shí)驗(yàn) | 刪除一個(gè)實(shí)驗(yàn)。 |
| EnableExperiment | 啟用實(shí)驗(yàn) | 啟用實(shí)驗(yàn)功能。 |
| UpdateExperimentBasicInfo | 更新實(shí)驗(yàn)基本信息 | 更新實(shí)驗(yàn)基本信息。 |
| UpdateExperimentConfig | 更新實(shí)驗(yàn)配置 | 更新一個(gè)實(shí)驗(yàn)配置信息。 |
| UpdateExperimentStatus | 更新實(shí)驗(yàn)狀態(tài) | 更新實(shí)驗(yàn)狀態(tài)。 |
| DescribeBaseExperiment | 獲取基礎(chǔ)實(shí)驗(yàn) | 獲取基礎(chǔ)實(shí)驗(yàn)。 |
| DescribeExperiment | DescribeExperiment | 查看一個(gè)實(shí)驗(yàn)詳情。 |
| DescribeExperimentEnv | 獲取實(shí)驗(yàn)環(huán)境 | 查看實(shí)驗(yàn)場(chǎng)景信息。 |
| DescribeExperimentEnvProgress | 獲取實(shí)驗(yàn)環(huán)境進(jìn)度 | 查看實(shí)驗(yàn)場(chǎng)景開通狀態(tài)。 |
| ListExperiments | ListExperiments | 列出實(shí)驗(yàn)清單，說(shuō)明：只展示實(shí)驗(yàn)基本信息，不展示算法配置，暫不提供分頁(yè)功能。 |
| CloneExperiment | 克隆實(shí)驗(yàn) | 克隆實(shí)驗(yàn)。 |
流量調(diào)控
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListFlowControlTaskReports | 流量調(diào)控任務(wù)曝光分析 | 流量調(diào)控任務(wù)曝光分析。 |
| ListFlowControlTaskInvalidItems | 查詢失效物品清單 | 查詢當(dāng)前流量調(diào)控任務(wù)中失效物品清單，返回物品ID(ItemId)與物品類型(ItemType)。 |
| ListFlowControlTaskItems | 流量調(diào)控預(yù)覽 | 流量調(diào)控預(yù)覽。 |
| CreateFlowControlTask | 創(chuàng)建流量調(diào)控任務(wù) | 創(chuàng)建流控任務(wù)。 |
| GetFlowControlTask | 獲取流量調(diào)控任務(wù)詳情 | 獲取流量調(diào)控任務(wù)詳情。 |
| DeleteFlowControlTask | 刪除流量調(diào)控任務(wù) | 刪除流量調(diào)控任務(wù)。 |
| ListFlowControlTask | 獲取流量調(diào)控任務(wù)列表，按照創(chuàng)建時(shí)間倒序返回 | 查詢流控任務(wù)列表。 |
| ListFlowControlTaskItemReports | 流量調(diào)控曝光排名物品/失效物品查詢 | 流量調(diào)控曝光排名物品/失效物品查詢。 |
| ListFlowControlTaskReference | 流量調(diào)控參考數(shù)據(jù) | 流量調(diào)控參考數(shù)據(jù)。 |
| ModifyFlowControlTask | 修改流量控制任務(wù)，目前只支持草稿態(tài)和發(fā)布失敗狀態(tài)的任務(wù)修改配置信息 | 流調(diào)任務(wù)修改接口。 |
| StopFlowControlTask | 結(jié)束流量調(diào)控任務(wù) | 結(jié)束流量調(diào)控任務(wù)。 |
| PublishFlowControlTask | 發(fā)布流量調(diào)控任務(wù) | 發(fā)布流量調(diào)控任務(wù)。 |
召回表
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateFilteringAlgorithm | 創(chuàng)建召回表 | 創(chuàng)建召回表，目前召回表由PAI訓(xùn)練完成導(dǎo)出到odps中，在AIRec中指定ODPS表信息。 |
| DeleteFilteringAlgorithm | 刪除召回表 | 刪除指定的召回配置及相關(guān)索引表信息。 |
| ModifyFilteringAlgorithmMeta | ModifyFilteringAlgorithmMeta | 修改召回表的配置。 |
| DescribeFilteringAlgorithm | 獲取召回表 | 根據(jù)指定召回表ID 獲取某個(gè)召回配置信息。 |
| ListFilteringAlgorithms | 獲取召回表列表 | 列表顯示所有的召回表信息。 |
| OfflineFilteringAlgorithm | 下線召回表 | 下線召回表。 |
排序系統(tǒng)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateRankingSystem | 創(chuàng)建排序服務(wù) | 創(chuàng)建排序服務(wù)。 |
| DeleteRankingSystem | 刪除排序服務(wù) | 刪除排序服務(wù)。 |
| ModifyRankingSystem | 修改排序服務(wù) | 修改排序服務(wù)。 |
| GetRankingSystem | 獲取排序服務(wù)詳情 | 獲取排序服務(wù)詳情。 |
| GetRankingSystemHistory | 查詢排序服務(wù)操作記錄 | 查詢排序服務(wù)操作記錄。 |
| ListRankingSystems | 獲取排序服務(wù)列表 | 獲取排序服務(wù)列表。 |
| ListRankingSystemHistories | 查詢服務(wù)操作記錄列表 | 查詢服務(wù)操作記錄列表。 |
| DeployRankingSystem | 部署排序服務(wù) | 部署/重啟部署排序服務(wù)，已經(jīng)部署過(guò)的服務(wù)，修改配置后必須重啟部署，注：若未修改任何參數(shù)，則可以不傳body。 |
| VerifyRankingSystem | 調(diào)試排序服務(wù) | 調(diào)試排序服務(wù)。 |
| RollbackRankingSystem | 回滾排序服務(wù) | 回滾排序服務(wù)。 |
排序模型模版
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateRankingModelTemplate | 創(chuàng)建排序模型模板 | 創(chuàng)建排序模型模板。 |
| DeleteRankingModelTemplate | 刪除模型 | 刪除模型。 |
| ModifyRankingModelTemplate | 修改排序模型模板 | 修改排序模型模板。 |
| GetRankingModelTemplate | 查看排序模型配置詳情 | 查看排序模型配置詳情。 |
| RunRankingModelTemplate | 啟動(dòng)訓(xùn)練 | 運(yùn)行排序模型模板 |
排序模型
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateRankingModel | 創(chuàng)建排名模型 | 創(chuàng)建模型。 |
| DeleteRankingModel | 刪除排名模型 | 刪除排序模型。 |
| DeleteRankingModelVersion | 刪除模型版本 | 刪除某個(gè)模型版本。 |
| ModifyRankingModel | 修改排名模型 | 修改模型信息。 |
| ListRankingModels | 獲取排名模型列表 | 查詢模型列表。 |
| ListRankingModelTemplates | 查看排序模型模板列表 | 查看排序模型模板列表，按創(chuàng)建時(shí)間倒序。 |
| GetRankingModelVersion | 查看排序模型版本詳情 | 查看排序模型版本詳情，包括評(píng)估結(jié)果和訓(xùn)練結(jié)果。 |
| ListRankingModelVersions | 獲取排序模型版本 | 獲取排序模型版本。 |
| DecribeRankingModel | 獲取排序模型 | 獲取排序模型。 |
| CheckRankingModelReachable | 測(cè)試模型網(wǎng)絡(luò)聯(lián)通性 | 測(cè)試模型網(wǎng)絡(luò)聯(lián)通性。 |
規(guī)則
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateRule | 創(chuàng)建規(guī)則 | 創(chuàng)建推薦策略運(yùn)營(yíng)規(guī)則。 |
| ModifyRule | ModifyRule | 修改規(guī)則。 |
| ListRules | 獲取規(guī)則列表 | 查詢規(guī)則列表。 |
| DescribeRule | 獲取規(guī)則信息 | 查詢一個(gè)規(guī)則的詳細(xì)信息。 |
| PublishRule | 發(fā)布規(guī)則 | 發(fā)布一個(gè)規(guī)則。 |
場(chǎng)景
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateScene | 創(chuàng)建場(chǎng)景 | 校驗(yàn)創(chuàng)建場(chǎng)景的信息。 |
| DeleteScene | 刪除場(chǎng)景 | 刪除場(chǎng)景。 |
| ModifyScene | 修改場(chǎng)景信息 | 修改場(chǎng)景信息。 |
| DescribeScene | 查詢場(chǎng)景詳情 | 查詢場(chǎng)景詳情。 |
| ListScenes | 查詢場(chǎng)景列表 | 查詢場(chǎng)景列表。 |
樣本
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateCustomSample | 創(chuàng)建自定義樣本 | 創(chuàng)建自定義樣本。 |
| CreateSampleFormatConfig | 創(chuàng)建樣本格式化配置 | 創(chuàng)建樣本格式化配置。 |
| DeleteSample | 刪除樣本 | 刪除樣本。 |
| ModifySample | 修改樣本配置 | 修改樣本配置。 |
| ListSamples | 獲取樣本列表 | 獲取樣本列表。 |
| GetSample | 獲取樣本詳情 | 獲取樣本詳情。 |
| CloneSample | 復(fù)制創(chuàng)建樣本 | 復(fù)制創(chuàng)建樣本。 |
| GenerateSample | 生成樣本 | 生成樣本，只針對(duì)復(fù)制創(chuàng)建的樣本。 |
其他
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateCustomAnalysisTask | 創(chuàng)建自定義分析任務(wù) | 創(chuàng)建自定義分析任務(wù)。 |
| AttachIndexVersion | AttachIndexVersion | 把指定版本的索引切換到線上。 |
| ModifyDataSource | 修改指定實(shí)例的指定數(shù)據(jù)源信息 | 修改指定表的數(shù)據(jù)源信息。 |
| ModifyFeatureTable | 修改特征表 | 修改特征表，只支表級(jí)別持特征列表的全量修改。 |
| ModifyItems | 修改項(xiàng)目 | 批量操作物品池。 |
| ModifyOfflineStorages | 修改實(shí)例的離線存儲(chǔ)配置 | 修改實(shí)例的離線存儲(chǔ)配置。（只支持三張表同時(shí)修改）。 |
| StopDataSet | 停止數(shù)據(jù)集 | 停止指定實(shí)例的指定數(shù)據(jù)集版本。 |
| DescribeCustomAnalysisTask | 查詢指定實(shí)例的儀表盤自定義分析任務(wù)結(jié)果 | 查詢指定實(shí)例的儀表盤自定義分析任務(wù)結(jié)果。 |
| DescribeDefaultAlgorithms | 獲取默認(rèn)算法信息 | 獲取默認(rèn)算法信息。 |
| DescribeLatestTask | 獲取最新任務(wù) | 獲取最近一次構(gòu)建的任務(wù)。 |
| DescribeQuota | 獲取指定實(shí)例的配額信息 | 通過(guò)指定的實(shí)例ID查看實(shí)例的配額信息。 |
| DescribeRegions | 查詢區(qū)域 | 查詢可以使用的阿里云區(qū)域。 |
| DescribeSceneBucket | DescribeSceneBucket | 查看場(chǎng)景下實(shí)驗(yàn)桶分布情況。 |
| DescribeSceneThroughput | 獲取場(chǎng)景流量 | 獲取場(chǎng)景流量。 |
| DescribeSyncReportDetail | 獲取實(shí)時(shí)數(shù)據(jù)小時(shí)級(jí)別報(bào)告細(xì)節(jié)信息 | 獲取實(shí)時(shí)數(shù)據(jù)小時(shí)級(jí)別報(bào)告細(xì)節(jié)信息。 |
| DescribeSyncReportOutliers | 獲取實(shí)時(shí)數(shù)據(jù)報(bào)告異常明細(xì) | 獲取實(shí)時(shí)數(shù)據(jù)報(bào)告異常明細(xì)。 |
| DescribeUserMetrics | 獲取用戶指標(biāo)（轉(zhuǎn)化率信息） | 獲取用戶指標(biāo)（轉(zhuǎn)化率信息）。 |
| GetExtraDataSource | 查看其他數(shù)據(jù)源詳情 | 查看其他數(shù)據(jù)源詳情。 |
| ListDashboardDetails | ListDashboardDetails | 通過(guò)指定條件查詢指定實(shí)例的細(xì)分指標(biāo)。 |
| ListDashboardDetailsFlows | 通過(guò)指定條件查詢實(shí)例的細(xì)分流量指標(biāo) | 通過(guò)指定條件查詢指定實(shí)例的細(xì)分流量指標(biāo)。 |
| ListDashboardMetrics | ListDashboardMetrics | 查詢指定實(shí)例的整理儀表盤數(shù)據(jù)。 |
| ListDashboardMetricsFlows | 查詢指定實(shí)例的整理儀表盤流量數(shù)據(jù) | 查詢指定實(shí)例的整理儀表盤流量數(shù)據(jù)。 |
| ListFeatureTables | 獲取特征表列表 | 獲取特征表列表。 |
| ListIndexVersions | 獲取索引版本列表 | 根據(jù)指定的實(shí)例ID，召回表ID獲取索引版本列表。目前僅支持顯示10條數(shù)據(jù)（包含3條可以切換的），所以不用翻頁(yè)，不用過(guò)濾。 |
| ListInstanceTask | 查詢指定實(shí)例的任務(wù)列表 | 查詢指定實(shí)例的任務(wù)列表。 |
| ListItems | 獲取列表項(xiàng) | 查詢實(shí)例物品池。 |
| ListLogs | 獲取日志列表 | 該接口用于獲取指定實(shí)例的日志信息（近七日內(nèi)）。 |
| ListMixCategories | ListMixCategories | 查詢類目列表。 |
| ListOfflineStorages | 查詢離線存儲(chǔ) | 查詢離線存儲(chǔ)。 |
| ListRuleConditions | 查詢實(shí)例具體的選品規(guī)則 | 查詢實(shí)例具體的選品規(guī)則.。 |
| ListRuleTasks | 查詢規(guī)則的任務(wù)狀態(tài) | 查詢規(guī)則的任務(wù)狀態(tài)。 |
| ListSampleFormatConfigs | 獲取樣本格式化配置列表 | 獲取樣本格式化配置列表。 |
| ListSceneItems | 獲取預(yù)覽結(jié)果 | 獲取預(yù)覽結(jié)果。 |
| ListSceneParameters | 獲取指定實(shí)例全量的渠道和場(chǎng)景信息列表 | 獲取指定實(shí)例全量的渠道和場(chǎng)景信息列表。 |
| ListUmengAppkeys | 獲取友盟 appkey 列表信息 | 獲取友盟appkey列表信息。 |
| ListUserClusters | 獲取用戶集群列表 | 列表顯示當(dāng)前的實(shí)例用戶cluster。 |
| QueryDataMessage | 查詢用戶數(shù)據(jù)表中的更新消息 | 用戶數(shù)據(jù)表中的更新消息查詢。 |
| QueryDataMessageStatistics | 查詢用戶數(shù)據(jù)表中的更新消息統(tǒng)計(jì)數(shù)據(jù) | 用戶數(shù)據(jù)表中的更新消息統(tǒng)計(jì)數(shù)據(jù)查詢。 |
| QueryExceptionHistory | 異常數(shù)據(jù)歷史分段查詢 | 異常數(shù)據(jù)歷史分段查詢。 |
| QueryRawData | 用戶數(shù)據(jù)表中的原始數(shù)據(jù)查詢 | 用戶數(shù)據(jù)表中的原始數(shù)據(jù)查詢。 |
| QuerySingleAggregationReport | 單表聚合查詢 | 單表聚合查詢（數(shù)據(jù)可能有修改）。 |
| QuerySingleReport | QuerySingleReport | 單表維度分析查詢（類型可能會(huì)增加）。 |
| QuerySyncReportAggregation | 查詢整體數(shù)據(jù)概覽 | 查詢整體數(shù)據(jù)概覽。 |
| ListDataSource | 獲取指定實(shí)例的數(shù)據(jù)源列表 | 獲取指定實(shí)例的數(shù)據(jù)源列表信息。 |
| InitComputingResource | 初始化計(jì)算資源 | 初始化計(jì)算資源。 |
| PushDocument | 推送文檔 | 向指定實(shí)例指定表推送文檔。 |
| PushIntervention | PushIntervention | 該接口用于向指定實(shí)例推送干預(yù)數(shù)據(jù)。 |
| RebuildIndex | 重建索引 | 重建索引。 |
| Recommend | 智能推薦 | 該接口用于獲取指定實(shí)例的推薦結(jié)果。 |
| RefreshFeatureTable | 刷新特征表 | 刷新特征表，根據(jù)特征表源更新特征表，刷新策略為以用戶源表為準(zhǔn)。 |
| RunSampleFormatConfig | 觸發(fā)樣本格式化 | 觸發(fā)樣本格式化。 |
| UnLockIndexVersion | 解鎖索引版本 | 解鎖召回表的索引版本。 |
| CreateDataDiagnoseTask | 創(chuàng)建數(shù)據(jù)診斷任務(wù) | 創(chuàng)建數(shù)據(jù)診斷任務(wù)。 |
| CreateUmengToken | 創(chuàng)建友盟Token | 創(chuàng)建友盟Token。 |
| GetLatestDataDiagnoseTaskStatus | 獲取最新診斷任務(wù)狀態(tài) | 獲取最新診斷任務(wù)狀態(tài)。 |
| ListDataDiagnoseReports | 獲取數(shù)據(jù)診斷報(bào)告 | 獲取數(shù)據(jù)診斷報(bào)告 （包括用戶手動(dòng)觸發(fā)的診斷、每天產(chǎn)出的周期報(bào)告、數(shù)據(jù)啟動(dòng)時(shí)診斷的報(bào)告）。 |
| ListDataDiagnoseSampleDetails | 獲取數(shù)據(jù)診斷報(bào)告抽樣明細(xì) | 獲取數(shù)據(jù)診斷報(bào)告抽樣明細(xì)。 |