文档

API概览

更新时间:
本产品(智能推荐/2020-11-26)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例

API标题API概述
CreateInstance创建一个预付费实例创建一个智能推荐实例。
ModifyInstance修改实例修改指定实例配置。
DescribeInstance查询实例信息通过指定的实例ID查看实例详情。
ListInstance查询实例列表查询一个或多个实例的详细信息。
RunInstance运行实例启动实例开始全量数据导入任务。
UpgradeInstance更新实例配额信息更新指定实例配额(Quota)信息。
ValidateInstance校验指定实例有效性校验指定实例信息的有效性。
DowngradeInstance降低指定实例配额 (Quota)信息降低指定实例配额 (Quota)信息。

外部数据源

API标题API概述
CreateExtraDataSource创建数据源创建一个数据源
DeleteExtraDataSource删除数据源删除数据源。
ListExtraDataSources获取数据源获取特征、样本数据源列表。

数据集

API标题API概述
DeleteDataSet删除指定实例的指定数据集版本删除指定实例的指定数据集版本。
AttachDataset开启数据训练指定实例的指定数据集版本提供在线服务。
DescribeDataSetMessageDescribeDataSetMessage获取指定实例的指定数据集版本数据错误详情。
ListDataSet获取数据集列表获取指定实例的数据集列表。

实验

API标题API概述
DeleteExperiment删除实验删除一个实验。
EnableExperiment启用实验启用实验功能。
UpdateExperimentBasicInfo更新实验基本信息更新实验基本信息。
UpdateExperimentConfig更新实验配置更新一个实验配置信息。
UpdateExperimentStatus更新实验状态更新实验状态。
DescribeBaseExperiment获取基础实验获取基础实验。
DescribeExperimentDescribeExperiment查看一个实验详情。
DescribeExperimentEnv获取实验环境查看实验场景信息。
DescribeExperimentEnvProgress获取实验环境进度查看实验场景开通状态。
ListExperimentsListExperiments列出实验清单,说明:只展示实验基本信息,不展示算法配置,暂不提供分页功能。
CloneExperiment克隆实验克隆实验。

流量调控

API标题API概述
ListFlowControlTaskReports流量调控任务曝光分析流量调控任务曝光分析。
ListFlowControlTaskInvalidItems查询失效物品清单查询当前流量调控任务中失效物品清单,返回物品ID(ItemId)与物品类型(ItemType)。
ListFlowControlTaskItems流量调控预览流量调控预览。
CreateFlowControlTask创建流量调控任务创建流控任务。
GetFlowControlTask获取流量调控任务详情获取流量调控任务详情。
DeleteFlowControlTask删除流量调控任务删除流量调控任务。
ListFlowControlTask获取流量调控任务列表,按照创建时间倒序返回查询流控任务列表。
ListFlowControlTaskItemReports流量调控曝光排名物品/失效物品查询流量调控曝光排名物品/失效物品查询。
ListFlowControlTaskReference流量调控参考数据。流量调控参考数据
ModifyFlowControlTask修改流量控制任务,目前只支持草稿态和发布失败状态的任务修改配置信息流调任务修改接口。
StopFlowControlTask结束流量调控任务结束流量调控任务。
PublishFlowControlTask发布流量调控任务发布流量调控任务。

召回表

API标题API概述
CreateFilteringAlgorithm创建召回表创建召回表,目前召回表由PAI训练完成导出到odps中,在AIRec中指定ODPS表信息。
DeleteFilteringAlgorithm删除召回表删除指定的召回配置及相关索引表信息。
ModifyFilteringAlgorithmMetaModifyFilteringAlgorithmMeta修改召回表的配置。
DescribeFilteringAlgorithm获取召回表根据指定召回表ID 获取某个召回配置信息。
ListFilteringAlgorithms获取召回表列表列表显示所有的召回表信息。
OfflineFilteringAlgorithm下线召回表下线召回表。

排序系统

