'1.0',
'info' => [
'style' => 'ROA',
'product' => 'Airec',
'version' => '2020-11-26',
],
'directories' => [
[
'id' => 156261,
'title' => '实例',
'type' => 'directory',
'children' => [
'CreateInstance',
'ModifyInstance',
'DescribeInstance',
'ListInstance',
'RunInstance',
'UpgradeInstance',
'ValidateInstance',
'DowngradeInstance',
],
],
[
'id' => 156270,
'title' => '外部数据源',
'type' => 'directory',
'children' => [
'CreateExtraDataSource',
'DeleteExtraDataSource',
'ListExtraDataSources',
],
],
[
'id' => 156273,
'title' => '数据集',
'type' => 'directory',
'children' => [
'DeleteDataSet',
'AttachDataset',
'DescribeDataSetMessage',
'ListDataSet',
],
],
[
'id' => 156276,
'title' => '实验',
'type' => 'directory',
'children' => [
'DeleteExperiment',
'EnableExperiment',
'UpdateExperimentBasicInfo',
'UpdateExperimentConfig',
'UpdateExperimentStatus',
'DescribeBaseExperiment',
'DescribeExperiment',
'DescribeExperimentEnv',
'DescribeExperimentEnvProgress',
'ListExperiments',
'CloneExperiment',
],
],
[
'id' => 174242,
'title' => '流量调控',
'type' => 'directory',
'children' => [
'ListFlowControlTaskReports',
'ListFlowControlTaskInvalidItems',
'ListFlowControlTaskItems',
'CreateFlowControlTask',
'GetFlowControlTask',
'DeleteFlowControlTask',
'ListFlowControlTask',
'ListFlowControlTaskItemReports',
'ListFlowControlTaskReference',
'ModifyFlowControlTask',
'StopFlowControlTask',
'PublishFlowControlTask',
],
],
[
'id' => 156282,
'title' => '召回表',
'type' => 'directory',
'children' => [
'CreateFilteringAlgorithm',
'DeleteFilteringAlgorithm',
'ModifyFilteringAlgorithmMeta',
'DescribeFilteringAlgorithm',
'ListFilteringAlgorithms',
'OfflineFilteringAlgorithm',
],
],
[
'id' => 156289,
'title' => '排序系统',
'type' => 'directory',
'children' => [
'CreateRankingSystem',
'DeleteRankingSystem',
'ModifyRankingSystem',
'GetRankingSystem',
'GetRankingSystemHistory',
'ListRankingSystems',
'ListRankingSystemHistories',
'DeployRankingSystem',
'VerifyRankingSystem',
'RollbackRankingSystem',
],
],
[
'id' => 156299,
'title' => '排序模型模版',
'type' => 'directory',
'children' => [
'CreateRankingModelTemplate',
'DeleteRankingModelTemplate',
'ModifyRankingModelTemplate',
'GetRankingModelTemplate',
'RunRankingModelTemplate',
],
],
[
'id' => 156305,
'title' => '排序模型',
'type' => 'directory',
'children' => [
'CreateRankingModel',
'DeleteRankingModel',
'DeleteRankingModelVersion',
'ModifyRankingModel',
'ListRankingModels',
'ListRankingModelTemplates',
'GetRankingModelVersion',
'ListRankingModelVersions',
'DecribeRankingModel',
'CheckRankingModelReachable',
],
],
[
'id' => 156255,
'title' => '规则',
'type' => 'directory',
'children' => [
'CreateRule',
'ModifyRule',
'ListRules',
'DescribeRule',
'PublishRule',
],
],
[
'id' => 156258,
'title' => '场景',
'type' => 'directory',
'children' => [
'CreateScene',
'DeleteScene',
'ModifyScene',
'DescribeScene',
'ListScenes',
],
],
[
'id' => 156320,
'title' => '样本',
'type' => 'directory',
'children' => [
'CreateCustomSample',
'CreateSampleFormatConfig',
'DeleteSample',
'ModifySample',
'ListSamples',
'GetSample',
'CloneSample',
'GenerateSample',
],
],
[
'id' => 156251,
'title' => '其他',
'type' => 'directory',
'children' => [
'CreateCustomAnalysisTask',
'AttachIndexVersion',
'ModifyDataSource',
'ModifyFeatureTable',
'ModifyItems',
'ModifyOfflineStorages',
'StopDataSet',
'DescribeCustomAnalysisTask',
'DescribeDefaultAlgorithms',
'DescribeLatestTask',
'DescribeQuota',
'DescribeRegions',
'DescribeSceneBucket',
'DescribeSceneThroughput',
'DescribeSyncReportDetail',
'DescribeSyncReportOutliers',
'DescribeUserMetrics',
'GetExtraDataSource',
'ListDashboardDetails',
'ListDashboardDetailsFlows',
'ListDashboardMetrics',
'ListDashboardMetricsFlows',
'ListFeatureTables',
'ListIndexVersions',
'ListInstanceTask',
'ListItems',
'ListLogs',
'ListMixCategories',
'ListOfflineStorages',
'ListRuleConditions',
'ListRuleTasks',
'ListSampleFormatConfigs',
'ListSceneItems',
'ListSceneParameters',
'ListUmengAppkeys',
'ListUserClusters',
'QueryDataMessage',
'QueryDataMessageStatistics',
'QueryExceptionHistory',
'QueryRawData',
'QuerySingleAggregationReport',
'QuerySingleReport',
'QuerySyncReportAggregation',
'ListDataSource',
'InitComputingResource',
'PushDocument',
'PushIntervention',
'RebuildIndex',
'Recommend',
'RefreshFeatureTable',
'RunSampleFormatConfig',
'UnLockIndexVersion',
'CreateDataDiagnoseTask',
'CreateUmengToken',
'GetLatestDataDiagnoseTaskStatus',
'ListDataDiagnoseReports',
'ListDataDiagnoseSampleDetails',
],
],
],
'components' => [
'schemas' => [
'ExtraDataSource' => [
'title' => '扩展数据源',
'description' => '扩展数据源',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '状态',
'description' => '状态',
'type' => 'string',
'example' => 'Ready 待应用;Online 已应用;Failed失败',
],
'Meta' => [
'title' => '数据源配置参数',
'description' => '数据源配置参数',
'type' => 'object',
'properties' => [
'Internal' => [
'title' => '是否为内置数据源',
'description' => '是否为内置数据源',
'type' => 'boolean',
'example' => 'true',
],
'MetaType' => [
'title' => '配置类型',
'description' => '配置类型',
'type' => 'string',
'required' => false,
'example' => 'ExtraDataSource',
],
'ProjectName' => [
'title' => 'ODPS project name。',
'description' => 'ODPS 项目名称',
'type' => 'string',
'example' => 'test_project',
],
'TableName' => [
'title' => 'ODPS table name。',
'description' => 'ODPS 表名称',
'type' => 'string',
'example' => 'test_table',
],
'Type' => [
'title' => '数据源类型,当前只支持ODPS。',
'description' => '数据源类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'ODPS',
],
'UpdateFrequency' => [
'title' => '更新频率',
'description' => '更新频率',
'type' => 'integer',
'format' => 'int64',
'example' => '86400',
],
],
],
'Type' => [
'title' => '数据源类型',
'description' => '数据源类型',
'type' => 'string',
'example' => 'UserCustomDataSource\\ItemCustomDataSource\\'."\n"
.'BehaviorCustomDataSource\\'."\n"
.'SampleCustomDataSource',
],
'GmtCreate' => [
'title' => '创建数据源的UTC时间。',
'description' => '创建数据源的UTC时间。',
'type' => 'string',
'example' => '2021-12-07T13:26:29.000Z',
],
'GmtModified' => [
'title' => '最后修改数据源的UTC时间。',
'description' => '最后修改数据源的UTC时间。',
'type' => 'string',
'example' => '2021-12-07T13:26:29.000Z',
],
'DataSourceId' => [
'title' => '数据源id',
'description' => '数据源id',
'type' => 'string',
'example' => 'E01D574F-ABD0-4C55-A5E3-8D24FD8D42EA',
],
],
],
'FeatureTable' => [
'title' => '特征表',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '状态',
'type' => 'string',
],
'Meta' => [
'title' => '配置信息',
'type' => 'object',
'properties' => [
'DataSourceId' => [
'title' => '数据源id',
'type' => 'string',
'example' => '907648f5-abae-44fd-a4c4-525cc25947e9',
],
'FeatureList' => [
'title' => '特征列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Comment' => [
'title' => '备注',
'type' => 'string',
'example' => 'com11',
],
'FeatureName' => [
'title' => '特征名称',
'type' => 'string',
'example' => 'fn11',
],
'FieldName' => [
'title' => '字段名称',
'type' => 'string',
'example' => 'fieldName11',
],
'Status' => [
'title' => '特征状态',
'type' => 'string',
'example' => 'NotApplied 未应用 Applied 已应用',
],
],
],
],
'Internal' => [
'title' => '是否为内置特征表',
'type' => 'boolean',
'example' => 'true',
],
'MetaType' => [
'title' => '配置类型',
'type' => 'string',
'example' => 'FeatureTable',
],
'Source' => [
'title' => '数据源来源',
'type' => 'string',
'example' => 'test_project.test_table',
],
'UpdateFrequency' => [
'title' => '更新频率',
'type' => 'integer',
'format' => 'int64',
'example' => '86400',
],
],
],
'FeatureTableId' => [
'title' => '特征表id',
'type' => 'string',
'example' => '30E70118-FC7C-4438-9287-583CE47266A9',
],
'Type' => [
'title' => '特征表类型',
'type' => 'string',
'example' => 'ItemFeatureTable 物品特征表 UserFeatureTable 用户特征表',
],
'GmtCreate' => [
'title' => '创建时间',
'type' => 'string',
'example' => '2021-12-10T02:59:54.000Z',
],
'GmtModified' => [
'title' => '修改时间',
'type' => 'string',
'example' => '2021-12-10T02:59:54.000Z',
],
],
],
'RankingModelTemplate' => [
'title' => '模型模板信息',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '状态',
'type' => 'string',
'example' => 'TRAINING_SUCCESS',
],
'Meta' => [
'title' => '配置信息',
'type' => 'object',
'properties' => [
'Authorized' => [
'title' => '是否授权',
'type' => 'boolean',
'example' => 'true',
],
'AutoRun' => [
'title' => '是否自动训练',
'type' => 'boolean',
'example' => 'true',
],
'AutoRunTime' => [
'title' => '自动训练频率',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'AutoRunType' => [
'title' => '自动训练时间类型',
'type' => 'string',
'example' => 'DAY',
],
'Conf' => [
'title' => '参数配置内容',
'type' => 'string',
'example' => 'train_config {}',
],
'LastEditTime' => [
'title' => '最后编辑时间',
'type' => 'string',
'example' => '2021-12-06T03:01:41.217Z',
],
'OssArn' => [
'title' => 'OSS arn',
'type' => 'string',
'example' => 'acs:ram::111:role/aliyunodpspaidefaultrole',
],
'OssBucket' => [
'title' => 'OSS bucket名称',
'type' => 'string',
'example' => 'bucket-a',
],
'OssEndpoint' => [
'title' => 'OSS endpoint',
'type' => 'string',
'example' => 'oss-cn-beijing.aliyuncs.com',
],
'SampleId' => [
'title' => '格式化样本ID',
'type' => 'string',
'example' => '1111',
],
'SampleName' => [
'title' => '样本名称',
'type' => 'string',
'example' => '样本1',
],
'SampleTimeWindow' => [
'title' => '采样时间窗大小',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'SampleTimeWindowType' => [
'title' => '采样时间窗类型',
'type' => 'string',
'example' => 'DAY',
],
'Type' => [
'title' => '排序模型类型',
'type' => 'string',
'example' => 'MULTI_TOWER',
],
'Name' => [
'title' => '模型模板名称',
'type' => 'string',
'example' => '模型A',
],
'DeployStatus' => [
'title' => '部署状态',
'type' => 'string',
'example' => 'NOT_DEPLOYED',
],
'CanDeploy' => [
'title' => '是否可部署',
'type' => 'boolean',
'example' => 'true',
],
],
],
'VersionNum' => [
'title' => '版本数',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'TemplateId' => [
'title' => '模型模板ID',
'type' => 'string',
'example' => 'a-a-a',
],
],
],
'RankingModelVersion' => [
'title' => '模型版本信息',
'description' => '模型版本信息',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '训练状态',
'description' => '训练状态',
'type' => 'string',
'example' => 'TRAINING',
],
'RunTime' => [
'title' => '启动训练时间',
'description' => '启动训练时间',
'type' => 'string',
'example' => '2021-12-08T20:00:00.0Z',
],
'RunLog' => [
'title' => '运行日志',
'description' => '运行日志',
'type' => 'string',
],
'TemplateName' => [
'title' => '模型模板名称',
'description' => '模型模板名称',
'type' => 'string',
'example' => '模型A',
],
'RunResult' => [
'title' => '运行结果',
'description' => '运行结果',
'type' => 'object',
'properties' => [
'AssessAuc' => [
'title' => '评估AUC',
'description' => '评估AUC',
'type' => 'string',
'example' => '0.3',
],
'AssessGauc' => [
'title' => '评估Loss',
'description' => '评估Loss',
'type' => 'string',
'example' => '0.3',
],
'AssessLoss' => [
'title' => '评估GAUC',
'description' => '评估GAUC',
'type' => 'string',
'example' => '0.3',
],
'TrainAuc' => [
'title' => '训练AUC',
'description' => '训练AUC',
'type' => 'string',
'example' => '0.3',
],
'TrainGauc' => [
'title' => '训练GAUC',
'description' => '训练GAUC',
'type' => 'string',
'example' => '0.3',
],
'TrainLoss' => [
'title' => '训练Loss',
'description' => '训练Loss',
'type' => 'string',
'example' => '0.3',
],
],
],
'Name' => [
'title' => '版本名称',
'description' => '版本名称',
'type' => 'string',
'example' => '模型A_t1638964800000',
],
'TemplateId' => [
'title' => '模型模板ID',
'description' => '模型模板ID',
'type' => 'string',
'example' => 'a-a-a',
],
],
],
'RankingSystem' => [
'title' => '排序服务',
'description' => '排序服务',
'type' => 'object',
'properties' => [
'Meta' => [
'title' => '元信息',
'description' => '元信息',
'type' => 'object',
'properties' => [
'AutoDeploy' => [
'title' => '是否自动部署',
'description' => '是否自动部署',
'type' => 'boolean',
'example' => 'true',
],
'AutoDeployAuc' => [
'title' => '自动部署设定的AUC阈值',
'description' => '自动部署设定的AUC阈值',
'type' => 'string',
'example' => '0.3',
],
'Conf' => [
'title' => '配置文件',
'description' => '配置文件',
'type' => 'string',
],
'PredictEngine' => [
'title' => '预测引擎配置',
'description' => '预测引擎配置',
'type' => 'object',
'properties' => [
'ResourceId' => [
'title' => '预测引擎资源id',
'description' => '预测引擎资源id',
'type' => 'string',
'example' => 'eas-oljkkdrggxhx7eizjd',
],
'Version' => [
'title' => '预测引擎版本',
'description' => '预测引擎版本',
'type' => 'string',
'example' => '1',
],
'ClusterId' => [
'title' => '预测引擎集群id',
'description' => '预测引擎集群id',
'type' => 'string',
'example' => 'cn-shanghai',
],
],
],
'PredictEngineType' => [
'title' => '预测引擎类型',
'description' => '预测引擎类型',
'type' => 'string',
'example' => 'EAS',
],
'ModelVersionName' => [
'title' => '模型版本名称',
'description' => '模型版本名称',
'type' => 'string',
'example' => '模型A_T1638964800000',
],
'FailMsg' => [
'title' => '部署失败原因',
'description' => '部署失败原因',
'type' => 'string',
],
],
],
'ApplyStatus' => [
'title' => '应用状态',
'description' => '应用状态',
'type' => 'string',
'example' => 'NOT_APPLIED',
],
'DeployStatus' => [
'title' => '部署状态',
'description' => '部署状态',
'type' => 'string',
'example' => 'NOT_DEPLOYED',
],
'SceneIdList' => [
'title' => '应用场景列表',
'description' => '应用场景列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
'example' => '[1, 2, 3]',
],
],
'Name' => [
'title' => '服务命名',
'description' => '服务命名',
'type' => 'string',
'example' => 'servicea',
],
'ModelTemplateId' => [
'title' => '模型模板ID',
'description' => '模型模板ID',
'type' => 'string',
'example' => 'a-a-a',
],
],
],
'RankingSystemHistory' => [
'title' => '排序服务操作记录',
'description' => '排序服务操作记录',
'type' => 'object',
'properties' => [
'Meta' => [
'title' => '元信息',
'description' => '元信息',
'type' => 'object',
'properties' => [
'AutoDeploy' => [
'title' => '是否自动部署',
'description' => '是否自动部署',
'type' => 'boolean',
'example' => 'true',
],
'AutoDeployAuc' => [
'title' => '自动部署的AUC阈值',
'description' => '自动部署的AUC阈值',
'type' => 'string',
'example' => '0.3',
],
'Conf' => [
'title' => '配置文件',
'description' => '配置文件',
'type' => 'string',
],
'ModelTemplateName' => [
'title' => '模型模板名称',
'description' => '模型模板名称',
'type' => 'string',
'example' => '排序模型A',
],
'PredictEngine' => [
'title' => '预测引擎信息',
'description' => '预测引擎信息',
'type' => 'object',
'properties' => [
'ResourceId' => [
'title' => '预测引擎资源id',
'description' => '预测引擎资源id',
'type' => 'string',
'example' => 'eas-oljkkdrggxhx7eizjd',
],
'Version' => [
'title' => '预测引擎版本',
'description' => '预测引擎版本',
'type' => 'string',
'example' => '1',
],
],
],
'PredictEngineType' => [
'title' => '预测引擎类型',
'description' => '预测引擎类型',
'type' => 'string',
'example' => 'EAS',
],
'PreviousOperateId' => [
'title' => '上一次操作记录ID',
'description' => '上一次操作记录ID',
'type' => 'string',
'example' => 'aaaa',
],
],
],
'OperateTime' => [
'title' => '操作时间',
'description' => '操作时间',
'type' => 'string',
'example' => '2021-12-06T03:01:41.217Z',
],
'OperateId' => [
'title' => '操作id',
'description' => '操作id',
'type' => 'string',
'example' => '8AC865AF-37D6-42ED-AA9A-B60D8ECDF640',
],
'OperateType' => [
'title' => '操作类型',
'description' => '操作类型',
'type' => 'string',
'example' => 'CONF_CHANGE',
],
'Name' => [
'title' => '服务名称',
'description' => '服务名称',
'type' => 'string',
'example' => 'servicea',
],
],
],
'Sample' => [
'title' => '样本',
'description' => '样本实体。',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '状态',
'description' => '样本状态枚举值。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Unready**:未完成配置。'."\n"
."\n"
.'- **Ready**:配置完成。'."\n"
."\n"
.'- **Generating**:样本生成中。'."\n"
."\n"
.'- **Success**:样本生成成功。'."\n"
."\n"
.'- **Failed**:样本生成失败。'."\n"
."\n"
.'- **Formatting**:格式化中。'."\n"
."\n"
.'- **Formatted**:格式化完成。'."\n"
."\n"
.'- **FormatFailed**:格式化失败。'."\n"
."\n"
.'- **Applied**:已应用到模型中。',
'type' => 'string',
'example' => 'Formatted',
],
'Meta' => [
'title' => '配置',
'description' => '配置。',
'type' => 'object',
'properties' => [
'AutoUpdate' => [
'title' => '是否自动更新',
'description' => '是否自动更新样本配置。',
'type' => 'boolean',
'example' => 'true',
],
'AutoUpdateFrequency' => [
'title' => '更新频率,秒级别时间戳',
'description' => '更新频率,秒级别时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1673341140',
],
'ClonedId' => [
'title' => '克隆的id',
'description' => '克隆的ID。',
'type' => 'string',
'example' => '1638877561147',
],
'Config' => [
'title' => '样本配置详情',
'description' => '样本配置详情。',
'type' => 'object',
'properties' => [
'BhvTableSourceIds' => [
'title' => '行为数据源列表',
'description' => '行为数据源列表。',
'type' => 'array',
'items' => [
'description' => '行为数据源。',
'type' => 'string',
],
],
'FeatureConfig' => [
'title' => '特征',
'description' => '特征配置。',
'type' => 'object',
'properties' => [
'ItemFeatures' => [
'title' => '物品特征,支持多值,逗号分隔。',
'description' => '物品特征,支持多值,逗号分隔。',
'type' => 'string',
'example' => 'deress,red',
],
'UserFeatures' => [
'title' => '用户特征,支持多值,逗号分隔。',
'description' => '用户特征,支持多值,逗号分隔。',
'type' => 'string',
'example' => 'man',
],
],
],
'LabelLogic' => [
'title' => '打标逻辑',
'description' => '样品打标逻辑。',
'type' => 'object',
'properties' => [
'BhvTimeWindow' => [
'title' => '时间窗口,秒级别时间戳。',
'description' => '时间窗口,秒级别时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '86400',
],
'NegativeBhvTypes' => [
'title' => '负行为,支持多值,逗号分隔。',
'description' => '负行为,支持多值,逗号分隔。',
'type' => 'string',
'example' => 'click,expose',
],
'PositiveBhvTypes' => [
'title' => '是 正行为,支持多值,逗号分隔。',
'description' => '是 正行为,支持多值,逗号分隔。',
'type' => 'string',
'example' => 'like',
],
],
],
'WeightLogicList' => [
'title' => '权重逻辑',
'description' => '权重逻辑配置。',
'type' => 'array',
'items' => [
'description' => '权重。',
'type' => 'object',
'properties' => [
'Bhv' => [
'title' => '行为类型',
'description' => '行为类型。',
'type' => 'string',
'example' => 'click',
],
'Weight' => [
'title' => '权重',
'description' => '权重(1-100)。',
'type' => 'string',
'example' => '1',
],
],
],
],
],
],
'ExtendParams' => [
'title' => '扩展参数',
'description' => '扩展参数。',
'type' => 'object',
'properties' => [
'LatestTaskStatus' => [
'title' => '任务状态',
'description' => '任务状态枚举值。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **0**:没有任务。'."\n"
."\n"
.'- **1**:正常。'."\n"
."\n"
.'- **2**:异常。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SampleCount' => [
'title' => '样本数量',
'description' => '样本数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'MetaType' => [
'title' => '修改元信息类型',
'description' => '修改元信息类型。',
'type' => 'string',
'example' => 'Sample',
],
'Name' => [
'title' => '样本名称',
'description' => '样本名称。',
'type' => 'string',
'example' => '12345',
],
'StoreConfig' => [
'title' => '存储位置',
'description' => '存储位置。',
'type' => 'string',
'example' => 'projectName.tableName',
],
'Type' => [
'title' => '样本类型',
'description' => '样本类型枚举值。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Cloned**:复制的。'."\n"
."\n"
.'- **System**:系统的。'."\n"
."\n"
.'- **Custom**:自定义的。',
'type' => 'string',
'example' => 'System',
],
],
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间,单位为UTC时间。',
'type' => 'string',
'example' => '2021-12-07T12:28:52.000Z',
],
'GmtModified' => [
'title' => '修改时间',
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2021-12-07T12:28:52.000Z',
],
'SampleId' => [
'title' => '样本id',
'description' => '样本ID。',
'type' => 'string',
'example' => '1638880131873',
],
],
],
],
],
'apis' => [
'CreateInstance' => [
'path' => '/v2/openapi/instances',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '18666',
'abilityTreeNodes' => [
'FEATUREairec5G3YBA',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'instanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'airec-cn-****',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"instanceId\\": \\"airec-cn-****\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"8F81A922-6C81-46D6-B78C-CC35E16B1691\\n\\n airec-cn-xxxxx\\n","errorExample":""}]',
'title' => '创建一个预付费实例',
'summary' => '创建一个智能推荐实例。',
'requestParamsDescription' => '| 参数 | 类型 | 是否必需 | 描述 |'."\n"
.'| :--- | :--- | :--- | :--- |'."\n"
.'| type | String |是| 指定实例的类型,分为算法配置版( Algorithm Configuration Edition )和行业运营版(Industry Operation Edition)。|'."\n"
.'| chargeType | String |是|实例的付费方式。取值范围: PREPAY:预付费,包年包月。选择该类付费方式时,您必须确认自己的账号支持余额支付/信用支付,否则将返回 InvalidPayMethod 的错误提示,并且需要指定paymentInfo参数。POSTPAY:按量付费(当前暂不支持)。|'."\n"
.'| quota| Map| 是|您要申请的配额信息|'."\n"
.'| userCountPerUnit|Integer|是|您要申请的用户表文档数的配额信息,限制请看系统限制。|'."\n"
.'| itemCountPerUnit|Integer|是|您要申请的物品表文档数的配额信息,限制请看系统限制。|'."\n"
.'| qps|Integer|是|您要申请的推荐请求的QPS配额信息,限制请看系统限制。|'."\n"
.'| paymentInfo|Map|否|付费信息。|'."\n"
.'| duration|Integer|否|付费周期,包含1,2,3,4,5,6,7,8,9,10,12|'."\n"
.'| pricingCycle|String|否|周期单位,包含:月(Month),年(Year)等|'."\n"
.'| autoRenew|Boolean|否|是否自动续费,包含:是(true)和否(false)|',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyInstance' => [
'path' => '/v2/openapi/instances/{instanceId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18721',
'abilityTreeNodes' => [
'FEATUREairec5G3YBA',
'FEATUREairecX63J28',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'regionId' => [
'description' => '实例所在的区域。'."\n",
'type' => 'string',
'example' => 'cn-beijing',
],
'type' => [
'description' => '实例类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Algorithm_configuration**:算法配置版。'."\n"
."\n"
.'- **Industry_operation**:行业运营版。'."\n"
."\n"
.'- **Cold_start**:冷启动版。',
'type' => 'string',
'example' => 'Algorithm_configuration',
],
'lockMode' => [
'description' => '实例锁定状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Unlock**:未锁定。'."\n"
."\n"
.'- **ManualLock**:手动锁定。'."\n"
."\n"
.'- **LockByExpiration**:欠费锁定。',
'type' => 'string',
'example' => 'Unlock',
],
'expiredTime' => [
'description' => '实例过期时间,单位为UTC时间。'."\n",
'type' => 'string',
'example' => '2019-01-06T16:00:00.000Z',
],
'status' => [
'description' => '实例运行状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Initializing**:初始化中。'."\n"
."\n"
.'- **Ready**:待数据导入。'."\n"
."\n"
.'- **Running**:运行中。',
'type' => 'string',
'example' => 'Running',
],
'gmtCreate' => [
'description' => '实例创建时间,单位为UTC时间。'."\n",
'type' => 'string',
'example' => '2018-12-06T06:14:01.000Z',
],
'chargeType' => [
'description' => '实例付费类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **PREPAY**:预付费(包年包月)。'."\n"
."\n"
.'- **POSTPAY**:后付费(按量付费)。',
'type' => 'string',
'example' => 'POSTPAY',
],
'industry' => [
'description' => '实例行业类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **content**:内容型。'."\n"
."\n"
.'- **item**:商品型。'."\n"
."\n"
.'- **news**:新闻型。',
'type' => 'string',
'example' => 'news',
],
'commodityCode' => [
'description' => 'Airec商品代码。',
'type' => 'string',
'example' => 'airecpre',
],
'gmtModified' => [
'description' => '实例最后修改时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
'dataSetVersion' => [
'description' => '当前实例在线服务的数据集版本。',
'type' => 'string',
'example' => '20181206170353',
],
'name' => [
'description' => '实例名称。'."\n",
'type' => 'string',
'example' => '实例1',
],
'instanceId' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'example' => 'airec-cn-****',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9B5AA8EF-DB75-5BE9-ADFD-E645F9EA7374',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'successful',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"type\\": \\"Algorithm_configuration\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"expiredTime\\": \\"2019-01-06T16:00:00.000Z\\",\\n \\"status\\": \\"Running\\",\\n \\"gmtCreate\\": \\"2018-12-06T06:14:01.000Z\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"industry\\": \\"news\\",\\n \\"commodityCode\\": \\"airecpre\\",\\n \\"gmtModified\\": \\"2020-04-23T06:08:48.000Z\\",\\n \\"dataSetVersion\\": \\"20181206170353\\",\\n \\"name\\": \\"实例1\\",\\n \\"instanceId\\": \\"airec-cn-****\\"\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"9B5AA8EF-DB75-5BE9-ADFD-E645F9EA7374\\",\\n \\"message\\": \\"successful\\"\\n}","type":"json"}]',
'title' => '修改实例',
'summary' => '修改指定实例配置。',
],
'DescribeInstance' => [
'path' => '/v2/openapi/instances/{instanceId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18683',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'regionId' => [
'description' => '实例所在的区域。'."\n",
'type' => 'string',
'example' => 'cn-beijing',
],
'type' => [
'description' => '实例类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Algorithm_configuration**:算法配置版。'."\n"
."\n"
.'- **Industry_operation**:行业运营版。'."\n"
."\n"
.'- **Cold_start**:冷启动版。',
'type' => 'string',
'example' => 'Standard',
],
'lockMode' => [
'description' => '实例锁定状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Unlock**:未锁定。'."\n"
."\n"
.'- **ManualLock**:手动锁定。'."\n"
."\n"
.'- **LockByExpiration**:欠费锁定。',
'type' => 'string',
'example' => 'Unlock',
],
'expiredTime' => [
'description' => '实例过期时间,单位为UTC时间。'."\n",
'type' => 'string',
'example' => '2019-01-06T16:00:00.000Z',
],
'scene' => [
'description' => '场景名称。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **gul**:猜你喜欢。'."\n"
."\n"
.'- **rr**:相关推荐。'."\n"
."\n"
.'- **hot**:热门推荐。'."\n"
."\n"
.'- **focus**:焦点图推荐。',
'type' => 'string',
'example' => 'gul',
],
'status' => [
'description' => '实例运行状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Initializing**:初始化中。'."\n"
."\n"
.'- **Ready**:待数据导入。'."\n"
."\n"
.'- **Running**:运行中。',
'type' => 'string',
'example' => 'Running',
],
'gmtCreate' => [
'description' => '实例创建时间,单位为UTC时间。'."\n",
'type' => 'string',
'example' => '2018-12-06T06:14:01.000Z',
],
'chargeType' => [
'description' => '实例付费类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **PREPAY**:预付费(包年包月)。'."\n"
."\n"
.'- **POSTPAY**:后付费(按量付费)。',
'type' => 'string',
'example' => 'PrePaid',
],
'industry' => [
'description' => '实例行业类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **content**:内容型。'."\n"
."\n"
.'- **item**:商品型。'."\n"
."\n"
.'- **news**:新闻型。',
'type' => 'string',
'example' => 'news',
],
'commodityCode' => [
'description' => 'Airec商品代码。',
'type' => 'string',
'example' => 'airecpre',
],
'gmtModified' => [
'description' => '实例最后更新时间,单位为UTC时间。'."\n",
'type' => 'string',
'example' => '2018-12-06T11:17:49.000Z',
],
'dataSetVersion' => [
'description' => '当前在线服务的数据集版本。',
'type' => 'string',
'example' => '20181206170353',
],
'name' => [
'description' => '实例名称。'."\n",
'type' => 'string',
'example' => '实例1',
],
'instanceId' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'example' => 'airec-cn-****',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"type\\": \\"Standard\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"expiredTime\\": \\"2019-01-06T16:00:00.000Z\\",\\n \\"scene\\": \\"gul\\",\\n \\"status\\": \\"Running\\",\\n \\"gmtCreate\\": \\"2018-12-06T06:14:01.000Z\\",\\n \\"chargeType\\": \\"PrePaid\\",\\n \\"industry\\": \\"news\\",\\n \\"commodityCode\\": \\"airecpre\\",\\n \\"gmtModified\\": \\"2018-12-06T11:17:49.000Z\\",\\n \\"dataSetVersion\\": \\"20181206170353\\",\\n \\"name\\": \\"实例1\\",\\n \\"instanceId\\": \\"airec-cn-****\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n airec-cn-xxxxxx\\n airec-cn-xxxxxx\\n Standard\\n Running\\n news\\n gul\\n cn-beijing\\n PrePaid\\n 20181206170353\\n airecpre\\n 2018-12-06T06:14:01.000Z\\n 2018-12-06T11:17:49.000Z\\n 2019-01-06T16:00:00.000Z\\n Unlock\\n\\nB352FBD9-4643-441E-80ED-699D47D7B6A3","errorExample":""}]',
'title' => '查询实例信息',
'summary' => '通过指定的实例ID查看实例详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListInstance' => [
'path' => '/v2/openapi/instances',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18705',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '指定页码,默认为:1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '指定每页展示条数,默认为10,限制:[1-50]。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'status',
'in' => 'query',
'schema' => [
'description' => '通过实例运行状态进行过滤。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Initializing**:初始化中。'."\n"
."\n"
.'- **Ready**:待数据导入。'."\n"
."\n"
.'- **Running**:运行中。',
'type' => 'string',
'required' => false,
'example' => 'Running',
],
],
[
'name' => 'name',
'in' => 'query',
'schema' => [
'description' => '通过实例名称进行过滤,支持模糊匹配。'."\n",
'type' => 'string',
'required' => false,
'example' => '实例1',
],
],
[
'name' => 'expiredTime',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳,通过过期时间过滤,大于当前时间会过滤出即将过期的实例(不包含已经过期的实例)。',
'type' => 'string',
'required' => false,
'example' => '1608533404',
],
],
[
'name' => 'instanceId',
'in' => 'query',
'schema' => [
'description' => '通过实例ID进行过滤,支持模糊匹配。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'regionId' => [
'description' => '实例所在的区域。',
'type' => 'string',
'example' => 'cn-beijing',
],
'type' => [
'description' => '实例类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Algorithm_configuration**:算法配置版。'."\n"
."\n"
.'- **Industry_operation**:行业运营版。'."\n"
."\n"
.'- **Cold_start**:冷启动版。',
'type' => 'string',
'example' => 'Standard',
],
'lockMode' => [
'description' => '实例锁定状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Unlock**:未锁定。'."\n"
."\n"
.'- **ManualLock**:手动锁定。'."\n"
."\n"
.'- **LockByExpiration**:欠费锁定。',
'type' => 'string',
'example' => 'Unlock',
],
'expiredTime' => [
'description' => '实例过期时间,单位为UTC时间。',
'type' => 'string',
'example' => '2019-01-06T16:00:00.000Z',
],
'status' => [
'description' => '实例运行状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Initializing**:初始化中。'."\n"
."\n"
.'- **Ready**:待数据导入。'."\n"
."\n"
.'- **Running**:运行中。',
'type' => 'string',
'example' => 'Running',
],
'gmtCreate' => [
'description' => '实例创建时间,单位为UTC时间。',
'type' => 'string',
'example' => '2018-12-06T06:14:01.000Z',
],
'chargeType' => [
'description' => '实例付费类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **PREPAY**:预付费(包年包月)。'."\n"
."\n"
.'- **POSTPAY**:后付费(按量付费)。',
'type' => 'string',
'example' => 'PrePaid',
],
'industry' => [
'description' => '实例行业类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **content**:内容型。'."\n"
."\n"
.'- **item**:商品型。'."\n"
."\n"
.'- **news**:新闻型。',
'type' => 'string',
'example' => 'news',
],
'commodityCode' => [
'description' => 'Airec商品代码。',
'type' => 'string',
'example' => 'airecpre',
],
'gmtModified' => [
'description' => '实例最后更新时间,单位为UTC时间。',
'type' => 'string',
'example' => '2018-12-06T11:17:49.000Z',
],
'dataSetVersion' => [
'description' => '当前在线服务的数据集版本。',
'type' => 'string',
'example' => '20181206170353',
],
'name' => [
'description' => '实例名称。',
'type' => 'string',
'example' => '实例1',
],
'instanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'airec-cn-****',
],
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"type\\": \\"Standard\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"expiredTime\\": \\"2019-01-06T16:00:00.000Z\\",\\n \\"status\\": \\"Running\\",\\n \\"gmtCreate\\": \\"2018-12-06T06:14:01.000Z\\",\\n \\"chargeType\\": \\"PrePaid\\",\\n \\"industry\\": \\"news\\",\\n \\"commodityCode\\": \\"airecpre\\",\\n \\"gmtModified\\": \\"2018-12-06T11:17:49.000Z\\",\\n \\"dataSetVersion\\": \\"20181206170353\\",\\n \\"name\\": \\"实例1\\",\\n \\"instanceId\\": \\"airec-cn-****\\"\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n airec-cn-5i3mq380d9q6\\n 测试使用\\n Standard\\n Running\\n item\\n cn-hangzhou\\n PrePaid\\n 20201220105251\\n airecpre\\n 2020-12-20T02:51:57.000Z\\n 2020-12-20T03:34:05.000Z\\n 2021-01-20T16:00:00.000Z\\n Unlock\\n\\nCD76827D-8D92-4C90-9C31-A01941834442\\n\\n 1\\n","errorExample":""}]',
'title' => '查询实例列表',
'summary' => '查询一个或多个实例的详细信息。',
'description' => '获取实例列表,返回实例列表按GmtCreate倒序。请求参数的作用类似于一个过滤器,过滤器为逻辑与( AND )关系。如果某个参数为空,则过滤器不起作用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RunInstance' => [
'path' => '/v2/openapi/instances/{instanceId}/actions/import',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18739',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '是否成功创建数据集。'."\n",
'type' => 'boolean',
'example' => 'false',
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": false,\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"8F81A922-6C81-46D6-B78C-CC35E16B1691\\ntrue","errorExample":""}]',
'title' => '运行实例',
'summary' => '启动实例开始全量数据导入任务。',
'description' => '启动实例全量数据导入,此时系统会创建一个数据集新版本。系统会从您的数据源中导入所有的全量数据到系统并训练。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpgradeInstance' => [
'path' => '/v2/openapi/instances/{instanceId}/actions/upgrade',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18745',
'abilityTreeNodes' => [
'FEATUREairecIDS0JZ',
'FEATUREairecDTVO6V',
'FEATUREairecDM7OX0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'instanceId' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'example' => 'airec-cn-****',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"instanceId\\": \\"airec-cn-****\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"90D6B8F5-FE97-4509-9AAB-367836C51818\\n\\n airec-cn-xxxxxx\\n","errorExample":""}]',
'title' => '更新实例配额信息',
'summary' => '更新指定实例配额(Quota)信息。',
'description' => '更新指定实例配额 (Quota)信息。'."\n"
."\n"
.'用户数限制为:最小值 1,000,000、最大值 10,000,000物品数限制为:最小值 1,000,000、最大值 10,000,000推荐请求QPS限制为:最小值 10、最大值 500。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ValidateInstance' => [
'path' => '/v2/openapi/instances/{instanceId}/actions/validate',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '18746',
'abilityTreeNodes' => [
'FEATUREairecIDS0JZ',
'FEATUREairecEDD4RN',
'FEATUREairecDTVO6V',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'boolean',
'example' => 'true',
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '90D6B8F5-FE97-4509-9AAB-367836C51818',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": true,\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"90D6B8F5-FE97-4509-9AAB-367836C51818\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '校验指定实例有效性',
'summary' => '校验指定实例信息的有效性。',
],
'DowngradeInstance' => [
'path' => '/v2/openapi/instances/{instanceId}/actions/downgrade',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18694',
'abilityTreeNodes' => [
'FEATUREairecIDS0JZ',
'FEATUREairecDTVO6V',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'instanceId' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'example' => 'airec-cn-****',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"instanceId\\": \\"airec-cn-****\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"90D6B8F5-FE97-4509-9AAB-367836C51818\\n\\n airec-cn-xxxxxx\\n","errorExample":""}]',
'title' => '降低指定实例配额 (Quota)信息',
'summary' => '降低指定实例配额 (Quota)信息。',
'description' => '新的配额数据不能大于已经选择的配额并且不能小于目前已经使用的配额。'."\n"
."\n"
.'用户数限制为:最小值 1,000,000、最大值 10,000,000;'."\n"
.'物品数限制为:最小值 1,000,000、最大值 10,000,000;'."\n"
.'推荐请求QPS限制为:最小值 10、最大值 500。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateExtraDataSource' => [
'summary' => '创建一个数据源。',
'path' => '/v2/openapi/instances/{instanceId}/extra-data-sources',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '117103',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回参数。',
'$ref' => '#/components/schemas/ExtraDataSource',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"Ready 待应用;Online 已应用;Failed失败\\",\\n \\"Meta\\": {\\n \\"Internal\\": true,\\n \\"MetaType\\": \\"ExtraDataSource\\",\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"Type\\": \\"ODPS\\",\\n \\"UpdateFrequency\\": 86400\\n },\\n \\"Type\\": \\"UserCustomDataSource、ItemCustomDataSource、BehaviorCustomDataSource、SampleCustomDataSource\\",\\n \\"GmtCreate\\": \\"2021-12-07T13:26:29.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T13:26:29.000Z\\",\\n \\"DataSourceId\\": \\"E01D574F-ABD0-4C55-A5E3-8D24FD8D42EA\\"\\n }\\n}","type":"json"}]',
'title' => '创建数据源',
],
'DeleteExtraDataSource' => [
'summary' => '删除数据源。',
'path' => '/v2/openapi/instances/{instanceId}/extra-data-sources/{type}/{dataSourceId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '117109',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'type',
'in' => 'path',
'schema' => [
'title' => '数据源类型',
'description' => '数据源类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **UserCustomDataSource**:用户数据源。'."\n"
."\n"
.'- **ItemCustomDataSource**:物品数据源。'."\n"
."\n"
.'- **BehaviorCustomDataSource**:行为数据源。',
'type' => 'string',
'required' => true,
'example' => 'UserCustomDataSource',
],
],
[
'name' => 'dataSourceId',
'in' => 'path',
'schema' => [
'title' => '数据源id',
'description' => '数据源ID。',
'type' => 'string',
'required' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回参数。',
'$ref' => '#/components/schemas/ExtraDataSource',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"Ready 待应用;Online 已应用;Failed失败\\",\\n \\"Meta\\": {\\n \\"Internal\\": true,\\n \\"MetaType\\": \\"ExtraDataSource\\",\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"Type\\": \\"ODPS\\",\\n \\"UpdateFrequency\\": 86400\\n },\\n \\"Type\\": \\"UserCustomDataSource、ItemCustomDataSource、BehaviorCustomDataSource、SampleCustomDataSource\\",\\n \\"GmtCreate\\": \\"2021-12-07T13:26:29.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T13:26:29.000Z\\",\\n \\"DataSourceId\\": \\"E01D574F-ABD0-4C55-A5E3-8D24FD8D42EA\\"\\n }\\n}","type":"json"}]',
'title' => '删除数据源',
],
'ListExtraDataSources' => [
'summary' => '获取特征、样本数据源列表。',
'path' => '/v2/openapi/instances/{instanceId}/extra-data-sources',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117105',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'type',
'in' => 'query',
'schema' => [
'title' => '根据数据源类型过滤',
'description' => '数据源类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **UserCustomDataSource**:用户数据源。'."\n"
."\n"
.'- **ItemCustomDataSource**:物品数据源。'."\n"
."\n"
.'- **BehaviorCustomDataSource**:行为数据源。',
'type' => 'string',
'required' => false,
'example' => 'UserCustomDataSource',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '数据源列表。',
'$ref' => '#/components/schemas/ExtraDataSource',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": [\\n {\\n \\"Status\\": \\"Ready 待应用;Online 已应用;Failed失败\\",\\n \\"Meta\\": {\\n \\"Internal\\": true,\\n \\"MetaType\\": \\"ExtraDataSource\\",\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"Type\\": \\"ODPS\\",\\n \\"UpdateFrequency\\": 86400\\n },\\n \\"Type\\": \\"UserCustomDataSource、ItemCustomDataSource、BehaviorCustomDataSource、SampleCustomDataSource\\",\\n \\"GmtCreate\\": \\"2021-12-07T13:26:29.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T13:26:29.000Z\\",\\n \\"DataSourceId\\": \\"E01D574F-ABD0-4C55-A5E3-8D24FD8D42EA\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取数据源',
],
'DeleteDataSet' => [
'path' => '/v2/openapi/instances/{instanceId}/dataSets/{versionId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '18671',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'versionId',
'in' => 'path',
'schema' => [
'description' => '版本ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018102321****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'versionId' => [
'description' => '版本号ID。',
'type' => 'string',
'example' => '2018102321****',
],
'state' => [
'description' => 'State状态类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Importing**:数据导入中。'."\n"
."\n"
.'- **DataSuccess**:数据导入成功。'."\n"
."\n"
.'- **DataFailed**:数据导入失败,终态。'."\n"
."\n"
.'- **Training**:训练中。'."\n"
."\n"
.'- **Success**:成功,终态。'."\n"
."\n"
.'- **Failed**:失败,终态。'."\n"
."\n"
.'- **Stopped**:终止,终态。',
'type' => 'string',
'example' => 'Importing',
],
'gmtModified' => [
'description' => '最后修改数据源的时间。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '2018-12-06T11:17:49.000Z',
],
'gmtCreate' => [
'description' => '创建数据源的时间。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '2018-12-07T02:24:26.000Z',
],
'instanceId' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'example' => 'airec-cn-o400whm78004',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"versionId\\": \\"2018102321****\\",\\n \\"state\\": \\"Importing\\",\\n \\"gmtModified\\": 0,\\n \\"gmtCreate\\": 0,\\n \\"instanceId\\": \\"airec-cn-o400whm78004\\"\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '删除指定实例的指定数据集版本',
'summary' => '删除指定实例的指定数据集版本。',
],
'AttachDataset' => [
'path' => '/v2/openapi/instances/{instanceId}/dataSets/{versionId}/actions/current',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18661',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'versionId',
'in' => 'path',
'schema' => [
'description' => '版本ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018102321****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'versionId' => [
'description' => '版本号ID。',
'type' => 'string',
'example' => '2018102321****',
],
'state' => [
'description' => 'State状态类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Importing**:数据导入中。'."\n"
."\n"
.'- **DataSuccess**:数据导入成功。'."\n"
."\n"
.'- **DataFailed**:数据导入失败,终态。'."\n"
."\n"
.'- **Training**:训练中。'."\n"
."\n"
.'- **Success**:成功,终态。'."\n"
."\n"
.'- **Failed**:失败,终态。'."\n"
."\n"
.'- **Stopped**:终止,终态。',
'type' => 'string',
'example' => 'Importing',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2018-12-07T02:24:26.000Z',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2018-12-06T06:14:01.000Z',
],
'instanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'airec-cn-****',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F60021C4-57AF-5F46-9B3E-FCEF1C7A1459',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"versionId\\": \\"2018102321****\\",\\n \\"state\\": \\"Importing\\",\\n \\"gmtModified\\": 0,\\n \\"gmtCreate\\": 0,\\n \\"instanceId\\": \\"airec-cn-****\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"F60021C4-57AF-5F46-9B3E-FCEF1C7A1459\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","type":"json"}]',
'title' => '开启数据训练',
'summary' => '指定实例的指定数据集版本提供在线服务。',
],
'DescribeDataSetMessage' => [
'path' => '/v2/openapi/instances/{instanceId}/dataSets/{versionId}/messages',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18677',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'versionId',
'in' => 'path',
'schema' => [
'description' => '版本号ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018102321****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'message' => [
'description' => '数据诊断错误详情。',
'type' => 'string',
'example' => 'item商品表合法率0.36,可被采纳数据(符合规范)较少。会影响预热期推荐效果。请检查数据,补充相关字段信息,重新导入。建议优化。',
],
'timestamp' => [
'description' => '数据诊断错误时间。',
'type' => 'string',
'example' => '20181211 17:27:44',
],
'errorLevel' => [
'description' => '数据诊断错误级别。',
'type' => 'string',
'example' => 'warn',
],
'errorType' => [
'description' => '数据诊断错误类型。',
'type' => 'string',
'example' => '合法率',
],
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"message\\": \\"item商品表合法率0.36,可被采纳数据(符合规范)较少。会影响预热期推荐效果。请检查数据,补充相关字段信息,重新导入。建议优化。\\",\\n \\"timestamp\\": \\"20181211 17:27:44\\",\\n \\"errorLevel\\": \\"warn\\",\\n \\"errorType\\": \\"合法率\\"\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"8F81A922-6C81-46D6-B78C-CC35E16B1691\\n\\n 合法率\\n warn\\n item商品表合法率0.36,可被采纳数据(符合规范)较少。会影响预热期推荐效果。请检查数据,补充相关字段信息,重新导入。建议优化。\\n 20181211 17:27:44\\n","errorExample":""}]',
'title' => 'DescribeDataSetMessage',
'summary' => '获取指定实例的指定数据集版本数据错误详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDataSet' => [
'path' => '/v2/openapi/instances/{instanceId}/dataSets',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18700',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'versionId' => [
'description' => '数据版本ID。',
'type' => 'string',
'example' => '2018102321****',
],
'state' => [
'description' => 'State状态类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Importing**:数据导入中。'."\n"
."\n"
.'- **DataSuccess**:数据导入成功。'."\n"
."\n"
.'- **DataFailed**:数据导入失败,终态。'."\n"
."\n"
.'- **Training**:训练中。'."\n"
."\n"
.'- **Success**:成功,终态。'."\n"
."\n"
.'- **Failed**:失败,终态。'."\n"
."\n"
.'- **Stopped**:终止,终态。',
'type' => 'string',
'example' => 'Importing',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2020-11-11T09:47:43.000Z',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2018-12-07T02:24:26.000Z',
],
'instanceId' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'example' => 'airec-cn-o400whm78004',
],
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"versionId\\": \\"2018102321****\\",\\n \\"state\\": \\"Importing\\",\\n \\"gmtModified\\": 0,\\n \\"gmtCreate\\": 0,\\n \\"instanceId\\": \\"airec-cn-o400whm78004\\"\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '获取数据集列表',
'summary' => '获取指定实例的数据集列表。',
],
'DeleteExperiment' => [
'summary' => '删除一个实验。',
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments/{experimentId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '18672',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****'."\n",
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
[
'name' => 'experimentId',
'in' => 'path',
'schema' => [
'description' => '实验ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12345',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'boolean',
'example' => 'true',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '删除实验',
],
'EnableExperiment' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/actions/enable-experiment',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18695',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'boolean',
'example' => 'True',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\"\\n}","type":"json"}]',
'title' => '启用实验',
'summary' => '启用实验功能。',
],
'UpdateExperimentBasicInfo' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments/{experimentId}/basic',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18742',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
[
'name' => 'experimentId',
'in' => 'path',
'schema' => [
'description' => '实验ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12345',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'base' => [
'description' => '分桶列表。',
'type' => 'boolean',
'example' => 'true',
],
'onlineTime' => [
'description' => '实验上线时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'offlineTime' => [
'description' => '实验下线时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'description' => [
'description' => '实验备注。',
'type' => 'string',
'example' => 'demo1',
],
'status' => [
'description' => '实验状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Init**:未上线。'."\n"
."\n"
.'- **Online**:上线。'."\n"
."\n"
.'- **Finish**:推全。'."\n"
."\n"
.'- **Offline**:下线。',
'type' => 'string',
'example' => '1',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'test',
],
'algorithms' => [
'description' => '实验参数列表。',
'type' => 'array',
'items' => [
'description' => '实验参数。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法key。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **i2i**:i2i召回链路。'."\n"
."\n"
.'- **u2x2i**:u2x2i召回链路。'."\n"
."\n"
.'- **hot**:热门商品召回链路。'."\n"
."\n"
.'- **new**:新品召回链路。'."\n"
."\n"
.'- **embedding**:向量召回链路。'."\n"
."\n"
.'- **mtorder**:召回链路优先级。'."\n"
."\n"
.'- **rankservice**:排序服务。',
'type' => 'string',
'example' => 'I2I',
],
'config' => [
'description' => '子配置项列表。',
'type' => 'array',
'items' => [
'description' => '子配置项信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法配置项key。',
'type' => 'string',
'example' => 'I2I',
],
'defaultValue' => [
'description' => '算法配置项默认值。',
'type' => 'string',
'example' => 'true',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => '400',
],
'name' => [
'description' => '子配置名称。',
'type' => 'string',
'example' => 'i2i召回链路',
],
],
],
],
'defaultValue' => [
'description' => '默认召回数量。',
'type' => 'string',
'example' => '400',
],
'type' => [
'description' => '算法类别。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **SYSTEM**:系统默认类型。'."\n"
."\n"
.'- **CUSTOM**:用户自定义类型。',
'type' => 'string',
'example' => 'SYSTEM',
],
'experimentValue' => [
'description' => '实验定制值。',
'type' => 'string',
'example' => '400',
],
'hasConfig' => [
'description' => '是否有子配置项。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。',
'type' => 'boolean',
'example' => 'false',
],
'category' => [
'description' => '算法类目。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **RECALL**:召回。'."\n"
."\n"
.'- **RANK**:排序。',
'type' => 'string',
'example' => '2',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'test',
],
],
],
],
'buckets' => [
'description' => '分桶列表。',
'type' => 'array',
'items' => [
'description' => '分桶。',
'type' => 'string',
'example' => '["1","2","3"]',
],
],
'experimentId' => [
'description' => '实验ID。',
'type' => 'string',
'example' => '12345',
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"base\\": true,\\n \\"onlineTime\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"offlineTime\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"description\\": \\"demo1\\",\\n \\"status\\": \\"1\\",\\n \\"name\\": \\"test\\",\\n \\"algorithms\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"config\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"defaultValue\\": \\"true\\",\\n \\"experimentValue\\": \\"400\\",\\n \\"name\\": \\"i2i召回链路\\"\\n }\\n ],\\n \\"defaultValue\\": \\"400\\",\\n \\"type\\": \\"SYSTEM\\",\\n \\"experimentValue\\": \\"400\\",\\n \\"hasConfig\\": false,\\n \\"category\\": \\"2\\",\\n \\"name\\": \\"test\\"\\n }\\n ],\\n \\"buckets\\": [\\n \\"[\\\\\\"1\\\\\\",\\\\\\"2\\\\\\",\\\\\\"3\\\\\\"]\\"\\n ],\\n \\"experimentId\\": \\"12345\\"\\n },\\n \\"requestId\\": \\"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '更新实验基本信息',
'summary' => '更新实验基本信息。',
],
'UpdateExperimentConfig' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments/{experimentId}/config',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18743',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****'."\n",
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
[
'name' => 'experimentId',
'in' => 'path',
'schema' => [
'description' => '实验ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12345',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'base' => [
'description' => '是否为默认实验。',
'type' => 'boolean',
'example' => 'true',
],
'onlineTime' => [
'description' => '实验上线时间。',
'type' => 'string',
'example' => '2020-12-07T06:47:30.000Z',
],
'offlineTime' => [
'description' => '实验下线/推全时间。',
'type' => 'string',
'example' => '2020-12-07T06:47:30.000Z',
],
'description' => [
'description' => '实验备注。',
'type' => 'string',
'example' => 'demo1',
],
'status' => [
'description' => '实验状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Init**:未上线。'."\n"
."\n"
.'- **Online**:上线。'."\n"
."\n"
.'- **Finish**:推全。'."\n"
."\n"
.'- **Offline**:下线。',
'type' => 'string',
'example' => 'Online',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'I2I召回链路',
],
'algorithms' => [
'description' => '实验参数列表。',
'type' => 'array',
'items' => [
'description' => '实验参数。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法key。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **I2I**:I2I召回链路。'."\n"
."\n"
.'- **u2X2I**:U2X2I召回链路。'."\n"
."\n"
.'- **hot**:热门商品召回链路。'."\n"
."\n"
.'- **new**:新品召回链路。'."\n"
."\n"
.'- **embedding**:向量召回链路。'."\n"
."\n"
.'- **mtorder**:召回链路优先级。'."\n"
."\n"
.'- **rankservice**:排序服务。',
'type' => 'string',
'example' => 'I2I',
],
'config' => [
'description' => '子配置项列表。',
'type' => 'array',
'items' => [
'description' => '子配置项信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法配置项key。',
'type' => 'string',
'example' => 'I2I',
],
'defaultValue' => [
'description' => '算法配置项默认值。',
'type' => 'string',
'example' => 'true',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => 'true',
],
'name' => [
'description' => '子配置名称。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'defaultValue' => [
'description' => '默认召回数量。',
'type' => 'string',
'example' => '400',
],
'type' => [
'description' => '算法类别。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **SYSTEM**:系统默认类型。'."\n"
."\n"
.'- **CUSTOM**:用户自定义类型。',
'type' => 'string',
'example' => 'SYSTEM',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => '300',
],
'hasConfig' => [
'description' => '是否有子配置项。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:是'."\n"
."\n"
.'- **false**:否',
'type' => 'boolean',
'example' => 'true',
],
'category' => [
'description' => '算法类目。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **RECALL**:召回。'."\n"
."\n"
.'- **RANK**:排序。',
'type' => 'string',
'example' => 'RECALL',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'buckets' => [
'description' => '分桶列表,上线实验时该字段才生效。',
'type' => 'array',
'items' => [
'description' => '分桶信息。',
'type' => 'string',
'example' => 'userid',
],
],
'experimentId' => [
'description' => '实验ID。',
'type' => 'string',
'example' => 'xxx',
],
],
],
'requestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"base\\": true,\\n \\"onlineTime\\": \\"2020-12-07T06:47:30.000Z\\",\\n \\"offlineTime\\": \\"2020-12-07T06:47:30.000Z\\",\\n \\"description\\": \\"demo1\\",\\n \\"status\\": \\"Online\\",\\n \\"name\\": \\"I2I召回链路\\",\\n \\"algorithms\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"config\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"defaultValue\\": \\"true\\",\\n \\"experimentValue\\": \\"true\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"defaultValue\\": \\"400\\",\\n \\"type\\": \\"SYSTEM\\",\\n \\"experimentValue\\": \\"300\\",\\n \\"hasConfig\\": true,\\n \\"category\\": \\"RECALL\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"buckets\\": [\\n \\"userid\\"\\n ],\\n \\"experimentId\\": \\"xxx\\"\\n },\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '更新实验配置',
'summary' => '更新一个实验配置信息。',
],
'UpdateExperimentStatus' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments/{experimentId}/status',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18744',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
[
'name' => 'experimentId',
'in' => 'path',
'schema' => [
'description' => '实验ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'base' => [
'description' => '是否为默认实验。',
'type' => 'boolean',
'example' => 'true',
],
'onlineTime' => [
'description' => '实验上线时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'offlineTime' => [
'description' => '实验下线时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'description' => [
'description' => '实验备注。',
'type' => 'string',
'example' => 'xxx',
],
'status' => [
'description' => '实验状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Init**:未上线。'."\n"
."\n"
.'- **Online**:上线。'."\n"
."\n"
.'- **Finish**:推全。'."\n"
."\n"
.'- **Offline**:下线。',
'type' => 'string',
'example' => 'init',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'test',
],
'algorithms' => [
'description' => '实验参数列表。',
'type' => 'array',
'items' => [
'description' => '实验参数信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法key。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **I2I**:I2I召回链路。'."\n"
."\n"
.'- **u2X2I**:U2X2I召回链路。'."\n"
."\n"
.'- **hot**:热门商品召回链路。'."\n"
."\n"
.'- **new**:新品召回链路。'."\n"
."\n"
.'- **embedding**:向量召回链路。'."\n"
."\n"
.'- **mtorder**:召回链路优先级。'."\n"
."\n"
.'- **rankservice**:排序服务。',
'type' => 'string',
'example' => 'hot',
],
'config' => [
'description' => '子配置项列表。',
'type' => 'array',
'items' => [
'description' => '子配置项信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法配置项key。',
'type' => 'string',
'example' => 'hot',
],
'defaultValue' => [
'description' => '算法配置项默认值。',
'type' => 'string',
'example' => 'xxx',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => 'xxx',
],
'name' => [
'description' => '子配置名称。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'defaultValue' => [
'description' => '默认召回数量。',
'type' => 'string',
'example' => 'swing',
],
'type' => [
'description' => '算法类别。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **SYSTEM**:系统默认类型。'."\n"
."\n"
.'- **CUSTOM**:用户自定义类型。',
'type' => 'string',
'example' => 'SYSTEM',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => 'xxx',
],
'hasConfig' => [
'description' => '是否有子配置项。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:是'."\n"
."\n"
.'- **false**:否',
'type' => 'boolean',
'example' => 'false',
],
'category' => [
'description' => '算法类目。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **RECALL**:召回。'."\n"
."\n"
.'- **RANK**:排序。',
'type' => 'string',
'example' => 'RECALL',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'buckets' => [
'description' => '分桶列表,上线实验时该字段才生效。',
'type' => 'array',
'items' => [
'description' => '分桶信息。',
'type' => 'string',
'example' => '["1"、"2"、"3"]',
],
],
'experimentId' => [
'description' => '实验ID。',
'type' => 'string',
'example' => '123',
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"base\\": true,\\n \\"onlineTime\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"offlineTime\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"description\\": \\"xxx\\",\\n \\"status\\": \\"init\\",\\n \\"name\\": \\"test\\",\\n \\"algorithms\\": [\\n {\\n \\"key\\": \\"hot\\",\\n \\"config\\": [\\n {\\n \\"key\\": \\"hot\\",\\n \\"defaultValue\\": \\"xxx\\",\\n \\"experimentValue\\": \\"xxx\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"defaultValue\\": \\"swing\\",\\n \\"type\\": \\"SYSTEM\\",\\n \\"experimentValue\\": \\"xxx\\",\\n \\"hasConfig\\": false,\\n \\"category\\": \\"RECALL\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"buckets\\": [\\n \\"[\\\\\\"1\\\\\\"、\\\\\\"2\\\\\\"、\\\\\\"3\\\\\\"]\\"\\n ],\\n \\"experimentId\\": \\"123\\"\\n },\\n \\"requestId\\": \\"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 12345\\n 实验1\\n demo1\\n 1\\n 2\\n 3\\n init\\n true\\n 2020-11-11t09:47:43.000z\\n \\n \\n i2i\\n i2i召回链路\\n recall\\n system\\n true\\n \\n true\\n \\n i2i-truncedquantity\\n 截断数量\\n 400\\n 300\\n \\n \\n i2i-algo\\n i2i算法\\n swing;commoni2i;pcategory;scategory\\n \\n \\n \\n \\n mtorder\\n 召回链路优先级\\n system\\n recall\\n i2i;u2x2i;new;hot;embedding;embedding\\n \\n false\\n \\n \\n e3d6fe3b-b7c2-43da-9a13-5ea837aced9b\\n","errorExample":""}]',
'title' => '更新实验状态',
'summary' => '更新实验状态。',
],
'DescribeBaseExperiment' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/base-experiment',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18676',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'base' => [
'description' => '是否为默认实验。',
'type' => 'boolean',
'example' => 'true',
],
'onlineTime' => [
'description' => '实验上线时间。',
'type' => 'string',
'example' => '2020-12-07T06:47:30.000Z',
],
'offlineTime' => [
'description' => '实验下线/推全时间。',
'type' => 'string',
'example' => '2020-12-07T06:47:30.000Z',
],
'description' => [
'description' => '实验备注。',
'type' => 'string',
'example' => 'xxx',
],
'status' => [
'description' => '实验状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Init**:未上线。'."\n"
."\n"
.'- **Online**:上线。'."\n"
."\n"
.'- **Finish**:推全。'."\n"
."\n"
.'- **Offline**:下线。',
'type' => 'string',
'example' => 'Init',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => '测试实验',
],
'algorithms' => [
'description' => '实验参数列表。',
'type' => 'array',
'items' => [
'description' => '实验参数信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法key。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **I2I**:I2I召回链路。'."\n"
."\n"
.'- **u2X2I**:U2X2I召回链路。'."\n"
."\n"
.'- **hot**:热门商品召回链路。'."\n"
."\n"
.'- **new**:新品召回链路。'."\n"
."\n"
.'- **embedding**:向量召回链路。'."\n"
."\n"
.'- **mtorder**:召回链路优先级。'."\n"
."\n"
.'- **rankservice**:排序服务。',
'type' => 'string',
'example' => 'I2I',
],
'config' => [
'description' => '子配置项列表。',
'type' => 'array',
'items' => [
'description' => '子配置项信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法配置项key。',
'type' => 'string',
'example' => 'I2I',
],
'defaultValue' => [
'description' => '算法配置项默认值。',
'type' => 'string',
'example' => 'true',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => '400',
],
'name' => [
'description' => '子配置名称。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'defaultValue' => [
'description' => '默认召回数量。',
'type' => 'string',
'example' => 'true',
],
'type' => [
'description' => '算法类别。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **SYSTEM**:系统默认类型。'."\n"
."\n"
.'- **CUSTOM**:用户自定义类型。',
'type' => 'string',
'example' => 'SYSTEM',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => '400',
],
'hasConfig' => [
'description' => '是否有子配置项。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:是'."\n"
."\n"
.'- **false**:否',
'type' => 'boolean',
'example' => 'false',
],
'category' => [
'description' => '算法类目。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **RECALL**:召回。'."\n"
."\n"
.'- **RANK**:排序。',
'type' => 'string',
'example' => 'RECALL',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'buckets' => [
'description' => '分桶列表,上线实验时该字段才生效。',
'type' => 'array',
'items' => [
'description' => '分桶信息。',
'type' => 'string',
'example' => '[1,2,3]',
],
],
'experimentId' => [
'description' => '实验ID。',
'type' => 'string',
'example' => 'xxx',
],
],
],
'requestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => 'A74E3FB7-406C-5CBB-833E-E49308B5DC05',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"base\\": true,\\n \\"onlineTime\\": \\"2020-12-07T06:47:30.000Z\\",\\n \\"offlineTime\\": \\"2020-12-07T06:47:30.000Z\\",\\n \\"description\\": \\"xxx\\",\\n \\"status\\": \\"Init\\",\\n \\"name\\": \\"测试实验\\",\\n \\"algorithms\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"config\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"defaultValue\\": \\"true\\",\\n \\"experimentValue\\": \\"400\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"defaultValue\\": \\"true\\",\\n \\"type\\": \\"SYSTEM\\",\\n \\"experimentValue\\": \\"400\\",\\n \\"hasConfig\\": false,\\n \\"category\\": \\"RECALL\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"buckets\\": [\\n \\"[1,2,3]\\"\\n ],\\n \\"experimentId\\": \\"xxx\\"\\n },\\n \\"requestId\\": \\"A74E3FB7-406C-5CBB-833E-E49308B5DC05\\"\\n}","type":"json"}]',
'title' => '获取基础实验',
'summary' => '获取基础实验。',
],
'DescribeExperiment' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments/{experimentId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18679',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
[
'name' => 'experimentId',
'in' => 'path',
'schema' => [
'description' => '实验ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '23245',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'base' => [
'description' => '是否为默认实验。',
'type' => 'boolean',
'example' => 'true',
],
'onlineTime' => [
'description' => '实验上线时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'offlineTime' => [
'description' => '实验下线时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'description' => [
'description' => '实验备注。',
'type' => 'string',
'example' => 'xxx',
],
'status' => [
'description' => '实验状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Init**:未上线。'."\n"
."\n"
.'- **Online**:上线。'."\n"
."\n"
.'- **Finish**:推全。'."\n"
."\n"
.'- **Offline**:下线。',
'type' => 'string',
'example' => '1',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'test',
],
'algorithms' => [
'description' => '实验参数列表。',
'type' => 'array',
'items' => [
'description' => '实验参数信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法key。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **I2I**:I2I召回链路。'."\n"
."\n"
.'- **u2X2I**:U2X2I召回链路。'."\n"
."\n"
.'- **hot**:热门商品召回链路。'."\n"
."\n"
.'- **new**:新品召回链路。'."\n"
."\n"
.'- **embedding**:向量召回链路。'."\n"
."\n"
.'- **mtorder**:召回链路优先级。'."\n"
."\n"
.'- **rankservice**:排序服务。',
'type' => 'string',
'example' => 'I2I',
],
'config' => [
'description' => '子配置项列表。',
'type' => 'array',
'items' => [
'description' => '子配置项信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法配置项key。',
'type' => 'string',
'example' => 'I2I',
],
'defaultValue' => [
'description' => '算法配置项默认值。',
'type' => 'string',
'example' => 'true',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => '400',
],
'name' => [
'description' => '子配置名称。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'defaultValue' => [
'description' => '默认召回数量。',
'type' => 'string',
'example' => 'true',
],
'type' => [
'description' => '算法类别。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **SYSTEM**:系统默认类型。'."\n"
."\n"
.'- **CUSTOM**:用户自定义类型。',
'type' => 'string',
'example' => 'SYSTEM',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => '空',
],
'hasConfig' => [
'description' => '是否有子配置项。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:是'."\n"
."\n"
.'- **false**:否',
'type' => 'boolean',
'example' => 'false',
],
'category' => [
'description' => '算法类目。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **RECALL**:召回。'."\n"
."\n"
.'- **RANK**:排序。',
'type' => 'string',
'example' => '2',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'test',
],
],
],
],
'buckets' => [
'description' => '分桶列表,上线实验时该字段才生效。',
'type' => 'array',
'items' => [
'description' => '分桶信息。',
'type' => 'string',
'example' => '["1","2","3"]',
],
],
'experimentId' => [
'description' => '实验ID。',
'type' => 'string',
'example' => '12345',
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"base\\": true,\\n \\"onlineTime\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"offlineTime\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"description\\": \\"xxx\\",\\n \\"status\\": \\"1\\",\\n \\"name\\": \\"test\\",\\n \\"algorithms\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"config\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"defaultValue\\": \\"true\\",\\n \\"experimentValue\\": \\"400\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"defaultValue\\": \\"true\\",\\n \\"type\\": \\"SYSTEM\\",\\n \\"experimentValue\\": \\"空\\",\\n \\"hasConfig\\": false,\\n \\"category\\": \\"2\\",\\n \\"name\\": \\"test\\"\\n }\\n ],\\n \\"buckets\\": [\\n \\"[\\\\\\"1\\\\\\",\\\\\\"2\\\\\\",\\\\\\"3\\\\\\"]\\"\\n ],\\n \\"experimentId\\": \\"12345\\"\\n },\\n \\"requestId\\": \\"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => 'DescribeExperiment',
'summary' => '查看一个实验详情。',
],
'DescribeExperimentEnv' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiment-env',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18680',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'bucketCount' => [
'description' => '分桶数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'divideType' => [
'description' => '分桶方式UID/IMEI。',
'type' => 'string',
'example' => 'UID',
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"bucketCount\\": 10,\\n \\"divideType\\": \\"UID\\"\\n },\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取实验环境',
'summary' => '查看实验场景信息。',
],
'DescribeExperimentEnvProgress' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiment-progress',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18681',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'status' => [
'description' => '开通状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **NotOpen**:未开通。'."\n"
."\n"
.'- **Processing**:开通中。'."\n"
."\n"
.'- **Running**:运行中。',
'type' => 'string',
'example' => 'Processing',
],
'progress' => [
'description' => '执行进度,范围为0-100,100为执行结束。',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"status\\": \\"Processing\\",\\n \\"progress\\": 80\\n },\\n \\"requestId\\": \\"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\"\\n}","type":"json"}]',
'title' => '获取实验环境进度',
'summary' => '查看实验场景开通状态。',
],
'ListExperiments' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18702',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'base' => [
'description' => '是否为默认实验。',
'type' => 'boolean',
'example' => 'true',
],
'onlineTime' => [
'description' => '实验上线时间。',
'type' => 'string',
'example' => '2020-12-07T06:47:30.000Z',
],
'offlineTime' => [
'description' => '实验下线时间。',
'type' => 'string',
'example' => '2020-12-07T06:47:30.000Z',
],
'description' => [
'description' => '实验备注。',
'type' => 'string',
'example' => 'xxx',
],
'status' => [
'description' => '实验状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Init**:未上线。'."\n"
."\n"
.'- **Online**:上线。'."\n"
."\n"
.'- **Finish**:推全。'."\n"
."\n"
.'- **Offline**:下线。',
'type' => 'string',
'example' => 'init',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'test',
],
'buckets' => [
'description' => '分桶列表,上线实验时该字段才生效。',
'type' => 'array',
'items' => [
'description' => '分桶信息。',
'type' => 'string',
'example' => '[1,2,3]',
],
],
'experimentId' => [
'description' => '实验ID。',
'type' => 'string',
'example' => '123',
],
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"base\\": true,\\n \\"onlineTime\\": \\"2020-12-07T06:47:30.000Z\\",\\n \\"offlineTime\\": \\"2020-12-07T06:47:30.000Z\\",\\n \\"description\\": \\"xxx\\",\\n \\"status\\": \\"init\\",\\n \\"name\\": \\"test\\",\\n \\"buckets\\": [\\n \\"[1,2,3]\\"\\n ],\\n \\"experimentId\\": \\"123\\"\\n }\\n ],\\n \\"requestId\\": \\"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 12345\\n 实验1\\n demo1\\n 1\\n 2\\n 3\\n init\\n true\\n 2020-11-11t09:47:43.000z\\n \\n\\ne3d6fe3b-b7c2-43da-9a13-5ea837aced9b","errorExample":""}]',
'title' => 'ListExperiments',
'summary' => '列出实验清单,说明:只展示实验基本信息,不展示算法配置,暂不提供分页功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CloneExperiment' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments/{experimentId}/actions/clone',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '18664',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sceneId',
],
],
[
'name' => 'dryRun',
'in' => 'query',
'schema' => [
'description' => '是否完成克隆。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:校验实验信息。'."\n"
."\n"
.'- **false**:默认false,创建实验。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'experimentId',
'in' => 'path',
'schema' => [
'description' => '实验ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'base' => [
'description' => '是否为默认实验。',
'type' => 'boolean',
'example' => 'true',
],
'onlineTime' => [
'description' => '实验线上时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'offlineTime' => [
'description' => '实验下线时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'description' => [
'description' => '实验备注。',
'type' => 'string',
'example' => 'xxx',
],
'status' => [
'description' => '实验状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Init**:未上线。'."\n"
."\n"
.'- **Online**:上线。'."\n"
."\n"
.'- **Finish**:推全。'."\n"
."\n"
.'- **Offline**:下线。',
'type' => 'string',
'example' => 'Init',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'xxx',
],
'algorithms' => [
'description' => '实验参数列表。',
'type' => 'array',
'items' => [
'description' => '实验参数。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法key。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **I2I**:I2I召回链路。'."\n"
."\n"
.'- **u2X2I**:U2X2I召回链路。'."\n"
."\n"
.'- **hot**:热门商品召回链路。'."\n"
."\n"
.'- **new**:新品召回链路。'."\n"
."\n"
.'- **embedding**:向量召回链路。'."\n"
."\n"
.'- **mtorder**:召回链路优先级。'."\n"
."\n"
.'- **rankservice**:排序服务。',
'type' => 'string',
'example' => 'I2I',
],
'config' => [
'description' => '子配置项列表。',
'type' => 'array',
'items' => [
'description' => '子配置项信息。',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法配置项key。',
'type' => 'string',
'example' => 'I2I-truncedquantity',
],
'defaultValue' => [
'description' => '算法配置项默认值。',
'type' => 'string',
'example' => '400',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => 'swing;commoni2i;pcategory;scategory',
],
'name' => [
'description' => '子配置名称。',
'type' => 'string',
'example' => 'I2I算法',
],
],
],
],
'defaultValue' => [
'description' => '默认召回数量。',
'type' => 'string',
'example' => 'i2i;u2x2i;new;hot;embedding;embedding',
],
'type' => [
'description' => '算法类别。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **SYSTEM**:系统默认类型。'."\n"
."\n"
.'- **CUSTOM**:用户自定义类型。',
'type' => 'string',
'example' => 'SYSTEM',
],
'experimentValue' => [
'description' => '实验值。',
'type' => 'string',
'example' => '300',
],
'hasConfig' => [
'description' => '是否有子配置项。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。',
'type' => 'boolean',
'example' => 'true',
],
'category' => [
'description' => '算法类目。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **RECALL**:召回。'."\n"
."\n"
.'- **RANK**:排序。',
'type' => 'string',
'example' => 'RECALL',
],
'name' => [
'description' => '实验名称。',
'type' => 'string',
'example' => 'name',
],
],
],
],
'buckets' => [
'description' => '分桶列表。',
'type' => 'array',
'items' => [
'description' => '分桶。',
'type' => 'string',
'example' => '["1","2","3"]',
],
],
'experimentId' => [
'description' => '实验ID。',
'type' => 'string',
'example' => '12345',
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"base\\": true,\\n \\"onlineTime\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"offlineTime\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"description\\": \\"xxx\\",\\n \\"status\\": \\"Init\\",\\n \\"name\\": \\"xxx\\",\\n \\"algorithms\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"config\\": [\\n {\\n \\"key\\": \\"I2I-truncedquantity\\",\\n \\"defaultValue\\": \\"400\\",\\n \\"experimentValue\\": \\"swing;commoni2i;pcategory;scategory\\",\\n \\"name\\": \\"I2I算法\\"\\n }\\n ],\\n \\"defaultValue\\": \\"i2i;u2x2i;new;hot;embedding;embedding\\",\\n \\"type\\": \\"SYSTEM\\",\\n \\"experimentValue\\": \\"300\\",\\n \\"hasConfig\\": true,\\n \\"category\\": \\"RECALL\\",\\n \\"name\\": \\"name\\"\\n }\\n ],\\n \\"buckets\\": [\\n \\"[\\\\\\"1\\\\\\",\\\\\\"2\\\\\\",\\\\\\"3\\\\\\"]\\"\\n ],\\n \\"experimentId\\": \\"12345\\"\\n },\\n \\"requestId\\": \\"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\"\\n}","errorExample":""},{"type":"xml","example":"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B","errorExample":""}]',
'title' => '克隆实验',
'summary' => '克隆实验。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListFlowControlTaskReports' => [
'summary' => '流量调控任务曝光分析。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}/flowTaskReports',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '155143',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1666697299358',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => 's时间戳(格式:yyyymmdd),如果'."\n"
.'不传,默认查询任务开始到t-1天统计数据与指标分析数据。',
'type' => 'string',
'required' => false,
'example' => '1666195200',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => 's时间戳(格式:yyyymmdd),最大值为t-1。',
'type' => 'string',
'required' => false,
'example' => '1668268800',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '16B78383-2803-4964-9605-37B30C073B0E',
],
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'total' => [
'description' => '指标统计数据。',
'type' => 'object',
'properties' => [
'accTaskCtr' => [
'description' => 'Ctr指标。',
'type' => 'number',
'format' => 'double',
'example' => '0.1',
],
'accTaskPv' => [
'description' => 'Pv指标。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'accTotalCtr' => [
'description' => '场景Ctr指标。',
'type' => 'number',
'format' => 'double',
'example' => '0.2',
],
'InvalidPercent' => [
'description' => '失效物品占比指标。',
'type' => 'number',
'format' => 'double',
'example' => '0.3',
],
],
],
'metrics' => [
'description' => '指标列表。',
'type' => 'array',
'items' => [
'description' => '指标详情。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '指标类型。',
'type' => 'string',
'example' => 'taskPv',
],
'details' => [
'description' => '数据列表。',
'type' => 'array',
'items' => [
'description' => '指标。',
'type' => 'object',
'properties' => [
'val' => [
'description' => '指标值。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'endTime' => [
'description' => '指标结束时间秒级时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1664035200',
],
'startTime' => [
'description' => '指标开始时间秒级时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1664000452',
],
],
],
],
],
],
],
],
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"16B78383-2803-4964-9605-37B30C073B0E\\",\\n \\"result\\": {\\n \\"total\\": {\\n \\"accTaskCtr\\": 0.1,\\n \\"accTaskPv\\": 1000,\\n \\"accTotalCtr\\": 0.2,\\n \\"InvalidPercent\\": 0.3\\n },\\n \\"metrics\\": [\\n {\\n \\"type\\": \\"taskPv\\",\\n \\"details\\": [\\n {\\n \\"val\\": 0,\\n \\"endTime\\": 1664035200,\\n \\"startTime\\": 1664000452\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16B78383-2803-4964-9605-37B30C073B0E\\n \\n \\n 1000\\n 0.2\\n 0.1\\n 0.2\\n 0.2\\n \\n \\n taskPv\\n \\n 0\\n 1588003200\\n 1588006800\\n 0\\n 0\\n \\n \\n 0\\n 1588089600\\n 1588093200\\n 0\\n 0\\n \\n \\n \\n totalPv\\n \\n 0\\n 1588003200\\n 1588006800\\n 0\\n 0\\n \\n \\n 0\\n 1588089600\\n 1588093200\\n 0\\n 0\\n \\n \\n \\n pvPercent\\n \\n 0\\n 1588003200\\n 1588006800\\n 0\\n 0\\n \\n \\n 0\\n 1588089600\\n 1588093200\\n 0\\n 0\\n \\n \\n \\n taskCtr\\n \\n 0\\n 1588003200\\n 1588006800\\n 0\\n 0\\n \\n \\n 0\\n 1588089600\\n 1588093200\\n 0\\n 0\\n \\n \\n \\n totalCtr\\n \\n 0\\n 1588003200\\n 1588006800\\n 0\\n 0\\n \\n \\n 0\\n 1588089600\\n 1588093200\\n 0\\n 0\\n \\n \\n \\n totalCount\\n \\n 0\\n 1588003200\\n 1588006800\\n 0\\n 0\\n \\n \\n 0\\n 1588089600\\n 1588093200\\n 0\\n 0\\n \\n \\n \\n invalidCount\\n \\n 0\\n 1588003200\\n 1588006800\\n 0\\n 0\\n \\n \\n 0\\n 1588089600\\n 1588093200\\n 0\\n 0\\n \\n \\n \\n","errorExample":""}]',
'title' => '流量调控任务曝光分析',
],
'ListFlowControlTaskInvalidItems' => [
'summary' => '查询当前流量调控任务中失效物品清单,返回物品ID(ItemId)与物品类型(ItemType)。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}/invalidItems',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '156202',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1661506482',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体参数。',
'type' => 'array',
'items' => [
'description' => 'ItemId与ItemType组合JSON。',
'type' => 'string',
'required' => false,
'example' => '[ { "itemId": "10", "itemType": "itemType" }, { "itemId": "10", "itemType": "itemType" } ]',
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'invalidItems' => [
'description' => '失效物品ItemId与ItemType清单。',
'type' => 'array',
'items' => [
'description' => '失效物品。',
'type' => 'object',
'properties' => [
'itemId' => [
'description' => '物品ID。',
'type' => 'string',
'example' => '287723',
],
'itemType' => [
'description' => '物品Type。',
'type' => 'string',
'example' => 'video',
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": [\\n {\\n \\"invalidItems\\": [\\n {\\n \\"itemId\\": \\"287723\\",\\n \\"itemType\\": \\"video\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 16B78383-2803-4964-9605-37B30C073B0E\\n \\n \\n itemId\\n 111111\\n \\n \\n","errorExample":""}]',
'title' => '查询失效物品清单',
],
'ListFlowControlTaskItems' => [
'summary' => '流量调控预览。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}/actions/items',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '155140',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1667369058068',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '分页,页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '分页查询时,设置的每页行数。最大值为500。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'totalCount' => [
'description' => '物品总条数。',
'type' => 'string',
'example' => '1',
],
'validCount' => [
'description' => '有效物品个数。',
'type' => 'string',
'example' => '1',
],
'detail' => [
'description' => '物品列表。',
'type' => 'array',
'items' => [
'description' => '物品信息。',
'type' => 'object',
'properties' => [
'author' => [
'description' => '作者。',
'type' => 'string',
'example' => 'zhangsan',
],
'duration' => [
'description' => '持续时间。',
'type' => 'string',
'example' => '18',
],
'itemId' => [
'description' => '物品ID。',
'type' => 'string',
'example' => '123',
],
'itemType' => [
'description' => '物品Type。',
'type' => 'string',
'example' => 'video',
],
'expireTime' => [
'description' => '过期时间。',
'type' => 'string',
'example' => '1612687809',
],
'categoryPath' => [
'description' => '类目路径。',
'type' => 'string',
'example' => '12_34',
],
'pubTime' => [
'description' => '发布时间。',
'type' => 'string',
'example' => '1661931487',
],
'lastModifyTime' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '1662346558',
],
'channel' => [
'description' => '频道。',
'type' => 'string',
'example' => 'news',
],
'weight' => [
'description' => '权重。',
'type' => 'string',
'example' => '10',
],
'title' => [
'description' => '标题。',
'type' => 'string',
'example' => 'test',
],
'status' => [
'description' => '物品状态。',
'type' => 'string',
'example' => '1',
],
],
],
],
],
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'Message' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": {\\n \\"totalCount\\": \\"1\\",\\n \\"validCount\\": \\"1\\",\\n \\"detail\\": [\\n {\\n \\"author\\": \\"zhangsan\\",\\n \\"duration\\": \\"18\\",\\n \\"itemId\\": \\"123\\",\\n \\"itemType\\": \\"video\\",\\n \\"expireTime\\": \\"1612687809\\",\\n \\"categoryPath\\": \\"12_34\\",\\n \\"pubTime\\": \\"1661931487\\",\\n \\"lastModifyTime\\": \\"1662346558\\",\\n \\"channel\\": \\"news\\",\\n \\"weight\\": \\"10\\",\\n \\"title\\": \\"test\\",\\n \\"status\\": \\"1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16B78383-2803-4964-9605-37B30C073B0E\\n \\n \\n -1\\n item1076848\\n video\\n 4102416000\\n none\\n none\\n 1661931487\\n 1662025185\\n none\\n 1\\n none\\n 1\\n \\n \\n -1\\n item8281501\\n image\\n 4102416000\\n none\\n none\\n 1661931487\\n 1662346558\\n none\\n 1\\n none\\n 1\\n \\n 19835\\n 19835\\n \\n","errorExample":""}]',
'title' => '流量调控预览',
],
'CreateFlowControlTask' => [
'summary' => '创建流控任务。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '154018',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'dryRun',
'in' => 'query',
'schema' => [
'description' => '是否为空运行请求。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:只检查参数正确。'."\n"
."\n"
.'- **false**:检查参数后执行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'taskId' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'example' => '1667297014460',
],
'gmtModified' => [
'description' => '实例最后更新时间,单位为UTC时间。'."\n",
'type' => 'string',
'example' => '2018-12-06T11:17:49.000Z',
],
'status' => [
'description' => '任务状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **DRAFT**:草稿。'."\n"
."\n"
.'- **READY**:待生效。'."\n"
."\n"
.'- **RUNNING**:运行中。'."\n"
."\n"
.'- **ENDED**:结束。',
'type' => 'string',
'example' => 'DRAFT',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
],
],
'code' => [
'description' => '状态码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'EDF43C1F-99E4-431F-A7C0-8B260A5A792E',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"taskId\\": \\"1667297014460\\",\\n \\"gmtModified\\": \\"2018-12-06T11:17:49.000Z\\",\\n \\"status\\": \\"DRAFT\\",\\n \\"gmtCreate\\": \\"2020-04-27T06:38:28.000Z\\"\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"EDF43C1F-99E4-431F-A7C0-8B260A5A792E\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n test\\n 这是一个测试任务\\n 1621267200\\n 1621267200\\n \\n \\n \\n \\n \\n 1,2,3\\n \\n EXPOSE_PERCENT\\n 50\\n \\n FlowControlTask\\n","errorExample":""}]',
'title' => '创建流量调控任务',
],
'GetFlowControlTask' => [
'summary' => '获取流量调控任务详情。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '155268',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1667979619806',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'gmtModified' => [
'description' => '最后修改数据源的UTC时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
'meta' => [
'description' => '流量调控Meta。',
'type' => 'object',
'properties' => [
'description' => [
'description' => '流量调控描述信息。',
'type' => 'string',
'example' => '用于首页推荐物品调控。',
],
'endTime' => [
'description' => '结束时间秒级时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1656518399',
],
'metaType' => [
'description' => '流量调控Meta类型,固定值FlowControlTask。',
'type' => 'string',
'example' => 'FlowControlTask',
],
'sceneIds' => [
'description' => '场景ID,支持多个,英文,分割即可。',
'type' => 'string',
'example' => '1,2,3',
],
'selectionParams' => [
'description' => '选品规则参数列表。',
'type' => 'array',
'items' => [
'description' => '选品规则参数。',
'type' => 'object',
'properties' => [
'selectType' => [
'description' => '选品规则过滤条件类型。',
'type' => 'string',
'example' => 'QUERY_PUB_TIME',
],
'selectValue' => [
'description' => '选品规则过滤条件具体数值。',
'type' => 'string',
'example' => '10000',
],
'selectionOperation' => [
'description' => '选品规则过滤条件操作。',
'type' => 'string',
'example' => 'OPERATOR_HIGHER',
],
],
],
],
'startTime' => [
'description' => '开始时间(秒级时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1640739600',
],
'target' => [
'description' => '曝光配置。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '曝光类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **EXPOSE_PERCENT**:每日曝光百分比。'."\n"
."\n"
.'- **EXPOSE_COUNT**:曝光总量。',
'type' => 'string',
'example' => 'EXPOSE_PERCENT',
],
'value' => [
'description' => '曝光值。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
],
],
'taskName' => [
'description' => '流量调控任务名称。',
'type' => 'string',
'example' => '曝光任务',
],
],
],
'status' => [
'description' => '任务状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **DRAFT**:草稿。'."\n"
."\n"
.'- **READY**:待生效。'."\n"
."\n"
.'- **RUNNING**:运行中。'."\n"
."\n"
.'- **ENDED**:结束。',
'type' => 'string',
'example' => 'DRAFT',
],
'taskId' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'example' => '1666854602398',
],
],
],
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": [\\n {\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"gmtModified\\": \\"2020-04-23T06:08:48.000Z\\",\\n \\"meta\\": {\\n \\"description\\": \\"用于首页推荐物品调控。\\",\\n \\"endTime\\": 1656518399,\\n \\"metaType\\": \\"FlowControlTask\\",\\n \\"sceneIds\\": \\"1,2,3\\",\\n \\"selectionParams\\": [\\n {\\n \\"selectType\\": \\"QUERY_PUB_TIME\\",\\n \\"selectValue\\": \\"10000\\",\\n \\"selectionOperation\\": \\"OPERATOR_HIGHER\\"\\n }\\n ],\\n \\"startTime\\": 1640739600,\\n \\"target\\": {\\n \\"type\\": \\"EXPOSE_PERCENT\\",\\n \\"value\\": 20\\n },\\n \\"taskName\\": \\"曝光任务\\"\\n },\\n \\"status\\": \\"DRAFT\\",\\n \\"taskId\\": \\"1666854602398\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取流量调控任务详情',
],
'DeleteFlowControlTask' => [
'summary' => '删除流量调控任务。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '154373',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1661506482',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '6E427B10-30FC-1873-922F-FC176D3398D4',
],
'result' => [
'description' => '返回参数。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
'code' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"6E427B10-30FC-1873-922F-FC176D3398D4\\",\\n \\"result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 8F81A922-6C81-46D6-B78C-CC35E16B1691\\n true\\n","errorExample":""}]',
'title' => '删除流量调控任务',
],
'ListFlowControlTask' => [
'summary' => '查询流控任务列表。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '155267',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'query',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1661506482',
],
],
[
'name' => 'status',
'in' => 'query',
'schema' => [
'description' => '任务状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **DRAFT**:草稿。'."\n"
."\n"
.'- **READY**:待生效。'."\n"
."\n"
.'- **RUNNING**:运行中。'."\n"
."\n"
.'- **ENDED**:结束。',
'type' => 'string',
'required' => false,
'example' => 'DRAFT',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '分页页数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '指定每页展示条数,默认为10,限制:[1-50]。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6E427B10-30FC-1873-922F-FC176D3398D4',
],
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'gmtCreate' => [
'description' => '创建时间,单位为UTC时间。',
'type' => 'string',
'example' => '2022-08-06T06:14:01.000Z',
],
'gmtModified' => [
'description' => '最后修改时间,单位为UTC时间。',
'type' => 'string',
'example' => '2022-08-06T06:14:01.000Z',
],
'meta' => [
'description' => '流量调控Meta。',
'type' => 'object',
'properties' => [
'description' => [
'description' => '流量调控描述信息。',
'type' => 'string',
'example' => '这是一个测试任务',
],
'endTime' => [
'description' => '结束时间秒级时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1621267200',
],
'metaType' => [
'description' => '流量调控Meta类型,固定值FlowControlTask。',
'type' => 'string',
'example' => 'metaType',
],
'sceneIds' => [
'description' => '场景ID,支持多个,英文,分割即可。',
'type' => 'string',
'example' => '1,2,3',
],
'selectionParams' => [
'description' => '选品规则参数列表。',
'type' => 'array',
'items' => [
'description' => '选品规则参数。',
'type' => 'object',
'properties' => [
'selectType' => [
'description' => '选品规则过滤条件类型。',
'type' => 'string',
'example' => 'selectType',
],
'selectValue' => [
'description' => '选品规则过滤条件具体数值。',
'type' => 'string',
'example' => 'selectValue',
],
'selectionOperation' => [
'description' => '选品规则过滤条件操作。',
'type' => 'string',
'example' => 'selectionOperation',
],
],
],
],
'startTime' => [
'description' => '开始时间秒级时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1621267200',
],
'target' => [
'description' => '曝光配置。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '曝光类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **EXPOSE_PERCENT**:每日曝光百分比。'."\n"
."\n"
.'- **EXPOSE_COUNT**:曝光总量。',
'type' => 'string',
'example' => 'EXPOSE_PERCENT',
],
'value' => [
'description' => '曝光值。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
],
],
'taskName' => [
'description' => '流量调控任务名称。',
'type' => 'string',
'example' => 'testtaskname',
],
],
],
'status' => [
'description' => '任务状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **DRAFT**:草稿。'."\n"
."\n"
.'- **READY**:待生效。'."\n"
."\n"
.'- **RUNNING**:运行中。'."\n"
."\n"
.'- **ENDED**:结束。',
'type' => 'string',
'example' => 'DRAFT',
],
'TaskId' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'example' => '1661506482',
],
],
],
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"6E427B10-30FC-1873-922F-FC176D3398D4\\",\\n \\"result\\": [\\n {\\n \\"gmtCreate\\": \\"2022-08-06T06:14:01.000Z\\",\\n \\"gmtModified\\": \\"2022-08-06T06:14:01.000Z\\",\\n \\"meta\\": {\\n \\"description\\": \\"这是一个测试任务\\",\\n \\"endTime\\": 1621267200,\\n \\"metaType\\": \\"metaType\\",\\n \\"sceneIds\\": \\"1,2,3\\",\\n \\"selectionParams\\": [\\n {\\n \\"selectType\\": \\"selectType\\",\\n \\"selectValue\\": \\"selectValue\\",\\n \\"selectionOperation\\": \\"selectionOperation\\"\\n }\\n ],\\n \\"startTime\\": 1621267200,\\n \\"target\\": {\\n \\"type\\": \\"EXPOSE_PERCENT\\",\\n \\"value\\": 50\\n },\\n \\"taskName\\": \\"testtaskname\\"\\n },\\n \\"status\\": \\"DRAFT\\",\\n \\"TaskId\\": \\"1661506482\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 8F81A922-6C81-46D6-B78C-CC35E16B1691\\n \\n \\n test\\n 这是一个测试任务\\n 1621267200\\n 1621267200\\n \\n \\n \\n \\n \\n 1,2,3\\n \\n EXPOSE_PERCENT\\n 50\\n \\n \\n 1661506482\\n DRAFT\\n 2022-08-06T06:14:01.000Z\\n 2022-08-06T11:17:49.000Z\\n \\n \\n 1\\n \\n","errorExample":""}]',
'title' => '获取流量调控任务列表,按照创建时间倒序返回',
],
'ListFlowControlTaskItemReports' => [
'summary' => '流量调控曝光排名物品/失效物品查询。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}/itemReports',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '155145',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1666854493104',
],
],
[
'name' => 'selectTimeType',
'in' => 'query',
'schema' => [
'description' => '查询时间段,如果selectType=invalidItem,则只支持yesterDay。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **yesterDay**:昨天。'."\n"
."\n"
.'- **lastSevenDays**:最近7天。'."\n"
."\n"
.'- **lastFifteenDays**:最近15天。',
'type' => 'string',
'required' => false,
'example' => 'yesterDay',
],
],
[
'name' => 'selectType',
'in' => 'query',
'schema' => [
'description' => '查询数据类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **topExposeItem**:曝光排名物品。'."\n"
."\n"
.'- **invalidItem**:失效物品。',
'type' => 'string',
'required' => false,
'example' => 'invalidItem',
],
],
[
'name' => 'count',
'in' => 'query',
'schema' => [
'description' => '当selectType="topItem",count 代表查询TOP前xx个物品,默认10'."\n"
.'当selectType="invalidItem",count 代表查询失效物品个数,默认10个。',
'type' => 'string',
'required' => false,
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D486768B-8BF8-4D80-B491-43DC3D0AF8AB',
],
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'detail' => [
'description' => '数据列表。',
'type' => 'array',
'items' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'taskId' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'example' => '1666669577221',
],
'itemId' => [
'description' => '物品ID。',
'type' => 'string',
'example' => '123',
],
'itemType' => [
'description' => '物品Type。',
'type' => 'string',
'example' => 'video',
],
'taskRank' => [
'description' => '当天曝光量排名。',
'type' => 'string',
'example' => '12',
],
'itemPv' => [
'description' => '物品当天曝光量。',
'type' => 'string',
'example' => '100',
],
'taskPv' => [
'description' => '任务当天曝光量。',
'type' => 'string',
'example' => '50',
],
'pvPercent' => [
'description' => '物品当天曝光占比。',
'type' => 'string',
'example' => '10.12',
],
'itemClick' => [
'description' => '物品当天点击量。',
'type' => 'string',
'example' => '100',
],
'taskClick' => [
'description' => '任务当天点击量。',
'type' => 'string',
'example' => '100',
],
'clickPercent' => [
'description' => '物品当天点击占比。',
'type' => 'string',
'example' => '1.23',
],
'itemCtr' => [
'description' => '物品当天点击率。',
'type' => 'string',
'example' => '2.34',
],
'taskCtr' => [
'description' => '任务当天点击率。',
'type' => 'string',
'example' => '1.23',
],
'accTaskRank' => [
'description' => '累计曝光量排名。',
'type' => 'string',
'example' => '10',
],
'accItemPv' => [
'description' => '物品累计曝光量。',
'type' => 'string',
'example' => '500',
],
'accTaskPv' => [
'description' => '任务累计曝光量。',
'type' => 'string',
'example' => '200',
],
'accPvPercent' => [
'description' => '物品累计曝光占比。',
'type' => 'string',
'example' => '20.12',
],
'accItemClick' => [
'description' => '物品累计点击量。',
'type' => 'string',
'example' => '1000',
],
'accTaskClick' => [
'description' => '任务累计点击量。',
'type' => 'string',
'example' => '600',
],
'accClickPercent' => [
'description' => '物品累计点击占比。',
'type' => 'string',
'example' => '3.24',
],
'accItemCtr' => [
'description' => '物品累计点击率。',
'type' => 'string',
'example' => '4.56',
],
'accTaskCtr' => [
'description' => '任务累计点击率。',
'type' => 'string',
'example' => '3.22',
],
],
],
],
],
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
'code' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D486768B-8BF8-4D80-B491-43DC3D0AF8AB\\",\\n \\"result\\": {\\n \\"detail\\": [\\n {\\n \\"taskId\\": \\"1666669577221\\",\\n \\"itemId\\": \\"123\\",\\n \\"itemType\\": \\"video\\",\\n \\"taskRank\\": \\"12\\",\\n \\"itemPv\\": \\"100\\",\\n \\"taskPv\\": \\"50\\",\\n \\"pvPercent\\": \\"10.12\\",\\n \\"itemClick\\": \\"100\\",\\n \\"taskClick\\": \\"100\\",\\n \\"clickPercent\\": \\"1.23\\",\\n \\"itemCtr\\": \\"2.34\\",\\n \\"taskCtr\\": \\"1.23\\",\\n \\"accTaskRank\\": \\"10\\",\\n \\"accItemPv\\": \\"500\\",\\n \\"accTaskPv\\": \\"200\\",\\n \\"accPvPercent\\": \\"20.12\\",\\n \\"accItemClick\\": \\"1000\\",\\n \\"accTaskClick\\": \\"600\\",\\n \\"accClickPercent\\": \\"3.24\\",\\n \\"accItemCtr\\": \\"4.56\\",\\n \\"accTaskCtr\\": \\"3.22\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16B78383-2803-4964-9605-37B30C073B0E\\n \\n \\n 111111\\n itemId\\n itemType\\n title\\n 人文关怀\\n 张三\\n 渠道\\n 121\\n 111\\n 12\\n 100\\n 50\\n 10.12\\n 100\\n 100\\n 1.23\\n 2.34\\n 1.56\\n 10\\n 500\\n 200\\n 20.12\\n 500\\n 300\\n 3.24\\n 4.56\\n 3.22\\n \\n \\n 111111\\n itemId\\n itemType\\n 12\\n 100\\n 50\\n 10.12\\n 100\\n 100\\n 1.23\\n 2.34\\n 1.56\\n 10\\n 500\\n 200\\n 20.12\\n 500\\n 300\\n 3.24\\n 4.56\\n 3.22\\n \\n \\n","errorExample":""}]',
'title' => '流量调控曝光排名物品/失效物品查询',
],
'ListFlowControlTaskReference' => [
'summary' => '流量调控参考数据。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}/reference',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '155137',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1666670046687',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'last7PvPercent' => [
'description' => '最近7天物品池平均曝光占比。',
'type' => 'number',
'format' => 'double',
'example' => '0.1',
],
'last7ScenePv' => [
'description' => '最近7天场景平均曝光。',
'type' => 'number',
'format' => 'double',
'example' => '10',
],
'last7TaskPv' => [
'description' => '最近7天物品池在选中场景平均曝光。',
'type' => 'number',
'format' => 'double',
'example' => '10',
],
'lastPvPercent' => [
'description' => '昨天物品池曝光占比。',
'type' => 'number',
'format' => 'double',
'example' => '0.1',
],
'lastScenePv' => [
'description' => '昨天场景总曝光。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'lastTaskPv' => [
'description' => '昨天物品池在选中场景内曝光。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'referenceId' => [
'description' => '预览ID。',
'type' => 'string',
'example' => '421351235918',
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"last7PvPercent\\": 0.1,\\n \\"last7ScenePv\\": 10,\\n \\"last7TaskPv\\": 10,\\n \\"lastPvPercent\\": 0.1,\\n \\"lastScenePv\\": 10,\\n \\"lastTaskPv\\": 10,\\n \\"referenceId\\": \\"421351235918\\"\\n },\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 16B78383-2803-4964-9605-37B30C073B0E\\n \\n 421351235918\\n 10\\n 10\\n 0.1\\n 10\\n 10\\n 0.1\\n \\n","errorExample":""}]',
'title' => '流量调控参考数据',
],
'ModifyFlowControlTask' => [
'summary' => '流调任务修改接口。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '154309',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1667297014460',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body参数。',
'type' => 'object',
'properties' => [
'TaskName' => [
'description' => '流量调控任务名称。',
'type' => 'string',
'required' => false,
'example' => 'testname',
],
'description' => [
'description' => '流量调控描述信息。',
'type' => 'string',
'required' => false,
'example' => '描述',
],
'endTime' => [
'description' => '结束时间秒级时间戳。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1639519200',
],
'metaType' => [
'description' => '流量调控Meta类型,固定值FlowControlTask。',
'type' => 'string',
'required' => false,
'example' => 'FlowControlTask',
],
'sceneIds' => [
'description' => '场景ID,支持多个,英文,分割即可。',
'type' => 'string',
'required' => false,
'example' => 'all,sy101',
],
'selectionParams' => [
'description' => '选品规则参数列表。',
'type' => 'array',
'items' => [
'description' => '选品规则参数。',
'type' => 'object',
'properties' => [
'selectType' => [
'description' => '选品规则过滤条件类型。',
'type' => 'string',
'required' => false,
'example' => 'invalidItem',
],
'selectValue' => [
'description' => '选品规则过滤条件具体数值。',
'type' => 'string',
'required' => false,
'example' => '20',
],
'selectionOperation' => [
'description' => '选品规则过滤条件操作。',
'type' => 'string',
'required' => false,
'example' => 'OPERATOR_HIGHER',
],
],
'required' => false,
],
'required' => false,
],
'startTime' => [
'description' => '开始时间(秒级时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1638460800',
],
'target' => [
'description' => '物品曝光配置。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '曝光类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **EXPOSE_PERCENT**:每日曝光百分比。'."\n"
."\n"
.'- **EXPOSE_COUNT**:曝光总量。',
'type' => 'string',
'required' => false,
'example' => 'EXPOSE_PERCENT',
],
'value' => [
'description' => '曝光值。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '50',
],
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'gmtModified' => [
'description' => '最后修改数据源的UTC时间。',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'meta' => [
'description' => '流量调控Meta。',
'type' => 'object',
'properties' => [
'description' => [
'description' => '流量调控描述信息。',
'type' => 'string',
'example' => 'tst',
],
'endTime' => [
'description' => '结束时间秒级时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1656518399',
],
'metaType' => [
'description' => '流量调控Meta类型,固定值FlowControlTask。',
'type' => 'string',
'example' => 'FlowControlTask',
],
'sceneIds' => [
'description' => '场景ID,支持多个,英文,分割即可。',
'type' => 'string',
'example' => '1,2,3',
],
'selectionParams' => [
'description' => '选品规则参数列表。',
'type' => 'array',
'items' => [
'description' => '选品规则参数。',
'type' => 'object',
'properties' => [
'selectType' => [
'description' => '选品规则过滤条件类型。',
'type' => 'string',
'example' => 'QUERY_PUB_TIME',
],
'selectValue' => [
'description' => '选品规则过滤条件具体数值。',
'type' => 'string',
'example' => '10000',
],
'selectionOperation' => [
'description' => '选品规则过滤条件操作。',
'type' => 'string',
'example' => 'OPERATOR_HIGHER',
],
],
],
],
'startTime' => [
'description' => '开始时间(秒级时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1640739600',
],
'target' => [
'description' => '曝光配置。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '曝光类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **EXPOSE_PERCENT**:每日曝光百分比。'."\n"
."\n"
.'- **EXPOSE_COUNT**:曝光总量。',
'type' => 'string',
'example' => 'EXPOSE_PERCENT',
],
'value' => [
'description' => '曝光值。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
],
],
'taskName' => [
'description' => '流量调侃任务名称。',
'type' => 'string',
'example' => '活动用户测试',
],
],
],
'status' => [
'description' => '任务状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **DRAFT**:草稿。'."\n"
."\n"
.'- **READY**:待生效。'."\n"
."\n"
.'- **RUNNING**:运行中。'."\n"
."\n"
.'- **ENDED**:结束。',
'type' => 'string',
'example' => 'DRAFT',
],
'TaskId' => [
'description' => '流量调侃任务ID。',
'type' => 'string',
'example' => '1661506482',
],
],
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": {\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"gmtModified\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"meta\\": {\\n \\"description\\": \\"tst\\",\\n \\"endTime\\": 1656518399,\\n \\"metaType\\": \\"FlowControlTask\\",\\n \\"sceneIds\\": \\"1,2,3\\",\\n \\"selectionParams\\": [\\n {\\n \\"selectType\\": \\"QUERY_PUB_TIME\\",\\n \\"selectValue\\": \\"10000\\",\\n \\"selectionOperation\\": \\"OPERATOR_HIGHER\\"\\n }\\n ],\\n \\"startTime\\": 1640739600,\\n \\"target\\": {\\n \\"type\\": \\"EXPOSE_PERCENT\\",\\n \\"value\\": 20\\n },\\n \\"taskName\\": \\"活动用户测试\\"\\n },\\n \\"status\\": \\"DRAFT\\",\\n \\"TaskId\\": \\"1661506482\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n test\\n 这是一个测试任务\\n 1621267200\\n 1621267200\\n \\n \\n \\n \\n \\n 1,2,3\\n \\n EXPOSE_PERCENT\\n 50\\n \\n FlowControlTask\\n","errorExample":""}]',
'title' => '修改流量控制任务,目前只支持草稿态和发布失败状态的任务修改配置信息',
],
'StopFlowControlTask' => [
'summary' => '结束流量调控任务。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}/actions/stop',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '154378',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1666854602398',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'description' => '返回参数。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
'code' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 8F81A922-6C81-46D6-B78C-CC35E16B1691\\n true\\n","errorExample":""}]',
'title' => '结束流量调控任务',
],
'PublishFlowControlTask' => [
'summary' => '发布流量调控任务。',
'path' => '/v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}/actions/publish',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '154377',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'description' => '流量调控任务ID。',
'type' => 'string',
'required' => false,
'example' => '1666669577221',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'description' => '返回参数。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
500 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
'code' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 8F81A922-6C81-46D6-B78C-CC35E16B1691\\n true\\n","errorExample":""}]',
'title' => '发布流量调控任务',
],
'CreateFilteringAlgorithm' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '18665',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'dryRun',
'in' => 'query',
'schema' => [
'description' => '是否预检参数。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:不会真实执行。'."\n"
."\n"
.'- **false**:会直接执行。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '召回表信息。',
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后更新时间,单位为UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'status' => [
'description' => '表示单签召回表的状态。 '."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
."\n"
.'- **Running**:运行中。'."\n"
."\n"
.'- **Offline**:已下线。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Running',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'algorithmId' => [
'description' => '召回表ID。',
'type' => 'string',
'example' => 'abc',
],
'meta' => [
'description' => 'Meta源数据。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '数据源类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'ODPS',
],
'extInfo' => [
'description' => '召回表类型包含内容。',
'type' => 'object',
'example' => '{}',
],
'category' => [
'description' => '数据源召回类目。',
'type' => 'string',
'example' => '1_2',
],
'threshold' => [
'description' => 'Table的阈值信息。',
'type' => 'object',
'properties' => [
'sourceDataSizeThreshold' => [
'description' => '源数据大小波动阈值(0-100)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'sourceDataRecordThreshold' => [
'description' => '源数据条目数波动阈值(0-100)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexSizeThreshold' => [
'description' => '索引大小波动阈值(0-100)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexLossThreshold' => [
'description' => '索引丢失阈值(0-100)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'status' => [
'description' => '表示单签召回表的状态。 '."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
."\n"
.'- **Running**:运行中。'."\n"
."\n"
.'- **Offline**:已下线。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Running',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'tableName' => [
'description' => 'ODPS召回表名称。',
'type' => 'string',
'example' => 'table_test',
],
'cron' => [
'description' => '定时调度任务Cron。',
'type' => 'string',
'example' => '0 0/12 0 * *',
],
'description' => [
'description' => '描述。',
'type' => 'string',
'example' => 'xx',
],
'gmtModified' => [
'description' => '最后修改时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'projectName' => [
'description' => 'ODPS中的ProjectName。',
'type' => 'string',
'example' => 'testname',
],
'algorithmName' => [
'description' => '召回名称。',
'type' => 'string',
'example' => 'algorithmTest',
],
'cronEnabled' => [
'description' => '是否开启定时任务。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'requestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"status\\": \\"Running\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"algorithmId\\": \\"abc\\",\\n \\"meta\\": {\\n \\"type\\": \\"ODPS\\",\\n \\"extInfo\\": {},\\n \\"category\\": \\"1_2\\",\\n \\"threshold\\": {\\n \\"sourceDataSizeThreshold\\": 1,\\n \\"sourceDataRecordThreshold\\": 1,\\n \\"indexSizeThreshold\\": 1,\\n \\"indexLossThreshold\\": 1\\n },\\n \\"status\\": \\"Running\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"tableName\\": \\"table_test\\",\\n \\"cron\\": \\"0 0/12 0 * *\\",\\n \\"description\\": \\"xx\\",\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"projectName\\": \\"testname\\",\\n \\"algorithmName\\": \\"algorithmTest\\",\\n \\"cronEnabled\\": true\\n }\\n },\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '创建召回表',
'summary' => '创建召回表,目前召回表由PAI训练完成导出到odps中,在AIRec中指定ODPS表信息。',
],
'DeleteFilteringAlgorithm' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '18673',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '指定的召回ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '召回表信息。',
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后更新时间,单位为UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'status' => [
'description' => '表示单签召回表的状态。 '."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
."\n"
.'- **Running**:运行中。'."\n"
."\n"
.'- **Offline**:已下线。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Running',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'algorithmId' => [
'description' => '指定的召回ID。',
'type' => 'string',
'example' => '123',
],
'meta' => [
'description' => 'Meta源数据。',
'type' => 'object',
'properties' => [
'taskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'test01',
],
'metaType' => [
'description' => '算法类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'odps',
],
'type' => [
'description' => '数据源类型,当前只支持ODPS。'."\n",
'type' => 'string',
'example' => 'ODPS',
],
'extInfo' => [
'description' => '召回表类型包含内容。',
'type' => 'object',
'properties' => [
'kvSeparator' => [
'description' => 'kv分隔符。',
'type' => 'string',
'example' => ';',
],
'itemSeparator' => [
'description' => 'Item分隔符。',
'type' => 'string',
'example' => ';',
],
],
],
'category' => [
'description' => '召回类别。',
'type' => 'string',
'example' => 'i2i',
],
'threshold' => [
'description' => 'Table的阈值信息。',
'type' => 'object',
'properties' => [
'sourceDataSizeThreshold' => [
'description' => '源数据大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'sourceDataRecordThreshold' => [
'description' => '源数据条目数波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexSizeThreshold' => [
'description' => '索引大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexLossThreshold' => [
'description' => '索引丢失阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'tableName' => [
'description' => 'ODPS召回表名称。',
'type' => 'string',
'example' => 'table01',
],
'clusterId' => [
'description' => '集群ID。',
'type' => 'string',
'example' => '1001',
],
'cron' => [
'description' => '定时调度任务Cron。',
'type' => 'string',
'example' => '0 0/12 0 * *',
],
'description' => [
'description' => '描述。',
'type' => 'string',
'example' => '训练任务',
],
'projectName' => [
'description' => 'ODPS中的ProjectName。',
'type' => 'string',
'example' => 'name01',
],
'algorithmName' => [
'description' => '召回名称。',
'type' => 'string',
'example' => 'user',
],
'cronEnabled' => [
'description' => '是否开启定时任务。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'requestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '936BE457-5D14-4DBD-85AE-176F7BA8D96D',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"status\\": \\"Running\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"algorithmId\\": \\"123\\",\\n \\"meta\\": {\\n \\"taskId\\": \\"test01\\",\\n \\"metaType\\": \\"odps\\",\\n \\"type\\": \\"ODPS\\",\\n \\"extInfo\\": {\\n \\"kvSeparator\\": \\";\\",\\n \\"itemSeparator\\": \\";\\"\\n },\\n \\"category\\": \\"i2i\\",\\n \\"threshold\\": {\\n \\"sourceDataSizeThreshold\\": 1,\\n \\"sourceDataRecordThreshold\\": 1,\\n \\"indexSizeThreshold\\": 1,\\n \\"indexLossThreshold\\": 1\\n },\\n \\"tableName\\": \\"table01\\",\\n \\"clusterId\\": \\"1001\\",\\n \\"cron\\": \\"0 0/12 0 * *\\",\\n \\"description\\": \\"训练任务\\",\\n \\"projectName\\": \\"name01\\",\\n \\"algorithmName\\": \\"user\\",\\n \\"cronEnabled\\": true\\n }\\n },\\n \\"requestId\\": \\"936BE457-5D14-4DBD-85AE-176F7BA8D96D\\"\\n}","errorExample":""},{"type":"xml","example":"abc\\n2018-12-07t02:24:26.000z\\n2018-12-07t02:24:26.000z\\n\\n user\\n i2i\\n 00***\\n \\n ,\\n ;\\n \\n \\n triggeritemId\\n abc\\n \\n \\n targeitemId\\n def\\n \\n \\n weight\\n ade\\n \\n \\n openrecGray\\n userFakeAna\\n odps\\n","errorExample":""}]',
'title' => '删除召回表',
'summary' => '删除指定的召回配置及相关索引表信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyFilteringAlgorithmMeta' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/meta',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18720',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '指定的召回ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '召回表信息。',
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后更新时间,单位为UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'status' => [
'description' => '表示单签召回表的状态。 '."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
."\n"
.'- **Running**:运行中。'."\n"
."\n"
.'- **Offline**:已下线。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Running',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'algorithmId' => [
'description' => '指定的召回ID。',
'type' => 'string',
'example' => 'abc',
],
'meta' => [
'description' => 'Meta源数据。',
'type' => 'object',
'properties' => [
'taskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'taskId',
],
'metaType' => [
'description' => '算法类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'metaType',
],
'type' => [
'description' => '数据源类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'ODPS',
],
'extInfo' => [
'description' => '召回表类型包含内容。',
'type' => 'object',
'properties' => [
'kvSeparator' => [
'description' => 'kv分隔符。',
'type' => 'string',
'example' => ':',
],
'itemSeparator' => [
'description' => 'Item分隔符。',
'type' => 'string',
'example' => ',',
],
],
],
'category' => [
'description' => '召回类别。',
'type' => 'string',
'example' => '1_2',
],
'threshold' => [
'description' => 'ODPS表的阈值配置信息。',
'type' => 'object',
'properties' => [
'sourceDataSizeThreshold' => [
'description' => '源数据大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'sourceDataRecordThreshold' => [
'description' => '源数据条目数波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexSizeThreshold' => [
'description' => '索引大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexLossThreshold' => [
'description' => '索引丢失阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'tableName' => [
'description' => 'ODPS召回表名称。',
'type' => 'string',
'example' => 'test_table',
],
'clusterId' => [
'description' => '集群ID。',
'type' => 'string',
'example' => '244',
],
'cron' => [
'description' => '定时调度任务Cron。',
'type' => 'string',
'example' => '* * 24 7 0',
],
'description' => [
'description' => '召回算法配置描述。',
'type' => 'string',
'example' => 'test',
],
'projectName' => [
'description' => 'ODPS中的ProjectName。',
'type' => 'string',
'example' => 'test',
],
'algorithmName' => [
'description' => '召回算法配置名称。',
'type' => 'string',
'example' => 'test',
],
'cronEnabled' => [
'description' => '是否开启定时启动实验任务配置。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:开启。'."\n"
."\n"
.'- **false**:关闭。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'requestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '7585C2B2-0D61-4C96-AC5D-B960BFEDD4A3',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"status\\": \\"Running\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"algorithmId\\": \\"abc\\",\\n \\"meta\\": {\\n \\"taskId\\": \\"taskId\\",\\n \\"metaType\\": \\"metaType\\",\\n \\"type\\": \\"ODPS\\",\\n \\"extInfo\\": {\\n \\"kvSeparator\\": \\":\\",\\n \\"itemSeparator\\": \\",\\"\\n },\\n \\"category\\": \\"1_2\\",\\n \\"threshold\\": {\\n \\"sourceDataSizeThreshold\\": 1,\\n \\"sourceDataRecordThreshold\\": 1,\\n \\"indexSizeThreshold\\": 1,\\n \\"indexLossThreshold\\": 1\\n },\\n \\"tableName\\": \\"test_table\\",\\n \\"clusterId\\": \\"244\\",\\n \\"cron\\": \\"* * 24 7 0\\",\\n \\"description\\": \\"test\\",\\n \\"projectName\\": \\"test\\",\\n \\"algorithmName\\": \\"test\\",\\n \\"cronEnabled\\": true\\n }\\n },\\n \\"requestId\\": \\"7585C2B2-0D61-4C96-AC5D-B960BFEDD4A3\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => 'ModifyFilteringAlgorithmMeta',
'summary' => '修改召回表的配置。',
'description' => '可修改的配置有:'."\n"
.'● cron、cronEnabled'."\n"
.'● description'."\n"
.'● algorithmName'."\n"
.'● threshold:注意,如果要修改ODPS表的阈值配置信息,必须全量提交,不支持只传入ODPS表的阈值配置信息下边的某一项。',
],
'DescribeFilteringAlgorithm' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18682',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '指定的召回表ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'abc',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '召回表信息。',
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后更新时间,单位为UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'status' => [
'description' => '表示单签召回表的状态。 '."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
."\n"
.'- **Running**:运行中。'."\n"
."\n"
.'- **Offline**:已下线。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Draft',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'algorithmId' => [
'description' => '指定的召回ID。',
'type' => 'string',
'example' => 'abc',
],
'meta' => [
'description' => 'Meta源数据。',
'type' => 'object',
'properties' => [
'taskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'taskId',
],
'metaType' => [
'description' => '算法类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'metaType',
],
'type' => [
'description' => '数据源类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'ODPS',
],
'extInfo' => [
'description' => '召回表类型包含内容。',
'type' => 'object',
'properties' => [
'kvSeparator' => [
'description' => 'kv分隔符。',
'type' => 'string',
'example' => ':',
],
'itemSeparator' => [
'description' => 'Item分隔符。',
'type' => 'string',
'example' => ',',
],
],
],
'category' => [
'description' => '召回类别。',
'type' => 'string',
'example' => '1_2',
],
'threshold' => [
'description' => 'Table的阈值信息。',
'type' => 'object',
'properties' => [
'sourceDataSizeThreshold' => [
'description' => '源数据大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'sourceDataRecordThreshold' => [
'description' => '源数据条目数波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexSizeThreshold' => [
'description' => '索引大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexLossThreshold' => [
'description' => '索引丢失阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'tableName' => [
'description' => 'ODPS召回表名称。',
'type' => 'string',
'example' => 'test_table',
],
'clusterId' => [
'description' => '集群ID。',
'type' => 'string',
'example' => '244',
],
'cron' => [
'description' => '定时调度任务Cron。',
'type' => 'string',
'example' => '* * 24 7 0',
],
'description' => [
'description' => '描述。',
'type' => 'string',
'example' => 'test',
],
'projectName' => [
'description' => 'ODPS中的ProjectName。',
'type' => 'string',
'example' => 'test',
],
'algorithmName' => [
'description' => '算法名称。',
'type' => 'string',
'example' => 'test',
],
'cronEnabled' => [
'description' => '是否开启定时任务。',
'type' => 'boolean',
'example' => 'Y',
],
],
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7585C2B2-0D61-4C96-AC5D-B960BFEDD4A3',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"status\\": \\"Draft\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"algorithmId\\": \\"abc\\",\\n \\"meta\\": {\\n \\"taskId\\": \\"taskId\\",\\n \\"metaType\\": \\"metaType\\",\\n \\"type\\": \\"ODPS\\",\\n \\"extInfo\\": {\\n \\"kvSeparator\\": \\":\\",\\n \\"itemSeparator\\": \\",\\"\\n },\\n \\"category\\": \\"1_2\\",\\n \\"threshold\\": {\\n \\"sourceDataSizeThreshold\\": 1,\\n \\"sourceDataRecordThreshold\\": 1,\\n \\"indexSizeThreshold\\": 1,\\n \\"indexLossThreshold\\": 1\\n },\\n \\"tableName\\": \\"test_table\\",\\n \\"clusterId\\": \\"244\\",\\n \\"cron\\": \\"* * 24 7 0\\",\\n \\"description\\": \\"test\\",\\n \\"projectName\\": \\"test\\",\\n \\"algorithmName\\": \\"test\\",\\n \\"cronEnabled\\": true\\n }\\n },\\n \\"requestId\\": \\"7585C2B2-0D61-4C96-AC5D-B960BFEDD4A3\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取召回表',
'summary' => '根据指定召回表ID 获取某个召回配置信息。',
],
'ListFilteringAlgorithms' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18703',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'status',
'in' => 'query',
'schema' => [
'description' => '表示单签召回表的状态。 '."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
."\n"
.'- **Running**:运行中。'."\n"
."\n"
.'- **Offline**:已下线。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'Running',
],
],
[
'name' => 'algorithmId',
'in' => 'query',
'schema' => [
'description' => '召回表ID。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '123',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '召回表分页。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '召回表大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '召回表信息。',
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后更新时间,单位为UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'status' => [
'description' => '表示单签召回表的状态。 '."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
."\n"
.'- **Running**:运行中。'."\n"
."\n"
.'- **Offline**:已下线。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Running',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'algorithmId' => [
'description' => '指定的召回ID。',
'type' => 'string',
'example' => '123',
],
'meta' => [
'description' => 'Meta源数据。',
'type' => 'object',
'properties' => [
'taskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '123',
],
'metaType' => [
'description' => '算法类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'ODPS',
],
'type' => [
'description' => '数据源类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'odps',
],
'extInfo' => [
'description' => '召回表类型包含内容。',
'type' => 'object',
'properties' => [
'kvSeparator' => [
'description' => 'kv分隔符。',
'type' => 'string',
'example' => ':',
],
'itemSeparator' => [
'description' => 'Item分隔符。',
'type' => 'string',
'example' => ',',
],
],
],
'category' => [
'description' => '召回类别。',
'type' => 'string',
'example' => 'odps',
],
'threshold' => [
'description' => 'Table的阈值信息。',
'type' => 'object',
'properties' => [
'sourceDataSizeThreshold' => [
'description' => '源数据大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'sourceDataRecordThreshold' => [
'description' => '源数据条目数波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexSizeThreshold' => [
'description' => '索引大小阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexLossThreshold' => [
'description' => '索引丢失阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'tableName' => [
'description' => 'ODPS召回表名称。',
'type' => 'string',
'example' => 'item',
],
'clusterId' => [
'description' => '集群ID。',
'type' => 'string',
'example' => '123',
],
'cron' => [
'description' => '定时调度任务Cron。',
'type' => 'string',
'example' => '0 0/12 0 * *',
],
'description' => [
'description' => '描述。',
'type' => 'string',
'example' => 'test',
],
'projectName' => [
'description' => 'ODPS中的ProjectName。',
'type' => 'string',
'example' => 'airec123',
],
'algorithmName' => [
'description' => '算法名称。',
'type' => 'string',
'example' => 'test',
],
'cronEnabled' => [
'description' => '是否开启定时任务。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
'headers' => [
'description' => '显示header信息,目前有count在map中。',
'type' => 'object',
'properties' => [
'X-Total-Count' => [
'description' => '总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7585C2B2-0D61-4C96-AC5D-B960BFEDD4A3',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"status\\": \\"Running\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"algorithmId\\": \\"123\\",\\n \\"meta\\": {\\n \\"taskId\\": \\"123\\",\\n \\"metaType\\": \\"ODPS\\",\\n \\"type\\": \\"odps\\",\\n \\"extInfo\\": {\\n \\"kvSeparator\\": \\":\\",\\n \\"itemSeparator\\": \\",\\"\\n },\\n \\"category\\": \\"odps\\",\\n \\"threshold\\": {\\n \\"sourceDataSizeThreshold\\": 1,\\n \\"sourceDataRecordThreshold\\": 1,\\n \\"indexSizeThreshold\\": 1,\\n \\"indexLossThreshold\\": 1\\n },\\n \\"tableName\\": \\"item\\",\\n \\"clusterId\\": \\"123\\",\\n \\"cron\\": \\"0 0/12 0 * *\\",\\n \\"description\\": \\"test\\",\\n \\"projectName\\": \\"airec123\\",\\n \\"algorithmName\\": \\"test\\",\\n \\"cronEnabled\\": true\\n }\\n }\\n ],\\n \\"headers\\": {\\n \\"X-Total-Count\\": 12\\n },\\n \\"requestId\\": \\"7585C2B2-0D61-4C96-AC5D-B960BFEDD4A3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 12\\n\\n7585c2b2-0d61-4c96-ac5d-b960bfedd4a3\\n\\n abc\\n 2018-12-07t02:24:26.000z\\n 2018-12-07t02:24:26.000z\\n \\n user\\n i2i\\n 00***\\n \\n ,\\n ;\\n \\n \\n triggeritemId\\n abc\\n \\n \\n targeitemId\\n def\\n \\n \\n weight\\n ade\\n \\n \\n openrecGray\\n userFakeAna\\n odps\\n \\n running\\n","errorExample":""}]',
'title' => '获取召回表列表',
'summary' => '列表显示所有的召回表信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'OfflineFilteringAlgorithm' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/actions/offline',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18726',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '召回算法ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '召回表信息。',
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后更新时间,单位为UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'status' => [
'description' => '表示单签召回表的状态。 '."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
."\n"
.'- **Running**:运行中。'."\n"
."\n"
.'- **Offline**:已下线。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Init',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'algorithmId' => [
'description' => '指定的召回ID。',
'type' => 'string',
'example' => 'abc',
],
'meta' => [
'description' => 'Meta源数据。',
'type' => 'object',
'properties' => [
'taskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'taskId',
],
'metaType' => [
'description' => '算法类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'metaType',
],
'type' => [
'description' => '数据源类型,当前只支持ODPS。',
'type' => 'string',
'example' => 'ODPS',
],
'extInfo' => [
'description' => '召回表类型包含内容。',
'type' => 'object',
'properties' => [
'kvSeparator' => [
'description' => 'kv分隔符。',
'type' => 'string',
'example' => ':',
],
'itemSeparator' => [
'description' => 'Item分隔符。',
'type' => 'string',
'example' => ',',
],
],
],
'category' => [
'description' => '召回类别。',
'type' => 'string',
'example' => '1_2',
],
'threshold' => [
'description' => 'Table的阈值信息。',
'type' => 'object',
'properties' => [
'sourceDataSizeThreshold' => [
'description' => '源数据大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'sourceDataRecordThreshold' => [
'description' => '源数据条目数波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexSizeThreshold' => [
'description' => '索引大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'indexLossThreshold' => [
'description' => '索引大小波动阈值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'tableName' => [
'description' => 'ODPS召回表名称。',
'type' => 'string',
'example' => 'test_table',
],
'clusterId' => [
'description' => '集群ID。',
'type' => 'string',
'example' => '244',
],
'cron' => [
'description' => '定时调度任务Cron。',
'type' => 'string',
'example' => '* * 24 7 0',
],
'description' => [
'description' => '描述。',
'type' => 'string',
'example' => 'test',
],
'projectName' => [
'description' => 'ODPS中的ProjectName。',
'type' => 'string',
'example' => 'test',
],
'algorithmName' => [
'description' => '算法名称。',
'type' => 'string',
'example' => 'test',
],
'cronEnabled' => [
'description' => '是否开启定时任务。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7585C2B2-0D61-4C96-AC5D-B960BFEDD4A3',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"status\\": \\"Init\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"algorithmId\\": \\"abc\\",\\n \\"meta\\": {\\n \\"taskId\\": \\"taskId\\",\\n \\"metaType\\": \\"metaType\\",\\n \\"type\\": \\"ODPS\\",\\n \\"extInfo\\": {\\n \\"kvSeparator\\": \\":\\",\\n \\"itemSeparator\\": \\",\\"\\n },\\n \\"category\\": \\"1_2\\",\\n \\"threshold\\": {\\n \\"sourceDataSizeThreshold\\": 1,\\n \\"sourceDataRecordThreshold\\": 1,\\n \\"indexSizeThreshold\\": 1,\\n \\"indexLossThreshold\\": 1\\n },\\n \\"tableName\\": \\"test_table\\",\\n \\"clusterId\\": \\"244\\",\\n \\"cron\\": \\"* * 24 7 0\\",\\n \\"description\\": \\"test\\",\\n \\"projectName\\": \\"test\\",\\n \\"algorithmName\\": \\"test\\",\\n \\"cronEnabled\\": true\\n }\\n },\\n \\"requestId\\": \\"7585C2B2-0D61-4C96-AC5D-B960BFEDD4A3\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '下线召回表',
'summary' => '下线召回表。',
],
'CreateRankingSystem' => [
'summary' => '创建排序服务。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '117162',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例id',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求id',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'result' => [
'description' => '返回详情结果',
'$ref' => '#/components/schemas/RankingSystem',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": {\\n \\"Meta\\": {\\n \\"AutoDeploy\\": true,\\n \\"AutoDeployAuc\\": \\"0.3\\",\\n \\"Conf\\": \\"\\",\\n \\"PredictEngine\\": {\\n \\"ResourceId\\": \\"eas-oljkkdrggxhx7eizjd\\",\\n \\"Version\\": \\"1\\",\\n \\"ClusterId\\": \\"cn-shanghai\\"\\n },\\n \\"PredictEngineType\\": \\"EAS\\",\\n \\"ModelVersionName\\": \\"模型A_T1638964800000\\",\\n \\"FailMsg\\": \\"\\"\\n },\\n \\"ApplyStatus\\": \\"NOT_APPLIED\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"SceneIdList\\": [\\n 0\\n ],\\n \\"Name\\": \\"servicea\\",\\n \\"ModelTemplateId\\": \\"a-a-a\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"829F38F6-E2D6-4109-90A6-888160BD16C2\\n\\n service-a\\n NOT_DEPLOYED\\n NOT_APPLIED\\n 123465\\n 排序模型A\\n 1\\n 2\\n 3\\n \\n true\\n 0.9\\n \\n EAS\\n \\n cn-shanghai\\n eas-oljkkdrggxhx7eizjd\\n v1\\n \\n \\n","errorExample":""}]',
'title' => '创建排序服务',
],
'DeleteRankingSystem' => [
'summary' => '删除排序服务',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems/{name}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '117181',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'name',
'in' => 'path',
'schema' => [
'title' => '排序服务名称',
'description' => '排序服务名称。',
'type' => 'string',
'required' => true,
'example' => 'service-a',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'result' => [
'description' => '返回结果。',
'$ref' => '#/components/schemas/RankingSystem',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": {\\n \\"Meta\\": {\\n \\"AutoDeploy\\": true,\\n \\"AutoDeployAuc\\": \\"0.3\\",\\n \\"Conf\\": \\"\\",\\n \\"PredictEngine\\": {\\n \\"ResourceId\\": \\"eas-oljkkdrggxhx7eizjd\\",\\n \\"Version\\": \\"1\\",\\n \\"ClusterId\\": \\"cn-shanghai\\"\\n },\\n \\"PredictEngineType\\": \\"EAS\\",\\n \\"ModelVersionName\\": \\"模型A_T1638964800000\\",\\n \\"FailMsg\\": \\"\\"\\n },\\n \\"ApplyStatus\\": \\"NOT_APPLIED\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"SceneIdList\\": [\\n 0\\n ],\\n \\"Name\\": \\"servicea\\",\\n \\"ModelTemplateId\\": \\"a-a-a\\"\\n }\\n}","type":"json"}]',
'title' => '删除排序服务',
],
'ModifyRankingSystem' => [
'summary' => '修改排序服务。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems/{name}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117165',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
],
],
[
'name' => 'name',
'in' => 'path',
'schema' => [
'title' => '排序服务',
'description' => '排序服务',
'type' => 'string',
'required' => true,
'example' => '"service-a',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '配置',
'type' => 'object',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'description' => '修改后的排序服务实体',
'$ref' => '#/components/schemas/RankingSystem',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": {\\n \\"Meta\\": {\\n \\"AutoDeploy\\": true,\\n \\"AutoDeployAuc\\": \\"0.3\\",\\n \\"Conf\\": \\"\\",\\n \\"PredictEngine\\": {\\n \\"ResourceId\\": \\"eas-oljkkdrggxhx7eizjd\\",\\n \\"Version\\": \\"1\\",\\n \\"ClusterId\\": \\"cn-shanghai\\"\\n },\\n \\"PredictEngineType\\": \\"EAS\\",\\n \\"ModelVersionName\\": \\"模型A_T1638964800000\\",\\n \\"FailMsg\\": \\"\\"\\n },\\n \\"ApplyStatus\\": \\"NOT_APPLIED\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"SceneIdList\\": [\\n 0\\n ],\\n \\"Name\\": \\"servicea\\",\\n \\"ModelTemplateId\\": \\"a-a-a\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '修改排序服务',
],
'GetRankingSystem' => [
'summary' => '获取排序服务详情。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems/{name}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117168',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => 'airec-test',
],
],
[
'name' => 'name',
'in' => 'path',
'schema' => [
'title' => '排序服务名称',
'description' => '服务名称',
'type' => 'string',
'required' => false,
'example' => 'test-service',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'result' => [
'description' => '响应业务实体',
'$ref' => '#/components/schemas/RankingSystem',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": {\\n \\"Meta\\": {\\n \\"AutoDeploy\\": true,\\n \\"AutoDeployAuc\\": \\"0.3\\",\\n \\"Conf\\": \\"\\",\\n \\"PredictEngine\\": {\\n \\"ResourceId\\": \\"eas-oljkkdrggxhx7eizjd\\",\\n \\"Version\\": \\"1\\",\\n \\"ClusterId\\": \\"cn-shanghai\\"\\n },\\n \\"PredictEngineType\\": \\"EAS\\",\\n \\"ModelVersionName\\": \\"模型A_T1638964800000\\",\\n \\"FailMsg\\": \\"\\"\\n },\\n \\"ApplyStatus\\": \\"NOT_APPLIED\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"SceneIdList\\": [\\n 0\\n ],\\n \\"Name\\": \\"servicea\\",\\n \\"ModelTemplateId\\": \\"a-a-a\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"829F38F6-E2D6-4109-90A6-888160BD16C2\\n\\n service-a\\n DEPLOY_SUCCESS\\n NOT_APPLIED\\n 排序模型A\\n 123455\\n 1\\n 2\\n 3\\n \\n true\\n 0.9\\n {\\n\\t\\"fg_threads\\": 4,\\n \\"fg_mode\\":\\"normal\\",\\n\\t\\"inter_op_parallelism_threads\\": 4,\\n\\t\\"intra_op_parallelism_threads\\": 4,\\n\\t\\"remote_type\\": \\"hologres\\",\\n\\t\\"url\\": \\"postgres://user:password@addr:port/db_name\\",\\n\\t\\"period\\": 2880,\\n\\t\\"timeout\\": 600,\\n\\t\\"tables\\": [{\\n\\t\\t\\"name\\": \\"table1\\",\\n\\t\\t\\"key\\": \\"svid\\",\\n\\t\\t\\"value\\": \\"feat1,feat2,feat3,feat4 as alt_feat4\\",\\n\\t\\t\\"timekey\\": \\"update_time\\",\\n\\t\\t\\"condition\\": \\"feat1 < 50\\"\\n\\t}, {\\n\\t\\t\\"name\\": \\"table2\\",\\n\\t\\t\\"key\\": \\"svid\\",\\n\\t\\t\\"value\\": \\"feat5,feat6,feat7,feat8\\",\\n\\t\\t\\"timekey\\": \\"update_time\\"\\n\\t}]\\n}\\n EAS\\n \\n cn-shanghai\\n eas-oljkkdrggxhx7eizjd\\n v1\\n \\n \\n","errorExample":""}]',
'title' => '获取排序服务详情',
'description' => '****',
],
'GetRankingSystemHistory' => [
'summary' => '查询排序服务操作记录。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems/{name}/histories/{operateId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117155',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
],
],
[
'name' => 'name',
'in' => 'path',
'schema' => [
'title' => '排序服务名称',
'description' => '排序服务名称',
'type' => 'string',
'required' => true,
'example' => 'service-a',
],
],
[
'name' => 'operateId',
'in' => 'path',
'schema' => [
'title' => '操作记录id',
'description' => '操作记录id',
'type' => 'string',
'required' => true,
'example' => 'u-s-a',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'description' => '响应业务实体',
'$ref' => '#/components/schemas/RankingSystemHistory',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": {\\n \\"Meta\\": {\\n \\"AutoDeploy\\": true,\\n \\"AutoDeployAuc\\": \\"0.3\\",\\n \\"Conf\\": \\"\\",\\n \\"ModelTemplateName\\": \\"排序模型A\\",\\n \\"PredictEngine\\": {\\n \\"ResourceId\\": \\"eas-oljkkdrggxhx7eizjd\\",\\n \\"Version\\": \\"1\\"\\n },\\n \\"PredictEngineType\\": \\"EAS\\",\\n \\"PreviousOperateId\\": \\"aaaa\\"\\n },\\n \\"OperateTime\\": \\"2021-12-06T03:01:41.217Z\\",\\n \\"OperateId\\": \\"8AC865AF-37D6-42ED-AA9A-B60D8ECDF640\\",\\n \\"OperateType\\": \\"CONF_CHANGE\\",\\n \\"Name\\": \\"servicea\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '查询排序服务操作记录',
],
'ListRankingSystems' => [
'summary' => '获取排序服务列表。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117169',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => 'airec-test',
],
],
[
'name' => 'name',
'in' => 'query',
'schema' => [
'title' => '排序服务名称',
'description' => '排序服务名称',
'type' => 'string',
'required' => false,
'example' => 'service-a',
],
],
[
'name' => 'deployStatus',
'in' => 'query',
'schema' => [
'title' => '查询部署状态',
'description' => '查询部署状态:'."\n"
.'NOT_DEPLOYED 未部署'."\n"
.'DEPLOY_SUCCESS 部署成功',
'type' => 'string',
'required' => false,
'example' => 'NOT_DEPLOYED',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'title' => '分页,页码',
'description' => '分页,页码',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'title' => '分页,大小',
'description' => '分页,大小',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'title' => 'result',
'description' => 'result',
'type' => 'array',
'items' => [
'description' => '服务列表信息',
'$ref' => '#/components/schemas/RankingSystem',
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": [\\n {\\n \\"Meta\\": {\\n \\"AutoDeploy\\": true,\\n \\"AutoDeployAuc\\": \\"0.3\\",\\n \\"Conf\\": \\"\\",\\n \\"PredictEngine\\": {\\n \\"ResourceId\\": \\"eas-oljkkdrggxhx7eizjd\\",\\n \\"Version\\": \\"1\\",\\n \\"ClusterId\\": \\"cn-shanghai\\"\\n },\\n \\"PredictEngineType\\": \\"EAS\\",\\n \\"ModelVersionName\\": \\"模型A_T1638964800000\\",\\n \\"FailMsg\\": \\"\\"\\n },\\n \\"ApplyStatus\\": \\"NOT_APPLIED\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"SceneIdList\\": [\\n 0\\n ],\\n \\"Name\\": \\"servicea\\",\\n \\"ModelTemplateId\\": \\"a-a-a\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取排序服务列表',
],
'ListRankingSystemHistories' => [
'summary' => '查询服务操作记录列表。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems/{name}/histories',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117159',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
],
],
[
'name' => 'name',
'in' => 'path',
'schema' => [
'title' => '排序服务名称',
'description' => '排序服务名称',
'type' => 'string',
'required' => true,
'example' => 'service-a',
],
],
[
'name' => 'operateType',
'in' => 'query',
'schema' => [
'title' => '操作类型',
'description' => '操作类型:'."\n"
.'CONF_CHANGE(配置变更)、DEPLOY_CHANGE(部署变更)',
'type' => 'string',
'required' => false,
'example' => 'CONF_CHANGE',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'title' => '分页,页码',
'description' => '分页,页码',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'title' => '分页,大小',
'description' => '分页,大小',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'title' => 'result',
'description' => 'result',
'type' => 'array',
'items' => [
'description' => '响应业务实体',
'$ref' => '#/components/schemas/RankingSystemHistory',
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": [\\n {\\n \\"Meta\\": {\\n \\"AutoDeploy\\": true,\\n \\"AutoDeployAuc\\": \\"0.3\\",\\n \\"Conf\\": \\"\\",\\n \\"ModelTemplateName\\": \\"排序模型A\\",\\n \\"PredictEngine\\": {\\n \\"ResourceId\\": \\"eas-oljkkdrggxhx7eizjd\\",\\n \\"Version\\": \\"1\\"\\n },\\n \\"PredictEngineType\\": \\"EAS\\",\\n \\"PreviousOperateId\\": \\"aaaa\\"\\n },\\n \\"OperateTime\\": \\"2021-12-06T03:01:41.217Z\\",\\n \\"OperateId\\": \\"8AC865AF-37D6-42ED-AA9A-B60D8ECDF640\\",\\n \\"OperateType\\": \\"CONF_CHANGE\\",\\n \\"Name\\": \\"servicea\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '查询服务操作记录列表',
],
'DeployRankingSystem' => [
'summary' => '部署/重启部署排序服务,已经部署过的服务,修改配置后必须重启部署,注:若未修改任何参数,则可以不传body。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems/{name}/actions/deploy',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117176',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例id',
'type' => 'string',
'required' => false,
'example' => 'airec-test',
],
],
[
'name' => 'name',
'in' => 'path',
'schema' => [
'title' => '排序服务名称',
'description' => '服务名称',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '配置',
'type' => 'object',
'required' => false,
'example' => ' "meta": {'."\n"
.' "autoDeploy": true,'."\n"
.' "autoDeployAuc": "0.9",'."\n"
.' "conf":"",'."\n"
.' "predictEngineType": "EAS",'."\n"
.' "predictEngine":{'."\n"
.' "resourceId": "eas-oljkkdrggxhx7eizjd"'."\n"
.' }'."\n"
.' }',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '当前请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'title' => 'result',
'description' => '返回结果',
'type' => 'object',
'example' => 'xxx',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"InternalServerError\\nAn internal server error occurred.\\n829F38F6-E2D6-4109-90A6-888160BD16C2","errorExample":""}]',
'title' => '部署排序服务',
],
'VerifyRankingSystem' => [
'summary' => '调试排序服务。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems/{name}/actions/verify',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '117171',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'name',
'in' => 'path',
'schema' => [
'title' => '排序服务名称',
'description' => '排序服务名称。',
'type' => 'string',
'required' => true,
'example' => 'service-a',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body参数。',
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "userFeatures": "a:c,d:b",'."\n"
.' "itemFeatures": "a:1,b:2"'."\n"
.'}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'title' => 'result',
'description' => '返回结果。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '调试排序服务',
],
'RollbackRankingSystem' => [
'summary' => '回滚排序服务。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-systems/{name}/actions/rollback',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '117180',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'name',
'in' => 'path',
'schema' => [
'title' => '排序服务名称',
'description' => '排序服务名称。',
'type' => 'string',
'required' => true,
'example' => 'service-a',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body参数。',
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "operateId": "a-b-c"'."\n"
.'}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'title' => 'result',
'description' => '返回结果。',
'type' => 'object',
'example' => '无',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '回滚排序服务',
],
'CreateRankingModelTemplate' => [
'summary' => '创建排序模型模板。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-templates',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '117139',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'result' => [
'title' => '排序模型模板信息',
'description' => '排序模型模板信息。',
'$ref' => '#/components/schemas/RankingModelTemplate',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": {\\n \\"Status\\": \\"TRAINING_SUCCESS\\",\\n \\"Meta\\": {\\n \\"Authorized\\": true,\\n \\"AutoRun\\": true,\\n \\"AutoRunTime\\": 1,\\n \\"AutoRunType\\": \\"DAY\\",\\n \\"Conf\\": \\"train_config {}\\",\\n \\"LastEditTime\\": \\"2021-12-06T03:01:41.217Z\\",\\n \\"OssArn\\": \\"acs:ram::111:role/aliyunodpspaidefaultrole\\",\\n \\"OssBucket\\": \\"bucket-a\\",\\n \\"OssEndpoint\\": \\"oss-cn-beijing.aliyuncs.com\\",\\n \\"SampleId\\": \\"1111\\",\\n \\"SampleName\\": \\"样本1\\",\\n \\"SampleTimeWindow\\": 3,\\n \\"SampleTimeWindowType\\": \\"DAY\\",\\n \\"Type\\": \\"MULTI_TOWER\\",\\n \\"Name\\": \\"模型A\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"CanDeploy\\": true\\n },\\n \\"VersionNum\\": 3,\\n \\"TemplateId\\": \\"a-a-a\\"\\n }\\n}","type":"json"}]',
'title' => '创建排序模型模板',
],
'DeleteRankingModelTemplate' => [
'summary' => '删除模型。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-templates/{templateId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '117145',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'templateId',
'in' => 'path',
'schema' => [
'title' => '排序模型模板ID',
'description' => '排序模型模板ID。',
'type' => 'string',
'required' => false,
'example' => 'testTemplateId',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'description' => '返回参数。',
'$ref' => '#/components/schemas/RankingModelTemplate',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": {\\n \\"Status\\": \\"TRAINING_SUCCESS\\",\\n \\"Meta\\": {\\n \\"Authorized\\": true,\\n \\"AutoRun\\": true,\\n \\"AutoRunTime\\": 1,\\n \\"AutoRunType\\": \\"DAY\\",\\n \\"Conf\\": \\"train_config {}\\",\\n \\"LastEditTime\\": \\"2021-12-06T03:01:41.217Z\\",\\n \\"OssArn\\": \\"acs:ram::111:role/aliyunodpspaidefaultrole\\",\\n \\"OssBucket\\": \\"bucket-a\\",\\n \\"OssEndpoint\\": \\"oss-cn-beijing.aliyuncs.com\\",\\n \\"SampleId\\": \\"1111\\",\\n \\"SampleName\\": \\"样本1\\",\\n \\"SampleTimeWindow\\": 3,\\n \\"SampleTimeWindowType\\": \\"DAY\\",\\n \\"Type\\": \\"MULTI_TOWER\\",\\n \\"Name\\": \\"模型A\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"CanDeploy\\": true\\n },\\n \\"VersionNum\\": 3,\\n \\"TemplateId\\": \\"a-a-a\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '删除模型',
],
'ModifyRankingModelTemplate' => [
'summary' => '修改排序模型模板。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-templates/{templateId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117144',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
],
],
[
'name' => 'templateId',
'in' => 'path',
'schema' => [
'title' => '排序模型模板ID',
'description' => '排序模型模板ID',
'type' => 'string',
'required' => true,
'example' => 'a-a-a',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '配置信息',
'type' => 'object',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'description' => '模型信息',
'$ref' => '#/components/schemas/RankingModelTemplate',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": {\\n \\"Status\\": \\"TRAINING_SUCCESS\\",\\n \\"Meta\\": {\\n \\"Authorized\\": true,\\n \\"AutoRun\\": true,\\n \\"AutoRunTime\\": 1,\\n \\"AutoRunType\\": \\"DAY\\",\\n \\"Conf\\": \\"train_config {}\\",\\n \\"LastEditTime\\": \\"2021-12-06T03:01:41.217Z\\",\\n \\"OssArn\\": \\"acs:ram::111:role/aliyunodpspaidefaultrole\\",\\n \\"OssBucket\\": \\"bucket-a\\",\\n \\"OssEndpoint\\": \\"oss-cn-beijing.aliyuncs.com\\",\\n \\"SampleId\\": \\"1111\\",\\n \\"SampleName\\": \\"样本1\\",\\n \\"SampleTimeWindow\\": 3,\\n \\"SampleTimeWindowType\\": \\"DAY\\",\\n \\"Type\\": \\"MULTI_TOWER\\",\\n \\"Name\\": \\"模型A\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"CanDeploy\\": true\\n },\\n \\"VersionNum\\": 3,\\n \\"TemplateId\\": \\"a-a-a\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '修改排序模型模板',
],
'GetRankingModelTemplate' => [
'summary' => '查看排序模型配置详情',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-templates/{templateId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117142',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'templateId',
'in' => 'path',
'schema' => [
'title' => '模型模板ID',
'description' => '排序模型模板ID。',
'type' => 'string',
'required' => false,
'example' => 'testTemplateId',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'result' => [
'description' => '返回参数。',
'$ref' => '#/components/schemas/RankingModelTemplate',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": {\\n \\"Status\\": \\"TRAINING_SUCCESS\\",\\n \\"Meta\\": {\\n \\"Authorized\\": true,\\n \\"AutoRun\\": true,\\n \\"AutoRunTime\\": 1,\\n \\"AutoRunType\\": \\"DAY\\",\\n \\"Conf\\": \\"train_config {}\\",\\n \\"LastEditTime\\": \\"2021-12-06T03:01:41.217Z\\",\\n \\"OssArn\\": \\"acs:ram::111:role/aliyunodpspaidefaultrole\\",\\n \\"OssBucket\\": \\"bucket-a\\",\\n \\"OssEndpoint\\": \\"oss-cn-beijing.aliyuncs.com\\",\\n \\"SampleId\\": \\"1111\\",\\n \\"SampleName\\": \\"样本1\\",\\n \\"SampleTimeWindow\\": 3,\\n \\"SampleTimeWindowType\\": \\"DAY\\",\\n \\"Type\\": \\"MULTI_TOWER\\",\\n \\"Name\\": \\"模型A\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"CanDeploy\\": true\\n },\\n \\"VersionNum\\": 3,\\n \\"TemplateId\\": \\"a-a-a\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"829F38F6-E2D6-4109-90A6-888160BD16C2\\n\\n a-a-a\\n TRAINING_READY\\n 3\\n \\n 模型a\\n RankingModelTemplate\\n 2021-12-06T03:01:41.217Z\\n MULTI_TOWER\\n train_config {\\n batch_size: 1024\\n log_step_count_steps: 100\\n optimizer_config: {\\n adam_optimizer: {\\n learning_rate: {\\n exponential_decay_learning_rate {\\n initial_learning_rate: 0.001\\n decay_steps: 1000\\n decay_factor: 0.5\\n min_learning_rate: 0.00001\\n }\\n }\\n }\\n use_moving_average: false\\n }\\n save_checkpoints_steps: 100\\n sync_replicas: True\\n num_steps: 2500\\n}\\n\\nmodel_config {\\n model_class: \\"MultiTower\\"\\n feature_groups {\\n group_name: \\"item\\"\\n feature_names: \\"adgroup_id\\"\\n feature_names: \\"cate_id\\"\\n feature_names: \\"campaign_id\\"\\n feature_names: \\"customer\\"\\n feature_names: \\"brand\\"\\n feature_names: \\"price\\"\\n feature_names: \\"pid\\"\\n wide_deep: DEEP\\n }\\n feature_groups {\\n group_name: \\"user\\"\\n feature_names: \\"user_id\\"\\n feature_names: \\"cms_segid\\"\\n feature_names: \\"cms_group_id\\"\\n feature_names: \\"age_level\\"\\n feature_names: \\"pvalue_level\\"\\n feature_names: \\"shopping_level\\"\\n feature_names: \\"occupation\\"\\n feature_names: \\"new_user_class_level\\"\\n feature_names: \\"user_tag_cate\\"\\n wide_deep: DEEP\\n }\\n feature_groups {\\n group_name: \\"combo\\"\\n feature_names: \\"combo__user_id_occupation\\"\\n feature_names: \\"combo__age_level_customer\\"\\n feature_names: \\"combo__pvalue_level_brand\\"\\n wide_deep: DEEP\\n }\\n embedding_regularization: 1e-05\\n multi_tower {\\n towers {\\n input: \\"item\\"\\n dnn {\\n hidden_units: 192\\n hidden_units: 256\\n hidden_units: 192\\n hidden_units: 128\\n }\\n }\\n towers {\\n input: \\"user\\"\\n dnn {\\n hidden_units: 192\\n hidden_units: 256\\n hidden_units: 192\\n hidden_units: 128\\n }\\n }\\n towers {\\n input: \\"combo\\"\\n dnn {\\n hidden_units: 192\\n hidden_units: 256\\n hidden_units: 192\\n hidden_units: 128\\n }\\n }\\n final_dnn {\\n hidden_units: 256\\n hidden_units: 192\\n hidden_units: 128\\n hidden_units: 64\\n }\\n l2_regularization: 0.0001\\n }\\n}\\n 123\\n 样本1\\n 30\\n HOUR\\n true\\n keluo\\n oss-cn-beijing.aliyuncs.com\\n acs:ram::111:role/aliyunodpspaidefaultrole\\n true\\n 3\\n HOUR\\n NOT_DEPLOYED\\n true\\n \\n","errorExample":""}]',
'title' => '查看排序模型配置详情',
],
'RunRankingModelTemplate' => [
'summary' => '运行排序模型模板',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-templates/{templateId}/actions/run',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117149',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例id',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
],
],
[
'name' => 'templateId',
'in' => 'path',
'schema' => [
'title' => '模型模板ID',
'description' => '模型ID',
'type' => 'string',
'required' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '当前请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'title' => 'result',
'description' => '返回结果',
'type' => 'object',
'example' => 'xxx',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"829F38F6-E2D6-4109-90A6-888160BD16C2","errorExample":""}]',
'title' => '启动训练',
],
'CreateRankingModel' => [
'path' => '/v2/openapi/instances/{instanceId}/ranking-models',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '18667',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'dryRun',
'in' => 'query',
'schema' => [
'description' => '是否校验参数。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **true**:校验模型ID是否存在。'."\n"
."\n"
.'- **false**:默认false,校验参数后创建模型 。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'rankingModelId' => [
'description' => '排序模型ID。',
'type' => 'string',
'example' => 'testRankingId',
],
'gmtModified' => [
'description' => '最后修改时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'meta' => [
'description' => '模型Meta原信息。',
'type' => 'object',
'example' => 'map',
],
],
],
'code' => [
'description' => '状态码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"rankingModelId\\": \\"testRankingId\\",\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '创建排名模型',
'summary' => '创建模型。',
],
'DeleteRankingModel' => [
'path' => '/v2/openapi/instances/{instanceId}/ranking-models/{rankingModelId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '18674',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'rankingModelId',
'in' => 'path',
'schema' => [
'description' => '排序模型ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testRankingId',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'rankingModelId' => [
'description' => '排序模型ID。',
'type' => 'string',
'example' => 'testRankingId',
],
'meta' => [
'description' => '模型Meta原信息。',
'type' => 'object',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D486768B-8BF8-4D80-B491-43DC3D0AF8AB',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'successful',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"rankingModelId\\": \\"testRankingId\\",\\n \\"meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"D486768B-8BF8-4D80-B491-43DC3D0AF8AB\\",\\n \\"message\\": \\"successful\\"\\n}","type":"json"}]',
'title' => '删除排名模型',
'summary' => '删除排序模型。',
],
'DeleteRankingModelVersion' => [
'summary' => '删除某个模型版本。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-versions/{versionId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '119230',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
],
],
[
'name' => 'versionId',
'in' => 'path',
'schema' => [
'description' => '版本ID',
'type' => 'string',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '删除模型版本',
],
'ModifyRankingModel' => [
'path' => '/v2/openapi/instances/{instanceId}/ranking-models/{rankingModelId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18723',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'rankingModelId',
'in' => 'path',
'schema' => [
'description' => '排序模型ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test1234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '结果',
'type' => 'object',
'properties' => [
'rankingModelId' => [
'description' => '排序模型ID',
'type' => 'string',
'example' => 'test1234',
],
'gmtModified' => [
'description' => '修改时间',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'gmtCreate' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'meta' => [
'description' => '数据源信息,召回表的数据来源,目前只支持ODPS',
'type' => 'object',
'example' => '{}',
],
],
],
'code' => [
'description' => '错误code',
'type' => 'string',
'example' => '1',
],
'requestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'message' => [
'description' => '返回消息',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"rankingModelId\\": \\"test1234\\",\\n \\"gmtModified\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"gmtCreate\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"meta\\": {}\\n },\\n \\"code\\": \\"1\\",\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '修改排名模型',
'summary' => '修改模型信息。',
],
'ListRankingModels' => [
'path' => '/v2/openapi/instances/{instanceId}/ranking-models',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18710',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test001',
],
],
[
'name' => 'rankingModelId',
'in' => 'query',
'schema' => [
'description' => '模型id',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '指定页码,默认为:1'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '指定每页展示条数,默认为10,限制:[1-50]',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '返回详情结果'."\n"
."\n",
'type' => 'object',
'properties' => [
'rankingModelId' => [
'description' => '模型ID',
'type' => 'string',
'example' => '123',
],
'gmtModified' => [
'description' => '最后修改时间',
'type' => 'string',
'example' => '2020-11-11T09:47:43.000Z',
],
'gmtCreate' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
'meta' => [
'description' => 'meta',
'type' => 'object',
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '2D898E45-B97A-4245-B590-6D0AFEAF626B',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"rankingModelId\\": \\"123\\",\\n \\"gmtModified\\": \\"2020-11-11T09:47:43.000Z\\",\\n \\"gmtCreate\\": \\"2020-04-27T06:38:28.000Z\\",\\n \\"meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"2D898E45-B97A-4245-B590-6D0AFEAF626B\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '获取排名模型列表',
'summary' => '查询模型列表。',
],
'ListRankingModelTemplates' => [
'summary' => '查看排序模型模板列表,按创建时间倒序。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-templates',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117146',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'airec-cn-****',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'title' => '分页,页码',
'description' => '指定页码,默认为1。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'title' => '分页,大小',
'description' => '指定每页展示条数,默认为10,限制:[1-50]。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'F1C976E0-FCD2-52E8-9244-179C9C095C29',
],
'result' => [
'title' => 'result',
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '排序模型。',
'$ref' => '#/components/schemas/RankingModelTemplate',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F1C976E0-FCD2-52E8-9244-179C9C095C29\\",\\n \\"result\\": [\\n {\\n \\"Status\\": \\"TRAINING_SUCCESS\\",\\n \\"Meta\\": {\\n \\"Authorized\\": true,\\n \\"AutoRun\\": true,\\n \\"AutoRunTime\\": 1,\\n \\"AutoRunType\\": \\"DAY\\",\\n \\"Conf\\": \\"train_config {}\\",\\n \\"LastEditTime\\": \\"2021-12-06T03:01:41.217Z\\",\\n \\"OssArn\\": \\"acs:ram::111:role/aliyunodpspaidefaultrole\\",\\n \\"OssBucket\\": \\"bucket-a\\",\\n \\"OssEndpoint\\": \\"oss-cn-beijing.aliyuncs.com\\",\\n \\"SampleId\\": \\"1111\\",\\n \\"SampleName\\": \\"样本1\\",\\n \\"SampleTimeWindow\\": 3,\\n \\"SampleTimeWindowType\\": \\"DAY\\",\\n \\"Type\\": \\"MULTI_TOWER\\",\\n \\"Name\\": \\"模型A\\",\\n \\"DeployStatus\\": \\"NOT_DEPLOYED\\",\\n \\"CanDeploy\\": true\\n },\\n \\"VersionNum\\": 3,\\n \\"TemplateId\\": \\"a-a-a\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查看排序模型模板列表',
],
'GetRankingModelVersion' => [
'summary' => '查看排序模型版本详情,包括评估结果和训练结果',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-versions/{versionId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117152',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'versionId',
'in' => 'path',
'schema' => [
'title' => '模型版本ID',
'description' => '模型版本ID。',
'type' => 'string',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '90EF57C6-CC92-55D0-BA35-892DF9337EAB',
],
'result' => [
'description' => '排序模型。',
'$ref' => '#/components/schemas/RankingModelVersion',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"90EF57C6-CC92-55D0-BA35-892DF9337EAB\\",\\n \\"result\\": {\\n \\"Status\\": \\"TRAINING\\",\\n \\"RunTime\\": \\"2021-12-08T20:00:00.0Z\\",\\n \\"RunLog\\": \\"\\",\\n \\"TemplateName\\": \\"模型A\\",\\n \\"RunResult\\": {\\n \\"AssessAuc\\": \\"0.3\\",\\n \\"AssessGauc\\": \\"0.3\\",\\n \\"AssessLoss\\": \\"0.3\\",\\n \\"TrainAuc\\": \\"0.3\\",\\n \\"TrainGauc\\": \\"0.3\\",\\n \\"TrainLoss\\": \\"0.3\\"\\n },\\n \\"Name\\": \\"模型A_t1638964800000\\",\\n \\"TemplateId\\": \\"a-a-a\\"\\n }\\n}","type":"json"}]',
'title' => '查看排序模型版本详情',
],
'ListRankingModelVersions' => [
'summary' => '获取排序模型版本。',
'path' => '/v2/openapi/instances/{instanceId}/ranking-model-versions',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117151',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'templateId',
'in' => 'query',
'schema' => [
'title' => '模型模板ID',
'description' => '模型模板ID。',
'type' => 'string',
'required' => true,
'example' => '1',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'title' => '分页,页码',
'description' => '指定页码,默认为1。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'title' => '分页,大小',
'description' => '指定每页展示条数,默认为10,限制:[1-50]。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'status',
'in' => 'query',
'schema' => [
'title' => '版本状态',
'description' => '版本状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- **DRAFT**:草稿状态。'."\n"
."\n"
.'- **EFFECTIVE**:生效状态。'."\n"
."\n"
.'- **PUBLISHING**:发布中状态。'."\n"
."\n"
.'- **INEFFECTIVE**:已失效状态。'."\n"
."\n"
.'- **FAILED**:未生效状态。',
'type' => 'string',
'required' => false,
'example' => 'TRAINING',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'result' => [
'title' => 'map',
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '排序模型版本数据。',
'$ref' => '#/components/schemas/RankingModelVersion',
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"result\\": [\\n {\\n \\"Status\\": \\"TRAINING\\",\\n \\"RunTime\\": \\"2021-12-08T20:00:00.0Z\\",\\n \\"RunLog\\": \\"\\",\\n \\"TemplateName\\": \\"模型A\\",\\n \\"RunResult\\": {\\n \\"AssessAuc\\": \\"0.3\\",\\n \\"AssessGauc\\": \\"0.3\\",\\n \\"AssessLoss\\": \\"0.3\\",\\n \\"TrainAuc\\": \\"0.3\\",\\n \\"TrainGauc\\": \\"0.3\\",\\n \\"TrainLoss\\": \\"0.3\\"\\n },\\n \\"Name\\": \\"模型A_t1638964800000\\",\\n \\"TemplateId\\": \\"a-a-a\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取排序模型版本',
],
'DecribeRankingModel' => [
'path' => '/v2/openapi/instances/{instanceId}/ranking-models/{rankingModelId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18670',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'rankingModelId',
'in' => 'path',
'schema' => [
'description' => '排序模型ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testRankingId',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'rankingModelId' => [
'description' => '排序模型ID。',
'type' => 'string',
'example' => 'testRankingId',
],
'gmtModified' => [
'description' => '最后修改时间的UTC时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
'gmtCreate' => [
'description' => '创建的UTC时间。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'meta' => [
'description' => '模型Meta原信息。',
'type' => 'object',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'successful',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"rankingModelId\\": \\"testRankingId\\",\\n \\"gmtModified\\": \\"2020-04-27T06:38:28.000Z\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"message\\": \\"successful\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取排序模型',
'summary' => '获取排序模型。',
],
'CheckRankingModelReachable' => [
'path' => '/v2/openapi/instances/{instanceId}/ranking-models/{rankingModelId}/actions/check-connectivity',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '18663',
'abilityTreeNodes' => [
'FEATUREairecY1ADIM',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-7e22x6f75001',
],
],
[
'name' => 'rankingModelId',
'in' => 'path',
'schema' => [
'description' => '模型id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'rankingModelId',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'boolean',
'example' => 'true',
],
'code' => [
'description' => '错误码',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '当前请求的RequestID。'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 829F38F6-E2D6-4109-90A6-888160BD16C2\\n","errorExample":""}]',
'title' => '测试模型网络联通性',
'summary' => '测试模型网络联通性。',
],
'CreateRule' => [
'path' => '/v2/openapi/instances/{instanceId}/rules',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '18668',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-****'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'ruleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => '98493A14-D619-4E88-9F8D-108939817F9F',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
'status' => [
'description' => '规则状态:'."\n"
."\n"
.'- **DRAFT**:草稿状态'."\n"
."\n\n"
.'- **EFFECTIVE**:生效状态'."\n"
."\n"
.'- **PUBLISHING**:发布中状态'."\n"
."\n"
.'- **INEFFECTIVE**:已失效状态'."\n"
."\n"
.'- **FAILED**:未生效状态',
'type' => 'string',
'example' => 'EFFECTIVE',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"ruleId\\": \\"98493A14-D619-4E88-9F8D-108939817F9F\\",\\n \\"gmtModified\\": \\"2020-04-27T06:38:28.000Z\\",\\n \\"status\\": \\"EFFECTIVE\\",\\n \\"gmtCreate\\": \\"2020-04-27T06:38:28.000Z\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"<0>\\n \\n DRAFT\\n 2020-04-27T06:38:28.000Z\\n 2020-04-27T06:38:28.000Z\\n 98493A14-D619-4E88-9F8D-108939817F9F\\n \\n SELECTION\\n 123\\n PUBLISHING\\n \\n QUERY_ITEM_TYPE\\n OPERATOR_EQUAL\\n atrical,image\\n \\n \\n \\n 76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF\\n0>\\n<1>\\n \\n DRAFT\\n 2020-04-27T03:17:21.000Z\\n 2020-04-27T03:17:21.000Z\\n 123456789001122\\n \\n OPERATION\\n 123\\n PUBLISHING\\n \\n MIX\\n \\n image\\n 10\\n \\n \\n \\n DIVERSIFY\\n 1\\n 2\\n true\\n TYPE_SHOP\\n \\n \\n EXPOSURE\\n \\n 12340\\n true\\n TYPE_EXPOSE\\n true\\n \\n \\n 12340000\\n true\\n TYPE_CLICK\\n true\\n \\n \\n \\n \\n 76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF\\n1>","errorExample":""}]',
'title' => '创建规则',
'summary' => '创建推荐策略运营规则。',
'requestParamsDescription' => '请求的body:'."\n"
.'| 参数 | 类型 | 是否必需 | 描述 |'."\n"
.'| --- | --- | --- | --- |'."\n"
.'| type | String | 是 | 规则类型
**SelectionRule:**选品规则
**OperationRule:**运营规则
**TopRule:** 置顶规则
**FixedPositionRule:**定坑规则 |'."\n"
.'| ruleMeta | Map | 是 | 规则的具体信息 |'."\n"
.'| └sceneId | String | 是 | 场景ID
如要修改全局运营规则,填global |'."\n"
.'| selectionParams | List | 是 | 选品规则参数 |'."\n"
.'| └selectType | Enum | 是 | **QUERY_ITEM_TYPE: **物品类型
**QUERY_CATEGORY:**物品类目
**QUERY_PUB_TIME :**发布时间
**QUERY_CHANNEL:** 渠道 |'."\n"
.'| └selectionOperation | Enum | 是 | **OPERATOR_HIGHER:**大于等于
**OPERATOR_LOWER:**小于等于
**_QUERY_VALUE_IN:** 包括_ |'."\n"
.'| └selectValue | String | 是 | 具体选择的选品规则(Json格式传递) |'."\n"
.'| operationParams | | | |'."\n"
.'| └modifyOperationType | List | 是 | ["DIVERSIFY","EXPOSURE"] 添加需要修改的 key |'."\n"
.'| └instanceDiversifyEnable | boolean | 是 | 是否使用实例级别的多样性规则 |'."\n"
.'| └instanceMixEnable | boolean |
| 是否使用实例级别的混排规则 |'."\n"
.'| └operationType | Enum | 是 | MIX 排序
**DIVERSIFY:** 多样性
**EXPOSURE:**曝光 (只有全局规则支持曝光类型) |'."\n"
.'| └settings | MixSetting | 是 | |'."\n"
.'| └name | String | 是 | 混排类型 |'."\n"
.'| └value | int | 是 | 混排类型所占百分比 |'."\n"
.'| └diversifyType | Enum | 是 | **TYPE_SHOP:** 店铺打散
**TYPE_AUTHOR :**作者打散
**TYPE_CATEGORY:**类目打散
**TYPE_ITEM_TYPE:** 物品类型打散 |'."\n"
.'| └categoryIndex | int | 是 | 层级,没有填0 |'."\n"
.'| └window | int | 是 | 窗口 |'."\n"
.'| └status | boolean | 是 | 打散是否开启,**true**:开启,**false**:关闭|'."\n"
.'| └instanceExposureEnable | boolean | 是 | 是否使用实例级别的曝光配置,
默认true |'."\n"
.'| └exposureSettings | List | 是 | 曝光配置列表 |'."\n"
.'| └durationSeconds | Long | 是 | 曝光时间(秒级时间戳) |'."\n"
.'| └exposureType | String | 是 | 曝光类型:
**TYPE_EXPOSE**:曝光
**TYPE_CLICK**:点击
**TYPE_LOOP**:循环 |'."\n"
.'| └status | boolean | 是 | 曝光是否开启,**true**:开启,**false**:关闭|'."\n"
.'| └scenarioBased | boolean | 是 | 是否基于场景,**true**:是,**false**:否,基于实例|'."\n"
.'| └mtOrderSettings | MtOrderSetting | 是 | 相关度规则配置列表 |'."\n"
.'| └index | int | 是 | 该值为标识顺序以及符号,
例如:a=b=c:111,a=b>c:112,a>b>c:123 |'."\n"
.'| └value | String | 是 | 相关度规则,**TITLE**,**TAG**,**CHANNEL**,**AUTHOR** |'."\n"
.'| └settings | NewItemSetting | 是 | 新品定义规则配置 |'."\n"
.'| └selectType | String | 是 | QUERY_PUB_TIME,固定字符串 |'."\n"
.'| └selectionOperation | String | 是 | OPERATOR_LOWER,固定字符串 |'."\n"
.'| └selectValue | int | 是 | 新品定义的时间,秒级别时间戳|'."\n"
.'| └settings | SimilaritySetting | | 标题相似度规则 |'."\n"
.'| └windowSize | int | | 重复个数,标题相似度这个规则不需要修改 |'."\n"
.'| └repeatLimit | int | | 时间窗口 ,标题相似度这个规则不需要修改|'."\n"
.'| └type | String | | title,固定字符串 |'."\n"
.'| └status | boolean | | 标题相似度规则是否开启,**true**:是,**false**:否|'."\n"
.'| topParams | List | 是 | 置顶规则物品列表 |'."\n"
.'| └itemId | String | 是 | 物品ID|'."\n"
.'| └itemType | String | 是 | 物品类型 |'."\n"
.'| └title | String | 是 | 标题 |'."\n"
.'| └categoryPath | String | 是 | 类目 |'."\n"
.'| └channel | String | 是 | 渠道(内容/新闻) |'."\n"
.'| └author | String | 是 | 作者(内容/新闻) |'."\n"
.'| └brandId | String | 是 | 品牌(电商) |'."\n"
.'| └shopId | String | 是 | 店铺(电商) |'."\n"
.'| fixedPositionParams | List | 是 | 定坑规则列表 |'."\n"
.'| └positions | List | 是 | 位置列表,格式为[坑位ID1,坑位ID2] |'."\n"
.'| └selectType | String | 是 | 选品类型,固定值为QUERY_ITEM_ID_AND_TYPE |'."\n"
.'| └selectionOperation | String | 是 | 选品规则,固定值为QUERY_VALUE_IN |'."\n"
.'| └selectValue | String | 是 | 选品物品,格式为1:item;2:item |',
],
'ModifyRule' => [
'path' => '/v2/openapi/instances/{instanceId}/rules/{ruleId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18724',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'ruleId',
'in' => 'path',
'schema' => [
'description' => '规则ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '13469',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果。',
'type' => 'object',
'properties' => [
'ruleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => '98493A14-D619-4E88-9F8D-108939817F9F',
],
'ruleMeta' => [
'description' => '规则的具体信息。',
'type' => 'object',
'example' => 'xxx',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
'status' => [
'description' => '规则状态:'."\n"
.'**DRAFT:** 草稿状态'."\n"
."\n"
.'**EFFECTIVE:** 生效状态'."\n"
."\n"
.'**PUBLISHING:**发布中状态'."\n"
."\n"
.'**INEFFECTIVE:** 已失效状态'."\n"
."\n"
.'**FAILED:**未生效状态',
'type' => 'string',
'example' => 'EFFECTIVE',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"ruleId\\": \\"98493A14-D619-4E88-9F8D-108939817F9F\\",\\n \\"ruleMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"gmtModified\\": \\"2020-04-27T06:38:28.000Z\\",\\n \\"status\\": \\"EFFECTIVE\\",\\n \\"gmtCreate\\": \\"2020-04-27T06:38:28.000Z\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => 'ModifyRule',
'summary' => '修改规则。',
'requestParamsDescription' => '```json'."\n"
.'// 修改选品规则'."\n"
.'{ "type":"SelectionRule",'."\n"
.' "ruleMeta":{'."\n"
.' "sceneId":"123",'."\n"
.' "ruleMetaType":"SELECTION",'."\n"
.' "selectionParams":['."\n"
.' {'."\n"
.' "selectType":"QUERY_ITEM_TYPE",'."\n"
.' "selectionOperation":"QUERY_VALUE_IN",'."\n"
.' "selectValue":"[\\"atrical\\",\\"image\\"]"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'."\n"
.'// 修改运营规则'."\n"
.'{'."\n"
.' "type":"OperationRule",'."\n"
.' "ruleMeta":{'."\n"
.' "ruleMetaType":"OPERATION",'."\n"
.' "sceneId":"123",'."\n"
.' "operationParams":['."\n"
.' {'."\n"
.' "operationType":"MIX",'."\n"
.' "settings":['."\n"
.' {'."\n"
.' "name":"image",'."\n"
.' "value":10'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "operationType":"DIVERSIFY",'."\n"
.' "status":true,'."\n"
.' "diversifyType":"TYPE_SHOP",'."\n"
.' "categoryIndex":1,'."\n"
.' "window":2'."\n"
.' },'."\n"
.' {'."\n"
.' "operationType":"EXPOSURE",'."\n"
.' "exposureSettings":['."\n"
.' {'."\n"
.' "durationSeconds":1234000,'."\n"
.' "status":true,'."\n"
.' "exposureType":"TYPE_EXPOSE",'."\n"
.' "scenarioBased":true'."\n"
.' },'."\n"
.' {'."\n"
.' "durationSeconds":123400,'."\n"
.' "status":true,'."\n"
.' "exposureType":"TYPE_CLICK",'."\n"
.' "scenarioBased":true'."\n"
.' },'."\n"
.' {'."\n"
.' "durationSeconds":3000,'."\n"
.' "status":true,'."\n"
.' "exposureType":"TYPE_LOOP",'."\n"
.' "scenarioBased":false'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListRules' => [
'path' => '/v2/openapi/instances/{instanceId}/rules',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18712',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'sceneId',
'in' => 'query',
'schema' => [
'description' => '要修改规则的场景ID,'."\n"
.'如要修改全局运营规则,则填**global**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'scenetest',
],
],
[
'name' => 'ruleType',
'in' => 'query',
'schema' => [
'description' => '规则类型:'."\n"
.'**selection:** 选品规则'."\n"
."\n"
.'**operation:**运营规则。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'selection',
],
],
[
'name' => 'status',
'in' => 'query',
'schema' => [
'description' => '规则状态:'."\n"
.'**DRAFT:** 草稿状态;'."\n"
."\n"
.'**EFFECTIVE:** 生效状态;'."\n"
."\n"
.'**PUBLISHING:**发布中状态;'."\n"
."\n"
.'**INEFFECTIVE:** 已失效状态;'."\n"
."\n"
.'**FAILED:**未生效状态。',
'type' => 'string',
'required' => false,
'example' => 'EFFECTIVE',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '指定页码,默认为:1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '指定每页展示条数,默认为10,限制:[1-50]。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间(秒级时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '4102444800',
'minimum' => '1546300800',
'example' => '1567584765',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间 (秒级时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1567584765',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'array',
'items' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'ruleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => '98493A14-D619-4E88-9F8D-108939817F9F',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
'status' => [
'description' => '规则状态:'."\n"
.'**DRAFT:** 草稿状态;'."\n"
."\n"
.'**EFFECTIVE:** 生效状态;'."\n"
."\n"
.'**PUBLISHING:**发布中状态;'."\n"
."\n"
.'**INEFFECTIVE:** 已失效状态;'."\n"
."\n"
.'**FAILED:**未生效状态。',
'type' => 'string',
'example' => 'draft',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"ruleId\\": \\"98493A14-D619-4E88-9F8D-108939817F9F\\",\\n \\"gmtModified\\": \\"2020-04-27T06:38:28.000Z\\",\\n \\"status\\": \\"draft\\",\\n \\"gmtCreate\\": \\"2020-04-27T06:38:28.000Z\\"\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"<0>\\n \\n DRAFT\\n 2020-04-27T06:38:28.000Z\\n 2020-04-27T06:38:28.000Z\\n 98493A14-D619-4E88-9F8D-108939817F9F\\n \\n SELECTION\\n 123\\n PUBLISHING\\n \\n QUERY_ITEM_TYPE\\n OPERATOR_EQUAL\\n atrical,image\\n \\n \\n \\n 76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF\\n \\n 19\\n \\n0>\\n<1>\\n \\n DRAFT\\n 2020-04-27T03:17:21.000Z\\n 2020-04-27T03:17:21.000Z\\n 123456789001122\\n \\n OPERATION\\n 123\\n PUBLISHING\\n \\n MIX\\n \\n image\\n 10\\n \\n \\n \\n DIVERSIFY\\n 1\\n 2\\n true\\n TYPE_SHOP\\n \\n \\n EXPOSURE\\n \\n 1234000\\n true\\n TYPE_EXPOSE\\n true\\n \\n \\n 123400\\n true\\n TYPE_CLICK\\n true\\n \\n \\n \\n \\n 76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF\\n \\n 19\\n \\n1>","errorExample":""}]',
'title' => '获取规则列表',
'summary' => '查询规则列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRule' => [
'path' => '/v2/openapi/instances/{instanceId}/rules/{ruleId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18687',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'ruleId',
'in' => 'path',
'schema' => [
'description' => '通过规则ID查询。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '98493A14-D619-4E88-9F8D-108939817F9F',
],
],
[
'name' => 'sceneId',
'in' => 'query',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'scenetest',
],
],
[
'name' => 'ruleType',
'in' => 'query',
'schema' => [
'description' => '规则类型:'."\n"
.'**selection:**选品规则'."\n"
."\n"
.'**operation:**运营规则'."\n"
."\n"
.'**top:**置顶规则'."\n"
."\n"
.'**fixed:**定坑规则',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'selection',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'ruleId' => [
'description' => '通过规则ID查询。',
'type' => 'string',
'example' => '98493A14-D619-4E88-9F8D-108939817F9F',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
'status' => [
'description' => '规则状态:'."\n"
.'**DRAFT:** 草稿状态'."\n"
."\n"
.'**EFFECTIVE:** 生效状态'."\n"
."\n"
.'**PUBLISHING:**发布中状态'."\n"
."\n"
.'**INEFFECTIVE:** 已失效状态'."\n"
."\n"
.'**FAILED:**未生效状态',
'type' => 'string',
'example' => 'DRAFT',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-04-27T06:38:28.000Z',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"ruleId\\": \\"98493A14-D619-4E88-9F8D-108939817F9F\\",\\n \\"gmtModified\\": \\"2020-04-27T06:38:28.000Z\\",\\n \\"status\\": \\"DRAFT\\",\\n \\"gmtCreate\\": \\"2020-04-27T06:38:28.000Z\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n \\n \\n\\n\\n\\n","errorExample":""}]',
'title' => '获取规则信息',
'summary' => '查询一个规则的详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PublishRule' => [
'path' => '/v2/openapi/instances/{instanceId}/rules/{ruleId}/actions/publish',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18727',
'abilityTreeNodes' => [
'FEATUREairecG8RBMT',
],
],
'parameters' => [
[
'name' => 'ruleId',
'in' => 'path',
'schema' => [
'description' => '规则ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '98493A14-D619-4E88-9F8D-108939817F9F',
],
],
[
'name' => 'ruleType',
'in' => 'query',
'schema' => [
'description' => '规则类型:'."\n"
.'**selection:**选品规则'."\n"
."\n"
.'**operation:**运营规则'."\n"
."\n"
.'**top:**置顶规则'."\n"
."\n"
.'**fixed:**定坑规则',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'selection',
],
],
[
'name' => 'sceneId',
'in' => 'query',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'ruleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => '98493A14-D619-4E88-9F8D-108939817F9F',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"ruleId\\": \\"98493A14-D619-4E88-9F8D-108939817F9F\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","type":"json"}]',
'title' => '发布规则',
'summary' => '发布一个规则。',
],
'CreateScene' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '18669',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'dryRun',
'in' => 'query',
'schema' => [
'description' => '是否dryRun'."\n"
.'**true:**校验场景ID是否存在'."\n"
.'**false:**默认为false,创建场景。',
'type' => 'boolean',
'required' => false,
'docRequired' => true,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'sceneId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => 'test',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
'status' => [
'description' => '场景状态:'."\n"
.'- **DRAFT**:唤醒,重新发布'."\n"
.'- **PUBLISHING** :发布'."\n"
.'- **RUNNING**:运行中'."\n"
.'- **FAILED**:发布失败'."\n"
.'- **FROZEN** :冻结',
'type' => 'string',
'example' => 'DRAFT',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"sceneId\\": \\"test\\",\\n \\"gmtModified\\": \\"2020-04-23T06:08:48.000Z\\",\\n \\"status\\": \\"DRAFT\\",\\n \\"gmtCreate\\": \\"2020-04-23T06:08:48.000Z\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"123\\n\\n sceneTest\\n xxx\\n","errorExample":""}]',
'title' => '创建场景',
'summary' => '校验创建场景的信息。',
'description' => '如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见官方文档:[通过选投策略配置,快速搭建推荐场景](https://help.aliyun.com/document_detail/171790.html?spm=a2c4g.11186623.6.677.1f6a3483tNyo2M)',
],
'DeleteScene' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '18675',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testid',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'sceneId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => 'test',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"sceneId\\": \\"test\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"8F81A922-6C81-46D6-B78C-CC35E16B1691\\n\\n airec-yunchu-test\\n 1234\\n 901\\n Scene\\n \\n 1587435971000\\n 1587435971000\\n \\n this is a test scene\\n aaa\\n \\n 123\\n 12334\\n 123\\n \\n \\n","errorExample":""}]',
'title' => '删除场景',
'summary' => '删除场景。',
'description' => '如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见官方文档:[通过选投策略配置,快速搭建推荐场景](https://help.aliyun.com/document_detail/171790.html?spm=a2c4g.11186623.6.677.1f6a3483tNyo2M)',
],
'ModifyScene' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18725',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'sceneId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => 'test',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
'status' => [
'description' => '场景状态:'."\n"
.'- **DRAFT**:唤醒,重新发布'."\n"
.'- **PUBLISHING** :发布'."\n"
.'- **RUNNING**:运行中'."\n"
.'- **FAILED**:发布失败'."\n"
.'- **FROZEN** :冻结',
'type' => 'string',
'example' => 'DRAFT',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"sceneId\\": \\"test\\",\\n \\"gmtModified\\": \\"2020-04-23T06:08:48.000Z\\",\\n \\"status\\": \\"DRAFT\\",\\n \\"gmtCreate\\": \\"2020-04-23T06:08:48.000Z\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n RUNNING\\n 2020-04-23T06:08:48.000Z\\n 2020-04-23T10:04:24.000Z\\n 123\\n \\n xxx\\n xxx\\n \\n\\nE6535761-3448-4D6E-A791-477531763F29","errorExample":""}]',
'title' => '修改场景信息',
'summary' => '修改场景信息。',
'description' => '如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见官方文档:[通过选投策略配置,快速搭建推荐场景](https://help.aliyun.com/document_detail/171790.html?spm=a2c4g.11186623.6.677.1f6a3483tNyo2M)',
],
'DescribeScene' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18688',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testid',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '场景详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '场景详情。',
'type' => 'object',
'properties' => [
'sceneId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => 'test',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
'status' => [
'description' => '场景状态:'."\n"
.'- **DRAFT**:唤醒,重新发布'."\n"
.'- **PUBLISHING** :发布'."\n"
.'- **RUNNING**:运行中'."\n"
.'- **FAILED**:发布失败'."\n"
.'- **FROZEN** :冻结',
'type' => 'string',
'example' => 'DRAFT',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"sceneId\\": \\"test\\",\\n \\"gmtModified\\": \\"2020-04-23T06:08:48.000Z\\",\\n \\"status\\": \\"DRAFT\\",\\n \\"gmtCreate\\": \\"2020-04-23T06:08:48.000Z\\"\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DRAFT\\n 2020-04-23T06:08:48.000Z\\n 2020-04-23T06:08:48.000Z\\n 123\\n \\n sceneTest\\n xxx\\n \\n 32\\n 32\\n 32\\n \\n \\n\\n76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF","errorExample":""}]',
'title' => '查询场景详情',
'summary' => '查询场景详情。',
'description' => '如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见官方文档:[通过选投策略配置,快速搭建推荐场景](https://help.aliyun.com/document_detail/171790.html?spm=a2c4g.11186623.6.677.1f6a3483tNyo2M)',
],
'ListScenes' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18716',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'status',
'in' => 'query',
'schema' => [
'description' => '场景状态:'."\n"
.'- **DRAFT**:唤醒,重新发布'."\n"
.'- **PUBLISHING** :发布'."\n"
.'- **RUNNING**:运行中'."\n"
.'- **FAILED**:发布失败'."\n"
.'- **FROZEN** :冻结',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'sceneId',
'in' => 'query',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '指定页码,默认为:1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '指定每页展示条数,默认为10,限制:1-50。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'array',
'items' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'sceneId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => 'test',
],
'gmtModified' => [
'description' => '最后修改时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
'status' => [
'description' => '场景状态:'."\n"
.'- **DRAFT**:唤醒,重新发布'."\n"
.'- **PUBLISHING** :发布'."\n"
.'- **RUNNING**:运行中'."\n"
.'- **FAILED**:发布失败'."\n"
.'- **FROZEN** :冻结',
'type' => 'string',
'example' => '1',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"sceneId\\": \\"test\\",\\n \\"gmtModified\\": \\"2020-04-23T06:08:48.000Z\\",\\n \\"status\\": \\"1\\",\\n \\"gmtCreate\\": \\"2020-04-23T06:08:48.000Z\\"\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DRAFT\\n 2020-04-23T06:08:48.000Z\\n 2020-04-23T06:08:48.000Z\\n 123\\n \\n sceneTest\\n xxx\\n \\n 32\\n 32\\n 32\\n \\n \\n\\n0D532E4F-899E-4A59-96B8-C7843A286A53","errorExample":""}]',
'title' => '查询场景列表',
'summary' => '查询场景列表。',
'description' => '如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见官方文档:[通过选投策略配置,快速搭建推荐场景](https://help.aliyun.com/document_detail/171790.html?spm=a2c4g.11186623.6.677.1f6a3483tNyo2M)',
],
'CreateCustomSample' => [
'summary' => '创建自定义样本。',
'path' => '/v2/openapi/instances/{instanceId}/samples',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '117123',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-xxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回结果详情。',
'$ref' => '#/components/schemas/Sample',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"样本状态 Unready 未完成配置 \\\\u0000Ready 配置完成 \\\\u0000Generating 样本生成中 \\\\u0000Success 样本生成成功 \\\\u0000Failed 样本生成失败 \\\\u0000Formatting 格式化中 \\\\u0000Formatted 格式化完成 \\\\u0000FormatFailed 格式化失败 \\\\u0000Applied 已应用到模型中\\",\\n \\"Meta\\": {\\n \\"AutoUpdate\\": true,\\n \\"AutoUpdateFrequency\\": 86400,\\n \\"ClonedId\\": \\"1638877561147\\",\\n \\"Config\\": {\\n \\"BhvTableSourceIds\\": [\\n \\"\\"\\n ],\\n \\"FeatureConfig\\": {\\n \\"ItemFeatures\\": \\"物品特征,支持多值,逗号分隔。\\",\\n \\"UserFeatures\\": \\"用户特征,支持多值,逗号分隔。\\"\\n },\\n \\"LabelLogic\\": {\\n \\"BhvTimeWindow\\": 86400,\\n \\"NegativeBhvTypes\\": \\"click,expose\\",\\n \\"PositiveBhvTypes\\": \\"like\\"\\n },\\n \\"WeightLogicList\\": [\\n {\\n \\"Bhv\\": \\"click\\",\\n \\"Weight\\": \\"1.01\\"\\n }\\n ]\\n },\\n \\"ExtendParams\\": {\\n \\"LatestTaskStatus\\": 0,\\n \\"SampleCount\\": 0\\n },\\n \\"MetaType\\": \\"Sample\\",\\n \\"Name\\": \\"12345\\",\\n \\"StoreConfig\\": \\"projectName.tableName\\",\\n \\"Type\\": \\"Cloned 复制的 System 系统的 Custom 自定义的\\"\\n },\\n \\"GmtCreate\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"SampleId\\": \\"1638880131873\\"\\n }\\n}","type":"json"}]',
'title' => '创建自定义样本',
],
'CreateSampleFormatConfig' => [
'summary' => '创建样本格式化配置。',
'path' => '/v2/openapi/instances/{instanceId}/samples/{sampleId}/format-configs',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '117132',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-****',
],
],
[
'name' => 'sampleId',
'in' => 'path',
'schema' => [
'title' => '样本id',
'description' => '样本ID。',
'type' => 'string',
'required' => true,
'example' => 'Sample1',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body参数。',
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "type": "SampleFormatConfig",'."\n"
.' "meta": {'."\n"
.' "metaType": "SampleFormatConfig",'."\n"
.' "config": {'."\n"
.' "features": ['."\n"
.' {'."\n"
.' "feature_type": "id_feature",'."\n"
.' "value_type": "String",'."\n"
.' "hash_bucket_size": 100000,'."\n"
.' "expression": "user:user_id",'."\n"
.' "feature_name": "user_id",'."\n"
.' "embedding_dim": 16,'."\n"
.' "combiner": "mean",'."\n"
.' "group": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "feature_type": "id_feature",'."\n"
.' "value_type": "String",'."\n"
.' "hash_bucket_size": 100,'."\n"
.' "expression": "user:cms_segid",'."\n"
.' "feature_name": "cms_segid",'."\n"
.' "embedding_dim": 16,'."\n"
.' "combiner": "mean",'."\n"
.' "group": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "feature_type": "id_feature",'."\n"
.' "value_type": "String",'."\n"
.' "hash_bucket_size": 100,'."\n"
.' "expression": "user:cms_group_id",'."\n"
.' "feature_name": "cms_group_id",'."\n"
.' "embedding_dim": 16,'."\n"
.' "combiner": "mean",'."\n"
.' "group": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "feature_type": "combo_feature",'."\n"
.' "hash_bucket_size": 10,'."\n"
.' "expression": ['."\n"
.' "user:pvalue_level",'."\n"
.' "item:brand"'."\n"
.' ],'."\n"
.' "feature_name": "combo__pvalue_level_brand",'."\n"
.' "embedding_dim": 16,'."\n"
.' "group": "combo"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.'}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'title' => 'result',
'description' => '格式化配置详情。',
'type' => 'object',
'example' => '{'."\n"
.' "result": {'."\n"
.' "meta": {'."\n"
.' "metaType": "SampleFormatConfig",'."\n"
.' "sampleId": "Sample1",'."\n"
.' "config": {'."\n"
.' "features": ['."\n"
.' {'."\n"
.' "feature_type": "id_feature",'."\n"
.' "value_type": "String",'."\n"
.' "hash_bucket_size": 100000,'."\n"
.' "expression": "user:user_id",'."\n"
.' "feature_name": "user_id",'."\n"
.' "embedding_dim": 16,'."\n"
.' "combiner": "mean",'."\n"
.' "group": "user"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' },'."\n"
.' "status": "",'."\n"
.' "gmtCreate": "2021-12-07T08:58:19.000Z",'."\n"
.' "gmtModified": "2021-12-07T08:58:19.000Z",'."\n"
.' "sampleFormatConfigId": "99D369F6-0A73-4247-9E9F-F693A16CD6AC"'."\n"
.' }'."\n"
.'}',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"result\\": {\\n \\"meta\\": {\\n \\"metaType\\": \\"SampleFormatConfig\\",\\n \\"sampleId\\": \\"Sample1\\",\\n \\"config\\": {\\n \\"features\\": [\\n {\\n \\"feature_type\\": \\"id_feature\\",\\n \\"value_type\\": \\"String\\",\\n \\"hash_bucket_size\\": 100000,\\n \\"expression\\": \\"user:user_id\\",\\n \\"feature_name\\": \\"user_id\\",\\n \\"embedding_dim\\": 16,\\n \\"combiner\\": \\"mean\\",\\n \\"group\\": \\"user\\"\\n }\\n ]\\n }\\n },\\n \\"status\\": \\"\\",\\n \\"gmtCreate\\": \\"2021-12-07T08:58:19.000Z\\",\\n \\"gmtModified\\": \\"2021-12-07T08:58:19.000Z\\",\\n \\"sampleFormatConfigId\\": \\"99D369F6-0A73-4247-9E9F-F693A16CD6AC\\"\\n }\\n }\\n}","type":"json"}]',
'title' => '创建样本格式化配置',
'responseParamsDescription' => '| 参数 | 类型 | 是否必需 | 描述 |'."\n"
.'| :--- | :--- | :--- | :--- |'."\n"
.'| meta|String|是|Meta源数据。|'."\n"
.'| metaType|String|是|SampleFormatConfig固定字符串。|'."\n"
.'| sampleId|String|是|样本ID。|'."\n"
.'| config|Object|是|配置列表。|'."\n"
.'| features|List|是|配置信息。|'."\n"
.'| feature_type|String|是|特征类型。|'."\n"
.'| value_type|String|否|返回值类型。|'."\n"
.'| hash_bucket_size|Integer|否|哈希桶大小。|'."\n"
.'| expression|String|否|特征表字段名数组。|'."\n"
.'| feature_name|String|否|特征名。|'."\n"
.'| embedding_dim|Integer|否|embedding维数。|'."\n"
.'| combiner|String|否|组合器名称。|'."\n"
.'| group|String|否|特征组名。|',
],
'DeleteSample' => [
'summary' => '删除样本。',
'path' => '/v2/openapi/instances/{instanceId}/samples/{sampleId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '117130',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'sampleId',
'in' => 'path',
'schema' => [
'title' => '样本id',
'description' => '样本ID。',
'type' => 'string',
'required' => true,
'example' => 'Sample1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回结果详情。',
'$ref' => '#/components/schemas/Sample',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"样本状态 Unready 未完成配置 \\\\u0000Ready 配置完成 \\\\u0000Generating 样本生成中 \\\\u0000Success 样本生成成功 \\\\u0000Failed 样本生成失败 \\\\u0000Formatting 格式化中 \\\\u0000Formatted 格式化完成 \\\\u0000FormatFailed 格式化失败 \\\\u0000Applied 已应用到模型中\\",\\n \\"Meta\\": {\\n \\"AutoUpdate\\": true,\\n \\"AutoUpdateFrequency\\": 86400,\\n \\"ClonedId\\": \\"1638877561147\\",\\n \\"Config\\": {\\n \\"BhvTableSourceIds\\": [\\n \\"\\"\\n ],\\n \\"FeatureConfig\\": {\\n \\"ItemFeatures\\": \\"物品特征,支持多值,逗号分隔。\\",\\n \\"UserFeatures\\": \\"用户特征,支持多值,逗号分隔。\\"\\n },\\n \\"LabelLogic\\": {\\n \\"BhvTimeWindow\\": 86400,\\n \\"NegativeBhvTypes\\": \\"click,expose\\",\\n \\"PositiveBhvTypes\\": \\"like\\"\\n },\\n \\"WeightLogicList\\": [\\n {\\n \\"Bhv\\": \\"click\\",\\n \\"Weight\\": \\"1.01\\"\\n }\\n ]\\n },\\n \\"ExtendParams\\": {\\n \\"LatestTaskStatus\\": 0,\\n \\"SampleCount\\": 0\\n },\\n \\"MetaType\\": \\"Sample\\",\\n \\"Name\\": \\"12345\\",\\n \\"StoreConfig\\": \\"projectName.tableName\\",\\n \\"Type\\": \\"Cloned 复制的 System 系统的 Custom 自定义的\\"\\n },\\n \\"GmtCreate\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"SampleId\\": \\"1638880131873\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '删除样本',
],
'ModifySample' => [
'summary' => '修改样本配置。',
'path' => '/v2/openapi/instances/{instanceId}/samples/{sampleId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117127',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'sampleId',
'in' => 'path',
'schema' => [
'title' => '样本id',
'description' => '样本ID。',
'type' => 'string',
'required' => true,
'example' => 'Sample1',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body参数。',
'type' => 'object',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回结果详情。',
'$ref' => '#/components/schemas/Sample',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"样本状态 Unready 未完成配置 \\\\u0000Ready 配置完成 \\\\u0000Generating 样本生成中 \\\\u0000Success 样本生成成功 \\\\u0000Failed 样本生成失败 \\\\u0000Formatting 格式化中 \\\\u0000Formatted 格式化完成 \\\\u0000FormatFailed 格式化失败 \\\\u0000Applied 已应用到模型中\\",\\n \\"Meta\\": {\\n \\"AutoUpdate\\": true,\\n \\"AutoUpdateFrequency\\": 86400,\\n \\"ClonedId\\": \\"1638877561147\\",\\n \\"Config\\": {\\n \\"BhvTableSourceIds\\": [\\n \\"\\"\\n ],\\n \\"FeatureConfig\\": {\\n \\"ItemFeatures\\": \\"物品特征,支持多值,逗号分隔。\\",\\n \\"UserFeatures\\": \\"用户特征,支持多值,逗号分隔。\\"\\n },\\n \\"LabelLogic\\": {\\n \\"BhvTimeWindow\\": 86400,\\n \\"NegativeBhvTypes\\": \\"click,expose\\",\\n \\"PositiveBhvTypes\\": \\"like\\"\\n },\\n \\"WeightLogicList\\": [\\n {\\n \\"Bhv\\": \\"click\\",\\n \\"Weight\\": \\"1.01\\"\\n }\\n ]\\n },\\n \\"ExtendParams\\": {\\n \\"LatestTaskStatus\\": 0,\\n \\"SampleCount\\": 0\\n },\\n \\"MetaType\\": \\"Sample\\",\\n \\"Name\\": \\"12345\\",\\n \\"StoreConfig\\": \\"projectName.tableName\\",\\n \\"Type\\": \\"Cloned 复制的 System 系统的 Custom 自定义的\\"\\n },\\n \\"GmtCreate\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"SampleId\\": \\"1638880131873\\"\\n }\\n}","type":"json"}]',
'title' => '修改样本配置',
],
'ListSamples' => [
'summary' => '获取样本列表。',
'path' => '/v2/openapi/instances/{instanceId}/samples',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117124',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '指定的实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'sampleId',
'in' => 'query',
'schema' => [
'title' => '样本id',
'description' => '样本id',
'type' => 'string',
'required' => false,
'example' => 'Sample1',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'title' => '分页,页码',
'description' => '分页,页码',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'title' => '分页,大小',
'description' => '分页,大小',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '当前请求的RequestID',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'title' => 'result',
'description' => '样本列表',
'type' => 'array',
'items' => [
'description' => '结果详情',
'$ref' => '#/components/schemas/Sample',
],
'example' => 'result',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": [\\n {\\n \\"Status\\": \\"样本状态 Unready 未完成配置 \\\\u0000Ready 配置完成 \\\\u0000Generating 样本生成中 \\\\u0000Success 样本生成成功 \\\\u0000Failed 样本生成失败 \\\\u0000Formatting 格式化中 \\\\u0000Formatted 格式化完成 \\\\u0000FormatFailed 格式化失败 \\\\u0000Applied 已应用到模型中\\",\\n \\"Meta\\": {\\n \\"AutoUpdate\\": true,\\n \\"AutoUpdateFrequency\\": 86400,\\n \\"ClonedId\\": \\"1638877561147\\",\\n \\"Config\\": {\\n \\"BhvTableSourceIds\\": [\\n \\"\\"\\n ],\\n \\"FeatureConfig\\": {\\n \\"ItemFeatures\\": \\"物品特征,支持多值,逗号分隔。\\",\\n \\"UserFeatures\\": \\"用户特征,支持多值,逗号分隔。\\"\\n },\\n \\"LabelLogic\\": {\\n \\"BhvTimeWindow\\": 86400,\\n \\"NegativeBhvTypes\\": \\"click,expose\\",\\n \\"PositiveBhvTypes\\": \\"like\\"\\n },\\n \\"WeightLogicList\\": [\\n {\\n \\"Bhv\\": \\"click\\",\\n \\"Weight\\": \\"1.01\\"\\n }\\n ]\\n },\\n \\"ExtendParams\\": {\\n \\"LatestTaskStatus\\": 0,\\n \\"SampleCount\\": 0\\n },\\n \\"MetaType\\": \\"Sample\\",\\n \\"Name\\": \\"12345\\",\\n \\"StoreConfig\\": \\"projectName.tableName\\",\\n \\"Type\\": \\"Cloned 复制的 System 系统的 Custom 自定义的\\"\\n },\\n \\"GmtCreate\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"SampleId\\": \\"1638880131873\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取样本列表',
],
'GetSample' => [
'summary' => '获取样本详情',
'path' => '/v2/openapi/instances/{instanceId}/samples/{sampleId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117125',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'sampleId',
'in' => 'path',
'schema' => [
'title' => '样本id',
'description' => '样本ID。',
'type' => 'string',
'required' => true,
'example' => '123',
],
],
[
'name' => 'withExtendParmas',
'in' => 'query',
'schema' => [
'title' => '是否携带扩展参数',
'description' => '是否携带扩展参数'."\n"
."\n"
.'- **true**:有扩展参数'."\n"
."\n"
.'- **false**:没有扩展参数',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '样本实体。',
'$ref' => '#/components/schemas/Sample',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"样本状态 Unready 未完成配置 \\\\u0000Ready 配置完成 \\\\u0000Generating 样本生成中 \\\\u0000Success 样本生成成功 \\\\u0000Failed 样本生成失败 \\\\u0000Formatting 格式化中 \\\\u0000Formatted 格式化完成 \\\\u0000FormatFailed 格式化失败 \\\\u0000Applied 已应用到模型中\\",\\n \\"Meta\\": {\\n \\"AutoUpdate\\": true,\\n \\"AutoUpdateFrequency\\": 86400,\\n \\"ClonedId\\": \\"1638877561147\\",\\n \\"Config\\": {\\n \\"BhvTableSourceIds\\": [\\n \\"\\"\\n ],\\n \\"FeatureConfig\\": {\\n \\"ItemFeatures\\": \\"物品特征,支持多值,逗号分隔。\\",\\n \\"UserFeatures\\": \\"用户特征,支持多值,逗号分隔。\\"\\n },\\n \\"LabelLogic\\": {\\n \\"BhvTimeWindow\\": 86400,\\n \\"NegativeBhvTypes\\": \\"click,expose\\",\\n \\"PositiveBhvTypes\\": \\"like\\"\\n },\\n \\"WeightLogicList\\": [\\n {\\n \\"Bhv\\": \\"click\\",\\n \\"Weight\\": \\"1.01\\"\\n }\\n ]\\n },\\n \\"ExtendParams\\": {\\n \\"LatestTaskStatus\\": 0,\\n \\"SampleCount\\": 0\\n },\\n \\"MetaType\\": \\"Sample\\",\\n \\"Name\\": \\"12345\\",\\n \\"StoreConfig\\": \\"projectName.tableName\\",\\n \\"Type\\": \\"Cloned 复制的 System 系统的 Custom 自定义的\\"\\n },\\n \\"GmtCreate\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"SampleId\\": \\"1638880131873\\"\\n }\\n}","type":"json"}]',
'title' => '获取样本详情',
],
'CloneSample' => [
'summary' => '复制创建样本。',
'path' => '/v2/openapi/instances/{instanceId}/samples/{sampleId}/actions/clone',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '117122',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'sampleId',
'in' => 'path',
'schema' => [
'title' => '样本id',
'description' => '样本id',
'type' => 'string',
'required' => true,
'example' => 'abc',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '样本',
'$ref' => '#/components/schemas/Sample',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"样本状态 Unready 未完成配置 \\\\u0000Ready 配置完成 \\\\u0000Generating 样本生成中 \\\\u0000Success 样本生成成功 \\\\u0000Failed 样本生成失败 \\\\u0000Formatting 格式化中 \\\\u0000Formatted 格式化完成 \\\\u0000FormatFailed 格式化失败 \\\\u0000Applied 已应用到模型中\\",\\n \\"Meta\\": {\\n \\"AutoUpdate\\": true,\\n \\"AutoUpdateFrequency\\": 86400,\\n \\"ClonedId\\": \\"1638877561147\\",\\n \\"Config\\": {\\n \\"BhvTableSourceIds\\": [\\n \\"\\"\\n ],\\n \\"FeatureConfig\\": {\\n \\"ItemFeatures\\": \\"物品特征,支持多值,逗号分隔。\\",\\n \\"UserFeatures\\": \\"用户特征,支持多值,逗号分隔。\\"\\n },\\n \\"LabelLogic\\": {\\n \\"BhvTimeWindow\\": 86400,\\n \\"NegativeBhvTypes\\": \\"click,expose\\",\\n \\"PositiveBhvTypes\\": \\"like\\"\\n },\\n \\"WeightLogicList\\": [\\n {\\n \\"Bhv\\": \\"click\\",\\n \\"Weight\\": \\"1.01\\"\\n }\\n ]\\n },\\n \\"ExtendParams\\": {\\n \\"LatestTaskStatus\\": 0,\\n \\"SampleCount\\": 0\\n },\\n \\"MetaType\\": \\"Sample\\",\\n \\"Name\\": \\"12345\\",\\n \\"StoreConfig\\": \\"projectName.tableName\\",\\n \\"Type\\": \\"Cloned 复制的 System 系统的 Custom 自定义的\\"\\n },\\n \\"GmtCreate\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"SampleId\\": \\"1638880131873\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '复制创建样本',
],
'GenerateSample' => [
'summary' => '生成样本,只针对复制创建的样本。',
'path' => '/v2/openapi/instances/{instanceId}/samples/{sampleId}/actions/generate',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '117131',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-xxx',
],
],
[
'name' => 'sampleId',
'in' => 'path',
'schema' => [
'title' => '样本id',
'description' => '样本ID。',
'type' => 'string',
'required' => true,
'example' => 'Sample',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回结果。',
'$ref' => '#/components/schemas/Sample',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"样本状态 Unready 未完成配置 \\\\u0000Ready 配置完成 \\\\u0000Generating 样本生成中 \\\\u0000Success 样本生成成功 \\\\u0000Failed 样本生成失败 \\\\u0000Formatting 格式化中 \\\\u0000Formatted 格式化完成 \\\\u0000FormatFailed 格式化失败 \\\\u0000Applied 已应用到模型中\\",\\n \\"Meta\\": {\\n \\"AutoUpdate\\": true,\\n \\"AutoUpdateFrequency\\": 86400,\\n \\"ClonedId\\": \\"1638877561147\\",\\n \\"Config\\": {\\n \\"BhvTableSourceIds\\": [\\n \\"\\"\\n ],\\n \\"FeatureConfig\\": {\\n \\"ItemFeatures\\": \\"物品特征,支持多值,逗号分隔。\\",\\n \\"UserFeatures\\": \\"用户特征,支持多值,逗号分隔。\\"\\n },\\n \\"LabelLogic\\": {\\n \\"BhvTimeWindow\\": 86400,\\n \\"NegativeBhvTypes\\": \\"click,expose\\",\\n \\"PositiveBhvTypes\\": \\"like\\"\\n },\\n \\"WeightLogicList\\": [\\n {\\n \\"Bhv\\": \\"click\\",\\n \\"Weight\\": \\"1.01\\"\\n }\\n ]\\n },\\n \\"ExtendParams\\": {\\n \\"LatestTaskStatus\\": 0,\\n \\"SampleCount\\": 0\\n },\\n \\"MetaType\\": \\"Sample\\",\\n \\"Name\\": \\"12345\\",\\n \\"StoreConfig\\": \\"projectName.tableName\\",\\n \\"Type\\": \\"Cloned 复制的 System 系统的 Custom 自定义的\\"\\n },\\n \\"GmtCreate\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"GmtModified\\": \\"2021-12-07T12:28:52.000Z\\",\\n \\"SampleId\\": \\"1638880131873\\"\\n }\\n}","type":"json"}]',
'title' => '生成样本',
],
'CreateCustomAnalysisTask' => [
'summary' => '创建自定义分析任务。',
'path' => '/v2/openapi/instances/{instanceId}/dashboard/custom-analysis-tasks',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '36672',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'type',
'in' => 'query',
'schema' => [
'description' => '查询类型 。'."\n"
.'如:'."\n"
.'**ITEM_CUSTOM**:物品维度自定义分析。',
'type' => 'string',
'required' => true,
'example' => 'ITEM_CUSTOM',
],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-xxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '16B78383-2803-4964-9605-37B30C073B0E',
],
'code' => [
'description' => '返回码。',
'type' => 'string',
'example' => '200',
],
'message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'success',
],
'result' => [
'description' => '创建任务的ID。',
'type' => 'object',
'example' => '123',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"16B78383-2803-4964-9605-37B30C073B0E\\",\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"result\\": 123\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n latest\\n","errorExample":""}]',
'title' => '创建自定义分析任务',
],
'AttachIndexVersion' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/index-versions/{versionId}/actions/attach',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18662',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '召回配置ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'versionId',
'in' => 'path',
'schema' => [
'description' => '索引版本ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'v1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '是否切换成功。'."\n"
.'**TRUE**:是。'."\n"
.'**FALSE**:否。',
'type' => 'boolean',
'example' => 'TRUE',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E63A27A4-3411-4910-B7D5-12EEAC19389B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"E63A27A4-3411-4910-B7D5-12EEAC19389B\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => 'AttachIndexVersion',
'summary' => '把指定版本的索引切换到线上。',
],
'ModifyDataSource' => [
'path' => '/v2/openapi/instances/{instanceId}/dataSources/{tableName}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18719',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'tableName',
'in' => 'path',
'schema' => [
'description' => '要修改数据源的数据表名称。',
'type' => 'string',
'required' => false,
'example' => 'behavior',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果详情。',
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后修改数据源的时间。'."\n",
'type' => 'string',
'example' => '2020-04-23T06:08:48.000Z',
],
'gmtCreate' => [
'description' => '创建时间的时间戳。',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'tableName' => [
'description' => '智能推荐的实例的表名。'."\n",
'type' => 'string',
'example' => 'behavior',
],
'meta' => [
'description' => '数据源配置参数。',
'type' => 'object',
'properties' => [
'bucketName' => [
'description' => 'oss数据源的bucketName信息。',
'type' => 'string',
'example' => 'airec',
],
'accessKeyId' => [
'description' => '有访问ODPS权限的accesskey ID。'."\n",
'type' => 'string',
'example' => 'xxx',
],
'type' => [
'description' => '数据源类型,当前只支持ODPS。'."\n",
'type' => 'string',
'example' => 'ODPS',
],
'partition' => [
'description' => 'ODPS Partition。例如:ds=20180102。',
'type' => 'string',
'example' => 'ds=20181122',
],
'timestamp' => [
'description' => 'ODPS 毫秒数据时间戳。例如:1544112000000。',
'type' => 'integer',
'format' => 'int64',
'example' => '1544112000000',
],
'path' => [
'description' => 'oss数据源的信息。',
'type' => 'string',
'example' => 'oss://xxx.xxx',
],
'tableName' => [
'description' => 'ODPS 数据源的table name。',
'type' => 'string',
'example' => 'table01',
],
'projectName' => [
'description' => 'ODPS数据源的 project name。',
'type' => 'string',
'example' => 'airecproject',
],
],
],
],
],
'code' => [
'description' => '错误码。',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情。',
'type' => 'string',
'example' => 'successful',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"gmtModified\\": \\"2020-04-23T06:08:48.000Z\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"tableName\\": \\"behavior\\",\\n \\"meta\\": {\\n \\"bucketName\\": \\"airec\\",\\n \\"accessKeyId\\": \\"xxx\\",\\n \\"type\\": \\"ODPS\\",\\n \\"partition\\": \\"ds=20181122\\",\\n \\"timestamp\\": 1544112000000,\\n \\"path\\": \\"oss://xxx.xxx\\",\\n \\"tableName\\": \\"table01\\",\\n \\"projectName\\": \\"airecproject\\"\\n }\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"successful\\"\\n}","type":"json"}]',
'title' => '修改指定实例的指定数据源信息',
'summary' => '修改指定表的数据源信息。',
],
'ModifyFeatureTable' => [
'summary' => '修改特征表,只支表级别持特征列表的全量修改。',
'path' => '/v2/openapi/instances/{instanceId}/feature-tables/{type}/{featureTableId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117111',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例id',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
],
],
[
'name' => 'type',
'in' => 'path',
'schema' => [
'title' => '特征表类型',
'description' => '特征表类型'."\n"
.'UserFeatureTable'."\n"
.'ItemFeatureTable',
'type' => 'string',
'required' => true,
'example' => 'UserFeatureTable',
],
],
[
'name' => 'featureTableId',
'in' => 'path',
'schema' => [
'title' => '特征表id',
'description' => '特征表id',
'type' => 'string',
'required' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'$ref' => '#/components/schemas/FeatureTable',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"\\",\\n \\"Meta\\": {\\n \\"DataSourceId\\": \\"907648f5-abae-44fd-a4c4-525cc25947e9\\",\\n \\"FeatureList\\": [\\n {\\n \\"Comment\\": \\"com11\\",\\n \\"FeatureName\\": \\"fn11\\",\\n \\"FieldName\\": \\"fieldName11\\",\\n \\"Status\\": \\"NotApplied 未应用 Applied 已应用\\"\\n }\\n ],\\n \\"Internal\\": true,\\n \\"MetaType\\": \\"FeatureTable\\",\\n \\"Source\\": \\"test_project.test_table\\",\\n \\"UpdateFrequency\\": 86400\\n },\\n \\"FeatureTableId\\": \\"30E70118-FC7C-4438-9287-583CE47266A9\\",\\n \\"Type\\": \\"ItemFeatureTable 物品特征表 UserFeatureTable 用户特征表\\",\\n \\"GmtCreate\\": \\"2021-12-10T02:59:54.000Z\\",\\n \\"GmtModified\\": \\"2021-12-10T02:59:54.000Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ItemFeatureTable\\n \\n FeatureTable\\n 907648f5-abae-44fd-a4c4-525cc25947e9\\n project_name.table\\n 86400\\n \\n fieldName11\\n fn11\\n com11\\n \\n \\n fieldName22\\n fn22\\n com2222\\n \\n \\n \\n 2021-12-10T02:59:54.000Z\\n 2021-12-10T02:59:54.000Z\\n 30E70118-FC7C-4438-9287-583CE47266A9\\n\\n15847E8B-F00E-44AD-8FD0-26E1B0F4A0A6","errorExample":""}]',
'title' => '修改特征表',
],
'ModifyItems' => [
'path' => '/v2/openapi/instances/{instanceId}/items',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18722',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '成功,失败',
'type' => 'boolean',
'example' => 'true',
],
'requestId' => [
'description' => '返回的RequestId',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\"\\n}","type":"json"}]',
'title' => '修改项目',
'summary' => '批量操作物品池。',
],
'ModifyOfflineStorages' => [
'summary' => '修改实例的离线存储配置。(只支持三张表同时修改)。',
'path' => '/v2/openapi/instances/[instanceId]/offlineStorages',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '20403',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'example' => 'airec-test-xxx',
'title' => '实例id',
'format' => 'byte',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '7F176EE8-51DA-4B4D-8FFE-04448CD7A171',
'title' => 'Id of the request',
'format' => 'byte',
],
'result' => [
'description' => '结果',
'type' => 'boolean',
'example' => 'true',
'title' => '是否成功',
],
],
'title' => 'Schema of Response',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"7F176EE8-51DA-4B4D-8FFE-04448CD7A171\\",\\n \\"result\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n7F176EE8-51DA-4B4D-8FFE-04448CD7A171","errorExample":""}]',
'title' => '修改实例的离线存储配置',
],
'StopDataSet' => [
'path' => '/v2/openapi/instances/{instanceId}/dataSets/{versionId}/actions/stop',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18740',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'versionId',
'in' => 'path',
'schema' => [
'description' => '版本号'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '20181023214546',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '数据集详情'."\n",
'type' => 'object',
'properties' => [
'versionId' => [
'description' => '版本号'."\n",
'type' => 'string',
'example' => '20181023214546',
],
'state' => [
'description' => '数据版本状态(Importing:导入中)'."\n",
'type' => 'string',
'example' => 'Importing',
],
'gmtModified' => [
'description' => '最后修改数据源的时间。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1544112000000',
],
'gmtCreate' => [
'description' => '创建数据源的时间。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1544112000000',
],
'instanceId' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'example' => 'airec-cn-o400whm78004',
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"code\\": \\"InternalServerError\\",\\n \\"message\\": \\"An internal server error occurred\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"result\\": {\\n \\"versionId\\": \\"20181023214546\\",\\n \\"state\\": \\"Importing\\",\\n \\"gmtModified\\": 1544112000000,\\n \\"gmtCreate\\": 1544112000000,\\n \\"instanceId\\": \\"airec-cn-o400whm78004\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"8F81A922-6C81-46D6-B78C-CC35E16B1691\\n\\n airec-cn-xxxxx\\n 20181023214546\\n Importing\\n 1537531932000\\n 1537531932000\\n","errorExample":""}]',
'title' => '停止数据集',
'summary' => '停止指定实例的指定数据集版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeCustomAnalysisTask' => [
'summary' => '查询指定实例的仪表盘自定义分析任务结果',
'path' => '/v2/openapi/instances/{instanceId}/dashboard/custom-analysis-tasks/{taskId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '36674',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'type',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'taskId',
'in' => 'path',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
],
'result' => [
'type' => 'object',
],
'code' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"code\\": \\"\\",\\n \\"message\\": \\"\\"\\n}","type":"json"}]',
'title' => '查询指定实例的仪表盘自定义分析任务结果',
],
'DescribeDefaultAlgorithms' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/default-algorithms',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18678',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-xxxxxx',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '返回详情结果',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法key'."\n"
.'I2I I2I召回链路'."\n"
.'u2X2I U2X2I召回链路'."\n"
.'hot 热门商品召回链路'."\n"
.'new 新品召回链路'."\n"
.'embedding 向量召回链路'."\n"
.'mtorder 召回链路优先级'."\n"
.'rankservice 排序服务',
'type' => 'string',
'example' => 'I2I',
],
'config' => [
'description' => '实验定制值',
'type' => 'array',
'items' => [
'description' => '子配置项信息',
'type' => 'object',
'properties' => [
'key' => [
'description' => '算法配置项key',
'type' => 'string',
'example' => 'I2I-truncedquantity',
],
'defaultValue' => [
'description' => '算法配置项默认值',
'type' => 'string',
'example' => 'swing;commoni2i;pcategory;scategory',
],
'experimentValue' => [
'description' => '算法配置项实验值',
'type' => 'string',
'example' => '300',
],
'name' => [
'description' => '算法配置项name'."\n"
.'(说明:系统默认算法,控制台需要通过美杜莎获取,用户自定义算法,后端会返回name)',
'type' => 'string',
'example' => 'I2I算法',
],
],
],
],
'defaultValue' => [
'description' => '算法默认值'."\n"
.'对于i2i,hot,new等召回算法为"true"/"false"'."\n"
.'对于mtorder为各路召回链路的排序',
'type' => 'string',
'example' => 'true',
],
'type' => [
'description' => '算法类别'."\n"
.'SYSTEM 系统默认类型'."\n"
.'CUSTOM 用户自定义类型',
'type' => 'string',
'example' => 'SYSTEM',
],
'experimentValue' => [
'description' => '实验定制值',
'type' => 'string',
'example' => '300',
],
'hasConfig' => [
'description' => '是否有子配置项'."\n"
.'true 是'."\n"
.'false 否',
'type' => 'boolean',
'example' => 'true',
],
'category' => [
'description' => '算法类目'."\n"
.'RECALL 召回'."\n"
.'RANK 排序',
'type' => 'string',
'example' => 'RECALL',
],
'name' => [
'description' => '名称(说明:系统默认算法,控制台需要通过美杜莎获取,用户自定义算法,后端会返回name)',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => 'F60021C4-57AF-5F46-9B3E-FCEF1C7A1459',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"key\\": \\"I2I\\",\\n \\"config\\": [\\n {\\n \\"key\\": \\"I2I-truncedquantity\\",\\n \\"defaultValue\\": \\"swing;commoni2i;pcategory;scategory\\",\\n \\"experimentValue\\": \\"300\\",\\n \\"name\\": \\"I2I算法\\"\\n }\\n ],\\n \\"defaultValue\\": \\"true\\",\\n \\"type\\": \\"SYSTEM\\",\\n \\"experimentValue\\": \\"300\\",\\n \\"hasConfig\\": true,\\n \\"category\\": \\"RECALL\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"requestId\\": \\"F60021C4-57AF-5F46-9B3E-FCEF1C7A1459\\"\\n}","type":"json"}]',
'title' => '获取默认算法信息',
'summary' => '获取默认算法信息。',
],
'DescribeLatestTask' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/tasks/latest',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18684',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '指定的召回ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应体',
'type' => 'object',
'properties' => [
'result' => [
'description' => '召回表信息',
'type' => 'array',
'items' => [
'description' => '召回表信息',
'type' => 'object',
'properties' => [
'code' => [
'description' => '错误码',
'type' => 'string',
'example' => '400',
],
'switchedTime' => [
'description' => '索引切换完成时间,为UTC时间',
'type' => 'string',
'example' => '2020-11-08T02:00:00Z',
],
'rollbackEnabled' => [
'description' => '是否可以回滚',
'type' => 'boolean',
'example' => 'true',
],
'message' => [
'description' => '错误信息',
'type' => 'string',
'example' => 'xxx',
],
'flowType' => [
'description' => '任务类型,包含 Auto Manual Rollback ',
'type' => 'string',
'example' => 'Manual',
],
'costSeconds' => [
'description' => '索引构建耗时',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'builtTime' => [
'description' => '索引开始构建时间,为UTC时间',
'type' => 'string',
'example' => '2020-11-08T02:00:00Z',
],
'versionId' => [
'description' => '索引版本的版本号,后端生成',
'type' => 'string',
'example' => '20102010211',
],
'size' => [
'description' => '索引构建大小',
'type' => 'integer',
'format' => 'int64',
'example' => '2938475566',
],
'status' => [
'description' => '索引状态,包含索引:'."\n"
."\n"
.'- 失败(failed)'."\n"
.'- 生效中(online)'."\n"
.'- 已失效(offline)'."\n"
."\n"
.'全量任务:'."\n"
."\n"
.'- 全量中(pending )'."\n"
.'- 已完成(success)'."\n"
.'- 失败(failed) '."\n"
."\n"
.'等',
'type' => 'string',
'example' => 'pending',
],
'progress' => [
'description' => '进度展示百分比,例如80',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
],
],
],
'requestId' => [
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"code\\": \\"400\\",\\n \\"switchedTime\\": \\"2020-11-08T02:00:00Z\\",\\n \\"rollbackEnabled\\": true,\\n \\"message\\": \\"xxx\\",\\n \\"flowType\\": \\"Manual\\",\\n \\"costSeconds\\": 50,\\n \\"builtTime\\": \\"2020-11-08T02:00:00Z\\",\\n \\"versionId\\": \\"20102010211\\",\\n \\"size\\": 2938475566,\\n \\"status\\": \\"pending\\",\\n \\"progress\\": 80\\n }\\n ],\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","type":"json"}]',
'title' => '获取最新任务',
'summary' => '获取最近一次构建的任务。',
],
'DescribeQuota' => [
'path' => '/v2/openapi/instances/{instanceId}/quota',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18685',
'abilityTreeNodes' => [
'FEATUREairecDM7OX0',
'FEATUREairecEDD4RN',
'FEATUREairecIDS0JZ',
'FEATUREairecDTVO6V',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'itemCountUsed' => [
'description' => '已经使用的物品数'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'itemCount' => [
'description' => '物品表文档数,取值范围:1~1000',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'userCount' => [
'description' => '用户表文档数,取值范围如下:'."\n"
.'1~1000',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'userCountUsed' => [
'description' => '已使用的用户数',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'qps' => [
'description' => '查询的QPS值,取值范围如下:'."\n"
."\n"
.'最小值 10、最大值 500',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'currentQps' => [
'description' => '弹性QPS数量',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"itemCountUsed\\": 100,\\n \\"itemCount\\": 100,\\n \\"userCount\\": 100,\\n \\"userCountUsed\\": 100,\\n \\"qps\\": 10,\\n \\"currentQps\\": 10\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '获取指定实例的配额信息',
'summary' => '通过指定的实例ID查看实例的配额信息。',
],
'DescribeRegions' => [
'path' => '/v2/openapi/configurations/regions',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18686',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'acceptLanguage',
'in' => 'query',
'schema' => [
'description' => '指定返回的语言,默认值为zh-cn。',
'type' => 'string',
'required' => false,
'example' => 'zh-cn',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '返回详情结果',
'type' => 'object',
'properties' => [
'regionId' => [
'description' => '实例所在的区域。',
'type' => 'string',
'example' => 'cn-beijing',
],
'endpoint' => [
'description' => '接入点地址',
'type' => 'string',
'example' => '47.109.94.218',
],
'status' => [
'description' => '开通状态:'."\n"
.'NotOpen 未开通'."\n"
.'Processing 开通中'."\n"
.'Running 运行中',
'type' => 'string',
'example' => 'Running',
],
'localName' => [
'description' => '区域名称',
'type' => 'string',
'example' => 'xxx',
],
'consoleUrl' => [
'description' => '控制台地址',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '16B78383-2803-4964-9605-37B30C073B0E',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'successful',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"endpoint\\": \\"47.109.94.218\\",\\n \\"status\\": \\"Running\\",\\n \\"localName\\": \\"xxx\\",\\n \\"consoleUrl\\": \\"xxx\\"\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"16B78383-2803-4964-9605-37B30C073B0E\\",\\n \\"message\\": \\"successful\\"\\n}","type":"json"}]',
'title' => '查询区域',
'summary' => '查询可以使用的阿里云区域。',
],
'DescribeSceneBucket' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiment-bucket',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18689',
'abilityTreeNodes' => [
'FEATUREairec4DBEUA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'num' => [
'description' => '总桶数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'inUse' => [
'description' => '当前所有ab占用桶号,其余均为缺省实验占用',
'type' => 'string',
'example' => '1',
],
'detail' => [
'description' => '详情',
'type' => 'object',
'example' => 'xxx',
],
],
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"num\\": 2,\\n \\"inUse\\": \\"1\\",\\n \\"detail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"requestId\\": \\"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 10\\n 1\\n 2\\n 3\\n \\n <123396>3123396>\\n <123417>1123417>\\n <123417>2123417>\\n \\n \\n E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B\\n","errorExample":""}]',
'title' => 'DescribeSceneBucket',
'summary' => '查看场景下实验桶分布情况。',
],
'DescribeSceneThroughput' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/throughput',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18690',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例id'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景id'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testid',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果'."\n"
."\n",
'type' => 'object',
'properties' => [
'pvCount' => [
'description' => 'pv计数',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"pvCount\\": 123\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 123213\\n\\n6839AE7C-A984-48C1-AC17-331BAC6D97BC","errorExample":""}]',
'title' => '获取场景流量',
'summary' => '获取场景流量。',
'description' => '如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见官方文档:[通过选投策略配置,快速搭建推荐场景](https://help.aliyun.com/document_detail/171790.html?spm=a2c4g.11186623.6.677.1f6a3483tNyo2M)',
],
'DescribeSyncReportDetail' => [
'path' => '/v2/openapi/instances/{instanceId}/sync-reports/detail',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18691',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'type',
'in' => 'query',
'schema' => [
'description' => 'behavior/item/user表',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'behavior',
],
],
[
'name' => 'levelType',
'in' => 'query',
'schema' => [
'description' => '严重等级 error/warn/info',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'error',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'historyData' => [
'description' => '历史数据异常记录占比列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'errorPercent' => [
'description' => '指定时间段异常数据记录占比 ',
'type' => 'number',
'format' => 'float',
'example' => '84.6',
],
'startTime' => [
'description' => '开始时间秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1586673466',
],
'endTime' => [
'description' => '结束时间秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1586673466',
],
],
],
],
'sampleDisplay' => [
'description' => '是否样本展示',
'type' => 'boolean',
'example' => 'true',
],
'type' => [
'description' => '例如:实时行为记录的bhv_time不合法。'."\n",
'type' => 'string',
'example' => 'bhvTimeBehavior',
],
'errorCount' => [
'description' => '错误数',
'type' => 'integer',
'format' => 'int32',
'example' => '246165',
],
'errorPercent' => [
'description' => '异常记录占比',
'type' => 'number',
'format' => 'float',
'example' => '84.6',
],
'defaultDisplay' => [
'description' => '是否默认展示',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"historyData\\": [\\n {\\n \\"errorPercent\\": 84.6,\\n \\"startTime\\": 1586673466,\\n \\"endTime\\": 1586673466\\n }\\n ],\\n \\"sampleDisplay\\": true,\\n \\"type\\": \\"bhvTimeBehavior\\",\\n \\"errorCount\\": 246165,\\n \\"errorPercent\\": 84.6,\\n \\"defaultDisplay\\": false\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 84.6\\n 290993\\n 246165\\n 1567152000\\n 1567155600\\n \\n \\n userIdBehavior\\n 0\\n 100\\n \\n 0\\n 1567119600\\n 1567123200\\n \\n \\n 0\\n 1567119600\\n 1567123200\\n \\n \\n \\n userIdBehavior\\n 0\\n 100\\n \\n 0\\n 1567119600\\n 1567123200\\n \\n \\n 0\\n 1567119600\\n 1567123200\\n \\n \\n\\nAD3BCF47-2A4C-44DD-B6B7-CC2F2BCB1DB9","errorExample":""}]',
'title' => '获取实时数据小时级别报告细节信息',
'summary' => '获取实时数据小时级别报告细节信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeSyncReportOutliers' => [
'path' => '/v2/openapi/instances/{instanceId}/sync-reports/outliers',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18692',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-test',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'key',
'in' => 'query',
'schema' => [
'description' => 'itemBhv'."\n"
.'实时行为中,商品ID是否存在于商品库中'."\n"
.'userBhv'."\n"
.'实时行为中,用户ID是否存在于用户库中'."\n"
.'bhvTypeBhv'."\n"
.'实时行为中,bhv_type是否合法'."\n"
.'traceIdBhv'."\n"
.'实时行为中,trace_id是否合法'."\n"
.'traceInfoBhv'."\n"
.'实时行为中,trace_info是否合法'."\n"
.'itemItem'."\n"
.'修改记录物品ID是否合法'."\n"
.'userUser'."\n"
.'修改记录用户ID是否合法',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'itemBhv',
],
],
[
'name' => 'type',
'in' => 'query',
'schema' => [
'description' => '数据表名(behavior/item/user)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hehavoir',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'levelType',
'in' => 'query',
'schema' => [
'description' => '异常级别(error/warn/info)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'error',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果'."\n"
."\n",
'type' => 'object',
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '获取实时数据报告异常明细',
'summary' => '获取实时数据报告异常明细。',
],
'DescribeUserMetrics' => [
'path' => '/v2/openapi/instances/{instanceId}/metrics',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18693',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间(秒级时间戳)',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1567152000',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间(秒级时间戳)',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1658110530',
],
],
[
'name' => 'metricType',
'in' => 'query',
'schema' => [
'description' => '查询数据类型:'."\n"
."\n"
.'- pvCtr'."\n"
.'- uvCtr',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pvCtr',
],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '返回结果'."\n",
'type' => 'object',
'properties' => [
'sceneId' => [
'description' => '场景ID',
'type' => 'string',
'example' => 'test',
],
'dataPoints' => [
'description' => '指标结果',
'type' => 'array',
'items' => [
'description' => '指标结果',
'type' => 'object',
'properties' => [
'val' => [
'description' => '具体数值',
'type' => 'number',
'format' => 'float',
'example' => '84.6',
],
'startTime' => [
'description' => '开始时间(秒级时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1567152000',
],
'endTime' => [
'description' => '结束时间(秒级时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1567152000',
],
],
],
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"sceneId\\": \\"test\\",\\n \\"dataPoints\\": [\\n {\\n \\"val\\": 84.6,\\n \\"startTime\\": 1567152000,\\n \\"endTime\\": 1567152000\\n }\\n ]\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '获取用户指标(转化率信息)',
'summary' => '获取用户指标(转化率信息)。',
],
'GetExtraDataSource' => [
'summary' => '查看其他数据源详情。',
'path' => '/v2/openapi/instances/{instanceId}/extra-data-sources/{type}/{dataSourceId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117108',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
'title' => 'A short description of struct',
],
],
[
'name' => 'type',
'in' => 'path',
'schema' => [
'description' => '数据源类型'."\n"
.'UserCustomDataSource'."\n"
.'ItemCustomDataSource'."\n"
.'BehaviorCustomDataSource'."\n"
.'SampleCustomDataSource',
'type' => 'string',
'required' => true,
'example' => 'UserCustomDataSource',
'title' => '数据源类型',
],
],
[
'name' => 'dataSourceId',
'in' => 'path',
'schema' => [
'description' => '数据源ID',
'type' => 'string',
'required' => true,
'example' => '123',
'title' => '数据源id',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'$ref' => '#/components/schemas/ExtraDataSource',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"\\n UserCustomDataSource\\n \\n ExtraDataSource\\n project_name\\n table\\n ODPS\\n 86400\\n false\\n \\n Online\\n 2021-11-30T11:53:05.000Z\\n 2021-11-30T11:53:05.000Z\\n cd4bb4b3-1e54-4dbb-a178-e58dac4035a5\\n\\n90D6B8F5-FE97-4509-9AAB-367836C51818","errorExample":""}]',
'title' => '查看其他数据源详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDashboardDetails' => [
'path' => '/v2/openapi/instances/{instanceId}/dashboard/details',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18696',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间,秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1588521600',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间,秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1588521600',
],
],
[
'name' => 'traceIds',
'in' => 'query',
'schema' => [
'description' => 'trace_Id,同数据规范',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Alibaba',
],
],
[
'name' => 'sceneIds',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'metricType',
'in' => 'query',
'schema' => [
'description' => '查询指标,枚举选择'."\n"
."\n"
.'USER_ACTION_PV_COUNT 整体流量规模PV'."\n"
."\n"
.'USER_ACTION_UV_COUNT 整体流量规模UV'."\n"
."\n"
.'USER_ACTION_PV_RATIO 流量转化率'."\n"
."\n"
.'USER_ACTION_UV_RATIO 人均流量'."\n"
."\n"
.'USER_PV_STAY 人均停留 (内容型)'."\n"
."\n"
.'USER_UV_STAY 次均停留 (内容型)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'xxx',
],
],
[
'name' => 'experimentIds',
'in' => 'query',
'schema' => [
'description' => '实验ID列表,all(场景级别整体效果)。默认值为all。',
'type' => 'string',
'required' => false,
'example' => 'all',
],
],
[
'name' => 'matchTypes',
'in' => 'query',
'schema' => [
'description' => '匹配类型列表。',
'type' => 'string',
'required' => false,
'example' => 'hot,emb,u2x2i,hilp,new,',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '指定指标的详细信息'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'traceId' => [
'description' => 'trace_id',
'type' => 'string',
'example' => 'Alibaba',
],
'sceneId' => [
'description' => '场景ID',
'type' => 'string',
'example' => 'test',
],
'metricRes' => [
'description' => '指标结果'."\n",
'type' => 'object',
'properties' => [
'total' => [
'description' => '统计',
'type' => 'object',
'example' => 'xxx',
],
'detail' => [
'description' => '详细信息',
'type' => 'object',
'example' => 'xxx',
],
],
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"traceId\\": \\"Alibaba\\",\\n \\"sceneId\\": \\"test\\",\\n \\"metricRes\\": {\\n \\"total\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"detail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n alibaba\\n scene_id1\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 1588521600\\n 1588525200\\n 0\\n \\n \\n 0\\n 0\\n 1588003200\\n 1588006800\\n 0\\n \\n \\n 0\\n 0\\n 1588089600\\n 1588093200\\n 0\\n \\n \\n 0\\n 0\\n 1588176000\\n 1588179600\\n 0\\n \\n \\n 0\\n 0\\n 1588262400\\n 1588266000\\n 0\\n \\n \\n 0\\n 0\\n 1588348800\\n 1588352400\\n 0\\n \\n \\n 0\\n 0\\n 1588435200\\n 1588438800\\n 0\\n \\n \\n 0\\n 0\\n 1588521600\\n 1588525200\\n 0\\n \\n \\n\\n\\n alibaba\\n all\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 1588521600\\n 1588525200\\n 0\\n \\n \\n 0\\n 0\\n 1588003200\\n 1588006800\\n 0\\n \\n \\n 0\\n 0\\n 1588089600\\n 1588093200\\n 0\\n \\n \\n 0\\n 0\\n 1588176000\\n 1588179600\\n 0\\n \\n \\n 0\\n 0\\n 1588262400\\n 1588266000\\n 0\\n \\n \\n 0\\n 0\\n 1588348800\\n 1588352400\\n 0\\n \\n \\n 0\\n 0\\n 1588435200\\n 1588438800\\n 0\\n \\n \\n 0\\n 0\\n 1588521600\\n 1588525200\\n 0\\n \\n \\n","errorExample":""}]',
'title' => 'ListDashboardDetails',
'summary' => '通过指定条件查询指定实例的细分指标。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDashboardDetailsFlows' => [
'path' => '/v2/openapi/instances/{instanceId}/dashboard/details/flows',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18697',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1588521600',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1588521600',
],
],
[
'name' => 'traceIds',
'in' => 'query',
'schema' => [
'description' => 'trace_Id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Alibaba',
],
],
[
'name' => 'sceneIds',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'metricType',
'in' => 'query',
'schema' => [
'description' => '查询指标,枚举选择'."\n"
."\n"
.'USER_ACTION_PV_COUNT 整体流量规模PV'."\n"
."\n"
.'USER_ACTION_UV_COUNT 整体流量规模UV'."\n"
."\n"
.'USER_ACTION_PV_RATIO 流量转化率'."\n"
."\n"
.'USER_ACTION_UV_RATIO 人均流量'."\n"
."\n"
.'USER_PV_STAY 人均停留 (内容型)'."\n"
."\n"
.'USER_UV_STAY 次均停留 (内容型)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'USERACTIONUV_COUNT',
],
],
[
'name' => 'experimentIds',
'in' => 'query',
'schema' => [
'description' => '实验ID列表,all(场景级别整体效果)。默认值为all。',
'type' => 'string',
'required' => false,
'example' => 'all',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '指定指标的详细信息'."\n"
."\n",
'type' => 'object',
'properties' => [
'metricType' => [
'description' => '查询指标,枚举选择'."\n"
."\n"
.'USER_ACTION_PV_COUNT 整体流量规模PV'."\n"
."\n"
.'USER_ACTION_UV_COUNT 整体流量规模UV'."\n"
."\n"
.'USER_ACTION_PV_RATIO 流量转化率'."\n"
."\n"
.'USER_ACTION_UV_RATIO 人均流量'."\n"
."\n"
.'USER_PV_STAY 人均停留 (内容型)'."\n"
."\n"
.'USER_UV_STAY 次均停留 (内容型)',
'type' => 'string',
'example' => 'USERACTIONUV_COUNT',
],
'metricData' => [
'description' => '指标结果',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'traceId' => [
'description' => 'trace_id',
'type' => 'string',
'example' => 'Alibaba',
],
'sceneId' => [
'description' => '场景ID',
'type' => 'string',
'example' => 'test',
],
'metricRes' => [
'description' => '指标结果',
'type' => 'object',
'example' => 'xxx',
],
],
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"metricType\\": \\"USERACTIONUV_COUNT\\",\\n \\"metricData\\": [\\n {\\n \\"traceId\\": \\"Alibaba\\",\\n \\"sceneId\\": \\"test\\",\\n \\"metricRes\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n cart\\n \\n alibaba\\n scene_id1\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 1588521600\\n 1588525200\\n 0\\n \\n \\n 0\\n 0\\n 1585929600\\n 1585933200\\n 0\\n \\n \\n 0\\n 0\\n 1586016000\\n 1586019600\\n 0\\n \\n \\n \\n \\n alibaba\\n all\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 1588521600\\n 1588525200\\n 0\\n \\n \\n 0\\n 0\\n 1588521600\\n 1588525200\\n 0\\n \\n \\n \\n","errorExample":""}]',
'title' => '通过指定条件查询实例的细分流量指标',
'summary' => '通过指定条件查询指定实例的细分流量指标。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDashboardMetrics' => [
'path' => '/v2/openapi/instances/{instanceId}/dashboard/metrics',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18698',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '起始时间,秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '截止时间,秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1586673466',
],
],
[
'name' => 'metricType',
'in' => 'query',
'schema' => [
'description' => '指标类型'."\n"
."\n"
.'USER_ACTION_PV_COUNT 整体流量规模PV'."\n"
."\n"
.'USER_ACTION_UV_COUNT 整体流量规模UV'."\n"
."\n"
.'USER_ACTION_PV_RATIO 流量转化率'."\n"
."\n"
.'USER_ACTION_UV_RATIO 人均流量',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '指标类型'."\n"
."\n"
.'USERACTIONPV_COUNT',
],
],
[
'name' => 'metricView',
'in' => 'query',
'schema' => [
'description' => '查询维度,配合metricQuery使用,默认值为USER, 枚举值如下;'."\n"
.' USER 用户维度,'."\n"
.' ITEM 物品维度',
'type' => 'string',
'required' => false,
'example' => 'ITEM',
],
],
[
'name' => 'metricQuery',
'in' => 'query',
'schema' => [
'description' => '查询条件,格式 k1:v1;k2:v2',
'type' => 'string',
'required' => false,
'example' => 'dimension:ITEM_TYPE;behaviorType:expose',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '统计结果'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'total' => [
'description' => '统计',
'type' => 'object',
'example' => 'xxx',
],
'detail' => [
'description' => '详细信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'val' => [
'description' => '具体数值',
'type' => 'string',
'example' => '13',
],
'startTime' => [
'description' => '秒级时间戳',
'type' => 'string',
'example' => '1586673466',
],
'endTime' => [
'description' => '秒级时间戳',
'type' => 'string',
'example' => '1586673466',
],
],
],
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"total\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"detail\\": [\\n {\\n \\"val\\": \\"13\\",\\n \\"startTime\\": \\"1586673466\\",\\n \\"endTime\\": \\"1586673466\\"\\n }\\n ]\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n \\n 32\\n 32\\n 32\\n 32\\n 32\\n 32\\n 1586673466\\n 1586673466\\n 32\\n \\n \\n 13\\n 1586673466\\n 1586673466\\n \\n \\n 32\\n 1586673466\\n 1586673466\\n \\n","errorExample":""}]',
'title' => 'ListDashboardMetrics',
'summary' => '查询指定实例的整理仪表盘数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDashboardMetricsFlows' => [
'path' => '/v2/openapi/instances/{instanceId}/dashboard/metrics/flows',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18699',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'metricType',
'in' => 'query',
'schema' => [
'description' => '指标类型'."\n"
."\n"
.'USER_ACTION_PV_COUNT 整体流量规模PV'."\n"
."\n"
.'USER_ACTION_UV_COUNT 整体流量规模UV'."\n"
."\n"
.'USER_ACTION_PV_RATIO 流量转化率'."\n"
."\n"
.'USER_ACTION_UV_RATIO 人均流量',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'USERACTIONPV_COUNT',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '统计结果'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'metricType' => [
'description' => '指标类型',
'type' => 'string',
'example' => 'xxx',
],
'metricData' => [
'description' => '指标数据',
'type' => 'object',
'example' => 'xxx',
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"metricType\\": \\"xxx\\",\\n \\"metricData\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n click\\n \\n 32\\n 32\\n 32\\n 32\\n 32\\n 32\\n 1586673466\\n 1586673466\\n \\n 10\\n 1586673466\\n 1586673466\\n click\\n \\n \\n 10\\n 1586673466\\n 1586673466\\n expose\\n \\n 32\\n \\n","errorExample":""}]',
'title' => '查询指定实例的整理仪表盘流量数据',
'summary' => '查询指定实例的整理仪表盘流量数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListFeatureTables' => [
'summary' => '获取特征表列表。',
'path' => '/v2/openapi/instances/{instanceId}/feature-tables',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117113',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '特征表id',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'type',
'in' => 'query',
'schema' => [
'title' => '特征表类型',
'description' => '特征表类型',
'type' => 'string',
'required' => false,
'example' => 'ItemFeatureTable UserFeatureTable',
],
],
[
'name' => 'updateFrequency',
'in' => 'query',
'schema' => [
'title' => '特征更新频率',
'description' => '特征更新频率',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'dataSourceId',
'in' => 'query',
'schema' => [
'title' => '数据源id',
'description' => '数据源id',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果详情',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求id',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'title' => 'result',
'description' => '返回结果数组',
'type' => 'array',
'items' => [
'description' => '返回结果',
'$ref' => '#/components/schemas/FeatureTable',
],
'example' => 'result',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"Meta\\": {\\n \\"DataSourceId\\": \\"907648f5-abae-44fd-a4c4-525cc25947e9\\",\\n \\"FeatureList\\": [\\n {\\n \\"Comment\\": \\"com11\\",\\n \\"FeatureName\\": \\"fn11\\",\\n \\"FieldName\\": \\"fieldName11\\",\\n \\"Status\\": \\"NotApplied 未应用 Applied 已应用\\"\\n }\\n ],\\n \\"Internal\\": true,\\n \\"MetaType\\": \\"FeatureTable\\",\\n \\"Source\\": \\"test_project.test_table\\",\\n \\"UpdateFrequency\\": 86400\\n },\\n \\"FeatureTableId\\": \\"30E70118-FC7C-4438-9287-583CE47266A9\\",\\n \\"Type\\": \\"ItemFeatureTable 物品特征表 UserFeatureTable 用户特征表\\",\\n \\"GmtCreate\\": \\"2021-12-10T02:59:54.000Z\\",\\n \\"GmtModified\\": \\"2021-12-10T02:59:54.000Z\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取特征表列表',
],
'ListIndexVersions' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/index-versions',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18704',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '指定的表ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'abc',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应体',
'type' => 'object',
'properties' => [
'result' => [
'description' => '召回表信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'code' => [
'description' => '错误码',
'type' => 'string',
'example' => 'abc',
],
'switchedTime' => [
'description' => '索引切换完成时间,为UTC时间',
'type' => 'string',
'example' => '2020-11-08T02:00:00Z',
],
'rollbackEnabled' => [
'description' => '是否可以回滚',
'type' => 'boolean',
'example' => 'true',
],
'message' => [
'description' => '错误信息',
'type' => 'string',
'example' => 'xxx',
],
'flowType' => [
'description' => '任务类型,包含 Auto Manual Rollback ',
'type' => 'string',
'example' => 'Auto',
],
'costSeconds' => [
'description' => '索引构建耗时',
'type' => 'integer',
'format' => 'int32',
'example' => '600',
],
'builtTime' => [
'description' => '索引开始构建时间,为UTC时间',
'type' => 'string',
'example' => '2020-11-08T02:00:00Z',
],
'versionId' => [
'description' => '索引版本的版本号,后端生成',
'type' => 'string',
'example' => '2020112301',
],
'size' => [
'description' => '索引构建大小',
'type' => 'integer',
'format' => 'int64',
'example' => '300922211',
],
'status' => [
'description' => '索引状态,包含索引:'."\n"
."\n"
.'- 失败(failed)'."\n"
.'- 生效中(online)'."\n"
.'- 已失效(offline)'."\n"
."\n"
.'全量任务:'."\n"
."\n"
.'- 全量中(pending)'."\n"
.'- 已完成(success)'."\n"
.'- 失败(failed)'."\n"
."\n"
.'等',
'type' => 'string',
'example' => 'abc',
],
'progress' => [
'description' => '进度展示百分比,例如80',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
],
],
],
'requestId' => [
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"code\\": \\"abc\\",\\n \\"switchedTime\\": \\"2020-11-08T02:00:00Z\\",\\n \\"rollbackEnabled\\": true,\\n \\"message\\": \\"xxx\\",\\n \\"flowType\\": \\"Auto\\",\\n \\"costSeconds\\": 600,\\n \\"builtTime\\": \\"2020-11-08T02:00:00Z\\",\\n \\"versionId\\": \\"2020112301\\",\\n \\"size\\": 300922211,\\n \\"status\\": \\"abc\\",\\n \\"progress\\": 80\\n }\\n ],\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取索引版本列表',
'summary' => '根据指定的实例ID,召回表ID获取索引版本列表。目前仅支持显示10条数据(包含3条可以切换的),所以不用翻页,不用过滤。',
],
'ListInstanceTask' => [
'path' => '/v2/openapi/instances/{instanceId}/tasks',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18706',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果。',
'type' => 'array',
'items' => [
'description' => '返回详情结果'."\n",
'type' => 'object',
'properties' => [
'subProgressInfos' => [
'description' => '子任务具体进度信息列表',
'type' => 'array',
'items' => [
'description' => '子任务具体进度信息列表',
'type' => 'object',
'properties' => [
'type' => [
'description' => '子任务类型',
'type' => 'string',
'example' => 'DATA_PROCESS',
],
'detail' => [
'description' => '子任务具体描述',
'type' => 'string',
'example' => 'data import progress info',
],
'totalNum' => [
'description' => '子任务一共的任务数量',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'finishedNum' => [
'description' => '已完成子任务数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'progress' => [
'description' => '执行进度'."\n"
.'范围为0-100'."\n"
.'100为执行结束',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
],
],
],
'totalProgress' => [
'description' => '当前任务整体进度',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'name' => [
'description' => '任务名称',
'type' => 'string',
'example' => '启动任务',
],
],
],
],
'code' => [
'description' => '错误码',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求的RequestID',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'successful',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"subProgressInfos\\": [\\n {\\n \\"type\\": \\"DATA_PROCESS\\",\\n \\"detail\\": \\"data import progress info\\",\\n \\"totalNum\\": 11,\\n \\"finishedNum\\": 2,\\n \\"progress\\": 20\\n }\\n ],\\n \\"totalProgress\\": 50,\\n \\"name\\": \\"启动任务\\"\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"successful\\"\\n}","type":"json"}]',
'title' => '查询指定实例的任务列表',
'summary' => '查询指定实例的任务列表。',
],
'ListItems' => [
'path' => '/v2/openapi/instances/{instanceId}/items/actions/list',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18707',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'strategyUsed',
'in' => 'query',
'schema' => [
'description' => '默认false,传入true 则使用置顶/定坑侧逻辑,但是必须在body中传入 sceneId',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'withInvalidDetail',
'in' => 'query',
'schema' => [
'description' => '置顶/定坑侧控制返回值中是否包含InvalidDetail'."\0".', 用于 itemId:itemType 查询类型使用',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '页数,默认1',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '每页数量,默认10',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '1000',
'minimum' => '1',
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '结果',
'type' => 'object',
'properties' => [
'total' => [
'description' => '统计',
'type' => 'object',
'properties' => [
'sceneWeightItem' => [
'description' => '场景加权物品数量',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'totalCount' => [
'description' => '全部数量',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
'queryCount' => [
'description' => '列出数量',
'type' => 'integer',
'format' => 'int64',
'example' => '3000',
],
'sceneRecommendItem' => [
'description' => '场景可推荐物品数量',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'weightItem' => [
'description' => '加权物品',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'instanceRecommendItem' => [
'description' => '实例可推荐物品数量',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
'detail' => [
'description' => '详细信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'title' => [
'description' => '标题',
'type' => 'string',
'example' => 'test',
],
'categoryPath' => [
'description' => '类目路径',
'type' => 'string',
'example' => '1_2',
],
'itemId' => [
'description' => 'itemId,同数据规范同字段',
'type' => 'string',
'example' => '123',
],
'itemType' => [
'description' => 'itemType,同数据规范同字段',
'type' => 'string',
'example' => 'item',
],
'status' => [
'description' => '是否可推荐',
'type' => 'string',
'example' => '1',
],
'brandId' => [
'description' => '品牌ID',
'type' => 'string',
'example' => '1',
],
'shopId' => [
'description' => '店铺ID',
'type' => 'string',
'example' => '1',
],
'pubTime' => [
'description' => '发布时间',
'type' => 'string',
'example' => '1647998107012',
],
'channel' => [
'description' => '频道',
'type' => 'string',
'example' => 'news',
],
'duration' => [
'description' => '持续时间',
'type' => 'string',
'example' => '30',
],
'author' => [
'description' => '作者',
'type' => 'string',
'example' => 'abc',
],
'expireTime' => [
'description' => '过期时间',
'type' => 'string',
'example' => '1647998107012',
],
],
],
],
],
],
'requestId' => [
'description' => '当前请求的RequestID',
'type' => 'string',
'example' => '6839AE7C-A984-48C1-AC17-331BAC6D97BC',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"total\\": {\\n \\"sceneWeightItem\\": 10,\\n \\"totalCount\\": 5000,\\n \\"queryCount\\": 3000,\\n \\"sceneRecommendItem\\": 200,\\n \\"weightItem\\": 10,\\n \\"instanceRecommendItem\\": 200\\n },\\n \\"detail\\": [\\n {\\n \\"title\\": \\"test\\",\\n \\"categoryPath\\": \\"1_2\\",\\n \\"itemId\\": \\"123\\",\\n \\"itemType\\": \\"item\\",\\n \\"status\\": \\"1\\",\\n \\"brandId\\": \\"1\\",\\n \\"shopId\\": \\"1\\",\\n \\"pubTime\\": \\"1647998107012\\",\\n \\"channel\\": \\"news\\",\\n \\"duration\\": \\"30\\",\\n \\"author\\": \\"abc\\",\\n \\"expireTime\\": \\"1647998107012\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"6839AE7C-A984-48C1-AC17-331BAC6D97BC\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取列表项',
'summary' => '查询实例物品池。',
],
'ListLogs' => [
'path' => '/v2/openapi/instances/{instanceId}/logs',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18708',
'abilityTreeNodes' => [
'FEATUREairecY1ADIM',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'queryParams',
'in' => 'query',
'schema' => [
'description' => '查询条件:'."\n"
.'key1:value1;key2:value;'."\n"
.'例如:requestId:xxxx;requestUri:xxx;',
'type' => 'string',
'required' => false,
'example' => 'key1:value1;key2:value',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间(秒级时间戳)',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '2147483647',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间 (秒级时间戳)'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '2147483647',
'minimum' => '1565193600',
'example' => '1678155766',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '页数,默认1',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '指定每页展示条数,默认为10,限制:[1-50]',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '1000',
'minimum' => '1',
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n",
'type' => 'array',
'items' => [
'description' => '查询结果'."\n",
'type' => 'object',
],
],
'headers' => [
'description' => 'headers info',
'type' => 'object',
'properties' => [
'X-Total-Count' => [
'description' => '查询总量'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
],
],
'code' => [
'description' => '错误码',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"headers\\": {\\n \\"X-Total-Count\\": 12\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '获取日志列表',
'summary' => '该接口用于获取指定实例的日志信息(近七日内)。',
],
'ListMixCategories' => [
'path' => '/v2/openapi/configurations/mixCategories',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18709',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '查询结果'."\n",
'type' => 'object',
'properties' => [
'categories' => [
'description' => '类目',
'type' => 'array',
'items' => [
'description' => '类目',
'type' => 'integer',
'format' => 'int64',
'example' => 'aaaa',
],
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'ED093A1D-1C56-57A2-B078-3C518F632F03',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'Success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"categories\\": [\\n 0\\n ]\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"ED093A1D-1C56-57A2-B078-3C518F632F03\\",\\n \\"message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => 'ListMixCategories',
'summary' => '查询类目列表。',
],
'ListOfflineStorages' => [
'summary' => '查询离线存储。',
'path' => '/v2/openapi/instances/[instanceId]/offlineStorages',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '20401',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'instanceId',
'description' => 'instanceId',
'type' => 'string',
'format' => 'byte',
'required' => true,
'example' => 'airec-cn-xxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'format' => 'byte',
'example' => '6839AE7C-A984-48C1-AC17-331BAC6D97BC',
],
'result' => [
'title' => '结果列表',
'description' => '结果列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'tableName' => [
'title' => '表名称',
'description' => '表名称',
'type' => 'string',
'format' => 'byte',
'example' => 'item',
],
'meta' => [
'title' => '元信息',
'description' => '元信息',
'type' => 'object',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6839AE7C-A984-48C1-AC17-331BAC6D97BC\\",\\n \\"result\\": [\\n {\\n \\"tableName\\": \\"item\\",\\n \\"meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询离线存储',
],
'ListRuleConditions' => [
'path' => '/v2/openapi/instances/{instanceId}/rule-conditions',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18711',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果',
'type' => 'array',
'items' => [
'description' => '返回详情结果',
'type' => 'object',
'properties' => [
'selectType' => [
'description' => '选品规则过滤条件类型',
'type' => 'string',
'example' => 'QUERY_ITEM_TYPE',
],
'selectValue' => [
'description' => '选品规则过滤条件具体数值'."\n",
'type' => 'string',
'example' => '[\\"image\\",\\"article\\",\\"video\\",\\"shortvideo\\",\\"item\\",\\"recipe\\",\\"audio\\"]',
],
'selectionOperation' => [
'description' => '选品规则过滤条件操作'."\n",
'type' => 'string',
'example' => 'QUERY_VALUE_IN',
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"selectType\\": \\"QUERY_ITEM_TYPE\\",\\n \\"selectValue\\": \\"[\\\\\\\\\\\\\\"image\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"article\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"video\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"shortvideo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"item\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"recipe\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"audio\\\\\\\\\\\\\\"]\\",\\n \\"selectionOperation\\": \\"QUERY_VALUE_IN\\"\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '查询实例具体的选品规则',
'summary' => '查询实例具体的选品规则.。',
],
'ListRuleTasks' => [
'path' => '/v2/openapi/instances/{instanceId}/rule-tasks',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18713',
'abilityTreeNodes' => [
'FEATUREairecJZYTIA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'sceneId',
'in' => 'query',
'schema' => [
'description' => '场景id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testid',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果'."\n",
'type' => 'object',
'properties' => [
'finishTime' => [
'description' => '完成时间',
'type' => 'integer',
'format' => 'int32',
'example' => '1588240081',
],
'finishRate' => [
'description' => '完成率',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"finishTime\\": 1588240081,\\n \\"finishRate\\": 50\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"B352FBD9-4643-441E-80ED-699D47D7B6A3\\n\\n 50\\n 1588240081\\n","errorExample":""}]',
'title' => '查询规则的任务状态',
'summary' => '查询规则的任务状态。',
],
'ListSampleFormatConfigs' => [
'summary' => '获取样本格式化配置列表。',
'path' => '/v2/openapi/instances/{instanceId}/samples/{sampleId}/format-configs',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '117133',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
'title' => 'A short description of struct',
],
],
[
'name' => 'sampleId',
'in' => 'path',
'schema' => [
'description' => '样本id',
'type' => 'string',
'required' => true,
'example' => '123',
'title' => '样本id',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'EDF43C1F-99E4-431F-A7C0-8B260A5A792E',
'title' => 'Id of the request',
],
'result' => [
'description' => '格式化配置列表',
'type' => 'object',
'example' => 'xxx',
'title' => 'result',
],
],
'title' => 'Schema of Response',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"EDF43C1F-99E4-431F-A7C0-8B260A5A792E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n SampleFormatConfig\\n 111\\n {\\"features\\":[{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100000.0,\\"expression\\":\\"user:user_id\\",\\"feature_name\\":\\"user_id\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"user\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100.0,\\"expression\\":\\"user:cms_segid\\",\\"feature_name\\":\\"cms_segid\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"user\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100.0,\\"expression\\":\\"user:cms_group_id\\",\\"feature_name\\":\\"cms_group_id\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"user\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":10.0,\\"expression\\":\\"user:age_level\\",\\"feature_name\\":\\"age_level\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"user\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":10.0,\\"expression\\":\\"user:pvalue_level\\",\\"feature_name\\":\\"pvalue_level\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"user\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":10.0,\\"expression\\":\\"user:shopping_level\\",\\"feature_name\\":\\"shopping_level\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"user\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":10.0,\\"expression\\":\\"user:occupation\\",\\"feature_name\\":\\"occupation\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"user\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":10.0,\\"expression\\":\\"user:new_user_class_level\\",\\"feature_name\\":\\"new_user_class_level\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"user\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100000.0,\\"expression\\":\\"item:adgroup_id\\",\\"feature_name\\":\\"adgroup_id\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"item\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100000.0,\\"expression\\":\\"item:cate_id\\",\\"feature_name\\":\\"cate_id\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"item\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100000.0,\\"expression\\":\\"item:campaign_id\\",\\"feature_name\\":\\"campaign_id\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"item\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100000.0,\\"expression\\":\\"item:customer\\",\\"feature_name\\":\\"customer\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"item\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100000.0,\\"expression\\":\\"item:brand\\",\\"feature_name\\":\\"brand\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"item\\"},{\\"feature_type\\":\\"raw_feature\\",\\"value_type\\":\\"Integer\\",\\"expression\\":\\"item:price\\",\\"feature_name\\":\\"price\\",\\"combiner\\":\\"mean\\",\\"group\\":\\"item\\"},{\\"feature_type\\":\\"id_feature\\",\\"value_type\\":\\"String\\",\\"hash_bucket_size\\":100000.0,\\"expression\\":\\"item:pid\\",\\"feature_name\\":\\"pid\\",\\"embedding_dim\\":16.0,\\"combiner\\":\\"mean\\",\\"group\\":\\"item\\"},{\\"feature_type\\":\\"id_feature\\",\\"hash_bucket_size\\":100000.0,\\"expression\\":\\"user:tag_category_list\\",\\"feature_name\\":\\"user_tag_cate\\",\\"group\\":\\"user\\",\\"is_multi\\":true},{\\"feature_type\\":\\"combo_feature\\",\\"hash_bucket_size\\":10.0,\\"expression\\":[\\"user:user_id\\",\\"user:occupation\\"],\\"feature_name\\":\\"combo__user_id_occupation\\",\\"embedding_dim\\":16.0,\\"group\\":\\"combo\\"},{\\"feature_type\\":\\"combo_feature\\",\\"hash_bucket_size\\":10.0,\\"expression\\":[\\"user:age_level\\",\\"item:customer\\"],\\"feature_name\\":\\"combo__age_level_customer\\",\\"embedding_dim\\":16.0,\\"group\\":\\"combo\\"},{\\"feature_type\\":\\"combo_feature\\",\\"hash_bucket_size\\":10.0,\\"expression\\":[\\"user:pvalue_level\\",\\"item:brand\\"],\\"feature_name\\":\\"combo__pvalue_level_brand\\",\\"embedding_dim\\":16.0,\\"group\\":\\"combo\\"}]}\\n \\n \\n 2021-12-07T08:58:19.000Z\\n 2021-12-07T08:58:19.000Z\\n 99D369F6-0A73-4247-9E9F-F693A16CD6AC\\n\\n1AEB0EBA-07EF-4C18-85FD-DC93B7A07DA2","errorExample":""}]',
'title' => '获取样本格式化配置列表',
],
'ListSceneItems' => [
'path' => '/v2/openapi/instances/{instanceId}/scenes/{sceneId}/items',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18714',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例id'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'sceneId',
'in' => 'path',
'schema' => [
'description' => '场景id'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testid',
],
],
[
'name' => 'operationRuleId',
'in' => 'query',
'schema' => [
'description' => '运营规则id'."\n",
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'selectionRuleId',
'in' => 'query',
'schema' => [
'description' => '选品规则id'."\n",
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '指定页码,默认为:1'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '指定每页展示条数,默认为10,限制:[1-50]'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '128',
'minimum' => '0',
'example' => '10',
],
],
[
'name' => 'previewType',
'in' => 'query',
'schema' => [
'description' => '预览类型:'."\n"
."\n"
.'PREVIEW_ITEM 单独预览选品规则预览结果'."\n"
."\n"
.'PREVIEW_QUERY 预览整体配置结果',
'type' => 'string',
'required' => false,
'example' => 'PREVIEW_ITEM',
],
],
[
'name' => 'queryCount',
'in' => 'query',
'schema' => [
'description' => '查询数量'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果'."\n"
."\n",
'type' => 'object',
'properties' => [
'total' => [
'description' => '统计',
'type' => 'object',
'properties' => [
'totalCount' => [
'description' => '实例中item总数',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'sceneWeightItem' => [
'description' => '当前场景加权的item数',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'sceneRecommendItem' => [
'description' => '当前场景下可推荐的item数',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'weightItem' => [
'description' => '实例中加权的item数',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'instanceRecommendItem' => [
'description' => '当前实例可推荐的item数',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
],
],
'detail' => [
'description' => '详情',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'title' => [
'description' => '标题',
'type' => 'string',
'example' => 'title',
],
'categoryPath' => [
'description' => '类目路径',
'type' => 'string',
'example' => '12_34',
],
'itemId' => [
'description' => 'item_id',
'type' => 'string',
'example' => '123',
],
'itemType' => [
'description' => 'item_type',
'type' => 'string',
'example' => 'video',
],
'status' => [
'description' => '是否可推荐,1为可推荐,0为不可推荐',
'type' => 'string',
'example' => '1',
],
'brandId' => [
'description' => '品牌id',
'type' => 'string',
'example' => '123',
],
'shopId' => [
'description' => '店铺id',
'type' => 'string',
'example' => '123',
],
'pubTime' => [
'description' => '发布时间',
'type' => 'string',
'example' => '1612687809',
],
'channel' => [
'description' => '频道',
'type' => 'string',
'example' => '娱乐',
],
'duration' => [
'description' => '停留时长',
'type' => 'string',
'example' => '300',
],
'author' => [
'description' => '作者',
'type' => 'string',
'example' => 'zhangsan',
],
'expireTime' => [
'description' => '失效时间',
'type' => 'string',
'example' => '1612687809',
],
],
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"total\\": {\\n \\"totalCount\\": 1000,\\n \\"sceneWeightItem\\": 1000,\\n \\"sceneRecommendItem\\": 1000,\\n \\"weightItem\\": 1000,\\n \\"instanceRecommendItem\\": 1000\\n },\\n \\"detail\\": [\\n {\\n \\"title\\": \\"title\\",\\n \\"categoryPath\\": \\"12_34\\",\\n \\"itemId\\": \\"123\\",\\n \\"itemType\\": \\"video\\",\\n \\"status\\": \\"1\\",\\n \\"brandId\\": \\"123\\",\\n \\"shopId\\": \\"123\\",\\n \\"pubTime\\": \\"1612687809\\",\\n \\"channel\\": \\"娱乐\\",\\n \\"duration\\": \\"300\\",\\n \\"author\\": \\"zhangsan\\",\\n \\"expireTime\\": \\"1612687809\\"\\n }\\n ]\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 200\\n 50\\n 10\\n 2217\\n 5000\\n \\n \\n 15755228600501_15755228759463\\n item\\n \\n 1024_10003\\n 1575523106\\n 15692083252170\\n 1\\n \\n 澜笛若慕洁面乳\\n 1\\n 123123\\n 123123\\n 123123\\n \\n\\n6839AE7C-A984-48C1-AC17-331BAC6D97BC","errorExample":""}]',
'title' => '获取预览结果',
'summary' => '获取预览结果。',
'description' => '如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见官方文档:[通过选投策略配置,快速搭建推荐场景](https://help.aliyun.com/document_detail/171790.html?spm=a2c4g.11186623.6.677.1f6a3483tNyo2M)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSceneParameters' => [
'path' => '/v2/openapi/instances/{instanceId}/dashboard/scene-parameters',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18715',
'abilityTreeNodes' => [
'FEATUREairecX63J28',
'FEATUREairec5G3YBA',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果',
'type' => 'object',
'properties' => [
'traceId' => [
'description' => '渠道列表'."\n",
'type' => 'array',
'items' => [
'description' => 'trace_id',
'type' => 'string',
'example' => 'alibaba',
],
],
'sceneId' => [
'description' => '场景列表'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '场景ID',
'type' => 'string',
'example' => 'test',
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '当前请求的RequestID。'."\n",
'type' => 'string',
'example' => 'A40E64C6-9E21-5E9C-B333-DD920AE5AB4A',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"traceId\\": [\\n \\"alibaba\\"\\n ],\\n \\"sceneId\\": [\\n \\"test\\"\\n ]\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"A40E64C6-9E21-5E9C-B333-DD920AE5AB4A\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '获取指定实例全量的渠道和场景信息列表',
'summary' => '获取指定实例全量的渠道和场景信息列表。',
],
'ListUmengAppkeys' => [
'path' => '/v2/openapi/umeng/appkeys',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18717',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n",
'type' => 'array',
'items' => [
'description' => '返回详情结果',
'type' => 'object',
'properties' => [
'appkey' => [
'description' => 'appkey'."\n",
'type' => 'string',
'example' => '5ddcf39f57729e708b00000e',
],
'platform' => [
'description' => 'Android/ios',
'type' => 'string',
'example' => 'ios',
],
'name' => [
'description' => 'app名称',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"appkey\\": \\"5ddcf39f57729e708b00000e\\",\\n \\"platform\\": \\"ios\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '获取友盟 appkey 列表信息',
'summary' => '获取友盟appkey列表信息。',
],
'ListUserClusters' => [
'path' => '/v2/openapi/instances/{instanceId}/user-clusters',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18718',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '指定的实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回详情结果',
'type' => 'array',
'items' => [
'description' => '返回详情结果',
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后修改时间的UTC时间',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'status' => [
'description' => '状态',
'type' => 'string',
'example' => '1',
],
'gmtCreate' => [
'description' => '创建时间的UTC时间',
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'name' => [
'description' => '用户cluster名称',
'type' => 'string',
'example' => 'mycluster-for-airec',
],
'meta' => [
'description' => 'meta',
'type' => 'object',
'properties' => [
'metaType' => [
'description' => 'meta类型',
'type' => 'string',
'example' => 'UserCluster',
],
'description' => [
'description' => '描述信息',
'type' => 'string',
'example' => 'tst',
],
],
],
],
],
],
'headers' => [
'description' => 'headers info',
'type' => 'object',
'properties' => [
'X-Total-Count' => [
'description' => '总数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1E2CBBA8-C623-4FEE-BC84-9672E460CA39',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"status\\": \\"1\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"name\\": \\"mycluster-for-airec\\",\\n \\"meta\\": {\\n \\"metaType\\": \\"UserCluster\\",\\n \\"description\\": \\"tst\\"\\n }\\n }\\n ],\\n \\"headers\\": {\\n \\"X-Total-Count\\": 1\\n },\\n \\"requestId\\": \\"1E2CBBA8-C623-4FEE-BC84-9672E460CA39\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取用户集群列表',
'summary' => '列表显示当前的实例用户cluster。',
],
'QueryDataMessage' => [
'path' => '/v2/openapi/instances/{instanceId}/tables/{table}/data-message',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18730',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'table',
'in' => 'path',
'schema' => [
'description' => '智能推荐表名(item/user)'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'item',
],
],
[
'name' => 'cmdType',
'in' => 'query',
'schema' => [
'description' => 'update/delete/add 三选一'."\n"
."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'update',
],
],
[
'name' => 'itemId',
'in' => 'query',
'schema' => [
'description' => 'table 为 item 时必选'."\n",
'type' => 'string',
'required' => false,
'example' => '111',
],
],
[
'name' => 'itemType',
'in' => 'query',
'schema' => [
'description' => 'table 为 item 时必选'."\n",
'type' => 'string',
'required' => false,
'example' => 'video',
],
],
[
'name' => 'userId',
'in' => 'query',
'schema' => [
'description' => 'table 为 user 时必选'."\n",
'type' => 'string',
'required' => false,
'example' => '222',
],
],
[
'name' => 'userType',
'in' => 'query',
'schema' => [
'description' => 'table 为 user 时必选'."\n",
'type' => 'string',
'required' => false,
'example' => 'app',
],
],
[
'name' => 'page',
'in' => 'query',
'schema' => [
'description' => '默认为 1'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'size',
'in' => 'query',
'schema' => [
'description' => '默认每页返回 20 条'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '20',
],
],
[
'name' => 'traceId',
'in' => 'query',
'schema' => [
'description' => 'trace_id',
'type' => 'string',
'required' => false,
'example' => 'Alibaba',
],
],
[
'name' => 'sceneId',
'in' => 'query',
'schema' => [
'description' => '场景id',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'bhvType',
'in' => 'query',
'schema' => [
'description' => ' '."\n"
.'expose 曝光'."\n"
."\n"
.'click 点击'."\n"
."\n"
.'like 点赞'."\n"
."\n"
.'comment 评论'."\n"
."\n\n"
.'collect 收藏'."\n"
."\n"
.'stay 停留时长'."\n"
."\n"
.'cart 加购'."\n"
."\n"
.'buy 购买'."\n"
."\n"
.'evaluate 评论',
'type' => 'string',
'required' => false,
'example' => 'expose',
],
],
[
'name' => 'messageSource',
'in' => 'query',
'schema' => [
'description' => 'CONSOLE 控制台更新物品'."\n"
."\n"
.'FEEDER SDK更新物品',
'type' => 'string',
'required' => false,
'example' => 'CONSOLE',
],
],
[
'name' => 'imei',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n",
'type' => 'object',
'example' => 'xxx',
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n 20000\\n 1000\\n \\n 2019-09-09T16:00:00.000Z\\n update\\n \\n 0\\n article\\n abc\\n \\n \\n \\n 2019-09-09T16:00:00.000Z\\n add\\n \\n 0\\n article\\n abc\\n \\n \\n","errorExample":""}]',
'title' => '查询用户数据表中的更新消息',
'summary' => '用户数据表中的更新消息查询。',
'description' => '查询用户指定实例,指定数据表中的更新消息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDataMessageStatistics' => [
'path' => '/v2/openapi/instances/{instanceId}/tables/{table}/data-message-statistics',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18731',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '946656000',
'example' => '1586673466',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '946656000',
'example' => '1586673466',
],
],
[
'name' => 'table',
'in' => 'path',
'schema' => [
'description' => '智能推荐表名(item/user)'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'item',
],
],
[
'name' => 'cmdType',
'in' => 'query',
'schema' => [
'description' => 'update/delete/add 三选一'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'update',
],
],
[
'name' => 'itemId',
'in' => 'query',
'schema' => [
'description' => 'table 为 item 时必选'."\n",
'type' => 'string',
'required' => false,
'example' => '111',
],
],
[
'name' => 'itemType',
'in' => 'query',
'schema' => [
'description' => 'table 为 item 时必选'."\n",
'type' => 'string',
'required' => false,
'example' => 'video',
],
],
[
'name' => 'userId',
'in' => 'query',
'schema' => [
'description' => 'table 为 user 时必选'."\n",
'type' => 'string',
'required' => false,
'example' => '222',
],
],
[
'name' => 'userType',
'in' => 'query',
'schema' => [
'description' => 'table 为 user 时必选'."\n",
'type' => 'string',
'required' => false,
'example' => 'app',
],
],
[
'name' => 'traceId',
'in' => 'query',
'schema' => [
'description' => 'trace_id'."\n",
'type' => 'string',
'required' => false,
'example' => 'Alibaba',
],
],
[
'name' => 'sceneId',
'in' => 'query',
'schema' => [
'description' => '场景id'."\n",
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'bhvType',
'in' => 'query',
'schema' => [
'description' => 'expose 曝光'."\n"
."\n"
.'click 点击'."\n"
."\n"
.'like 点赞'."\n"
."\n"
.'comment 评论'."\n"
."\n"
.'collect 收藏'."\n"
."\n"
.'stay 停留时长'."\n"
."\n"
.'cart 加购'."\n"
."\n"
.'buy 购买'."\n"
."\n"
.'evaluate 评论',
'type' => 'string',
'required' => false,
'example' => 'expose ',
],
],
[
'name' => 'messageSource',
'in' => 'query',
'schema' => [
'description' => 'CONSOLE'."\n"
."\n"
.'FEEDER',
'type' => 'string',
'required' => false,
'example' => ' FEEDER',
],
],
[
'name' => 'imei',
'in' => 'query',
'schema' => [
'description' => '设备 imei',
'type' => 'string',
'required' => false,
'example' => 'd41d8cd98f00b204e9800998ecf8427e',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n",
'type' => 'object',
'example' => 'xxx',
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n 123456\\n 100\\n\\n\\n 123456\\n 100\\n","errorExample":""}]',
'title' => '查询用户数据表中的更新消息统计数据',
'summary' => '用户数据表中的更新消息统计数据查询。',
'description' => '查询用户指定实例,指定数据表中的更新消息的统计数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryExceptionHistory' => [
'path' => '/v2/openapi/instances/{instanceId}/sync-reports/exception-history',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18732',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'type',
'in' => 'query',
'schema' => [
'description' => '必填 item|behavior|user',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'user',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n",
'type' => 'object',
],
'code' => [
'description' => '错误码',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => 'Id of the request',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'successful',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"successful\\"\\n}","type":"json"}]',
'title' => '异常数据历史分段查询',
'summary' => '异常数据历史分段查询。',
],
'QueryRawData' => [
'path' => '/v2/openapi/instances/{instanceId}/tables/{table}/raw-data',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18733',
'abilityTreeNodes' => [
'FEATUREairecY1ADIM',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'table',
'in' => 'path',
'schema' => [
'description' => '智能推荐表名(item/user)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'item',
],
],
[
'name' => 'itemId',
'in' => 'query',
'schema' => [
'description' => 'table 为 item 时必选',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '112',
],
],
[
'name' => 'itemType',
'in' => 'query',
'schema' => [
'description' => 'table 为 item 时必选',
'type' => 'string',
'required' => false,
'example' => 'video',
],
],
[
'name' => 'userId',
'in' => 'query',
'schema' => [
'description' => 'table 为 user 时必选',
'type' => 'string',
'required' => false,
'example' => '111',
],
],
[
'name' => 'userType',
'in' => 'query',
'schema' => [
'description' => 'table 为 user 时必选',
'type' => 'string',
'required' => false,
'example' => 'app',
],
],
[
'name' => 'imei',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n"
."\n",
'type' => 'object',
'example' => 'xxx',
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'Message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
'requestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"code\\": \\"InternalServerError\\",\\n \\"Message\\": \\"An internal server error occurred\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n \\n 1243\\n article\\n 1,2,3\\n Xxx\\n \\n \\n 2019-09-09T16:00:00.000Z\\n update\\n \\n 0\\n article\\n abc\\n \\n \\n \\n 2019-09-09T16:00:00.000Z\\n add\\n \\n 0\\n article\\n abc\\n \\n \\n","errorExample":""}]',
'title' => '用户数据表中的原始数据查询',
'summary' => '用户数据表中的原始数据查询。',
'description' => '对当前实例进行特定表和主键的检索,返回结果供客户确认。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QuerySingleAggregationReport' => [
'path' => '/v2/openapi/instances/{instanceId}/sync-reports/single-aggregation-report',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18734',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n",
'type' => 'object',
],
'code' => [
'description' => '错误码',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '当前请求的RequestID',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情',
'type' => 'string',
'example' => 'successful',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"successful\\"\\n}","type":"json"}]',
'title' => '单表聚合查询',
'summary' => '单表聚合查询(数据可能有修改)。',
],
'QuerySingleReport' => [
'path' => '/v2/openapi/instances/{instanceId}/sync-reports/single-report',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18735',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
[
'name' => 'reportType',
'in' => 'query',
'schema' => [
'description' => '必填,单表报告类型:'."\n"
.'- typeItemValidScene'."\n"
.'- typeItemTag'."\n"
.'- typeItemTagScene'."\n"
.'- typeItemWeightScene'."\n"
.'- typeItemRawScene'."\n"
.'- typeItemExpireScene',
'type' => 'string',
'required' => true,
'example' => 'typeItemTagScene',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n"
."\n",
'type' => 'object',
'example' => 'xxx',
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n 1_0:1\\n 1\\n\\n\\n 1_0:0\\n 2\\n","errorExample":""}]',
'title' => 'QuerySingleReport',
'summary' => '单表维度分析查询(类型可能会增加)。',
],
'QuerySyncReportAggregation' => [
'path' => '/v2/openapi/instances/{instanceId}/sync-reports/aggregation',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18736',
'abilityTreeNodes' => [
'FEATUREairecLALQPW',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004'."\n",
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '开始时间秒级时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '结束时间秒级时间戳'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '4102416000',
'minimum' => '1565193600',
'example' => '1586673466',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '查询结果'."\n",
'type' => 'object',
'example' => 'xxx',
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '请求id'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"16B78383-2803-4964-9605-37B30C073B0E\\n\\n normal\\n 1566489600\\n 1566658800\\n \\n normal\\n \\n behavior\\n \\n \\n \\n \\n normal\\n \\n item\\n \\n \\n \\n \\n normal\\n \\n user\\n \\n \\n \\n","errorExample":""}]',
'title' => '查询整体数据概览',
'summary' => '查询整体数据概览。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDataSource' => [
'path' => '/v2/openapi/instances/{instanceId}/dataSources',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18701',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-cn-o400whm78004',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '数据源信息列表'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'gmtModified' => [
'description' => '最后修改数据源的UTC时间。'."\n",
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'gmtCreate' => [
'description' => '创建数据源的UTC时间。'."\n",
'type' => 'string',
'example' => '2018-12-07T02:24:26.000Z',
],
'tableName' => [
'description' => '智能推荐的实例的表名。'."\n",
'type' => 'string',
'example' => 'behavior',
],
'meta' => [
'description' => '数据源配置参数'."\n",
'type' => 'object',
'properties' => [
'bucketName' => [
'description' => 'oss数据源的bucketName信息',
'type' => 'string',
'example' => 'airec',
],
'accessKeyId' => [
'description' => '有访问ODPS权限的accesskey ID。'."\n",
'type' => 'string',
'example' => 'xxx',
],
'type' => [
'description' => '数据源类型,当前只支持ODPS。'."\n",
'type' => 'string',
'example' => 'ODPS',
],
'partition' => [
'description' => 'ODPS Partition。例如:ds=20180102'."\n",
'type' => 'string',
'example' => 'ds=20181122',
],
'timestamp' => [
'description' => 'ODPS 毫秒数据时间戳。例如:1544112000000'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1544112000000',
],
'path' => [
'description' => 'oss数据源的path信息',
'type' => 'string',
'example' => 'oss://xxx.xxx',
],
'tableName' => [
'description' => 'ODPS的table name。',
'type' => 'string',
'example' => 'test_maxcompute',
],
'projectName' => [
'description' => 'ODPS 的project name。',
'type' => 'string',
'example' => 'openrec_gray',
],
],
],
],
],
],
'code' => [
'description' => '错误码'."\n",
'type' => 'string',
'example' => 'InternalServerError',
],
'requestId' => [
'description' => '当前请求的RequestID。'."\n",
'type' => 'string',
'example' => '8F81A922-6C81-46D6-B78C-CC35E16B1691',
],
'message' => [
'description' => '错误详情'."\n",
'type' => 'string',
'example' => 'An internal server error occurred',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"gmtModified\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"gmtCreate\\": \\"2018-12-07T02:24:26.000Z\\",\\n \\"tableName\\": \\"behavior\\",\\n \\"meta\\": {\\n \\"bucketName\\": \\"airec\\",\\n \\"accessKeyId\\": \\"xxx\\",\\n \\"type\\": \\"ODPS\\",\\n \\"partition\\": \\"ds=20181122\\",\\n \\"timestamp\\": 1544112000000,\\n \\"path\\": \\"oss://xxx.xxx\\",\\n \\"tableName\\": \\"test_maxcompute\\",\\n \\"projectName\\": \\"openrec_gray\\"\\n }\\n }\\n ],\\n \\"code\\": \\"InternalServerError\\",\\n \\"requestId\\": \\"8F81A922-6C81-46D6-B78C-CC35E16B1691\\",\\n \\"message\\": \\"An internal server error occurred\\"\\n}","errorExample":""},{"type":"xml","example":"2018-12-07T02:24:26.000Z\\n2018-12-07T02:24:26.000Z\\nitem\\n\\n ODPS\\n 1544112000000\\n LTAIHhxxxxxxxxxx\\n openrec_gray\\n content_gul_item_autotest\\n ds=20181122\\n","errorExample":""}]',
'title' => '获取指定实例的数据源列表',
'summary' => '获取指定实例的数据源列表信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'InitComputingResource' => [
'summary' => '初始化计算资源。',
'path' => '/v2/openapi/instances/{instanceId}/computing-resources/actions/init',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117128',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例id',
'type' => 'string',
'required' => false,
'example' => 'airec-test',
],
],
[
'name' => 'type',
'in' => 'query',
'schema' => [
'title' => '计算资源类型',
'description' => '资源类型,本期固定为:MAX_COMPUTE',
'type' => 'string',
'required' => false,
'example' => '是',
],
],
[
'name' => 'key',
'in' => 'query',
'schema' => [
'title' => '计算资源初始化参数',
'description' => 'type=MAX_COMPUTE则为mc工作空间名称',
'type' => 'string',
'required' => false,
'example' => 'MAX_COMPUTE',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求id',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","errorExample":""},{"type":"xml","example":"829F38F6-E2D6-4109-90A6-888160BD16C2\\ntrue","errorExample":""}]',
'title' => '初始化计算资源',
],
'PushDocument' => [
'path' => '/v2/openapi/instances/{instanceId}/tables/{tableName}/actions/bulk',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18728',
'abilityTreeNodes' => [
'FEATUREairecY1ADIM',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '智能推荐的实例 Id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'tableName',
'in' => 'path',
'schema' => [
'description' => '行业的3张表,分别是用户表(user)、物品表(item)和行为表(behavior)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'user',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => 'true/false',
'type' => 'boolean',
'example' => 'true',
],
'code' => [
'description' => '错误码',
'type' => 'string',
'example' => '0',
],
'requestId' => [
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'message' => [
'description' => '返回信息',
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"code\\": \\"0\\",\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '推送文档',
'summary' => '向指定实例指定表推送文档。',
],
'PushIntervention' => [
'path' => '/v2/openapi/instances/{instanceId}/actions/intervene',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18729',
'abilityTreeNodes' => [
'FEATUREairecY1ADIM',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => 'result true/false',
'type' => 'boolean',
'example' => 'true',
],
'code' => [
'description' => 'code',
'type' => 'string',
'example' => '1',
],
'requestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
'message' => [
'description' => '返回消息',
'type' => 'string',
'example' => 'success',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"code\\": \\"1\\",\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\",\\n \\"message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => 'PushIntervention',
'summary' => '该接口用于向指定实例推送干预数据。',
],
'RebuildIndex' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/actions/rebuild',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18737',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '算法ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'string',
'example' => 'true',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": \\"true\\",\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","type":"json"}]',
'title' => '重建索引',
'summary' => '重建索引。',
],
'Recommend' => [
'path' => '/v2/openapi/instances/{instanceId}/actions/recommend',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18738',
'abilityTreeNodes' => [
'FEATUREairecY1ADIM',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test001',
],
],
[
'name' => 'sceneId',
'in' => 'query',
'schema' => [
'description' => '物品被投放的场景ID',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'userId',
'in' => 'query',
'schema' => [
'description' => '用户唯一ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'ip',
'in' => 'query',
'schema' => [
'description' => '用户最后登录的IP',
'type' => 'string',
'required' => false,
'example' => '192.168.1.1',
],
],
[
'name' => 'imei',
'in' => 'query',
'schema' => [
'description' => '设备ID',
'type' => 'string',
'required' => false,
'example' => '06e1565409c9fc4887036b974421****',
],
],
[
'name' => 'returnCount',
'in' => 'query',
'schema' => [
'description' => '返回结果条数(0-50之间)',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'items',
'in' => 'query',
'schema' => [
'description' => '用于相关推荐的item(限于相关推荐场景使用)',
'type' => 'string',
'required' => false,
'example' => '1001',
],
],
[
'name' => 'serviceType',
'in' => 'query',
'schema' => [
'description' => '略',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'userInfo',
'in' => 'query',
'schema' => [
'description' => '略',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'rankOpen',
'in' => 'query',
'schema' => [
'description' => '召回排序阶段是否根据用户ID个性化排序',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'recType',
'in' => 'query',
'schema' => [
'description' => '推荐服务类型',
'type' => 'string',
'required' => false,
'example' => 'gul',
],
],
[
'name' => 'filter',
'in' => 'query',
'schema' => [
'description' => '推荐过滤字符串',
'type' => 'string',
'required' => false,
'example' => 'eyJqb2luIjoiYW5kIiwiZmlsdGVycyI6W3siY29uZCI6ImNvbnRhaW4iLCJmaWVsZCI6InRhZ3MiLCJ2YWx1ZSI6IuWPjOS6uiJ9XX0.',
],
],
[
'name' => 'strategy',
'in' => 'query',
'schema' => [
'description' => '如果需要使用坑位策略,请求参数内新增strategy="fixedSlot",此时系统将按照坑位配置返回推荐结果',
'type' => 'string',
'required' => false,
'example' => 'fixedSlot',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'matchInfo' => [
'description' => '不用关心,debug时可能用到',
'type' => 'string',
'example' => 'xxx',
],
'traceId' => [
'description' => '回传日志时使用,回传日志时,trace_id=ali',
'type' => 'string',
'example' => 'ali',
],
'position' => [
'description' => '物品在需要展示的位置,从0开始(注意:返回结果已经按照position排序,可以不用关注)',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'itemId' => [
'description' => '物品ID',
'type' => 'string',
'example' => '123',
],
'itemType' => [
'description' => '物品类型',
'type' => 'string',
'example' => 'item',
],
'traceInfo' => [
'description' => '返回结果里traceInfo的值(注意:每个item的值均不一样,回传日志时,需要传对应的)',
'type' => 'string',
'example' => '"1007.62381.131491.100200300000000:bcb946ed-3f09-4e9b-bf4a-c19862f42231:792783::0:s101:::15:content___130788_stall:item:i2i_common_common:0.0205279946753756:null:null:1673258031504::context__recall_index=156,context__hour=17,context__trigger_num=2::C7EF99C9-6C55-5D45-A8D5-0754082E9DCF:hot_common,i2i_common_common,i2i_swing_common,hot_full:::::"',
],
'weight' => [
'description' => '权重',
'type' => 'number',
'format' => 'float',
'example' => '1',
],
'flowWeight' => [
'description' => '流控加权字段;=0未加权;>0加权;<0降权',
'type' => 'number',
'format' => 'double',
'example' => '0',
],
'message' => [
'description' => '状态信息',
'type' => 'string',
'example' => 'Successful',
],
],
],
],
'code' => [
'description' => '状态码',
'type' => 'string',
'example' => '200',
],
'requestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '04707E49-642A-4649-827A-F8EEB07D4C27',
],
'message' => [
'description' => '状态信息',
'type' => 'string',
'example' => '"i2i_common_common;NotFound;1673254401;similar product/content of clicked ones;2023-01-09 16:53:21"',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [\\n {\\n \\"matchInfo\\": \\"xxx\\",\\n \\"traceId\\": \\"ali\\",\\n \\"position\\": 1,\\n \\"itemId\\": \\"123\\",\\n \\"itemType\\": \\"item\\",\\n \\"traceInfo\\": \\"\\\\\\"1007.62381.131491.100200300000000:bcb946ed-3f09-4e9b-bf4a-c19862f42231:792783::0:s101:::15:content___130788_stall:item:i2i_common_common:0.0205279946753756:null:null:1673258031504::context__recall_index=156,context__hour=17,context__trigger_num=2::C7EF99C9-6C55-5D45-A8D5-0754082E9DCF:hot_common,i2i_common_common,i2i_swing_common,hot_full:::::\\\\\\"\\",\\n \\"weight\\": 1,\\n \\"flowWeight\\": 0,\\n \\"message\\": \\"Successful\\"\\n }\\n ],\\n \\"code\\": \\"200\\",\\n \\"requestId\\": \\"04707E49-642A-4649-827A-F8EEB07D4C27\\",\\n \\"message\\": \\"\\\\\\"i2i_common_common;NotFound;1673254401;similar product/content of clicked ones;2023-01-09 16:53:21\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"04707E49-642A-4649-827A-F8EEB07D4C27\\n\\n 897068\\n article\\n emb_title2vec_common\\n 1\\n 极简主义的“有水蛋糕”,香软甜绵5个步骤搞定,给孩子收藏了\\n articleCommonRelated\\n 1\\n none\\n 美食\\n 164\\n 4102416000\\n 0.6191751956939697\\n 1\\n 1\\n 1007.19746.107647.100200300000000:c7bd13e3-371b-4276-b142-4c1a439f21a0:1:40000:0::::2:content___1729346806:image:cd:0.0545865490313237:0.027317269681932512:0.6218346196125295:::::::::::\\n\\n\\n 897068\\n article\\n emb_title2vec_common\\n 1\\n 极简主义的“有水蛋糕”,香软甜绵5个步骤搞定,给孩子收藏了\\n articleCommonRelated\\n 1\\n none\\n 美食\\n 164\\n 4102416000\\n 0.6191751956939697\\n 1\\n 1\\n 1007.19746.107647.100200300000000:c7bd13e3-371b-4276-b142-4c1a439f21a0:1:40000:0::::2:content___1729346806:image:cd:0.0545865490313237:0.027317269681932512:0.6218346196125295:::::::::::\\n","errorExample":""}]',
'title' => '智能推荐',
'summary' => '该接口用于获取指定实例的推荐结果。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RefreshFeatureTable' => [
'summary' => '刷新特征表,根据特征表源更新特征表,刷新策略为以用户源表为准。',
'path' => '/v2/openapi/instances/{instanceId}/feature-tables/{type}/{featureTableId}/actions/refresh',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117112',
'abilityTreeNodes' => [
'FEATUREairecGK86LR',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'type',
'in' => 'path',
'schema' => [
'title' => '特征表类型',
'description' => '特征表类型',
'type' => 'string',
'required' => true,
'example' => 'ItemFeatureTable UserFeatureTable',
],
],
[
'name' => 'featureTableId',
'in' => 'path',
'schema' => [
'title' => '特征表id',
'description' => '特征表id',
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'$ref' => '#/components/schemas/FeatureTable',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"Status\\": \\"\\",\\n \\"Meta\\": {\\n \\"DataSourceId\\": \\"907648f5-abae-44fd-a4c4-525cc25947e9\\",\\n \\"FeatureList\\": [\\n {\\n \\"Comment\\": \\"com11\\",\\n \\"FeatureName\\": \\"fn11\\",\\n \\"FieldName\\": \\"fieldName11\\",\\n \\"Status\\": \\"NotApplied 未应用 Applied 已应用\\"\\n }\\n ],\\n \\"Internal\\": true,\\n \\"MetaType\\": \\"FeatureTable\\",\\n \\"Source\\": \\"test_project.test_table\\",\\n \\"UpdateFrequency\\": 86400\\n },\\n \\"FeatureTableId\\": \\"30E70118-FC7C-4438-9287-583CE47266A9\\",\\n \\"Type\\": \\"ItemFeatureTable 物品特征表 UserFeatureTable 用户特征表\\",\\n \\"GmtCreate\\": \\"2021-12-10T02:59:54.000Z\\",\\n \\"GmtModified\\": \\"2021-12-10T02:59:54.000Z\\"\\n }\\n}","type":"json"}]',
'title' => '刷新特征表',
],
'RunSampleFormatConfig' => [
'summary' => '触发样本格式化。',
'path' => '/v2/openapi/instances/{instanceId}/samples/{sampleId}/format-configs/actions/run',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '117134',
'abilityTreeNodes' => [
'FEATUREairec5XEKC0',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'example' => 'airec-test',
'title' => 'A short description of struct',
],
],
[
'name' => 'sampleId',
'in' => 'path',
'schema' => [
'description' => '样本id',
'type' => 'string',
'required' => true,
'example' => '123',
'title' => '样本id',
],
],
[
'name' => 'mode',
'in' => 'query',
'schema' => [
'description' => '格式化模式'."\n"
.'Latest:采用最新的格式化配置(默认值)',
'type' => 'string',
'required' => false,
'example' => 'latest',
'title' => '格式化模式',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '实例id',
'type' => 'string',
'example' => 'airec-test',
'title' => 'Id of the request',
],
'result' => [
'description' => '格式化配置',
'type' => 'boolean',
'example' => 'true',
'title' => 'result',
],
],
'title' => 'Schema of Response',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"airec-test\\"\\n}","errorExample":""},{"type":"xml","example":"true\\n90D6B8F5-FE97-4509-9AAB-367836C51818","errorExample":""}]',
'title' => '触发样本格式化',
],
'UnLockIndexVersion' => [
'path' => '/v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/actions/unlock',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '18741',
'abilityTreeNodes' => [
'FEATUREairecXPRU1W',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'airec-test',
],
],
[
'name' => 'algorithmId',
'in' => 'path',
'schema' => [
'description' => '召回ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'abc',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应体',
'type' => 'object',
'properties' => [
'result' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'requestId' => [
'description' => '请求的RequestID',
'type' => 'string',
'example' => '829F38F6-E2D6-4109-90A6-888160BD16C2',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '解锁索引版本',
'summary' => '解锁召回表的索引版本。',
],
'CreateDataDiagnoseTask' => [
'summary' => '创建数据诊断任务。',
'path' => '/v2/openapi/instances/{instanceId}/data-diagnose-task',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '138221',
'abilityTreeNodes' => [
'FEATUREairecG8RBMT',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回内容',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '当前请求的RequestID',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '创建任务是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": true\\n}","type":"json"}]',
'title' => '创建数据诊断任务',
],
'CreateUmengToken' => [
'summary' => '创建友盟授权token',
'path' => '/v2/openapi/umeng/token',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '148531',
'abilityTreeNodes' => [
'FEATUREairecY1ADIM',
],
],
'parameters' => [
[
'name' => 'code',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => [
'type' => 'boolean',
],
'code' => [
'type' => 'string',
],
'requestId' => [
'type' => 'string',
],
'message' => [
'type' => 'string',
],
],
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'GetLatestDataDiagnoseTaskStatus' => [
'summary' => '获取最新诊断任务状态。',
'path' => '/v2/openapi/instances/{instanceId}/data-diagnose-task/status',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '138222',
'abilityTreeNodes' => [
'FEATUREairecG8RBMT',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '当前请求的RequestID',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '创建的任务状态'."\n"
.'任务状态:'."\n"
."\n"
.'- RUNNING 运行中'."\n"
.'- FAILURE 失败'."\n"
.'- SUCCESS 成功'."\n"
.'- NOTASK 没有任务',
'type' => 'object',
'example' => 'RUNNING',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
'title' => '获取最新诊断任务状态',
],
'ListDataDiagnoseReports' => [
'summary' => '获取数据诊断报告 (包括用户手动触发的诊断、每天产出的周期报告、数据启动时诊断的报告)。',
'path' => '/v2/openapi/instances/{instanceId}/data-diagnose-reports',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '138223',
'abilityTreeNodes' => [
'FEATUREairecG8RBMT',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'taskCreateTime',
'in' => 'query',
'schema' => [
'description' => '创建任务的时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1566489600',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回结果',
'type' => 'object',
'example' => '{'."\n"
.' "todayTimeLimit":8,'."\n"
.' "totalCount":10,'."\n"
.' "reports":['."\n"
.' {'."\n"
.' "diagnoseLevel":"low | medium | high",'."\n"
.' "startTime":1566489600,'."\n"
.' "endTime":1566489600,'."\n"
.' "taskCreateTime":1566489600,'."\n"
.' "taskSource":"manual | cycle | firstRun",'."\n"
.' "total":{'."\n"
.' "itemCount":100,'."\n"
.' "userCount":100,'."\n"
.' "bhvCount":100'."\n"
.' },'."\n"
.' "details":['."\n"
.' {'."\n"
.' "key":"",'."\n"
.' "level":"error | warn | info",'."\n"
.' "errorCount":10,'."\n"
.' "errorPercent":10,'."\n"
.' "sampleEnabled":true;'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "diagnoseLevel":"low | medium | high",'."\n"
.' "startTime":1566489600,'."\n"
.' "endTime":1566489600,'."\n"
.' "taskCreateTime":1566489600,'."\n"
.' "taskSource":"manual | cycle | firstRun",'."\n"
.' "total":{'."\n"
.' "itemCount":100,'."\n"
.' "userCount":100,'."\n"
.' "bhvCount":100'."\n"
.' },'."\n"
.' "details":['."\n"
.' {'."\n"
.' "key":"",'."\n"
.' "level":"error | warn | info",'."\n"
.' "errorCount":10,'."\n"
.' "errorPercent":10,'."\n"
.' "sampleEnabled":true;'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
'title' => '获取数据诊断报告 ',
],
'ListDataDiagnoseSampleDetails' => [
'summary' => '获取数据诊断报告抽样明细。',
'path' => '/v2/openapi/instances/{instanceId}/data-diagnose-reports/sample-details',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '139245',
'abilityTreeNodes' => [
'FEATUREairecG8RBMT',
],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '实例id',
'type' => 'string',
'required' => true,
'example' => 'airec-cn-shdjkgkeog',
],
],
[
'name' => 'taskCreateTime',
'in' => 'query',
'schema' => [
'description' => '毫秒时间戳, 诊断任务创建的时间。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1665936000000',
],
],
[
'name' => 'startTime',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳,查询的整点时间',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1665158400',
],
],
[
'name' => 'endTime',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳,查询的整点时间',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1682179200',
],
],
[
'name' => 'taskSource',
'in' => 'query',
'schema' => [
'description' => '任务类型:firstRun, manual, cycle',
'type' => 'string',
'required' => true,
'example' => 'cycle',
],
],
[
'name' => 'key',
'in' => 'query',
'schema' => [
'description' => '诊断项',
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '当前请求的RequestID',
'type' => 'string',
'example' => '8B90B646-1678-41A3-B23F-EAC6587B0E48',
],
'result' => [
'description' => '返回详情结果',
'type' => 'object',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B90B646-1678-41A3-B23F-EAC6587B0E48\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
'title' => '获取数据诊断报告抽样明细',
],
],
'endpoints' => [
[
'regionId' => 'cn-beijing',
'endpoint' => 'airec.cn-beijing.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'airec.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'airec.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'airec.cn-shenzhen.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'airec.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'airec.us-east-1.aliyuncs.com',
],
],
];