API标题API概述
CreateRankingSystem创建排序服务创建排序服务。
DeleteRankingSystem删除排序服务删除排序服务。
ModifyRankingSystem修改排序服务修改排序服务。
GetRankingSystem获取排序服务详情获取排序服务详情。
GetRankingSystemHistory查询排序服务操作记录查询排序服务操作记录。
ListRankingSystems获取排序服务列表获取排序服务列表。
ListRankingSystemHistories查询服务操作记录列表查询服务操作记录列表。
DeployRankingSystem部署排序服务部署/重启部署排序服务,已经部署过的服务,修改配置后必须重启部署,注:若未修改任何参数,则可以不传body。
VerifyRankingSystem调试排序服务调试排序服务
RollbackRankingSystem回滚排序服务回滚排序服务

排序模型模版

API标题API概述
CreateRankingModelTemplate创建排序模型模板创建排序模型模板。
DeleteRankingModelTemplate删除模型删除模型。
ModifyRankingModelTemplate修改排序模型模板修改排序模型模板。
GetRankingModelTemplate查看排序模型配置详情查看排序模型配置详情。
RunRankingModelTemplate启动训练运行排序模型模板

排序模型

API标题API概述
CreateRankingModel创建排名模型创建模型。
DeleteRankingModel删除排名模型删除排序模型。
DeleteRankingModelVersion删除模型版本删除某个模型版本。
ModifyRankingModel修改排名模型修改模型信息。
ListRankingModels获取排名模型列表查询模型列表。
ListRankingModelTemplates查看排序模型模板列表查看排序模型模板列表,按创建时间倒序。
GetRankingModelVersion查看排序模型版本详情查看排序模型版本详情,包括评估结果和训练结果。
ListRankingModelVersions获取排序模型版本获取排序模型版本。
DecribeRankingModel获取排序模型获取排序模型。
CheckRankingModelReachable测试模型网络联通性测试模型网络联通性。

规则

API标题API概述
CreateRule创建规则创建推荐策略运营规则。
ModifyRuleModifyRule修改规则。
ListRules获取规则列表查询规则列表。
DescribeRule获取规则信息查询一个规则的详细信息。
PublishRule发布规则发布一个规则。

场景

API标题API概述
CreateScene创建场景校验创建场景的信息。
DeleteScene删除场景删除场景。
ModifyScene修改场景信息修改场景信息。
DescribeScene查询场景详情查询场景详情。
ListScenes查询场景列表查询场景列表。

样本

API标题API概述
CreateCustomSample创建自定义样本创建自定义样本。
CreateSampleFormatConfig创建样本格式化配置创建样本格式化配置。
DeleteSample删除样本删除样本。
ModifySample修改样本配置修改样本配置。
ListSamples获取样本列表获取样本列表。
GetSample获取样本详情获取样本详情。
CloneSample复制创建样本复制创建样本。
GenerateSample生成样本生成样本,只针对复制创建的样本。

其他

API标题API概述
CreateCustomAnalysisTask创建自定义分析任务创建自定义分析任务。
AttachIndexVersionAttachIndexVersion把指定版本的索引切换到线上。
ModifyDataSource修改指定实例的指定数据源信息修改指定表的数据源信息。
ModifyFeatureTable修改特征表修改特征表,只支表级别持特征列表的全量修改。
ModifyItems修改项目批量操作物品池。
ModifyOfflineStorages修改实例的离线存储配置修改实例的离线存储配置。(只支持三张表同时修改)。
StopDataSet停止数据集停止指定实例的指定数据集版本。
DescribeCustomAnalysisTask查询指定实例的仪表盘自定义分析任务结果。查询指定实例的仪表盘自定义分析任务结果。
DescribeDefaultAlgorithms获取默认算法信息获取默认算法信息。
DescribeLatestTask获取最新任务获取最近一次构建的任务。
DescribeQuota获取指定实例的配额信息通过指定的实例ID查看实例的配额信息。
DescribeRegions查询区域查询可以使用的阿里云区域。
DescribeSceneBucketDescribeSceneBucket查看场景下实验桶分布情况。
DescribeSceneThroughput获取场景流量获取场景流量。
DescribeSyncReportDetail获取实时数据小时级别报告细节信息获取实时数据小时级别报告细节信息。
DescribeSyncReportOutliers获取实时数据报告异常明细获取实时数据报告异常明细。
DescribeUserMetrics获取用户指标(转化率信息)获取用户指标(转化率信息)。
GetExtraDataSource查看其他数据源详情查看其他数据源详情。
ListDashboardDetailsListDashboardDetails通过指定条件查询指定实例的细分指标。
ListDashboardDetailsFlows通过指定条件查询实例的细分流量指标通过指定条件查询指定实例的细分流量指标。
ListDashboardMetricsListDashboardMetrics查询指定实例的整理仪表盘数据。
ListDashboardMetricsFlows查询指定实例的整理仪表盘流量数据查询指定实例的整理仪表盘流量数据。
ListFeatureTables获取特征表列表获取特征表列表。
ListIndexVersions获取索引版本列表根据指定的实例ID,召回表ID获取索引版本列表。目前仅支持显示10条数据(包含3条可以切换的),所以不用翻页,不用过滤。
ListInstanceTask查询指定实例的任务列表查询指定实例的任务列表。
ListItems获取列表项查询实例物品池。
ListLogs获取日志列表该接口用于获取指定实例的日志信息(近七日内)。
ListMixCategoriesListMixCategoriesListMixCategories
ListOfflineStorages查询离线存储查询离线存储
ListRuleConditions查询实例具体的选品规则查询实例具体的选品规则.。
ListRuleTasks查询规则的任务状态查询规则的任务状态。
ListSampleFormatConfigs获取样本格式化配置列表获取样本格式化配置列表。
ListSceneItems获取预览结果获取预览结果。
ListSceneParameters获取指定实例全量的渠道和场景信息列表获取指定实例全量的渠道和场景信息列表。
ListUmengAppkeys获取友盟 appkey 列表信息获取友盟appkey列表信息。
ListUserClusters获取用户集群列表列表显示当前的实例用户cluster。
QueryDataMessage查询用户数据表中的更新消息用户数据表中的更新消息查询。
QueryDataMessageStatistics查询用户数据表中的更新消息统计数据用户数据表中的更新消息统计数据查询。
QueryExceptionHistory异常数据历史分段查询异常数据历史分段查询。
QueryRawData用户数据表中的原始数据查询用户数据表中的原始数据查询。
QuerySingleAggregationReport单表聚合查询单表聚合查询(数据可能有修改)。
QuerySingleReportQuerySingleReport单表维度分析查询(类型可能会增加)。
QuerySyncReportAggregation查询整体数据概览查询整体数据概览。
ListDataSource获取指定实例的数据源列表获取指定实例的数据源列表信息。
InitComputingResource初始化计算资源初始化计算资源
PushDocument推送文档向指定实例指定表推送文档。
PushInterventionPushIntervention该接口用于向指定实例推送干预数据
RebuildIndex重建索引重建索引
Recommend智能推荐该接口用于获取指定实例的推荐结果。
RefreshFeatureTable刷新特征表刷新特征表,根据特征表源更新特征表,刷新策略为以用户源表为准。
RunSampleFormatConfig触发样本格式化触发样本格式化。
UnLockIndexVersion解锁索引版本解锁召回表的索引版本。
CreateDataDiagnoseTask创建数据诊断任务创建数据诊断任务。
CreateUmengToken创建友盟Token创建友盟Token
GetLatestDataDiagnoseTaskStatus获取最新诊断任务状态获取最新诊断任务状态。
ListDataDiagnoseReports获取数据诊断报告 获取数据诊断报告 (包括用户手动触发的诊断、每天产出的周期报告、数据启动时诊断的报告)。
ListDataDiagnoseSampleDetails获取数据诊断报告抽样明细获取数据诊断报告抽样明细。
  • 本页导读 (0)
文档反馈